Skip to content

Band Manipulation

Args:

bbox (str) (required):

A bbox (bounding box) is a rectangular feature that will encompass a desired Area Of Interest (AOI). The format is miny,minx,maxy,maxx (minimum y coordinate, minimum x coordinate, maximum y coordinate, maximum y coordinate). Other projections are not supported at this time

Example:

 interface.band_manipulation(bbox="39.7530, -104.9962, 39.7580, -104.9912")

featureid (str) (required):

The featureid is the online id of the desired image feature

Example:

 interface.band_manipulation(bbox="39.7530, -104.9962, 39.7580, -104.9912", featureid="d330c2f9486b4b5b0798b142fd1e6388")

band_combination (list) (required):

The band_combination is a list of strings containing the desired band combination of 1-4 items. Available options include:

  • R
  • G
  • B
  • C
  • Y
  • RE
  • N
  • N2
  • S1
  • S2
  • S3
  • S4
  • S5
  • S6
  • S7

Further information about bands can be found here: Bands

Example:

 interface.band_manipulation(bbox="39.7530, -104.9962, 39.7580, -104.9912", featureid="d330c2f9486b4b5b0798b142fd1e6388", band_combination=['R', 'B', 'G', 'C'])

srsname (str):

Desired projection. Defaults to "EPSG:4326".

**Example:**

  interface.band_manipulation(bbox="39.7530, -104.9962, 39.7580, -104.9912", featureid="d330c2f9486b4b5b0798b142fd1e6388", band_combination=['R', 'B', 'G', 'C'], srsname="EPSG:3857")

height, width (int):

Desired image height and width in pixels. Maximum is 8000.

Example:

 interface.download_image(bbox="39.7530, -104.9962, 39.7580, -104.9912", featureid="d330c2f9486b4b5b0798b142fd1e6388", height=512, width=512)

img_format (str):

The img_format is the desired format of the returned object. Available options include jpeg, png, or geotiff

Example:

 interface.band_manipulation(bbox="39.7530, -104.9962, 39.7580, -104.9912", featureid="d330c2f9486b4b5b0798b142fd1e6388", img_format='png')

outputpath (str):

The outputpath is the desired location for the image to be downloaded. outputpath defaults to root directory and defaults name of file to download (ex: r"C:\Users\user\download.jpeg"). File extension is also needed in outputpath if declared (ex: r"C:\Users\user\image.jpeg")

Example:

 interface.band_manipulation(bbox="39.7530, -104.9962, 39.7580, -104.9912", featureid="d330c2f9486b4b5b0798b142fd1e6388", outputpath=r"C:\Users\user\image.jpeg")