v2

latestSwagger 2.02026-07-131451441001.2 KB
Tiles for STAC Items

Item Statistics

Merged assets statistics for a STAC item.

get/data/mosaic/collections/{collectionId}/items/{itemId}/statistics

Path parameters

collectionIdstring required

STAC Collection Identifier

itemIdstring required

STAC Item Identifier

Query parameters

api-versionstring required

The API version to use for this operation.

bidxinteger[]

Dataset band indexes

assetsstring[]

Asset's names.

expressionstring

Band math expression between assets

asset_bidxstring[]

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")

asset_as_bandboolean

Asset as Band

nodatastring

Overwrite internal Nodata value

unscaleboolean

Apply internal Scale or Offset

reproject'nearest' | 'bilinear' | 'cubic' | 'cubic_spline' | 'lanczos' | 'average' | 'mode' | 'max' | 'min' | 'med' | 'q1' | 'q3' | 'sum' | 'rms'

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

resampling'nearest' | 'bilinear' | 'cubic' | 'cubic_spline' | 'lanczos' | 'average' | 'mode' | 'gauss' | 'rms'

Resampling method.

max_sizeinteger

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

categoricalboolean

Return statistics for categorical dataset.

cinteger[]

List of pixel categorical values for which to report counts.

pinteger[]

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

histogram_binsstring

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

histogram_rangestring

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

subdataset_namestring

The name of a subdataset within the asset.

subdataset_bandsinteger[]

The index of a subdataset band within the asset.

crsstring

Coordinate Reference System.

datetimestring

Datetime to use for subsetting the asset.

selstring[]

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

sel_method'nearest' | 'linear' | 'bilinear' | 'cubic' | 'cubic_spline' | 'lanczos' | 'area' | 'mode'

Xarray indexing method to use for inexact matches.

algorithmstring

Algorithm name.

algorithm_paramsstring

Algorithm parameter.

heightinteger

Force output image height.

widthinteger

Force output image width.

Response

The request has succeeded.

TilerStacItemStatistics required

Return dataset's statistics.