⚠️ Climate Engine documentation is moving to a new support site. Please visit ClimateEngine.org and click “Get Started” to access the latest documentation. This site will transition fully on May 1, so please update your bookmarks before then.

Probabilities

The Probabilties endpoints are used to generate statistics for Climate Engine datasets over different geometries.

There are three groups of Probabilities endpoints:

/probabilities/exceedance - The exceedance probabilities endpoints produces the probability of a variable value to exceed a threshold at a location defined by a geometry.

/probabilities/exterior - The exterior probabilities endpoints produces the probability of a variable value to lie outside of a lower and an upper threshold at a location defined by a geometry.

/probabilities/interior - The interior probabilities endpoints produces the probability of a variable value to lie inside of a lower and an upper threshold at a location defined by a geometry.

/probabilities/exceedance/coordinates

/probabilities/exceedance/feature_collection

/probabilities/exterior/coordinates

/probabilities/exterior/feature_collection

/probabilities/interior/coordinates

/probabilities/interior/feature_collection

/probabilities/exceedance/coordinates

Computes exceedance probabilities for points or polygons.

Returns: json

Resource url example:

/probabilities/exceedance/coordinates?dataset=GRIDMET&variable=tmmx&temporal_statistic=mean&start_day=15&end_day=20&start_month=06&end_month=06&area_reducer=mean&export_format=json&operator=%3E%3D&value=25&coordinates=%5B%5B%5B-121.61%2C38.78%5D%2C%5B-121.52%2C38.78%5D%2C%5B-121.52%2C38.83%5D%2C%5B-121.61%2C38.83%5D%2C%5B-121.61%2C38.78%5D%5D%5D

NAME	REQUIRED	DESCRIPTION	DEFAULT	EXAMPLE
coordinates	yes	lon, lat pairs of points or polygon vertices, see https://support.climateengine.org/article/152-formatting-coordinates-for-api-requests		[[-121.61, 38.78], [-121.52, 38.78],[-121.52, 38.83],[-121.61, 38.83],[-121.61, 38.78]]
simplify_geometry	no	maxError in meters, see ee.Feature.simplify	None
buffer	no	Buffer (in meters) to be applied to each geometry		[400]
area_reducer	yes	Statistic over region		mean, median, min, max
dataset	yes			NLDAS2_DAILY, RTMA
variable	yes		tmmx
mask_image_id	no	Image mask ID
mask_band	no	Mask band
mask_value	no	Image mask value
start_day	yes			15
end_day	yes			30
start_month	yes			06
end_month	yes			06
temporal_statistic	yes			mean, median, max, min, total
operator	yes	exceedance operator	>=	>=, <=, <, >
value	yes	exceedance value	25	integer or float
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

/probabilities/exceedance/feature_collection

Computes exceedance probabilities for the features of an Earth Engine FeatureCollection.

Returns: json

Resource url example:

/probabilities/exceedance/feature_collection?dataset=GRIDMET&variable=tmmx&temporal_statistic=mean&start_day=15&end_day=20&start_month=06&end_month=06&area_reducer=mean&export_format=json&operator=%3E%3D&value=25&feature_collection_asset_id=USGS%2FWBD%2F2017%2FHUC08&sub_choices=%5B%22Animas%22%5D&filter_by=Name

NAME	REQUIRED	DESCRIPTION	DEFAULT	EXAMPLE
feature_collection_asset_id	yes	EE FeatureCollection asset id, must have “Anyone can read” permissions		projects/climate-engine/featureCollections /shp_simplified/ClimateEngine_US_States
filter_by	no	Key name of property in feature collection (GIS users: this is the attribute name)		Name
simplify_geometry	no	maxError in meters, see ee.Feature.simplify	None
sub_choices	no	Values of property in feature collection		Idaho, Nevada
buffer	no	Buffer (in meters) to be applied to each geometry		[400]
area_reducer	yes	Statistic over region		mean, median, min, max
dataset	yes			NLDAS2_DAILY, RTMA
variable	yes		tmmx
mask_image_id	no	Image mask ID
mask_band	no	Mask band
mask_value	no	Image mask value
start_day	yes			15
end_day	yes			30
start_month	yes			06
end_month	yes			06
temporal_statistic	yes			mean, median, max, min, total
operator	yes	exceedance operator	>=	>=, <=, <, >
value	yes	exceedance value	25	integer or float
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

/probabilities/exterior/coordinates

Computes exterior probabilities for points or polygons.

Returns: json

Resource url example:

/probabilities/exterior/coordinates?dataset=GRIDMET&variable=tmmx&temporal_statistic=mean&start_day=15&end_day=20&start_month=06&end_month=06&area_reducer=mean&export_format=json&operator=%3C%3D%3E&value_1=20&value_2=25&coordinates=%5B%5B%5B-121.61%2C38.78%5D%2C%5B-121.52%2C38.78%5D%2C%5B-121.52%2C38.83%5D%2C%5B-121.61%2C38.83%5D%2C%5B-121.61%2C38.78%5D%5D%5D

