Tingyucha: Created page with "= HawkEye Parameter Descriptions =
HawkEye is the engineering display for the HAWK moments data. This is a C++ application using the QT GUI toolkit.
..."

2019-07-16T21:13:18Z

Created page with "= HawkEye Parameter Descriptions = <blockquote>HawkEye is the engineering display for the HAWK moments data. This is a C++ application using the QT GUI toolkit. </blockquote>..."

New page

= HawkEye Parameter Descriptions =
<blockquote>HawkEye is the engineering display for the HAWK moments data.

This is a C++ application using the QT GUI toolkit.
</blockquote>
= DEBUGGING AND PROCESS CONTROL =

== debug ==

<blockquote>Debug option.

If set, debug messages will be printed appropriately.

Type: enum
</blockquote>
Options:

* DEBUG_OFF
* DEBUG_NORM
* DEBUG_VERBOSE
* DEBUG_EXTRA

'''debug = DEBUG_OFF;'''

== check_ray_alloc ==

<blockquote>Print out checks on ray memory allocation.

; If TRUE, the app will keep track of the number of rays allocated and
: freed, and print out that information every 100 rays.

Type: boolean
</blockquote>
'''check_ray_alloc = FALSE;'''

== register_with_procmap ==

<blockquote>Option to register this process with the process mapper (procmap).

; If TRUE, every minute this process will register a heartbeat with
: procmap. If the process hangs, it will be restared by the auto_restarter.

Type: boolean
</blockquote>
'''register_with_procmap = FALSE;'''

== instance ==

<blockquote>Process instance.

Used for registration with procmap.

Type: string
</blockquote>
'''instance = "test";'''

= REALTIME DATA INPUT =

== input_mode ==

<blockquote>Method for reading the input data.

<blockquote>IWRF_FMQ_INPUT: read IWRF moments from an FMQ. IWRF_TCP_INPUT: read an IWRF moments stream from a TCP socket. SIMULATED_INPUT: internally-generated test pattern data. DSR_FMQ_INPUT: deprecated.
</blockquote>
Type: enum
</blockquote>
Options:

* IWRF_FMQ_INPUT
* IWRF_TCP_INPUT
* SIMULATED_INPUT
* DSR_FMQ_INPUT

'''input_mode = IWRF_FMQ_INPUT;'''

== input_fmq_url ==

<blockquote>; DSR_FMQ_INPUT or IWRF_FMQ_INPUT mode: input URL for moments data from
: an FMQ.
; Full url is of the form fmqp:://hostname:port:path. Path does not in
: lude the file extension.

Type: string
</blockquote>
'''input_fmq_url = "/tmp/fmq/test";'''

== seek_to_start_of_fmq ==

<blockquote>Option to seek to the start of the input FMQ.

; If TRUE, the program will seek to the start of the fmq and read the
: entire contents at startup. If FALSE, it will read only new data as it arrives.

Type: boolean
</blockquote>
'''seek_to_start_of_fmq = FALSE;'''

== input_tcp_host ==

<blockquote>IWRF_TCP_INPUT: name of host running IWRF moments server.

Type: string
</blockquote>
'''input_tcp_host = "localhost";'''

== input_tcp_port ==

<blockquote>IWRF_TCP_INPUT: port for IWRF moments server.

Type: int
</blockquote>
'''input_tcp_port = 11000;'''

== beam_queue_size ==

<blockquote>Size of the internal queue used to store beams.

; The reader runs in a separate thread, and stored the beams in a
: queue. The main thread then grabs the available beams from the queue as they become available.

Type: int
</blockquote>
'''beam_queue_size = 400;'''

= ARCHIVE MODE =

== begin_in_archive_mode ==

<blockquote>Option to begin in archive mode.

; If TRUE, the app will start up and read data from the
: archive_data_url, at the specified start time. If the start time is not set, the start time will be set to NOW.

Type: boolean
</blockquote>
'''begin_in_archive_mode = FALSE;'''

== archive_start_time ==

<blockquote>Start time for archive mode.

In archive mode, data retrieval starts at this time.

Type: string
</blockquote>
'''archive_start_time = "1970 01 01 00 00 00";'''

== archive_time_span_secs ==

<blockquote>Time span in ARCHIVE mode (secs).

Archive end time = archive_start_time + archive_time_span.

Type: double
</blockquote>
'''archive_time_span_secs = 3600;'''

== archive_data_url ==

<blockquote>URL for archive data files.

This should point to a CfRadial moments data set.

Type: string
</blockquote>
'''archive_data_url = "/data/cfradial/kddc";'''

= STATUS TO BE SHOWN IN GUI =

== show_status_in_gui ==

<blockquote>Indicate which status items to show in GUI.

