PlanetaryComputerModelFactory.GetItemStatisticsOptions 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 item merged statistics operations.

public static Azure.Analytics.PlanetaryComputer.GetItemStatisticsOptions GetItemStatisticsOptions(string collectionId = default, string itemId = 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, Azure.Analytics.PlanetaryComputer.ResamplingMethod? resampling = default, int? maxSize = default, bool? categorical = default, System.Collections.Generic.IEnumerable<int> categoriesPixels = default, System.Collections.Generic.IEnumerable<int> percentiles = default, string histogramBins = default, string histogramRange = 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 algorithm = default, string algorithmParams = default, int? height = default, int? width = default);

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

Public Shared Function GetItemStatisticsOptions (Optional collectionId As String = Nothing, Optional itemId 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 resampling As Nullable(Of ResamplingMethod) = Nothing, Optional maxSize As Nullable(Of Integer) = Nothing, Optional categorical As Nullable(Of Boolean) = Nothing, Optional categoriesPixels As IEnumerable(Of Integer) = Nothing, Optional percentiles As IEnumerable(Of Integer) = Nothing, Optional histogramBins As String = Nothing, Optional histogramRange As String = 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 algorithm As String = Nothing, Optional algorithmParams As String = Nothing, Optional height As Nullable(Of Integer) = Nothing, Optional width As Nullable(Of Integer) = Nothing) As GetItemStatisticsOptions

Parameters

collectionId: String

STAC Collection Identifier.

itemId: String

STAC Item Identifier.

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.

resampling: Nullable<ResamplingMethod>

Resampling method.

maxSize: Nullable<Int32>

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

categorical: Nullable<Boolean>

Return statistics for categorical dataset.

categoriesPixels: IEnumerable<Int32>

List of pixel categorical values for which to report counts.

percentiles: IEnumerable<Int32>

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

histogramBins: String

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: String

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

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.