Sign in
Xarray Tiler API

Statistics

Get Dataset statistics.

get/statistics

Request

  • Base URL: https://map.cal-adapt.org (the document declares no server; this is the origin it was published from)
  • URL: https://map.cal-adapt.org/statistics
  • Auth: none declared

Query parameters

urlstring required

Dataset URL

variablestring required

Xarray Variable name

drop_dimstring nullable

Dimension to drop

datetimestring nullable

Slice of time to read (if available)

groupstring nullable

Select a specific zarr group from a zarr hierarchy. Could be associated with a zoom level or dataset.

decode_timesboolean nullable

Whether to decode times

coord_crsstring nullable

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

dst_crsstring nullable

Output Coordinate Reference System.

string
OR
integer
OR
number
reproject'nearest' | 'bilinear' | 'cubic' | 'cubic_spline' | 'lanczos' | 'average' | 'mode' | 'sum' | 'rms' nullable

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

max_sizeinteger nullable
heightinteger nullable
widthinteger nullable
resampling'nearest' | 'bilinear' | 'cubic' | 'cubic_spline' | 'lanczos' | 'average' | 'mode' | 'gauss' | 'rms' nullable

RasterIO resampling algorithm. Defaults to nearest.

algorithm'hillshade' | 'contours' | 'normalizedIndex' | 'terrarium' | 'terrainrgb'

Algorithm name

algorithm_paramsstring nullable

Algorithm parameter

categoricalboolean nullable

Return statistics for categorical dataset. Defaults to False

pinteger[] nullable

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

histogram_binsstring nullable

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 nullable

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

Response

Returns dataset statistics.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.