Skip to content

Commit

Permalink
Per #2362, update the topo_mask and land_mask documentation to clarif…
Browse files Browse the repository at this point in the history
…y when SURFACE/LANDSF/WATERSF must be defined.
  • Loading branch information
JohnHalleyGotway committed Dec 1, 2022
1 parent 97375d9 commit 88fb621
Showing 1 changed file with 25 additions and 25 deletions.
50 changes: 25 additions & 25 deletions docs/Users_Guide/config_options.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1797,20 +1797,20 @@ This dictionary may include the following entries:
land_mask
^^^^^^^^^

The "land_mask" dictionary defines the land/sea mask field which is used
when verifying at the surface. For point observations whose message type
appears in the "LANDSF" entry of the "message_type_group_map" setting,
only use forecast grid points where land = TRUE. For point observations
whose message type appears in the "WATERSF" entry of the
"message_type_group_map" setting, only use forecast grid points where
land = FALSE. The "flag" entry enables/disables this logic. If the
"file_name" entry is left empty, then the land/sea is assumed to exist in
the input forecast file. Otherwise, the specified file(s) are searched for
the data specified in the "field" entry. The "regrid" settings specify how
this field should be regridded to the verification domain. Lastly, the
"thresh" entry is the threshold which defines land (threshold is true) and
water (threshold is false).
land_mask.flag may be set separately in each "obs.field" entry.
The "land_mask" dictionary defines the land/sea mask field used when
verifying at the surface. The "flag" entry enables/disables this logic.
When enabled, the "message_type_group_map" dictionary must contain entries
for "LANDSF" and "WATERSF". For point observations whose message type
appears in the "LANDSF" entry, only use forecast grid points where land =
TRUE. For point observations whose message type appears in the "WATERSF"
entry, only use forecast grid points where land = FALSE. If the "file_name"
entry is left empty, the land/sea is assumed to exist in the input forecast
file. Otherwise, the specified file(s) are searched for the data specified
in the "field" entry. The "regrid" settings specify how this field should be
regridded to the verification domain. Lastly, the "thresh" entry is the
threshold which defines land (threshold is true) and water (threshold is false).

The "land_mask.flag" entry may be set separately in each "obs.field" entry.

.. code-block:: none
Expand All @@ -1825,21 +1825,21 @@ land_mask.flag may be set separately in each "obs.field" entry.
topo_mask
^^^^^^^^^

The "topo_mask" dictionary defines the model topography field which is used
when verifying at the surface. This logic is applied to point observations
whose message type appears in the "SURFACE" entry of the
"message_type_group_map" setting. Only use point observations where the
topo - station elevation difference meets the "use_obs_thresh" threshold
The "topo_mask" dictionary defines the model topography field used when
verifying at the surface. The flag entry enables/disables this logic.
When enabled, the "message_type_group_map" dictionary must contain an entry
for "SURFACE". This logic is applied to point observations whose message type
appears in the "SURFACE" entry. Only use point observations where the
topo minus station elevation difference meets the "use_obs_thresh" threshold
entry. For the observations kept, when interpolating forecast data to the
observation location, only use forecast grid points where the topo - station
difference meets the "interp_fcst_thresh" threshold entry. The flag entry
enables/disables this logic. If the "file_name" is left empty, then the
topography data is assumed to exist in the input forecast file. Otherwise,
the specified file(s) are searched for the data specified in the "field"
observation location, only use forecast grid points where the topo minus station
difference meets the "interp_fcst_thresh" threshold entry. If the "file_name"
is left empty, the topography data is assumed to exist in the input forecast file.
Otherwise, the specified file(s) are searched for the data specified in the "field"
entry. The "regrid" settings specify how this field should be regridded to
the verification domain.

topo_mask.flag may be set separately in each "obs.field" entry.
The "topo_mask.flag" entry may be set separately in each "obs.field" entry.

.. code-block:: none
Expand Down

0 comments on commit 88fb621

Please sign in to comment.