<dl>
<dt>These items are shown in the left panel in the GUI. Setting an item</dt>
<dd>to false will hide it in the GUI.</dd>
<dt>Type: struct</dt>
<dd><dl>
<dt>typedef struct {</dt>
<dd>boolean azimuth; boolean elevation; boolean fixed_angle; boolean volume_number; boolean sweep_number; boolean n_samples; boolean n_gates; boolean gate_length; boolean pulse_width; boolean prf_mode; boolean prf; boolean nyquist; boolean max_range; boolean unambiguous_range; boolean measured_power_h; boolean measured_power_v; boolean scan_name; boolean scan_mode; boolean polarization_mode; boolean latitude; boolean longitude; boolean altitude; boolean altitude_rate; boolean sun_elevation; boolean sun_azimuth; boolean speed; boolean heading; boolean track;</dd></dl>

}</dd></dl>
</blockquote>
'''show_status_in_gui = {'''

'''azimuth = TRUE,'''

'''elevation = TRUE,'''

'''fixed_angle = TRUE,'''

'''volume_number = FALSE,'''

'''sweep_number = TRUE,'''

'''n_samples = TRUE,'''

'''n_gates = TRUE,'''

'''gate_length = TRUE,'''

'''pulse_width = TRUE,'''

'''prf_mode = TRUE,'''

'''prf = TRUE,'''

'''nyquist = TRUE,'''

'''max_range = TRUE,'''

'''unambiguous_range = TRUE,'''

'''measured_power_h = FALSE,'''

'''measured_power_v = FALSE,'''

'''scan_name = FALSE,'''

'''scan_mode = TRUE,'''

'''polarization_mode = TRUE,'''

'''latitude = TRUE,'''

'''longitude = TRUE,'''

'''altitude = TRUE,'''

'''altitude_rate = FALSE,'''

'''sun_elevation = TRUE,'''

'''sun_azimuth = TRUE,'''

'''speed = FALSE,'''

'''heading = FALSE,'''

'''track = FALSE'''

'''};'''

= FIELDS TO BE DISPLAYED =

== color_scale_dir ==

<blockquote>Directory for color scales.

You can set this in 2 ways:

<ol style="list-style-type: lower-alpha;">
<li>Set to the absolute path</li></ol>

; (b)Set as a path relative to the location of the application binary
: executable.

Type: string
</blockquote>
'''color_scale_dir = "../share/color_scales";'''

== fields ==

<blockquote>Fields to be displayed.

<dl>
<dt>label: appears on the GUI. raw_name: unfiltered field name.</dt>
<dd>filtered_name: field with clutter filter applied. units: units string for color scale. color_map: name of color map in color_scale_dir. shortcut: keyboard character for shortcut. Specified key will select raw field. Use ALT-key to get filtered field. .</dd>
<dt>Type: struct</dt>
<dd><dl>
<dt>typedef struct {</dt>
<dd>string label; string raw_name; string filtered_name; string units; string color_map; string shortcut;</dd></dl>

}</dd></dl>

1D array - variable length.
</blockquote>
'''fields = {'''

'''label = "DBZ",'''

'''raw_name = "DBZ",'''

'''filtered_name = "",'''

'''units = "dBZ",'''

'''color_map = "dbz.colors",'''

'''shortcut = "1"'''

'''label = "REF",'''

'''raw_name = "REF",'''

'''filtered_name = "",'''

'''units = "dBZ",'''

'''color_map = "dbz.colors",'''

'''shortcut = "2"'''

'''label = "VEL",'''

'''raw_name = "VEL",'''

'''filtered_name = "",'''

'''units = "m/s",'''

'''color_map = "vel.colors",'''

'''shortcut = "3"'''

'''label = "WIDTH",'''

'''raw_name = "WIDTH",'''

'''filtered_name = "",'''

'''units = "m/s",'''

'''color_map = "width.colors",'''

'''shortcut = "4"'''

'''label = "SW",'''

'''raw_name = "SW",'''

'''filtered_name = "",'''

'''units = "m/s",'''

'''color_map = "width.colors",'''

'''shortcut = "5"'''

'''label = "ZDR",'''

'''raw_name = "ZDR",'''

'''filtered_name = "",'''

'''units = "dB",'''

'''color_map = "zdr.colors",'''

'''shortcut = "6"'''

'''label = "PHIDP",'''

'''raw_name = "PHIDP",'''

'''filtered_name = "",'''

'''units = "deg",'''

'''color_map = "phidp.colors",'''

'''shortcut = "7"'''

'''label = "RHOHV",'''

'''raw_name = "RHOHV",'''

'''filtered_name = "",'''

'''units = "unitless",'''

'''color_map = "rhohv.colors",'''

'''shortcut = "8"'''

'''};'''

