casa::TblAsXYDD Class Reference
[DisplayDatas_internal_classes]

#include <TblAsXYDD.h>

Inheritance diagram for casa::TblAsXYDD:

[legend]Collaboration diagram for casa::TblAsXYDD:

[legend]List of all members.

Detailed Description

Class for displaying data within a table as a xy image.

Intended use:

Internal or<h3>Intended use: Internal

Prerequisite

Etymology

"TblAsXYDD" is a implementation of a ActiveCaching2dDD which provides for the display of data held within a table to be displayed as a xy image in an environment where individual depictions of the data are automatically cached.

Synopsis

This class adds to the interface defined in DisplayData . It adds the capability to display data from a Table column as a xy image. It is assumed that the Y axis is defined to be either the row number of the table column being displayed or the scalar value from the same row number in a different table column (e.g. plotting intensity as a function of frequency against row number or time determined from a different column of the table). The X axis is assumed to be the data in a scalar table column.

Example

A TblAsXYDD object could be construed and used as follows:

       TblAsXYDD *tardd1 = 0;
       tardd1 = new TblAsXYDD("tablename");
       Colormap cmap1("Hot Metal 2");
       tardd1->setColormap(&cmap1, 1.0);
       wcHolder->addDisplayData((DisplayData *)tardd1);

Motivation

To allow the display of data from a table as a xy image.

Template Type Argument Requirements (T)

Thrown Exceptions

To Do

make sure complex data are handled correctly
make sure table column units can be determined properly
make sure a scalar table column can be used for y axis
extend to n-dimensional arrays in table column
when constructed with *table we need to keep table from being deleted
handle movie axis once ActiveCachingNDim exists
implement showValue()
be able to derive xy plot data from columns with arrays
choose whether to draw points, lines or both

Definition at line 115 of file TblAsXYDD.h.

Public Member Functions

TblAsXYDD (Table *table)

constructors given an already constructed table

TblAsXYDD (const String tablename)

given a string which gives the full pathname and filename of a table on disk

virtual ~TblAsXYDD ()

Destructor.

virtual String showValue (const Vector< Double > &world)

format the table value at the give world position

virtual const Unit dataUnit (const String column)

get the data unit

virtual const Unit dataUnit ()

virtual void setDefaultOptions ()

install the default options for this DisplayData

virtual Bool setOptions (Record &rec, Record &recOut)

Apply options stored in rec to the DisplayData.

virtual Record getOptions ()

Retrieve the current and default options and parameter types.

virtual Display::DisplayDataType classType ()

Return the type of this DisplayData.

virtual CachingDisplayMethod * newDisplayMethod (WorldCanvas *worldCanvas, AttributeBuffer *wchAttributes, AttributeBuffer *ddAttributes, CachingDisplayData *dd)

Create a new TblAsXyDM for drawing on the given WorldCanvas when the AttributeBuffers are suitably matched to the current state of this DisplayData and of the WorldCanvas/Holder.

virtual AttributeBuffer optionsAsAttributes ()

Return the current options of this DisplayData as an AttributeBuffer.

Table * table ()

provide read-only access to the table

virtual void cleanup ()

