ErrorBarRep Class Reference

#include <ErrorBarRep.h>

Inheritance diagram for ErrorBarRep:

[legend]Collaboration diagram for ErrorBarRep:

[legend]List of all members.

Detailed Description

A rep to draw error bars, owned by point reps.

Author:: Paul F. Kunz <Paul_Kunz@slac.stanford.edu>
Oded Wurman <owurman@stanford.edu>

Definition at line 26 of file ErrorBarRep.h.

Public Member Functions

RepBase * clone ()

The clone function returns an object of its own kind which is a copy of this object at this moment.

virtual const Color & color () const

Returns the representation's color.

virtual void displayError (ViewBase &view)

Display an error message.

virtual void drawProjectedValues (const DataSource *ntuple, TransformBase *transform, ViewBase *view)

Draws the projected values.

ErrorBarRep ()

The default constructor.

virtual const Color & getColor () const

Get the color of the representation.

virtual unsigned int getStyle () const

Returns the style of the point representation.

virtual const BinToColor * getValueTransform () const

Returns the value transform.

virtual bool isSelected () const

Returns true if representation is in selected state, otherwise returns false.

const std::string & name () const

Returns the name of the representation.

virtual void setColor (const Color &)

Sets the color of the representation.

virtual void setErrorOn (const std::string &axis, bool yes=true)

Sets the error representation on specified axis, if any, to yes.

virtual void setHighLighted (bool yes)

Sets the highlighted state of the point representation.

virtual void setSelected (bool yes=true)

Sets the representation to be selected if yes is true, otherwise set it to be deselected.

void setSize (float value)

Sets the size of the representation.

virtual void setStyle (unsigned int style)

Sets the symbol of the representation.

void setText (const std::string &text)

Sets the text.

virtual void setValueTransform (BinToColor *)

Sets the value transform.

void setXError (bool)

Sets the flag to plot the errors on the X axis.

void setYError (bool)

Sets the flag to plot the errors on the Y axis.

float size () const

Returns the size of the representation.

virtual bool xError () const

Returns true if the point representation displays error on the X axis.

virtual bool yError () const

Returns true if the point representation displays error on the Y axis.

~ErrorBarRep ()

The destructor.

Protected Attributes

Color m_color

The color of the representation.

bool m_desel

A flag to indicate the representation is de-selected.

bool m_highlite

Sets the state of highlighting.

std::string m_name

The name of the representation.

float m_size

The size of the representation.

std::string m_text

The text to be displayed before the statistics.

Static Protected Attributes

static const Color s_desel_color

The color of the representation when it is de-selected.

Private Member Functions

void drawXError (double x, double y, double error, ViewBase &vb, const TransformBase &t)

Creates the line segment for the X error bar.

void drawYError (double x, double y, double error, ViewBase &vb, const TransformBase &t)

Creates the line segment for the Y error bar.

void getRanges (const DataSource *ntuple)

Gets the ranges of the data.

Private Attributes

double m_x_cap

The X error bar cap length.

std::vector< double > m_x_err

A cache of the X errors.

bool m_x_flag

The X error flag.

Range m_x_range

The X axis range for cap calculation.

double m_y_cap

The Y error bar cap length.

std::vector< double > m_y_err

A cache of the Y errors.

bool m_y_flag

The Y error flag.

Range m_y_range

The Y axis range for cap calculation.

Constructor & Destructor Documentation

ErrorBarRep::ErrorBarRep ( )

The default constructor.

Note:
The copy constructor does not need to be implemented as the compiler create one works and saves 1.4KB in the object code.

Definition at line 31 of file ErrorBarRep.cxx.
Referenced by clone().

ErrorBarRep::~ErrorBarRep ( )

The destructor.

Definition at line 40 of file ErrorBarRep.cxx.

Member Function Documentation

RepBase * ErrorBarRep::clone ( ) [virtual]

The clone function returns an object of its own kind which is a copy of this object at this moment.

Implements RepBase.
Definition at line 44 of file ErrorBarRep.cxx.
References ErrorBarRep().
Referenced by ColumnPointRep::ColumnPointRep(), and SymbolPointRep::SymbolPointRep().

