GetItemStatisticsOptions Class

Definition

Namespace:
Azure.Analytics.PlanetaryComputer
Assembly:
Azure.Analytics.PlanetaryComputer.dll
Package:
Azure.Analytics.PlanetaryComputer v1.0.0
Source:
GetItemStatisticsOptions.cs

Options for item merged statistics operations.

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

Constructors

Name Description
GetItemStatisticsOptions(String, String)

Initializes a new instance of GetItemStatisticsOptions.

Properties

Name Description
Algorithm

Algorithm name.
AlgorithmParams

Algorithm parameter.
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.
Bidx

Dataset band indexes.
Categorical

Return statistics for categorical dataset.
CategoriesPixels

List of pixel categorical values for which to report counts.
CollectionId

STAC Collection Identifier.
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.
Expression

Band math expression between assets.
Height

Force output image height.
HistogramBins

Defines the number of equal-width bins in the given range (10, by default). If bins is a sequence (comma , delimited values), it defines a monotonically increasing array of bin edges, including the rightmost edge, allowing for non-uniform bin widths. link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html
HistogramRange

Comma , delimited range of the bins. The lower and upper range of the bins. If not provided, range is simply (a.min(), a.max()). Values outside the range are ignored. The first element of the range must be less than or equal to the second. range affects the automatic bin computation as well. link: https://numpy.org/doc/stable/reference/generated/numpy.histogram.html
ItemId

STAC Item Identifier.
MaxSize

Maximum dimension in pixels for the source data used to calculate statistics.
NoData

Overwrite internal Nodata value.
Percentiles

List of percentile values (default to [2, 98]).
Reproject

WarpKernel resampling algorithm (only used when doing re-projection). Defaults to nearest.
Resampling

Resampling method.
Sel

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

Xarray indexing method to use for inexact matches.
SubdatasetBands

The index of a subdataset band within the asset.
SubdatasetName

The name of a subdataset within the asset.
Unscale

Apply internal Scale or Offset.
Width

Force output image width.

Methods

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

Explicit Interface Implementations

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

Applies to