Linear scaling of data for WorldCanvases. More...

#include <WCLinearScaleHandler.h>

Inheritance diagram for casa::WCLinearScaleHandler:

Public Member Functions
	WCLinearScaleHandler ()
	Default Constructor Required. More...

virtual	~WCLinearScaleHandler ()
	Destructor. More...

virtual casacore::Bool	operator() (casacore::Array< casacore::uInt > &out, const casacore::Array< casacore::Bool > &in)
	apply returns true if the array in was converted to the array out successfully the last parameter sets the output range More...

virtual casacore::Bool	operator() (casacore::Array< casacore::uInt > &out, const casacore::Array< casacore::uChar > &in)

virtual casacore::Bool	operator() (casacore::Array< casacore::uInt > &out, const casacore::Array< casacore::Char > &in)

virtual casacore::Bool	operator() (casacore::Array< casacore::uInt > &out, const casacore::Array< casacore::uShort > &in)

virtual casacore::Bool	operator() (casacore::Array< casacore::uInt > &out, const casacore::Array< casacore::Short > &in)

virtual casacore::Bool	operator() (casacore::Array< casacore::uInt > &out, const casacore::Array< casacore::uInt > &in)

virtual casacore::Bool	operator() (casacore::Array< casacore::uInt > &out, const casacore::Array< casacore::Int > &in)

virtual casacore::Bool	operator() (casacore::Array< casacore::uInt > &out, const casacore::Array< casacore::uLong > &in)

virtual casacore::Bool	operator() (casacore::Array< casacore::uInt > &out, const casacore::Array< casacore::Long > &in)

virtual casacore::Bool	operator() (casacore::Array< casacore::uInt > &out, const casacore::Array< casacore::Float > &in)

virtual casacore::Bool	operator() (casacore::Array< casacore::uInt > &out, const casacore::Array< casacore::Double > &in)

virtual casacore::Bool	operator() (casacore::Array< casacore::uInt > &out, const casacore::Array< casacore::Complex > &in)

virtual casacore::Bool	operator() (casacore::Array< casacore::uInt > &out, const casacore::Array< casacore::DComplex > &in)

Public Member Functions inherited from casa::WCDataScaleHandler
	WCDataScaleHandler ()
	Default Constructor Required. More...

virtual	~WCDataScaleHandler ()
	Destructor (does nothing) More...

	WCDataScaleHandler (casacore::Double min, casacore::Double max)
	Set min/max at construction time. More...

casacore::Double	domainMin () const
	set/get the min/max to use for the input Array More...

casacore::Double	domainMax () const

void	setDomainMinMax (casacore::Double min, casacore::Double max)

casacore::uInt	rangeMax () const
	set/get the maximum value to use for the output array Note: the minimum value is always zero More...

void	setRangeMax (casacore::uInt max)

virtual void	setDefaultOptions ()
	install the default options for this DisplayData More...

virtual casacore::Bool	setOptions (casacore::Record &rec, casacore::Record &recOut)
	apply options stored in val to the DisplayData; return value true means a refresh is needed... More...

virtual casacore::Record	getOptions (bool scrub=false) const
	retrieve the current and default options and parameter types. More...

Public Member Functions inherited from casa::DisplayOptions
	DisplayOptions ()
	Constructor. More...

virtual	~DisplayOptions ()
	Destructor. More...

template<class T >
casacore::Bool	readOptionRecord (casacore::Vector< T > &target, casacore::Bool &error, const casacore::Record &rec, const casacore::String &fieldname) const
	Find the field `fieldname` in casacore::Record `rec`, containing the requested type (casacore::Bool, casacore::String, casacore::Float, casacore::Int) in itself or its "value" sub-field, and return the value in `target`. More...

template<class T >
casacore::Bool	readOptionRecord (T &target, casacore::Bool &error, const casacore::Record &rec, const casacore::String &fieldname) const

virtual casacore::Bool	readOptionRecord (casacore::String &target, casacore::Bool &unsetTarget, casacore::Bool &error, const casacore::Record &rec, const casacore::String &fieldname) const
	Find the field `fieldname` in casacore::Record `rec`, containing the requested type (casacore::String) in itself or its "value" sub-field, and return the value in `target`. More...

casacore::Record	unset () const
	Return a casacore::Record which is an "unset" casacore::Record, ie. More...

casacore::Bool	isUnset (const casacore::Record &rec) const
	Return true or false indicating if the provided casacore::Record is equal to an "unset" Record. More...

Additional Inherited Members
Protected Member Functions inherited from casa::DisplayOptions
	DisplayOptions (const DisplayOptions &other)
	(Required) copy constructor. More...

