GetCollectionTileJsonOptions Class

Definition

Options for collection-level TileJSON metadata operations.

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

Constructors

Name Description
GetCollectionTileJsonOptions(String)

Initializes a new instance of GetCollectionTileJsonOptions.

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.

Buffer

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

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.

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.
ExitWhenFull

Return as soon as the geometry is fully covered (defaults to True).

Expression

Band math expression between assets.

Ids

Array of Item ids.

ItemsLimit

Return as soon as we have N items per geometry (defaults to 100).

MaxZoom

Overwrite default maxzoom.

MinZoom

Overwrite default minzoom.

NoData

Overwrite internal Nodata value.

Padding

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

PixelSelection

Pixel selection method.

Query

JSON query expression for filtering items.

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.

ScanLimit

Return as soon as we scan N items (defaults to 10000).

Sel

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

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.

TileFormat

The format of the output tile image.

TileMatrixSetId

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

TileScale

Tile scale factor affecting output size.

TimeLimit

Return after N seconds to avoid long requests (defaults to 5).

Unscale

Apply internal Scale or Offset.

Methods

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

Explicit Interface Implementations

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

Applies to