== background_render_mins ==

<blockquote>Background rendering time period in minutes.

; Any field which is viewed will continue to be rendered in the
: background for this number of minutes.

Minimum val: 0

Type: double
</blockquote>
'''background_render_mins = 2;'''

== use_field_label_in_title ==

<blockquote>Option to use field label in the display title.

; If TRUE, the label will be used in the title. If FALSE, the raw_name
: or filtered name will be used.

Type: boolean
</blockquote>
'''use_field_label_in_title = FALSE;'''

= INITIAL MAX RANGE =

== max_range_km ==

<blockquote>Max range for the display (km).

Type: double
</blockquote>
'''max_range_km = 225;'''

= DISPLAY TYPE =

== display_mode ==

<blockquote>Main display mode.

<blockquote>POLAR_DISPLAY - normal PPI and RHI display. BSCAN_DISPLAY - BSCAN
</blockquote>
<blockquote>mode.
</blockquote>
Type: enum
</blockquote>
Options:

* POLAR_DISPLAY
* BSCAN_DISPLAY

'''display_mode = POLAR_DISPLAY;'''

= NAMES AND LABELS =

== override_radar_name ==

<blockquote>Option to override radar name in the data.

Type: boolean
</blockquote>
'''override_radar_name = FALSE;'''

== radar_name ==

<blockquote>Radar name if overridden.

Type: string
</blockquote>
'''radar_name = "SPOL";'''

== display_site_name ==

<blockquote>Option to display the site name in the left panel.

Type: boolean
</blockquote>
'''display_site_name = FALSE;'''

== override_site_name ==

<blockquote>Option to override site name in the data.

Type: boolean
</blockquote>
'''override_site_name = FALSE;'''

== site_name ==

<blockquote>Site name if overridden.

Type: string
</blockquote>
'''site_name = "MARSHALL";'''

= WINDOW DIMENSIONS AND PLOTTING DETAILS =

== main_window_width ==

<blockquote>Startup width of main window (pixels).

Type: int
</blockquote>
'''main_window_width = 1050;'''

== main_window_height ==

<blockquote>Startup height of main window (pixels).

Type: int
</blockquote>
'''main_window_height = 635;'''

== main_window_start_x ==

<blockquote>Startup X for main window (pixels).

Type: int
</blockquote>
'''main_window_start_x = 0;'''

== main_window_start_y ==

<blockquote>Startup Y for main window (pixels).

Type: int
</blockquote>
'''main_window_start_y = 0;'''

== color_scale_width ==

<blockquote>Width of color scale (pixels).

Type: int
</blockquote>
'''color_scale_width = 40;'''

== label_font_size ==

<blockquote>Basic font size for labels (pixels).

Some of the labels are scaled relative to this size.

Type: int
</blockquote>
'''label_font_size = 12;'''

== background_color ==

<blockquote>Color of main display background.

Type: string
</blockquote>
'''background_color = "black";'''

== grid_and_range_ring_color ==

<blockquote>Color of grids and range rings.

Type: string
</blockquote>
'''grid_and_range_ring_color = "white";'''

== range_ring_label_font_size ==

<blockquote>Font size for labels on range rings (pixels).

Type: int
</blockquote>
'''range_ring_label_font_size = 8;'''

== click_cross_size ==

<blockquote>Size of cross at click point (pixels).

Size of cross drawn at click point, to select data.

Type: int
</blockquote>
'''click_cross_size = 11;'''

= PPI MODE DISPLAY =

== ppi_display_type ==

<blockquote>Type of display to use for the PPI window.

<blockquote>PPI_FULL - Display the full 360 degrees of the PPI. This is the
</blockquote>
<blockquote>; default.
: PPI_AIRBORN - Use the airborn radar PPI display. This display shows

just the 180 degrees of radar pointing forward from the nose of the plane.
</blockquote>
Type: enum
</blockquote>
Options:

* PPI_FULL
* PPI_AIRBORNE

'''ppi_display_type = PPI_FULL;'''

== ppi_aspect_ratio ==

<blockquote>Aspect ratio (width/height) of PPI window.

Type: double
</blockquote>
'''ppi_aspect_ratio = 1;'''

== ppi_grids_on_at_startup ==

<blockquote>Set PPI grids overlay on at startup.

Type: boolean
</blockquote>
'''ppi_grids_on_at_startup = FALSE;'''

== ppi_range_rings_on_at_startup ==

<blockquote>Set PPI range rings overlay on at startup.

Type: boolean
</blockquote>
'''ppi_range_rings_on_at_startup = TRUE;'''

== ppi_azimuth_lines_on_at_startup ==

<blockquote>Set PPI azimuth lines overlay on at startup.

Type: boolean
</blockquote>
'''ppi_azimuth_lines_on_at_startup = TRUE;'''