const Color & RepBase::color ( ) const [virtual, inherited]

Returns the representation's color.

Todo:
Remove this member in favor of getColor().

Definition at line 61 of file RepBase.cxx.
References RepBase::m_color, RepBase::m_desel, and RepBase::s_desel_color.
Referenced by ContourPointRep::createContours(), SymbolPointRep::drawProjectedValues(), LinePointRep::drawProjectedValues(), drawProjectedValues(), ColumnPointRep::drawProjectedValues(), ColorSymbolPointRep::drawProjectedValues(), ColorBoxPointRep::drawProjectedValues(), and DataRep::getRepColor().

void RepBase::displayError ( ViewBase & view ) [virtual, inherited]

Display an error message.
Display an error message instead of drawing a point. This base class implementation displays a message with the name of the RepBase object.
Definition at line 153 of file RepBase.cxx.
References ViewBase::drawText(), RepBase::m_name, and RepBase::m_size.

void ErrorBarRep::drawProjectedValues ( const DataSource * ntuple,

TransformBase * transform,

ViewBase * view

) [virtual]

Draws the projected values.
Draws the projected values contained in the DataSource ntuple. Each row of the ntuple is data point tuple of some dimension. Derived classes expect the DataSoruce to be of the correct dimension. The drawn points undergo a transform represented by transform and are drawn to the view view. If highlighting is on, uses the ranges to control highlighting.
Implements RepBase.
Definition at line 167 of file ErrorBarRep.cxx.
References RepBase::color(), drawXError(), drawYError(), getRanges(), RepBase::m_size, m_x_cap, m_x_err, m_x_flag, m_y_cap, m_y_err, m_y_flag, HippoRectangle::makeInBounds(), RepBase::size(), hippodraw::Line::Solid, hippodraw::Axes::X, hippodraw::DataPoint2DTuple::XERR, hippodraw::Axes::Y, and hippodraw::DataPoint2DTuple::YERR.

void ErrorBarRep::drawXError ( double x,

double y,

double error,

ViewBase & vb,

const TransformBase & t

) [private]

Creates the line segment for the X error bar.

Definition at line 59 of file ErrorBarRep.cxx.
References Range::high(), Range::length(), Range::low(), m_x_cap, m_x_err, m_y_err, m_y_range, and BinaryTransform::transform().
Referenced by drawProjectedValues().

void ErrorBarRep::drawYError ( double x,

double y,

double error,

ViewBase & vb,

const TransformBase & tb

) [private]

Creates the line segment for the Y error bar.

Bug:
The caps to the error bars are drawn in data space.
This could be a mis calculation as we want a fixed appearance in view coordinates. Don't know of example where it can be seen to be wrong.
Definition at line 114 of file ErrorBarRep.cxx.
References Range::high(), Range::length(), Range::low(), m_x_err, m_x_range, m_y_cap, m_y_err, and BinaryTransform::transform().
Referenced by drawProjectedValues().

const Color & RepBase::getColor ( ) const [virtual, inherited]

Get the color of the representation.

Definition at line 56 of file RepBase.cxx.
References RepBase::m_color.
Referenced by PointRepXML::createElement().

void ErrorBarRep::getRanges ( const DataSource * ntuple ) [private]

Gets the ranges of the data.

Definition at line 219 of file ErrorBarRep.cxx.
References m_x_range, m_y_range, hippodraw::Axes::X, and hippodraw::Axes::Y.
Referenced by drawProjectedValues().

unsigned int RepBase::getStyle ( ) const [virtual, inherited]

Returns the style of the point representation.
Derived class should override this member function if they support styles. This base class implementation returns 0.
Reimplemented in ColumnPointRep, LinePointRep, LinePointRep, and SymbolPointRep.
Definition at line 108 of file RepBase.cxx.
Referenced by PointRepXML::setAttributes().

const BinToColor * RepBase::getValueTransform ( ) const [virtual, inherited]

