Raster
Raster Endpoints¶
The Maps endpoints are used to generate maps (and map statistics) of the datasets available in Climate Engine. There are two groups of Maps endpoints:
/raster/mapid - These are used to generate Earth Engine maps, and produce an Earth Engine map ID value.
/raster/export - These endpoints are used to generate a map and export it to a Google Cloud Storage bucket.
NOTES:
-
The endpoints ending in “standard_index” are only valid for indices like SPI, SPEI and EDDI.
-
Additionally, “forecasts” endpoints are only available for forecast datasets (i.e. CFS_GRIDMET and FRET).
-
For the “anomalies” endpoints, the calculations “anompercentof” and “anompercentchange” are not valid for temperature variables.
/raster/export/task_update¶
- Checks the status of an Earth Engine export tasks.
- Returns: json
URL Example:
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| task_id | yes | Earth Engine ID of the task (from output of export endpoint) | 2BFYQPFADAYHRGTRME2OXFD7 |
/raster/export/task_queue¶
- Lists all exports of chosen tasks states in the Earth Engine task queue.
- Returns: json
URL Example
https://api.climateengine.org/raster/export/task_queue?task_states=RUNNING%2C%20PENDING%2C%20FAILED%2C%20SUCCEEDED
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| task_states | list of task states | READY, RUNNING, SUCCEEDED, FAILED | RUNNING, FAILED |
/raster/export/values¶
- Exports a map of values to a Google Cloud Storage bucket. The temporal statistic is applied over the date range defined by start_date and end_date.
- Returns: json, Earth Engine task ID
URL Example:
https://api.climateengine.org/raster/export/values?dataset=GRIDMET&variable=tmmx&temporal_statistic=mean&start_date=2010-06-01&end_date=2010-06-30&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| temporal_statistic | yes | mean | mean, median, max, min, total | |
| start_date | yes | 2010-06-01 | 2019-01-01 | |
| end_date | yes | 2010-06-30 | 2019-12-31 | |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] |
/raster/export/forecasts/values¶
- Exports a map of forecast values to a Google Cloud Storage bucket. The temporal statistic is applied over the date range defined by start_date and end_date.
- Returns: json, Earth Engine task ID
URL Example:
https://api.climateengine.org/raster/export/forecasts/values?dataset=CFS_GRIDMET&variable=tmmx&temporal_statistic=mean&model=ens_mean&start_day=day01&end_day=day07&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | CFS_ GRIDMET | CFS_GRIDMET | |
| variable | yes | tmmx | pet, pr, tmmx, tmmn | |
| model | yes | ens01 to en | ens_mean | ens_max, ens_min, ... |
| temporal_statistic | yes | mean | mean, median, max, min, total | |
| start_day | yes | day01 to day28, start_day <= end_day | day01 | day15 |
| end_day | yes | day01 to day28, end_day >= start_day | day07 | day17 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] |
/raster/export/climatologies¶
- Exports a map of average values to a Google Cloud Storage bucket. The temporal statistic is applied over the date range defined by start_date and end_date.
- Returns: json, Earth Engine task ID
URL Example:
https://api.climateengine.org/raster/export/climatologies?dataset=GRIDMET&variable=tmmx&temporal_statistic=mean&start_season=08-01&end_season=10-31&start_year=2016&end_year=2018&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| temporal_statistic | yes | mean | mean, median, max, min, total | |
| start_season | yes | 08-01 | 05-10 | |
| end_season | yes | 10-31 | 10-16 | |
| start_year | yes | Start year for the climatology | 2016 | 1981 |
| end_year | yes | End year for the climatology | 2018 | 2010 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] |
/raster/export/anomalies¶
- Exports a map of anomalies to a Google Cloud Storage bucket. The following calculation choices can be specified:
- anom: differences of the values from average conditions
- anompercentof: the values divided by the average conditions multiplied by 100 to cast as a percent
- anompercentchange: difference of values from average conditions divided by average conditions and then multiplied by 100 to cast as a percent
- Returns: json, Earth Engine task ID
URL Example:
https://api.climateengine.org/raster/export/anomalies?dataset=GRIDMET&variable=tmmx&temporal_statistic=mean&calculation=anom&start_date=2010-06-01&end_date=2010-06-30&start_year=2016&end_year=2018&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| temporal_statistic | yes | mean | mean, median, max, min, total | |
| calculation | yes | Anomaly calculation | anom | anom, anompercentof, anompercentchange |
| start_date | yes | 2010-06-01 | 2019-01-01 | |
| end_date | yes | 2010-06-30 | 2019-12-31 | |
| start_year | yes | Start year for the climatology | 2016 | 1981 |
| end_year | yes | End year for the climatology | 2018 | 2010 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] |
/raster/export/forecasts/anomalies¶
- Exports a map of anomaly forecasts to a Google Cloud Storage bucket. The following calculation choices can be specified:
- anom: differences of the values from average conditions
- anompercentof: the values divided by the average conditions multiplied by 100 to cast as a percent
- anompercentchange: difference of values from average conditions divided by average conditions and then multiplied by 100 to cast as a percent
- Returns: json, Earth Engine task ID
URL Example:
https://api.climateengine.org/raster/export/forecasts/anomalies?dataset=CFS_GRIDMET&variable=tmmx&temporal_statistic=mean&model=ens_mean&calculation=anom&start_day=day01&end_day=day07&start_year=2016&end_year=2018&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | CFS_GRIDMET | CFS_GRIDMET | |
| variable | yes | pet, pr, tmmx, tmmn | tmmx | tmmx |
| model | yes | ens01 to en | ens_mean | ens_max, ens_min, ... |
| temporal_statistic | yes | mean | mean, median, max, min, total | |
| calculation | yes | Anomaly calculation | anom | anom, anompercentof, anompercentchange |
| start_day | yes | day01 to day28, start_day <= end_day | day01 | day02 |
| end_day | yes | day01 to day28, end_day >= start_day | day07 | day15 |
| start_year | yes | Start year for the climatology | 2016 | 1981 |
| end_year | yes | End year for the climatology | 2018 | 2010 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] |
/raster/export/percentiles¶
- Generates a map of percentiles or rank of the dataset variable over the time period.
- percentile: Return a number between (percentile_step to 100) showing where the target period is
- rank: Return an integer between (0 to number of years in climatology). A value of 0 is below the lowest value in climatology. 1 is the lowest value in climatology.
- Returns: json, Earth Engine task ID
URL Example:
https://api.climateengine.org/raster/export/percentiles?dataset=GRIDMET&variable=tmmx&temporal_statistic=mean&start_date=2010-06-01&end_date=2010-06-30&start_year=2016&end_year=2018&export_path=ncei-nidis%2Fdemo_image&calculation=percentile&percentile_step=1&precision=1e-7
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| calculation | yes | percentile | percentile, rank | |
| temporal_statistic | yes | mean | mean, median, max, min, total | |
| percentile_step | yes | difference between percentiles computed | 1 | 0.5, 1 or 5 |
| start_date | yes | 2010-06-01 | 2019-01-01 | |
| end_date | yes | 2010-06-30 | 2019-12-31 | |
| start_year | yes | Start year for the climatology | 2016 | 1981 |
| end_year | yes | End year for the climatology | 2018 | 2010 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] | |
| precision | yes | 1e-7 | 1e-7 |
/raster/export/forecasts/percentiles¶
- Generates a map of forecasts percentiles or rank of the dataset variable over the time period.
- percentile: Return a number between (percentile_step to 100) showing where the target period is
- rank: Return an integer between (0 to number of years in climatology). A value of 0 is below the lowest value in climatology. 1 is the lowest value in climatology.
- Returns: json, Earth Engine task ID
NOTE: CFS_GRIDMET is the only valid dataset for this endpoint because we have the GRIDMET base climatology dataset needed for the precentile computation.
URL Example:
https://api.climateengine.org/raster/export/forecasts/percentiles?dataset=CFS_GRIDMET&variable=tmmx&temporal_statistic=mean&model=ens_mean&calculation=percentile&percentile_step=1&precision=1e-7&start_day=day01&end_day=day07&start_year=2016&end_year=2018&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| calculation | yes | percentile | percentile, rank | |
| model | yes | ens01 to en | ens_mean | ens_max, ens_min, ... |
| temporal_statistic | yes | mean | mean, median, max, min, total | |
| percentile_step | yes | difference between percentiles computed | 1 | 0.5, 1 or 5 |
| start_day | yes | day01 to day28, start_day <= end_day | day01 | day02 |
| end_day | yes | day01 to day28, end_day >= start_day | day07 | day15 |
| start_year | yes | Start year for the climatology | 2016 | 1981 |
| end_year | yes | End year for the climatology | 2018 | 2010 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] | |
| precision | yes | 1e-7 | 1e-7 |
/raster/export/standard_index¶
- Exports a map of drought indices to a Google Cloud Storage bucket.
- Available variables: spi, spei, eddi, speih, edddih
- Returns: json, Earth Engine task ID
URL Example:
https://api.climateengine.org/raster/export/standard_index?dataset=GRIDMET&distribution=nonparametric&variable=eddi&start_date=2010-06-01&end_date=2010-06-30&start_year=2016&end_year=2018&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| distribution | yes | nonparametric | loglogistic, gamma, nonparametric | |
| start_date | yes | 2010-06-01 | 2019-01-01 | |
| end_date | yes | 2010-06-30 | 2019-12-31 | |
| start_year | yes | Start year for the climatology | 2016 | 1981 |
| end_year | yes | End year for the climatology | 2018 | 2010 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] |
/raster/export/forecasts/standard_index¶
- Exports a map of drought indices forecasts to a Google Cloud Storage bucket.
- Available variables: spi, spei, eddi, speih, edddih
- Returns: json, Earth Engine task ID
URL Example:
https://api.climateengine.org/raster/export/forecasts/standard_index?dataset=CFS_GRIDMET&distribution=nonparametric&variable=eddi&model=ens_mean&time_step=wk1&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | CFS_GRIDMET | CFS_GRIDMET | |
| variable | yes | eddi | eddi | |
| model | yes | ens01 to en | ens_mean | ens_max, ens_min, ... |
| distribution | yes | nonparametric | loglogistic, gamma, nonparametric | |
| time_step | yes | individual forecasts wk1, wk2, wk3, wk4 and means wk12, wk123, wk1234 | wk1 | wk123 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] |
/raster/export/mann_kendall¶
- Exports a map of Mann Kendall trends to a Google Cloud Storage bucket.
- mk_sen: Slope of trend (Sen’s slope)
- mk_tau: Correlation of trend (Kendall Tau-b)
- Returns: json
URL Example:
https://api.climateengine.org/raster/export/mann_kendall?dataset=GRIDMET&variable=tmmx&temporal_statistic=mean&calculation=mk_tau&p_value=0.5&start_season=08-01&end_season=10-31&start_year=2016&end_year=2018&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| temporal_statistic | yes | mean | mean, median, max, min, total | |
| calculation | yes | Sen’s Slope or Kendall Tau-b | mk_tau | mk_sen, mk_tau |
| p_value | no | Mann Kendall p-value mask | 0.5 | 1.0 (all trends), 0.2 (80% confidence), 0.1, 0.05, 0.01 |
| start_season | yes | 08-01 | 05-10 | |
| end_season | yes | 10-31 | 10-16 | |
| start_year | yes | Start year for the climatology | 2016 | 1981 |
| end_year | yes | End year for the climatology | 2018 | 2010 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] |
/raster/export/counts¶
- Exports a map of counts/probabilities to a Google Cloud Storage bucket.
- counts: Number of times between start date and end date that a pixel met the the selected operator’s criteria
- probability: The count divided by the total number of data points considered.
- Returns: json, Earth Engine task ID
Note: Will work for wrapping around years (e.g. water year)
URL Example:
https://api.climateengine.org/raster/export/counts?dataset=GRIDMET&variable=tmmx&operator=threshold_gte&output=counts&value_1=25&start_date=2010-01-01&end_date=2010-12-31&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| operator | yes | Type of operator - options include threshold, interior, exterior | threshold_gte | theshold_gt, threshold_gte, threshold_lt, threshold_lte, interior_eq, interior_neq, exterior_eq, exterior_neq |
| output | yes | Type of output | counts | counts, probability |
| value_1 | yes | Value to apply operator to | 25 | 25 |
| value_2 | no | Second value for interior/exterior operators | ||
| start_date | yes | 2010-01-01 | 2023-01-01 | |
| end_date | yes | 2010-12-31 | 2023-12-31 | |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] |
/raster/export/count_climatologies¶
- Exports a map of counts/probabilities climatologies to a Google Cloud Storage bucket.
- counts: Number of times between start date and end date that a pixel met the the selected operator’s criteria
- probability: The count divided by the total number of data points considered.
- Returns: json, Earth Engine task ID
Note: Will work for wrapping around years (e.g. water year)
URL Example:
https://api.climateengine.org/raster/export/count_climatologies?dataset=GRIDMET&variable=tmmx&operator=threshold_gte&output=counts&value_1=25&start_season=01-01&end_season=12-31&start_year=2001&end_year=2020&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| operator | yes | Type of operator - options include threshold, interior, exterior | threshold_gte | theshold_gt, threshold_gte, threshold_lt, threshold_lte, interior_eq, interior_neq, exterior_eq, exterior_neq |
| output | yes | Type of output | counts | counts, probability |
| value_1 | yes | Value to apply operator to | 25 | 25 |
| value_2 | no | Second value for interior/exterior operators | ||
| start_season | yes | 01-01 | 01-01 | |
| end_season | yes | 12-31 | 12-31 | |
| start_year | yes | Start year for the climatology | 2016 | 1981 |
| end_year | yes | End year for the climatology | 2018 | 2010 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] |
/raster/export/count_anomalies¶
- Exports a map of counts/probabilities anomalies to a Google Cloud Storage bucket.
- counts: Number of times between start date and end date that a pixel met the the selected operator’s criteria
- probability: The count divided by the total number of data points considered.
- Returns: json, Earth Engine task ID
Note: Will work for wrapping around years (e.g. water year)
URL Example:
https://api.climateengine.org/raster/export/count_anomalies?dataset=GRIDMET&variable=tmmx&operator=threshold_gte&output=counts&value_1=25&calculation=anom&start_date=2010-01-01&end_date=2010-12-31&start_year=2001&end_year=2020&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| operator | yes | Type of operator - options include threshold, interior, exterior | threshold_gte | theshold_gt, threshold_gte, threshold_lt, threshold_lte, interior_eq, interior_neq, exterior_eq, exterior_neq |
| output | yes | Type of output | counts | counts, probability |
| value_1 | yes | Value to apply operator to | 25 | 25 |
| value_2 | no | Second value for interior/exterior operators | ||
| calculation | yes | Anomaly calculation | anom | anom, anompercentof, anompercentchange |
| start_date | yes | 2010-01-01 | 2023-01-01 | |
| end_date | yes | 2010-12-31 | 2023-12-31 | |
| start_year | yes | Start year for the climatology | 2001 | 2000 |
| end_year | yes | End year for the climatology | 2020 | 2023 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] |
/raster/export/count_mann_kendall¶
- Exports a map of counts/probabilities trends to a Google Cloud Storage bucket.
- counts: Number of times between start date and end date that a pixel met the the selected operator’s criteria
- probability: The count divided by the total number of data points considered.
- mk_sen: Slope of trend (Sen’s slope)
- mk_tau: Correlation of trend (Kendall Tau-b)
- Returns: json, Earth Engine task ID
Note: Will work for wrapping around years (e.g. water year)
URL Example:
https://api.climateengine.org/raster/export/count_mann_kendall?dataset=GRIDMET&variable=tmmx&operator=threshold_gte&output=counts&value_1=25&calculation=mk_tau&p_value=0.5&start_season=01-01&end_season=12-31&start_year=2001&end_year=2020&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| operator | yes | Type of operator - options include threshold, interior, exterior | threshold_gte | theshold_gt, threshold_gte, threshold_lt, threshold_lte, interior_eq, interior_neq, exterior_eq, exterior_neq |
| output | yes | Type of output | counts | counts, probability |
| value_1 | yes | Value to apply operator to | 25 | 25 |
| value_2 | no | Second value for interior/exterior operators | ||
| calculation | yes | Sen’s Slope or Kendall Tau-b | mk_tau | mk_sen, mk_tau |
| p_value | no | Mann Kendall p-value mask | 0.5 | 1.0 (all trends), 0.2 (80% confidence), 0.1, 0.05, 0.01 |
| start_season | yes | 01-01 | 01-01 | |
| end_season | yes | 12-31 | 12-31 | |
| start_year | yes | Start year for the climatology | 2001 | 2000 |
| end_year | yes | End year for the climatology | 2020 | 2023 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] |
/raster/export/date_threshold¶
- Exports a map of dates that the given threshold value was met during a time period (defined by start_date and end_date) to a Google Cloud Storage bucket.
- Selecting threshold_max and threshold_min return date when max/min values were met during the time period.
- Occurrence allows you to select first or last time a threshold is met during the time period. For Min/Max thresholds, occurrence values will be the same.
- Will work for wrapping around years and for both climate and remote sensing assets.
- The units returned is in milliseconds since 1970-01-01.
- A masked value indicates threshold value was not passed.
- Returns: json, Earth Engine task ID
URL Example:
https://api.climateengine.org/raster/export/date_threshold?dataset=GRIDMET&variable=tmmx&operator=threshold_max&occurrence=first&start_date=2010-01-01&end_date=2010-12-31&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| operator | yes | Type of operator - options include threshold, interior, exterior | threshold_max | threshold_max, threshold_min, threshold_gt, threshold_gte, threshold_lte, threshold_lt |
| occurance | yes | Timing of when threshold was met | first | first, last |
| value | no | value for thresholding, only applies to threshold_gt, threshold_gte, threshold_lte, threshold_lt | 32 | |
| start_date | yes | 2010-01-01 | 2023-01-01 | |
| end_date | yes | 2010-12-31 | 2023-12-31 | |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] |
/raster/export/date_threshold_climatologies¶
- Exports a map of average time since the provided start_season (in milliseconds) that the given threshold value was met during a time period (defined by start_season and end_season) over a set of years to a Google Cloud Storage bucket.
- Selecting threshold_max and threshold_min return date when max/min values were met during the time period.
- Occurrence allows you to select first or last time a threshold is met during the time period. For Min/Max thresholds, occurrence values will be the same.
- Will work for wrapping around years and for both climate and remote sensing assets.
- The units returned are in milliseconds since the start day-month of climatology season.
- Returns: json, Earth Engine task ID
URL Example:
https://api.climateengine.org/raster/export/date_threshold_climatologies?dataset=GRIDMET&variable=tmmx&operator=threshold_max&occurrence=first&start_season=01-01&end_season=12-31&start_year=2001&end_year=2020&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| operator | yes | Type of operator - options include threshold, interior, exterior | threshold_max | threshold_max, threshold_min, threshold_gt, threshold_gte, threshold_lte, threshold_lt |
| occurance | yes | Timing of when threshold was met | first | first, last |
| value | no | value for thresholding, only applies to threshold_gt, threshold_gte, threshold_lte, threshold_lt | 32 | |
| start_season | yes | 01-01 | 01-01 | |
| end_season | yes | 12-31 | 12-31 | |
| start_year | yes | Start year for the climatology | 2001 | 2001 |
| end_year | yes | End year for the climatology | 2020 | 2020 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] |
/raster/export/date_threshold_anomalies¶
- Exports a map of the difference in time (milliseconds, or percent) between the time when the target period threshold is met and the average time when the threshold is met over the climatology time period to a Google Cloud Storage bucket.
- Selecting threshold_max and threshold_min return date when max/min values were met during the time period.
- Occurrence allows you to select first or last time a threshold is met during the time period. For Min/Max thresholds, occurrence values will be the same.
- Will work for wrapping around years and for both climate and remote sensing assets.
- The units returned are in milliseconds difference if anom is chosen. Otherwise it is a percentage.
- Returns: json, Earth Engine task ID
URL Example:
https://api.climateengine.org/raster/export/date_threshold_anomalies?dataset=GRIDMET&variable=tmmx&operator=threshold_max&occurrence=first&calculation=anom&start_date=2010-01-01&end_date=2010-12-31&start_year=2001&end_year=2020&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| operator | yes | Type of operator - options include threshold, interior, exterior | threshold_max | threshold_max, threshold_min, threshold_gt, threshold_gte, threshold_lte, threshold_lt |
| occurance | yes | Timing of when threshold was met | first | first, last |
| value | no | value for thresholding, only applies to threshold_gt, threshold_gte, threshold_lte, threshold_lt | 32 | |
| calculation | yes | Anomaly calculation | anom | anom, anompercentof, anompercentchange |
| start_date | yes | 2010-01-01 | 2010-01-01 | |
| end_date | yes | 2010-12-31 | 2010-12-31 | |
| start_year | yes | Start year for the climatology | 2001 | 2001 |
| end_year | yes | End year for the climatology | 2020 | 2020 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] |
/raster/export/date_threshold_mann_kendall¶
- Exports a map of the trend of time (milliseconds per year) since the start month-month over a set of years to a Google Cloud Storage bucket.
- Selecting threshold_max and threshold_min return date when max/min values were met during the time period.
- Occurrence allows you to select first or last time a threshold is met during the time period. For Min/Max thresholds, occurrence values will be the same.
- Will work for wrapping around years and for both climate and remote sensing assets.
- The units for the slope are in milliseconds per year.
- Returns: json, Earth Engine task ID
URL Example:
https://api.climateengine.org/raster/export/date_threshold_mann_kendall?dataset=GRIDMET&variable=tmmx&operator=threshold_max&occurrence=first&calculation=mk_tau&p_value=0.5&start_season=01-01&end_season=12-31&start_year=2001&end_year=2020&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmmx | tmmx | |
| operator | yes | Type of operator - options include threshold, interior, exterior | threshold_max | threshold_max, threshold_min, threshold_gt, threshold_gte, threshold_lte, threshold_lt |
| occurance | yes | Timing of when threshold was met | first | first, last |
| value | no | value for thresholding, only applies to threshold_gt, threshold_gte, threshold_lte, threshold_lt | 32 | |
| calculation | yes | Sen’s Slope or Kendall Tau-b | mk_tau | mk_sen, mk_tau |
| p_value | no | Mann Kendall p-value mask | 0.5 | 1.0 (all trends), 0.2 (80% confidence), 0.1, 0.05, 0.01 |
| start_season | yes | 01-01 | 01-01 | |
| end_season | yes | 12-31 | 12-31 | |
| start_year | yes | Start year for the climatology | 2001 | 2001 |
| end_year | yes | End year for the climatology | 2020 | 2020 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] |
/raster/export/degree_days¶
- Exports a map of heating degree or cooling degree days to a Google Cloud Storage bucket.
- Heating degree days count how many degree days are below the base temperature (how much heating is required).
- Cooling degree days count how many degree days are above the base temperature (how much cooling is required).
- Returns: json, Earth Engine task ID
URL Example:
https://api.climateengine.org/raster/export/degree_days?dataset=GRIDMET&variable=tmean&dd_type=hdd&value=18.3&start_date=2010-01-01&end_date=2010-12-31&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmean | tmean | |
| dd_type | yes | heating or cooling degree days | hdd | hdd, cdd |
| value | no | standard threshold | 18.3 | 18.3 |
| start_date | yes | 2010-01-01 | 2023-01-01 | |
| end_date | yes | 2010-12-31 | 2023-12-31 | |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] |
/raster/export/degree_days/climatologies¶
- Exports a map of average heating degree or cooling degree days to a Google Cloud Storage bucket.
- Heating degree days count how many degree days are below the base temperature (how much heating is required).
- Cooling degree days count how many degree days are above the base temperature (how much cooling is required).
- Returns: json, Earth Engine task ID
URL Example:
https://api.climateengine.org/raster/export/degree_days/climatologies?dataset=GRIDMET&variable=tmean&dd_type=hdd&value=18.3&start_season=01-01&end_season=12-31&start_year=2001&end_year=2020&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmean | tmean | |
| dd_type | yes | heating or cooling degree days | hdd | hdd, cdd |
| value | no | standard threshold | 18.3 | 18.3 |
| start_season | yes | 01-01 | 01-01 | |
| end_season | yes | 12-31 | 12-31 | |
| start_year | yes | Start year for the climatology | 2001 | 2001 |
| end_year | yes | End year for the climatology | 2020 | 2020 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] |
/raster/export/degree_days/anomalies¶
- Exports a map of difference in heating degree or cooling degree days for time period of interest relative to a climatology to a Google Cloud Storage bucket.
- Heating degree days count how many degree days are below the base temperature (how much heating is required).
- Cooling degree days count how many degree days are above the base temperature (how much cooling is required).
- Returns: json, Earth Engine task ID
URL Example:
https://api.climateengine.org/raster/export/degree_days/anomalies?dataset=GRIDMET&variable=tmean&dd_type=hdd&value=18.3&calculation=anom&start_date=2010-01-01&end_date=2010-12-31&start_year=2001&end_year=2020&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmean | tmean | |
| dd_type | yes | heating or cooling degree days | hdd | hdd, cdd |
| value | no | standard threshold | 18.3 | 18.3 |
| calculation | yes | Anomaly calculation | anom | anom, anompercentof, anompercentchange |
| start_date | yes | 2010-01-01 | 2010-01-01 | |
| end_date | yes | 2010-12-31 | 2010-12-31 | |
| start_year | yes | Start year for the climatology | 2001 | 2001 |
| end_year | yes | End year for the climatology | 2020 | 2020 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] |
/raster/export/degree_days/mann_kendall¶
- Exports a map of trend in heating degree or cooling degree days for time period over a set of years to a Google Cloud Storage bucket.
- Heating degree days count how many degree days are below the base temperature (how much heating is required).
- Cooling degree days count how many degree days are above the base temperature (how much cooling is required).
- Returns: json, Earth Engine task ID
URL Example:
https://api.climateengine.org/raster/export/degree_days/mann_kendall?dataset=GRIDMET&variable=tmean&dd_type=hdd&value=18.3&calculation=mk_tau&p_value=0.5&start_season=01-01&end_season=12-31&start_year=2001&end_year=2020&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable | yes | tmean | tmean | |
| dd_type | yes | heating or cooling degree days | hdd | hdd, cdd |
| value | no | standard threshold | 18.3 | 18.3 |
| calculation | yes | Sen’s Slope or Kendall Tau-b | mk_tau | mk_sen, mk_tau |
| p_value | no | Mann Kendall p-value mask | 0.5 | 1.0 (all trends), 0.2 (80% confidence), 0.1, 0.05, 0.01 |
| start_season | yes | 01-01 | 01-01 | |
| end_season | yes | 12-31 | 12-31 | |
| start_year | yes | Start year for the climatology | 2001 | 2001 |
| end_year | yes | End year for the climatology | 2020 | 2020 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] |
/raster/export/growing_degree_days¶
- Exports a map of growing degree days to a Google Cloud Storage bucket.
- Growing Degree Days (GDD) are a measure of heat accumulation used to predict plant and insect development based on temperature.
- GDD is calculated using a base temperature below which growth does not occur, and an upper cutoff temperature above which growth is limited.
- The default values used here are for corn.
- Returns: json, Earth Engine task ID
URL Example:
https://api.climateengine.org/raster/export/growing_degree_days?dataset=GRIDMET&variable_tmax=tmmx&variable_tmin=tmmn&base_threshold=10&cutoff_threshold=30&start_date=2010-01-01&end_date=2010-12-31&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable_tmax | yes | tmmx | tmmx | |
| variable_tmin | yes | tmin | tmin | |
| base_threshold | yes | base threshold temperature | 10 | 10 |
| cutoff_threshold | no | cutoff threshold temperature | 30 | 30 |
| start_date | yes | 2010-01-01 | 2023-01-01 | |
| end_date | yes | 2010-12-31 | 2023-12-31 | |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] |
/raster/export/growing_degree_days/climatologies¶
- Exports a map of average growing degree days to a Google Cloud Storage bucket.
- Growing Degree Days (GDD) are a measure of heat accumulation used to predict plant and insect development based on temperature.
- GDD is calculated using a base temperature below which growth does not occur, and an upper cutoff temperature above which growth is limited.
- The default values used here are for corn.
- Returns: json, Earth Engine task ID
URL Example:
https://api.climateengine.org/raster/export/growing_degree_days/climatologies?dataset=GRIDMET&variable_tmax=tmmx&variable_tmin=tmmn&base_threshold=10&cutoff_threshold=30&start_season=01-01&end_season=12-31&start_year=2001&end_year=2020&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable_tmax | yes | tmmx | tmmx | |
| variable_tmin | yes | tmin | tmin | |
| start_season | yes | 01-01 | 01-01 | |
| end_season | yes | 12-31 | 12-31 | |
| start_year | yes | Start year for the climatology | 2001 | 2001 |
| end_year | yes | End year for the climatology | 2020 | 2020 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] |
/raster/export/growing_degree_days/anomalies¶
- Exports a map of difference in growing degree days for time period of interest relative to a climatology to a Google Cloud Storage bucket.
- Growing Degree Days (GDD) are a measure of heat accumulation used to predict plant and insect development based on temperature.
- GDD is calculated using a base temperature below which growth does not occur, and an upper cutoff temperature above which growth is limited.
- The default values used here are for corn.
- Returns: json, Earth Engine task ID
URL Example:
https://api.climateengine.org/raster/export/growing_degree_days/anomalies?dataset=GRIDMET&variable_tmax=tmmx&variable_tmin=tmmn&base_threshold=10&cutoff_threshold=30&calculation=anom&start_date=2010-01-01&end_date=2010-12-31&start_year=2001&end_year=2020&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable_tmax | yes | tmmx | tmmx | |
| variable_tmin | yes | tmin | tmin | |
| calculation | yes | Anomaly calculation | anom | anom, anompercentof, anompercentchange |
| start_date | yes | 2010-01-01 | 2010-01-01 | |
| end_date | yes | 2010-12-31 | 2010-12-31 | |
| start_year | yes | Start year for the climatology | 2001 | 2001 |
| end_year | yes | End year for the climatology | 2020 | 2020 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] |
/raster/export/growing_degree_days/mann_kendall¶
- Exports a map of average growing degree days to a Google Cloud Storage bucket.
- Growing Degree Days (GDD) are a measure of heat accumulation used to predict plant and insect development based on temperature.
- GDD is calculated using a base temperature below which growth does not occur, and an upper cutoff temperature above which growth is limited.
- The default values used here are for corn.
- Returns: json, Earth Engine task ID
URL Example:
https://api.climateengine.org/raster/export/growing_degree_days/mann_kendall?dataset=GRIDMET&variable_tmax=tmmx&variable_tmin=tmmn&base_threshold=10&cutoff_threshold=30&calculation=mk_tau&p_value=0.5&start_season=01-01&end_season=12-31&start_year=2001&end_year=2020&export_path=ncei-nidis%2Fdemo_image
| Name | Required | Description | Default | Example |
|---|---|---|---|---|
| dataset | yes | GRIDMET | GRIDMET | |
| variable_tmax | yes | tmmx | tmmx | |
| variable_tmin | yes | tmin | tmin | |
| calculation | yes | Sen’s Slope or Kendall Tau-b | mk_tau | mk_sen, mk_tau |
| p_value | no | Mann Kendall p-value mask | 0.5 | 1.0 (all trends), 0.2 (80% confidence), 0.1, 0.05, 0.01 |
| start_season | yes | 01-01 | 01-01 | |
| end_season | yes | 12-31 | 12-31 | |
| start_year | yes | Start year for the climatology | 2001 | 2000 |
| end_year | yes | End year for the climatology | 2020 | 2023 |
| bounding_box | yes | The bounding box [SWLong, SWLat, NELong, NELat] | [-139, 49, -138, 50] | |
| export_projection | no | EPSG:4326 | ||
| export_resolution | no | Resolution of exported image (in meters) | Native resolution of dataset | 4000 |
| export_path | yes | path to bucket | Includes bucket/ | ncei-nidis/test/test_values |
| map_mask | no | Show ranges of data on the map | [0, 200] or [0, 200, 300, 400] |