== ppi_main_legend_pos ==

<blockquote>Position of main legend in the PPI plot window.

This include time, field name and elevation angle.

Type: enum
</blockquote>
Options:

* LEGEND_TOP_LEFT
* LEGEND_TOP_RIGHT
* LEGEND_BOTTOM_LEFT
* LEGEND_BOTTOM_RIGHT

'''ppi_main_legend_pos = LEGEND_TOP_LEFT;'''

= RHI MODE DISPLAY =

== rhi_window_width ==

<blockquote>Startup width of RHI window (pixels).

Type: int
</blockquote>
'''rhi_window_width = 500;'''

== rhi_window_height ==

<blockquote>Startup height of RHI window (pixels).

Type: int
</blockquote>
'''rhi_window_height = 500;'''

== rhi_window_start_x ==

<blockquote>Startup X for RHI window (pixels).

Type: int
</blockquote>
'''rhi_window_start_x = 1100;'''

== rhi_window_start_y ==

<blockquote>Startup Y for RHI window (pixels).

Type: int
</blockquote>
'''rhi_window_start_y = 0;'''

== rhi_top_margin ==

<blockquote>Height of top margin in RHI mode (pixels).

Titles go in the top margin.

Type: int
</blockquote>
'''rhi_top_margin = 20;'''

== rhi_bottom_margin ==

<blockquote>Height of bottom margin in RHI mode (pixels).

Time scale goes in the bottom margin.

Type: int
</blockquote>
'''rhi_bottom_margin = 20;'''

== rhi_left_margin ==

<blockquote>Width of left margin in RHI mode (pixels).

Height scale goes in the left margin.

Type: int
</blockquote>
'''rhi_left_margin = 20;'''

== rhi_right_margin ==

<blockquote>Width of right margin in RHI mode (pixels).

Height scale goes in the right margin.

Type: int
</blockquote>
'''rhi_right_margin = 20;'''

== rhi_label_font_size ==

<blockquote>Font size for labels on range rings (pixels).

Type: int
</blockquote>
'''rhi_label_font_size = 8;'''

== rhi_axis_tick_len ==

<blockquote>Length of ticks on axes (pixels).

Type: int
</blockquote>
'''rhi_axis_tick_len = 7;'''

== rhi_n_ticks_ideal ==

<blockquote>Ideal number of ticks on axes.

Type: int
</blockquote>
'''rhi_n_ticks_ideal = 7;'''

== rhi_text_margin ==

<blockquote>Margin around some text (pixels).

Type: int
</blockquote>
'''rhi_text_margin = 5;'''

== rhi_display_180_degrees ==

<blockquote>; Flag indicating to display full 180 degrees in RHI window. If set to
: false, the RHI window will just display 90 degrees of the RHI.

Type: boolean
</blockquote>
'''rhi_display_180_degrees = FALSE;'''

== rhi_aspect_ratio ==

<blockquote>Aspect ratio (width/height) of RHI window.

Type: double
</blockquote>
'''rhi_aspect_ratio = 1;'''

== rhi_max_height_km ==

<blockquote>Max height of data in RHI window (km).

Type: double
</blockquote>
'''rhi_max_height_km = 25;'''

== rhi_color_scale_width ==

<blockquote>Width of color scale for RHI window (pixels).

Type: int
</blockquote>
'''rhi_color_scale_width = 40;'''

== rhi_grids_on_at_startup ==

<blockquote>Set RHI grids overlay on at startup.

Type: boolean
</blockquote>
'''rhi_grids_on_at_startup = TRUE;'''

== rhi_range_rings_on_at_startup ==

<blockquote>Set RHI range rings overlay on at startup.

Type: boolean
</blockquote>
'''rhi_range_rings_on_at_startup = TRUE;'''

== rhi_elevation_lines_on_at_startup ==

<blockquote>Set RHI elevation lines overlay on at startup.

Type: boolean
</blockquote>
'''rhi_elevation_lines_on_at_startup = FALSE;'''

== rhi_main_legend_pos ==

<blockquote>Position of main legend in the RHI plot window.

This include time, field name and elevation angle.

Type: enum
</blockquote>
Options:

* LEGEND_TOP_LEFT
* LEGEND_TOP_RIGHT
* LEGEND_BOTTOM_LEFT
* LEGEND_BOTTOM_RIGHT

'''rhi_main_legend_pos = LEGEND_TOP_LEFT;'''

== rhi_beam_queue_size ==

<blockquote>Size of the queue for RHI beams.

After the queue reaches this size, older beams are discarded.

Type: int
</blockquote>
'''rhi_beam_queue_size = 360;'''

= BSCAN TIME LIMITS =

== bscan_time_span_secs ==

