Actions

Difference between revisions of "RadxBufr"

From Lrose Wiki

(Created page with "RadxBufr ingests polarimetric radar data and calculates differences between fields. === '''Overview''' === RadxBufr computes statistics about the difference between fields i...")
 
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
RadxBufr ingests polarimetric radar data and calculates differences between fields.
+
RadxBufr converts BUFR files to CfRadial.
  
 
=== '''Overview''' ===
 
=== '''Overview''' ===
  
RadxBufr 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.
+
RadxBufr converts BUFR files to CfRadial.
  
  
Line 21: Line 21:
 
To obtain the default parameter file, use the following command:
 
To obtain the default parameter file, use the following command:
  
<code lang="bash">/path/to/lrose/install/bin/R RadxBufr -print_params &gt; param_file_name</code>
+
<code lang="bash">/path/to/lrose/install/bin/RadxBufr -print_params &gt; 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">/path/to/lrose/install/bin/RadxBufr -params orig_param_file_name -print_params &gt; new_param_file_name</code>
 
<code lang="bash">/path/to/lrose/install/bin/RadxBufr -params orig_param_file_name -print_params &gt; new_param_file_name</code>
 +
  
 
==== '''Important parameters''' ====
 
==== '''Important parameters''' ====
Line 31: Line 32:
 
Input params
 
Input params
  
* primary_input_dir: directory containing radar data (if not specified on the command line and if mode = REALTIME)
+
* input_dir: directory containing radar data (if not specified on the command line and if mode = REALTIME)
 +
 
 +
 
 +
Table path
 +
 
 
* 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)
 
* 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
 
  
* field_pairs: specify the field names and whether the fields are in the same file or different files (along with secondary file path)
+
Option to specify field names and output encoding
* 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)
+
* set_output_fields: option to specify fields or include all fields in the final output files
* secondary_ray_elevation_tolerance_sec: elevation tolerance for matching rays between the primary and secondary data sets (deg)
+
* output_fields: list of field names, units, scaling, offset, etc.
* secondary_ray_azimuth_tolerance_sec: azimuth tolerance for matching rays between the primary and secondary data sets (deg)
+
 
 +
 
 +
Censoring
 +
 
 +
* apply_censoring: option to censor fields where gates meet certain criteria
 +
* censoring_fields: list fields, minimum and maximum values, and combination method to determine whether a gate should be censored
 +
 
 +
 
 +
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
 
  
Write results
+
Output directory and file name
  
* write_results_to_spdb: the results will be written in XML, stored in SPDB
+
* output_dir: files will be written to this directory
* spdb_output_url: files will be written to this directory
 
  
  

Latest revision as of 16:44, 14 April 2021

RadxBufr converts BUFR files to CfRadial.

Overview

RadxBufr converts BUFR files to CfRadial.


Prerequesites

The following items are required:

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


Parameter file

RadxBufr 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/RadxBufr -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/RadxBufr -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)


Table path

  • 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)


Option to specify field names and output encoding

  • set_output_fields: option to specify fields or include all fields in the final output files
  • output_fields: list of field names, units, scaling, offset, etc.


Censoring

  • apply_censoring: option to censor fields where gates meet certain criteria
  • censoring_fields: list fields, minimum and maximum values, and combination method to determine whether a gate should be censored


Output format

  • output_format: select the preferred file type (usually CFRADIAL)


Output directory and file name

  • output_dir: files will be written to this directory


Running RadxBufr

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

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

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

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

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

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