casa  $Rev:20696$
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Static Public Member Functions | Public Attributes | Static Public Attributes
casa::PMS Class Reference

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

#include <PlotMSConstants.h>

List of all members.

Public Member Functions

 PMS_ENUM1 (Axis, axes, axesStrings, axis, SCAN, FIELD, TIME, TIME_INTERVAL, SPW, CHANNEL, FREQUENCY, VELOCITY, CORR, ANTENNA1, ANTENNA2, BASELINE, ROW, AMP, PHASE, REAL, IMAG, WT, WTxAMP, 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, NONE) PMS_ENUM2(Axis
 Enum for the axis choices that are available to be plotted.
 PMS_ENUM1 (DataColumn, dataColumns, dataColumnStrings, dataColumn, DATA, CORRECTED, MODEL, CORRMODEL, DATAMODEL) 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) PMS_ENUM2(AxisUnit
 Enum for different axes units.
 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 static None
PlotAxisScale 
axisScale (Axis axis)
 Returns the axes scale for the given axis.
corrected data static model 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 time AxisType axisType (Axis axis)
 Returns the type for the given axis.
date static time 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 ()
 Colorizing Values //.
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 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
 Amp
 Phase
 Real
 Imag
 Wt
WtAmp
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 GainAmp
Wt Ant Ant Ant GainPhase
Wt Ant Ant Ant GainReal
Wt Ant Ant Ant GainImag
Wt Ant Ant Ant Delay
Wt Ant Ant Ant SwPower
Wt Ant Ant Ant Tsys
Wt Ant Ant Ant Opac
 dataColumns
 dataColumnStrings
 dataColumn
 data
 corrected
 model
corrected model
 axesTypes
 axesTypeStrings
 axisType
 boolean
 integer
 float
 double
 axesUnits
 axesUnitStrings
 axisUnit
 summaryTypes
 summaryTypeStrings
 summaryType
 All
 Where
 What
 How
 Main
 Tables
 Antenna
 Feed
 Observation
 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 Axis DEFAULT_XAXIS
 Default values for PMS_PP_Cache.
static const Axis DEFAULT_YAXIS
static const DataColumn DEFAULT_DATACOLUMN
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_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 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 105 of file PlotMSConstants.h.


Member Function Documentation

corrected data static model 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.

Wt Ant Ant Ant 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.

date static time 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]

Colorizing Values //.

Returns the list of unique colors used to colorize plots.

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 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]

Default rectangle annotation properties.

Default text annotation properties.

Default values for PMS_PP_Display.

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

Definition at line 216 of file PlotMSConstants.h.

References casa::ArrayBase::size().

