Jcdehart at 21:41, 31 March 2021

2021-03-31T21:41:21Z

Jcdehart: Created page with "RadxMergeFields merges fields from multiple CfRadial files into a single file. === '''Overview''' === RadxMergeFields compares two Radx-supported files for differences. Repo..."

2021-03-31T21:30:41Z

Created page with "RadxMergeFields merges fields from multiple CfRadial files into a single file. === '''Overview''' === RadxMergeFields compares two Radx-supported files for differences. Repo..."

New page

RadxMergeFields merges fields from multiple CfRadial files into a single file.

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

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

RadxMergeFields 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/RadxMergeFields -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/RadxMergeFields -params orig_param_file_name -print_params > new_param_file_name</code>

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

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

<code lang="bash">/path/to/lrose/install/bin/RadxMergeFields -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/RadxMergeFields -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/RadxMergeFields -f /path/to/cfradial/files/ -params param_file_name</code>

@@ Line 3: / Line 3: @@
 === '''Overview''' ===
-RadxMergeFields compares two Radx-supported files for differences. Reports are printed to standard output and 0 indicates success and 1 indicates failure.
+RadxMergeFields merges fields from multiple CfRadial files into a single file.
@@ Line 30: / Line 30: @@
 ==== '''Important parameters''' ====
-Reading the data
+Data input
-* search_mode: mode for finding files (SEARCH_BY_PATH or SEARCH_BY_TIME)
+* 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)
-Search by path
+Data locations
-* file1_path: path to file #1
+* input_datasets: file path, time offset, and time/elevation/azimuth tolerances for files and rays
-Search by time
+Specifying fields to copy from each source
-* file1_dir: directory for file #1
+* output_fields: field names and encoding
-Fields to compare
+Specifying fields to be combined
-* specify_field_names: if TRUE, only fields in field_names are compared, if FALSE, each field in file #1 is compared with file #2
+* add_combined_fields: determines whether pairs of fields are to be combined using simple algorithms (fields must be included in output_fields)
-* field_names: list of fields for comparison
+* combined_fields: fields and combination method (e.g., mean, max, sum)
-What to report
+Output format
-* ''There is a long list of variables to check, including volume number, number of fields, field names, etc. Please refer to the parameter file.''
+* output_format: select the preferred file type (usually CFRADIAL)
-Writing the output
+Output directory and filename
-* output_file_path: output is reported to either stdout or stderr
+* output_dir: files will be written to this directory

RadxMergeFields - Revision history

Jcdehart at 21:41, 31 March 2021

Jcdehart: Created page with "RadxMergeFields merges fields from multiple CfRadial files into a single file. === '''Overview''' === RadxMergeFields compares two Radx-supported files for differences. Repo..."