Clean up (ie.

Protected Member Functions

TblAsXYDD ()

(Required) default constructor.

TblAsXYDD (const TblAsXYDD &other)

(Required) copy constructor.

void operator= (const TblAsXYDD &other)

(Required) copy assignment.

template<class T>

Bool getTableKeyword (T &value, const String keyword) const

Get the value of the named keyword, or the first keyword matching regex, and return it in value.

template<class T>

Bool getTableKeyword (T &value, const Regex &regex) const

template<class T>

Bool getColumnKeyword (T &value, const String column, const String keyword) const

Get the value of the named keyword, or the first keyword matching regex for the named column, and return it in value.

template<class T>

Bool getColumnKeyword (T &value, const String column, const Regex &regex) const

Private Member Functions

void installDefaultOptions ()

set the default options for this display data

Bool arrangeQueryTable ()

Arrange the query table (called after changing an option).

void getCoordinateSystem ()

update/set the coordinate system

void setCoordinateSystem ()

void getTableColumnNames ()

get all of the table columnNames

Vector< double > columnStatistics (const String &columnName)

get the table column world coordinate range

Vector< String > getColumnNamesOfType ()

get all of the table columnNames with a certain data type

void constructParameters ()

Construct and destruct the parameter set.

void destructParameters ()

Private Attributes

Table * itsTable

The table to be displayed.

Table * itsQueryTable

The result from a table query.

Vector< String > itsColumnNames

store all the table column names

DParameterChoice * itsXColumnName

what columns are we displaying and do we have a movie axis available

DParameterChoice * itsYColumnName

DParameterChoice * itsMColumnName

DParameterChoice * itsMColumnSet

String itsOptQueryString

options - what is the query string and is it unset?

Bool itsOptQueryStringUnset

CoordinateSystem itsCoord

holder for the current coordinate system

Vector< Double > itsLinblc

Vector< Double > itsLintrc

Friends

class TblAsXYDM

Constructor & Destructor Documentation

casa::TblAsXYDD::TblAsXYDD ( Table * table )

constructors given an already constructed table

casa::TblAsXYDD::TblAsXYDD ( const String tablename )

given a string which gives the full pathname and filename of a table on disk

virtual casa::TblAsXYDD::~TblAsXYDD ( ) [virtual]

Destructor.

casa::TblAsXYDD::TblAsXYDD ( ) [protected]

(Required) default constructor.

casa::TblAsXYDD::TblAsXYDD ( const TblAsXYDD & other ) [protected]

(Required) copy constructor.

Member Function Documentation

virtual String casa::TblAsXYDD::showValue ( const Vector< Double > & world ) [virtual]

format the table value at the give world position

Implements casa::DisplayData.

virtual const Unit casa::TblAsXYDD::dataUnit ( const String column ) [virtual]

get the data unit

virtual const Unit casa::TblAsXYDD::dataUnit ( ) [virtual]

Implements casa::DisplayData.

virtual void casa::TblAsXYDD::setDefaultOptions ( ) [virtual]

install the default options for this DisplayData

Reimplemented from casa::ActiveCaching2dDD.

virtual Bool casa::TblAsXYDD::setOptions	(	Record &	rec,
		Record &	recOut
	)			`[virtual]`

Apply options stored in rec to the DisplayData.

A return value of True means a refresh is needed. recOut contains any fields which were implicitly changed as a result of the call to this function.

Reimplemented from casa::ActiveCaching2dDD.

virtual Record casa::TblAsXYDD::getOptions ( ) [virtual]

Retrieve the current and default options and parameter types.

Reimplemented from casa::ActiveCaching2dDD.

virtual Display::DisplayDataType casa::TblAsXYDD::classType ( ) [inline, virtual]

Return the type of this DisplayData.

Implements casa::DisplayData.

Definition at line 150 of file TblAsXYDD.h.

References casa::Display::Vector.

virtual CachingDisplayMethod* casa::TblAsXYDD::newDisplayMethod	(	WorldCanvas *	worldCanvas,
		AttributeBuffer *	wchAttributes,
		AttributeBuffer *	ddAttributes,
		CachingDisplayData *	dd
	)			`[virtual]`

Create a new TblAsXyDM for drawing on the given WorldCanvas when the AttributeBuffers are suitably matched to the current state of this DisplayData and of the WorldCanvas/Holder.

The tag is a unique number used to identify the age of the newly constructed CachingDisplayMethod.

Implements casa::CachingDisplayData.

virtual AttributeBuffer casa::TblAsXYDD::optionsAsAttributes ( ) [virtual]

Return the current options of this DisplayData as an AttributeBuffer.

Reimplemented from casa::ActiveCaching2dDD.

Table* casa::TblAsXYDD::table ( )

provide read-only access to the table

virtual void casa::TblAsXYDD::cleanup ( ) [virtual]

Clean up (ie.

delete any existing cached display list).

Reimplemented from casa::ActiveCaching2dDD.

void casa::TblAsXYDD::operator= ( const TblAsXYDD & other ) [protected]

(Required) copy assignment.

template<class T>

Bool casa::TblAsXYDD::getTableKeyword	(	T &	value,
		const String	keyword
	)			const `[protected]`

Get the value of the named keyword, or the first keyword matching regex, and return it in value.

The return value is True for success, and False for failure, which is the result if the wrong type T is requested.

template<class T>

Bool casa::TblAsXYDD::getTableKeyword	(	T &	value,
		const Regex &	regex
	)			const `[protected]`

template<class T>

Bool casa::TblAsXYDD::getColumnKeyword	(	T &	value,
		const String	column,
		const String	keyword
	)			const `[protected]`

Get the value of the named keyword, or the first keyword matching regex for the named column, and return it in value.

The return value is True for success, and False for failure, which is the result if // the wrong type T is requested, or if the keyword doesn't exist.

template<class T>

Bool casa::TblAsXYDD::getColumnKeyword	(	T &	value,
		const String	column,
		const Regex &	regex
	)			const `[protected]`

void casa::TblAsXYDD::installDefaultOptions ( ) [private]

set the default options for this display data

Reimplemented from casa::CachingDisplayData.

Bool casa::TblAsXYDD::arrangeQueryTable ( ) [private]

Arrange the query table (called after changing an option).

void casa::TblAsXYDD::getCoordinateSystem ( ) [private]

update/set the coordinate system

void casa::TblAsXYDD::setCoordinateSystem ( ) [private]

void casa::TblAsXYDD::getTableColumnNames ( ) [private]

get all of the table columnNames

Vector<double> casa::TblAsXYDD::columnStatistics ( const String & columnName ) [private]

get the table column world coordinate range

Vector<String> casa::TblAsXYDD::getColumnNamesOfType ( ) [private]

get all of the table columnNames with a certain data type

void casa::TblAsXYDD::constructParameters ( ) [private]

Construct and destruct the parameter set.

void casa::TblAsXYDD::destructParameters ( ) [private]

Friends And Related Function Documentation

friend class TblAsXYDM [friend]

Definition at line 208 of file TblAsXYDD.h.

Member Data Documentation

Table* casa::TblAsXYDD::itsTable [private]

The table to be displayed.

Definition at line 211 of file TblAsXYDD.h.

Table* casa::TblAsXYDD::itsQueryTable [private]

The result from a table query.

Definition at line 214 of file TblAsXYDD.h.

Vector<String> casa::TblAsXYDD::itsColumnNames [private]

store all the table column names

Definition at line 217 of file TblAsXYDD.h.

DParameterChoice* casa::TblAsXYDD::itsXColumnName [private]

what columns are we displaying and do we have a movie axis available

Definition at line 220 of file TblAsXYDD.h.

DParameterChoice* casa::TblAsXYDD::itsYColumnName [private]

Definition at line 221 of file TblAsXYDD.h.

DParameterChoice* casa::TblAsXYDD::itsMColumnName [private]

Definition at line 222 of file TblAsXYDD.h.

DParameterChoice* casa::TblAsXYDD::itsMColumnSet [private]

Definition at line 223 of file TblAsXYDD.h.

String casa::TblAsXYDD::itsOptQueryString [private]

options - what is the query string and is it unset?

Definition at line 226 of file TblAsXYDD.h.

Bool casa::TblAsXYDD::itsOptQueryStringUnset [private]

Definition at line 227 of file TblAsXYDD.h.

CoordinateSystem casa::TblAsXYDD::itsCoord [private]

holder for the current coordinate system

Definition at line 236 of file TblAsXYDD.h.

Vector<Double> casa::TblAsXYDD::itsLinblc [private]

Definition at line 237 of file TblAsXYDD.h.

Vector<Double> casa::TblAsXYDD::itsLintrc [private]

Definition at line 237 of file TblAsXYDD.h.

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

display/implement/DisplayDatas/TblAsXYDD.h

Generated on Mon Sep 1 22:48:26 2008 for NRAOCASA by

1.5.1


Public Member Functions
	TblAsXYDD (Table *table)
	constructors given an already constructed table
	TblAsXYDD (const String tablename)
	given a string which gives the full pathname and filename of a table on disk
virtual	~TblAsXYDD ()
	Destructor.
virtual String	showValue (const Vector< Double > &world)
	format the table value at the give world position
virtual const Unit	dataUnit (const String column)
	get the data unit
virtual const Unit	dataUnit ()
virtual void	setDefaultOptions ()
	install the default options for this DisplayData
virtual Bool	setOptions (Record &rec, Record &recOut)
	Apply options stored in `rec` to the DisplayData.
virtual Record	getOptions ()
	Retrieve the current and default options and parameter types.
virtual Display::DisplayDataType	classType ()
	Return the type of this DisplayData.
virtual CachingDisplayMethod *	newDisplayMethod (WorldCanvas worldCanvas, AttributeBuffer wchAttributes, AttributeBuffer ddAttributes, CachingDisplayData dd)
	Create a new TblAsXyDM for drawing on the given WorldCanvas when the AttributeBuffers are suitably matched to the current state of this DisplayData and of the WorldCanvas/Holder.
virtual AttributeBuffer	optionsAsAttributes ()
	Return the current options of this DisplayData as an AttributeBuffer.
Table *	table ()
	provide read-only access to the table
virtual void	cleanup ()
	Clean up (ie.
Protected Member Functions
	TblAsXYDD ()
	(Required) default constructor.
	TblAsXYDD (const TblAsXYDD &other)
	(Required) copy constructor.
void	operator= (const TblAsXYDD &other)
	(Required) copy assignment.

template<class T>
Bool	getTableKeyword (T &value, const String keyword) const
	Get the value of the named keyword, or the first keyword matching `regex`, and return it in `value`.
template<class T>
Bool	getTableKeyword (T &value, const Regex &regex) const

template<class T>
Bool	getColumnKeyword (T &value, const String column, const String keyword) const
	Get the value of the named keyword, or the first keyword matching `regex` for the named column, and return it in `value`.
template<class T>
Bool	getColumnKeyword (T &value, const String column, const Regex &regex) const
Private Member Functions
void	installDefaultOptions ()
	set the default options for this display data
Bool	arrangeQueryTable ()
	Arrange the query table (called after changing an option).
void	getCoordinateSystem ()
	update/set the coordinate system
void	setCoordinateSystem ()
void	getTableColumnNames ()
	get all of the table columnNames
Vector< double >	columnStatistics (const String &columnName)
	get the table column world coordinate range
Vector< String >	getColumnNamesOfType ()
	get all of the table columnNames with a certain data type

void	constructParameters ()
	Construct and destruct the parameter set.
void	destructParameters ()
Private Attributes
Table *	itsTable
	The table to be displayed.
Table *	itsQueryTable
	The result from a table query.
Vector< String >	itsColumnNames
	store all the table column names
DParameterChoice *	itsXColumnName
	what columns are we displaying and do we have a movie axis available
DParameterChoice *	itsYColumnName
DParameterChoice *	itsMColumnName
DParameterChoice *	itsMColumnSet
String	itsOptQueryString
	options - what is the query string and is it unset?
Bool	itsOptQueryStringUnset
CoordinateSystem	itsCoord
	holder for the current coordinate system
Vector< Double >	itsLinblc
Vector< Double >	itsLintrc
Friends
class	TblAsXYDM

casa::TblAsXYDD Class Reference [DisplayDatas_internal_classes]

Detailed Description

Intended use:

Prerequisite

Etymology

Synopsis

Example

Motivation

Template Type Argument Requirements (T)

Thrown Exceptions

To Do

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Friends

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

casa::TblAsXYDD Class Reference
[DisplayDatas_internal_classes]