From b779b691d3cf5d4c465ce786184814a622e62786 Mon Sep 17 00:00:00 2001 From: John Halley Gotway Date: Wed, 9 Nov 2022 14:38:14 -0700 Subject: [PATCH 1/3] Per #2337, rename the TCDIAG SOURCE column as DIAG_SOURCE.g --- data/table_files/met_header_columns_V11.0.txt | 2 +- docs/Users_Guide/tc-pairs.rst | 2 +- internal/test_unit/hdr/met_11_0.hdr | 2 +- internal/test_unit/perl/tcst_conv.pl | 6 +++--- src/libcode/vx_tc_util/tc_columns.h | 2 +- src/libcode/vx_tc_util/track_pair_info.cc | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/data/table_files/met_header_columns_V11.0.txt b/data/table_files/met_header_columns_V11.0.txt index 2c9cf33896..c991a2847f 100644 --- a/data/table_files/met_header_columns_V11.0.txt +++ b/data/table_files/met_header_columns_V11.0.txt @@ -37,5 +37,5 @@ V11.0 : MODE : OBJ : VERSION MODEL N_VALID GRID_RES DESC FCST_LEAD FCST_VAL V11.0 : MODE : CTS : VERSION MODEL N_VALID GRID_RES DESC FCST_LEAD FCST_VALID FCST_ACCUM OBS_LEAD OBS_VALID OBS_ACCUM FCST_RAD FCST_THR OBS_RAD OBS_THR FCST_VAR FCST_UNITS FCST_LEV OBS_VAR OBS_UNITS OBS_LEV OBTYPE FIELD TOTAL FY_OY FY_ON FN_OY FN_ON BASER FMEAN ACC FBIAS PODY PODN POFD FAR CSI GSS HK HSS ODDS V11.0 : TCST : TCMPR : VERSION AMODEL BMODEL DESC STORM_ID BASIN CYCLONE STORM_NAME INIT LEAD VALID INIT_MASK VALID_MASK LINE_TYPE TOTAL INDEX LEVEL WATCH_WARN INITIALS ALAT ALON BLAT BLON TK_ERR X_ERR Y_ERR ALTK_ERR CRTK_ERR ADLAND BDLAND AMSLP BMSLP AMAX_WIND BMAX_WIND AAL_WIND_34 BAL_WIND_34 ANE_WIND_34 BNE_WIND_34 ASE_WIND_34 BSE_WIND_34 ASW_WIND_34 BSW_WIND_34 ANW_WIND_34 BNW_WIND_34 AAL_WIND_50 BAL_WIND_50 ANE_WIND_50 BNE_WIND_50 ASE_WIND_50 BSE_WIND_50 ASW_WIND_50 BSW_WIND_50 ANW_WIND_50 BNW_WIND_50 AAL_WIND_64 BAL_WIND_64 ANE_WIND_64 BNE_WIND_64 ASE_WIND_64 BSE_WIND_64 ASW_WIND_64 BSW_WIND_64 ANW_WIND_64 BNW_WIND_64 ARADP BRADP ARRP BRRP AMRD BMRD AGUSTS BGUSTS AEYE BEYE ADIR BDIR ASPEED BSPEED ADEPTH BDEPTH NUM_MEMBERS TRACK_SPREAD DIST_MEAN MSLP_SPREAD MAX_WIND_SPREAD -V11.0 : TCST : TCDIAG : VERSION AMODEL BMODEL DESC STORM_ID BASIN CYCLONE STORM_NAME INIT LEAD VALID INIT_MASK VALID_MASK LINE_TYPE TOTAL INDEX SOURCE (N_DIAG) DIAG_[0-9]* VALUE_[0-9]* +V11.0 : TCST : TCDIAG : VERSION AMODEL BMODEL DESC STORM_ID BASIN CYCLONE STORM_NAME INIT LEAD VALID INIT_MASK VALID_MASK LINE_TYPE TOTAL INDEX DIAG_SOURCE (N_DIAG) DIAG_[0-9]* VALUE_[0-9]* V11.0 : TCST : PROBRIRW : VERSION AMODEL BMODEL DESC STORM_ID BASIN CYCLONE STORM_NAME INIT LEAD VALID INIT_MASK VALID_MASK LINE_TYPE ALAT ALON BLAT BLON INITIALS TK_ERR X_ERR Y_ERR ADLAND BDLAND RIRW_BEG RIRW_END RIRW_WINDOW AWIND_END BWIND_BEG BWIND_END BDELTA BDELTA_MAX BLEVEL_BEG BLEVEL_END (N_THRESH) THRESH_[0-9]* PROB_[0-9]* diff --git a/docs/Users_Guide/tc-pairs.rst b/docs/Users_Guide/tc-pairs.rst index 3e6508446d..85bf8c5ee4 100644 --- a/docs/Users_Guide/tc-pairs.rst +++ b/docs/Users_Guide/tc-pairs.rst @@ -582,7 +582,7 @@ TC-Pairs produces output in TCST format. The default output file name can be ove - INDEX - Index of the current track pair * - 16 - - SOURCE + - DIAG_SOURCE - Diagnostics data source * - 17 - N_DIAG diff --git a/internal/test_unit/hdr/met_11_0.hdr b/internal/test_unit/hdr/met_11_0.hdr index c70e192768..573457d898 100644 --- a/internal/test_unit/hdr/met_11_0.hdr +++ b/internal/test_unit/hdr/met_11_0.hdr @@ -34,5 +34,5 @@ MODE_SOA : VERSION MODEL DESC FCST_LEAD FCST_VALID_BEG FCST_VALID_END OBS_L MODE_POA : VERSION MODEL DESC FCST_LEAD FCST_VALID_BEG FCST_VALID_END OBS_LEAD OBS_VALID_BEG OBS_VALID_END FCST_VAR FCST_UNITS FCST_LEV OBS_VAR OBS_UNITS OBS_LEV OBTYPE VX_MASK INTERP_MTHD INTERP_PNTS FCST_THRESH OBS_THRESH COV_THRESH ALPHA LINE_TYPE N_VALID GRID_RES OBJECT_ID OBJECT_CAT CENTROID_DIST BOUNDARY_DIST CONVEX_HULL_DIST ANGLE_DIFF ASPECT_DIFF AREA_RATIO INTERSECTION_AREA UNION_AREA SYMMETRIC_DIFF INTERSECTION_OVER_AREA CURVATURE_RATIO COMPLEXITY_RATIO PERCENTILE_INTENSITY_RATIO INTEREST MODE_CTS : VERSION MODEL DESC FCST_LEAD FCST_VALID_BEG FCST_VALID_END OBS_LEAD OBS_VALID_BEG OBS_VALID_END FCST_VAR FCST_UNITS FCST_LEV OBS_VAR OBS_UNITS OBS_LEV OBTYPE VX_MASK INTERP_MTHD INTERP_PNTS FCST_THRESH OBS_THRESH COV_THRESH ALPHA LINE_TYPE N_VALID GRID_RES FIELD TOTAL FY_OY FY_ON FN_OY FN_ON BASER FMEAN ACC FBIAS PODY PODN POFD FAR CSI GSS HK HSS ODDS TCST_TCMPR : VERSION MODEL DESC FCST_LEAD FCST_VALID_BEG FCST_VALID_END OBS_LEAD OBS_VALID_BEG OBS_VALID_END FCST_VAR FCST_UNITS FCST_LEV OBS_VAR OBS_UNITS OBS_LEV OBTYPE VX_MASK INTERP_MTHD INTERP_PNTS FCST_THRESH OBS_THRESH COV_THRESH ALPHA LINE_TYPE AMODEL BMODEL STORM_ID BASIN CYCLONE STORM_NAME INIT_MASK VALID_MASK TOTAL INDEX LEVEL WATCH_WARN INITIALS ALAT ALON BLAT BLON TK_ERR X_ERR Y_ERR ALTK_ERR CRTK_ERR ADLAND BDLAND AMSLP BMSLP AMAX_WIND BMAX_WIND AAL_WIND_34 BAL_WIND_34 ANE_WIND_34 BNE_WIND_34 ASE_WIND_34 BSE_WIND_34 ASW_WIND_34 BSW_WIND_34 ANW_WIND_34 BNW_WIND_34 AAL_WIND_50 BAL_WIND_50 ANE_WIND_50 BNE_WIND_50 ASE_WIND_50 BSE_WIND_50 ASW_WIND_50 BSW_WIND_50 ANW_WIND_50 BNW_WIND_50 AAL_WIND_64 BAL_WIND_64 ANE_WIND_64 BNE_WIND_64 ASE_WIND_64 BSE_WIND_64 ASW_WIND_64 BSW_WIND_64 ANW_WIND_64 BNW_WIND_64 ARADP BRADP ARRP BRRP AMRD BMRD AGUSTS BGUSTS AEYE BEYE ADIR BDIR ASPEED BSPEED ADEPTH BDEPTH NUM_MEMBERS TRACK_SPREAD DIST_MEAN MSLP_SPREAD MAX_WIND_SPREAD -TCST_TCDIAG : VERSION MODEL DESC FCST_LEAD FCST_VALID_BEG FCST_VALID_END OBS_LEAD OBS_VALID_BEG OBS_VALID_END FCST_VAR FCST_UNITS FCST_LEV OBS_VAR OBS_UNITS OBS_LEV OBTYPE VX_MASK INTERP_MTHD INTERP_PNTS FCST_THRESH OBS_THRESH COV_THRESH ALPHA LINE_TYPE AMODEL BMODEL STORM_ID BASIN CYCLONE STORM_NAME INIT_MASK VALID_MASK TOTAL INDEX SOURCE N_DIAG _VAR_ +TCST_TCDIAG : VERSION MODEL DESC FCST_LEAD FCST_VALID_BEG FCST_VALID_END OBS_LEAD OBS_VALID_BEG OBS_VALID_END FCST_VAR FCST_UNITS FCST_LEV OBS_VAR OBS_UNITS OBS_LEV OBTYPE VX_MASK INTERP_MTHD INTERP_PNTS FCST_THRESH OBS_THRESH COV_THRESH ALPHA LINE_TYPE AMODEL BMODEL STORM_ID BASIN CYCLONE STORM_NAME INIT_MASK VALID_MASK TOTAL INDEX DIAG_SOURCE N_DIAG _VAR_ TCST_PROBRIRW : VERSION MODEL DESC FCST_LEAD FCST_VALID_BEG FCST_VALID_END OBS_LEAD OBS_VALID_BEG OBS_VALID_END FCST_VAR FCST_UNITS FCST_LEV OBS_VAR OBS_UNITS OBS_LEV OBTYPE VX_MASK INTERP_MTHD INTERP_PNTS FCST_THRESH OBS_THRESH COV_THRESH ALPHA LINE_TYPE ALAT ALON BLAT BLON INITIALS TK_ERR X_ERR Y_ERR ADLAND BDLAND RI_BEG RI_END RI_WINDOW AWIND_END BWIND_BEG BWIND_END BDELTA BDELTA_MAX BLEVEL_BEG BLEVEL_END N_THRESH _VAR_ diff --git a/internal/test_unit/perl/tcst_conv.pl b/internal/test_unit/perl/tcst_conv.pl index f8f504c47c..d653e9cb4b 100755 --- a/internal/test_unit/perl/tcst_conv.pl +++ b/internal/test_unit/perl/tcst_conv.pl @@ -33,7 +33,7 @@ () NUM_MEMBERS TRACK_SPREAD DIST_MEAN MSLP_SPREAD MAX_WIND_SPREAD); my @fld_tcdiag = qw(AMODEL BMODEL DESC STORM_ID BASIN CYCLONE STORM_NAME INIT_MASK VALID_MASK - TOTAL INDEX LEVEL SOURCE N_DIAG DIAG_ VALUE_); + TOTAL INDEX LEVEL DIAG_SOURCE N_DIAG DIAG_ VALUE_); my @fld_probrirw = qw(AMODEL BMODEL DESC STORM_ID BASIN CYCLONE STORM_NAME INIT_MASK VALID_MASK ALAT ALON BLAT BLON INITIALS TK_ERR X_ERR Y_ERR ADLAND BDLAND RI_BEG RI_END RI_WINDOW @@ -158,7 +158,7 @@ () "%15s" . # VALID_MASK "%15s" . # TOTAL "%15s" . # INDEX - "%15s" . # SOURCE + "%15s" . # DIAG_SOURCE "%15s"; # N_DIAG my $fmt_probrirw = @@ -360,7 +360,7 @@ () # TCDIAG Line Type # 14 - TOTAL # 15 - INDEX -# 16 - SOURCE +# 16 - DIAG_SOURCE # 17 - N_DIAG # 18 - DIAG_i # 19 - VALUE_i diff --git a/src/libcode/vx_tc_util/tc_columns.h b/src/libcode/vx_tc_util/tc_columns.h index 7bd6c58814..6910590efc 100644 --- a/src/libcode/vx_tc_util/tc_columns.h +++ b/src/libcode/vx_tc_util/tc_columns.h @@ -122,7 +122,7 @@ static const int n_tc_cols_xy = sizeof(tc_cols_xy)/sizeof(*tc_cols_xy); //////////////////////////////////////////////////////////////////////// static const char * tc_diag_cols [] = { - "TOTAL", "INDEX", "SOURCE", + "TOTAL", "INDEX", "DIAG_SOURCE", "N_DIAG", "DIAG_", "VALUE_" }; diff --git a/src/libcode/vx_tc_util/track_pair_info.cc b/src/libcode/vx_tc_util/track_pair_info.cc index 4a69d2d0db..9fc9cc0d18 100644 --- a/src/libcode/vx_tc_util/track_pair_info.cc +++ b/src/libcode/vx_tc_util/track_pair_info.cc @@ -472,7 +472,7 @@ void TrackPairInfo::add_tcdiag_line(const TCStatLine &l) { StringArray diag_name; // Diagnostic source type - DiagType t = string_to_diagtype(l.get_item("SOURCE")); + DiagType t = string_to_diagtype(l.get_item("DIAG_SOURCE")); // Make sure the source type does not change if(ADeck.diag_source() != DiagType_None && From d7e3b7cd6826cfc3ef1f850176f1865fa994547e Mon Sep 17 00:00:00 2001 From: John Halley Gotway Date: Wed, 9 Nov 2022 15:40:53 -0700 Subject: [PATCH 2/3] Per #2337, remove duplicate descriptions of TMP_DIR and MESSAGE_TYPE_GROUP_MAP. Only 1 is needed. --- docs/Users_Guide/config_options.rst | 43 ++++++----------------------- 1 file changed, 8 insertions(+), 35 deletions(-) diff --git a/docs/Users_Guide/config_options.rst b/docs/Users_Guide/config_options.rst index d7e5075f4e..b01f079c64 100644 --- a/docs/Users_Guide/config_options.rst +++ b/docs/Users_Guide/config_options.rst @@ -493,8 +493,8 @@ override the default value set in ConfigConstants. output_precision = 5; -tmp_dir_1 -^^^^^^^^^ +tmp_dir +^^^^^^^ The "tmp_dir" entry in ConfigConstants defines the directory for the temporary files. The directory must exist and be writable. The environment @@ -506,8 +506,8 @@ Some tools override the temporary directory by the command line argument tmp_dir = "/tmp"; -message_type_group_map_1 -^^^^^^^^^^^^^^^^^^^^^^^^ +message_type_group_map +^^^^^^^^^^^^^^^^^^^^^^ The "message_type_group_map" entry is an array of dictionaries, each containing a "key" string and "val" string. This defines a mapping of @@ -2230,17 +2230,6 @@ forecast field: The "obs_raw_plot", "wvlt_plot", and "object_plot" entries are dictionaries similar to the "fcst_raw_plot" described above. -tmp_dir_2 -^^^^^^^^^ - -The "tmp_dir" entry is a string specifying the location where temporary -files should be written. - -.. code-block:: none - - tmp_dir = "/tmp"; - - output_prefix ^^^^^^^^^^^^^ @@ -2445,8 +2434,8 @@ combination of the categorical threshold (cat_thresh), neighborhood width ]; } -fcst, obs_1 -""""""""""" +fcst, obs +""""""""" The fcst and obs entries define the fields for which Ensemble-Stat should compute rank histograms, probability integral transform histograms, @@ -3009,8 +2998,8 @@ MODE will be run. quilt = false; -fcst, obs_2 -""""""""""" +fcst, obs +""""""""" The object definition settings for MODE are contained within the "fcst" and "obs" entries: @@ -3375,22 +3364,6 @@ For example: message_type = []; -message_type_group_map_2 -"""""""""""""""""""""""" - -Mapping of message type group name to comma-separated list of values. -The default setting defines ANYAIR, ANYSFC, and ONLYSF as groups. -Derive PRMSL only for SURFACE message types. - -.. code-block:: none - - message_type_group_map = [ - { key = "SURFACE"; val = "ADPSFC,SFCSHP,MSONET"; }, - { key = "ANYAIR"; val = "AIRCAR,AIRCFT"; }, - { key = "ANYSFC"; val = "ADPSFC,SFCSHP,ADPUPA,PROFLR,MSONET"; }, - { key = "ONLYSF"; val = "ADPSFC,SFCSHP"; } - ]; - station_id """""""""" From 116bb8508ef067d1ba85ad475837c70957539821 Mon Sep 17 00:00:00 2001 From: John Halley Gotway Date: Wed, 9 Nov 2022 15:47:53 -0700 Subject: [PATCH 3/3] Per #2337, fix up docs about config options. --- docs/Users_Guide/config_options_tc.rst | 206 ++++++++++--------------- docs/Users_Guide/tc-pairs.rst | 4 +- 2 files changed, 87 insertions(+), 123 deletions(-) diff --git a/docs/Users_Guide/config_options_tc.rst b/docs/Users_Guide/config_options_tc.rst index 17b1c266c4..1d6d098ad8 100644 --- a/docs/Users_Guide/config_options_tc.rst +++ b/docs/Users_Guide/config_options_tc.rst @@ -9,8 +9,8 @@ See :numref:`config_options` for a description of the configuration file syntax. Configuration settings common to multiple tools =============================================== -storm_id_1 ----------- +storm_id +-------- Specify a comma-separated list of storm id's to be used: @@ -64,8 +64,8 @@ For example: cyclone = []; -storm_name_1 ------------- +storm_name +---------- Specify a comma-separated list of storm names to be used. An empty list indicates that all should be used. @@ -105,8 +105,8 @@ For example: init_inc = []; init_exc = []; -valid_beg end inc exc_1 ------------------------ +valid_beg end inc exc +--------------------- Specify a model valid time window YYYYMMDD[_HH[MMSS]] format or provide a list of specific valid times to include (inc) or exclude (exc). If a time @@ -133,8 +133,8 @@ For example: valid_inc = []; valid_exc = []; -init_hour_1 ------------ +init_hour +--------- Specify a comma-separated list of model initialization hours to be used in HH[MMSS] format. An empty list indicates that all hours should be used. @@ -162,23 +162,6 @@ all lead times will be used. lead_req = []; -init_mask, valid_mask ---------------------- - -Specify lat/lon polylines defining masking regions to be applied. -Tracks whose initial location falls within init_mask will be used. -Tracks for which all locations fall within valid_mask will be used. - -For example: - -| init_mask = "MET_BASE/poly/EAST.poly"; -| - -.. code-block:: none - - init_mask = ""; - valid_mask = ""; - version ------- @@ -197,8 +180,8 @@ Settings specific to individual tools TCPairsConfig_default --------------------- -model_1 -^^^^^^^ +model +^^^^^ The "model" entry specifies an array of model names to be verified. If verifying multiple models, choose descriptive model names (no whitespace) @@ -213,6 +196,23 @@ For example: model = []; +init_mask, valid_mask +^^^^^^^^^^^^^^^^^^^^^ + +Specify lat/lon polylines defining masking regions to be applied. +Tracks whose initial location falls within init_mask will be used. +Tracks for which all locations fall within valid_mask will be used. + +For example: + +| init_mask = "MET_BASE/poly/EAST.poly"; +| + +.. code-block:: none + + init_mask = ""; + valid_mask = ""; + check_dup ^^^^^^^^^ @@ -423,10 +423,10 @@ parameter will result in missed matches. ]; TCStatConfig_default -==================== +-------------------- amodel, bmodel --------------- +^^^^^^^^^^^^^^ Stratify by the AMODEL or BMODEL columns. Specify comma-separated lists of model names to be used for all analyses @@ -444,32 +444,8 @@ For example: amodel = []; bmodel = []; -valid_beg end inc exc ---------------------- - -Stratify by the VALID times. -Define beginning and ending time windows in YYYYMMDD[_HH[MMSS]] -or provide a list of specific valid times to include or exclude. -May modify using the "-valid_beg", "-valid_end", "-valid_inc", -and "-valid_exc" job command options. - -For example: - -| valid_beg = "20100101"; -| valid_end = "20101231_12"; -| valid_inc = [ "20101231_06" ]; -| valid_exc = [ "20101231_00" ]; -| - -.. code-block:: none - - valid_beg = ""; - valid_end = ""; - valid_inc = []; - valid_exc = []; - init valid_hour lead req ------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^ Stratify by the initialization and valid hours and lead time. Specify a comma-separated list of initialization hours, @@ -492,9 +468,26 @@ For example: lead = []; lead_req = []; +init_mask, valid_mask +^^^^^^^^^^^^^^^^^^^^^ + +Stratify by the contents of the INIT_MASK and VALID_MASK columns. +Specify a comma-separated list of strings for these options. +May add using the "-init_mask" and "-valid_mask" job command +options. + +For example: + +| init_mask = [ "AL_BASIN", "EP_BASIN" ]; +| + +.. code-block:: none + + init_mask = []; + valid_mask = []; line_type ---------- +^^^^^^^^^ Stratify by the LINE_TYPE column. May add using the "-line_type" job command option. @@ -509,7 +502,7 @@ For example: line_type = []; track_watch_warn ----------------- +^^^^^^^^^^^^^^^^ Stratify by checking the watch/warning status for each track point common to both the ADECK and BDECK tracks. If the watch/warning status @@ -530,7 +523,7 @@ For example: column_thresh_name_and_val --------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^ Stratify by applying thresholds to numeric data columns. Specify a comma-separated list of columns names and thresholds @@ -549,7 +542,7 @@ For example: column_thresh_val = []; column_str_name, column_str_val -------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Stratify by performing string matching on non-numeric data columns. Specify a comma-separated list of columns names and values @@ -568,7 +561,7 @@ For example: column_str_val = []; column_str_name val -------------------- +^^^^^^^^^^^^^^^^^^^ Stratify by performing string matching on non-numeric data columns. Specify a comma-separated list of columns names and values @@ -587,7 +580,7 @@ For example: column_str_exc_val = []; init_thresh_name, init_thresh_val ---------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Just like the column_thresh options above, but apply the threshold only when lead = 0. If lead = 0 value does not meet the threshold, discard @@ -606,7 +599,7 @@ For example: init_thresh_val = []; init_str_name, init_str_val ---------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^ Just like the column_str options above, but apply the string matching only when lead = 0. If lead = 0 string does not match, discard the entire track. @@ -624,7 +617,7 @@ For example: init_str_val = []; init_str_exc_name and _exc_val ------------------------------- +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Just like the column_str_exc options above, but apply the string matching only when lead = 0. If lead = 0 string does match, discard the entire track. @@ -642,7 +635,7 @@ For example: init_str_exc_val = []; water_only ----------- +^^^^^^^^^^ Stratify by the ADECK and BDECK distances to land. Once either the ADECK or BDECK track encounters land, discard the remainder of the track. @@ -657,7 +650,7 @@ For example: water_only = FALSE; rirw ----- +^^^^ Specify whether only those track points for which rapid intensification or weakening of the maximum wind speed occurred in the previous time @@ -690,7 +683,7 @@ May modify using the following job command options: } landfall beg end ----------------- +^^^^^^^^^^^^^^^^ Specify whether only those track points occurring near landfall should be retained, and define the landfall retention window as a time string in HH[MMSS] @@ -722,7 +715,7 @@ For example: landfall_end = "00"; event_equal ------------ +^^^^^^^^^^^ Specify whether only those cases common to all models in the dataset should be retained. May modify using the "-event_equal" job command option. @@ -738,7 +731,7 @@ For example: event_equal_lead ----------------- +^^^^^^^^^^^^^^^^ Specify lead times that must be present for a track to be included in the event equalization logic. @@ -749,7 +742,7 @@ event equalization logic. out_int_mask ------------- +^^^^^^^^^^^^ Apply polyline masking logic to the location of the ADECK track at the initialization time. If it falls outside the mask, discard the entire track. @@ -766,7 +759,7 @@ For example: out_valid_mask --------------- +^^^^^^^^^^^^^^ Apply polyline masking logic to the location of the ADECK track at the valid time. If it falls outside the mask, discard only the current track @@ -782,7 +775,7 @@ For example: out_valid_mask = ""; job ---- +^^^ The "jobs" entry is an array of TCStat jobs to be performed. Each element in the array contains the specifications for a single analysis @@ -967,10 +960,10 @@ Where "job_name" is set to one of the following: jobs = []; TCGenConfig_default -=================== +------------------- -int_freq --------- +init_freq +^^^^^^^^^ Model initialization frequency in hours, starting at 0. @@ -979,7 +972,7 @@ Model initialization frequency in hours, starting at 0. init_freq = 6; lead_window ------------ +^^^^^^^^^^^ Lead times in hours to be searched for genesis events. @@ -992,7 +985,7 @@ Lead times in hours to be searched for genesis events. } min_duration ------------- +^^^^^^^^^^^^ Minimum track duration for genesis event in hours. @@ -1001,7 +994,7 @@ Minimum track duration for genesis event in hours. min_duration = 12; fcst_genesis ------------- +^^^^^^^^^^^^ Forecast genesis event criteria. Defined as tracks reaching the specified intensity category, maximum wind speed threshold, and minimum sea-level @@ -1017,7 +1010,7 @@ track point where all of these criteria are met. } best_genesis ------------- +^^^^^^^^^^^^ BEST track genesis event criteria. Defined as tracks reaching the specified intensity category, maximum wind speed threshold, and minimum sea-level @@ -1034,7 +1027,7 @@ first track point where all of these criteria are met. } oper_genesis ------------- +^^^^^^^^^^^^ Operational track genesis event criteria. Defined as tracks reaching the specified intensity category, maximum wind speed threshold, and minimum @@ -1050,9 +1043,6 @@ time of the first track point where all of these criteria are met. mslp_thresh = NA; } -Track filtering options which may be specified separately in each filter array entry ------------------------------------------------------------------------------------- - filter ^^^^^^ @@ -1073,38 +1063,19 @@ Description written to output DESC column desc = "NA"; -model_2 -^^^^^^^ +model +^^^^^ Forecast ATCF ID's If empty, all ATCF ID's found will be processed. Statistics will be generated separately for each ATCF ID. - .. code-block:: none model = []; -storm_id_2 -^^^^^^^^^^ - -BEST and operational track storm identifiers - -.. code-block:: none - - storm_id = []; - -storm_name_2 -^^^^^^^^^^^^ - -BEST and operational track storm names - -.. code-block:: none - - storm_name = []; - -init_beg, init_end2 -^^^^^^^^^^^^^^^^^^^ +init_beg, init_end +^^^^^^^^^^^^^^^^^^ Forecast and operational initialization time window @@ -1113,8 +1084,8 @@ Forecast and operational initialization time window init_beg = ""; init_end = ""; -valid_beg, valid_end_2 -^^^^^^^^^^^^^^^^^^^^^^ +valid_beg, valid_end +^^^^^^^^^^^^^^^^^^^^ Forecast, BEST, and operational valid time window @@ -1123,15 +1094,6 @@ Forecast, BEST, and operational valid time window valid_beg = ""; valid_end = ""; -init_hour_2 -^^^^^^^^^^^ - -Forecast and operational initialization hours - -.. code-block:: none - - init_hour = []; - lead ^^^^ @@ -1180,11 +1142,8 @@ Genesis matching search radius in km. genesis_radius = 300; -Global settings -=============== - ci_alpha --------- +^^^^^^^^ Confidence interval alpha value @@ -1193,14 +1152,19 @@ Confidence interval alpha value ci_alpha = 0.05; output_flag ------------ +^^^^^^^^^^^ Statistical output types .. code-block:: none - + output_flag = { fho = NONE; ctc = BOTH; cts = BOTH; + pct = NONE; + pstd = NONE; + pjc = NONE; + prc = NONE; + genmpr = NONE; } diff --git a/docs/Users_Guide/tc-pairs.rst b/docs/Users_Guide/tc-pairs.rst index 85bf8c5ee4..02e1c2cb2d 100644 --- a/docs/Users_Guide/tc-pairs.rst +++ b/docs/Users_Guide/tc-pairs.rst @@ -122,9 +122,9 @@ ____________________ valid_inc = []; valid_exc = []; init_hour = []; - init_mask = []; + init_mask = ""; + valid_mask = ""; lead_req = []; - valid_mask = []; match_points = TRUE; version = "VN.N";