Feature #2279 point_weight_flag

.github/workflows/testing.yml

@@ -176,7 +176,7 @@ jobs:
           - jobid: 'job1'
             tests: 'ascii2nc_indy pb2nc_indy tc_dland tc_pairs tc_stat plot_tc tc_rmw rmw_analysis tc_diag tc_gen'
           - jobid: 'job2'
-            tests: 'met_test_scripts mode_multivar mode_graphics mtd regrid airnow gsi_tools netcdf modis series_analysis wwmca_regrid gen_vx_mask grid_weight interp_shape grid_diag grib_tables lidar2nc shift_data_plane trmm2nc aeronet wwmca_plot ioda2nc gaussian'
+            tests: 'met_test_scripts mode_multivar mode_graphics mtd regrid airnow gsi_tools netcdf modis series_analysis wwmca_regrid gen_vx_mask interp_shape grid_diag grib_tables lidar2nc shift_data_plane trmm2nc aeronet wwmca_plot ioda2nc gaussian'
       fail-fast: false
     steps:
       - uses: actions/checkout@v4
@@ -310,6 +310,8 @@ jobs:
             tests: 'ensemble_stat stat_analysis_es'
           - jobid: 'job5'
             tests: 'ugrid'
+          - jobid: 'job6'
+            tests: 'grid_weight point_weight'
       fail-fast: false
     steps:
       - uses: actions/checkout@v4

data/config/ConfigConstants

@@ -137,6 +137,10 @@ NONE           = 1;
 COS_LAT        = 2;
 AREA           = 3;
 
+// Point weight flag settings
+NONE           = 1;
+SID            = 2;
+
 // Duplicate flag settings
 NONE           = 1;
 UNIQUE         = 2;

data/config/EnsembleStatConfig_default

