DataCropCollectionFeatureOptionalParams interface

Package:

@azure/planetarycomputer

Optional parameters.

Extends

OperationOptions

Properties

algorithm	Terrain algorithm name
algorithmParams	Terrain algorithm parameters
assetAsBand	Asset as Band
assetBandIndices	Per asset band indexes (coma separated indexes, e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image")
assets	Asset's names.
bbox	Bounding box (west, south, east, north).
bidx	Dataset band indexes
collection	STAC Collection ID
colorFormula	rio-color formula (info: https://github.com/mapbox/rio-color)
colorMap	JSON encoded custom Colormap
colorMapName	Colormap name
coordinateReferenceSystem	Coordinate Reference System of the input coords. Default to epsg:4326.
crs	Coordinate Reference System.
datetime	Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots. Examples: A date-time: "2018-02-12T23:20:50Z" A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z" Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z" Only features that have a temporal property that intersects the value of datetime are selected. If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.
destinationCrs	Output Coordinate Reference System.
exitWhenFull	Return as soon as the geometry is fully covered (defaults to True).
expression	Band math expression between assets
format	Output image format.
height	Height in pixels for the output image
ids	Array of Item ids.
itemsLimit	Return as soon as we have N items per geometry (defaults to 100).
maxSize	Image output size limit if width and height limits are not set.
noData	Overwrite internal Nodata value
pixelSelection	Pixel selection method.
query	JSON query expression for filtering items.
reproject	WarpKernel resampling algorithm (only used when doing re-projection). Defaults to nearest.
resampling	Resampling method.
rescale	comma (',') delimited Min,Max range. Can set multiple time for multiple bands.
returnMask	Add mask to the output data.
scanLimit	Return as soon as we scan N items (defaults to 10000).
sel	Xarray Indexing using dimension names {dimension}={value}.
selMethod	Xarray indexing method to use for inexact matches.
skipCovered	Skip any items that would show up completely under the previous items (defaults to True).
sortby	Sorting expression (e.g. +/-property).
subdatasetBands	The index of a subdataset band within the asset.
subdatasetName	The name of a subdataset within the asset.
timeLimit	Return after N seconds to avoid long requests (defaults to 5).
unscale	Apply internal Scale or Offset
width	Width in pixels for the output image

Inherited Properties

abortSignal	The signal which can be used to abort requests.
onResponse	A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.
requestOptions	Options used when creating and sending HTTP requests for this operation.
tracingOptions	Options used when tracing is enabled.

Property Details

algorithm

Terrain algorithm name

algorithm?: string

Property Value

string

algorithmParams

Terrain algorithm parameters

algorithmParams?: string

Property Value

string

assetAsBand

Asset as Band

assetAsBand?: boolean

Property Value

boolean

assetBandIndices

Per asset band indexes (coma separated indexes, e.g. "image|1,2,3" means use the bands 1, 2, and 3 from the asset named "image")

assetBandIndices?: string[]

Property Value

string[]

assets

Asset's names.

assets?: string[]

Property Value

string[]

bbox

Bounding box (west, south, east, north).

bbox?: string

Property Value

string

bidx

Dataset band indexes

bidx?: number[]

Property Value

number[]

collection

STAC Collection ID

collection?: string

Property Value

string

colorFormula

rio-color formula (info: https://github.com/mapbox/rio-color)

colorFormula?: string

Property Value

string

colorMap

JSON encoded custom Colormap

colorMap?: string

Property Value

string

colorMapName

Colormap name

colorMapName?: string

Property Value

string

coordinateReferenceSystem

Coordinate Reference System of the input coords. Default to epsg:4326.

coordinateReferenceSystem?: string

Property Value

string

crs

Coordinate Reference System.

crs?: string

Property Value

string

datetime

Either a date-time or an interval, open or closed. Date and time expressions adhere to RFC 3339. Open intervals are expressed using double-dots.

Examples:

• A date-time: "2018-02-12T23:20:50Z"
• A closed interval: "2018-02-12T00:00:00Z/2018-03-18T12:31:12Z"
• Open intervals: "2018-02-12T00:00:00Z/.." or "../2018-03-18T12:31:12Z"

Only features that have a temporal property that intersects the value of datetime are selected.

If a feature has multiple temporal properties, it is the decision of the server whether only a single temporal property is used to determine the extent or all relevant temporal properties.

datetime?: string

Property Value

string

destinationCrs

Output Coordinate Reference System.

destinationCrs?: string

Property Value

string

exitWhenFull

Return as soon as the geometry is fully covered (defaults to True).

exitWhenFull?: boolean

Property Value

boolean

expression

Band math expression between assets

expression?: string

Property Value

string

format

Output image format.

format?: string

Property Value

string

height

Height in pixels for the output image

height?: number

Property Value

number

ids

Array of Item ids.

ids?: string

Property Value

string

itemsLimit

Return as soon as we have N items per geometry (defaults to 100).

itemsLimit?: number

Property Value

number

maxSize

Image output size limit if width and height limits are not set.

maxSize?: number

Property Value

number

noData

Overwrite internal Nodata value

noData?: string

Property Value

string

pixelSelection

Pixel selection method.

pixelSelection?: string

Property Value

string

query

JSON query expression for filtering items.

query?: string

Property Value

string

reproject

WarpKernel resampling algorithm (only used when doing re-projection). Defaults to nearest.

reproject?: string

Property Value

string

resampling

Resampling method.

resampling?: string

Property Value

string

rescale

comma (',') delimited Min,Max range. Can set multiple time for multiple bands.

rescale?: string[]

Property Value

string[]

returnMask

Add mask to the output data.

returnMask?: boolean

Property Value

boolean

scanLimit

Return as soon as we scan N items (defaults to 10000).

scanLimit?: number

Property Value

number

sel

Xarray Indexing using dimension names {dimension}={value}.

sel?: string[]

Property Value

string[]

selMethod

Xarray indexing method to use for inexact matches.

selMethod?: string

Property Value

string

skipCovered

Skip any items that would show up completely under the previous items (defaults to True).

skipCovered?: boolean

Property Value

boolean

sortby

Sorting expression (e.g. +/-property).

sortby?: string

Property Value

string

subdatasetBands

The index of a subdataset band within the asset.

subdatasetBands?: number[]

Property Value

number[]

subdatasetName

The name of a subdataset within the asset.

subdatasetName?: string

Property Value

string

timeLimit

Return after N seconds to avoid long requests (defaults to 5).

timeLimit?: number

Property Value

number

unscale

Apply internal Scale or Offset

unscale?: boolean

Property Value

boolean

width

Width in pixels for the output image

width?: number

Property Value

number

Inherited Property Details

abortSignal

The signal which can be used to abort requests.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

Inherited From OperationOptions.abortSignal

onResponse

A function to be called each time a response is received from the server while performing the requested operation. May be called multiple times.

onResponse?: RawResponseCallback

Property Value

RawResponseCallback

Inherited From OperationOptions.onResponse

requestOptions

Options used when creating and sending HTTP requests for this operation.

requestOptions?: OperationRequestOptions

Property Value

OperationRequestOptions

Inherited From OperationOptions.requestOptions

tracingOptions

Options used when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From OperationOptions.tracingOptions