sdk.aoi.create()

elements.sdk.api.aoi

Create an AOI.

Create a new AOI with metadata and geometry inputs, and add the AOI to an AOI Collection.

Parameters

  • wkt (str) - the WKT-format string of polygon coordinates
  • name (str) - the name of the AOI
  • category (str) - the category of the AOI
  • tags (str) - any descriptive tags to enhance the AOI's metadata
  • aoi_collection_id (str) - the ID of the AOI Collection that the AOI will be added to

Returns

List[AOIIdentifier]

Example(s)

# Create an AOI
await sdk.aoi.create(aoi_collection_id="43af4120-959c-47be-a34c-9c7bf5ab37af",
                     geom_wkt="POLYGON ((-121.891336 37.345116, -121.882978 37.322622, -121.865618 37.335404, -121.891336 37.345116))",
                     name="San Jose State University", category="University",
                     category_type="Education", tags=["college","education"]) 

# Output (List[AOIIdentifier])
[id: "18d6207a-091f-4852-8ab3-f2dbbcca3fc5"
version: 35014258
]