Per #3030, enhance Series-Analysis to aggregate the GRAD line type in…

…crementally across multiple runs. However, this can only be done when requesting that 'ALL' GRAD columns be written.
dtcenter · Dec 12, 2024 · 9d876c4 · 9d876c4
1 parent e54eb54
commit 9d876c4
Show file tree

Hide file tree

Showing 4 changed files with 295 additions and 27 deletions.
diff --git a/docs/Users_Guide/series-analysis.rst b/docs/Users_Guide/series-analysis.rst
@@ -188,4 +188,4 @@ The output_stats array controls the type of output that the Series-Analysis tool
 
 13. GRAD for Gradient Statistics (See :numref:`table_GS_format_info_GRAD`)
 
-.. note:: When the -input option is used, all partial sum and contingency table count columns are required to aggregate statistics across multiple runs. To facilitate this, the output_stats entries for the CTC, SL1L2, SAL1L2, and PCT line types can be set to "ALL" to indicate that all available columns for those line types should be written.
+.. note:: When the -input option is used, all partial sum and contingency table count columns are required to aggregate statistics across multiple runs. To facilitate this, the output_stats entries for the CTC, SL1L2, SAL1L2, PCT, and GRAD line types can be set to "ALL" to indicate that all available columns for those line types should be written.
diff --git a/internal/test_unit/config/SeriesAnalysisConfig b/internal/test_unit/config/SeriesAnalysisConfig
@@ -109,6 +109,19 @@ mask = {
    poly = "${MASK_POLY}";
 }
 
+////////////////////////////////////////////////////////////////////////////////
+
+//
+// Gradient statistics
+// May be set separately in each "obs.field" entry
+//
+gradient = {
+   dx = [ 1, 3 ];
+   dy = [ 1, 3 ];
+}
+
+////////////////////////////////////////////////////////////////////////////////
+
 //
 // Number of grid points to be processed concurrently. Set smaller to use less
 // memory but increase the number of passes through the data. If set <= 0, all
@@ -139,6 +152,7 @@ output_stats = {
    pstd   = [ ${PSTD_STATS}   ];
    pjc    = [ ${PJC_STATS}    ];
    prc    = [ ${PRC_STATS}    ];
+   grad   = [ ${GRAD_STATS}   ];
 }
 
 ////////////////////////////////////////////////////////////////////////////////

diff --git a/internal/test_unit/xml/unit_series_analysis.xml b/internal/test_unit/xml/unit_series_analysis.xml
@@ -40,6 +40,7 @@
       <pair><name>PSTD_STATS</name>      <value></value></pair>
       <pair><name>PJC_STATS</name>       <value></value></pair>
       <pair><name>PRC_STATS</name>       <value></value></pair>
+      <pair><name>GRAD_STATS</name>      <value>"ALL"</value></pair>
     </env>
     <param> \
       -fcst   &DATA_DIR_MODEL;/grib1/gfs_hmt/gfs_2012040900_F006.grib \
@@ -81,6 +82,7 @@
       <pair><name>PSTD_STATS</name>      <value></value></pair>
       <pair><name>PJC_STATS</name>       <value></value></pair>
       <pair><name>PRC_STATS</name>       <value></value></pair>
+      <pair><name>GRAD_STATS</name>      <value>"ALL"</value></pair>
     </env>
     <param> \
       -fcst   &DATA_DIR_MODEL;/grib1/gfs_hmt/gfs_2012040900_F030.grib \
@@ -131,6 +133,7 @@
       <pair><name>PSTD_STATS</name>      <value>"TOTAL", "ROC_AUC", "BRIER", "BRIER_NCL", "BRIER_NCU"</value></pair>
       <pair><name>PJC_STATS</name>       <value>"CALIBRATION_1", "REFINEMENT_1"</value></pair>
       <pair><name>PRC_STATS</name>       <value>"PODY_1", "POFD_1"</value></pair>
+      <pair><name>GRAD_STATS</name>      <value></value></pair>
     </env>
     <param> \
       -fcst   &OUTPUT_DIR;/series_analysis/input_fcst_file_list \
@@ -174,6 +177,7 @@
       <pair><name>PSTD_STATS</name>      <value>"TOTAL", "ROC_AUC", "BRIER", "BRIER_NCL", "BRIER_NCU"</value></pair>
       <pair><name>PJC_STATS</name>       <value>"CALIBRATION_1", "REFINEMENT_1"</value></pair>
       <pair><name>PRC_STATS</name>       <value>"PODY_1", "POFD_1"</value></pair>
+      <pair><name>GRAD_STATS</name>      <value></value></pair>
     </env>
     <param> \
       -fcst   &OUTPUT_DIR;/series_analysis/aggregate_fcst_file_list \
@@ -210,6 +214,7 @@
       <pair><name>PSTD_STATS</name>      <value></value></pair>
       <pair><name>PJC_STATS</name>       <value></value></pair>
       <pair><name>PRC_STATS</name>       <value></value></pair>
+      <pair><name>GRAD_STATS</name>      <value></value></pair>
     </env>
     <param> \
       -fcst   &DATA_DIR_MODEL;/grib1/arw-fer-gep1/arw-fer-gep1_2012040900_F012.grib \
Original file line number	Diff line number	Diff line change
Expand Up		@@ -188,4 +188,4 @@ The output_stats array controls the type of output that the Series-Analysis tool

		13. GRAD for Gradient Statistics (See :numref:`table_GS_format_info_GRAD`)

		.. note:: When the -input option is used, all partial sum and contingency table count columns are required to aggregate statistics across multiple runs. To facilitate this, the output_stats entries for the CTC, SL1L2, SAL1L2, and PCT line types can be set to "ALL" to indicate that all available columns for those line types should be written.
		.. note:: When the -input option is used, all partial sum and contingency table count columns are required to aggregate statistics across multiple runs. To facilitate this, the output_stats entries for the CTC, SL1L2, SAL1L2, PCT, and GRAD line types can be set to "ALL" to indicate that all available columns for those line types should be written.