<blockquote>Number of seconds in BSCAN display.

; In REALTIME mode, when we reach the right-hand side of the display,
: the existing plot will be moved left to make room for more data.

Type: double
</blockquote>
'''bscan_time_span_secs = 60;'''

== bscan_truncate_start_time ==

<blockquote>Option to truncate the plot start time to even seconds.

If true, we truncate the start time to the previous second.

Type: boolean
</blockquote>
'''bscan_truncate_start_time = FALSE;'''

== bscan_subsec_precision ==

<blockquote>Precision of subseconds in time labels.

; Number of decimals of precision in time labels. Set to 0 for times in
: integer seconds.

Minimum val: 0 Maximum val: 9

Type: int
</blockquote>
'''bscan_subsec_precision = 3;'''

= BSCAN REALTIME CONTROLS =

== bscan_realtime_fraction_saved ==

<blockquote>; What fraction of the existing data to save when moving the plot to
: the left.
; When we reach the right-hand side of the display, we need to move the
: plot to the left. This is the fraction of the plot that is saved after the move has taken place.

Type: double
</blockquote>
'''bscan_realtime_fraction_saved = 0.5;'''

== bscan_min_secs_between_reading_beams ==

<blockquote>Min time between incoming beams (secs).

; If beams arrive too fast, we discard some so that the time between
: the beams is at least this long.

Type: double
</blockquote>
'''bscan_min_secs_between_reading_beams = 0.01;'''

== bscan_min_secs_between_rendering_beams ==

<blockquote>Min time between rendering (secs).

; Setting this higher makes the display less smooth, but prevents the
: display from taking up too much CPU and/or GPU.

Type: double
</blockquote>
'''bscan_min_secs_between_rendering_beams = 0;'''

= BSCAN RANGE AND ALTITUDE LIMITS =

== bscan_specify_range_limits ==

<blockquote>Specify the min and max range when in range mode.

If false, we will use the start range and max range in the data.

Type: boolean
</blockquote>
'''bscan_specify_range_limits = TRUE;'''

== bscan_min_range_km ==

<blockquote>Min range to be plotted (km).

Used if 'bscan_specify_range_limits' is true.

Type: double
</blockquote>
'''bscan_min_range_km = 0;'''

== bscan_max_range_km ==

<blockquote>Max range to be plotted (km).

Used if 'bscan_specify_range_limits' is true.

Type: double
</blockquote>
'''bscan_max_range_km = 25;'''

== bscan_min_altitude_km ==

<blockquote>Min altitude plotted (km).

Type: double
</blockquote>
'''bscan_min_altitude_km = -0.5;'''

== bscan_max_altitude_km ==

<blockquote>Max altitude plotted (km).

Type: double
</blockquote>
'''bscan_max_altitude_km = 25;'''

== bscan_altitude_in_feet ==

<blockquote>Use feet for altitude units?.

Type: boolean
</blockquote>
'''bscan_altitude_in_feet = FALSE;'''

== bscan_range_in_feet ==

<blockquote>Use feet for range units?.

Type: boolean
</blockquote>
'''bscan_range_in_feet = FALSE;'''

== bscan_range_axis_mode ==

Options:

* RANGE_AXIS_UP - instrument is at the bottom, range plotted positively
* upwards. RANGE_AXIS_DOWN: instrument is at the top, range plotted
* downwards. RANGE_AXIS_ALTITUDE: vertical scale represents the
* Type: enum

Options:

* RANGE_AXIS_UP
* RANGE_AXIS_DOWN
* RANGE_AXIS_ALTITUDE

'''bscan_range_axis_mode = RANGE_AXIS_ALTITUDE;'''

= BSCAN CENSOR DATA BELOW SURFACE =

== bscan_censor_data_below_surface ==

<blockquote>Option to censor data below the measured surface.

Type: boolean
</blockquote>
'''bscan_censor_data_below_surface = FALSE;'''

== bscan_surface_field ==

<blockquote>Name of field used to identify the surface from the data.

; The surface will be identified at the gate with the maximum value in
: this field.

Type: string
</blockquote>
'''bscan_surface_field = "DBZ";'''

== bscan_min_range_to_surface_km ==

<blockquote>Minumum range to the surface (km).

We will search for the surface echo in the gates beyound this range.

Type: double
</blockquote>
'''bscan_min_range_to_surface_km = 0.5;'''

== bscan_surface_range_margin_km ==

<blockquote>Margin of data plotted beyond the surface (km).

; We will censor the data beyond the surface gate, plus this range
: margin.

Type: double
</blockquote>
'''bscan_surface_range_margin_km = 0.2;'''

== bscan_max_field_val_below_surface ==

<blockquote>Maximum value of the surface field, below the measured surface.

