casa::PMS Class Reference

Container class for useful constants/methods. More...

#include <PlotMSConstants.h>

Public Member Functions
	PMS_ENUM1 (Axis, axes, axesStrings, axis, SCAN, FIELD, TIME, TIME_INTERVAL, SPW, CHANNEL, FREQUENCY, VELOCITY, CORR, ANTENNA1, ANTENNA2, BASELINE, ROW, OBSERVATION, INTENT, FEED1, FEED2, AMP, PHASE, REAL, IMAG, WT, WTxAMP, WTSP, SIGMA, SIGMASP, FLAG, FLAG_ROW, UVDIST, UVDIST_L, U, V, W, UWAVE, VWAVE, WWAVE, AZ0, EL0, HA0, PA0, ANTENNA, AZIMUTH, ELEVATION, PARANG, GAMP, GPHASE, GREAL, GIMAG, DELAY, SWP, TSYS, OPAC, SNR, TEC, RADIAL_VELOCITY, RHO, NONE) PMS_ENUM2(Axis
	Enum for the axis choices that are available to be plotted.
Wt Ant Ant Ant Gain Gain Gain Gain Radial	Distance (rho)[km]"
	PMS_ENUM1 (DataColumn, dataColumns, dataColumnStrings, dataColumn, DATA, CORRECTED, MODEL, CORRMODEL, DATAMODEL, DATA_DIVIDE_MODEL, CORRECTED_DIVIDE_MODEL, FLOAT_DATA) PMS_ENUM2(DataColumn
	Enum for the different data columns for data axes.
	PMS_ENUM1 (AxisType, axesTypes, axesTypeStrings, axisType, TBOOL, TINT, TFLOAT, TDOUBLE, TTIME) PMS_ENUM2(AxisType
	Enum for different axes types.
	PMS_ENUM1 (AxisUnit, axesUnits, axesUnitStrings, axisUnit, UNONE, UDATETIME, GHERTZ, METERS_PER_SECOND, KILOMETERS_PER_SECOND, KILOMETERS, METERS, HOURS, WAVELENGTHS, DEGREES, NANOSECONDS, KELVIN, NEPERS, SECONDS)
	Enum for different axes units.
	PMS_ENUM2 (AxisUnit, axesUnits, axesUnitStrings, axisUnit,"","hh:mm:ss","GHz","m/s","km/s","km","m","hours","<html>λ</html>","degrees","ns","K","neper","s")
	PMS_ENUM1 (SummaryType, summaryTypes, summaryTypeStrings, summaryType, S_ALL, S_WHERE, S_WHAT, S_HOW, S_MAIN, S_TABLES, S_ANTENNA, S_FEED, S_FIELD, S_OBSERVATION, S_HISTORY, S_POLARIZATION, S_SOURCE, S_SPW, S_SPW_POL, S_SYSCAL, S_WEATHER) PMS_ENUM2(SummaryType
	Enum for the different MS summary types.
Static Public Member Functions
Wt Ant Ant Ant Gain Gain Gain Gain Radial static None PlotAxisScale	axisScale (Axis axis)
	Returns the axes scale for the given axis.
corrected data data corrected static float bool	axisIsData (Axis axis)
	Returns whether or not the given axis needs the second data parameter to indicate which data column to use or not.
static bool	axisNeedsCalSlice (Axis axis)
	Cal table axes which need validation/slicing for poln selection.
static bool	axisIsWeight (Axis axis)
	Need datacolumn for averaging weight axes.
static time AxisType	axisType (Axis axis)
	Returns the type for the given axis.
static AxisUnit	axisUnit (Axis axis)
	Returns the unit for the given axis.
static double	dateDouble (unsigned int year, unsigned int mon, unsigned int day, unsigned int hour, unsigned int min, double sec, PlotAxisScale scale=DATE_MJ_SEC)
	Convert to/from dates and doubles, using the given scale (must be either DATE_MJ_SEC or DATE_MJ_DAY).
static void	dateDouble (double value, unsigned int &year, unsigned int &mon, unsigned int &day, unsigned int &hour, unsigned int &min, double &sec, PlotAxisScale scale=DATE_MJ_SEC)
static bool	strEq (const String &str1, const String &str2, bool ignoreCase=false)
	Returns true if the given Strings are equals, false otherwise.
static bool	recEq (const Record &rec1, const Record &rec2)
	Returns true if the given Records are equals, false otherwise.
template<class T >
static Vector< int >	toIntVector (const vector< T > &v)
	Converts the given templated vector to/from an int Vector.
template<class T >
static vector< T >	fromIntVector (const Vector< int > &v)
Spectral Spectral Window and static Weather const vector < String > &	COLORS_LIST ()
	Enum for export range.
static PlotLinePtr	DEFAULT_GRID_LINE (PlotFactoryPtr factory)
static PlotSymbolPtr	DEFAULT_UNFLAGGED_SYMBOL (PlotFactoryPtr factory)
	Default values for PMS_PP_Display.
static PlotSymbolPtr	DEFAULT_FLAGGED_SYMBOL (PlotFactoryPtr factory)
static PlotSymbolPtr	NO_FLAGGED_SYMBOL (PlotFactoryPtr factory)
static std::map < PlotSymbol::Symbol, int >	SYMBOL_MINIMUM_SIZES ()
	Returns the minimum visible sizes for plot symbol types.
static PlotFontPtr	DEFAULT_ANNOTATION_TEXT_FONT (PlotFactoryPtr factory)
	Default text annotation properties.
static PlotLinePtr	DEFAULT_ANNOTATION_TEXT_OUTLINE (PlotFactoryPtr factory)
static PlotAreaFillPtr	DEFAULT_ANNOTATION_TEXT_BACKGROUND (PlotFactoryPtr factory)
static PlotLinePtr	DEFAULT_ANNOTATION_RECT_LINE (PlotFactoryPtr factory)
	Default rectangle annotation properties.
static PlotAreaFillPtr	DEFAULT_ANNOTATION_RECT_FILL (PlotFactoryPtr f)
Public Attributes
	axes
	axesStrings
	axis
	Scan
	Field
	Time
	Interval
	Spw
	Channel
	Frequency
	Velocity
	Corr
	Antenna1
	Antenna2
	Baseline
	Row
	Observation
	Intent
	Feed1
	Feed2
	Amp
	Phase
	Real
	Imag
	Wt
Wt *	Amp
Wt	WtSp
Wt	Sigma
Wt	SigmaSp
Wt	Flag
Wt	FlagRow
Wt	UVdist
Wt	UVwave
Wt	U
Wt	V
Wt	W
Wt	Uwave
Wt	Vwave
Wt	Wwave
Wt	Azimuth
Wt	Elevation
Wt	HourAngle
Wt	ParAngle
Wt	Antenna
Wt Ant	Azimuth
Wt Ant Ant	Elevation
Wt Ant Ant Ant	ParAngle
Wt Ant Ant Ant Gain	Amplitude
Wt Ant Ant Ant Gain Gain	Phase
Wt Ant Ant Ant Gain Gain Gain	Real
Wt Ant Ant Ant Gain Gain Gain Gain	Imag
Wt Ant Ant Ant Gain Gain Gain Gain	Delay
Wt Ant Ant Ant Gain Gain Gain Gain	SwPower
Wt Ant Ant Ant Gain Gain Gain Gain	Tsys
Wt Ant Ant Ant Gain Gain Gain Gain	Opac
Wt Ant Ant Ant Gain Gain Gain Gain	SNR
Wt Ant Ant Ant Gain Gain Gain Gain	TEC
Wt Ant Ant Ant Gain Gain Gain Gain Radial	Velocity [km/s]
	dataColumns
	dataColumnStrings
	dataColumn
	data
	corrected
	model
corrected	model
corrected data	model
corrected data data	model
corrected data data corrected	model
	axesTypes
	axesTypeStrings
	axisType
	boolean
	integer
	float
	double
	summaryTypes
	summaryTypeStrings
	summaryType
	All
	Where
	What
	How
	Main
	Tables
	Antenna
	Feed
	History
	Polarization
	Source
Spectral	Window
Spectral Spectral Window and	Polarization
Spectral Spectral Window and	SysCal
Static Public Attributes
static const String	DEFAULT_LOG_FILENAME
	Default Parameter Values //.
static const int	DEFAULT_LOG_EVENTS
static const LogMessage::Priority	DEFAULT_LOG_PRIORITY
static const bool	DEFAULT_CLEAR_SELECTIONS
static const int	DEFAULT_CACHED_IMAGE_WIDTH
static const int	DEFAULT_CACHED_IMAGE_HEIGHT
static const int	DEFAULT_GRID_ROWS
static const int	DEFAULT_GRID_COLS
static const Axis	DEFAULT_XAXIS
	Default values for PMS_PP_Cache.
static const Axis	DEFAULT_YAXIS
static const DataColumn	DEFAULT_DATACOLUMN
static const DataColumn	DEFAULT_DATACOLUMN_WT
static const Axis	DEFAULT_COLOR_AXIS
static const PlotAxis	DEFAULT_CANVAS_XAXIS
	Default values for PMS_PP_Canvas.
static const PlotAxis	DEFAULT_CANVAS_YAXIS
static const String	DEFAULT_CANVAS_AXIS_LABEL_FORMAT
static const bool	DEFAULT_FONTSET
static const int	DEFAULT_FONT
static const bool	DEFAULT_SHOWAXIS
static const bool	DEFAULT_SHOWLEGEND
static const PlotCanvas::LegendPosition	DEFAULT_LEGENDPOSITION
static const bool	DEFAULT_SHOW_GRID
static const String	DEFAULT_TITLE_FORMAT
static const ExportRange	DEFAULT_EXPORT_RANGE
	Default values for export range;.
static const String	LOG_ORIGIN
	Logging Constants //.
static const String	LOG_ORIGIN_DBUS
	Log event origin names.
static const String	LOG_ORIGIN_FLAG
static const String	LOG_ORIGIN_LOAD_CACHE
static const String	LOG_ORIGIN_LOCATE
static const String	LOG_ORIGIN_PARAMS_CHANGED
static const String	LOG_ORIGIN_PLOT
static const String	LOG_ORIGIN_RELEASE_CACHE
static const String	LOG_ORIGIN_UNFLAG
static const String	LOG_ORIGIN_SUMMARY
static const int	LOG_EVENT_DBUS
	Log event flags.
static const int	LOG_EVENT_FLAG
static const int	LOG_EVENT_LOAD_CACHE
static const int	LOG_EVENT_LOCATE
static const int	LOG_EVENT_PARAMS_CHANGED
static const int	LOG_EVENT_PLOT
static const int	LOG_EVENT_RELEASE_CACHE
static const int	LOG_EVENT_UNFLAG
static const int	LOG_EVENT_SUMMARY

Detailed Description

Container class for useful constants/methods.

Definition at line 102 of file PlotMSConstants.h.

Member Function Documentation

corrected data data corrected static float bool casa::PMS::axisIsData ( Axis axis ) [static]

Returns whether or not the given axis needs the second data parameter to indicate which data column to use or not.

Currently false except for AMP, PHASE, REAL, and IMAG.

Type Constraints

static bool casa::PMS::axisIsWeight ( Axis axis ) [static]

Need datacolumn for averaging weight axes.

static bool casa::PMS::axisNeedsCalSlice ( Axis axis ) [static]

Cal table axes which need validation/slicing for poln selection.

Wt Ant Ant Ant Gain Gain Gain Gain Radial static None PlotAxisScale casa::PMS::axisScale ( Axis axis ) [static]

Returns the axes scale for the given axis.

Currently NORMAL unless the axis is TIME, in which case the scale is DATE_MJ_SEC.

static time AxisType casa::PMS::axisType ( Axis axis ) [static]

Returns the type for the given axis.

Type Constraints

static AxisUnit casa::PMS::axisUnit ( Axis axis ) [static]

Returns the unit for the given axis.

Spectral Spectral Window and static Weather const vector<String>& casa::PMS::COLORS_LIST ( ) [static]

Enum for export range.

Colorizing Values //

Returns the list of unique colors used to colorize plots.

Type Constraints

static void casa::PMS::dateDouble	(	double	value,
		unsigned int &	year,
		unsigned int &	mon,
		unsigned int &	day,
		unsigned int &	hour,
		unsigned int &	min,
		double &	sec,
		PlotAxisScale	scale = `DATE_MJ_SEC`
	)			`[static]`

static double casa::PMS::dateDouble	(	unsigned int	year,
		unsigned int	mon,
		unsigned int	day,
		unsigned int	hour,
		unsigned int	min,
		double	sec,
		PlotAxisScale	scale = `DATE_MJ_SEC`
	)			`[static]`

Convert to/from dates and doubles, using the given scale (must be either DATE_MJ_SEC or DATE_MJ_DAY).

static PlotAreaFillPtr casa::PMS::DEFAULT_ANNOTATION_RECT_FILL ( PlotFactoryPtr f ) [static]

static PlotLinePtr casa::PMS::DEFAULT_ANNOTATION_RECT_LINE ( PlotFactoryPtr factory ) [static]

Default rectangle annotation properties.

static PlotAreaFillPtr casa::PMS::DEFAULT_ANNOTATION_TEXT_BACKGROUND ( PlotFactoryPtr factory ) [static]

static PlotFontPtr casa::PMS::DEFAULT_ANNOTATION_TEXT_FONT ( PlotFactoryPtr factory ) [static]

Default text annotation properties.

static PlotLinePtr casa::PMS::DEFAULT_ANNOTATION_TEXT_OUTLINE ( PlotFactoryPtr factory ) [static]

static PlotSymbolPtr casa::PMS::DEFAULT_FLAGGED_SYMBOL ( PlotFactoryPtr factory ) [static]

Referenced by casa::PMS_PP_Display::flaggedSymbol().

static PlotLinePtr casa::PMS::DEFAULT_GRID_LINE ( PlotFactoryPtr factory ) [static]

static PlotSymbolPtr casa::PMS::DEFAULT_UNFLAGGED_SYMBOL ( PlotFactoryPtr factory ) [static]

Default values for PMS_PP_Display.

Referenced by casa::PMS_PP_Display::unflaggedSymbol().

Wt Ant Ant Ant Gain Gain Gain Gain Radial casa::PMS::Distance ( rho )

Type Constraints

template<class T >

static vector<T> casa::PMS::fromIntVector ( const Vector< int > & v ) [inline, static]

Definition at line 226 of file PlotMSConstants.h.

static PlotSymbolPtr casa::PMS::NO_FLAGGED_SYMBOL ( PlotFactoryPtr factory ) [static]

casa::PMS::PMS_ENUM1	(	SummaryType	,
		summaryTypes	,
		summaryTypeStrings	,
		summaryType	,
		S_ALL	,
		S_WHERE	,
		S_WHAT	,
		S_HOW	,
		S_MAIN	,
		S_TABLES	,
		S_ANTENNA	,
		S_FEED	,
		S_FIELD	,
		S_OBSERVATION	,
		S_HISTORY	,
		S_POLARIZATION	,
		S_SOURCE	,
		S_SPW	,
		S_SPW_POL	,
		S_SYSCAL	,
		S_WEATHER
	)

Enum for the different MS summary types.

casa::PMS::PMS_ENUM1	(	AxisUnit	,
		axesUnits	,
		axesUnitStrings	,
		axisUnit	,
		UNONE	,
		UDATETIME	,
		GHERTZ	,
		METERS_PER_SECOND	,
		KILOMETERS_PER_SECOND	,
		KILOMETERS	,
		METERS	,
		HOURS	,
		WAVELENGTHS	,
		DEGREES	,
		NANOSECONDS	,
		KELVIN	,
		NEPERS	,
		SECONDS
	)

Enum for different axes units.

Currently only used in labels.

casa::PMS::PMS_ENUM1	(	AxisType	,
		axesTypes	,
		axesTypeStrings	,
		axisType	,
		TBOOL	,
		TINT	,
		TFLOAT	,
		TDOUBLE	,
		TTIME
	)

Enum for different axes types.

Currently only used to display this information to the user in the GUI's cache tab.

casa::PMS::PMS_ENUM1	(	DataColumn	,
		dataColumns	,
		dataColumnStrings	,
		dataColumn	,
		DATA	,
		CORRECTED	,
		MODEL	,
		CORRMODEL	,
		DATAMODEL	,
		DATA_DIVIDE_MODEL	,
		CORRECTED_DIVIDE_MODEL	,
		FLOAT_DATA
	)

Enum for the different data columns for data axes.

If these are changed, also update: xmlcasa/tasks/plotms.xml.**

casa::PMS::PMS_ENUM1	(	Axis	,
		axes	,
		axesStrings	,
		axis	,
		SCAN	,
		FIELD	,
		TIME	,
		TIME_INTERVAL	,
		SPW	,
		CHANNEL	,
		FREQUENCY	,
		VELOCITY	,
		CORR	,
		ANTENNA1	,
		ANTENNA2	,
		BASELINE	,
		ROW	,
		OBSERVATION	,
		INTENT	,
		FEED1	,
		FEED2	,
		AMP	,
		PHASE	,
		REAL	,
		IMAG	,
		WT	,
		WTxAMP	,
		WTSP	,
		SIGMA	,
		SIGMASP	,
		FLAG	,
		FLAG_ROW	,
		UVDIST	,
		UVDIST_L	,
		U	,
		V	,
		W	,
		UWAVE	,
		VWAVE	,
		WWAVE	,
		AZ0	,
		EL0	,
		HA0	,
		PA0	,
		ANTENNA	,
		AZIMUTH	,
		ELEVATION	,
		PARANG	,
		GAMP	,
		GPHASE	,
		GREAL	,
		GIMAG	,
		DELAY	,
		SWP	,
		TSYS	,
		OPAC	,
		SNR	,
		TEC	,
		RADIAL_VELOCITY	,
		RHO	,
		NONE
	)

Enum for the axis choices that are available to be plotted.

Used both by the user to select what to plot and by the cache loading system. If these are changed, also update: xmlcasa/tasks/plotms.xml, xmlcasa/scripts/task_plotms.py.**

casa::PMS::PMS_ENUM2	(	AxisUnit	,
		axesUnits	,
		axesUnitStrings	,
		axisUnit	,
		""	,
		"hh:mm:ss"	,
		"GHz"	,
		"m/s"	,
		"km/s"	,
		"km"	,
		"m"	,
		"hours"	,
		"<html>λ</html>"	,
		"degrees"	,
		"ns"	,
		"K"	,
		"neper"	,
		"s"
	)