PlanetaryComputerModelFactory.GetTileNoTmsOptions Method

Definition

Options for the getTileNoTms operation.

public static Azure.Analytics.PlanetaryComputer.GetTileNoTmsOptions GetTileNoTmsOptions(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, float z = 0, float x = 0, float y = 0, Azure.Analytics.PlanetaryComputer.TileMatrixSetId? tileMatrixSetId = default, Azure.Analytics.PlanetaryComputer.TilerImageFormat? format = default, int? scale = default, float? buffer = default, string colorFormula = default, Azure.Analytics.PlanetaryComputer.ResamplingMethod? resampling = default, System.Collections.Generic.IEnumerable<string> rescale = default, Azure.Analytics.PlanetaryComputer.ColorMapNames? colorMapName = default, string colorMap = default, bool? returnMask = default, int? padding = 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 GetTileNoTmsOptions : 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 * single * single * single * Nullable<Azure.Analytics.PlanetaryComputer.TileMatrixSetId> * Nullable<Azure.Analytics.PlanetaryComputer.TilerImageFormat> * Nullable<int> * Nullable<single> * string * Nullable<Azure.Analytics.PlanetaryComputer.ResamplingMethod> * seq<string> * Nullable<Azure.Analytics.PlanetaryComputer.ColorMapNames> * string * Nullable<bool> * Nullable<int> * string * seq<int> * string * string * seq<string> * Nullable<Azure.Analytics.PlanetaryComputer.SelMethod> -> Azure.Analytics.PlanetaryComputer.GetTileNoTmsOptions
Public Shared Function GetTileNoTmsOptions (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 z As Single = 0, Optional x As Single = 0, Optional y As Single = 0, Optional tileMatrixSetId As Nullable(Of TileMatrixSetId) = Nothing, Optional format As Nullable(Of TilerImageFormat) = Nothing, Optional scale As Nullable(Of Integer) = Nothing, Optional buffer As Nullable(Of Single) = Nothing, Optional colorFormula As String = Nothing, Optional resampling As Nullable(Of ResamplingMethod) = 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 padding As Nullable(Of Integer) = 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 GetTileNoTmsOptions

Parameters

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").

assetAsBand
Nullable<Boolean>

Asset as Band.

noData
String

Overwrite internal Nodata value.

unscale
Nullable<Boolean>

Apply internal Scale or Offset.

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.

z
Single

Identifier (Z) selecting one of the scales defined in the TileMatrixSet and representing the scaleDenominator the tile.

x
Single

Column (X) index of the tile on the selected TileMatrix. It cannot exceed the MatrixHeight-1 for the selected TileMatrix.

y
Single

Row (Y) index of the tile on the selected TileMatrix. It cannot exceed the MatrixWidth-1 for the selected TileMatrix.

tileMatrixSetId
Nullable<TileMatrixSetId>

Identifier selecting one of the TileMatrixSetId supported (default: 'WebMercatorQuad')

format
Nullable<TilerImageFormat>

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

scale
Nullable<Int32>

Numeric scale factor for the tile. Higher values produce larger tiles.

buffer
Nullable<Single>

Buffer on each side of the given tile. It must be a multiple of 0.5. Output tilesize will be expanded to tilesize + 2 * buffer (e.g 0.5 = 257x257, 1.0 = 258x258).

colorFormula
String

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

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.

returnMask
Nullable<Boolean>

Add mask to the output data.

padding
Nullable<Int32>

Padding to apply to each tile edge. Helps reduce resampling artefacts along edges. Defaults to 0.

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"
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.
sel
IEnumerable<String>

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

selMethod
Nullable<SelMethod>

Xarray indexing method to use for inexact matches.

Returns

A new GetTileNoTmsOptions instance for mocking.

Applies to