RadxDiffFields - Revision history

Jcdehart: /* Running RadxDiffFields */

2021-03-31T17:47:22Z

Running RadxDiffFields

Jcdehart at 17:46, 31 March 2021

2021-03-31T17:46:55Z

Jcdehart: Created page with "RadxDiffFields ingests polarimetric radar data and calculates $K_{DP}$ from $\phi_{DP}$ . === '''Overview''' === RadxDiffFields computes statistics abou..."

2021-03-31T17:32:46Z

Created page with "RadxDiffFields ingests polarimetric radar data and calculates <math>K_{DP}</math> from <math>\phi_{DP}</math>. === '''Overview''' === RadxDiffFields computes statistics abou..."

New page

RadxDiffFields ingests polarimetric radar data and calculates <math>K_{DP}</math> from <math>\phi_{DP}</math>.

=== '''Overview''' ===

RadxDiffFields computes statistics about the difference between fields in Radx files. The fields can be in the same file or in different files. The results are written to SPDB as XML.

=== '''Prerequesites''' ===

The following items are required:

* Polarimetric radar data (any Radx supported format, e.g., cfradial)

=== '''Parameter file''' ===

RadxKdp uses one parameter file that includes the basic parameters related to data location and field names, which is similar to the parameter files for the other Radx applications.

==== '''Ensure file is up to date''' ====

To obtain the default parameter file, use the following command:

<code lang="bash">/path/to/lrose/install/bin/RadxDiffFields -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:

<code lang="bash">/path/to/lrose/install/bin/RadxDiffFields -params orig_param_file_name -print_params > new_param_file_name</code>

==== '''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>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>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

=== '''Running RadxKdp''' ===

To check all command line options for RadxKdp, including debugging options and file paths, type the following command into a terminal.

<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:

<code lang="bash">/path/to/lrose/install/bin/RadxKdp -params param_file_name</code>

The user can also specify the location of cfradial files in the following manner:

<code lang="bash">/path/to/lrose/install/bin/RadxKdp -f /path/to/cfradial/files/ -params param_file_name</code>

@@ Line 54: / Line 54: @@
 === '''Running RadxDiffFields''' ===
-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 RadxDiffFields, including debugging options and file paths, type the following command into a terminal.
 <code lang="bash">/path/to/lrose/install/bin/RadxDiffFields -h</code>

@@ Line 1: / Line 1: @@
-RadxDiffFields ingests polarimetric radar data and calculates <math>K_{DP}</math> from <math>\phi_{DP}</math>.
+RadxDiffFields ingests polarimetric radar data and calculates differences between fields.
 === '''Overview''' ===
 RadxDiffFields computes statistics about the difference between fields in Radx files. The fields can be in the same file or in different files. The results are written to SPDB as XML.
 === '''Prerequesites''' ===
@@ Line 14: / Line 15: @@
 === '''Parameter file''' ===
-RadxKdp uses one parameter file that includes the basic parameters related to data location and field names, which is similar to the parameter files for the other Radx applications.
+RadxDiffFields uses one parameter file that includes the basic parameters related to data location and field names, which is similar to the parameter files for the other Radx applications.
 ==== '''Ensure file is up to date''' ====
@@ Line 30: / Line 31: @@
 Input params
-* input_dir: directory containing radar data (if not specified on the command line and if mode = REALTIME)
+* primary_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
+Field details
-* output_fields: specify the fields to be written to the output file (including attenuation-corrected fields)
+* field_pairs: specify the field names and whether the fields are in the same file or different files (along with secondary file path)
-Output format
+Stats
-* output_format: select the preferred file type (usually CFRADIAL)
+* result_percentiles: specify the percentiles to be computed in addition to the mean
-Output directory
+Write results
-* output_dir: files will be written to this directory
+* write_results_to_spdb: the results will be written in XML, stored in SPDB
-=== '''Running RadxKdp''' ===
+=== '''Running RadxDiffFields''' ===
 To check all command line options for RadxKdp, including debugging options and file paths, type the following command into a terminal.
-<code lang="bash">/path/to/lrose/install/bin/RadxKdp -h</code>
+<code lang="bash">/path/to/lrose/install/bin/RadxDiffFields -h</code>
 Once your parameter file is complete, use a command similar to the following to run the application:
-<code lang="bash">/path/to/lrose/install/bin/RadxKdp -params param_file_name</code>
+<code lang="bash">/path/to/lrose/install/bin/RadxDiffFields -params param_file_name</code>
 The user can also specify the location of cfradial files in the following manner:
-<code lang="bash">/path/to/lrose/install/bin/RadxKdp -f /path/to/cfradial/files/ -params param_file_name</code>
+<code lang="bash">/path/to/lrose/install/bin/RadxDiffFields -f /path/to/cfradial/files/ -params param_file_name</code>

RadxDiffFields - Revision history

Jcdehart: /* Running RadxDiffFields */

Jcdehart at 17:46, 31 March 2021

Jcdehart: Created page with "RadxDiffFields ingests polarimetric radar data and calculates K_{DP} from \phi_{DP}. === '''Overview''' === RadxDiffFields computes statistics abou..."

Jcdehart: Created page with "RadxDiffFields ingests polarimetric radar data and calculates $K_{DP}$ from $\phi_{DP}$ . === '''Overview''' === RadxDiffFields computes statistics abou..."