PlanetaryComputerModelFactory.GetSearchTileJsonOptions Method

Definition

Namespace:: Azure.Analytics.PlanetaryComputer

Assembly:: Azure.Analytics.PlanetaryComputer.dll

Package:: Azure.Analytics.PlanetaryComputer v1.0.0

Source:: PlanetaryComputerModelFactory.cs

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 search-based TileJSON metadata operations.

public static Azure.Analytics.PlanetaryComputer.GetSearchTileJsonOptions GetSearchTileJsonOptions(string searchId = default, 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, int? scanLimit = default, int? itemsLimit = default, int? timeLimit = default, bool? exitWhenFull = default, bool? skipCovered = 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, Azure.Analytics.PlanetaryComputer.TileMatrixSetId? tileMatrixSetId = default, Azure.Analytics.PlanetaryComputer.TilerImageFormat? tileFormat = default, int? tileScale = default, int? minZoom = default, int? maxZoom = default, int? padding = default, float? buffer = default, string colorFormula = default, string collectionId = default, Azure.Analytics.PlanetaryComputer.ResamplingMethod? resampling = default, Azure.Analytics.PlanetaryComputer.PixelSelection? pixelSelection = default, Azure.Analytics.PlanetaryComputer.TerrainAlgorithm? algorithm = default, string algorithmParams = default, System.Collections.Generic.IEnumerable<string> rescale = default, Azure.Analytics.PlanetaryComputer.ColorMapNames? colormapName = default, string colormap = default, bool? returnMask = default);

static member GetSearchTileJsonOptions : string * seq<int> * seq<string> * string * seq<string> * Nullable<bool> * string * Nullable<bool> * Nullable<Azure.Analytics.PlanetaryComputer.WarpKernelResampling> * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<bool> * Nullable<bool> * string * seq<int> * string * string * seq<string> * Nullable<Azure.Analytics.PlanetaryComputer.SelMethod> * Nullable<Azure.Analytics.PlanetaryComputer.TileMatrixSetId> * Nullable<Azure.Analytics.PlanetaryComputer.TilerImageFormat> * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<int> * Nullable<single> * string * string * Nullable<Azure.Analytics.PlanetaryComputer.ResamplingMethod> * Nullable<Azure.Analytics.PlanetaryComputer.PixelSelection> * Nullable<Azure.Analytics.PlanetaryComputer.TerrainAlgorithm> * string * seq<string> * Nullable<Azure.Analytics.PlanetaryComputer.ColorMapNames> * string * Nullable<bool> -> Azure.Analytics.PlanetaryComputer.GetSearchTileJsonOptions

Public Shared Function GetSearchTileJsonOptions (Optional searchId As String = Nothing, 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 scanLimit As Nullable(Of Integer) = Nothing, Optional itemsLimit As Nullable(Of Integer) = Nothing, Optional timeLimit As Nullable(Of Integer) = Nothing, Optional exitWhenFull As Nullable(Of Boolean) = Nothing, Optional skipCovered 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, Optional tileMatrixSetId As Nullable(Of TileMatrixSetId) = Nothing, Optional tileFormat As Nullable(Of TilerImageFormat) = Nothing, Optional tileScale As Nullable(Of Integer) = Nothing, Optional minZoom As Nullable(Of Integer) = Nothing, Optional maxZoom As Nullable(Of Integer) = Nothing, Optional padding As Nullable(Of Integer) = Nothing, Optional buffer As Nullable(Of Single) = Nothing, Optional colorFormula As String = Nothing, Optional collectionId As String = Nothing, Optional resampling As Nullable(Of ResamplingMethod) = Nothing, Optional pixelSelection As Nullable(Of PixelSelection) = Nothing, Optional algorithm As Nullable(Of TerrainAlgorithm) = Nothing, Optional algorithmParams As String = 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) As GetSearchTileJsonOptions

Parameters

searchId: String

Search Id (pgSTAC Search Hash).

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.

scanLimit: Nullable<Int32>

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

itemsLimit: Nullable<Int32>

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

timeLimit: Nullable<Int32>

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

exitWhenFull: Nullable<Boolean>

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

skipCovered: Nullable<Boolean>

Skip any items that would show up completely under the previous items (defaults to True).

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.