NAME	REQUIRED	DESCRIPTION	DEFAULT	EXAMPLE
coordinates	yes	lon, lat pairs of polygon vertices, see https://support.climateengine.org/article/152-formatting-coordinates-for-api-requests		[[-121.61, 38.78], [-121.52, 38.78],[-121.52, 38.83],[-121.61, 38.83],[-121.61, 38.78]]
simplify_geometry	no	maxError in meters, see ee.Feature.simplify	None
buffer	no	Buffer (in meters) to be applied to each geometry		[400]
area_reducer	yes	Statistic over region		mean, median, min, max
dataset	yes			NLDAS2_DAILY, RTMA
variable	yes		tmmx
mask_image_id	no	Image mask ID
mask_band	no	Mask band
mask_value	no	Image mask value
start_day	yes			15
end_day	yes			30
start_month	yes			06
end_month	yes			06
temporal_statistic	yes			mean, median, max, min, total
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

/probabilities/exterior/feature_collection

Computes exterior probabilities for the features of an Earth Engine FeatureCollection.

Returns: json

Resource url example:

/probabilities/exterior/feature_collection?dataset=GRIDMET&variable=tmmx&temporal_statistic=mean&start_day=15&end_day=20&start_month=06&end_month=06&area_reducer=mean&export_format=json&operator=%3C%3D%3E&value_1=20&value_2=25&feature_collection_asset_id=USGS%2FWBD%2F2017%2FHUC08&sub_choices=%5B%22Animas%22%5D&filter_by=Name

NAME	REQUIRED	DESCRIPTION	DEFAULT	EXAMPLE
feature_collection_asset_id	yes	EE FeatureCollection asset id, must have “Anyone can read” permissions		projects/climate-engine/featureCollections /shp_simplified/ClimateEngine_US_States
filter_by	no	Key name of property in feature collection (GIS users: this is the attribute name)		Name
simplify_geometry	no	maxError in meters, see ee.Feature.simplify	None
sub_choices	no	Values of property in feature collection		Idaho, Nevada
buffer	no	Buffer (in meters) to be applied to each geometry		[400]
area_reducer	yes	Statistic over region		mean, median, min, max
dataset	yes			NLDAS2_DAILY, RTMA
variable	yes		tmmx
mask_image_id	no	Image mask ID
mask_band	no	Mask band
mask_value	no	Image mask value
start_day	yes			15
end_day	yes			30
start_month	yes			06
end_month	yes			06
temporal_statistic	yes			mean, median, max, min, total
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

/probabilities/interior/coordinates

Computes interior probabilities for points polygons.

Returns: json

Resource url example:

/probabilities/interior/coordinates?dataset=GRIDMET&variable=tmmx&temporal_statistic=mean&start_day=15&end_day=20&start_month=06&end_month=06&area_reducer=mean&export_format=json&operator=%3C%3D%3E&value_1=20&value_2=25&coordinates=%5B%5B%5B-121.61%2C38.78%5D%2C%5B-121.52%2C38.78%5D%2C%5B-121.52%2C38.83%5D%2C%5B-121.61%2C38.83%5D%2C%5B-121.61%2C38.78%5D%5D%5D

NAME	REQUIRED	DESCRIPTION	DEFAULT	EXAMPLE
coordinates	yes	lon, lat pairs of polygon vertices, see https://support.climateengine.org/article/152-formatting-coordinates-for-api-requests		[[-121.61, 38.78], [-121.52, 38.78],[-121.52, 38.83],[-121.61, 38.83],[-121.61, 38.78]]
simplify_geometry	no	maxError in meters, see ee.Feature.simplify	None
buffer	no	Buffer (in meters) to be applied to each geometry		[400]
area_reducer	yes	Statistic over region		mean, median, min, max
dataset	yes			NLDAS2_DAILY, RTMA
variable	yes		tmmx
mask_image_id	no	Image mask ID
mask_band	no	Mask band
mask_value	no	Image mask value
start_day	yes			15
end_day	yes			30
start_month	yes			06
end_month	yes			06
temporal_statistic	yes			mean, median, max, min, total
operator	yes	interior operator	<=>	<=>, <>
value_1	yes	lower threshold	20	integer or float
value_2	yes	upper threshold	25	integer or float
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

/probabilities/interior/feature_collection

Computes interior probabilities for the features of an Earth Engine Feature Collection.

Returns: json

Resource url example:

/probabilities/interior/feature_collection?dataset=GRIDMET&variable=tmmx&temporal_statistic=mean&start_day=15&end_day=20&start_month=06&end_month=06&area_reducer=mean&export_format=json&operator=%3C%3D%3E&value_1=20&value_2=25&feature_collection_asset_id=USGS%2FWBD%2F2017%2FHUC08&sub_choices=%5B%22Animas%22%5D&filter_by=Name

NAME	REQUIRED	DESCRIPTION	DEFAULT	EXAMPLE
feature_collection_asset_id	yes	EE FeatureCollection asset id, must have “Anyone can read” permissions		projects/climate-engine/featureCollections /shp_simplified/ClimateEngine_US_States
filter_by	no	Key name of property in feature collection (GIS users: this is the attribute name)		Name
simplify_geometry	no	maxError in meters, see ee.Feature.simplify	None
sub_choices	no	Values of property in feature collection		Idaho, Nevada
buffer	no	Buffer (in meters) to be applied to each geometry		[400]
area_reducer	yes	Statistic over region		mean, median, min, max
dataset	yes			NLDAS2_DAILY, RTMA
variable	yes		tmmx
mask_image_id	no	Image mask ID
mask_band	no	Mask band
mask_value	no	Image mask value
start_day	yes			15
end_day	yes			30
start_month	yes			06
end_month	yes			06
temporal_statistic	yes			mean, median, max, min, total
operator	yes	interior operator	<=>	<=>, <>
value_1	yes	lower threshold	20	integer or float
value_2	yes	upper threshold	25	integer or float
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