PlanetaryComputerModelFactory.GetItemPreviewOptions Method
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 getItemPreview operation.
public static Azure.Analytics.PlanetaryComputer.GetItemPreviewOptions GetItemPreviewOptions(System.Collections.Generic.IEnumerable<int> bidx = default, System.Collections.Generic.IEnumerable<string> assets = default, string expression = default, System.Collections.Generic.IEnumerable<string> assetBandIndices = default, bool? assetAsBand = default, string noData = default, bool? unscale = default, Azure.Analytics.PlanetaryComputer.WarpKernelResampling? reproject = default, Azure.Analytics.PlanetaryComputer.TerrainAlgorithm? algorithm = default, string algorithmParams = default, string collectionId = default, string itemId = default, Azure.Analytics.PlanetaryComputer.TilerImageFormat? format = default, string colorFormula = default, string dstCrs = default, Azure.Analytics.PlanetaryComputer.ResamplingMethod? resampling = default, int? maxSize = default, int? height = default, int? width = default, System.Collections.Generic.IEnumerable<string> rescale = default, Azure.Analytics.PlanetaryComputer.ColorMapNames? colorMapName = default, string colorMap = default, bool? returnMask = default, string subdatasetName = default, System.Collections.Generic.IEnumerable<int> subdatasetBands = default, string crs = default, string datetime = default, System.Collections.Generic.IEnumerable<string> sel = default, Azure.Analytics.PlanetaryComputer.SelMethod? selMethod = default);static member GetItemPreviewOptions : seq<int> * seq<string> * string * seq<string> * Nullable<bool> * string * Nullable<bool> * Nullable<Azure.Analytics.PlanetaryComputer.WarpKernelResampling> * Nullable<Azure.Analytics.PlanetaryComputer.TerrainAlgorithm> * string * string * string * Nullable<Azure.Analytics.PlanetaryComputer.TilerImageFormat> * string * string * Nullable<Azure.Analytics.PlanetaryComputer.ResamplingMethod> * Nullable<int> * Nullable<int> * Nullable<int> * seq<string> * Nullable<Azure.Analytics.PlanetaryComputer.ColorMapNames> * string * Nullable<bool> * string * seq<int> * string * string * seq<string> * Nullable<Azure.Analytics.PlanetaryComputer.SelMethod> -> Azure.Analytics.PlanetaryComputer.GetItemPreviewOptionsPublic Shared Function GetItemPreviewOptions (Optional bidx As IEnumerable(Of Integer) = Nothing, Optional assets As IEnumerable(Of String) = Nothing, Optional expression As String = Nothing, Optional assetBandIndices As IEnumerable(Of String) = Nothing, Optional assetAsBand As Nullable(Of Boolean) = Nothing, Optional noData As String = Nothing, Optional unscale As Nullable(Of Boolean) = Nothing, Optional reproject As Nullable(Of WarpKernelResampling) = Nothing, Optional algorithm As Nullable(Of TerrainAlgorithm) = Nothing, Optional algorithmParams As String = Nothing, Optional collectionId As String = Nothing, Optional itemId As String = Nothing, Optional format As Nullable(Of TilerImageFormat) = Nothing, Optional colorFormula As String = Nothing, Optional dstCrs As String = Nothing, Optional resampling As Nullable(Of ResamplingMethod) = Nothing, Optional maxSize As Nullable(Of Integer) = Nothing, Optional height As Nullable(Of Integer) = Nothing, Optional width As Nullable(Of Integer) = Nothing, Optional rescale As IEnumerable(Of String) = Nothing, Optional colorMapName As Nullable(Of ColorMapNames) = Nothing, Optional colorMap As String = Nothing, Optional returnMask As Nullable(Of Boolean) = Nothing, Optional subdatasetName As String = Nothing, Optional subdatasetBands As IEnumerable(Of Integer) = Nothing, Optional crs As String = Nothing, Optional datetime As String = Nothing, Optional sel As IEnumerable(Of String) = Nothing, Optional selMethod As Nullable(Of SelMethod) = Nothing) As GetItemPreviewOptionsParameters
- bidx
- IEnumerable<Int32>
Dataset band indexes.
- assets
- IEnumerable<String>
Asset's names.
- expression
- String
Band math expression between assets.
- assetBandIndices
- IEnumerable<String>
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").
- noData
- String
Overwrite internal Nodata value.
- reproject
- Nullable<WarpKernelResampling>
WarpKernel resampling algorithm (only used when doing re-projection). Defaults to nearest.
- algorithm
- Nullable<TerrainAlgorithm>
Terrain algorithm name.
- algorithmParams
- String
Terrain algorithm parameters.
- collectionId
- String
STAC Collection Identifier.
- itemId
- String
STAC Item Identifier.
- format
- Nullable<TilerImageFormat>
Output format for the tile or image (e.g., png, jpeg, webp).
- colorFormula
- String
rio-color formula (info: https://github.com/mapbox/rio-color).
- dstCrs
- String
Output Coordinate Reference System.
- resampling
- Nullable<ResamplingMethod>
Resampling method.
- rescale
- IEnumerable<String>
comma (',') delimited Min,Max range. Can set multiple time for multiple bands.
- colorMapName
- Nullable<ColorMapNames>
Colormap name.
- colorMap
- String
JSON encoded custom Colormap.
- subdatasetName
- String
The name of a subdataset within the asset.
- subdatasetBands
- IEnumerable<Int32>
The index of a subdataset band within the asset.
- crs
- String
Coordinate Reference System.
- datetime
- String
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"
- sel
- IEnumerable<String>
Xarray Indexing using dimension names {dimension}={value}.
Returns
A new GetItemPreviewOptions instance for mocking.