@@ -266,8 +266,10 @@ rng = {
 
 ////////////////////////////////////////////////////////////////////////////////
 
-grid_weight_flag = NONE;
-output_prefix    = "";
-version          = "V12.0.0";
+grid_weight_flag  = NONE;
+point_weight_flag = NONE;
+
+output_prefix = "";
+version       = "V12.0.0";
 
 ////////////////////////////////////////////////////////////////////////////////

data/config/GridStatConfig_default

@@ -271,8 +271,9 @@ nc_pairs_flag = {
 ////////////////////////////////////////////////////////////////////////////////
 
 grid_weight_flag = NONE;
-tmp_dir          = "/tmp";
-output_prefix    = "";
-version          = "V12.0.0";
+
+tmp_dir       = "/tmp";
+output_prefix = "";
+version       = "V12.0.0";
 
 ////////////////////////////////////////////////////////////////////////////////

data/config/PointStatConfig_default

@@ -305,8 +305,10 @@ output_flag = {
 
 ////////////////////////////////////////////////////////////////////////////////
 
-tmp_dir        = "/tmp";
-output_prefix  = "";
-version        = "V12.0.0";
+point_weight_flag = NONE;
+
+tmp_dir       = "/tmp";
+output_prefix = "";
+version       = "V12.0.0";
 
 ////////////////////////////////////////////////////////////////////////////////

docs/Users_Guide/config_options.rst

@@ -1847,15 +1847,18 @@ in the following ways:
     embedded within another quoted string. Any such embedded quotes must
     be escaped using a preceeding backslash character.
 
-* The "sid" entry is an array of strings which define groups of
-  observation station ID's over which to compute statistics. Each entry
-  in the array is either a filename of a comma-separated list.
-
-  * For a filename, the strings are whitespace-separated. The first
-    string is the mask "name" and the remaining strings are the station
+* The "sid" entry is an array of strings which define groups of observation station
+  ID's over which to compute statistics. Each station ID string can be followed by an
+  optional numeric weight enclosed in parenethesis and used by the "point_weight_flag"
+  configuration option. Each entry in the "sid" "array is either a filename or a
+  comma-separated list.
+
+  * For an ASCII filename, the strings contained within it are whitespace-separated.
+    The first string is the mask "name" and the remaining strings are the station
     ID's to be used.
   * For a comma-separated list, optionally use a colon to specify a name.
-    For "MY_LIST:SID1,SID2", name = MY_LIST and values = SID1 and SID2.
+    For "MY_LIST:SID1(WGT1),SID2(WGT2)", name = MY_LIST which consists of
+    two station ID's (SID1 and SID2) and optional numeric weights (WGT1 and WGT2).
   * For a comma-separated list of length one with no name specified, the
     mask "name" and value are both set to the single station ID string.
     For "SID1", name = SID1 and value = SID1.
@@ -1865,6 +1868,7 @@ in the following ways:
     For "SID1,SID2", name = MASK_SID and values = SID1 and SID2.
   * The "name" of the station ID mask is written to the VX_MASK column
     of the MET output files.
+
 * The "llpnt" entry is either a single dictionary or an array of
   dictionaries. Each dictionary contains three entries, the "name" for
   the masking region, "lat_thresh", and "lon_thresh". The latitude and
@@ -2353,8 +2357,9 @@ NBRCTC), partial sums (SL1L2, SAL1L2, VL1L2, and VAL1L2), and statistics
 It is meant to account for grid box area distortion and is often applied
 to global Lat/Lon grids. It is only applied for grid-to-grid verification
 in Grid-Stat and Ensemble-Stat and is not applied for grid-to-point
-verification. It can only be defined once at the highest level of config
-file context and applies to all verification tasks for that run.
+verification, which is controlled by the "point_weight_flag" option.
+It can only be defined once at the highest level of config file context
+and applies to all verification tasks for that run.
 
 Three grid weighting options are currently supported:
 
@@ -2391,6 +2396,27 @@ versions of MET.
 
   grid_weight_flag = NONE;
 
+point_weight_flag
+-----------------
+
+The "point_weight_flag" is similar to the "grid_weight_flag", described above,
+but applies to grid-to-point verification in Point-Stat and Ensemble-Stat.
+It is not applied for grid-to-grid verification which is controlled by the
+"grid_weight_flag" option. It can only be defined once at the highest level
+of config file context and applies to all verification tasks for that run.
+
+While only one point weighting option is currently supported, additional
+methods are planned for future versions:
+
+* NONE to disable point weighting using a constant weight of 1.0 (default).
+
+* SID to use the weights defined by the station ID masking configuration option,
+  "mask.sid".
+
+.. code-block:: none
+
+  point_weight_flag = NONE;
+
 hss_ec_value
 ------------
 

docs/Users_Guide/ensemble-stat.rst

@@ -182,13 +182,25 @@ ____________________
   obs_perc_value   = 50;
   message_type_group_map = [...];
   grid_weight_flag = NONE;
+  point_weight_flag = NONE;
   output_prefix    = "";
   version          = "VN.N";
 
 
 The configuration options listed above are common to many MET tools and are described in :numref:`config_options`.
 
-Note that the **HIRA** interpolation method is only supported in Ensemble-Stat.
+.. note::
+
+  The **HIRA** interpolation method is only supported in Ensemble-Stat.
+
+.. note::
+
+  The "grid_weight_flag" and "point_weight_flag" options described in
+  :numref:`config_options` define how matched pairs are weighted for
+  grid-to-grid and grid-to-point verification in Ensemble-Stat. These
+  weights currently only apply to the computation of probabilistic
+  outputs (PCT, PSTD, PJC, and PRC) but no other Ensemble-Stat output
+  line types.
 
 _____________________
 

docs/Users_Guide/point-stat.rst

@@ -362,6 +362,7 @@ ________________________
   obs_summary    = NONE;
   obs_perc_value = 50;
   message_type_group_map = [...];
+  point_weight_flag = NONE;
   tmp_dir        = "/tmp";
   output_prefix  = "";
   version        = "VN.N";

internal/test_unit/config/EnsembleStatConfig

@@ -226,8 +226,10 @@ rng = {
 
 ////////////////////////////////////////////////////////////////////////////////
 
-grid_weight_flag = NONE;
-output_prefix    = "${OUTPUT_PREFIX}";
-version          = "V12.0.0";
+grid_weight_flag  = NONE;
+point_weight_flag = NONE;
+
+output_prefix = "${OUTPUT_PREFIX}";
+version       = "V12.0.0";
 
 ////////////////////////////////////////////////////////////////////////////////

internal/test_unit/config/EnsembleStatConfig_MASK_SID

@@ -218,8 +218,10 @@ rng = {
 
 ////////////////////////////////////////////////////////////////////////////////
 
-grid_weight_flag = NONE;
-output_prefix    = "${OUTPUT_PREFIX}";
-version          = "V12.0.0";
+grid_weight_flag  = NONE;
+point_weight_flag = NONE;
+
+output_prefix = "${OUTPUT_PREFIX}";
+version       = "V12.0.0";
 
 ////////////////////////////////////////////////////////////////////////////////

internal/test_unit/config/EnsembleStatConfig_climo

@@ -248,8 +248,10 @@ rng = {
 
 ////////////////////////////////////////////////////////////////////////////////
 
-grid_weight_flag = NONE;
-output_prefix    = "${OUTPUT_PREFIX}";
-version          = "V12.0.0";
+grid_weight_flag  = NONE;
+point_weight_flag = NONE;
+
+output_prefix = "${OUTPUT_PREFIX}";
+version       = "V12.0.0";
 
 ////////////////////////////////////////////////////////////////////////////////

internal/test_unit/config/EnsembleStatConfig_grid_weight

@@ -240,8 +240,10 @@ rng = {
 
 ////////////////////////////////////////////////////////////////////////////////
 
-grid_weight_flag = ${GRID_WEIGHT};
-output_prefix    = "${OUTPUT_PREFIX}";
-version          = "V12.0.0";
+grid_weight_flag  = ${GRID_WEIGHT};
+point_weight_flag = NONE;
+
+output_prefix = "${OUTPUT_PREFIX}";
+version       = "V12.0.0";
 
 ////////////////////////////////////////////////////////////////////////////////

internal/test_unit/config/EnsembleStatConfig_one_cdf_bin

@@ -232,8 +232,10 @@ rng = {
 
 ////////////////////////////////////////////////////////////////////////////////
 
-grid_weight_flag = NONE;
-output_prefix    = "${OUTPUT_PREFIX}";
-version          = "V12.0.0";
+grid_weight_flag  = NONE;
+point_weight_flag = NONE;
+
+output_prefix = "${OUTPUT_PREFIX}";
+version       = "V12.0.0";
 
 ////////////////////////////////////////////////////////////////////////////////