void	operator= (const DisplayOptions &other)
	(Required) copy assignment. More...

Detailed Description

Linear scaling of data for WorldCanvases.

Prerequisite

WCDataScaleHandler

Etymology

WCLinearScaleHandler : WorldCanvas Linear Scale Handler

Synopsis

The WCLinearScaleHandler is an implementation of the WCDataScaleHandler that uses linear scaling to get from real values to discrete values in the range of 0 to rangeMax. Typically, rangeMax is equivalent to the available color resolution minus 1.

Motivation

Need to provide some basic implementations of the WCDataScaleHandler so users can model other custom scale handlers after it. Linear scaling is a common need, so it was implemented.

Example

see the test program tWCLinearScaleHandler.cc in the Display/test directory.

To Do

stream ops

Definition at line 71 of file WCLinearScaleHandler.h.

Constructor & Destructor Documentation

casa::WCLinearScaleHandler::WCLinearScaleHandler ( )

Default Constructor Required.

virtual casa::WCLinearScaleHandler::~WCLinearScaleHandler ( )

virtual

Destructor.

Member Function Documentation

virtual casacore::Bool casa::WCLinearScaleHandler::operator()	(	casacore::Array< casacore::uInt > &	out,
		const casacore::Array< casacore::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.

virtual casacore::Bool casa::WCLinearScaleHandler::operator()	(	casacore::Array< casacore::uInt > &	out,
		const casacore::Array< casacore::uChar > &	in
	)

virtual

Reimplemented from casa::WCDataScaleHandler.

virtual casacore::Bool casa::WCLinearScaleHandler::operator()	(	casacore::Array< casacore::uInt > &	out,
		const casacore::Array< casacore::Char > &	in
	)

virtual

Reimplemented from casa::WCDataScaleHandler.

virtual casacore::Bool casa::WCLinearScaleHandler::operator()	(	casacore::Array< casacore::uInt > &	out,
		const casacore::Array< casacore::uShort > &	in
	)

virtual

Reimplemented from casa::WCDataScaleHandler.

virtual casacore::Bool casa::WCLinearScaleHandler::operator()	(	casacore::Array< casacore::uInt > &	out,
		const casacore::Array< casacore::Short > &	in
	)

virtual

Reimplemented from casa::WCDataScaleHandler.

virtual casacore::Bool casa::WCLinearScaleHandler::operator()	(	casacore::Array< casacore::uInt > &	out,
		const casacore::Array< casacore::uInt > &	in
	)

virtual

Reimplemented from casa::WCDataScaleHandler.

virtual casacore::Bool casa::WCLinearScaleHandler::operator()	(	casacore::Array< casacore::uInt > &	out,
		const casacore::Array< casacore::Int > &	in
	)

virtual

Reimplemented from casa::WCDataScaleHandler.

virtual casacore::Bool casa::WCLinearScaleHandler::operator()	(	casacore::Array< casacore::uInt > &	out,
		const casacore::Array< casacore::uLong > &	in
	)

virtual

Reimplemented from casa::WCDataScaleHandler.

virtual casacore::Bool casa::WCLinearScaleHandler::operator()	(	casacore::Array< casacore::uInt > &	out,
		const casacore::Array< casacore::Long > &	in
	)

virtual

Reimplemented from casa::WCDataScaleHandler.

virtual casacore::Bool casa::WCLinearScaleHandler::operator()	(	casacore::Array< casacore::uInt > &	out,
		const casacore::Array< casacore::Float > &	in
	)

virtual

Reimplemented from casa::WCDataScaleHandler.

virtual casacore::Bool casa::WCLinearScaleHandler::operator()	(	casacore::Array< casacore::uInt > &	out,
		const casacore::Array< casacore::Double > &	in
	)

virtual

Reimplemented from casa::WCDataScaleHandler.

virtual casacore::Bool casa::WCLinearScaleHandler::operator()	(	casacore::Array< casacore::uInt > &	out,
		const casacore::Array< casacore::Complex > &	in
	)

virtual

Reimplemented from casa::WCDataScaleHandler.

virtual casacore::Bool casa::WCLinearScaleHandler::operator()	(	casacore::Array< casacore::uInt > &	out,
		const casacore::Array< casacore::DComplex > &	in
	)

virtual

Reimplemented from casa::WCDataScaleHandler.

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

casa/code/display/DisplayCanvas/WCLinearScaleHandler.h

Public Member Functions

Additional Inherited Members

Detailed Description

Prerequisite

Etymology

Synopsis

Motivation

Example

To Do

Constructor & Destructor Documentation

Member Function Documentation