Difference between revisions of "RadxKdp"
From Lrose Wiki
| Line 1: | Line 1: | ||
RadxKdp ingests polarimetric radar data and calculates KDP from PHIDP. | RadxKdp ingests polarimetric radar data and calculates KDP from PHIDP. | ||
| − | = Prerequesites = | + | === Prerequesites === |
The following items are required: | The following items are required: | ||
| Line 8: | Line 8: | ||
* Two parameter files to run RadxKdp and to calculate KDP. | * Two parameter files to run RadxKdp and to calculate KDP. | ||
| − | = Overview = | + | === Overview === |
RadxKdp uses a couple different methods to calculate KDP from PHIDP. In general, KDP is calculated from the PHIDP slope between range gates (after smoothing and unfolding the PHIDP data). Filtering smears out KDP in range, so an additional field (KDP_SC) is constrained by KDP estimated theoretically from Z and ZDR. | RadxKdp uses a couple different methods to calculate KDP from PHIDP. In general, KDP is calculated from the PHIDP slope between range gates (after smoothing and unfolding the PHIDP data). Filtering smears out KDP in range, so an additional field (KDP_SC) is constrained by KDP estimated theoretically from Z and ZDR. | ||
| Line 15: | Line 15: | ||
A more detailed explanation of the procedure used to estimate KDP can be found [http://wiki.lrose.net/index.php/KDP_estimation here]. | A more detailed explanation of the procedure used to estimate KDP can be found [http://wiki.lrose.net/index.php/KDP_estimation here]. | ||
| − | = Parameter files = | + | === Parameter files === |
RadxKdp uses two separate parameter files. The first includes the basic parameters related to data location and field names, which is similar to the parameter files for the other Radx applications. The second includes the parameters that set the filtering length, method, and relevant coefficients necessary to calculate KDP and estimate attenuation. | RadxKdp uses two separate parameter files. The first includes the basic parameters related to data location and field names, which is similar to the parameter files for the other Radx applications. The second includes the parameters that set the filtering length, method, and relevant coefficients necessary to calculate KDP and estimate attenuation. | ||
| − | == 1) Main parameter file == | + | ==== 1) Main parameter file ==== |
| − | === Ensure file is up to date === | + | ===== Ensure file is up to date ===== |
To obtain the default parameter file, use the following command: | To obtain the default parameter file, use the following command: | ||
| Line 31: | Line 31: | ||
<code lang="bash">/path/to/lrose/install/bin/RadxKdp -params orig_param_file_name -print_params > new_param_file_name</code> | <code lang="bash">/path/to/lrose/install/bin/RadxKdp -params orig_param_file_name -print_params > new_param_file_name</code> | ||
| − | === Important parameters === | + | ===== Important parameters ===== |
Input params | Input params | ||
| Line 55: | Line 55: | ||
* output_dir: files will be written to this directory | * output_dir: files will be written to this directory | ||
| − | == 2) KDP-specific parameter file == | + | ==== 2) KDP-specific parameter file ==== |
| − | === Ensure file is up to date === | + | ===== Ensure file is up to date ===== |
To obtain the default parameter file, use the following command: | To obtain the default parameter file, use the following command: | ||
| Line 67: | Line 67: | ||
<code lang="bash">/path/to/lrose/install/bin/RadxKdp -params_kdp orig_param_file_name -print_params_kdp > new_param_file_name</code> | <code lang="bash">/path/to/lrose/install/bin/RadxKdp -params_kdp orig_param_file_name -print_params_kdp > new_param_file_name</code> | ||
| − | === Important parameters === | + | ===== Important parameters ===== |
Unfolding and filtering | Unfolding and filtering | ||
| Line 77: | Line 77: | ||
* KDP_psob_method: Method to handle PSOB | * KDP_psob_method: Method to handle PSOB | ||
| − | = Running RadxKdp = | + | === Running RadxKdp === |
To check all command line options for RadxKdp, including debugging options and file paths, type the following command into a terminal. | To check all command line options for RadxKdp, including debugging options and file paths, type the following command into a terminal. | ||
Revision as of 20:47, 11 January 2021
RadxKdp ingests polarimetric radar data and calculates KDP from PHIDP.
Contents
Prerequesites
The following items are required:
- Polarimetric radar data (any Radx supported format, e.g., cfradial)
- Two parameter files to run RadxKdp and to calculate KDP.
Overview
RadxKdp uses a couple different methods to calculate KDP from PHIDP. In general, KDP is calculated from the PHIDP slope between range gates (after smoothing and unfolding the PHIDP data). Filtering smears out KDP in range, so an additional field (KDP_SC) is constrained by KDP estimated theoretically from Z and ZDR.
A more detailed explanation of the procedure used to estimate KDP can be found here.
Parameter files
RadxKdp uses two separate parameter files. The first includes the basic parameters related to data location and field names, which is similar to the parameter files for the other Radx applications. The second includes the parameters that set the filtering length, method, and relevant coefficients necessary to calculate KDP and estimate attenuation.
1) Main parameter file
Ensure file is up to date
To obtain the default parameter file, use the following command:
/path/to/lrose/install/bin/RadxKdp -print_params > param_file_name
If you already have a parameter file and simply want to check for (and add) updated parameters while retaining current parameters, use the following command:
/path/to/lrose/install/bin/RadxKdp -params orig_param_file_name -print_params > new_param_file_name
Important parameters
Input params
- input_dir: directory containing radar data (if not specified on the command line and if mode = REALTIME)
- mode: determines if the program waits for new files (REALTIME), moves through start and end times specified on the command line (ARCHIVE), or moves through list of files specified on the command line (FILELIST)
Input field information
- SNR_available: determines if SNR data is in the file or needs to be calculated from DBZ
- VARIABLE_field_name: tells RadxKdp the polarimetric variable names in the ingested cfradial files
Computing KDP
- KDP_params_file_path: path to the KDP-specific parameter file
Output format
- output_format: select the preferred file type (usually CFRADIAL)
Output directory
- output_dir: files will be written to this directory
2) KDP-specific parameter file
Ensure file is up to date
To obtain the default parameter file, use the following command:
/path/to/lrose/install/bin/RadxKdp -print_params_kdp > param_file_name
If you already have a parameter file and simply want to check for (and add) updated parameters while retaining current parameters, use the following command:
/path/to/lrose/install/bin/RadxKdp -params_kdp orig_param_file_name -print_params_kdp > new_param_file_name
Important parameters
Unfolding and filtering
- KDP_fir_filter_len: Filter length applied to PHIDP
Handling phase shift on backscatter (PSOB)
- KDP_psob_method: Method to handle PSOB
Running RadxKdp
To check all command line options for RadxKdp, including debugging options and file paths, type the following command into a terminal.
/path/to/lrose/install/bin/RadxKdp -h
Once your parameter file is complete, use a command similar to the following to run the application:
/path/to/lrose/install/bin/RadxKdp -params param_file_name
The user can also specify the location of cfradial files in the following manner:
/path/to/lrose/install/bin/RadxKdp -f /path/to/cfradial/files/ -params param_file_name