casa  $Rev:20696$
Public Member Functions | Private Attributes
casa::PlotMSData Class Reference

Layer between plot cache and the rest of PlotMS and the GenericPlotter classes. More...

#include <PlotMSData.h>

Inheritance diagram for casa::PlotMSData:
casa::PlotMaskedPointData casa::PlotPointData casa::PlotData

List of all members.

Public Member Functions

 PlotMSData (PlotMSApp *plotms)
 Constructor which takes the parent PlotMS.
 PlotMSData (const PlotMSData &copy)
 Copy constructor.
 ~PlotMSData ()
 Destructor.
void setCache (PlotMSCache *cache)
 Set the internal cache.
bool willDeleteData () const
 Implemented PlotData methods.
void setDeleteData (bool del=true)
 Sets whether this object will delete its underlying data structures upon deconstruction or not.
bool isValid () const
 ABSTRACT METHODS //.
unsigned int size () const
 Implemented PlotPointData methods.
double xAt (unsigned int i) const
 Returns the x value at the given index.
double yAt (unsigned int i) const
 Returns the y value at the given index.
void xAndYAt (unsigned int index, double &x, double &y) const
 IMPLEMENTED METHODS //.
bool minsMaxes (double &xMin, double &xMax, double &yMin, double &yMax)
 Gets the minimum and maximum values.
bool maskedAt (unsigned int index) const
 Implemented PlotMaskedPointData methods.
void xyAndMaskAt (unsigned int index, double &x, double &y, bool &mask) const
 IMPLEMENTED METHODS //.
unsigned int sizeMasked () const
 Unimplemented PlotMaskedPointData methods.
unsigned int sizeUnmasked () const
 Returns the number of unmasked points.
bool maskedMinsMaxes (double &xMin, double &xMax, double &yMin, double &yMax)
 Gets the mins/maxes for just the masked points.
bool unmaskedMinsMaxes (double &xMin, double &xMax, double &yMin, double &yMax)
 Gets the mins/maxes for just the unmasked points.
unsigned int numBins () const
 Implemented PlotBinnedData methods.
unsigned int binAt (unsigned int i) const
bool isBinned () const
bool colorize (bool doColorize, PMS::Axis colorizeAxis)
 Tells the cache what to colorize on, on the next draw.
bool hasReferenceValue (PMS::Axis axis)
 Returns the reference value for the given axis, if applicable.
double referenceValue (PMS::Axis axis)
bool cacheReady () const
 See PlotMSCache::readyForPlotting().
void clearCache ()
 See PlotMSCache::clear().
void loadCache (const vector< PMS::Axis > &axes, const vector< PMS::DataColumn > &data, const String &msname, const PlotMSSelection &selection, const PlotMSAveraging &averaging, const PlotMSTransformations &transformations, PlotMSCacheThread *thread=NULL)
 Loads values into the cache using the given vis set, with the given axes used for x and y values.
void setupCache (PMS::Axis xAxis, PMS::Axis yAxis)
 See PlotMSCache::setUpPlot().
void releaseCache (const vector< PMS::Axis > &axes)
 See PlotMSCache::release().
PlotLogMessagelocateRange (const Vector< PlotRegion > &regions)
 See PlotMSCache::locateRange().
PlotLogMessageflagRange (const PlotMSFlagging &flagging, const Vector< PlotRegion > &regions, bool flag=true)
 See PlotMSCache::flagRange().
vector< pair< PMS::Axis,
unsigned int > > 
loadedAxes () const
 See PlotMSCache::loadedAxes().
PlotMSDataoperator= (const PlotMSData &copy)
 Copy operator.

Private Attributes

PlotMSAppitsPlotms_
 Parent.
PlotMSCachePtr itsCache_
 Cache.
PlotMSCachePtr itsMSCache_
PlotMSCachePtr itsCalCache_
PlotMSCacheIndexerPtr itsIndexer_
 Indexer.
bool itsColorize_
 Last set colorizing parameters.
PMS::Axis itsColorizeAxis_

Detailed Description

Layer between plot cache and the rest of PlotMS and the GenericPlotter classes.

Definition at line 46 of file PlotMSData.h.


Constructor & Destructor Documentation

casa::PlotMSData::PlotMSData ( PlotMSApp plotms)

Constructor which takes the parent PlotMS.

casa::PlotMSData::PlotMSData ( const PlotMSData copy)

Copy constructor.

See operator=().

casa::PlotMSData::~PlotMSData ( )

Destructor.


Member Function Documentation

unsigned int casa::PlotMSData::binAt ( unsigned int  i) const
bool casa::PlotMSData::cacheReady ( ) const
void casa::PlotMSData::clearCache ( )
bool casa::PlotMSData::colorize ( bool  doColorize,
PMS::Axis  colorizeAxis 
)

Tells the cache what to colorize on, on the next draw.

Returns whether the plot needs to be redrawn or not.

PlotLogMessage* casa::PlotMSData::flagRange ( const PlotMSFlagging flagging,
const Vector< PlotRegion > &  regions,
bool  flag = true 
)
bool casa::PlotMSData::hasReferenceValue ( PMS::Axis  axis)

