BinToKamaeScale Class Reference

#include <BinToKamaeScale.h>

Inheritance diagram for BinToKamaeScale:

[legend]Collaboration diagram for BinToKamaeScale:

[legend]List of all members.

---

Detailed Description

The class derived from the BinToColor class.

The BinToKamaeScale class implements the transformation of a value to a color with an algorithm invented by Tune Kamae.

Author:

Tune Kamae <kamae@slac.stanford.edu>

Paul F. Kunz <paul_kunz@slac.stanford.edu>

Definition at line 27 of file BinToKamaeScale.h.

Public Member Functions
	BinToKamaeScale (const BinToKamaeScale &)
	The copy constructor.
	BinToKamaeScale (const char *name)
	The constructor.
virtual BinToColor *	clone () const
	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.
const Range &	getRange () const
	Get the Range.
virtual bool	hasControlPoints () const
	Returns true if class has control points by which the value to color transform can be varied.
const std::string &	name () const
	Returns the name of the value to color transform.
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.
Protected Attributes
std::vector< double >	m_control_points
	A set of control points that might be used for the value to color transform.
std::string	m_name
	The name of this value transform.
Range	m_range
	The range of the values given to this object.

---

Constructor & Destructor Documentation

BinToKamaeScale::BinToKamaeScale (  const char *  name  )

The constructor. Definition at line 19 of file BinToKamaeScale.cxx. Referenced by clone().

BinToKamaeScale::BinToKamaeScale (  const BinToKamaeScale &   )

The copy constructor. Definition at line 24 of file BinToKamaeScale.cxx.

---

Member Function Documentation

BinToColor * BinToKamaeScale::clone (   )  const [virtual]

Creates a copy of itself. Implements BinToColor. Definition at line 29 of file BinToKamaeScale.cxx. References BinToKamaeScale().

void BinToKamaeScale::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 36 of file BinToKamaeScale.cxx. References std::exp(), Range::length(), Range::low(), BinToColor::m_range, std::min(), std::pow(), Color::setColor(), and std::sin().

const std::vector< double > & BinToColor::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 62 of file BinToColor.cxx. References BinToColor::m_control_points. Referenced by BinToColorXML::createElement().

const Range & BinToColor::getRange (   )  const [inherited]

Get the Range. Definition at line 48 of file BinToColor.cxx. References BinToColor::m_range. Referenced by ContourPointRep::createContours(), and AxisRepColor::drawColorScale().

bool BinToColor::hasControlPoints (   )  const [virtual, inherited]

Returns true if class has control points by which the value to color transform can be varied. The implementation in this base class returns false. Reimplemented in BinToColorScaleMovingBrkPt, BinToMovingBrkPt, and BinToUsrDefinedScale. Definition at line 55 of file BinToColor.cxx. Referenced by BinToColorXML::createElement().

const std::string & BinToColor::name (   )  const [inherited]

Returns the name of the value to color transform. Definition at line 38 of file BinToColor.cxx. References BinToColor::m_name. Referenced by BinToColorXML::createElement().

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

Set the value of the control points. Interpretation of control points is left to derived classes. Definition at line 69 of file BinToColor.cxx. References BinToColor::m_control_points.

void BinToColor::setRange (  const Range &  r  )  [inherited]

Sets the range of the values passed. Definition at line 43 of file BinToColor.cxx. References BinToColor::m_range. Referenced by ContourPointRep::drawProjectedValues(), ColorSymbolPointRep::drawProjectedValues(), and ColorBoxPointRep::drawProjectedValues().

---

Member Data Documentation

std::vector< double > BinToColor::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 42 of file BinToColor.h. Referenced by BinToColorScaleMovingBrkPt::BinToColorScaleMovingBrkPt(), BinToMovingBrkPt::BinToMovingBrkPt(), BinToUsrDefinedScale::BinToUsrDefinedScale(), BinToUsrDefinedScale::doubleToColor(), BinToMovingBrkPt::doubleToColor(), BinToColorScaleMovingBrkPt::doubleToColor(), BinToColor::getControlPoints(), and BinToColor::setControlPoints().

std::string BinToColor::m_name [protected, inherited]

The name of this value transform. Definition at line 49 of file BinToColor.h. Referenced by BinToColor::name().

Range BinToColor::m_range [protected, inherited]

The range of the values given to this object. It is needed in the algorithms used to calculate the color returned. Definition at line 46 of file BinToColor.h. Referenced by BinToUsrDefinedScale::doubleToColor(), BinToMovingBrkPt::doubleToColor(), doubleToColor(), BinToGreyScale::doubleToColor(), BinToFullColorScale::doubleToColor(), BinToColorScaleMovingBrkPt::doubleToColor(), BinToColorScale::doubleToColor(), BinTo3ColorScale::doubleToColor(), BinToColor::getRange(), and BinToColor::setRange().

---

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

• BinToKamaeScale.h
• BinToKamaeScale.cxx

---