PlanetaryComputerModelFactory.GetItemPointOptions Method

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Source:

PlanetaryComputerModelFactory.cs

Options for item point query operations.

public static Azure.Analytics.PlanetaryComputer.GetItemPointOptions GetItemPointOptions(string collectionId = default, string itemId = default, float longitude = 0, float latitude = 0, 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, 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, string coordinateReferenceSystem = default, Azure.Analytics.PlanetaryComputer.ResamplingMethod? resampling = default);

static member GetItemPointOptions : string * string * single * single * seq<int> * seq<string> * string * seq<string> * Nullable<bool> * string * Nullable<bool> * Nullable<Azure.Analytics.PlanetaryComputer.WarpKernelResampling> * string * seq<int> * string * string * seq<string> * Nullable<Azure.Analytics.PlanetaryComputer.SelMethod> * string * Nullable<Azure.Analytics.PlanetaryComputer.ResamplingMethod> -> Azure.Analytics.PlanetaryComputer.GetItemPointOptions

Public Shared Function GetItemPointOptions (Optional collectionId As String = Nothing, Optional itemId As String = Nothing, Optional longitude As Single = 0, Optional latitude As Single = 0, 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 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 coordinateReferenceSystem As String = Nothing, Optional resampling As Nullable(Of ResamplingMethod) = Nothing) As GetItemPointOptions

Parameters

collectionId

String

STAC Collection Identifier.

itemId

String

STAC Item Identifier.

longitude

Single

Longitude.

latitude

Single

Latitude.

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.

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.

coordinateReferenceSystem

String

Coordinate Reference System of the input coords. Default to epsg:4326.

resampling

Nullable<ResamplingMethod>

Resampling method.

Returns

GetItemPointOptions

A new GetItemPointOptions instance for mocking.