HawkEye - Revision history

Barbero: /* Colors */

2022-07-08T20:31:10Z

Colors

Barbero: /* Adding variables to HawkEye parameter file */

2022-07-08T20:30:59Z

Adding variables to HawkEye parameter file

Barbero: /* Adding variables to HawkEye parameter file */

2022-07-08T20:30:22Z

Adding variables to HawkEye parameter file

Barbero: /* Colors */

2022-07-08T19:43:07Z

Colors

Barbero: /* Adding variables to HawkEye parameter file */

2022-07-08T19:42:27Z

Adding variables to HawkEye parameter file

Barbero at 19:41, 8 July 2022

2022-07-08T19:41:43Z

Barbero at 19:31, 8 July 2022

2022-07-08T19:31:38Z

Adesros: /* Running HawkEye */

2021-03-18T21:33:06Z

Running HawkEye

Adesros: /* Running HawkEye */

2021-03-18T21:31:40Z

Running HawkEye

Jcdehart at 23:49, 12 January 2021

2021-01-12T23:49:04Z

@@ Line 88: / Line 88: @@
 ==== '''Colors''' ====
-HawkEye supports many different color scales for different fields that can be specified via external files. Default color palettes are applied to variable names with commonly used meanings (ie. ZDR), but can be overridden by the user. A list of colors can be found [https://github.com/NCAR/lrose-displays/tree/master/color_scales here].
+HawkEye supports many different color scales for different fields that can be specified via external files. Default color palettes are applied to variable names with commonly used meanings (ie. ZDR), but can be overridden by the user. A list of colormaps can be found [https://github.com/NCAR/lrose-displays/tree/master/color_scales here].
 While most of the GUI viewing options are intuitive, additional documentation on all the details of the HawkEye GUI is under development.

@@ Line 50: / Line 50: @@
 ==== '''Adding variables to HawkEye parameter file''' ====
-The default parameter file contains the variables "DBZ", "REF", "VEL", "WIDTH", "SW", "ZDR", "PHIDP", "RHOHV". If you would like to view other retrieved/calculated variables (e.g., KDP, PID, RATE_ZH) in HawkEye, add another struct with the variable of interest in the HawkEye parameter file in lines 345-417. Make sure the raw_name matches the variable in the file which you are viewing and the units are correct. However, the label and color_map are up to the user's discretion. A list of colors can be found [https://github.com/NCAR/lrose-displays/tree/master/color_scales here]. You can check the variable name, units, longname etc., using the ncdump command.
+The default parameter file contains the variables "DBZ", "REF", "VEL", "WIDTH", "SW", "ZDR", "PHIDP", "RHOHV". If you would like to view other retrieved/calculated variables (e.g., KDP, PID, RATE_ZH) in HawkEye, add another struct with the variable of interest in the HawkEye parameter file in lines 345-417. Make sure the raw_name matches the variable in the file which you are viewing and the units are correct. However, the label and color_map are up to the user's discretion. A list of colormaps can be found [https://github.com/NCAR/lrose-displays/tree/master/color_scales here]. You can check the variable name, units, longname etc., using the ncdump command.
 Example: Add PID and RATE_ZH variables from QPE file.

@@ Line 51: / Line 51: @@
 The default parameter file contains the variables "DBZ", "REF", "VEL", "WIDTH", "SW", "ZDR", "PHIDP", "RHOHV". If you would like to view other retrieved/calculated variables (e.g., KDP, PID, RATE_ZH) in HawkEye, add another struct with the variable of interest in the HawkEye parameter file in lines 345-417. Make sure the raw_name matches the variable in the file which you are viewing and the units are correct. However, the label and color_map are up to the user's discretion. A list of colors can be found [https://github.com/NCAR/lrose-displays/tree/master/color_scales here]. You can check the variable name, units, longname etc., using the ncdump command.
- Example: Add PID and RATE_ZH variables from QPE file
- > View metadata of variable in CfRadial .nc file
+Example: Add PID and RATE_ZH variables from QPE file.
 <code lang="bash">ncdump -c ./cfrad.20170602_001311.000_to_20170602_001311.000_RCWF_SUR.nc </code>
- > Add variables of interest to HawkEye parameter file
     ...
    ,
@@ Line 75: / Line 80: @@
    }
 };