; After finding the range to the surface, we inspect the surface_field
: values below the surface. If we find values that exceed this parameter, we conclude that the surface cannot be reliably found.

Type: double
</blockquote>
'''bscan_max_field_val_below_surface = 5;'''

= BSCAN MARGINS =

== bscan_top_margin ==

<blockquote>Height of top margin in BSCAN mode (pixels).

Titles go in the top margin.

Type: int
</blockquote>
'''bscan_top_margin = 40;'''

== bscan_bottom_margin ==

<blockquote>Height of bottom margin in BSCAN mode (pixels).

Time scale goes in the bottom margin.

Type: int
</blockquote>
'''bscan_bottom_margin = 45;'''

== bscan_left_margin ==

<blockquote>Width of left margin in BSCAN mode (pixels).

Height scale goes in the left margin.

Type: int
</blockquote>
'''bscan_left_margin = 50;'''

== bscan_right_margin ==

<blockquote>Width of right margin in BSCAN mode (pixels).

Height scale goes in the right margin.

Type: int
</blockquote>
'''bscan_right_margin = 40;'''

== bscan_axis_tick_len ==

<blockquote>Length of ticks on axes (pixels).

Type: int
</blockquote>
'''bscan_axis_tick_len = 6;'''

== bscan_n_ticks_ideal ==

<blockquote>Ideal number of ticks on axes.

Type: int
</blockquote>
'''bscan_n_ticks_ideal = 10;'''

== bscan_text_margin ==

<blockquote>Margin around some text (pixels).

Type: int
</blockquote>
'''bscan_text_margin = 5;'''

= BSCAN TITLES, LABELS AND AXES =

== bscan_title_font_size ==

<blockquote>Font size of center title (pixels).

Type: int
</blockquote>
'''bscan_title_font_size = 12;'''

== bscan_axis_label_font_size ==

<blockquote>Font size of axis labels in bscan (pixels).

Type: int
</blockquote>
'''bscan_axis_label_font_size = 10;'''

== bscan_axis_values_font_size ==

<blockquote>Font size of axis values (pixels).

Type: int
</blockquote>
'''bscan_axis_values_font_size = 8;'''

== bscan_axes_color ==

<blockquote>Color of axes in bscan.

Type: string
</blockquote>
'''bscan_axes_color = "white";'''

== bscan_grid_color ==

<blockquote>Color of grid lines on bscan.

Type: string
</blockquote>
'''bscan_grid_color = "gray";'''

== bscan_labels_color ==

<blockquote>Color of labels in bscan.

Type: string
</blockquote>
'''bscan_labels_color = "white";'''

== bscan_draw_time_grid_lines ==

<blockquote>Option to draw grid lines across plot at regular time intervals.

Type: boolean
</blockquote>
'''bscan_draw_time_grid_lines = TRUE;'''

== bscan_draw_range_grid_lines ==

<blockquote>Option to draw grid lines across plot at regular range intervals.

Type: boolean
</blockquote>
'''bscan_draw_range_grid_lines = TRUE;'''

== bscan_draw_instrument_height_line ==

<blockquote>Option to draw a line for the instrument location.

Type: boolean
</blockquote>
'''bscan_draw_instrument_height_line = TRUE;'''

== bscan_instrument_height_color ==

<blockquote>Color of instrument height line in ALTITUDE plot.

Type: string
</blockquote>
'''bscan_instrument_height_color = "white";'''

= DISTANCE SCALE =

== bscan_add_distance_to_time_axis ==

<blockquote>Option to plot distance as well as time on the time axis.

; If true, extra tick marks will show the distance in km along the time
: axis, in addition to the time.

Type: boolean
</blockquote>
'''bscan_add_distance_to_time_axis = TRUE;'''

== bscan_n_segments_for_computing_distance ==

<blockquote>Number of segments to be used for computing distance.

; We divide the rays into this number of segments and then compute the
: distance travelled during each segment using the change in lat/lon position. We keep the number of segments reasonably small to avoid unnecessary CPU usage.

Type: int
</blockquote>
'''bscan_n_segments_for_computing_distance = 50;'''

= BSCAN LEGENDS =

== bscan_plot_starting_latlon_as_legend ==

<blockquote>Option to plot the starting lat/lon position as a legend.

This helps in geolocating the data from a mobile system.

Type: boolean
</blockquote>
'''bscan_plot_starting_latlon_as_legend = TRUE;'''

== bscan_starting_latlon_legend_pos ==

<blockquote>Position of lat/lon legend in plot.

; The starting latitude/longitude will be plotted as a legend in the
: location specified. See 'bscan_plot_starting_latlon_as_legend'.

Type: enum
</blockquote>
Options:

