Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature #2334 land_mask (and topo_mask) in PointStat #2456

Merged
merged 4 commits into from
Dec 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 90 additions & 0 deletions docs/Users_Guide/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11509,3 +11509,93 @@ METplus Configuration Glossary
Specify the value for 'regrid.censor_val' in the MET configuration file for WaveletStat.

| *Used by:* WaveletStat

POINT_STAT_LAND_MASK_FLAG
Specify the value for 'land_mask.flag' in the MET configuration file for PointStat.

| *Used by:* PointStat

POINT_STAT_LAND_MASK_FILE_NAME
Specify the value for 'land_mask.file_name' in the MET configuration file for PointStat.

| *Used by:* PointStat

POINT_STAT_LAND_MASK_FIELD_NAME
Specify the value for 'land_mask.field.name' in the MET configuration file for PointStat.

| *Used by:* PointStat

POINT_STAT_LAND_MASK_FIELD_LEVEL
Specify the value for 'land_mask.field.level' in the MET configuration file for PointStat.

| *Used by:* PointStat

POINT_STAT_LAND_MASK_REGRID_METHOD
Specify the value for 'land_mask.regrid.method' in the MET configuration file for PointStat.

| *Used by:* PointStat

POINT_STAT_LAND_MASK_REGRID_WIDTH
Specify the value for 'land_mask.regrid.width' in the MET configuration file for PointStat.

| *Used by:* PointStat

POINT_STAT_LAND_MASK_THRESH
Specify the value for 'land_mask.thresh' in the MET configuration file for PointStat.

| *Used by:* PointStat

POINT_STAT_TOPO_MASK_FLAG
Specify the value for 'topo_mask.flag' in the MET configuration file for PointStat.

| *Used by:* PointStat

POINT_STAT_TOPO_MASK_FILE_NAME
Specify the value for 'topo_mask.file_name' in the MET configuration file for PointStat.

| *Used by:* PointStat

POINT_STAT_TOPO_MASK_FIELD_NAME
Specify the value for 'topo_mask.field.name' in the MET configuration file for PointStat.

| *Used by:* PointStat

POINT_STAT_TOPO_MASK_FIELD_LEVEL
Specify the value for 'topo_mask.field.level' in the MET configuration file for PointStat.

| *Used by:* PointStat

POINT_STAT_TOPO_MASK_REGRID_METHOD
Specify the value for 'topo_mask.regrid.method' in the MET configuration file for PointStat.

| *Used by:* PointStat

POINT_STAT_TOPO_MASK_REGRID_WIDTH
Specify the value for 'topo_mask.regrid.width' in the MET configuration file for PointStat.

| *Used by:* PointStat

POINT_STAT_TOPO_MASK_USE_OBS_THRESH
Specify the value for 'topo_mask.use_obs_thresh' in the MET configuration file for PointStat.

| *Used by:* PointStat

POINT_STAT_TOPO_MASK_INTERP_FCST_THRESH
Specify the value for 'topo_mask.interp_fcst_thresh' in the MET configuration file for PointStat.

| *Used by:* PointStat

POINT_STAT_DUPLICATE_FLAG
Specify the value for 'duplicate_flag' in the MET configuration file for PointStat.

| *Used by:* PointStat

POINT_STAT_OBS_SUMMARY
Specify the value for 'obs_summary' in the MET configuration file for PointStat.

| *Used by:* PointStat

POINT_STAT_OBS_PERC_VALUE
Specify the value for 'obs_perc_value' in the MET configuration file for PointStat.

| *Used by:* PointStat
104 changes: 104 additions & 0 deletions docs/Users_Guide/wrappers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6286,8 +6286,26 @@ Configuration
| :term:`POINT_STAT_CLIMO_CDF_CENTER_BINS`
| :term:`POINT_STAT_CLIMO_CDF_WRITE_BINS`
| :term:`POINT_STAT_CLIMO_CDF_DIRECT_PROB`
| :term:`POINT_STAT_LAND_MASK_FLAG`
| :term:`POINT_STAT_LAND_MASK_FILE_NAME`
| :term:`POINT_STAT_LAND_MASK_FIELD_NAME`
| :term:`POINT_STAT_LAND_MASK_FIELD_LEVEL`
| :term:`POINT_STAT_LAND_MASK_REGRID_METHOD`
| :term:`POINT_STAT_LAND_MASK_REGRID_WIDTH`
| :term:`POINT_STAT_LAND_MASK_THRESH`
| :term:`POINT_STAT_TOPO_MASK_FLAG`
| :term:`POINT_STAT_TOPO_MASK_FILE_NAME`
| :term:`POINT_STAT_TOPO_MASK_FIELD_NAME`
| :term:`POINT_STAT_TOPO_MASK_FIELD_LEVEL`
| :term:`POINT_STAT_TOPO_MASK_REGRID_METHOD`
| :term:`POINT_STAT_TOPO_MASK_REGRID_WIDTH`
| :term:`POINT_STAT_TOPO_MASK_USE_OBS_THRESH`
| :term:`POINT_STAT_TOPO_MASK_INTERP_FCST_THRESH`
| :term:`POINT_STAT_OBS_QUALITY_INC`
| :term:`POINT_STAT_OBS_QUALITY_EXC`
| :term:`POINT_STAT_DUPLICATE_FLAG`
| :term:`POINT_STAT_OBS_SUMMARY`
| :term:`POINT_STAT_OBS_PERC_VALUE`
| :term:`POINT_STAT_OUTPUT_FLAG_FHO`
| :term:`POINT_STAT_OUTPUT_FLAG_CTC`
| :term:`POINT_STAT_OUTPUT_FLAG_CTS`
Expand Down Expand Up @@ -6589,6 +6607,42 @@ ${METPLUS_OBS_QUALITY_EXC}
* - :term:`POINT_STAT_OBS_QUALITY_EXC`
- obs_quality_exc

