Skip to contents

Describe an AOI

Source: R/aoi_describe.R
aoi_describe.Rd

Describe a spatial (sf/sp/raster) object in terms of a reproducible AOI (e.g. aoi_get) parameters.

Usage

aoi_describe(AOI)

Arguments

AOI

a spatial object (raster, sf, sp).

Value

a data.frame of AOI descriptors

Examples

{
  fname <- system.file("shape/nc.shp", package = "sf")
  nc <- sf::read_sf(fname)
  aoi_describe(AOI = nc[1, ])
}
#> type:		 POLYGON (1)
#> BBox Area:	 1771.842 [km^2]
#> Centroid:	 -81.49048 36.412 [x,y]
#> Diminsions:	 27.8302 24.5152 [width, height, in miles]
#> area:		 1137.108 [km^2]
#> Area/BBox Area:	 64.17661 [%]