GetCollectionPointOptions Class

Definition

Namespace:

Azure.Analytics.PlanetaryComputer

Assembly:

Azure.Analytics.PlanetaryComputer.dll

Package:

Azure.Analytics.PlanetaryComputer v1.0.0

Source:

GetCollectionPointOptions.cs

Options for collection-level point query operations.

public class GetCollectionPointOptions : System.ClientModel.Primitives.IJsonModel<Azure.Analytics.PlanetaryComputer.GetCollectionPointOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.Analytics.PlanetaryComputer.GetCollectionPointOptions>

type GetCollectionPointOptions = class
    interface IJsonModel<GetCollectionPointOptions>
    interface IPersistableModel<GetCollectionPointOptions>

Public Class GetCollectionPointOptions
Implements IJsonModel(Of GetCollectionPointOptions), IPersistableModel(Of GetCollectionPointOptions)

Inheritance

Object

GetCollectionPointOptions

Implements

IJsonModel<GetCollectionPointOptions> IPersistableModel<GetCollectionPointOptions> IPersistableModel<T>

Constructors

Name	Description
GetCollectionPointOptions(String, Single, Single)	Initializes a new instance of GetCollectionPointOptions.

Properties

Name	Description
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.
CollectionId	STAC Collection Identifier.
CoordinateReferenceSystem	Coordinate Reference System of the input coords. Default to epsg:4326.
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).
Latitude	Latitude.
Longitude	Longitude.
NoData	Overwrite internal Nodata value.
Query	JSON query expression for filtering items.
Reproject	WarpKernel resampling algorithm (only used when doing re-projection). Defaults to nearest.
Resampling	Resampling method.
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.
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<GetCollectionPointOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<GetCollectionPointOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<GetCollectionPointOptions>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<GetCollectionPointOptions>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<GetCollectionPointOptions>.Write(ModelReaderWriterOptions)