Returns the value transform.
A value transform changes a binary value to some graphical representations such as color. The implementation in this base class returns a null pointer. Derived classes that implement value transform should return a pointer to the object it uses.
Reimplemented in ColorBoxPointRep, ColorSymbolPointRep, and ContourPointRep.
Definition at line 139 of file RepBase.cxx.
Referenced by PointRepXML::createElement().

bool RepBase::isSelected ( ) const [virtual, inherited]

Returns true if representation is in selected state, otherwise returns false.

Definition at line 77 of file RepBase.cxx.
References RepBase::m_desel.
Referenced by DataRep::isSelected().

const string & RepBase::name ( ) const [inherited]

Returns the name of the representation.
This name might be used by a Factory.
Definition at line 45 of file RepBase.cxx.
References RepBase::m_name.
Referenced by FuncParmRep::drawProjectedValues(), PointRepXML::setAttributes(), QtDisplay::setContourLevels(), and Inspector::updatePlotTab().

void RepBase::setColor ( const Color & ) [virtual, inherited]

Sets the color of the representation.

Reimplemented in ColumnPointRep, and SymbolPointRep.
Definition at line 51 of file RepBase.cxx.
References RepBase::m_color.
Referenced by PointRepXML::createObject(), CutRangeRep::CutRangeRep(), FunctionRep::FunctionRep(), LineDataRep::LineDataRep(), SymbolPointRep::setColor(), ColumnPointRep::setColor(), and DataRep::setRepColor().

void RepBase::setErrorOn ( const std::string & axis,

bool yes = true

) [virtual, inherited]

Sets the error representation on specified axis, if any, to yes.

Todo:
This member Needs to be implemented in some derived classes.

Reimplemented in ColumnPointRep, and SymbolPointRep.
Definition at line 128 of file RepBase.cxx.
Referenced by PointRepXML::createObject(), and DataRep::setErrorDisplay().

void RepBase::setHighLighted ( bool yes ) [virtual, inherited]

Sets the highlighted state of the point representation.
If yes is true, then the point representation should show the non highlighted regions in some fashion, typically using light gray color instead of its normal color.
See also:
setSelected (bool)
m_ranges.

Definition at line 84 of file RepBase.cxx.
References RepBase::m_highlite.

void RepBase::setSelected ( bool yes = true ) [virtual, inherited]

Sets the representation to be selected if yes is true, otherwise set it to be deselected.

Reimplemented in PointRepBase.
Definition at line 70 of file RepBase.cxx.
References RepBase::m_desel.
Referenced by PointRepBase::setSelected(), and DataRep::setSelected().

void RepBase::setSize ( float value ) [inherited]

Sets the size of the representation.

Definition at line 94 of file RepBase.cxx.
References RepBase::m_size.
Referenced by PointRepXML::createObject(), FunctionRep::FunctionRep(), and DataRep::setRepSize().

void RepBase::setStyle ( unsigned int style ) [virtual, inherited]

Sets the symbol of the representation.
Derived classes may use this method to set the style of the representation, if they have various styles. This base class implementation does nothing.
Reimplemented in ColumnPointRep, LinePointRep, LinePointRep, and SymbolPointRep.
Definition at line 101 of file RepBase.cxx.
Referenced by DataRep::setRepStyle().

void RepBase::setText ( const std::string & text ) [inherited]

Sets the text.

Definition at line 132 of file RepBase.cxx.
References RepBase::m_text.
Referenced by DisplayController::createTextDataRep().

void RepBase::setValueTransform ( BinToColor * ) [virtual, inherited]

Sets the value transform.
The implementation in this base class does nothing. Derived classes that implement a value transform should override this method and take possession of the received object.

Todo:
Should have base class that doesn't know about color and BinToColor class should derive from it.

Reimplemented in ColorBoxPointRep, ColorSymbolPointRep, and ContourPointRep.
Definition at line 146 of file RepBase.cxx.

void ErrorBarRep::setXError ( bool )

Sets the flag to plot the errors on the X axis.

Definition at line 49 of file ErrorBarRep.cxx.
References m_x_flag.
Referenced by SymbolPointRep::setErrorOn().

void ErrorBarRep::setYError ( bool )