* LEGEND_TOP_LEFT
* LEGEND_TOP_RIGHT
* LEGEND_BOTTOM_LEFT
* LEGEND_BOTTOM_RIGHT

'''bscan_starting_latlon_legend_pos = LEGEND_TOP_LEFT;'''

== bscan_plot_mean_track_and_speed_as_legend ==

<blockquote>Option to plot the mean track and speed in a legend.

This helps in geolocating the data from a mobile system.

Type: boolean
</blockquote>
'''bscan_plot_mean_track_and_speed_as_legend = TRUE;'''

== bscan_mean_track_and_speed_legend_pos ==

<blockquote>Position of track/speed legend in plot.

; The mean track and speed will be plotted as a legend in the location
: specified. See 'bscan_plot_track_and_speed_as_legend'.

Type: enum
</blockquote>
Options:

* LEGEND_TOP_LEFT
* LEGEND_TOP_RIGHT
* LEGEND_BOTTOM_LEFT
* LEGEND_BOTTOM_RIGHT

'''bscan_mean_track_and_speed_legend_pos = LEGEND_TOP_RIGHT;'''

= BSCAN DWELL CONTROLS =

== bscan_archive_dwell_auto ==

<blockquote>Compute dwell from image size and time range.

; If TRUE, we compute the optimal dwell so that there will be
: approximately 1 dwell for each pixel in the resulting image. If FALSE, the dwell is specified below.

Type: boolean
</blockquote>
'''bscan_archive_dwell_auto = TRUE;'''

== bscan_archive_dwell_secs ==

<blockquote>Specified dwell time for archive mode (secs).

Type: double
</blockquote>
'''bscan_archive_dwell_secs = 0.1;'''

== bscan_dwell_stats ==

<blockquote>Method for computing stats on the dwell.

; Applies to READ_RAYS_IN_INTERVAL mode. MIDDLE refers to the middle
: ray in the dwell sequence.

Type: enum
</blockquote>
Options:

* DWELL_STATS_MEAN
* DWELL_STATS_MEDIAN
* DWELL_STATS_MAXIMUM
* DWELL_STATS_MINIMUM
* DWELL_STATS_MIDDLE

'''bscan_dwell_stats = DWELL_STATS_MIDDLE;'''

= SAVING IMAGES TO FILE =

<blockquote><dl>
<dt>In creating files for the field catalog, the file name is of the</dt>
<dd>form:
<blockquote>category.platform.YYYYMMDDHHmm.product_name.ext</blockquote></dd>
<dt>The following parameters control the output directory, and the</dt>
<dd>construction of the file name.</dd></dl>
</blockquote>
== images_output_dir ==

<blockquote>Output directory for images generated by this app.

Type: string
</blockquote>
'''images_output_dir = "/tmp/images/HawkEye";'''

== images_write_to_day_dir ==

<blockquote>Option to create a subdirectory for each day.

Type: boolean
</blockquote>
'''images_write_to_day_dir = TRUE;'''

== images_file_name_category ==

<blockquote>Set the category string.

If empty, no category will be included.

Type: string
</blockquote>
'''images_file_name_category = "radar";'''

== images_file_name_platform ==

<blockquote>Set the platform string.

If empty, no platform will be included.

Type: string
</blockquote>
'''images_file_name_platform = "NSF_NCAR_GV_HCR";'''

== images_file_name_extension ==

<blockquote>; Set the extension string. This also governs the file format. It
: should be 'png', 'jpg', 'gif' etc.

An extension is always required.

Type: string
</blockquote>
'''images_file_name_extension = "png";'''

== images_file_name_delimiter ==

<blockquote>Set the delimiter between the parts of the file name.

NOTE: before the extension the delimited is always a period: '.'.

Type: string
</blockquote>
'''images_file_name_delimiter = ".";'''

== images_include_time_part_in_file_name ==

<blockquote>Normally the file name includes a time part: YYYYMMDDHHMMSS.

If FALSE, the time part will be omitted.

Type: boolean
</blockquote>
'''images_include_time_part_in_file_name = TRUE;'''

== images_include_seconds_in_time_part ==

<blockquote>Normally the time part include the seconds: YYYYMMDDHHMMSS.

If FALSE, the SS will be excluuded from the time part.

Type: boolean
</blockquote>
'''images_include_seconds_in_time_part = FALSE;'''

== images_include_field_label_in_file_name ==

<blockquote>Normally the file name includes the field label (product type).

If FALSE, the field label will be omitted.

Type: boolean
</blockquote>
'''images_include_field_label_in_file_name = TRUE;'''

== images_write_latest_data_info ==

<blockquote>Option to write latest_data_info files when an image is created.

Type: boolean
</blockquote>
'''images_write_latest_data_info = TRUE;'''

