casa::TblAsXYDD Class Reference

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

#include <TblAsXYDD.h>

Inheritance diagram for casa::TblAsXYDD:

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 (bool scrub=false) const
	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
DisplayCoordinateSystem	itsCoord
	holder for the current coordinate system
Vector< Double >	itsLinblc
Vector< Double >	itsLintrc
Friends
class	TblAsXYDM

Detailed Description

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

Intended use:

Internal or

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)

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.

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

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

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

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 void casa::TblAsXYDD::cleanup ( ) [virtual]

Clean up (ie.

delete any existing cached display list).

Reimplemented from casa::ActiveCaching2dDD.

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

get the table column world coordinate range

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

Construct and destruct the parameter set.

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

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

get the data unit

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

template<class T >

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

template<class T >

Bool casa::TblAsXYDD::getColumnKeyword	(	T &	value,
		const String	column,
		const String	keyword
	)			const `[inline, 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.

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

get all of the table columnNames with a certain data type

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

update/set the coordinate system

virtual Record casa::TblAsXYDD::getOptions ( bool scrub = false ) const [virtual]

Retrieve the current and default options and parameter types.

Reimplemented from casa::ActiveCaching2dDD.

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

get all of the table columnNames

template<class T >

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

template<class T >

Bool casa::TblAsXYDD::getTableKeyword	(	T &	value,
		const String	keyword
	)			const `[inline, 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.

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

set the default options for this display data

Reimplemented from casa::CachingDisplayData.

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.

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

(Required) copy assignment.

Reimplemented from casa::ActiveCaching2dDD.

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

Return the current options of this DisplayData as an AttributeBuffer.

Reimplemented from casa::ActiveCaching2dDD.

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

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 String casa::TblAsXYDD::showValue ( const Vector< Double > & world ) [virtual]

format the table value at the give world position

Implements casa::DisplayData.

Table* casa::TblAsXYDD::table ( )

provide read-only access to the table