- > Rerun HawkEdit
 <code lang="bash">HawkEye -params ./HawkEye.qpe.params -f cfrad.20170602_001311.000_to_20170602_001311.000_RCWF_SUR.nc</code>
 [[File:HawkEdit_Add_Variables.png|700px|center]]

@@ Line 81: / Line 81: @@
 ==== '''Colors''' ====
-HawkEye supports many different color scales for different fields that can be specified via external files. Default color palettes are applied to variable names with commonly used meanings (ie. ZDR), but can be overridden by the user.
+HawkEye supports many different color scales for different fields that can be specified via external files. Default color palettes are applied to variable names with commonly used meanings (ie. ZDR), but can be overridden by the user. A list of colors can be found [https://github.com/NCAR/lrose-displays/tree/master/color_scales here].
 While most of the GUI viewing options are intuitive, additional documentation on all the details of the HawkEye GUI is under development.

@@ Line 52: / Line 52: @@
 The default parameter file contains the variables "DBZ", "REF", "VEL", "WIDTH", "SW", "ZDR", "PHIDP", "RHOHV". If you would like to view other retrieved/calculated variables (e.g., KDP, PID, RATE_ZH) in HawkEye, add another struct with the variable of interest in the HawkEye parameter file in lines 345-417. Make sure the raw_name matches the variable in the file which you are viewing and the units are correct. However, the label and color_map are up to the user's discretion. A list of colors can be found [https://github.com/NCAR/lrose-displays/tree/master/color_scales here]. You can check the variable name, units, longname etc., using the ncdump command.
   Example: Add PID and RATE_ZH variables from QPE file
-  View metadata of variable in CfRadial .nc file
+  > View metadata of variable in CfRadial .nc file
 <code lang="bash">ncdump -c ./cfrad.20170602_001311.000_to_20170602_001311.000_RCWF_SUR.nc </code>
-  Add variables of interest to HawkEye parameter file
+  > Add variables of interest to HawkEye parameter file
     ...
    ,
@@ Line 75: / Line 75: @@
    }
 };
-  Rerun HawkEdit
+  > Rerun HawkEdit
 <code lang="bash">HawkEye -params ./HawkEye.qpe.params -f cfrad.20170602_001311.000_to_20170602_001311.000_RCWF_SUR.nc</code>
 [[File:HawkEdit_Add_Variables.png|700px|center]]
 ==== '''Colors''' ====

← Older revision		Revision as of 19:31, 8 July 2022
Line 47:		Line 47:

	While HawkEye will do its best to display data properly, the parameter file can force the viewer to use POLAR_DISPLAY for PPI and RHI display and BSCAN_DISPLAY for BSCAN mode. The full parameter file description can be found here: '''[http://wiki.lrose.net/index.php/HawkEye_parameter_file HawkEye parameter file]'''		While HawkEye will do its best to display data properly, the parameter file can force the viewer to use POLAR_DISPLAY for PPI and RHI display and BSCAN_DISPLAY for BSCAN mode. The full parameter file description can be found here: '''[http://wiki.lrose.net/index.php/HawkEye_parameter_file HawkEye parameter file]'''
		+
		+	==== '''Adding variables to HawkEye parameter file''' ====
		+
		+	The default parameter file contains the variables "DBZ", "REF", "VEL", "WIDTH", "SW", "ZDR", "PHIDP", "RHOHV". If you would like to view other retrieved/calculated variables (e.g., KDP, PID, RATE_ZH) in HawkEye, add another struct with the variable of interest in the HawkEye parameter file in lines 345-417. Make sure the raw_name matches the variable in the file which you are viewing and the units are correct. However, the label and color_map are up to the user's discretion. A list of colors can be found [https://github.com/NCAR/lrose-displays/tree/master/color_scales here]. You can check the variable name, units, longname etc., using the ncdump command.
		+	Example: Add PID and RATE_ZH variables from QPE file
		+	View metadata of variable in CfRadial .nc file
		+	<code lang="bash">ncdump -c ./cfrad.20170602_001311.000_to_20170602_001311.000_RCWF_SUR.nc </code>
		+	Add variables of interest to HawkEye parameter file
		+	...
		+	417 ,
		+	418 {
		+	419 label = "PID",
		+	420 raw_name = "PID",
		+	421 filtered_name = "",
		+	422 units = "unitless",
		+	423 color_map = "pid.colors",
		+	424 shortcut = "p"
		+	425 }
		+	426 ,
		+	427 {
		+	428 label = "RATE_ZH",
		+	429 raw_name = "RATE_ZH",
		+	430 filtered_name = "",
		+	431 units = "mm/h",
		+	432 color_map = "prate.colors",
		+	433 shortcut = "r"
		+	434 }
		+	435 };
		+	Rerun HawkEdit
		+	<code lang="bash">HawkEye -params ./HawkEye.qpe.params -f cfrad.20170602_001311.000_to_20170602_001311.000_RCWF_SUR.nc</code>

	==== '''Colors''' ====		==== '''Colors''' ====