= OPTION TO CREATE IMAGES AUTOMATICALLY =

== images_auto_create ==

<blockquote>Option to create images automatically.

Type: boolean
</blockquote>
'''images_auto_create = FALSE;'''

== images_creation_mode ==

<blockquote>Mode for controlling auto image creation.

CREATE_IMAGES_FROM_GUI: create images interactively using the GUI.

; CREATE_IMAGES_THEN_EXIT: for the specified start time and time span,
: create an output image for every field in the fields array, and then exit.
; CREATE_IMAGES_ON_REALTIME_SCHEDULE: wait for the scheduled time, then
: generate an image for each field.
; CREATE_IMAGES_ON_ARCHIVE_SCHEDULE: for each scheduled time between
: the start and end times, generate an image for each field.

Type: enum
</blockquote>
Options:

* CREATE_IMAGES_THEN_EXIT
* CREATE_IMAGES_ON_REALTIME_SCHEDULE
* CREATE_IMAGES_ON_ARCHIVE_SCHEDULE

'''images_creation_mode = CREATE_IMAGES_THEN_EXIT;'''

== images_schedule_interval_secs ==

<blockquote>Interval at which images are created on schedule (secs).

; The application waits until the interval has passed, plus any
: specified delay, and then creates the images.

Type: int
</blockquote>
'''images_schedule_interval_secs = 300;'''

== images_schedule_delay_secs ==

<blockquote>Delay between scheduled time and image creation (secs).

; In order to ensure that the data has been written, a delay may be
: provided. This allows for the writing application to complete writing the data before this application tries to access it.

Type: int
</blockquote>
'''images_schedule_delay_secs = 60;'''

== images_archive_start_time ==

<blockquote>Start time for image generation in archive mode.

; Image generation starts with a seach at this time, and the proceeds
: at increments of images_schedule_interval_secs.

Type: string
</blockquote>
'''images_archive_start_time = "1970 01 01 00 00 00";'''

== images_archive_end_time ==

<blockquote>End time for image generation in archive mode.

; Image generation is terminated when the search time exceeds this end
: time.

Type: string
</blockquote>
'''images_archive_end_time = "1970 01 01 00 00 00";'''

== images_scan_interval_secs ==

<blockquote>Time between scans in archive mode (secs).

Only applies to POLAR (PPI/RHI) mode, not BSCAN mode.

Type: int
</blockquote>
'''images_scan_interval_secs = 300;'''

== images_set_sweep_index_list ==

<blockquote>Option to specify the sweep indexes for the image generation.

If TRUE, only the specified sweeps will be processed.

Type: boolean
</blockquote>
'''images_set_sweep_index_list = FALSE;'''

== images_sweep_index_list ==

<blockquote>List of valid sweep indexes for image generation.

; See 'images_set_sweep_index_list'. Images will only be generated for
: the specified sweep indexes.

Type: int 1D array - variable length.
</blockquote>
'''images_sweep_index_list = {'''

'''};'''

= SIMULATION MODE =

== sim_sleep_msecs ==

<blockquote>; Number of milliseconds to sleep between beams in simulated input
: mode.

Type: int
</blockquote>
'''sim_sleep_msecs = 10;'''

== sim_n_gates ==

<blockquote>Number of gates in simulated data.

Type: int
</blockquote>
'''sim_n_gates = 1000;'''

== sim_start_range_km ==

<blockquote>Start range in simulated mode (km).

Type: double
</blockquote>
'''sim_start_range_km = 0.075;'''

== sim_gate_spacing_km ==

<blockquote>Gate spacing in simulated mode (km).

Type: double
</blockquote>
'''sim_gate_spacing_km = 0.15;'''

HawkEye parameter file - Revision history

Tingyucha: /* HawkEye Parameter Descriptions */

Tingyucha: Created page with "= HawkEye Parameter Descriptions =
HawkEye is the engineering display for the HAWK moments data. This is a C++ application using the QT GUI toolkit.
..."

@@ Line 1: / Line 1: @@
 = HawkEye Parameter Descriptions =
-<blockquote>HawkEye is the engineering display for the HAWK moments data.
+HawkEye is the engineering display for the HAWK moments data.
 This is a C++ application using the QT GUI toolkit.
-</blockquote>
 = DEBUGGING AND PROCESS CONTROL =

HawkEye parameter file - Revision history

Tingyucha: /* HawkEye Parameter Descriptions */

Tingyucha: Created page with "= HawkEye Parameter Descriptions = HawkEye is the engineering display for the HAWK moments data. This is a C++ application using the QT GUI toolkit. ..."

Tingyucha: Created page with "= HawkEye Parameter Descriptions =
HawkEye is the engineering display for the HAWK moments data. This is a C++ application using the QT GUI toolkit.
..."