casa::PMS::PMS_ENUM1 ( Axis  ,
axes  ,
axesStrings  ,
axis  ,
SCAN  ,
FIELD  ,
TIME  ,
TIME_INTERVAL  ,
SPW  ,
CHANNEL  ,
FREQUENCY  ,
VELOCITY  ,
CORR  ,
ANTENNA1  ,
ANTENNA2  ,
BASELINE  ,
ROW  ,
AMP  ,
PHASE  ,
REAL  ,
IMAG  ,
WT  ,
WTxAMP  ,
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  ,
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_ENUM1 ( DataColumn  ,
dataColumns  ,
dataColumnStrings  ,
dataColumn  ,
DATA  ,
CORRECTED  ,
MODEL  ,
CORRMODEL  ,
DATAMODEL   
)

Enum for the different data columns for data axes.

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

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 ( AxisUnit  ,
axesUnits  ,
axesUnitStrings  ,
axisUnit  ,
UNONE  ,
UDATETIME   
)

Enum for different axes units.

Currently only used in labels.

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.

static bool casa::PMS::recEq ( const Record rec1,
const Record rec2 
) [static]

Returns true if the given Records are equals, false otherwise.

static bool casa::PMS::strEq ( const String str1,
const String str2,
bool  ignoreCase = false 
) [static]

Returns true if the given Strings are equals, false otherwise.

If ignoreCase is false then it is a direct String comparison using ==; otherwise the String characters are compared while ignoring case for letters.

static map<PlotSymbol::Symbol, int> casa::PMS::SYMBOL_MINIMUM_SIZES ( ) [static]

Returns the minimum visible sizes for plot symbol types.

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

Converts the given templated vector to/from an int Vector.

Definition at line 209 of file PlotMSConstants.h.


Member Data Documentation

Definition at line 232 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 232 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 165 of file PlotMSConstants.h.

Definition at line 165 of file PlotMSConstants.h.

Definition at line 177 of file PlotMSConstants.h.

Definition at line 177 of file PlotMSConstants.h.

Definition at line 165 of file PlotMSConstants.h.

Definition at line 177 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 165 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 150 of file PlotMSConstants.h.

Definition at line 150 of file PlotMSConstants.h.

Definition at line 150 of file PlotMSConstants.h.

Definition at line 150 of file PlotMSConstants.h.

Definition at line 150 of file PlotMSConstants.h.

Definition at line 255 of file PlotMSConstants.h.

Definition at line 254 of file PlotMSConstants.h.

Definition at line 270 of file PlotMSConstants.h.

Default values for PMS_PP_Canvas.

Definition at line 268 of file PlotMSConstants.h.

Definition at line 269 of file PlotMSConstants.h.

Definition at line 253 of file PlotMSConstants.h.

const Axis casa::PMS::DEFAULT_COLOR_AXIS [static]

Definition at line 263 of file PlotMSConstants.h.

const DataColumn casa::PMS::DEFAULT_DATACOLUMN [static]

Definition at line 262 of file PlotMSConstants.h.

Definition at line 273 of file PlotMSConstants.h.

const int casa::PMS::DEFAULT_LOG_EVENTS [static]

Definition at line 251 of file PlotMSConstants.h.

Default Parameter Values //.

Default values for PlotMSParameters.

Definition at line 250 of file PlotMSConstants.h.

Definition at line 252 of file PlotMSConstants.h.

const bool casa::PMS::DEFAULT_SHOW_GRID [static]

Definition at line 274 of file PlotMSConstants.h.

const bool casa::PMS::DEFAULT_SHOWAXIS [static]

Definition at line 271 of file PlotMSConstants.h.

const bool casa::PMS::DEFAULT_SHOWLEGEND [static]

Definition at line 272 of file PlotMSConstants.h.

Definition at line 276 of file PlotMSConstants.h.

const Axis casa::PMS::DEFAULT_XAXIS [static]

Default values for PMS_PP_Cache.

Definition at line 260 of file PlotMSConstants.h.

const Axis casa::PMS::DEFAULT_YAXIS [static]

Definition at line 261 of file PlotMSConstants.h.

Wt Ant Ant Ant casa::PMS::Delay

Definition at line 125 of file PlotMSConstants.h.

Definition at line 165 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 232 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 165 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Wt Ant Ant Ant casa::PMS::GainAmp

Definition at line 125 of file PlotMSConstants.h.

Wt Ant Ant Ant casa::PMS::GainImag

Definition at line 125 of file PlotMSConstants.h.

Wt Ant Ant Ant casa::PMS::GainPhase

Definition at line 125 of file PlotMSConstants.h.

Wt Ant Ant Ant casa::PMS::GainReal

Definition at line 125 of file PlotMSConstants.h.

Definition at line 232 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 232 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 165 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

const int casa::PMS::LOG_EVENT_DBUS [static]

Log event flags.

Definition at line 323 of file PlotMSConstants.h.

const int casa::PMS::LOG_EVENT_FLAG [static]

Definition at line 324 of file PlotMSConstants.h.

Referenced by casa::PlotMSCacheBase::logFlag().

const int casa::PMS::LOG_EVENT_LOAD_CACHE [static]

Definition at line 325 of file PlotMSConstants.h.

Referenced by casa::PlotMSCacheBase::logLoad().

const int casa::PMS::LOG_EVENT_LOCATE [static]

Definition at line 326 of file PlotMSConstants.h.

Definition at line 327 of file PlotMSConstants.h.

const int casa::PMS::LOG_EVENT_PLOT [static]

Definition at line 328 of file PlotMSConstants.h.

Definition at line 329 of file PlotMSConstants.h.

const int casa::PMS::LOG_EVENT_SUMMARY [static]

Definition at line 331 of file PlotMSConstants.h.

const int casa::PMS::LOG_EVENT_UNFLAG [static]

Definition at line 330 of file PlotMSConstants.h.

const String casa::PMS::LOG_ORIGIN [static]

Logging Constants //.

Log class origin.

Definition at line 306 of file PlotMSConstants.h.

Log event origin names.

Definition at line 310 of file PlotMSConstants.h.

Definition at line 311 of file PlotMSConstants.h.

Referenced by casa::PlotMSCacheBase::logFlag().

Definition at line 312 of file PlotMSConstants.h.

Referenced by casa::PlotMSCacheBase::logLoad().

Definition at line 313 of file PlotMSConstants.h.

Definition at line 314 of file PlotMSConstants.h.

Definition at line 315 of file PlotMSConstants.h.

Definition at line 316 of file PlotMSConstants.h.

Definition at line 318 of file PlotMSConstants.h.

Definition at line 317 of file PlotMSConstants.h.

Definition at line 232 of file PlotMSConstants.h.

Definition at line 150 of file PlotMSConstants.h.

Definition at line 150 of file PlotMSConstants.h.

Definition at line 232 of file PlotMSConstants.h.

Wt Ant Ant Ant casa::PMS::Opac

Definition at line 125 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Wt Ant Ant Ant casa::PMS::ParAngle

Definition at line 125 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 232 of file PlotMSConstants.h.

Spectral Spectral Window and casa::PMS::Polarization

Definition at line 232 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 232 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 232 of file PlotMSConstants.h.

Definition at line 232 of file PlotMSConstants.h.

Definition at line 232 of file PlotMSConstants.h.

Wt Ant Ant Ant casa::PMS::SwPower

Definition at line 125 of file PlotMSConstants.h.

Spectral Spectral Window and casa::PMS::SysCal

Definition at line 232 of file PlotMSConstants.h.

Definition at line 232 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Wt Ant Ant Ant casa::PMS::Tsys

Definition at line 125 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 232 of file PlotMSConstants.h.

Definition at line 232 of file PlotMSConstants.h.

Definition at line 232 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.

Definition at line 125 of file PlotMSConstants.h.


The documentation for this class was generated from the following file: