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

A DisplayData to draw color wedges. More...

#include <WedgeDD.h>

Inheritance diagram for casa::WedgeDD:
casa::ActiveCaching2dDD casa::CachingDisplayData casa::DisplayData casa::DisplayOptions casa::DisplayEH casa::DlTarget

List of all members.

Public Member Functions

 WedgeDD (DisplayData *image)
virtual ~WedgeDD ()
 Destructor.
virtual void setup ()
 Constructor help function, creates coordinatesystem and fills data Matrix.
virtual void updateCsys ()
 The coordinate sydtem needs to be update when the data range changes.
virtual Bool labelAxes (const WCRefreshEvent &ev)
 Axis labeller, 5th step in the WCHolder refresh cycle.
bool isDisplayable () const
virtual const Unit dataUnit () const
 Return the data unit.
const IPosition dataShape () const
const uInt dataDim () const
std::vector< int > displayAxes () const
virtual String showValue (const Vector< Double > &world)
 Format the wedge value at the given world position.
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.
String dataType () const
 Pure virtual function from DisplayData...
virtual CachingDisplayMethodnewDisplayMethod (WorldCanvas *worldCanvas, AttributeBuffer *wchAttributes, AttributeBuffer *ddAttributes, CachingDisplayData *dd)
 Create a new AxesDisplayMethod 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.
virtual void notifyUnregister (WorldCanvasHolder &wcHolder, Bool ignoreRefresh=False)
 Take actions on removal from WC[H] (notably, deletion of drawlists).

Static Public Attributes

static const String WEDGE_PREFIX

Private Member Functions

 WedgeDD (const WedgeDD &other)
 (Required) copy constructor.
void operator= (const WedgeDD &other)
 (Required) copy assignment.

Private Attributes

Float itsMin
 Data minimum and maximum to set up the coordinate system.
Float itsMax
uInt itsLength
 the length of the Vector
String itsDataUnit
 the unit of the input data
Float itsPowerCycles
 the power law adjustment for for the scle handler
WCPowerScaleHandleritsPowerScaleHandler
String itsOptionsMode
WCCSNLAxisLabeller itsAxisLabeller
 the axis labeller
Matrix< FloatitsColorbar
 The actual colorbar data.
CoordinateSystem itsCoordinateSystem
 the local coordinate system - gets exported to the parent DD
DlHandle< DisplayDataihandle_

Friends

class WedgeDM

Detailed Description

A DisplayData to draw color wedges.

Intended use:

Public interface

Review Status

Date Reviewed:
yyyy/mm/dd

Prerequisite

Etymology

Synopsis

This DisplayData can be created by itself. It's main task though is to set up a coordinate system form the data range and units of another DisplayData. The user can control this through options in this DisplayData: "datamin", "datamax, "dataunit" and "powercycles".

Example

Motivation

Users want wedges

Definition at line 81 of file WedgeDD.h.


Constructor & Destructor Documentation

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

Destructor.

casa::WedgeDD::WedgeDD ( const WedgeDD other) [private]

(Required) copy constructor.


Member Function Documentation

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

Return the type of this DisplayData.

Implements casa::DisplayData.

Definition at line 123 of file WedgeDD.h.

References casa::Display::Raster.

const uInt casa::WedgeDD::dataDim ( ) const [inline, virtual]

Implements casa::DisplayData.

Definition at line 104 of file WedgeDD.h.

const IPosition casa::WedgeDD::dataShape ( ) const [inline, virtual]

Implements casa::DisplayData.

Definition at line 103 of file WedgeDD.h.

String casa::WedgeDD::dataType ( ) const [inline, virtual]

Pure virtual function from DisplayData...

Implements casa::DisplayData.

Definition at line 126 of file WedgeDD.h.

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

Return the data unit.

Implements casa::DisplayData.

std::vector<int> casa::WedgeDD::displayAxes ( ) const [inline, virtual]

Implements casa::DisplayData.

Definition at line 105 of file WedgeDD.h.

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

Retrieve the current and default options and parameter types.

Reimplemented from casa::ActiveCaching2dDD.

bool casa::WedgeDD::isDisplayable ( ) const [virtual]

Reimplemented from casa::DisplayData.

virtual Bool casa::WedgeDD::labelAxes ( const WCRefreshEvent ev) [virtual]

Axis labeller, 5th step in the WCHolder refresh cycle.

Reimplemented from casa::DisplayData.

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

Create a new AxesDisplayMethod 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 void casa::WedgeDD::notifyUnregister ( WorldCanvasHolder wcHolder,
Bool  ignoreRefresh = False 
) [virtual]

Take actions on removal from WC[H] (notably, deletion of drawlists).

Reimplemented from casa::CachingDisplayData.

void casa::WedgeDD::operator= ( const WedgeDD other) [private]

(Required) copy assignment.

Return the current options of this DisplayData as an AttributeBuffer.

Reimplemented from casa::ActiveCaching2dDD.

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

Install the default options for this DisplayData.

Reimplemented from casa::ActiveCaching2dDD.

virtual Bool casa::WedgeDD::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 void casa::WedgeDD::setup ( ) [virtual]

Constructor help function, creates coordinatesystem and fills data Matrix.

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

Format the wedge value at the given world position.

Implements casa::DisplayData.

virtual void casa::WedgeDD::updateCsys ( ) [virtual]

The coordinate sydtem needs to be update when the data range changes.


Friends And Related Function Documentation

friend class WedgeDM [friend]

Definition at line 158 of file WedgeDD.h.


Member Data Documentation

Definition at line 179 of file WedgeDD.h.

the axis labeller

Definition at line 173 of file WedgeDD.h.

The actual colorbar data.

Definition at line 175 of file WedgeDD.h.

the local coordinate system - gets exported to the parent DD

Reimplemented from casa::ActiveCaching2dDD.

Definition at line 177 of file WedgeDD.h.

the unit of the input data

Definition at line 164 of file WedgeDD.h.

the length of the Vector

Definition at line 162 of file WedgeDD.h.

Definition at line 160 of file WedgeDD.h.

Data minimum and maximum to set up the coordinate system.

Definition at line 160 of file WedgeDD.h.

Definition at line 170 of file WedgeDD.h.

the power law adjustment for for the scle handler

Definition at line 167 of file WedgeDD.h.

Definition at line 168 of file WedgeDD.h.

Definition at line 146 of file WedgeDD.h.


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