Note
Go to the end to download the full example code.
MODE/Grid-Stat: Brightness Temperature Verification and Distance Maps
model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTempObjs.conf
Scientific Objective
To provide statistical inforation on regions of low brightness temperatures, defined by creating objects, in the FV3 ensemble members compared to GOES satellite. In addition, distance map information is computed for both the model and observation using object based brightness temperatures
Version Added
METplus version 4.0
Datasets
Forecast: FV3 Model member data
Observation: GOES Brightness Temperature
Climatology: None
Location: All of the input data required for this use case can be found in a sample data tarball. Each use case category will have one or more sample data tarballs. It is only necessary to download the tarball with the use case’s dataset and not the entire collection of sample data. Click here to access the METplus releases page and download sample data for the appropriate release: https://github.com/dtcenter/METplus/releases This tarball should be unpacked into the directory that you will set the value of INPUT_BASE. See Running METplus section for more information.
METplus Components
This use case runs MODE to create object statistics on brightness temperatures below 235 K. Then it runs grid_stat to compute neighborhood contingency table counts and distance maps for the forecast and observations.
METplus Workflow
Beginning time (INIT_BEG): 2019052100
End time (INIT_END): 2019052100
Increment between beginning and end times (INIT_INCREMENT): 3600
Sequence of forecast leads to process (LEAD_SEQ): 1,2
The MODE and grid_stat tools are run for each of 2 ensemble members and for each time. This example loops by initialization time. It processes 2 lead times, listed below.
METplus Configuration
METplus first loads all of the configuration files found in parm/metplus_config, then it loads any configuration files passed to METplus via the command line, i.e. parm/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTempObjs.conf
[config]
# Documentation for this use case can be found at
# https://metplus.readthedocs.io/en/latest/generated/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTempObjs.html
# For additional information, please see the METplus Users Guide.
# https://metplus.readthedocs.io/en/latest/Users_Guide
###
# Processes to run
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#process-list
###
PROCESS_LIST = MODE(lsm1), MODE(mp1), GridStat(lsm1), GridStat(mp1)
###
# Time Info
# LOOP_BY options are INIT, VALID, RETRO, and REALTIME
# If set to INIT or RETRO:
# INIT_TIME_FMT, INIT_BEG, INIT_END, and INIT_INCREMENT must also be set
# If set to VALID or REALTIME:
# VALID_TIME_FMT, VALID_BEG, VALID_END, and VALID_INCREMENT must also be set
# LEAD_SEQ is the list of forecast leads to process
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#timing-control
###
LOOP_BY = init
INIT_TIME_FMT = %Y%m%d%H
INIT_BEG = 2019052100
INIT_END = 2019052100
INIT_INCREMENT = 3600
LEAD_SEQ = 1,2
###
# File I/O
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#directory-and-filename-template-info
###
# MODE
FCST_MODE_INPUT_DIR = {INPUT_BASE}/model_applications/short_range/brightness_temperature
FCST_MODE_INPUT_TEMPLATE = {init?fmt=%Y%m%d%H}/core_{instance}/core_{instance}_{init?fmt=%Y%m%d}_{init?fmt=%H%M}_f{lead?fmt=%HH}.nc
OBS_MODE_INPUT_DIR = {INPUT_BASE}/model_applications/short_range/brightness_temperature
OBS_MODE_INPUT_TEMPLATE = {valid?fmt=%Y_%m_%d}_141/remap_GOES-16.{valid?fmt=%Y%m%d}.{valid?fmt=%H%M%S}.nc
MODE_OUTPUT_DIR = {OUTPUT_BASE}/short_range/brightness_temperature/mode
# GridStat
FCST_GRID_STAT_INPUT_DIR = {MODE_OUTPUT_DIR}
FCST_GRID_STAT_INPUT_TEMPLATE = mode_{MODE_OUTPUT_PREFIX}_{lead?fmt=%HH}0000L_{valid?fmt=%Y%m%d}_{valid?fmt=%H%M%S}V_000000A_obj.nc
OBS_GRID_STAT_INPUT_DIR = {FCST_GRID_STAT_INPUT_DIR}
OBS_GRID_STAT_INPUT_TEMPLATE = {FCST_GRID_STAT_INPUT_TEMPLATE}
GRID_STAT_OUTPUT_DIR = {OUTPUT_BASE}/short_range/brightness_temperature/grid_stat_obj
###
# Field Info
# https://metplus.readthedocs.io/en/latest/Users_Guide/systemconfiguration.html#field-info
###
MODEL = FV3_core
OBTYPE = GOES
FCST_MODE_VAR1_NAME = SBTA1613_topofatmosphere
FCST_MODE_VAR1_LEVELS = "(*,*)"
FCST_MODE_VAR1_OPTIONS = file_type = NETCDF_MET;
MODE_FCST_CENSOR_THRESH = <=0
MODE_FCST_CENSOR_VAL = 9999
OBS_MODE_VAR1_NAME = channel_13_brightness_temperature
OBS_MODE_VAR1_LEVELS = "(*,*)"
OBS_MODE_VAR1_OPTIONS = file_type = NETCDF_MET;
MODE_OBS_CENSOR_THRESH = <=0
MODE_OBS_CENSOR_VAL = 9999
FCST_GRID_STAT_VAR1_NAME = fcst_obj_raw
FCST_GRID_STAT_VAR1_LEVELS = "(*,*)"
FCST_GRID_STAT_VAR1_THRESH = lt999
FCST_GRID_STAT_VAR1_OPTIONS = file_type = NETCDF_MET; censor_thresh = eq-9999; censor_val = 999;
OBS_GRID_STAT_VAR1_NAME = obs_obj_raw
OBS_GRID_STAT_VAR1_LEVELS = "(*,*)"
OBS_GRID_STAT_VAR1_THRESH = lt999
OBS_GRID_STAT_VAR1_OPTIONS = file_type = NETCDF_MET; censor_thresh = eq-9999; censor_val = 999;
###
# MODE Settings
# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#mode
###
MODE_QUILT = FALSE
MODE_CONV_RADIUS = 5
MODE_CONV_THRESH = <=235
MODE_MERGE_THRESH = <=235
MODE_MERGE_FLAG = NONE
MODE_MASK_POLY = {INPUT_BASE}/model_applications/short_range/brightness_temperature/CentUS.nc
MODE_GRID_RES = 3
MODE_MAX_CENTROID_DIST = 600.0/grid_res
MODE_INTEREST_FUNCTION_CENTROID_DIST = ( ( 0.0, 1.0 ) ( 60.0/grid_res, 1.0 ) ( 450.0/grid_res, 0.0 ) )
MODE_MASK_MISSING_FLAG = BOTH
MODE_MASK_POLY_FLAG = BOTH
MODE_WEIGHT_CENTROID_DIST = 4.0
MODE_WEIGHT_BOUNDARY_DIST = 3.0
MODE_WEIGHT_CONVEX_HULL_DIST = 1.0
MODE_WEIGHT_AREA_RATIO = 4.0
MODE_WEIGHT_INT_AREA_RATIO = 3.0
MODE_TOTAL_INTEREST_THRESH = 0.65
MODE_NC_PAIRS_FLAG_POLYLINES = False
MODE_REGRID_TO_GRID = NONE
MODE_OUTPUT_PREFIX = FV3_core_{instance}
###
# GridStat Settings
# https://metplus.readthedocs.io/en/latest/Users_Guide/wrappers.html#gridstat
###
GRID_STAT_NEIGHBORHOOD_WIDTH = 1
GRID_STAT_NEIGHBORHOOD_SHAPE = SQUARE
GRID_STAT_OUTPUT_FLAG_NBRCTC = BOTH
GRID_STAT_OUTPUT_FLAG_DMAP = BOTH
GRID_STAT_NC_PAIRS_FLAG_DISTANCE_MAP = TRUE
GRID_STAT_OUTPUT_PREFIX = FV3_core_{instance}
MET Configuration
METplus sets environment variables based on user settings in the METplus configuration file. See How METplus controls MET config file settings for more details.
YOU SHOULD NOT SET ANY OF THESE ENVIRONMENT VARIABLES YOURSELF! THEY WILL BE OVERWRITTEN BY METPLUS WHEN IT CALLS THE MET TOOLS!
If there is a setting in the MET configuration file that is currently not supported by METplus you’d like to control, please refer to: Overriding Unsupported MET config file settings
MODEConfig_wrapped
////////////////////////////////////////////////////////////////////////////////
//
// MODE configuration file.
//
// For additional information, see the MET_BASE/config/README file.
//
////////////////////////////////////////////////////////////////////////////////
//
// Output model name to be written
//
// model =
${METPLUS_MODEL}
//
// Output description to be written
//
// desc =
${METPLUS_DESC}
//
// Output observation type to be written
//
// obtype =
${METPLUS_OBTYPE}
////////////////////////////////////////////////////////////////////////////////
//
// Verification grid
//
// regrid = {
${METPLUS_REGRID_DICT}
////////////////////////////////////////////////////////////////////////////////
//
// Approximate grid resolution (km)
//
// grid_res =
${METPLUS_GRID_RES}
////////////////////////////////////////////////////////////////////////////////
//
// Run all permutations of radius and threshold
//
// quilt =
${METPLUS_QUILT}
//
// MODE Multivar boolean combination logic
//
//multivar_logic =
${METPLUS_MULTIVAR_LOGIC}
//multivar_intensity_compare_fcst =
${METPLUS_MULTIVAR_INTENSITY_COMPARE_FCST}
//multivar_intensity_compare_obs =
${METPLUS_MULTIVAR_INTENSITY_COMPARE_OBS}
//
// Forecast and observation fields to be verified
//
fcst = {
//field = {
${METPLUS_FCST_FIELD}
//censor_thresh = [
${METPLUS_FCST_CENSOR_THRESH}
//censor_val = [
${METPLUS_FCST_CENSOR_VAL}
//conv_radius =
${METPLUS_FCST_CONV_RADIUS}
//conv_thresh =
${METPLUS_FCST_CONV_THRESH}
//vld_thresh =
${METPLUS_FCST_VLD_THRESH}
//filter_attr_name = [
${METPLUS_FCST_FILTER_ATTR_NAME}
//filter_attr_thresh = [
${METPLUS_FCST_FILTER_ATTR_THRESH}
//merge_thresh =
${METPLUS_FCST_MERGE_THRESH}
//merge_flag =
${METPLUS_FCST_MERGE_FLAG}
${METPLUS_FCST_FILE_TYPE}
${METPLUS_FCST_MULTIVAR_NAME}
${METPLUS_FCST_MULTIVAR_LEVEL}
}
obs = {
//field = {
${METPLUS_OBS_FIELD}
//censor_thresh = [
${METPLUS_OBS_CENSOR_THRESH}
//censor_val = [
${METPLUS_OBS_CENSOR_VAL}
//conv_radius =
${METPLUS_OBS_CONV_RADIUS}
//conv_thresh =
${METPLUS_OBS_CONV_THRESH}
//vld_thresh =
${METPLUS_OBS_VLD_THRESH}
//filter_attr_name = [
${METPLUS_OBS_FILTER_ATTR_NAME}
//filter_attr_thresh = [
${METPLUS_OBS_FILTER_ATTR_THRESH}
//merge_thresh =
${METPLUS_OBS_MERGE_THRESH}
//merge_flag =
${METPLUS_OBS_MERGE_FLAG}
${METPLUS_OBS_FILE_TYPE}
${METPLUS_OBS_MULTIVAR_NAME}
${METPLUS_OBS_MULTIVAR_LEVEL}
}
////////////////////////////////////////////////////////////////////////////////
//
// Handle missing data
//
// mask_missing_flag =
${METPLUS_MASK_MISSING_FLAG}
//
// Match objects between the forecast and observation fields
//
//match_flag =
${METPLUS_MATCH_FLAG}
//
// Maximum centroid distance for objects to be compared
//
//max_centroid_dist =
${METPLUS_MAX_CENTROID_DIST}
////////////////////////////////////////////////////////////////////////////////
//
// Verification masking regions
//
//mask = {
${METPLUS_MASK_DICT}
////////////////////////////////////////////////////////////////////////////////
//
// Fuzzy engine weights
//
//weight = {
${METPLUS_WEIGHT_DICT}
////////////////////////////////////////////////////////////////////////////////
//
// Fuzzy engine interest functions
//
interest_function = {
//centroid_dist = (
${METPLUS_INTEREST_FUNCTION_CENTROID_DIST}
//boundary_dist = (
${METPLUS_INTEREST_FUNCTION_BOUNDARY_DIST}
//convex_hull_dist = (
${METPLUS_INTEREST_FUNCTION_CONVEX_HULL_DIST}
angle_diff = (
( 0.0, 1.0 )
( 30.0, 1.0 )
( 90.0, 0.0 )
);
aspect_diff = (
( 0.00, 1.0 )
( 0.10, 1.0 )
( 0.75, 0.0 )
);
corner = 0.8;
ratio_if = (
( 0.0, 0.0 )
( corner, 1.0 )
( 1.0, 1.0 )
);
area_ratio = ratio_if;
int_area_ratio = (
( 0.00, 0.00 )
( 0.10, 0.50 )
( 0.25, 1.00 )
( 1.00, 1.00 )
);
curvature_ratio = ratio_if;
complexity_ratio = ratio_if;
inten_perc_ratio = ratio_if;
}
////////////////////////////////////////////////////////////////////////////////
//
// Total interest threshold for determining matches
//
//total_interest_thresh =
${METPLUS_TOTAL_INTEREST_THRESH}
//
// Interest threshold for printing output pair information
//
print_interest_thresh = 0.0;
////////////////////////////////////////////////////////////////////////////////
//
// Plotting information
//
met_data_dir = "MET_BASE";
fcst_raw_plot = {
color_table = "MET_BASE/colortables/met_default.ctable";
plot_min = 0.0;
plot_max = 0.0;
}
obs_raw_plot = {
color_table = "MET_BASE/colortables/met_default.ctable";
plot_min = 0.0;
plot_max = 0.0;
}
object_plot = {
color_table = "MET_BASE/colortables/mode_obj.ctable";
}
//
// Boolean for plotting on the region of valid data within the domain
//
plot_valid_flag = FALSE;
//
// Plot polyline edges using great circle arcs instead of straight lines
//
plot_gcarc_flag = FALSE;
////////////////////////////////////////////////////////////////////////////////
//
// NetCDF matched pairs, PostScript, and contingency table output files
//
//ps_plot_flag =
${METPLUS_PS_PLOT_FLAG}
//nc_pairs_flag = {
${METPLUS_NC_PAIRS_FLAG_DICT}
//ct_stats_flag =
${METPLUS_CT_STATS_FLAG}
////////////////////////////////////////////////////////////////////////////////
shift_right = 0; // grid squares
////////////////////////////////////////////////////////////////////////////////
${METPLUS_OUTPUT_PREFIX}
//version = "V10.0";
tmp_dir = "${MET_TMP_DIR}";
////////////////////////////////////////////////////////////////////////////////
${METPLUS_TIME_OFFSET_WARNING}
${METPLUS_MET_CONFIG_OVERRIDES}
GridStatConfig_wrapped
////////////////////////////////////////////////////////////////////////////////
//
// Grid-Stat configuration file.
//
// For additional information, see the MET_BASE/config/README file.
//
////////////////////////////////////////////////////////////////////////////////
//
// Output model name to be written
//
// model =
${METPLUS_MODEL}
//
// Output description to be written
// May be set separately in each "obs.field" entry
//
// desc =
${METPLUS_DESC}
//
// Output observation type to be written
//
// obtype =
${METPLUS_OBTYPE}
////////////////////////////////////////////////////////////////////////////////
//
// Verification grid
//
// regrid = {
${METPLUS_REGRID_DICT}
////////////////////////////////////////////////////////////////////////////////
//censor_thresh =
${METPLUS_CENSOR_THRESH}
//censor_val =
${METPLUS_CENSOR_VAL}
//cat_thresh =
${METPLUS_CAT_THRESH}
cnt_thresh = [ NA ];
cnt_logic = UNION;
wind_thresh = [ NA ];
wind_logic = UNION;
eclv_points = 0.05;
//nc_pairs_var_name =
${METPLUS_NC_PAIRS_VAR_NAME}
nc_pairs_var_suffix = "";
//hss_ec_value =
${METPLUS_HSS_EC_VALUE}
rank_corr_flag = FALSE;
//
// Forecast and observation fields to be verified
//
fcst = {
${METPLUS_FCST_FILE_TYPE}
${METPLUS_FCST_FIELD}
${METPLUS_FCST_CLIMO_MEAN_DICT}
${METPLUS_FCST_CLIMO_STDEV_DICT}
}
obs = {
${METPLUS_OBS_FILE_TYPE}
${METPLUS_OBS_FIELD}
${METPLUS_OBS_CLIMO_MEAN_DICT}
${METPLUS_OBS_CLIMO_STDEV_DICT}
}
////////////////////////////////////////////////////////////////////////////////
//
// Climatology mean data
//
//climo_mean = {
${METPLUS_CLIMO_MEAN_DICT}
//climo_stdev = {
${METPLUS_CLIMO_STDEV_DICT}
//
// May be set separately in each "obs.field" entry
//
//climo_cdf = {
${METPLUS_CLIMO_CDF_DICT}
////////////////////////////////////////////////////////////////////////////////
//
// Verification masking regions
//
// mask = {
${METPLUS_MASK_DICT}
////////////////////////////////////////////////////////////////////////////////
//
// Confidence interval settings
//
ci_alpha = [ 0.05 ];
boot = {
interval = PCTILE;
rep_prop = 1.0;
n_rep = 0;
rng = "mt19937";
seed = "";
}
////////////////////////////////////////////////////////////////////////////////
//
// Data smoothing methods
//
//interp = {
${METPLUS_INTERP_DICT}
////////////////////////////////////////////////////////////////////////////////
//
// Neighborhood methods
//
nbrhd = {
field = BOTH;
// shape =
${METPLUS_NBRHD_SHAPE}
// width =
${METPLUS_NBRHD_WIDTH}
// cov_thresh =
${METPLUS_NBRHD_COV_THRESH}
vld_thresh = 1.0;
}
////////////////////////////////////////////////////////////////////////////////
//
// Fourier decomposition
// May be set separately in each "obs.field" entry
//
//fourier = {
${METPLUS_FOURIER_DICT}
////////////////////////////////////////////////////////////////////////////////
//
// Gradient statistics
// May be set separately in each "obs.field" entry
//
//gradient = {
${METPLUS_GRADIENT_DICT}
////////////////////////////////////////////////////////////////////////////////
//
// Distance Map statistics
// May be set separately in each "obs.field" entry
//
//distance_map = {
${METPLUS_DISTANCE_MAP_DICT}
////////////////////////////////////////////////////////////////////////////////
// Threshold for SEEPS p1 (Probability of being dry)
//seeps_p1_thresh =
${METPLUS_SEEPS_P1_THRESH}
////////////////////////////////////////////////////////////////////////////////
//
// Statistical output types
//
//output_flag = {
${METPLUS_OUTPUT_FLAG_DICT}
//
// NetCDF matched pairs output file
// May be set separately in each "obs.field" entry
//
// nc_pairs_flag = {
${METPLUS_NC_PAIRS_FLAG_DICT}
////////////////////////////////////////////////////////////////////////////////
//ugrid_dataset =
${METPLUS_UGRID_DATASET}
//ugrid_max_distance_km =
${METPLUS_UGRID_MAX_DISTANCE_KM}
//ugrid_coordinates_file =
${METPLUS_UGRID_COORDINATES_FILE}
////////////////////////////////////////////////////////////////////////////////
//grid_weight_flag =
${METPLUS_GRID_WEIGHT_FLAG}
tmp_dir = "${MET_TMP_DIR}";
// output_prefix =
${METPLUS_OUTPUT_PREFIX}
////////////////////////////////////////////////////////////////////////////////
${METPLUS_TIME_OFFSET_WARNING}
${METPLUS_MET_CONFIG_OVERRIDES}
Python Embedding
This use case does not use Python embedding.
User Scripting
User Scripting is not used in this use case.
Running METplus
Pass the use case configuration file to the run_metplus.py script along with any user-specific system configuration files if desired:
run_metplus.py /path/to/METplus/parm/use_cases/model_applications/short_range/MODE_fcstFV3_obsGOES_BrightnessTempObjs.conf /path/to/user_system.conf
See Running METplus for more information.
Expected Output
A successful run will output the following both to the screen and to the logfile:
INFO: METplus has successfully finished running.
Refer to the value set for OUTPUT_BASE to find where the output data was generated. Output for this use case will be found in short_range/brightness_temperature (relative to OUTPUT_BASE) and will contain the following files:
mode/mode_FV3_core_lsm1_010000L_20190521_010000V_NAA_cts.txt mode/mode_FV3_core_lsm1_010000L_20190521_010000V_NAA_obj.nc mode/mode_FV3_core_lsm1_010000L_20190521_010000V_NAA_obj.txt mode/mode_FV3_core_lsm1_010000L_20190521_010000V_NAA.ps mode/mode_FV3_core_lsm1_010000L_20190521_020000V_NAA_cts.txt mode/mode_FV3_core_lsm1_010000L_20190521_020000V_NAA_obj.nc mode/mode_FV3_core_lsm1_010000L_20190521_020000V_NAA_obj.txt mode/mode_FV3_core_lsm1_010000L_20190521_020000V_NAA.ps mode/mode_FV3_core_mp1_010000L_20190521_010000V_NAA_cts.txt mode/mode_FV3_core_mp1_010000L_20190521_010000V_NAA_obj.nc mode/mode_FV3_core_mp1_010000L_20190521_010000V_NAA_obj.txt mode/mode_FV3_core_mp1_010000L_20190521_010000V_NAA.ps mode/mode_FV3_core_mp1_010000L_20190521_020000V_NAA_cts.txt mode/mode_FV3_core_mp1_010000L_20190521_020000V_NAA_obj.nc mode/mode_FV3_core_mp1_010000L_20190521_020000V_NAA_obj.txt mode/mode_FV3_core_mp1_010000L_20190521_020000V_NAA.ps grid_stat_obj/grid_stat_FV3_core_lsm1_000000L_20190521_010000V_dmap.txt grid_stat_obj/grid_stat_FV3_core_lsm1_000000L_20190521_010000V_nbrctc.txt grid_stat_obj/grid_stat_FV3_core_lsm1_000000L_20190521_010000V_pairs.nc grid_stat_obj/grid_stat_FV3_core_lsm1_000000L_20190521_010000V.stat grid_stat_obj/grid_stat_FV3_core_lsm1_000000L_20190521_020000V_dmap.txt grid_stat_obj/grid_stat_FV3_core_lsm1_000000L_20190521_020000V_nbrctc.txt grid_stat_obj/grid_stat_FV3_core_lsm1_000000L_20190521_020000V_pairs.nc grid_stat_obj/grid_stat_FV3_core_lsm1_000000L_20190521_020000V.stat grid_stat_obj/grid_stat_FV3_core_mp1_000000L_20190521_010000V_dmap.txt grid_stat_obj/grid_stat_FV3_core_mp1_000000L_20190521_010000V_nbrctc.txt grid_stat_obj/grid_stat_FV3_core_mp1_000000L_20190521_010000V_pairs.nc grid_stat_obj/grid_stat_FV3_core_mp1_000000L_20190521_010000V.stat grid_stat_obj/grid_stat_FV3_core_mp1_000000L_20190521_020000V_dmap.txt grid_stat_obj/grid_stat_FV3_core_mp1_000000L_20190521_020000V_nbrctc.txt grid_stat_obj/grid_stat_FV3_core_mp1_000000L_20190521_020000V_pairs.nc grid_stat_obj/grid_stat_FV3_core_mp1_000000L_20190521_020000V.stat
Keywords
Note
MODEToolUseCase
GridStatToolUseCase
ShortRangeAppUseCase
NetCDFFileUseCase
NOAAEMCOrgUseCase
NOAAHWTOrgUseCase
ValidationUseCase
Navigate to the METplus Quick Search for Use Cases page to discover other similar use cases.
#