casa::WCPowerScaleHandler Class Reference

Linear, logarithmic and exponential scaling of data for the WorldCanvas. More...

#include <WCPowerScaleHandler.h>

Inheritance diagram for casa::WCPowerScaleHandler:

List of all members.

Public Member Functions
	WCPowerScaleHandler ()
	Default Constructor Required.
virtual	~WCPowerScaleHandler ()
	Destructor.
void	setCycles (Float cyc)
	set/get the number of log cycles into which to compress the data
Float	cycles ()
virtual void	setDefaultOptions ()
	install the default options for this DisplayData
virtual Bool	setOptions (Record &rec, Record &recOut)
	apply options stored in val to the DisplayData; return value True means a refresh is needed.
virtual Record	getOptions (bool scrub=false) const
	retrieve the current and default options and parameter types.
virtual Bool	operator() (Array< uInt > &out, const Array< Bool > &in)
	apply returns True if the array in was converted to the array out successfully the last parameter sets the output range
virtual Bool	operator() (Array< uInt > &out, const Array< uChar > &in)
virtual Bool	operator() (Array< uInt > &out, const Array< Char > &in)
virtual Bool	operator() (Array< uInt > &out, const Array< uShort > &in)
virtual Bool	operator() (Array< uInt > &out, const Array< Short > &in)
virtual Bool	operator() (Array< uInt > &out, const Array< uInt > &in)
virtual Bool	operator() (Array< uInt > &out, const Array< Int > &in)
virtual Bool	operator() (Array< uInt > &out, const Array< uLong > &in)
virtual Bool	operator() (Array< uInt > &out, const Array< Long > &in)
virtual Bool	operator() (Array< uInt > &out, const Array< Float > &in)
virtual Bool	operator() (Array< uInt > &out, const Array< Double > &in)
virtual Bool	operator() (Array< uInt > &out, const Array< Complex > &in)
virtual Bool	operator() (Array< uInt > &out, const Array< DComplex > &in)
Bool	histoEqualise (Array< Float > &out, const Array< Float > &in)
Static Public Attributes
static const String	POWER_CYCLES
Private Attributes
Float	itsOptionsPowerCycles
	Scaling power cycles: < 0 => log scaling, > 0 => exp scaling, == 0 => linear scaling.
Bool	itsOptionsHistoEqualisation
	Is histogram equalisation required?

---

Detailed Description

Linear, logarithmic and exponential scaling of data for the WorldCanvas.

Prerequisite

• WCDataScaleHandler

Etymology

WCPowerScaleHandler : WorldCanvas Power Scale Handler

Synopsis

The WCPowerScaleHandler is an implementation of the WCDataScaleHandler that uses linear, logarithmic or exponential scaling to transform (probably non-discrete) input data into discrete output values in the range 0 to a settable maximum. Typically, this maximum would be set to the available number of colorcells minus one, for indexed raster drawing, or to a large integer (say 1000000) for use in color cube raster drawing. In the latter case, the output is then divided by the chosen large number in order to provide values in the range 0 to 1.

Motivation

This class is motivated by the need to provide the most common data scaling requirements to the user.

Example

..\.

To Do

• stream ops

Definition at line 76 of file WCPowerScaleHandler.h.

---

Constructor & Destructor Documentation

casa::WCPowerScaleHandler::WCPowerScaleHandler

(

)

Default Constructor Required.

virtual casa::WCPowerScaleHandler::~WCPowerScaleHandler

(

)

[virtual]

Destructor.

---

Member Function Documentation

Float casa::WCPowerScaleHandler::cycles

(

)

[inline]

Definition at line 91 of file WCPowerScaleHandler.h.

References itsOptionsPowerCycles.

virtual Record casa::WCPowerScaleHandler::getOptions

(

bool

scrub = false

)

const [virtual]

retrieve the current and default options and parameter types.

Reimplemented from casa::WCDataScaleHandler.

Bool casa::WCPowerScaleHandler::histoEqualise	(	Array< Float > &	out,
		const Array< Float > &	in
	)