Sets the flag to plot the errors on the Y axis.

Definition at line 54 of file ErrorBarRep.cxx.
References m_y_flag.
Referenced by SymbolPointRep::setErrorOn(), and ColumnPointRep::setErrorOn().

float RepBase::size ( ) const [inherited]

Returns the size of the representation.

Definition at line 89 of file RepBase.cxx.
References RepBase::m_size.
Referenced by ContourPointRep::createContours(), ContourPointRep::drawContourTicks(), SymbolPointRep::drawProjectedValues(), LinePointRep::drawProjectedValues(), drawProjectedValues(), ContourPointRep::drawProjectedValues(), ColumnPointRep::drawProjectedValues(), ColorSymbolPointRep::drawProjectedValues(), ColorBoxPointRep::drawProjectedValues(), DisplayController::pointSize(), and PointRepXML::setAttributes().

bool RepBase::xError ( ) const [virtual, inherited]

Returns true if the point representation displays error on the X axis.
The default implementation returns false. May be overridden by derived classes.
Reimplemented in SymbolPointRep.
Definition at line 114 of file RepBase.cxx.
Referenced by DataRep::isErrorDisplayed(), and PointRepXML::setAttributes().

bool RepBase::yError ( ) const [virtual, inherited]

Returns true if the point representation displays error on the Y axis.
The default implementation returns false. May be overridden by derived classes.
Reimplemented in ColumnPointRep, and SymbolPointRep.
Definition at line 120 of file RepBase.cxx.
Referenced by DataRep::isErrorDisplayed(), and PointRepXML::setAttributes().

Member Data Documentation

Color RepBase::m_color [protected, inherited]

The color of the representation.

Definition at line 55 of file RepBase.h.
Referenced by RepBase::color(), CutRangeRep::drawInvertedRange1D(), CutRangeRep::drawInvertedRange2D(), CutRangeRep::drawNormalRange(), RepBase::getColor(), and RepBase::setColor().

bool RepBase::m_desel [protected, inherited]

A flag to indicate the representation is de-selected.

Definition at line 64 of file RepBase.h.
Referenced by RepBase::color(), CutRangeRep::drawInvertedRange1D(), CutRangeRep::drawInvertedRange2D(), CutRangeRep::drawNormalRange(), ColorBoxPointRep::drawProjectedValues(), RepBase::isSelected(), and RepBase::setSelected().

bool RepBase::m_highlite [protected, inherited]

Sets the state of highlighting.

Definition at line 68 of file RepBase.h.
Referenced by RepBase::setHighLighted().

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

The name of the representation.

Definition at line 49 of file RepBase.h.
Referenced by AverageTextRep::AverageTextRep(), ColorSymbolPointRep::ColorSymbolPointRep(), RepBase::displayError(), ContourPointRep::init(), and RepBase::name().

std::string RepBase::m_text [protected, inherited]

The text to be displayed before the statistics.

Definition at line 52 of file RepBase.h.
Referenced by BoxTextRep::drawProjectedValues(), and RepBase::setText().

double ErrorBarRep::m_x_cap [private]

The X error bar cap length.

Definition at line 46 of file ErrorBarRep.h.
Referenced by drawProjectedValues(), and drawXError().

std::vector< double > ErrorBarRep::m_x_err [private]

A cache of the X errors.

See also:
SymbolPointRep::m_x

Definition at line 32 of file ErrorBarRep.h.
Referenced by drawProjectedValues(), drawXError(), and drawYError().

bool ErrorBarRep::m_x_flag [private]

The X error flag.
If set true, error bars along the X axis are generated.
Definition at line 39 of file ErrorBarRep.h.
Referenced by drawProjectedValues(), and setXError().

Range ErrorBarRep::m_x_range [private]

The X axis range for cap calculation.

Definition at line 52 of file ErrorBarRep.h.
Referenced by drawYError(), and getRanges().

double ErrorBarRep::m_y_cap [private]

The Y error bar cap length.

Definition at line 49 of file ErrorBarRep.h.
Referenced by drawProjectedValues(), and drawYError().

std::vector< double > ErrorBarRep::m_y_err [private]

