Difference between revisions of "RadxKdp"
From Lrose Wiki
| (15 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | RadxKdp ingests polarimetric radar data and calculates | + | RadxKdp ingests polarimetric radar data and calculates <math>K_{DP}</math> from <math>\phi_{DP}</math>. |
| − | = Prerequesites = | + | === '''Overview''' === |
| + | |||
| + | RadxKdp uses a couple different methods to calculate <math>K_{DP}</math> from <math>\phi_{DP}</math>. In general, <math>K_{DP}</math> is calculated from the <math>\phi_{DP}</math> slope between range gates (after smoothing and unfolding the <math>\phi_{DP}</math> data). Filtering smears out <math>K_{DP}</math> in range, so an additional field (KDP_SC) is constrained by <math>K_{DP}</math> estimated theoretically from <math>Z_H</math> and <math>Z_{DR}</math>. | ||
| + | |||
| + | |||
| + | === '''Scientific Background''' === | ||
| + | A detailed explanation of the procedure used to estimate <math>K_{DP}</math> can be found [http://wiki.lrose.net/index.php/KDP_estimation here]. | ||
| + | |||
| + | Information about how attenuation is estimated from <math>K_{DP}</math> can be found [http://wiki.lrose.net/index.php/Estimated_Attenuation here]. | ||
| + | |||
| + | |||
| + | === '''Prerequesites''' === | ||
The following items are required: | The following items are required: | ||
* Polarimetric radar data (any Radx supported format, e.g., cfradial) | * Polarimetric radar data (any Radx supported format, e.g., cfradial) | ||
| − | * Two parameter files to run RadxKdp and to calculate | + | * Two parameter files to run RadxKdp and to calculate <math>K_{DP}</math>. |
| − | |||
| − | + | === '''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 <math>K_{DP}</math> and estimate attenuation. | |
| − | = | + | ==== '''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: | ||
| − | <code lang="bash">lrose | + | <code lang="bash">/path/to/lrose/install/bin/RadxKdp -print_params > param_file_name</code> |
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: | 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: | ||
| − | <code lang="bash">lrose | + | <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 39: | Line 45: | ||
Input field information | Input field information | ||
| − | * SNR_available: determines if SNR data is in the file or needs to be calculated from | + | * SNR_available: determines if SNR data is in the file or needs to be calculated from <math>Z_H</math> |
* VARIABLE_field_name: tells RadxKdp the polarimetric variable names in the ingested cfradial files | * VARIABLE_field_name: tells RadxKdp the polarimetric variable names in the ingested cfradial files | ||
Computing KDP | Computing KDP | ||
| − | * KDP_params_file_path: path to the | + | * KDP_params_file_path: path to the <math>K_{DP}</math>-specific parameter file |
| + | |||
| + | Output fields | ||
| + | |||
| + | * output_fields: specify the fields to be written to the output file (including attenuation-corrected fields) | ||
Output format | Output format | ||
| Line 54: | Line 64: | ||
* 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: | ||
| − | <code lang="bash">lrose | + | <code lang="bash">/path/to/lrose/install/bin/RadxKdp -print_params_kdp > param_file_name</code> |
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: | 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: | ||
| − | <code lang="bash">lrose | + | <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 | ||
| − | * KDP_fir_filter_len: Filter length applied to | + | * KDP_fir_filter_len: Filter length applied to <math>\phi_{DP}</math> |
Handling phase shift on backscatter (PSOB) | Handling phase shift on backscatter (PSOB) | ||
| Line 76: | Line 86: | ||
* 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. | ||
| − | <code lang="bash">lrose | + | <code lang="bash">/path/to/lrose/install/bin/RadxKdp -h</code> |
| − | Once your parameter file is complete, use a command similar to the following to run the application: | + | Once your parameter file is complete, use a command similar to the following to run the application. ''Note: this command will '''''not''''' work for the FILELIST mode.'' |
| − | <code lang="bash">lrose | + | <code lang="bash">/path/to/lrose/install/bin/RadxKdp -params param_file_name</code> |
| − | + | If using FILELIST mode, the user needs to specify the location of cfradial files using the <code lang="bash">-f</code> flag: | |
| − | <code lang="bash">lrose | + | <code lang="bash">/path/to/lrose/install/bin/RadxKdp -f /path/to/cfradial/files/ -params param_file_name</code> |
Latest revision as of 20:27, 19 April 2024
RadxKdp ingests polarimetric radar data and calculates [math]\displaystyle{ K_{DP} }[/math] from [math]\displaystyle{ \phi_{DP} }[/math].
Contents
Overview
RadxKdp uses a couple different methods to calculate [math]\displaystyle{ K_{DP} }[/math] from [math]\displaystyle{ \phi_{DP} }[/math]. In general, [math]\displaystyle{ K_{DP} }[/math] is calculated from the [math]\displaystyle{ \phi_{DP} }[/math] slope between range gates (after smoothing and unfolding the [math]\displaystyle{ \phi_{DP} }[/math] data). Filtering smears out [math]\displaystyle{ K_{DP} }[/math] in range, so an additional field (KDP_SC) is constrained by [math]\displaystyle{ K_{DP} }[/math] estimated theoretically from [math]\displaystyle{ Z_H }[/math] and [math]\displaystyle{ Z_{DR} }[/math].
Scientific Background
A detailed explanation of the procedure used to estimate [math]\displaystyle{ K_{DP} }[/math] can be found here.
Information about how attenuation is estimated from [math]\displaystyle{ K_{DP} }[/math] can be found here.
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 [math]\displaystyle{ K_{DP} }[/math].
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 [math]\displaystyle{ K_{DP} }[/math] 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 [math]\displaystyle{ Z_H }[/math]
- VARIABLE_field_name: tells RadxKdp the polarimetric variable names in the ingested cfradial files
Computing KDP
- KDP_params_file_path: path to the [math]\displaystyle{ K_{DP} }[/math]-specific parameter file
Output fields
- output_fields: specify the fields to be written to the output file (including attenuation-corrected fields)
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 [math]\displaystyle{ \phi_{DP} }[/math]
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. Note: this command will not work for the FILELIST mode.
/path/to/lrose/install/bin/RadxKdp -params param_file_name
If using FILELIST mode, the user needs to specify the location of cfradial files using the -f flag:
/path/to/lrose/install/bin/RadxKdp -f /path/to/cfradial/files/ -params param_file_name