CHchloris
Cloud Optimized GeoTIFF

Geojson Statistics

Get Statistics from a geojson feature or featureCollection.

post/tiles/cog/statistics

Request

Query parameters

data_pathstring nullable

The reporting unit entry's dataPath parameter. Should be used instead of url in most cases.

carbon_poolstring nullable

The carbon pool for the report unit layer. Valid options are: agb, bgb, dom. Defaults to agb. Requires data_path to be set.

Example:agb
product_typestring nullable

The product type for the report unit layer. Valid options are: stock, change, cumulative_change, forest, nonforest, forest_area_gain, forest_area_loss, forest_area_degradation. Requires data_path to be set.

Example:stock
product_variantstring nullable

The product variant id for the report unit layer. May be omitted to use the default variant. Requires data_path and product_type to be set. Deprecated in favor of carbon_pool and resolution.

Example:dynamic-30m
resolutioninteger nullable

The nominal group distance in meters report unit layer. May be omitted to use highest resolution available for the given zoom level. Requires data_path and product_type to be set.

Example:30
yearinteger nullable

The year for the report unit layer. Should be used instead of bidx in most cases. Requires data_path and product_type to be set.

Example:2000
analysis_completed_atstring nullable

The analysisCompletedAt from the report unit entry to ensure the latest data is fetched.

Example:2024-01-01T00:00Z
urlstring nullable

Dataset URL, may be omitted if using data_path (recommended).

coord_crsstring nullable

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

dst_crsstring nullable

Output Coordinate Reference System.

bidxinteger[] nullable

Dataset band indexes

expressionstring nullable

rio-tiler's band math expression

number
OR
integer
OR
string
unscaleboolean nullable

Apply internal Scale/Offset. Defaults to False.

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

RasterIO resampling algorithm. Defaults to nearest.

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

Request body

OR

Response

Return dataset's statistics from feature or featureCollection.

OR

Changes

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