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/points
/probabilities/exceedance/polygons
/probabilities/exceedance/climate_engine_asset
/probabilities/exceedance/custom_asset
/probabilities/exxterior_probabilities/points
/probabilities/exterior/polygons
/probabilities/exterior/climate_engine_asset
/probabilities/exterior/custom_asset
/probabilities/interior/points
/probabilities/interior/polygons
/probabilities/interior/climate_engine_asset
/probabilities/interiorprobabilities/custom_asset

/probabilities/exceedance/points

Computes exceedance probabilities for one or more points.
Returns: json

Resource url example:

probabilities/exceedance/points?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-121.61%2C38.78%5D%5D

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

NLDAS2_DAILY, RTMA

variable

yes

tmmx

temporal_statistic

yes

mean, median, max, min, total

start_day

yes

15

end_day

yes

30

start_month

yes

06

end_month

yes

06

area_reducer

yes

Statistic over region

mean, median, min, max

mask_image_id

no

Image mask ID

mask_value

no

Image mask value

buffer

no

Buffer (in 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

operator

yes

exceedance operator

>=

>=, <=, <, >

value

yes

exceedance value

25

integer or float

coordinates

yes

lon, lat pairs of points

[[-158.9844,62.3723]]

/probabilities/exceedance/polygons

Computes exceedance probabilities for one or more polygons.
Returns: json

Resource url example:

/probabilities/exceedance/polygons?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

dataset

yes

NLDAS2_DAILY, RTMA

variable

yes

tmmx

temporal_statistic

yes

mean, median, max, min, total

start_day

yes

15

end_day

yes

30

start_month

yes

06

end_month

yes

06

area_reducer

yes

Statistic over region

mean, median, min, max

mask_image_id

no

Image mask ID

mask_value

no

Image mask value

buffer

no

Buffer (in 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

operator

yes

exceedance operator

>=

>=, <=, <, >

value

yes

exceedance value

25

integer or float

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

/probabilities/exceedance/climate_engine_asset

Computes exceedance probabilities for the features of a Climate Engine feature collection asset.
For a list of available county assets use /metadata/county_names endpoint.
Returns: json

Resource url example:

/probabilities/exceedance/climate_engine_asset?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&region=states&sub_choices=%5B%22Nevada%22%5D

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

NLDAS2_DAILY, RTMA

variable

yes

tmmx

temporal_statistic

yes

mean, median, max, min, total

start_day

yes

15

end_day

yes

30

start_month

yes

06

end_month

yes

06

area_reducer

yes

Statistic over region

mean, median, min, max

mask_image_id

no

Image mask ID

mask_value

no

Image mask value

buffer

no

Buffer (in 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

operator

yes

exceedance operator

>=

>=, <=, <, >

value

yes

exceedance value

25

integer or float

region

yes

states, counties, divisions

sub_choices

no

Select features, if not specified all feature data will be returned

CA, NV

filter_by

no

Key name of property in feature collection (GIS users: this is the attribute name)

Name

/probabilities/exceedance/custom_asset

Computes exceedance probabilities for the features of a custom feature collection asset.
Returns: json

Resource url example:

/probabilities/exceedance/custom_asset?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&asset_id=USGS%2FWBD%2F2017%2FHUC08&sub_choices=%5B%22Animas%22%5D&filter_by=Name

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

NLDAS2_DAILY, RTMA

variable

yes

tmmx

temporal_statistic

yes

mean, median, max, min, total

start_day

yes

15

end_day

yes

30

start_month

yes

06

end_month

yes

06

area_reducer

yes

Statistic over region

mean, median, min, max

mask_image_id

no

Image mask ID

mask_value

no

Image mask value

buffer

no

Buffer (in 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

operator

yes

exceedance operator

>=

>=, <=, <, >

value

yes

exceedance value

25

integer or float

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

/probabilities/exxterior_probabilities/points

Computes exterior probabilities for one or more points.
Returns: json

Resource url example:

/probabilities/exterior/points?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-121.61%2C38.78%5D%5D

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

NLDAS2_DAILY, RTMA

variable

yes

tmmx

temporal_statistic

yes

mean, median, max, min, total

start_day

yes

15

end_day

yes

30

start_month

yes

06

end_month

yes

06

area_reducer

yes

Statistic over region

mean, median, min, max

mask_image_id

no

Image mask ID

mask_value

no

Image mask value

buffer

no

Buffer (in 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

operator

yes

exterior operator

<=>

<=>, <>

value_1

yes

lower threshold

20

integer or float

value_2

yes

upper threshold

25

integer or float

coordinates

yes

lon, lat pairs of points

[[-158.9844,62.3723]]

/probabilities/exterior/polygons

Computes exterior probabilities for one or more polygons.
Returns: json

Resource url example:

/probabilities/exterior/polygons?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

dataset

yes

NLDAS2_DAILY, RTMA

variable

yes

tmmx

temporal_statistic

yes

mean, median, max, min, total

start_day

yes

15

end_day

yes

30

start_month

yes

06

end_month

yes

06

area_reducer

yes

Statistic over region

mean, median, min, max

mask_image_id

no

Image mask ID

mask_value

no

Image mask value

buffer

no

Buffer (in 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

operator

yes

exterior operator

<=>

<=>, <>

value_1

yes

lower threshold

20

integer or float

value_2

yes

upper threshold

25

integer or float

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

/probabilities/exterior/climate_engine_asset

Computes exterior probabilities for the features of a Climate Engine feature collection asset.
For a list of available county assets use /metadata/county_names endpoint.
Returns: json

Resource url example:

/probabilities/exterior/climate_engine_asset?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&region=states&sub_choices=%5B%22Nevada%22%5D

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

NLDAS2_DAILY, RTMA

variable

yes

tmmx

temporal_statistic

yes

mean, median, max, min, total

start_day

yes

15

end_day

yes

30

start_month

yes

06

end_month

yes

06

area_reducer

yes

Statistic over region

mean, median, min, max

mask_image_id

no

Image mask ID

mask_value

no

Image mask value

buffer

no

Buffer (in 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

operator

yes

exterior operator

<=>

<=>, <>

value_1

yes

lower threshold

20

integer or float

value_2

yes

upper threshold

25

integer or float

region

yes

states, counties, divisions

sub_choices

no

Select features, if not specified all feature data will be returned

CA, NV

filter_by

no

Key name of property in feature collection (GIS users: this is the attribute name)

Name

/probabilities/exterior/custom_asset

Computes exterior probabilities for the features of a custom feature collection asset.
Returns: json

Resource url example:

/probabilities/exterior/custom_asset?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&asset_id=USGS%2FWBD%2F2017%2FHUC08&sub_choices=%5B%22Animas%22%5D&filter_by=Name

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

NLDAS2_DAILY, RTMA

variable

yes

tmmx

temporal_statistic

yes

mean, median, max, min, total

start_day

yes

15

end_day

yes

30

start_month

yes

06

end_month

yes

06

area_reducer

yes

Statistic over region

mean, median, min, max

mask_image_id

no

Image mask ID

mask_value

no

Image mask value

buffer

no

Buffer (in 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

operator

yes

exterior operator

<=>

<=>, <>

value_1

yes

lower threshold

20

integer or float

value_2

yes

upper threshold

25

integer or float

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

/probabilities/interior/points

Computes interior probabilities for one or more points.
Returns: json

Resource url example:

/probabilities/interior/points?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-121.61%2C38.78%5D%5D

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

NLDAS2_DAILY, RTMA

variable

yes

tmmx

temporal_statistic

yes

mean, median, max, min, total

start_day

yes

15

end_day

yes

30

start_month

yes

06

end_month

yes

06

area_reducer

yes

Statistic over region

mean, median, min, max

mask_image_id

no

Image mask ID

mask_value

no

Image mask value

buffer

no

Buffer (in 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

operator

yes

interior operator

<=>

<=>, <>

value_1

yes

lower threshold

20

integer or float

value_2

yes

upper threshold

25

integer or float

coordinates

yes

lon, lat pairs of points

[[-158.9844,62.3723]]

/probabilities/interior/polygons

Computes interior probabilities for one or more polygons.
Returns: json

Resource url example:

/probabilities/interior/polygons?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

dataset

yes

NLDAS2_DAILY, RTMA

variable

yes

tmmx

temporal_statistic

yes

mean, median, max, min, total

start_day

yes

15

end_day

yes

30

start_month

yes

06

end_month

yes

06

area_reducer

yes

Statistic over region

mean, median, min, max

mask_image_id

no

Image mask ID

mask_value

no

Image mask value

buffer

no

Buffer (in 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

operator

yes

interior operator

<=>

<=>, <>

value_1

yes

lower threshold

20

integer or float

value_2

yes

upper threshold

25

integer or float

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

/probabilities/interior/climate_engine_asset

Computes interior probabilities for the features of a Climate Engine feature collection asset.
For a list of available county assets use /metadata/county_names endpoint.
Returns: json

Resource url example:

/probabilities/interior/climate_engine_asset?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&region=states&sub_choices=%5B%22Nevada%22%5D

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

NLDAS2_DAILY, RTMA

variable

yes

tmmx

temporal_statistic

yes

mean, median, max, min, total

start_day

yes

15

end_day

yes

30

start_month

yes

06

end_month

yes

06

area_reducer

yes

Statistic over region

mean, median, min, max

mask_image_id

no

Image mask ID

mask_value

no

Image mask value

buffer

no

Buffer (in 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

operator

yes

interior operator

<=>

<=>, <>

value_1

yes

lower threshold

20

integer or float

value_2

yes

upper threshold

25

integer or float

region

yes

states, counties, divisions

sub_choices

no

Select features, if not specified all feature data will be returned

CA, NV

filter_by

no

Key name of property in feature collection (GIS users: this is the attribute name)

Name

/probabilities/interiorprobabilities/custom_asset

Computes interior probabilities for the features of a custom feature collection asset.
Returns: json

Resource url example:

/probabilities/interior/custom_asset?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&asset_id=USGS%2FWBD%2F2017%2FHUC08&sub_choices=%5B%22Animas%22%5D&filter_by=Name

NAME

REQUIRED

DESCRIPTION

DEFAULT

EXAMPLE

dataset

yes

NLDAS2_DAILY, RTMA

variable

yes

tmmx

temporal_statistic

yes

mean, median, max, min, total

start_day

yes

15

end_day

yes

30

start_month

yes

06

end_month

yes

06

area_reducer

yes

Statistic over region

mean, median, min, max

mask_image_id

no

Image mask ID

mask_value

no

Image mask value

buffer

no

Buffer (in 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

operator

yes

interior operator

<=>

<=>, <>

value_1

yes

lower threshold

20

integer or float

value_2

yes

upper threshold

25

integer or float

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