Actions

Difference between revisions of "RadxDiffVol"

From Lrose Wiki

(Created page with "RadxDiffVol ingests polarimetric radar data and calculates differences between fields. === '''Overview''' === RadxDiffVol computes statistics about the difference between fi...")
 
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
RadxDiffVol ingests polarimetric radar data and calculates differences between fields.
+
RadxDiffVol compares two Radx-supported files for differences.
  
 
=== '''Overview''' ===
 
=== '''Overview''' ===
  
−
RadxDiffVol 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.
+
RadxDiffVol compares two Radx-supported files for differences. Reports are printed to standard output and 0 indicates success and 1 indicates failure.
  
  
Line 10: Line 10:
 
The following items are required:
 
The following items are required:
  
−
* Polarimetric radar data (any Radx supported format, e.g., cfradial)
+
* Radar data (any Radx supported format, e.g., cfradial)
  
  
Line 26: Line 26:
  
 
<code lang="bash">/path/to/lrose/install/bin/RadxDiffVol -params orig_param_file_name -print_params &gt; new_param_file_name</code>
 
<code lang="bash">/path/to/lrose/install/bin/RadxDiffVol -params orig_param_file_name -print_params &gt; new_param_file_name</code>
 +
  
 
==== '''Important parameters''' ====
 
==== '''Important parameters''' ====
  
−
Input params
+
Reading the data
 +
 
 +
* search_mode: mode for finding files (SEARCH_BY_PATH or SEARCH_BY_TIME)
 +
 
 +
 
 +
Search by path
 +
 
 +
* file1_path: path to file #1
 +
* file2_path: path to file #2
 +
 
 +
 
 +
Search by time
 +
 
 +
* file1_dir: directory for file #1
 +
* file2_dir: directory for file #2
 +
* time_mode: determine how RadxDiffVol searches for files (READ_LATEST, READ_CLOSEST, READ_FIRST_BEFORE, READ_FIRST_AFTER)
 +
* read_search_time: time to search for files (YYYY MM DD HH MM SS; not necessary is time_mode = READ_LATEST)
 +
* read_search_margin: margin around search time (secs)
 +
 
 +
 
 +
Fields to compare
 +
 
 +
* specify_field_names: if TRUE, only fields in field_names are compared, if FALSE, each field in file #1 is compared with file #2
 +
* field_names: list of fields for comparison
  
−
* 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)
 
  
−
Field details
+
What to report
  
−
* field_pairs: specify the field names and whether the fields are in the same file or different files (along with secondary file path)
+
* ''There is a long list of variables to check, including volume number, number of fields, field names, etc. Please refer to the parameter file.''
−
* secondary_file_time_tolerance_sec: time tolerance for finding secondary file to compare with primary data file (secs)
 
−
* secondary_ray_time_tolerance_sec: time tolerance for matching rays between the primary and secondary data sets (secs)
 
−
* secondary_ray_elevation_tolerance_sec: elevation tolerance for matching rays between the primary and secondary data sets (deg)
 
−
* secondary_ray_azimuth_tolerance_sec: azimuth tolerance for matching rays between the primary and secondary data sets (deg)
 
  
−
Stats
 
  
−
* result_percentiles: specify the percentiles to be computed in addition to the mean
+
Writing the output
  
−
Write results
+
* output_file_path: output is reported to either stdout or stderr
  
−
* write_results_to_spdb: the results will be written in XML, stored in SPDB
 
−
* spdb_output_url: files will be written to this directory
 
  
  

Latest revision as of 21:06, 31 March 2021

RadxDiffVol compares two Radx-supported files for differences.

Overview

RadxDiffVol compares two Radx-supported files for differences. Reports are printed to standard output and 0 indicates success and 1 indicates failure.


Prerequesites

The following items are required:

  • Radar data (any Radx supported format, e.g., cfradial)


Parameter file

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

/path/to/lrose/install/bin/RadxDiffVol -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/RadxDiffVol -params orig_param_file_name -print_params > new_param_file_name


Important parameters

Reading the data

  • search_mode: mode for finding files (SEARCH_BY_PATH or SEARCH_BY_TIME)


Search by path

  • file1_path: path to file #1
  • file2_path: path to file #2


Search by time

  • file1_dir: directory for file #1
  • file2_dir: directory for file #2
  • time_mode: determine how RadxDiffVol searches for files (READ_LATEST, READ_CLOSEST, READ_FIRST_BEFORE, READ_FIRST_AFTER)
  • read_search_time: time to search for files (YYYY MM DD HH MM SS; not necessary is time_mode = READ_LATEST)
  • read_search_margin: margin around search time (secs)


Fields to compare

  • specify_field_names: if TRUE, only fields in field_names are compared, if FALSE, each field in file #1 is compared with file #2
  • field_names: list of fields for comparison


What to report

  • There is a long list of variables to check, including volume number, number of fields, field names, etc. Please refer to the parameter file.


Writing the output

  • output_file_path: output is reported to either stdout or stderr


Running RadxDiffVol

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

/path/to/lrose/install/bin/RadxDiffVol -h

Once your parameter file is complete, use a command similar to the following to run the application:

/path/to/lrose/install/bin/RadxDiffVol -params param_file_name

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

/path/to/lrose/install/bin/RadxDiffVol -f /path/to/cfradial/files/ -params param_file_name

Retrieved from "http://wiki.lrose.net/index.php?title=RadxDiffVol&oldid=683"