@@ Line 15: / Line 15: @@
 <code lang="bash">/Applications/HawkEye.app/Contents/MacOS/HawkEye -f </path/to/CfRadial_files></code>
-Depending on how the CfRadial files are stored in the directory, it may be necessary to use </path/to/CfRadial_files/cfrad*>.
+Depending on how the CfRadial files are stored in the directory, it may be necessary to use </path/to/CfRadial_files/cfrad*> to point the program directly to the CfRadials.
 If the data is organized under the YYYYMMHH date directory in the path, the user can specify specific time span to display:
@@ Line 25: / Line 25: @@
 <code lang="bash">/Applications/HawkEye.app/Contents/MacOS/HawkEye -archive_url /scr/rain1/rsfdata/projects/pecan/CfRadial/kddc/moments -start_time "2015 06 26 00 00 00" -time_span 7200</code>
-This command would start it up to look at the specified data location, from the specified start time, for a time span of 2 hours (time span argument taken in units of seconds). In this case, since we are searching by time, you are required to have a day directory in the path, so that actual data would be in the 20150626 subdirectory underneath the 'moments' directory.
+This command would start it up to look at the specified data location, from the specified start time, for a time span of 2 hours (argument taken in units of seconds). In this case, since we are searching by time, you are required to have a day directory in the path, so that actual data would be in the 20150626 subdirectory underneath the 'moments' directory.

@@ Line 14: / Line 14: @@
 <code lang="bash">/Applications/HawkEye.app/Contents/MacOS/HawkEye -f </path/to/CfRadial_files></code>
 If the data is organized under the YYYYMMHH date directory in the path, the user can specify specific time span to display:
@@ Line 24: / Line 25: @@
 This command would start it up to look at the specified data location, from the specified start time, for a time span of 2 hours. In this case, since we are searching by time, you are required to have a day directory in the path, so that actual data would be in the 20150626 subdirectory underneath the 'moments' directory.
 To check all command line options for HawkEye, type the following command into a bash.
@@ Line 32: / Line 34: @@
 <code lang="bash">/Applications/HawkEye.app/Contents/MacOS/HawkEye -h</code>
 To obtain the default parameter file for more options, use the following command:
@@ Line 40: / Line 43: @@
 <code lang="bash">/Applications/HawkEye.app/Contents/MacOS/HawkEye -print_params > $PWD/HawkEye.params</code>
 While HawkEye will do its best to display data properly, the parameter file can force the viewer to use POLAR_DISPLAY for PPI and RHI display and BSCAN_DISPLAY for BSCAN mode. The full parameter file description can be found here: '''[http://wiki.lrose.net/index.php/HawkEye_parameter_file HawkEye parameter file]'''