Maps¶
/raster/mapid/values¶
Resource url example:
/raster/mapid/values?dataset=GRIDMET&variable=tmmx&temporal_statistic=Mean&start_date=2016-01-01&end_date=2016-12-30&colormap_opacity=0.7&colormap_type=continuous
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 |
||
colormap_min_max |
no |
Two data values corresponding to palette color bands |
Depends on parameter combination |
[290.0,314.0] |
colormap_opacity |
no |
Values between 0 (transparent) and 1 |
0.7 |
0.4 |
colormap_palette |
no |
List of colors in hex |
Depends on dataset and variable |
[d8d8d8, 34addff, 35affa3, f2ff89, ff725c] |
colormap_type |
no |
continuous |
continuous, discrete |
|
colormap_mask |
no |
Show ranges of data on the map |
[0,200] or [0,200,300,400] |
/raster/mapid/forecasts/values¶
Resource url example:
/raster/mapid/forecasts/values?dataset=CFS_GRIDMET&variable=tmmx&model=ens15&temporal_statistic=Mean&start_day=day02&end_day=day21&colormap_opacity=0.7&colormap_type=continuous
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
CFS_GRIDMET |
CFS_GRIDMET |
|
variable |
yes |
pet, pr, tmmx, tmmn |
tmmx |
|
model |
yes |
ens01 to en<xx> for individual models (see documentation), ens_min, ens_max, ens_mean, ens_median |
ens_mean |
ens_max |
temporal_statistic |
yes |
mean, median, max, min, total |
||
start_day |
yes |
day01 to day 28, start_day <= end_day |
day01 |
day02 |
end_day |
yes |
day01 to day28, end_day >= start_day |
day28 |
day15 |
colormap_min_max |
no |
Two data values corresponding to palette color bands |
Depends on parameter combination |
[290.0,314.0] |
colormap_opacity |
no |
Values between 0 (transparent) and 1 |
0.7 |
0.4 |
colormap_palette |
no |
List of colors in hex |
Depends on dataset and variable |
[d8d8d8, 34addff, 35affa3, f2ff89, ff725c] |
colormap_type |
no |
continuous |
continuous, discrete |
|
colormap_mask |
no |
Show ranges of data on the map |
[0,200] or [0,200,300,400] |
/raster/mapid/climatologies¶
Resource url example:
/raster/mapid/climatologies?dataset=GRIDMET&variable=tmmx&temporal_statistic=Mean&start_season=08-01&end_season=10-30&start_year=2014&end_year=2018&colormap_opacity=0.7&colormap_type=continuous
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
tmmx |
||
temporal_statistic |
yes |
mean, median, max, min, total |
||
start_season |
yes |
05-10 |
||
end_season |
yes |
10-16 |
||
start_year |
yes |
Start year for the climatology |
1981 |
|
end_year |
yes |
End year for the climatology |
2010 |
|
colormap_min_max |
no |
Two data values corresponding to palette color bands |
Depends on parameter combination |
[290.0,314.0] |
colormap_opacity |
no |
Values between 0 (transparent) and 1 |
0.7 |
0.4 |
colormap_palette |
no |
List of colors in hex |
Depends on dataset and variable |
[d8d8d8, 34addff, 35affa3, f2ff89, ff725c] |
colormap_type |
no |
continuous |
continuous, discrete |
|
colormap_mask |
no |
Show ranges of data on the map |
[0,200] or [0,200,300,400] |
/raster/mapid/anomalies¶
Resource url example:
/raster/mapid/anomalies?dataset=GRIDMET&variable=pr&temporal_statistic=Total&calculation=anom&start_date=2016-08-01&end_date=2016-10-30&start_year=2014&end_year=2018&colormap_opacity=0.7&colormap_type=continuous
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
tmmx |
||
temporal_statistic |
yes |
mean, median, max, min, total |
||
calculation |
yes |
Anomaly calculation |
anom, anompercentof, anompercentchange |
|
start_date |
yes |
2019-01-01 |
||
end_date |
yes |
2019-10-16 |
||
start_year |
yes |
Start year for the climatology |
1981 |
|
end_year |
yes |
End year for the climatology |
2010 |
|
colormap_min_max |
no |
Two data values corresponding to palette color bands |
Depends on parameter combination |
[290.0,314.0] |
colormap_opacity |
no |
Values between 0 (transparent) and 1 |
0.7 |
0.4 |
colormap_palette |
no |
List of colors in hex |
Depends on dataset and variable |
[d8d8d8, 34addff, 35affa3, f2ff89, ff725c] |
colormap_type |
no |
continuous |
continuous, discrete |
|
colormap_mask |
no |
Show ranges of data on the map |
[0,200] or [0,200,300,400] |
/raster/mapid/forecasts/anomalies¶
Resource url example:
/raster/mapid/forecasts/anomalies?dataset=CFS_GRIDMET&variable=pr&model=ens_max*temporal_statistic=Total&calculation=anom&start_day=day01&end_day=day28&start_year=1981&end_year=2010&colormap_opacity=0.7&colormap_type=continuous
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
CFS_GRIDMET |
CFS_GRIDMET |
|
variable |
yes |
pet, pr, tmmx, tmmn |
tmmx |
|
model |
yes |
ens01 to en<xx> for individual models (see documentation), ens_min, ens_max, ens_mean, ens_median |
ens_mean |
ens_max |
temporal_statistic |
yes |
mean, median, max, min, total |
||
calculation |
yes |
Anomaly calculation |
anom, anompercentof, anompercentchange |
|
start_day |
yes |
day01 to day 28, start_day <= end_day |
day01 |
day02 |
end_day |
yes |
day01 to day28, end_day >= start_day |
day28 |
day15 |
start_year |
yes |
Start year for the climatology |
1981 |
|
end_year |
yes |
End year for the climatology |
2010 |
|
colormap_min_max |
no |
Two data values corresponding to palette color bands |
Depends on parameter combination |
[290.0,314.0] |
colormap_opacity |
no |
Values between 0 (transparent) and 1 |
0.7 |
0.4 |
colormap_palette |
no |
List of colors in hex |
Depends on dataset and variable |
[d8d8d8, 34addff, 35affa3, f2ff89, ff725c] |
colormap_type |
no |
continuous |
continuous, discrete |
|
colormap_mask |
no |
Show ranges of data on the map |
[0,200] or [0,200,300,400] |
/raster/mapid/percentiles¶
Resource url example:
/raster/mapid/percentiles?dataset=GRIDMET&variable=pr&temporal_statistic=Total&percentile_step=1&start_date=2016-08-01&end_date=2016-10-30&start_year=2014&end_year=2018&colormap_opacity=0.7&colormap_type=continuous
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
tmmx |
||
temporal_statistic |
yes |
mean, median, max, min, total |
||
percentile_step |
yes |
difference between percentiles computed |
1 |
0.5, 1 or 5 |
start_date |
yes |
2019-01-01 |
||
end_date |
yes |
2019-10-16 |
||
start_year |
yes |
Start year for the climatology |
1981 |
|
end_year |
yes |
End year for the climatology |
2010 |
|
colormap_min_max |
no |
Two data values corresponding to palette color bands |
[0, 100] |
[10,80] |
colormap_opacity |
no |
Values between 0 (transparent) and 1 |
0.7 |
0.4 |
colormap_palette |
no |
List of colors in hex |
Depends on dataset and variable |
[d8d8d8, 34addff, 35affa3, f2ff89, ff725c] |
colormap_type |
no |
continuous |
continuous, discrete |
|
colormap_mask |
no |
Show ranges of data on the map |
[0,200] or [0,200,300,400] |
/raster/mapid/forecasts/percentiles¶
Resource url example:
/raster/mapid/forecasts/percentiles?dataset=CFS_GRIDMET&variable=pr&model=ens_mean&temporal_statistic=Total&percentile_step=1&start_day=day01&end_day=day14&start_year=2014&end_year=2018&colormap_opacity=0.7&colormap_type=continuous
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
CFS_GRIDMET |
CFS_GRIDMET |
|
variable |
yes |
tmmx |
||
model |
yes |
ens01 to en<xx> for individual models (see documentation), ens_min, ens_max, ens_mean, ens_median |
ens_mean |
ens_max |
temporal_statistic |
yes |
mean, median, max, min, total |
||
percentile_step |
yes |
difference between percentiles computed |
1 |
0.5, 1 or 5 |
start_day |
yes |
day01 to day 28, 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 |
1981 |
|
end_year |
yes |
End year for the climatology |
2010 |
|
colormap_min_max |
no |
Two data values corresponding to palette color bands |
[0, 100] |
[10,80] |
colormap_opacity |
no |
Values between 0 (transparent) and 1 |
0.7 |
0.4 |
colormap_palette |
no |
List of colors in hex |
Depends on dataset and variable |
[d8d8d8, 34addff, 35affa3, f2ff89, ff725c] |
colormap_type |
no |
continuous |
continuous, discrete |
|
colormap_mask |
no |
Show ranges of data on the map |
[0,200] or [0,200,300,400] |
/raster/mapid/standard_index¶
Resource url example:
/raster/mapid/standard_index?dataset=GRIDMET&variable=eddi&start_date=2016-08-01&end_date=2016-10-30&start_year=2014&end_year=2018&colormap_opacity=0.7&colormap_type=continuous
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
spi |
||
distribution |
yes |
nonparametric, gamma or loglogistic |
nonparametric |
gamma |
start_date |
yes |
2019-01-01 |
||
end_date |
yes |
2019-10-16 |
||
start_year |
yes |
Start year for the climatology |
1981 |
|
end_year |
yes |
End year for the climatology |
2010 |
|
colormap_min_max |
no |
Two data values corresponding to palette color bands |
Depends on parameter combination |
[290.0,314.0] |
colormap_opacity |
no |
Values between 0 (transparent) and 1 |
0.7 |
0.4 |
colormap_palette |
no |
List of colors in hex |
Depends on dataset and variable |
[d8d8d8, 34addff, 35affa3, f2ff89, ff725c] |
colormap_type |
no |
continuous |
continuous, discrete |
|
colormap_mask |
no |
Show ranges of data on the map |
[0,50] or [0,50,70,80] |
/raster/mapid/forecasts/standard_index¶
Resource url example:
/raster/mapid/forecasts/standard_index?dataset=CFS_GRIDMET&variable=eddi&model=ens21&time_step=wk1&colormap_opacity=0.7&colormap_type=continuous
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
CFS_GRIDMET |
CFS_GRIDMET |
|
variable |
yes |
eddi |
eddi |
|
distribution |
yes |
nonparametric, gamma or loglogistic |
nonparametric |
gamma |
model |
yes |
ens01 to en<xx> for individual models (see documentation), ens_min, ens_max, ens_mean, ens_median |
ens |
ens_max |
time_step |
yes |
individual forecasts wk1, wk2, wk3, wk4 and means wk12, wk123, wk1234 |
wk1 |
wk123 |
colormap_min_max |
no |
Two data values corresponding to palette color bands |
Depends on parameter combination |
[290.0,314.0] |
colormap_opacity |
no |
Values between 0 (transparent) and 1 |
0.7 |
0.4 |
colormap_palette |
no |
List of colors in hex |
Depends on dataset and variable |
[d8d8d8, 34addff, 35affa3, f2ff89, ff725c] |
colormap_type |
no |
continuous |
continuous, discrete |
|
colormap_mask |
no |
Show ranges of data on the map |
[0,200] or [0,200,300,400] |
/raster/mapid/mann_kendall¶
Resource url example:
/raster/mapid/mann_kendall?dataset=LANDSAT7_TOA&variable=NDVI&temporal_statistic=Mean&calculation=mk_tau&p_value=0.5&start_season=05-01&end_season=07-30&start_year=2016&end_year=2018&colormap_opacity=0.7&colormap_type=continuous
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
tmmx |
||
temporal_statistic |
yes |
mean, median, max, min, total |
||
calculation |
yes |
Sen’s Slope or Kendall Tau-b |
mk_sen, mk_tau |
|
p_value |
no |
Mann Kendall p-value mask |
1.0 |
1.0 (all trends), 0.2 (80% confidence), 0.1, 0.05, 0.01 |
start_season |
yes |
01-01 |
||
end_season |
yes |
10-16 |
||
start_year |
yes |
Start year for the climatology |
1981 |
|
end_year |
yes |
End year for the climatology |
2010 |
|
colormap_min_max |
no |
Two data values corresponding to palette color bands |
Depends on parameter combination |
[290.0,314.0] |
colormap_opacity |
no |
Values between 0 (transparent) and 1 |
0.7 |
0.4 |
colormap_palette |
no |
List of colors in hex |
Depends on dataset and variable |
[d8d8d8, 34addff, 35affa3, f2ff89, ff725c] |
colormap_type |
no |
continuous |
continuous, discrete |
|
colormap_mask |
no |
Show ranges of data on the map |
[0,200] or [0,200,300,400] |
/raster/mapid/counts¶
Resource url example:
/raster/mapid/counts?dataset=GRIDMET&variable=tmmx&operator=threshold_gte&output=counts&value_1=25&colormap_opacity=0.7&colormap_type=continuous&start_date=2010-01-01&end_date=2010-12-31
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
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 |
|
colormap_min_max |
no |
Two data values corresponding to palette color bands |
Depends on parameter combination |
[0,365] |
colormap_opacity |
no |
Values between 0 (transparent) and 1 |
0.7 |
0.4 |
colormap_palette |
no |
List of colors in hex |
Depends on dataset and variable |
[d8d8d8, 34addff, 35affa3, f2ff89, ff725c] |
colormap_type |
no |
continuous |
continuous, discrete |
|
colormap_mask |
no |
Show ranges of data on the map |
[0,200] or [0,200,300,400] |
/raster/mapid/count_climatologies¶
Resource url example:
/raster/mapid/count_climatologies?dataset=GRIDMET&variable=tmmx&operator=threshold_gte&output=counts&value_1=25&colormap_opacity=0.7&colormap_type=continuous&start_season=01-01&end_season=12-31&start_year=2001&end_year=2020
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
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 |
2001 |
2000 |
|
end_season |
yes |
2020 |
2023 |
|
colormap_min_max |
no |
Two data values corresponding to palette color bands |
Depends on parameter combination |
[0,365] |
colormap_opacity |
no |
Values between 0 (transparent) and 1 |
0.7 |
0.4 |
colormap_palette |
no |
List of colors in hex |
Depends on dataset and variable |
[d8d8d8, 34addff, 35affa3, f2ff89, ff725c] |
colormap_type |
no |
continuous |
continuous, discrete |
|
colormap_mask |
no |
Show ranges of data on the map |
[0,200] or [0,200,300,400] |
/raster/mapid/count_anomalies¶
Resource url example:
/raster/mapid/count_anomalies?dataset=GRIDMET&variable=tmmx&operator=threshold_gte&output=counts&value_1=25&colormap_opacity=0.7&colormap_type=continuous&start_date=2010-01-01&end_date=2010-12-31&start_year=2001&end_year=2020&calculation=anom
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
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 |
anom |
anom |
|
start_date |
yes |
2010-01-01 |
2023-01-01 |
|
end_date |
yes |
2010-12-31 |
2023-12-31 |
|
start_year |
yes |
2001 |
2000 |
|
end_season |
yes |
2020 |
2023 |
|
colormap_min_max |
no |
Two data values corresponding to palette color bands |
Depends on parameter combination |
[0,365] |
colormap_opacity |
no |
Values between 0 (transparent) and 1 |
0.7 |
0.4 |
colormap_palette |
no |
List of colors in hex |
Depends on dataset and variable |
[d8d8d8, 34addff, 35affa3, f2ff89, ff725c] |
colormap_type |
no |
continuous |
continuous, discrete |
|
colormap_mask |
no |
Show ranges of data on the map |
[0,200] or [0,200,300,400] |
/raster/mapid/count_mann_kendall¶
Resource url example:
/raster/mapid/count_mann_kendall?dataset=GRIDMET&variable=tmmx&operator=threshold_gte&output=counts&value_1=25&colormap_opacity=0.7&colormap_type=continuous&start_season=01-01&end_season=12-31&start_year=2001&end_year=2020&calculation=mk_tau&p_value=1
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
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 |
mk_tau |
mk_sen, mk_tau |
|
p_value |
no |
Mann Kendall p-value mask |
1.0 |
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 |
2001 |
2000 |
|
end_season |
yes |
2020 |
2023 |
|
colormap_min_max |
no |
Two data values corresponding to palette color bands |
Depends on parameter combination |
[0,365] |
colormap_opacity |
no |
Values between 0 (transparent) and 1 |
0.7 |
0.4 |
colormap_palette |
no |
List of colors in hex |
Depends on dataset and variable |
[d8d8d8, 34addff, 35affa3, f2ff89, ff725c] |
colormap_type |
no |
continuous |
continuous, discrete |
|
colormap_mask |
no |
Show ranges of data on the map |
[0,200] or [0,200,300,400] |
/raster/export/task_update¶
Resource url example:
/raster/export/task_update?task_id=2BFYQPFADAYHRGTRME2OXFD7
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
task_id |
yes |
Earth Engine ID of the task (from output of export endpoint) |
2BFYQPFADAYHRGTRME2OXFD7 |
/raster/export/task_queue¶
Resource url example:
/raster/export/task_queue?task_states=RUNNING%2C%20FAILED
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
task_states |
list of task states |
READY, RUNNING, SUCCEEDED, FAILED |
RUNNING, FAILED |
/raster/export/values¶
Resource url example:
/raster/export/values?dataset=GRIDMET&variable=tmmx&temporal_statistic=Mean&start_date=2016-01-01&end_date=2016-12-30&bounding_box=[-121.7,38.3,-120.1,38.9]&export_path=ncei-nidis/test/test_values&export_projection=EPSG:4326&export_resolution=1000
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 |
||
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/<optional folder>/filename |
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¶
Resource url example:
/raster/export/forecasts/values?dataset=CFS_GRIDMET&variable=tmmx&model=ens&temporal_statistic=Mean&start_day=day01&end_day=day28&bounding_box=[-121.7,38.3,-120.1,38.9]&export_path=ncei-nidis/test/test_values&export_projection=EPSG:4326&export_resolution=1000
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET_CFS |
GRIDMET_CFS |
|
variable |
yes |
pet, pr, tmmx, tmmn |
tmmx |
|
model |
yes |
ens01 to en<xx> for individual models (see documentation), ens_min, ens_max, ens_mean, ens_median |
ens |
ens_max |
temporal_statistic |
yes |
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 |
day28 |
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/<optional folder>/filename |
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¶
Resource url example:
/raster/export/climatologies?dataset=GRIDMET&variable=tmmx&temporal_statistic=Mean&start_season=08-01&end_season=10-30&start_year=2014&end_year=2018&bounding_box=[23.8858,48.9802,-128.3203,-66.5332]&export_path=ncei-nidis/test/test_clim&export_projection=EPSG:4326&export_resolution=1000
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
tmmx |
||
temporal_statistic |
yes |
mean, median, max, min, total |
||
start_season |
yes |
05-10 |
||
end_season |
yes |
10-16 |
||
start_year |
yes |
Start year for the climatology |
1981 |
|
end_year |
yes |
End year for the climatology |
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/<optional folder>/filename |
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¶
Resource url example:
/raster/export/anomalies?dataset=GRIDMET&variable=tmmx&temporal_statistic=Mean&calculation=anom&start_date=2016-08-01&end_date=2016-10-30&start_year=2014&end_year=2018&bounding_box=[-121.7,38.3,-120.1,38.9]&export_path=ncei-nidis/test/test_anomalies&export_projection=EPSG:4326&export_resolution=1000
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
tmmx |
||
temporal_statistic |
yes |
mean, median, max, min, total |
||
calculation |
yes |
Anomaly calculation |
anom, anompercentof, anompercentchange |
|
start_date |
yes |
2019-01-01 |
||
end_date |
yes |
2019-10-16 |
||
start_year |
yes |
Start year for the climatology |
1981 |
|
end_year |
yes |
End year for the climatology |
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/<optional folder>/filename |
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¶
Resource url example:
/raster/export/forecasts/anomalies?dataset=CFS_GRIDMET&variable=tmmx&model=ens&temporal_statistic=Mean&calculation=anom&start_day=day01&end_day=day28&start_year=2014&end_year=2018&bounding_box=[-121.7,38.3,-120.1,38.9]&export_path=ncei-nidis/test/test_anomalies&export_projection=EPSG:4326&export_resolution=1000
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
CFS_GRIDMET |
CFS_GRIDMET |
|
variable |
yes |
pet, pr, tmmx, tmmn |
tmmx |
|
model |
yes |
ens01 to en<xx> for individual models (see documentation), ens_min, ens_max, ens_mean, ens_median |
ens |
ens_max |
temporal_statistic |
yes |
mean, median, max, min, total |
||
calculation |
yes |
Anomaly calculation |
anom, anompercentof, anompercentchange |
|
start_day |
yes |
day01 to day 28, start_day <= end_day |
day01 |
day02 |
end_day |
yes |
day01 to day28, end_day >= start_day |
day28 |
day15 |
start_year |
yes |
Start year for the climatology |
1981 |
|
end_year |
yes |
End year for the climatology |
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/<optional folder>/filename |
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¶
Resource url example:
/raster/export/percentiles?dataset=GRIDMET&variable=pr&temporal_statistic=Total&percentile_step=1&start_date=2016-08-01&end_date=2016-10-30&start_year=2014&end_year=2018&bounding_box=[-121.7,38.3,-120.1,38.9]&export_path=ncei-nidis/test/test_anomalies&export_projection=EPSG:4326&export_resolution=1000
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
tmmx |
||
temporal_statistic |
yes |
mean, median, max, min, total |
||
percentile_step |
yes |
difference between percentiles computed |
1 |
0.5, 1 or 5 |
start_date |
yes |
2019-01-01 |
||
end_date |
yes |
2019-10-16 |
||
start_year |
yes |
Start year for the climatology |
1981 |
|
end_year |
yes |
End year for the climatology |
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/<optional folder>/filename |
ncei-nidis/test/test_values |
map_mask |
no |
Show ranges of data on the map |
[0, 20] or [0, 30, 50, 80] |
/raster/export/forecasts/percentiles¶
Resource url example:
/raster/export/forecasts/percentiles?dataset=CFS_GRIDMET&variable=pr&model=ens_mean&temporal_statistic=Total&percentile_step=1&start_day=day01&end_day=day16&start_year=2014&end_year=2018&bounding_box=[-121.7,38.3,-120.1,38.9]&export_path=ncei-nidis/test/test_anomalies&export_projection=EPSG:4326&export_resolution=1000
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
CFS_GRIDMET |
CFS_GRIDMET |
|
variable |
yes |
tmmx |
||
model |
yes |
ens01 to en<xx> for individual models (see documentation), ens_min, ens_max, ens_mean, ens_median |
ens_mean |
ens_max |
temporal_statistic |
yes |
mean, median, max, min, total |
||
percentile_step |
yes |
difference between percentiles computed |
1 |
0.5, 1 or 5 |
start_day |
yes |
day01 to day 28, 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 |
1981 |
|
end_year |
yes |
End year for the climatology |
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/<optional folder>/filename |
ncei-nidis/test/test_values |
map_mask |
no |
Show ranges of data on the map |
[0, 20] or [0, 30, 50, 80] |
/raster/export/standard_index¶
Resource url example:
/raster/export/standard_index?dataset=GRIDMET&variable=eddi&start_date=2016-08-01&end_date=2016-10-30&start_year=2014&end_year=2018&bounding_box=[-121.7,38.3,-120.1,38.9]&export_path=ncei-nidis/test/test_norm&export_projection=EPSG:4326&export_resolution=1000
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
spi |
||
distribution |
yes |
nonparametric, gamma or loglogistic |
nonparametric |
gamma |
start_date |
yes |
2019-01-01 |
||
end_date |
yes |
2019-10-16 |
||
start_year |
yes |
Start year for the climatology |
1981 |
|
end_year |
yes |
End year for the climatology |
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/<optional folder>/filename |
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¶
Resource url example:
/raster/export/forecasts/standard_index?dataset=CFS_GRIDMET&variable=eddi&time_step=wk2&bounding_box=[-121.7,38.3,-120.1,38.9]&export_path=ncei-nidis/test/test_norm&export_projection=EPSG:4326&export_resolution=1000
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET_CFS |
||
variable |
yes |
eddi |
eddi |
|
distribution |
yes |
nonparametric, gamma or loglogistic |
nonparametric |
gamma |
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/<optional folder>/filename |
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¶
Resource url example:
/raster/export/mann_kendall?dataset=LANDSAT7_TOA&variable=NDVI&temporal_statistic=Mean&calculation=mk_tau&p_value=0.5&start_season=05-01&end_season=07-30&start_year=2016&end_year=2018&bounding_box=[-121.7,38.3,-120.1,38.9]&export_path=ncei-nidis/test/test_mk&export_projection=EPSG:4326&export_resolution=1000
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
tmmx |
||
temporal_statistic |
yes |
mean, median, max, min, total |
||
calculation |
yes |
Sen’s Slope or Kendall Tau-b |
mk_sen, mk_tau |
|
p_value |
no |
Mann Kendall p-value mask |
1.0 |
1.0 (all trends), 0.2 (80% confidence), 0.1, 0.05, 0.01 |
start_season |
yes |
01-01 |
||
end_season |
yes |
10-16 |
||
start_year |
yes |
Start year for the climatology |
1981 |
|
end_year |
yes |
End year for the climatology |
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/<optional folder>/filename |
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¶
Resource url example:
/raster/export/counts?dataset=GRIDMET&variable=tmmx&operator=threshold_gte&output=counts&value_1=25&export_path=ncei-nidis%2Fdemo_image&start_date=2010-01-31&end_date=2010-12-31
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
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-31 |
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/<optional folder>/filename |
ncei-nidis/demo_image |
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¶
Resource url example:
/raster/export/count_climatologies?dataset=GRIDMET&variable=tmmx&operator=threshold_gte&output=counts&value_1=25&export_path=ncei-nidis%2Fdemo_image&start_season=08-01&end_season=10-31&start_year=2016&end_year=2018
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
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-31 |
01-01 |
|
end_season |
yes |
10-31 |
12-31 |
|
start_year |
yes |
2016 |
2020 |
|
end_year |
yes |
2018 |
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/<optional folder>/filename |
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¶
Resource url example:
/raster/export/count_anomalies?dataset=GRIDMET&variable=tmmx&operator=threshold_gte&output=counts&value_1=25&export_path=ncei-nidis%2Fdemo_image&start_date=2010-01-01&end_date=2010-12-31&start_year=2001&end_year=2020&calculation=anom
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
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 |
anom |
anom |
|
start_date |
yes |
2010-01-01 |
2023-01-01 |
|
end_date |
yes |
2010-12-31 |
2023-12-31 |
|
start_year |
yes |
2001 |
2000 |
|
end_year |
yes |
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/<optional folder>/filename |
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¶
Resource url example:
/raster/export/count_mann_kendall?dataset=GRIDMET&variable=tmmx&operator=threshold_gte&output=counts&value_1=25&export_path=ncei-nidis%2Fdemo_image&start_season=01-01&end_season=12-31&start_year=2001&end_year=2020&calculation=mk_tau&p_value=1
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
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 |
mk_tau |
mk_tau |
|
p_value |
no |
Mann Kendall p-value mask |
1.0 |
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 |
2001 |
2000 |
|
end_year |
yes |
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/<optional folder>/filename |
ncei-nidis/test/test_values |
map_mask |
no |
Show ranges of data on the map |
[0, 200] or [0, 200, 300, 400] |
/raster/metadata/percentiles/values¶
Resource url example:
/raster/metadata/percentiles/values?dataset=GRIDMET&variable=tmmx&temporal_statistic=Mean&start_date=2016-01-01&end_date=2016-12-30&bounding_box=[-121.7,38.3,-120.1,38.9]&percentiles=[0,5,10,25,50,75,90,95,100]&scale=4000
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
tmmx |
||
temporal_statistic |
yes |
mean, median, max, min, total |
||
export_format |
no |
File format of export |
json |
csv, json |
start_date |
yes |
2019-01-01 |
||
end_date |
yes |
2019-12-31 |
||
scale |
no |
Dataset scale |
Depends dataset and bounding box |
4000 |
bounding_box |
yes |
The bounding box [SWLong, SWLat, NELong, NELat] |
[-121.7, 38.3, -120.1, 38.9] |
|
percentiles |
no |
The percentiles |
[0, 5, 10, 25, 50, 75, 90, 95, 100] |
/raster/metadata/percentiles/climatologies¶
Resource url example:
/raster/metadata/percentiles/climatologies?dataset=GRIDMET&variable=tmmx&temporal_statistic=Mean&start_season=08-01&end_season=10-30&start_year=2014&end_year=2018&bounding_box=[-121.7,38.3,-120.1,38.9]&percentiles=[0,5,10,25,50,75,90,95,100]&scale=4000
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
tmmx |
||
temporal_statistic |
yes |
mean, median, max, min, total |
||
export_format |
no |
File format of export |
json |
csv, json |
start_season |
yes |
05-10 |
||
end_season |
yes |
10-16 |
||
start_year |
yes |
Start year for the climatology |
1981 |
|
end_year |
yes |
End year for the climatology |
2010 |
|
scale |
no |
Dataset scale |
Depends dataset and bounding box |
4000 |
bounding_box |
yes |
The bounding box [SWLong, SWLat, NELong, NELat] |
[-121.7, 38.3, -120.1, 38.9] |
|
percentiles |
no |
The percentiles |
[0, 5, 10, 25, 50, 75, 90, 95, 100] |
/raster/metadata/percentiles/anomalies¶
Resource url example:
/raster/metadata/percentiles/anomalies?dataset=GRIDMET&variable=tmmx&temporal_statistic=Mean&calculation=anom&start_date=2016-08-01&end_date=2016-10-30&start_year=2014&end_year=2018&bounding_box=[-121.7,38.3,-120.1,38.9]&percentiles=[0,5,10,25,50,75,90,95,100]&scale=4000
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
tmmx |
||
temporal_statistic |
yes |
mean, median, max, min, total |
||
export_format |
no |
File format of export |
json |
csv, json |
calculation |
yes |
Anomaly calculation |
anom, anompercentof, anompercentchange |
|
start_date |
yes |
2019-01-01 |
||
end_date |
yes |
2019-10-16 |
||
start_year |
yes |
Start year for the climatology |
1981 |
|
end_year |
yes |
End year for the climatology |
2010 |
|
scale |
no |
Dataset scale |
Depends dataset and bounding box |
4000 |
bounding_box |
yes |
The bounding box [SWLong, SWLat, NELong, NELat] |
[-121.7, 38.3, -120.1, 38.9] |
|
percentiles |
no |
The percentiles |
[0, 5, 10, 25, 50, 75, 90, 95, 100] |
/raster/metadata/percentiles/standard_index¶
Resource url example:
/raster/metadata/percentiles/standard_index?dataset=GRIDMET&variable=eddi&start_date=2016-08-01&end_date=2016-10-30&start_year=2014&end_year=2018&bounding_box=[-121.7,38.3,-120.1,38.9]&percentiles=[0,5,10,25,50,75,90,95,100]&scale=4000
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
tmmx |
||
start_date |
yes |
2019-01-01 |
||
end_date |
yes |
2019-10-16 |
||
start_year |
yes |
Start year for the climatology |
1981 |
|
end_year |
yes |
End year for the climatology |
2010 |
|
scale |
no |
Dataset scale |
Depends dataset and bounding box |
4000 |
bounding_box |
yes |
The bounding box [SWLong, SWLat, NELong, NELat] |
[-121.7, 38.3, -120.1, 38.9] |
|
export_format |
no |
File format of export |
json |
csv, json |
percentiles |
no |
The percentiles |
[0, 5, 10, 25, 50, 75, 90, 95, 100] |
/raster/metadata/percentiles/mann_kendall¶
Resource url example:
/raster/metadata/percentiles/mann_kendall?dataset=LANDSAT7_TOA&variable=NDVI&temporal_statistic=Mean&calculation=mk_tau&p_value=0.5&start_season=05-01&end_season=07-30&start_year=2016&end_year=2018&bounding_box=[-121.7,38.3,-120.1,38.9]&percentiles=[0,5,10,25,50,75,90,95,100]&scale=4000
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
tmmx |
||
temporal_statistic |
yes |
mean, median, max, min, total |
||
export_format |
no |
File format of export |
json |
csv, json |
calculation |
yes |
Sen’s Slope or Kendall Tau-b |
mk_sen, mk_tau |
|
p_value |
no |
Mann Kendall p-value mask |
1.0 |
1.0 (all trends), 0.2 (80% confidence), 0.1, 0.05, 0.01 |
start_season |
yes |
01-01 |
||
end_season |
yes |
10-16 |
||
start_year |
yes |
Start year for the climatology |
1981 |
|
end_year |
yes |
End year for the climatology |
2010 |
|
scale |
no |
Dataset scale |
Depends dataset and bounding box |
4000 |
bounding_box |
yes |
The bounding box [SWLong, SWLat, NELong, NELat] |
[-121.7, 38.3, -120.1, 38.9] |
|
percentiles |
no |
The percentiles |
[0, 5, 10, 25, 50, 75, 90, 95, 100] |
/raster/metadata/statistics/values¶
Resource url example:
/raster/metadata/statistics/values?dataset=GGRIDMETvariable=tmmx&temporal_statistic=Mean&start_date=2016-01-01&end_date=2016-12-30&bounding_box=[-121.7,38.3,-120.1,38.9]&scale=4000
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
tmmx |
||
temporal_statistic |
yes |
mean, median, max, min, total |
||
export_format |
no |
File format of export |
json |
csv, json |
start_date |
yes |
2019-01-01 |
||
end_date |
yes |
2019-12-31 |
||
scale |
no |
Dataset scale |
Depends dataset and bounding box |
4000 |
bounding_box |
no |
The bounding box [SWLong, SWLat, NELong, NELat] |
[-121.7, 38.3, -120.1, 38.9] |
/raster/metadata/statistics/climatologies¶
Resource url example:
/raster/metadata/statistics/climatologies?dataset=GRIDMET&variable=tmmx&temporal_statistic=Mean&start_season=08-01&end_season=10-30&start_year=2014&end_year=2018&bounding_box=[-121.7,38.3,-120.1,38.9]&scale=4000
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
tmmx |
||
temporal_statistic |
yes |
mean, median, max, min, total |
||
export_format |
no |
File format of export |
json |
csv, json |
start_season |
yes |
05-10 |
||
end_season |
yes |
10-16 |
||
start_year |
yes |
Start year for the climatology |
1981 |
|
end_year |
yes |
End year for the climatology |
2010 |
|
scale |
no |
Dataset scale |
Depends dataset and bounding box |
4000 |
bounding_box |
no |
The bounding box [SWLong, SWLat, NELong, NELat] |
[-121.7, 38.3, -120.1, 38.9] |
/raster/metadata/statistics/anomalies¶
Resource url example:
/raster/metadata/statistics/anomalies?dataset=GRIDMET&variable=tmmx&temporal_statistic=Mean&calculation=anom&start_date=2016-08-01&end_date=2016-10-30&start_year=2014&end_year=2018&bounding_box=[-121.7,38.3,-120.1,38.9]&scale=4000
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
tmmx |
||
temporal_statistic |
yes |
mean, median, max, min, total |
||
export_format |
no |
File format of export |
json |
csv, json |
calculation |
yes |
Anomaly calculation |
anom, anompercentof, anompercentchange |
|
start_date |
yes |
2019-01-01 |
||
end_date |
yes |
2019-10-16 |
||
start_year |
yes |
Start year for the climatology |
1981 |
|
end_year |
yes |
End year for the climatology |
2010 |
|
scale |
no |
Dataset scale |
Depends dataset and bounding box |
4000 |
bounding_box |
no |
The bounding box [SWLong, SWLat, NELong, NELat] |
[-121.7, 38.3, -120.1, 38.9] |
/raster/metadata/statistics/standard_index¶
Resource url example:
/raster/metadata/statistics/standard_index?dataset=GRIDMET&variable=eddi&start_date=2016-08-01&end_date=2016-10-30&start_year=2014&end_year=2018&bounding_box=[-121.7,38.3,-120.1,38.9]&scale=4000
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
tmmx |
||
start_date |
yes |
2019-01-01 |
||
end_date |
yes |
2019-10-16 |
||
start_year |
yes |
Start year for the climatology |
1981 |
|
end_year |
yes |
End year for the climatology |
2010 |
|
bounding_box |
no |
The bounding box [SWLong, SWLat, NELong, NELat] |
[-121.7, 38.3, -120.1, 38.9] |
|
export_format |
no |
File format of export |
json |
csv, json |
scale |
no |
Dataset scale |
Depends dataset and bounding box |
4000 |
/raster/metadata/statistics/mann_kendall¶
Resource url example:
/raster/metadata/statistics/mann_kendall?dataset=LANDSAT7_TOA&variable=NDVI&temporal_statistic=Mean&calculation=mk_tau&p_value=0.5&start_season=05-01&end_season=07-30&start_year=2016&end_year=2018&bounding_box=[-121.7,38.3,-120.1,38.9]&scale=4000
NAME |
REQUIRED |
DESCRIPTION |
DEFAULT |
EXAMPLE |
---|---|---|---|---|
dataset |
yes |
GRIDMET |
||
variable |
yes |
tmmx |
||
temporal_statistic |
yes |
mean, median, max, min, total |
||
export_format |
no |
File format of export |
json |
csv, json |
calculation |
yes |
Sen’s Slope or Kendall Tau-b |
mk_sen, mk_tau |
|
p_value |
no |
Mann Kendall p-value mask |
1.0 |
1.0 (all trends), 0.2 (80% confidence), 0.1, 0.05, 0.01 |
start_season |
yes |
01-01 |
||
end_season |
yes |
10-16 |
||
start_year |
yes |
Start year for the climatology |
1981 |
|
end_year |
yes |
End year for the climatology |
2010 |
|
scale |
no |
Dataset scale |
Depends dataset and bounding box |
4000 |
bounding_box |
no |
The bounding box [SWLong, SWLat, NELong, NELat] |
[-121.7, 38.3, -120.1, 38.9] |