CPLOT_structPlotOptions Struct Reference

#include <cplot.h>

Detailed Description

The user specified plot options.

Definition at line 105 of file cplot.h.


Data Fields
int	numberOfSeries
	The total number of series to be plotted.
int	PlotSize_Width_cm
	The size of the plot portion of the figure [cm].
int	PlotSize_Height_cm
	The size of the plot portion of the figure [cm].
char *	title
	The title string if any. NULL if none.
char *	y_label_right
	The ylabel on the right hand side of the plot. NULL if none. Usually NULL.
double	y_label_right_scale_factor
	Scale the lhs y ticks by this value for the rhs ticks.
double	y_label_right_bias
	Offset the rhs y ticks by this value after scaling.
CPLOT_enumColor	RightYLabelColor
	The color of the right y label.
CPLOT_structAxisOptions	x
	General axis options for X.
CPLOT_structAxisOptions	y
	General axis options for Y.
BOOL	useGPSLabel
	A boolean indicating if the special GPS x axis label is to be used. Enabling X_UseGPSLabel assumes that the X part of the series is a GPS time of week, (0-604800 s), and will compute the corresponding UTC time and include it below each xtick.
int	UTCOffset
	The GPS/UTC offset (always +ve).
BOOL	plotStatistics
	A boolean indicating if statistics are to be included in the figure.
BOOL	plotLabelOnRight
	Place labels and statistics on the right of the plot. Otherwise below the plot.
CPLOT_enumColor	figureBackgroundColor
	The figure background color.

Field Documentation

int CPLOT_structPlotOptions::numberOfSeries

The total number of series to be plotted.

Definition at line 107 of file cplot.h.

int CPLOT_structPlotOptions::PlotSize_Width_cm

The size of the plot portion of the figure [cm].

Definition at line 108 of file cplot.h.

int CPLOT_structPlotOptions::PlotSize_Height_cm

The size of the plot portion of the figure [cm].

Definition at line 109 of file cplot.h.

char* CPLOT_structPlotOptions::title

The title string if any. NULL if none.

Definition at line 110 of file cplot.h.

char* CPLOT_structPlotOptions::y_label_right

The ylabel on the right hand side of the plot. NULL if none. Usually NULL.

Data can be plotted with respect to y ticks on the right hand side of the plot window. For example, plot elevation angle (0-90, left side y ticks) and plot azimuth angle (-180-180, right side y ticks).

    rhs_ytick = lhs_ytick * scale_factor + offset
    e.g.
    Y_Label,              = "Elevation (deg)"
    Y_RightYLabel,        = "Azimuth (deg)"
    Y_RightYOffset,       = -180
    Y_RightYScaleFactor,  = 4

Definition at line 128 of file cplot.h.

double CPLOT_structPlotOptions::y_label_right_scale_factor

Scale the lhs y ticks by this value for the rhs ticks.

Definition at line 129 of file cplot.h.

double CPLOT_structPlotOptions::y_label_right_bias

Offset the rhs y ticks by this value after scaling.

Definition at line 130 of file cplot.h.

CPLOT_enumColor CPLOT_structPlotOptions::RightYLabelColor

The color of the right y label.

Definition at line 131 of file cplot.h.

CPLOT_structAxisOptions CPLOT_structPlotOptions::x

General axis options for X.

Definition at line 133 of file cplot.h.

CPLOT_structAxisOptions CPLOT_structPlotOptions::y

General axis options for Y.

Definition at line 134 of file cplot.h.

BOOL CPLOT_structPlotOptions::useGPSLabel

A boolean indicating if the special GPS x axis label is to be used. Enabling X_UseGPSLabel assumes that the X part of the series is a GPS time of week, (0-604800 s), and will compute the corresponding UTC time and include it below each xtick.

Definition at line 143 of file cplot.h.

int CPLOT_structPlotOptions::UTCOffset

The GPS/UTC offset (always +ve).

Definition at line 144 of file cplot.h.

BOOL CPLOT_structPlotOptions::plotStatistics

A boolean indicating if statistics are to be included in the figure.

Definition at line 146 of file cplot.h.

BOOL CPLOT_structPlotOptions::plotLabelOnRight

Place labels and statistics on the right of the plot. Otherwise below the plot.

Definition at line 148 of file cplot.h.

CPLOT_enumColor CPLOT_structPlotOptions::figureBackgroundColor

The figure background color.