${METPLUS_DUPLICATE_FLAG}
^^^^^^^^^^^^^^^^^^^^^^^^^

.. list-table::
:widths: 5 5
:header-rows: 1

* - METplus Config(s)
- MET Config File
* - :term:`POINT_STAT_DUPLICATE_FLAG`
- duplicate_flag

${METPLUS_OBS_SUMMARY}
^^^^^^^^^^^^^^^^^^^^^^

.. list-table::
:widths: 5 5
:header-rows: 1

* - METplus Config(s)
- MET Config File
* - :term:`POINT_STAT_OBS_SUMMARY`
- obs_summary

${METPLUS_OBS_PERC_VALUE}
^^^^^^^^^^^^^^^^^^^^^^^^^

.. list-table::
:widths: 5 5
:header-rows: 1

* - METplus Config(s)
- MET Config File
* - :term:`POINT_STAT_OBS_PERC_VALUE`
- obs_perc_value

${METPLUS_MESSAGE_TYPE_GROUP_MAP}
"""""""""""""""""""""""""""""""""

Expand Down Expand Up @@ -6679,6 +6733,56 @@ ${METPLUS_CLIMO_CDF_DICT}
* - :term:`POINT_STAT_CLIMO_CDF_DIRECT_PROB`
- climo_cdf.direct_prob

${METPLUS_LAND_MASK_DICT}
^^^^^^^^^^^^^^^^^^^^^^^^^

.. list-table::
:widths: 5 5
:header-rows: 1

* - METplus Config(s)
- MET Config File
* - :term:`POINT_STAT_LAND_MASK_FLAG`
- land_mask.flag
* - :term:`POINT_STAT_LAND_MASK_FILE_NAME`
- land_mask.file_name
* - :term:`POINT_STAT_LAND_MASK_FIELD_NAME`
- land_mask.field.name
* - :term:`POINT_STAT_LAND_MASK_FIELD_LEVEL`
- land_mask.field.level
* - :term:`POINT_STAT_LAND_MASK_REGRID_METHOD`
- land_mask.regrid.method
* - :term:`POINT_STAT_LAND_MASK_REGRID_WIDTH`
- land_mask.regrid.width
* - :term:`POINT_STAT_LAND_MASK_THRESH`
- land_mask.thresh

${METPLUS_TOPO_MASK_DICT}
^^^^^^^^^^^^^^^^^^^^^^^^^

.. list-table::
:widths: 5 5
:header-rows: 1

* - METplus Config(s)
- MET Config File
* - :term:`POINT_STAT_TOPO_MASK_FLAG`
- topo_mask.flag
* - :term:`POINT_STAT_TOPO_MASK_FILE_NAME`
- topo_mask.file_name
* - :term:`POINT_STAT_TOPO_MASK_FIELD_NAME`
- topo_mask.field.name
* - :term:`POINT_STAT_TOPO_MASK_FIELD_LEVEL`
- topo_mask.field.level
* - :term:`POINT_STAT_TOPO_MASK_REGRID_METHOD`
- topo_mask.regrid.method
* - :term:`POINT_STAT_TOPO_MASK_REGRID_WIDTH`
- topo_mask.regrid.width
* - :term:`POINT_STAT_TOPO_MASK_USE_OBS_THRESH`
- topo_mask.use_obs_thresh
* - :term:`POINT_STAT_TOPO_MASK_INTERP_FCST_THRESH`
- topo_mask.interp_fcst_thresh

${METPLUS_OBS_WINDOW_DICT}
""""""""""""""""""""""""""

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -544,6 +544,63 @@ def test_met_dictionary_in_var_options(metplus_config):
'sid = ["one", "two"];'
'llpnt = [{ name = "LAT30TO40"; lat_thresh = >=30&&<=40; lon_thresh = NA; }, { name = "BOX"; lat_thresh = >=20&&<=40; lon_thresh = >=-110&&<=-90; }];}'
)}),
# land_mask dictionary
({'POINT_STAT_LAND_MASK_FLAG': 'false', },
{'METPLUS_LAND_MASK_DICT': 'land_mask = {flag = FALSE;}'}),
({'POINT_STAT_LAND_MASK_FILE_NAME': '/some/file/path.nc', },
{'METPLUS_LAND_MASK_DICT': 'land_mask = {file_name = ["/some/file/path.nc"];}'}),
({'POINT_STAT_LAND_MASK_FIELD_NAME': 'LAND',
'POINT_STAT_LAND_MASK_FIELD_LEVEL': 'L0'},
{'METPLUS_LAND_MASK_DICT': 'land_mask = {field = {name = "LAND";level = "L0";}}'}),
({'POINT_STAT_LAND_MASK_REGRID_METHOD': 'NEAREST',
'POINT_STAT_LAND_MASK_REGRID_WIDTH': '1'},
{'METPLUS_LAND_MASK_DICT': 'land_mask = {regrid = {method = NEAREST;width = 1;}}'}),
({'POINT_STAT_LAND_MASK_THRESH': 'eq1', },
{'METPLUS_LAND_MASK_DICT': 'land_mask = {thresh = eq1;}'}),
({'POINT_STAT_LAND_MASK_FLAG': 'false',
'POINT_STAT_LAND_MASK_FILE_NAME': '/some/file/path.nc',
'POINT_STAT_LAND_MASK_FIELD_NAME': 'LAND',
'POINT_STAT_LAND_MASK_FIELD_LEVEL': 'L0',
'POINT_STAT_LAND_MASK_REGRID_METHOD': 'NEAREST',
'POINT_STAT_LAND_MASK_REGRID_WIDTH': '1',
'POINT_STAT_LAND_MASK_THRESH': 'eq1',
},
{'METPLUS_LAND_MASK_DICT': ('land_mask = {flag = FALSE;file_name = ["/some/file/path.nc"];'
'field = {name = "LAND";level = "L0";}'
'regrid = {method = NEAREST;width = 1;}thresh = eq1;}')}),
# topo_mask dictionary
({'POINT_STAT_TOPO_MASK_FLAG': 'false', },
{'METPLUS_TOPO_MASK_DICT': 'topo_mask = {flag = FALSE;}'}),
({'POINT_STAT_TOPO_MASK_FILE_NAME': '/some/file/path.nc', },
{'METPLUS_TOPO_MASK_DICT': 'topo_mask = {file_name = ["/some/file/path.nc"];}'}),
({'POINT_STAT_TOPO_MASK_FIELD_NAME': 'TOPO',
'POINT_STAT_TOPO_MASK_FIELD_LEVEL': 'L0'},
{'METPLUS_TOPO_MASK_DICT': 'topo_mask = {field = {name = "TOPO";level = "L0";}}'}),
({'POINT_STAT_TOPO_MASK_REGRID_METHOD': 'NEAREST',
'POINT_STAT_TOPO_MASK_REGRID_WIDTH': '1'},
{'METPLUS_TOPO_MASK_DICT': 'topo_mask = {regrid = {method = NEAREST;width = 1;}}'}),
({'POINT_STAT_TOPO_MASK_USE_OBS_THRESH': 'ge-100&&le100', },
{'METPLUS_TOPO_MASK_DICT': 'topo_mask = {use_obs_thresh = ge-100&&le100;}'}),
({'POINT_STAT_TOPO_MASK_INTERP_FCST_THRESH': 'ge-50&&le50', },
{'METPLUS_TOPO_MASK_DICT': 'topo_mask = {interp_fcst_thresh = ge-50&&le50;}'}),
({'POINT_STAT_TOPO_MASK_FLAG': 'false',
'POINT_STAT_TOPO_MASK_FILE_NAME': '/some/file/path.nc',
'POINT_STAT_TOPO_MASK_FIELD_NAME': 'TOPO',
'POINT_STAT_TOPO_MASK_FIELD_LEVEL': 'L0',
'POINT_STAT_TOPO_MASK_REGRID_METHOD': 'NEAREST',
'POINT_STAT_TOPO_MASK_REGRID_WIDTH': '1',
'POINT_STAT_TOPO_MASK_USE_OBS_THRESH': 'ge-100&&le100',
'POINT_STAT_TOPO_MASK_INTERP_FCST_THRESH': 'ge-50&&le50'
},
{'METPLUS_TOPO_MASK_DICT': ('topo_mask = {flag = FALSE;file_name = ["/some/file/path.nc"];'
'field = {name = "TOPO";level = "L0";}regrid = {method = NEAREST;width = 1;}'
'use_obs_thresh = ge-100&&le100;interp_fcst_thresh = ge-50&&le50;}')}),
({'POINT_STAT_DUPLICATE_FLAG': 'NONE', },
{'METPLUS_DUPLICATE_FLAG': 'duplicate_flag = NONE;'}),
({'POINT_STAT_OBS_SUMMARY': 'NONE', },
{'METPLUS_OBS_SUMMARY': 'obs_summary = NONE;'}),
({'POINT_STAT_OBS_PERC_VALUE': '50', },
{'METPLUS_OBS_PERC_VALUE': 'obs_perc_value = 50;'}),

]
)
Expand Down
Loading