A cache of the Y errors.

See also:
SymbolPointRep::m_x

Definition at line 35 of file ErrorBarRep.h.
Referenced by drawProjectedValues(), drawXError(), and drawYError().

bool ErrorBarRep::m_y_flag [private]

The Y error flag.
If set true, error bars along the Y axis are generated.
Definition at line 43 of file ErrorBarRep.h.
Referenced by drawProjectedValues(), and setYError().

Range ErrorBarRep::m_y_range [private]

The Y axis range for cap calculation.

Definition at line 55 of file ErrorBarRep.h.
Referenced by drawXError(), and getRanges().

const Color RepBase::s_desel_color [static, protected, inherited]

The color of the representation when it is de-selected.

Referenced by RepBase::color(), CutRangeRep::drawInvertedRange1D(), CutRangeRep::drawInvertedRange2D(), and CutRangeRep::drawNormalRange().

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

Generated for HippoDraw-1.14.8.5 by

1.4.3


Public Member Functions
RepBase *	clone ()
	The clone function returns an object of its own kind which is a copy of this object at this moment.
virtual const Color &	color () const
	Returns the representation's color.
virtual void	displayError (ViewBase &view)
	Display an error message.
virtual void	drawProjectedValues (const DataSource ntuple, TransformBase transform, ViewBase *view)
	Draws the projected values.
	ErrorBarRep ()
	The default constructor.
virtual const Color &	getColor () const
	Get the color of the representation.
virtual unsigned int	getStyle () const
	Returns the style of the point representation.
virtual const BinToColor *	getValueTransform () const
	Returns the value transform.
virtual bool	isSelected () const
	Returns `true` if representation is in selected state, otherwise returns `false`.
const std::string &	name () const
	Returns the name of the representation.
virtual void	setColor (const Color &)
	Sets the color of the representation.
virtual void	setErrorOn (const std::string &axis, bool yes=true)
	Sets the error representation on specified axis, if any, to yes.
virtual void	setHighLighted (bool yes)
	Sets the highlighted state of the point representation.
virtual void	setSelected (bool yes=true)
	Sets the representation to be selected if yes is `true`, otherwise set it to be deselected.
void	setSize (float value)
	Sets the size of the representation.
virtual void	setStyle (unsigned int style)
	Sets the symbol of the representation.
void	setText (const std::string &text)
	Sets the text.
virtual void	setValueTransform (BinToColor *)
	Sets the value transform.
void	setXError (bool)
	Sets the flag to plot the errors on the X axis.
void	setYError (bool)
	Sets the flag to plot the errors on the Y axis.
float	size () const
	Returns the size of the representation.
virtual bool	xError () const
	Returns true if the point representation displays error on the X axis.
virtual bool	yError () const
	Returns true if the point representation displays error on the Y axis.
	~ErrorBarRep ()
	The destructor.
Protected Attributes
Color	m_color
	The color of the representation.
bool	m_desel
	A flag to indicate the representation is de-selected.
bool	m_highlite
	Sets the state of highlighting.
std::string	m_name
	The name of the representation.
float	m_size
	The size of the representation.
std::string	m_text
	The text to be displayed before the statistics.
Static Protected Attributes
static const Color	s_desel_color
	The color of the representation when it is de-selected.
Private Member Functions
void	drawXError (double x, double y, double error, ViewBase &vb, const TransformBase &t)
	Creates the line segment for the X error bar.
void	drawYError (double x, double y, double error, ViewBase &vb, const TransformBase &t)
	Creates the line segment for the Y error bar.
void	getRanges (const DataSource *ntuple)
	Gets the ranges of the data.
Private Attributes
double	m_x_cap
	The X error bar cap length.
std::vector< double >	m_x_err
	A cache of the X errors.
bool	m_x_flag
	The X error flag.
Range	m_x_range
	The X axis range for cap calculation.
double	m_y_cap
	The Y error bar cap length.
std::vector< double >	m_y_err
	A cache of the Y errors.
bool	m_y_flag
	The Y error flag.
Range	m_y_range
	The Y axis range for cap calculation.