Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes

BinToColorMap Class Reference

The base class for the value to the color transformation. More...

#include <BinToColorMap.h>

Inheritance diagram for BinToColorMap:
Inheritance graph
[legend]
Collaboration diagram for BinToColorMap:
Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual bool acceptChangeColor () const
 Returns true if object can accept changing color,i.e.
 BinToColorMap (const BinToColorMap &bin_to_color)
 The copy constructor.
virtual BinToColorclone () const =0
 Creates a copy of itself.
virtual void doubleToColor (double value, Color &color) const
 This function does the actual calculation that transforms the given value into a color using the current Range.
const std::vector< double > & getControlPoints () const
 Returns a list of control points.
Range getRange () const
 Get the Range of expected values.
bool hasControlPoints () const
 Retruns true.
virtual bool isUserDefined () const
 Returns true if object can be user defined.
const std::string & name () const
 Returns the name of the value to color transform.
virtual void setControlPoints (const std::vector< double > &points)
 Set the value of the control points.
void setRange (const Range &r)
 Sets the range of the values passed.
virtual ~BinToColorMap ()
 The destructor.

Protected Member Functions

 BinToColorMap (const char *name)
 The constructor.
 BinToColorMap (const std::string &)
 Another constructor.

Protected Attributes

std::vector< int > m_blues
 vector of blues for color map.
std::vector< double > m_control_points
 A set of control points that might be used for the value to color transform.
double m_dv
 The distance of the expected values, i.e.
std::vector< int > m_greens
 vector of greens for color map.
std::string m_name
 The name of this value transform.
std::vector< int > m_reds
 vector of reds for color map.
double m_vmin
 The minimum value expected.

Private Member Functions

void calcGamma ()
 Calculate the gamma factor based on current control points.

Private Attributes

double m_gamma
 The gamma correction factor.

Detailed Description

The base class for the value to the color transformation.

It is needed, for example, for the drawing of color plots when the color of a point depends on its value.

Author:
Stephane Bonneaud <gandalf@slac.stanford.edu>
Tao Xu <taox@stanford.edu>

Definition at line 29 of file BinToColorMap.h.


Constructor & Destructor Documentation

BinToColorMap ( const char *  name  )  [protected]

The constructor.

Definition at line 21 of file BinToColorMap.cxx.

References BinToColorMap::calcGamma(), and BinToColor::m_control_points.

BinToColorMap ( const std::string &   )  [protected]

Another constructor.

BinToColorMap ( const BinToColorMap bin_to_color  ) 
~BinToColorMap (  )  [virtual]

The destructor.

Definition at line 64 of file BinToColorMap.cxx.


Member Function Documentation

bool acceptChangeColor (  )  const [virtual, inherited]

Returns true if object can accept changing color,i.e.

enable the "Change color" button in plot inspector tabbed panel within inspector. Reimplemented in BinToBlack and BinToGreyScale. The base class implementation returns false.

Reimplemented in BinToBlack, BinToGamma, BinToGreyScale, and BinToLineStyle.

Definition at line 94 of file BinToColor.cxx.

void calcGamma (  )  [private]

Calculate the gamma factor based on current control points.

Definition at line 45 of file BinToColorMap.cxx.

References BinToColor::m_control_points, and BinToColorMap::m_gamma.

Referenced by BinToColorMap::BinToColorMap(), and BinToColorMap::setControlPoints().

virtual BinToColor* clone (  )  const [pure virtual]
void doubleToColor ( double  value,
Color color 
) const [virtual]

This function does the actual calculation that transforms the given value into a color using the current Range.

Implements BinToColor.

Definition at line 70 of file BinToColorMap.cxx.

References BinToColorMap::m_blues, BinToColor::m_dv, BinToColorMap::m_gamma, BinToColorMap::m_greens, BinToColorMap::m_reds, BinToColor::m_vmin, and Color::setColor().

const std::vector< double > & getControlPoints (  )  const [inherited]

Returns a list of control points.

If a derived class has control points to vary the transform of value to color returns the list of control points. Otherwise, the returned list is empty.

Definition at line 71 of file BinToColor.cxx.

References BinToColor::m_control_points.

Referenced by BinToColorXML::createElement().

Range getRange (  )  const [inherited]

Get the Range of expected values.

Definition at line 55 of file BinToColor.cxx.

References BinToColor::m_dv, and BinToColor::m_vmin.

Referenced by ContourPointRep::createContours(), and AxisRepColor::drawColorScale().

bool hasControlPoints (  )  const [virtual]

Retruns true.

Reimplemented from BinToColor.

Definition at line 30 of file BinToColorMap.cxx.

bool isUserDefined (  )  const [virtual, inherited]

Returns true if object can be user defined.

Returns true if value to color transform can be user defined. That is, the control points for the transform are editable. This base class implementation returns false.

Reimplemented in BinToGamma, and BinToUsrDefinedScale.

Definition at line 85 of file BinToColor.cxx.

const std::string& name (  )  const

Returns the name of the value to color transform.

Reimplemented from BinToColor.

void setControlPoints ( const std::vector< double > &  points  )  [virtual]

Set the value of the control points.

Interpretation of control points is left to derived classes.

Reimplemented from BinToColor.

Definition at line 37 of file BinToColorMap.cxx.

References BinToColorMap::calcGamma(), and BinToColor::m_control_points.

void setRange ( const Range r  )  [inherited]

Member Data Documentation

std::vector< int > m_blues [protected]
std::vector< double > m_control_points [protected, inherited]

A set of control points that might be used for the value to color transform.

Note:
This vector is declared in the base class so that the implementation of getControlPoints in this base class can return an empty vector, otherwise some compilers would flag an error for not returning anything.

Definition at line 46 of file BinToColor.h.

Referenced by BinToColor::BinToColor(), BinToColorMap::BinToColorMap(), BinToColorScaleMovingBrkPt::BinToColorScaleMovingBrkPt(), BinToGamma::BinToGamma(), BinToMovingBrkPt::BinToMovingBrkPt(), BinToUsrDefinedScale::BinToUsrDefinedScale(), BinToColorMap::calcGamma(), BinToUsrDefinedScale::doubleToColor(), BinToMovingBrkPt::doubleToColor(), BinToGamma::doubleToColor(), BinToColorScaleMovingBrkPt::doubleToColor(), BinToColor::getControlPoints(), BinToColorMap::setControlPoints(), and BinToColor::setControlPoints().

double m_dv [protected, inherited]
double m_gamma [private]

The gamma correction factor.

Definition at line 35 of file BinToColorMap.h.

Referenced by BinToColorMap::calcGamma(), and BinToColorMap::doubleToColor().

std::vector< int > m_greens [protected]
std::string m_name [protected, inherited]

The name of this value transform.

Definition at line 36 of file BinToColor.h.

Referenced by BinToColor::name().

std::vector< int > m_reds [protected]
double m_vmin [protected, inherited]

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

Generated for HippoDraw Class Library by doxygen