virtual Bool casa::WCPowerScaleHandler::operator()	(	Array< uInt > &	out,
		const Array< DComplex > &	in
	)			[virtual]

Reimplemented from casa::WCDataScaleHandler.

virtual Bool casa::WCPowerScaleHandler::operator()	(	Array< uInt > &	out,
		const Array< Complex > &	in
	)			[virtual]

Reimplemented from casa::WCDataScaleHandler.

virtual Bool casa::WCPowerScaleHandler::operator()	(	Array< uInt > &	out,
		const Array< Double > &	in
	)			[virtual]

Reimplemented from casa::WCDataScaleHandler.

virtual Bool casa::WCPowerScaleHandler::operator()	(	Array< uInt > &	out,
		const Array< Float > &	in
	)			[virtual]

Reimplemented from casa::WCDataScaleHandler.

virtual Bool casa::WCPowerScaleHandler::operator()	(	Array< uInt > &	out,
		const Array< Long > &	in
	)			[virtual]

Reimplemented from casa::WCDataScaleHandler.

virtual Bool casa::WCPowerScaleHandler::operator()	(	Array< uInt > &	out,
		const Array< uLong > &	in
	)			[virtual]

Reimplemented from casa::WCDataScaleHandler.

virtual Bool casa::WCPowerScaleHandler::operator()	(	Array< uInt > &	out,
		const Array< Int > &	in
	)			[virtual]

Reimplemented from casa::WCDataScaleHandler.

virtual Bool casa::WCPowerScaleHandler::operator()	(	Array< uInt > &	out,
		const Array< uInt > &	in
	)			[virtual]

Reimplemented from casa::WCDataScaleHandler.

virtual Bool casa::WCPowerScaleHandler::operator()	(	Array< uInt > &	out,
		const Array< Short > &	in
	)			[virtual]

Reimplemented from casa::WCDataScaleHandler.

virtual Bool casa::WCPowerScaleHandler::operator()	(	Array< uInt > &	out,
		const Array< uShort > &	in
	)			[virtual]

Reimplemented from casa::WCDataScaleHandler.

virtual Bool casa::WCPowerScaleHandler::operator()	(	Array< uInt > &	out,
		const Array< Char > &	in
	)			[virtual]

Reimplemented from casa::WCDataScaleHandler.

virtual Bool casa::WCPowerScaleHandler::operator()	(	Array< uInt > &	out,
		const Array< uChar > &	in
	)			[virtual]

Reimplemented from casa::WCDataScaleHandler.

virtual Bool casa::WCPowerScaleHandler::operator()	(	Array< uInt > &	out,
		const Array< Bool > &	in
	)			[virtual]

apply returns True if the array in was converted to the array out successfully the last parameter sets the output range

Reimplemented from casa::WCDataScaleHandler.

void casa::WCPowerScaleHandler::setCycles

(

Float

cyc

)

[inline]

set/get the number of log cycles into which to compress the data

Definition at line 88 of file WCPowerScaleHandler.h.

References itsOptionsPowerCycles.

virtual void casa::WCPowerScaleHandler::setDefaultOptions

(

)

[virtual]

install the default options for this DisplayData

Reimplemented from casa::WCDataScaleHandler.

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

apply options stored in val to the DisplayData; return value True means a refresh is needed.

.\.

Reimplemented from casa::WCDataScaleHandler.

---

Member Data Documentation

Bool casa::WCPowerScaleHandler::itsOptionsHistoEqualisation [private]

Is histogram equalisation required?

Definition at line 133 of file WCPowerScaleHandler.h.

Float casa::WCPowerScaleHandler::itsOptionsPowerCycles [private]

Scaling power cycles: < 0 => log scaling, > 0 => exp scaling, == 0 => linear scaling.

Definition at line 130 of file WCPowerScaleHandler.h.

Referenced by cycles(), and setCycles().

const String casa::WCPowerScaleHandler::POWER_CYCLES [static]

Definition at line 125 of file WCPowerScaleHandler.h.

---

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

• code/display/DisplayCanvas/WCPowerScaleHandler.h