GetCollectionBboxCropWithDimensionsOptions Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Options for the getCollectionBboxCropWithDimensions operation.
public class GetCollectionBboxCropWithDimensionsOptions : System.ClientModel.Primitives.IJsonModel<Azure.Analytics.PlanetaryComputer.GetCollectionBboxCropWithDimensionsOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.Analytics.PlanetaryComputer.GetCollectionBboxCropWithDimensionsOptions>type GetCollectionBboxCropWithDimensionsOptions = class
interface IJsonModel<GetCollectionBboxCropWithDimensionsOptions>
interface IPersistableModel<GetCollectionBboxCropWithDimensionsOptions>Public Class GetCollectionBboxCropWithDimensionsOptions
Implements IJsonModel(Of GetCollectionBboxCropWithDimensionsOptions), IPersistableModel(Of GetCollectionBboxCropWithDimensionsOptions)- Inheritance
-
GetCollectionBboxCropWithDimensionsOptions
- Implements
Constructors
| Name | Description |
|---|---|
| GetCollectionBboxCropWithDimensionsOptions(String, Single, Single, Single, Single, Int32, Int32, String) |
Initializes a new instance of GetCollectionBboxCropWithDimensionsOptions. |
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. |
| Bbox |
Bounding box (west, south, east, north). |
| Bidx |
Dataset band indexes. |
| Collection |
STAC Collection ID. |
| 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 |
| 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:
|
| 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 format for the tile or image (e.g., png, jpeg, webp). |
| Height |
Force output image height. |
| 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. |
| 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. |
| PixelSelection |
Pixel selection method. |
| Query |
JSON query expression for filtering items. |
| Reproject |
WarpKernel resampling algorithm (only used when doing re-projection). Defaults to |
| 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 |
| 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 |
Force output image width. |
