GetItemBboxCropWithDimensionsOptions Class

Definition

Options for the getItemBboxCropWithDimensions operation.

public class GetItemBboxCropWithDimensionsOptions : System.ClientModel.Primitives.IJsonModel<Azure.Analytics.PlanetaryComputer.GetItemBboxCropWithDimensionsOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.Analytics.PlanetaryComputer.GetItemBboxCropWithDimensionsOptions>
type GetItemBboxCropWithDimensionsOptions = class
    interface IJsonModel<GetItemBboxCropWithDimensionsOptions>
    interface IPersistableModel<GetItemBboxCropWithDimensionsOptions>
Public Class GetItemBboxCropWithDimensionsOptions
Implements IJsonModel(Of GetItemBboxCropWithDimensionsOptions), IPersistableModel(Of GetItemBboxCropWithDimensionsOptions)
Inheritance
GetItemBboxCropWithDimensionsOptions
Implements

Constructors

Name Description
GetItemBboxCropWithDimensionsOptions(String, String, Single, Single, Single, Single, Int32, Int32, String)

Initializes a new instance of GetItemBboxCropWithDimensionsOptions.

Properties

Name Description
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.

Bidx

Dataset band indexes.

CollectionId

STAC Collection Identifier.

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.

Expression

Band math expression between assets.

Format

Output format for the tile or image (e.g., png, jpeg, webp).

Height

Force output image height.

ItemId

STAC Item Identifier.

MaxSize

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

MaxX

Bounding box max X.

MaxY

Bounding box max Y.

MinX

Bounding box min X.

MinY

Bounding box min Y.

NoData

Overwrite internal Nodata value.

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.

Sel

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

SelMethod

Xarray indexing method to use for inexact matches.

SubdatasetBands

The index of a subdataset band within the asset.

SubdatasetName

The name of a subdataset within the asset.

Unscale

Apply internal Scale or Offset.

Width

Force output image width.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<GetItemBboxCropWithDimensionsOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<GetItemBboxCropWithDimensionsOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<GetItemBboxCropWithDimensionsOptions>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<GetItemBboxCropWithDimensionsOptions>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<GetItemBboxCropWithDimensionsOptions>.Write(ModelReaderWriterOptions)

Applies to