Zonal Statistics¶
/zonal_stats/pixel_count/climate_engine_asset¶
Resource url example:
/zonal_stats/pixel_count/climate_engine_asset?dataset=GRIDMET_DROUGHT&variable=spi180d&bins=[0,40,80,120,160,200,240,280,320,360,400]&end_date=2000-12-30®ion=states&sub_choices=["Nevada"]
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET_DROUGHT |
||
variable |
yes |
spi180d |
||
end_date |
yes |
2019-12-31 |
||
bins |
no |
Bins for the pixel count, currently limited to 10 values |
-2, -1.5, -1.2,-0.7, -0.5, 0.5, 0.7, 1.2, 1.5, 2 |
|
feature_collection |
yes |
Feature collection name, see list of available assets |
states |
|
sub_choices |
no |
Select features, if not specified all feature data will be returned |
CA, NV |
|
export_path |
no |
Export CSV results to a Google cloud storage bucket (must have correct permissions) |
climate-engine-public/my_csv_file.csv |
|
export_format |
no |
File format of export |
json |
csv, json |
/zonal_stats/pixel_count/custom_asset¶
Resource url example:
/zonal_stats/pixel_count/custom_asset?dataset=GRIDMET_DROUGHT&variable=spei2y&bins=[0,40,80,120,160,200,240,280,320,360,400]&end_date=2000-12-30&asset_id=USGS/WBD/2017/HUC08&sub_choices=["Animas"]&filter_by=name
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET_DROUGHT |
||
variable |
yes |
spi180d |
||
end_date |
yes |
2019-12-31 |
||
bins |
no |
Bins for the pixel count, currently limited to 10 values |
-2, -1.5, -1.2, -0.7, -0.5, 0.5, 0.7, 1.2, 1.5, 2 |
|
asset_id |
yes |
Custom EE asset id, must have “Anyone can read” permissions |
‘projects/climate-engine/featureCollections /shp_simplified/ClimateEngine_US_Counties’ |
|
filter_by |
no |
Key name of property in feature collection (GIS users: this is the attribute name) |
Name |
|
sub_choices |
no |
Values of property in feature collection |
CA, NV |
|
export_path |
no |
Export CSV results to a Google cloud storage bucket (must have correct permissions) |
climate-engine-public/my_csv_file.csv |
|
export_format |
no |
File format of export |
json |
csv, json |
/zonal_stats/pixel_count/polygons¶
Resource url example:
/zonal_stats/pixel_count/polygons?dataset=GRIDMET_DROUGHT&variable=spi180d&bins=[0,40,80,120,160,200,240,280,320,360,400]&end_date=2000-12-30&coordinates=[[[-121.61,38.78], [-121.52,38.78],[-121.52,38.83],[-121.61,38.83],[-121.61,38.78]]]
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET_DROUGHT |
||
variable |
yes |
spi180d |
||
end_date |
yes |
2019-12-31 |
||
bins |
no |
Bins for the pixel count, currently limited to 10 values |
-2, -1.5, -1.2, -0.7, -0.5, 0.5, 0.7, 1.2, 1.5, 2 |
|
coordinates |
yes |
list of lon, lat pairs of polygon vertices |
[[[-121.61, 38.78], [-121.52, 38.78],[-121.52, 38.83],[-121.61, 38.83],[-121.61, 38.78]]] |
|
buffers |
no |
List of integer buffers (meters) to be applied to each geometry |
[400] |
|
export_path |
no |
Export CSV results to a Google cloud storage bucket (must have correct permissions) |
climate-engine-public/my_csv_file.csv |
|
export_format |
no |
File format of export |
json |
csv, json |
/zonal_stats/pixel_count/timeseries/climate_engine_asset¶
Resource url example:
/zonal_stats/pixel_count/timeseries/climate_engine_asset?dataset=GRIDMET_DROUGHT&variable=spi180d&bins=[0,40,80,120,160,200,240,280,320,360,400]&start_date=2019-06-01&end_date=2000-12-30®ion=states&sub_choices=["Nevada"]
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET_DROUGHT |
||
variable |
yes |
spi180d |
||
start_date |
yes |
2019-01-01 |
||
end_date |
yes |
2019-12-31 |
||
bins |
no |
Bins for the pixel count, currently limited to 10 values |
-2, -1.5, -1.2,-0.7, -0.5, 0.5, 0.7, 1.2, 1.5, 2 |
|
feature_collection |
yes |
Feature collection name, see list of available assets |
states |
|
sub_choices |
yes |
Select features, if not specified all feature data will be returned |
CA, NV |
|
export_path |
no |
Export CSV results to a Google cloud storage bucket (must have correct permissions) |
climate-engine-public/my_csv_file.csv |
|
export_format |
no |
File format of export |
json |
csv, json |
/zonal_stats/pixel_count/timeseries/custom_asset¶
Resource url example:
/zonal_stats/pixel_count/timeseries/custom_asset?dataset=GRIDMET_DROUGHT&variable=spei2y&bins=[0,40,80,120,160,200,240,280,320,360,400]&start_date=2019-06-01&end_date=2000-12-30&asset_id=USGS/WBD/2017/HUC08&sub_choices=["Animas"]&filter_by=name
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET_DROUGHT |
||
variable |
yes |
spi180d |
||
start_date |
yes |
2019-01-01 |
||
end_date |
yes |
2019-12-31 |
||
bins |
no |
Bins for the pixel count, currently limited to 10 values |
-2, -1.5, -1.2, -0.7, -0.5, 0.5, 0.7, 1.2, 1.5, 2 |
|
asset_id |
yes |
Custom EE asset id, must have “Anyone can read” permissions |
‘projects/climate-engine/featureCollections /shp_simplified/ClimateEngine_US_Counties’ |
|
filter_by |
yes |
Key name of property in feature collection (GIS users: this is the attribute name) |
Name |
|
sub_choices |
yes |
Values of property in feature collection |
CA, NV |
|
export_path |
no |
Export CSV results to a Google cloud storage bucket (must have correct permissions) |
climate-engine-public/my_csv_file.csv |
|
export_format |
no |
File format of export |
json |
csv, json |
/zonal_stats/pixel_count/timeseries/polygon¶
Resource url example:
/zonal_stats/pixel_count/timeseries/polygon?dataset=GRIDMET_DROUGHT&variable=spi180d&bins=[0,40,80,120,160,200,240,280,320,360,400]&start_date=2019-06-01&end_date=2000-12-30&coordinates=[[-121.61,38.78], [-121.52,38.78],[-121.52,38.83],[-121.61,38.83],[-121.61,38.78]]
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET_DROUGHT |
||
variable |
yes |
spi180d |
||
start_date |
yes |
2019-01-01 |
||
end_date |
yes |
2019-12-31 |
||
bins |
no |
Bins for the pixel count, currently limited to 10 values |
-2, -1.5, -1.2, -0.7, -0.5, 0.5, 0.7, 1.2, 1.5, 2 |
|
coordinates |
yes |
lon, lat pairs of polygon vertices |
[[-121.61, 38.78], [-121.52, 38.78],[-121.52, 38.83],[-121.61, 38.83],[-121.61, 38.78]] |
|
buffer |
no |
Integer buffers (meters) to be applied to geometry |
[400] |
|
export_path |
no |
Export CSV results to a Google cloud storage bucket (must have correct permissions) |
climate-engine-public/my_csv_file.csv |
|
export_format |
no |
File format of export |
json |
csv, json |
/zonal_stats/values/climate_engine_asset¶
Resource url example:
/zonal_stats/values/climate_engine_asset?dataset=GRIDMET&variable=tmmn&temporal_statistic=median&start_date=2014-01-01&end_date=2018-12-30®ion=counties&sub_choices=["CA - Mono"]
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
tmmx |
||
temporal_statistic |
yes |
mean, median, max, min, total |
||
start_date |
yes |
2019-01-01 |
||
end_date |
yes |
2019-12-31 |
||
feature_collection |
yes |
Feature collection name, see list of available assets |
states |
|
sub_choices |
no |
Select features, if not specified all feature data will be returned |
CA, NV |
|
area_reducer |
yes |
Statistic over region |
mean |
mean, median, min, max |
export_path |
no |
Export CSV results to a Google cloud storage bucket (must have correct permissions) |
climate-engine-public/my_csv_file.csv |
|
export_format |
no |
File format of export |
json |
csv, json |
/zonal_stats/values/custom_asset¶
Resource url example:
/zonal_stats/values/custom_asset?dataset=LANDSAT_TOA&variable=EVI&temporal_statistic=mean&start_date=2014-07-01&end_date=2014-08-31&asset_id=USGS/WBD/2017/HUC08&sub_choices=["Animas"]&filter_by=name
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
tmmx |
||
temporal_statistic |
yes |
mean, median, max, min, total |
||
start_date |
yes |
2019-01-01 |
||
end_date |
yes |
2019-12-31 |
||
asset_id |
yes |
Custom EE asset id, must have “Anyone can read” permissions |
‘projects/climate-engine/featureCollections/shp_simplified/ClimateEngine_US_Counties’ |
|
filter_by |
no |
Key name of property in feature collection (GIS users: this is the attribute name) |
Name |
|
sub_choices |
no |
Values of property in feature collection |
CA, NV |
|
area_reducer |
yes |
Statistic over region |
mean |
mean, median, min, max |
export_path |
no |
Export CSV results to a Google cloud storage bucket (must have correct permissions) |
climate-engine-public/my_csv_file.csv |
|
export_format |
no |
File format of export |
json |
csv, json |
/zonal_stats/values/polygons¶
Resource url example:
/zonal_stats/values/polygons?dataset=PRISM&variable=tmin&temporal_statistic=min&start_date=2014-01-01&end_date=2014-01-31&coordinates=[[[-121.61,38.78], [-121.52,38.78],[-121.52,38.83],[-121.61,38.83],[-121.61,38.78]]]
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
tmmx |
||
temporal_statistic |
yes |
mean, median, max, min, total |
||
start_date |
yes |
2019-01-01 |
||
end_date |
yes |
2019-12-31 |
||
coordinates |
yes |
lon, lat pairs of polygon vertices |
[[-121.61, 38.78], [-121.52, 38.78],[-121.52, 38.83],[-121.61, 38.83],[-121.61, 38.78]] |
|
buffers |
no |
List of integer buffers (meters) to be applied to each geometry |
[400] |
|
area_reducer |
yes |
Statistic over region |
mean |
mean, median, min, max |
export_path |
no |
Export CSV results to a Google cloud storage bucket (must have correct permissions) |
climate-engine-public/my_csv_file.csv |
|
export_format |
no |
File format of export |
json |
csv, json |
/zonal_stats/value/climate_engine_asset¶
Resource url example:
zonal_stats/value/climate_engine_asset?dataset=WRC&variable=WHP®ion=divisions&sub_choices=%5B%22NY%20-%20YATES%22%5D&area_reducer=mean
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
WRC |
||
variable |
yes |
WHP |
||
mask_image_id |
no |
Image mask ID |
||
mask_value |
no |
Image mask value |
||
region |
yes |
divisions |
||
feature_collection |
yes |
Feature collection name, see list of available assets |
states |
|
sub_choices |
no |
Select features, if not specified all feature data will be returned |
[“NY - YATES”] |
|
filter_by |
no |
“Name” |
||
area_reducer |
yes |
Statistic over region |
mean |
mean, median, min, max |
export_path |
no |
Export CSV results to a Google cloud storage bucket (must have correct permissions) |
climate-engine-public/my_csv_file.csv |
|
export_format |
no |
File format of export |
json |
csv, json |
/zonal_stats/value/custom_asset¶
Resource url example:
zonal_stats/value/custom_asset?dataset=WRC&variable=BP&asset_id=projects%2Fclimate-engine%2FfeatureCollections%2Fshp_orig%2FClimateEngine_US_Climate_Divisions_plus_AK&sub_choices=%5B%22NY%20-%20YATES%22%5D&filter_by=Name&area_reducer=mean
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
WRC |
||
variable |
yes |
BP |
||
mask_image_id |
no |
Image mask ID |
||
mask_value |
no |
Image mask value |
||
asset_id |
yes |
projects/climate-engine/featureCollections/shp_orig/ClimateEngine_US_Climate_Divisions_plus_AK |
||
sub_choices |
no |
Select features, if not specified all feature data will be returned |
[“NY - YATES”] |
|
filter_by |
no |
Name |
||
buffer |
no |
Buffer (in meters) to be applied to each geometry |
[400] |
|
area_reducer |
yes |
Statistic over region |
mean |
mean, median, min, max |
export_path |
no |
Export CSV results to a Google cloud storage bucket (must have correct permissions) |
climate-engine-public/my_csv_file.csv |
|
export_format |
no |
File format of export |
json |
csv, json |
/zonal_stats/value/points¶
Resource url example:
zonal_stats/value/points?dataset=WRC&variable=CFL&coordinates=%5B%5B-158.9844%2C62.3723%5D%5D&area_reducer=mean
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
WRC |
||
variable |
yes |
CFL |
||
mask_image_id |
no |
Image mask ID |
||
mask_value |
no |
Image mask value |
||
coordinates |
yes |
lon, lat pairs of points |
[[-158.9844,62.3723]] |
|
buffer |
no |
Buffer (in meters) to apply to each geometry |
[400] |
|
area_reducer |
yes |
Statistic over region |
mean |
mean, median, min, max |
export_path |
no |
Export CSV results to a Google cloud storage bucket (must have correct permissions) |
climate-engine-public/my_csv_file.csv |
|
export_format |
no |
File format of export |
json |
csv, json |
/zonal_stats/value/polygons¶
Resource url example:
zonal_stats/value/polygons?dataset=WRC&variable=FLEP8&coordinates=%5B%5B%5B-160.56%2C61.25%5D%2C%20%5B-159.85%2C61.25%5D%2C%5B-159.85%2C61.46%5D%2C%20%5B-160.56%2C61.46%5D%2C%20%5B-160.56%2C61.25%5D%5D%5D&area_reducer=mean
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
WRC |
||
variable |
yes |
FLEP8 |
||
mask_image_id |
no |
Image mask ID |
||
mask_value |
no |
Image mask value |
||
coordinates |
yes |
lon, lat pairs of polygon vertices |
[[-121.61, 38.78], [-121.52, 38.78],[-121.52, 38.83],[-121.61, 38.83],[-121.61, 38.78]] |
|
buffer |
no |
Buffer (in meters) to apply to each geometry |
[400] |
|
area_reducer |
yes |
Statistic over region |
mean |
mean, median, min, max |
export_path |
no |
Export CSV results to a Google cloud storage bucket (must have correct permissions) |
climate-engine-public/my_csv_file.csv |
|
export_format |
no |
File format of export |
json |
csv, json |