Colormap.h

Classes

Colormap -- Describes a method of generating a table of colors. (full description)

class Colormap

Types

enum

ColormapVersion = 1

Interface

Public Members

Colormap()

explicit Colormap(const String& name)

virtual ~Colormap()

Bool rigid() const

void setRigid(Bool b)

uInt rigidSize() const

void setRigidSize(uInt s)

virtual Bool calcRGBMaps(uInt reqSize, Vector<Float> & redMap, Vector<Float> & greenMap, Vector<Float> & blueMap) const

const String & name() const

void registerPCColorTable(PixelCanvasColorTable *pcctbl)

void unregisterPCColorTable(PixelCanvasColorTable *pcctbl)

void setBrightness(const Float &brightness, const Bool &doReinstall = True)

Float getBrightness() const

void setContrast(const Float &contrast, const Bool &doReinstall = True)

Float getContrast() const

void setInvertFlags(const Bool &red, const Bool &green, const Bool &blue, const Bool &doReinstall = True)

void getInvertFlags(Bool &red, Bool &green, Bool &blue) const

void doResizeCallbacks()

void setShapingFunction(Function1D<Float, Float> *shapingfunc = 0)

void setShapingCoefficients(const Vector<Float> &params, const Bool &doReinstall = True)

const Vector<Float> getShapingCoefficients() const

friend ostream & operator << (ostream & os, const Colormap & c)

friend AipsIO &operator<<(AipsIO &aio, const Colormap & c)

friend LogIO &operator<<(LogIO &lio, const Colormap & c)

friend AipsIO &operator>>(AipsIO &aio, Colormap & c)

ColormapDefinition *definition()

Protected Members

void reinstall()

Description

Etymology

Synopsis

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

  To Do

  Member Description

  Colormap()

  Default Constructor Required

  explicit Colormap(const String& name)

  User Constructor

  virtual ~Colormap()

  Destructor.

  Bool rigid() const
  void setRigid(Bool b)

  If rigid is True, the colormap must be installed at a specific size.

  uInt rigidSize() const
  void setRigidSize(uInt s)

  What is the size enforced by the rigid requirement?

  virtual Bool calcRGBMaps(uInt reqSize, Vector<Float> & redMap, Vector<Float> & greenMap, Vector<Float> & blueMap) const

  Compute RGB values using the definition and shape function

  const String & name() const

  return the name of the map

  void registerPCColorTable(PixelCanvasColorTable *pcctbl)
  void unregisterPCColorTable(PixelCanvasColorTable *pcctbl)

  Register/Unregister a PixelCanvasColorTable that uses this Colormap

  void setBrightness(const Float &brightness, const Bool &doReinstall = True)
  Float getBrightness() const

  set/get the colormap brightness level in range 0 to 1

  void setContrast(const Float &contrast, const Bool &doReinstall = True)
  Float getContrast() const

  set/get the colormap contrast level

  void setInvertFlags(const Bool &red, const Bool &green, const Bool &blue, const Bool &doReinstall = True)
  void getInvertFlags(Bool &red, Bool &green, Bool &blue) const

  set/get the inverse flags

  void doResizeCallbacks()

  Do resizeCallbacks on the PixelCanvasColorTables that use this Colormap

  void setShapingFunction(Function1D<Float, Float> *shapingfunc = 0)

  Set the Colormap shaping function. If the argument is 0, then resort to using the default shaping function, which happens to be a polynomial of order 1.

  void setShapingCoefficients(const Vector<Float> &params, const Bool &doReinstall = True)
  const Vector<Float> getShapingCoefficients() const

  Set and retrieve the coefficients of the shaping function.

  friend ostream & operator << (ostream & os, const Colormap & c)

  Write a Colormap to an ostream in a simple text form.

  friend AipsIO &operator<<(AipsIO &aio, const Colormap & c)

  Write a Colormap to an AipsIO stream in a binary format.

  friend LogIO &operator<<(LogIO &lio, const Colormap & c)

  Write a Colormap to a LogIO stream.

  friend AipsIO &operator>>(AipsIO &aio, Colormap & c)

  Read a Colormap from an AipsIO stream in a binary format. Will throw an AipsError if the current Colormap Version does not match that of the one on disk.

  ColormapDefinition *definition()

  Provide access to the colormap definition.

  void reinstall()

  reinstall this Colormap on the registered PixelCanvasColorTables

  enum