Returns the reference value for the given axis, if applicable.

bool casa::PlotMSData::isBinned ( ) const
bool casa::PlotMSData::isValid ( ) const [virtual]

ABSTRACT METHODS //.

Returns whether the contained data is valid or not.

Implements casa::PlotData.

void casa::PlotMSData::loadCache ( const vector< PMS::Axis > &  axes,
const vector< PMS::DataColumn > &  data,
const String msname,
const PlotMSSelection selection,
const PlotMSAveraging averaging,
const PlotMSTransformations transformations,
PlotMSCacheThread thread = NULL 
)

Loads values into the cache using the given vis set, with the given axes used for x and y values.

See PlotMSCache::load().

vector<pair<PMS::Axis, unsigned int> > casa::PlotMSData::loadedAxes ( ) const
PlotLogMessage* casa::PlotMSData::locateRange ( const Vector< PlotRegion > &  regions)
bool casa::PlotMSData::maskedAt ( unsigned int  index) const [virtual]

Implemented PlotMaskedPointData methods.

Implements casa::PlotMaskedPointData.

bool casa::PlotMSData::maskedMinsMaxes ( double &  xMin,
double &  xMax,
double &  yMin,
double &  yMax 
) [inline, virtual]

Gets the mins/maxes for just the masked points.

Implements casa::PlotMaskedPointData.

Definition at line 87 of file PlotMSData.h.

bool casa::PlotMSData::minsMaxes ( double &  xMin,
double &  xMax,
double &  yMin,
double &  yMax 
) [virtual]

Gets the minimum and maximum values.

Returns false for error.

Implements casa::PlotPointData.

unsigned int casa::PlotMSData::numBins ( ) const

Implemented PlotBinnedData methods.

PlotMSData& casa::PlotMSData::operator= ( const PlotMSData copy)

Copy operator.

double casa::PlotMSData::referenceValue ( PMS::Axis  axis)
void casa::PlotMSData::releaseCache ( const vector< PMS::Axis > &  axes)
void casa::PlotMSData::setCache ( PlotMSCache cache) [inline]

Set the internal cache.

Definition at line 58 of file PlotMSData.h.

void casa::PlotMSData::setDeleteData ( bool  del = true) [inline, virtual]

Sets whether this object will delete its underlying data structures upon deconstruction or not.

Implements casa::PlotData.

Definition at line 63 of file PlotMSData.h.

void casa::PlotMSData::setupCache ( PMS::Axis  xAxis,
PMS::Axis  yAxis 
)

See PlotMSCache::setUpPlot().

unsigned int casa::PlotMSData::size ( ) const [virtual]

Implemented PlotPointData methods.

Implements casa::PlotPointData.

unsigned int casa::PlotMSData::sizeMasked ( ) const [inline, virtual]

Unimplemented PlotMaskedPointData methods.

Implements casa::PlotMaskedPointData.

Definition at line 85 of file PlotMSData.h.

unsigned int casa::PlotMSData::sizeUnmasked ( ) const [inline, virtual]

Returns the number of unmasked points.

Implements casa::PlotMaskedPointData.

Definition at line 86 of file PlotMSData.h.

bool casa::PlotMSData::unmaskedMinsMaxes ( double &  xMin,
double &  xMax,
double &  yMin,
double &  yMax 
) [inline, virtual]

Gets the mins/maxes for just the unmasked points.

Implements casa::PlotMaskedPointData.

Definition at line 89 of file PlotMSData.h.

bool casa::PlotMSData::willDeleteData ( ) const [inline, virtual]

Implemented PlotData methods.

Implements casa::PlotData.

Definition at line 62 of file PlotMSData.h.

void casa::PlotMSData::xAndYAt ( unsigned int  index,
double &  x,
double &  y 
) const [virtual]

IMPLEMENTED METHODS //.

Gets the x and y values at the given index. Default implementation just calls xAt and yAt, but in subclasses where performance could be gained, this method should be overridden. Implementations for plots that use PlotPointData should use this method by default in case there are performance gains.

Reimplemented from casa::PlotPointData.

double casa::PlotMSData::xAt ( unsigned int  i) const [virtual]

Returns the x value at the given index.

Implements casa::PlotPointData.

void casa::PlotMSData::xyAndMaskAt ( unsigned int  index,
double &  x,
double &  y,
bool &  mask 
) const [virtual]

IMPLEMENTED METHODS //.

Gets the x and y values and the mask at the given index. See PlotPointData::xAndYAt().

Reimplemented from casa::PlotMaskedPointData.

double casa::PlotMSData::yAt ( unsigned int  i) const [virtual]

Returns the y value at the given index.

Implements casa::PlotPointData.


Member Data Documentation

Cache.

Definition at line 167 of file PlotMSData.h.

Definition at line 169 of file PlotMSData.h.

Last set colorizing parameters.

Definition at line 176 of file PlotMSData.h.

Definition at line 177 of file PlotMSData.h.

Indexer.

Definition at line 172 of file PlotMSData.h.

Definition at line 168 of file PlotMSData.h.

Parent.

Definition at line 164 of file PlotMSData.h.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines