NAME
BQTrace - BRTT Qt graphics extension for drawing a single trace and editing arrivals
SYNOPSIS
$(QTNATIVELIBS) -lbqplot_native -lbanner -lbrttutil -lbumapdata $(DBLIBS) $(TRLIBS)
#include "BQ.h"
DESCRIPTION
BQTrace class is a helper class for
BQTraceview objects.
BQTrace objects are only created withon
BQTraceview objects and
cannot be created outside of
BQTraceview objects. Because of this, in this man
page the constructors will be omitted. Details can be found in
BQTraceview(3).
INHERITS FROM
BQPixelator,
BQConfigure
METHODS INHERITED FROM BQConfigure
-
void configure (Pf *params);
An Antelope parameter file object pointer that contains the BQBQTrace object
parameters. The parameters are described below.
-
void configure (...);
A variable argument list composed entirely of character string key-value pairs with
a single NULL terminating argument. This is an alternate method for specifying
the BQBQTrace object parameters. The parameters are described below.
OBJECT CONFIGURATION PARAMETERS
-
color_foreground color_string
This specifies a trace foreground color, the color of the trace waveform line.
If this is specified as NULL, then the foreground color is taken from
the parent BQTraceview object depending on whether or not
the BQTraceciew main display is in edit mode.
-
color_background color_string
This specifies a trace background color.
If this is specified as NULL, then the background color is taken from
the parent BQTraceview object depending on whether or not
the BQTraceciew main display is in edit mode.
-
font_trace_label font_string
This specifies a trace label font.
If this is specified as NULL, then the label font is taken from
the parent BQTraceview object.
-
color_trace_label color_string
This specifies a trace label color.
If this is specified as NULL, then the label color is taken from
the parent BQTraceview object.
-
font_trace_amp_label font_string
This specifies a trace amplitude annotation font.
If this is specified as NULL, then the amplitude annotation font is taken from
the parent BQTraceview object.
-
color_trace_amp_label color_string
This specifies a trace amplitude annotation color.
If this is specified as NULL, then the amplitude annotation color is taken from
the parent BQTraceview object.
-
font_trace_filter_label font_string
This specifies a trace filter label font.
If this is specified as NULL, then the trace filter label font is taken from
the parent BQTraceview object.
-
color_trace_filter_label color_string
This specifies a trace filter label color.
If this is specified as NULL, then the filter label color is taken from
the parent BQTraceview object.
-
color_trace_select_background color_string
This specifies the trace label background color when the trace is selected.
If this is specified as NULL, then the selected trace label background color is taken from
the parent BQTraceview object.
-
font_trace_select_order_label font_string
This specifies a font for the trace label select order annotation.
If this is specified as NULL, then the trace label select order font is taken from
the parent BQTraceview object.
-
color_trace_select_order_label color_string
This specifies a color for the trace label select order annotation.
If this is specified as NULL, then the trace label select order color is taken from
the parent BQTraceview object.
-
linewidth linewidth
This sets the trace waveform line width. If it is set to -1, then the trace linewidth is taken from
the parent BQTraceview object.
-
visible {yes|no}
This determines if the trace is visible in the BQTraceview parent display.
-
show_arrivals {yes|no|default}
This determines if the trace arrivals are visible in the BQTraceview parent display.
If set to default, then the show arrivals flag is taken from
the parent BQTraceview object.
-
show_detections {yes|no|default}
This determines if the trace detections are visible in the BQTraceview parent display.
If set to default, then the show detections flag is taken from
the parent BQTraceview object.
-
show_predicted_arrivals {yes|no|default}
This determines if the trace predicted arrivals are visible in the BQTraceview parent display.
If set to default, then the show predicted arrivals flag is taken from
the parent BQTraceview object.
-
show_residuals {yes|no|default}
This determines if the trace residuals are visible in the BQTraceview parent display.
If set to default, then the show residuals flag is taken from
the parent BQTraceview object.
-
label_visible {yes|no|default}
This determines if the trace label is visible in the BQTraceview parent display.
If set to default, then the label visibility flag is taken from
the parent BQTraceview object.
-
ampscale_visible {yes|no|default}
This determines if the trace amplitude annotations label is visible in the BQTraceview parent display.
If set to default, then the amplitude annotation visibility flag is taken from
the parent BQTraceview object.
-
ampscale_mode {auto|fixed|default}
This sets the trace plot amplitude scale mode in the BQTraceview parent display.
If set to default, then the trace plot amplitude scale mode is taken from
the parent BQTraceview object.
-
units {source|counts|sm|default}
This sets the trace plot amplitude unist in the BQTraceview parent display.
If set to default, then the trace plot amplitude unts is taken from
the parent BQTraceview object.
-
clip {yes|no|default}
This sets the trace plot clip flag in the BQTraceview parent display.
If set to default, then the trace plot clip flag is taken from
the parent BQTraceview object.
-
stretch_height stretch
This sets the trace plot height stretch factor.
-
abottom abottom
This sets the trace amplitude value abottom in the trace source units
corresponding to the bottom of the trace display window. This
is only used when the ampscale_mode is fixed.
-
atop atop
This sets the trace amplitude value atop in the trace source units
corresponding to the top of the trace display window. This
is only used when the ampscale_mode is fixed.
-
gain gain
This sets the trace plot gain value to gain.
If set to 0.0, then the trace plot gain is taken from
the parent BQTraceview object.
-
filter_string filter_string
This sets the trace filter string.
If set to NULL, then the trace filter string is taken from
the parent BQTraceview object.
-
filter_tpad filter_tpad
This sets the trace filter time pad.
If set to NULL, then the trace filter time pad is taken from
the parent BQTraceview object.
-
filter_label filter_label
This sets the trace filter label.
SEE ALSO
bqplot(3),
BQConfigure(3),
BQTraceview(3)
AUTHOR
Danny Harvey, BRTT