casa::Colormap Class Reference

Describes a method of generating a table of colors. More...

#include <Colormap.h>

Public Member Functions
	Colormap ()
	Default Constructor Required.
	Colormap (const String &name)
	User Constructor.
virtual	~Colormap ()
	Destructor.
Bool	rigid () const
	If rigid is True, the colormap must be installed at a specific size.
void	setRigid (Bool b)
uInt	rigidSize () const
	What is the size enforced by the rigid requirement?
void	setRigidSize (uInt s)
virtual Bool	calcRGBMaps (uInt reqSize, Vector< Float > &redMap, Vector< Float > &greenMap, Vector< Float > &blueMap, Vector< Float > &alphaMap) const
	Compute RGB values using the definition and shape function.
const String &	name () const
	return the name of the map
void	setName (const String &mapName)
void	registerPCColorTable (PixelCanvasColorTable *pcctbl)
	Register/Unregister a PixelCanvasColorTable that uses this Colormap.
void	unregisterPCColorTable (PixelCanvasColorTable *pcctbl)
void	setBrightness (const Float &brightness, const Bool &doReinstall=True)
	set/get the colormap brightness level in range 0 to 1
Float	getBrightness () const
void	setAlpha (const Float &brightness, const Bool &doReinstall=True)
	set/get the colormap alpha level in range 0 to 1
Float	getAlpha () const
void	setContrast (const Float &contrast, const Bool &doReinstall=True)
	set/get the colormap contrast level
Float	getContrast () const
void	setInvertFlags (const Bool &red, const Bool &green, const Bool &blue, const Bool &doReinstall=True)
	set/get the inverse flags
void	getInvertFlags (Bool &red, Bool &green, Bool &blue) const
void	setLogScale (const Int &logScale, const Bool &doReinstall=True)
	Set whether or not the colormap should use a log scale.
void	doResizeCallbacks ()
	Do resizeCallbacks on the PixelCanvasColorTables that use this Colormap.
void	setShapingFunction (Function1D< Float, Float > *shapingfunc=0)
	Set the Colormap shaping function.
void	setShapingCoefficients (const Vector< Float > &params, const Bool &doReinstall=True)
	Set and retrieve the coefficients of the shaping function.
const Vector< Float >	getShapingCoefficients () const
ColormapDefinition *	definition ()
	Provide access to the colormap definition.
void	setColormapDefinition (ColormapDefinition *definition)
Protected Member Functions
void	reinstall ()
	reinstall this Colormap on the registered PixelCanvasColorTables
Private Types
enum	{ ColormapVersion }
Private Attributes
String	itsName
	name of this Colormap.
Bool	itsIsRigid
	is this Colormap rigid?
uInt	itsRigidSize
	what is its rigid size?
Float	itsAlpha
	Transparency.
Float	itsBrightness
	levels
Float	itsBrightnessScale
Float	itsContrast
Float	itsContrastScale
Bool	itsInvertRed
	invert flags
Bool	itsInvertGreen
Bool	itsInvertBlue
Int	itsLogScale
ColormapDefinition *	itsColormapDefinition
Function1D< Float, Float > *	itsShapingFunction
	function for shaping the colormap
Bool	itsOwnShapingFunction
SimpleOrderedMap < PixelCanvasColorTable *, uInt >	itsPCColorTables
Friends
ostream &	operator<< (ostream &os, const Colormap &c)
	Write a Colormap to an ostream in a simple text form.
AipsIO &	operator<< (AipsIO &aio, const Colormap &c)
	Write a Colormap to an AipsIO stream in a binary format.
LogIO &	operator<< (LogIO &lio, const Colormap &c)
	Write a Colormap to a LogIO stream.
AipsIO &	operator>> (AipsIO &aio, Colormap &c)
	Read a Colormap from an AipsIO stream in a binary format.

Detailed Description

Describes a method of generating a table of colors.

Etymology

The name of Colormap comes from ..\.

Synopsis

A Colormap is a class which is capable of generating a table of colormaps for the ColormapManager. The Colormap's duties are to fill a Vector of colors of a specific size.

A Colormap can operate in two modes:

Dynamic - The Colormap is treated as a function which can be arbitrarily descretized into some number of cells. Static - The Colormap is treated as a rigid table of colors and may not be resized by, for example, the ColormapManager.

The Colormap generates colors by composing a ColormapShapeFunc with a ColormapDefinition to provide the colors for the ColormapManager.

Typically the ColormapDefinition is selected from a menu, and the ColormapShapeFunc what is changed by a gui.

The ColormapDefinition and ColormapShapeFunc may be derived from to provide specialized colortable treatment.

Motivation

Needed to satisfy many simultaneous wishes:
1. Wanted to increase application portability by providing for dynamic resize of the colortable(s) used by the application.
2. Needed a way to specialize colormaps (e.g. Ron & Renzo map which requires knowledge of the dataset being viewed).
3. Needed a colormap to be sharable across multiple displays. This implies its existence can vary from colortable to colortable.
Example

see the Display test directory

Definition at line 100 of file Colormap.h.

Member Enumeration Documentation

anonymous enum [private]

Enumerator:

ColormapVersion

Definition at line 259 of file Colormap.h.

Constructor & Destructor Documentation

casa::Colormap::Colormap ( )

Default Constructor Required.

casa::Colormap::Colormap ( const String & name ) [explicit]

User Constructor.

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

Destructor.

Member Function Documentation

virtual Bool casa::Colormap::calcRGBMaps	(	uInt	reqSize,
		Vector< Float > &	redMap,
		Vector< Float > &	greenMap,
		Vector< Float > &	blueMap,
		Vector< Float > &	alphaMap
	)			const `[virtual]`