GetItemPreviewWithFormatOptions 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 getItemPreviewWithFormat operation.
public class GetItemPreviewWithFormatOptions : System.ClientModel.Primitives.IJsonModel<Azure.Analytics.PlanetaryComputer.GetItemPreviewWithFormatOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.Analytics.PlanetaryComputer.GetItemPreviewWithFormatOptions>type GetItemPreviewWithFormatOptions = class
interface IJsonModel<GetItemPreviewWithFormatOptions>
interface IPersistableModel<GetItemPreviewWithFormatOptions>Public Class GetItemPreviewWithFormatOptions
Implements IJsonModel(Of GetItemPreviewWithFormatOptions), IPersistableModel(Of GetItemPreviewWithFormatOptions)- Inheritance
-
GetItemPreviewWithFormatOptions
- Implements
Constructors
| Name | Description |
|---|---|
| GetItemPreviewWithFormatOptions(String, String, String) |
Initializes a new instance of GetItemPreviewWithFormatOptions. |
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. |
| 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:
|
| DstCrs |
Output Coordinate Reference System. |
| Expression |
Band math expression between assets. |
| Format |
Output format for the tile or image (e.g., png, jpeg, webp). |
| Height |
Height in pixels for the output image. |
| ItemId |
STAC Item Identifier. |
| MaxSize |
Image output size limit if width and height limits are not set. |
| NoData |
Overwrite internal Nodata value. |
| 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. |
| Sel |
Xarray Indexing using dimension names |
| 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 |
Width in pixels for the output image. |
