BinningProjector Class Reference

#include <BinningProjector.h>

Inheritance diagram for BinningProjector:

[legend]Collaboration diagram for BinningProjector:

[legend]List of all members.

---

Detailed Description

The BinningProjector is an abstract class provides most of the functionality for a projector that does some from of binning along the one or more axes.

Author:

Stephane Bonneaud <gandalf@slac.stanford.edu>

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

Matan Shacham <matan@slac.stanford.edu>

Oded Wurman <owurman@stanford.edu>

Definition at line 32 of file BinningProjector.h.

Public Types
typedef void(hippodraw::Observer::*	Action )(const Observable *)
	The member function of the Observer that is called.
typedef std::list< hippodraw::Observer * >	ObserverList_t
	The type of STL container to maintain list of Observer objects.
Public Member Functions
void	addObserver (hippodraw::Observer *)
	Adds an Observer to the Observer list.
virtual void	addValues (const std::vector< double > &v)
	Add values to the projection.
virtual ProjectorBase *	clone ()=0
	The clone function returns an object of its own kind which is a copy of this object at this moment.
virtual DataSource *	createNTuple () const
	Returns an NTuple representing the binned values.
virtual const DataSource *	createOldStyleNTuple () const
	Creates and returns NTuple object.
virtual Range	dataRangeOn (hippodraw::Axes::Type) const =0
	Returns the range of the raw data.
virtual double	getAverage (hippodraw::Axes::Type axis) const
	Get the Average of all projected values on the specified axis.
virtual const std::vector< std::string > &	getAxisBindings () const
	Returns the axis bindings.
virtual AxisModelBase *	getAxisModel (hippodraw::Axes::Type axis) const
	Get the AxisModel for axis axis.
const BinsBase *	getBinner () const
	Returns reference to BinsBase object used by this projector.
double	getBinWidth (hippodraw::Axes::Type axis) const
	Returns the bin width of the axis.
virtual NTuple *	getNTupleAfterCuts () const
	Template for projectors that can return subsets of the NTuple used by the DataRep.
virtual int	getNumberOfBins (hippodraw::Axes::Type axis) const
	Returns the number of bins.
virtual int	getNumberOfEntries () const =0
	Returns the total number of entries that went into creating the projected values.
const ObserverList_t &	getObservers () const
	Returns the list of observers.
double	getOffset (hippodraw::Axes::Type axis) const
	Returns the offset of the axis.
const std::vector< std::string > &	getPointReps () const
	Return the vector of Point Reps.
virtual double	getPosOn (hippodraw::Axes::Type) const =0
	Returns the minimum positive value.
const DataSource *	getProjectedValues () const
	Returns ntuple representation of projected values.
virtual const Range &	getRange (hippodraw::Axes::Type) const
	Returns the Range along the specified axis.
virtual double	getRMS (hippodraw::Axes::Type axis)
	Returns the RMS.
virtual const std::string &	getTitle () const =0
	Finds the title of the plot.
virtual const std::string &	getXLabel () const =0
	Finds the X axis label of the plot.
virtual const std::string &	getYLabel (bool flag=false) const =0
	Finds the Y axis label of the plot.
virtual const std::string &	getZLabel () const
	Finds the Z axis label of the plot.
virtual double	getZValue (double x, double y) const
	Get the z value at the specified point (x,y).
virtual bool	isAxisBinned (const std::string &axis) const
	Returns true if specified axis is binned.
bool	isDirty () const
	Returns true if the projector has been marked dirty.
virtual bool	isEmpty () const =0
	Returns true if the data source used by this projector is empty.
virtual bool	isValueBinned () const
	Returns true if the projected values are the result of binning.
virtual void	matrixTranspose (bool yes)
	Transposes the X and Y axis.
virtual void	normalize ()
	Normalizes the projector to its target.
virtual void	normalizeTo (const ProjectorBase *target)
	Normalize the output of the receiving object's projected values to that of target.
virtual void	normalizeTo (double number)
	Sets a scale factor on the output so that the number of entries appears to be number.
virtual void	notifyObservers () const
	Notifies Observer objects of a change.
virtual Range	preferredRange (hippodraw::Axes::Type) const
	Returns the preferred Range.
virtual void	prepareValues ()
	Prepares the projector for plotting by executing, if needed, the binning procedure.
void	removeObserver (hippodraw::Observer *)
	Removes an Observer from the Observer list.
virtual void	reset ()
	Resets the bins.
virtual void	setAxisBinding (const std::string &axis, const std::string &label)
	Sets the axis binding.
virtual void	setAxisBindings (const std::vector< std::string > &bindings)
	Sets the axis binding.
virtual void	setAxisModel (hippodraw::Axes::Type, AxisModelBase *)
	Sets the AxisModel for axis axis.
void	setBinContents (const DataSource *source)
	Sets the contents of the bins from the data source.
void	setBinner (BinsBase *bins)
	Sets the BinsBase object to be used by this projector.
virtual void	setBinnerOn (BinnerAxis *binner, hippodraw::Axes::Type axis)
	Sets the bin edge calculator to binner on axis axis.
virtual void	setBinnerRange (hippodraw::Axes::Type axis, const Range &range, bool const_width)=0
	Sets the Range of the binner.
virtual void	setBinWidth (const std::string &axis, int parm, bool dragging)
	Sets the bin width.
virtual void	setBinWidth (hippodraw::Axes::Type axis, double width)
virtual void	setDirty (bool value=true)
	Sets the dirty flag to value.
virtual void	setNormalizing (bool on)
	Sets the scaling number of entries on if on is true, otherwise turns if off.
virtual void	setNumberOfBins (hippodraw::Axes::Type axis, unsigned int number)
	Sets the number of bins.
virtual void	setOffset (hippodraw::Axes::Type axis, double offset)
	Sets the bin offset.
virtual void	setOffset (const std::string &axis, int parm, bool dragging)
	Sets the bin offset.
virtual void	setRange (hippodraw::Axes::Type axis, bool const_width=true)
	Sets the range of the selected axis.
virtual void	setRange (hippodraw::Axes::Type, const Range &range, bool)
	Sets the range of the binner.
virtual void	update (const Observable *object)
	Updates the receiving projector.
virtual Range	valueRange () const =0
	Finds the range of the projected values.
virtual bool	wantsScaleFactor (const std::string &axis) const
	Returns whether the projector wants scale factor.
virtual void	willDelete (const Observable *object)
	If object is the target of normalization, removes the target and sets normalization off.
	~BinningProjector ()
	The destructor.
Protected Member Functions
virtual void	addPointReps ()=0
	Function to add the acceptable point reps.
	BinningProjector (const BinningProjector &projector)
	The copy constructor.
	BinningProjector (unsigned int axes)
	The following constructor takes the number of axes used by the BinsBase object.
virtual void	checkScaling ()
	Checks and sets if an AxisModelBase object on an axis should be scaled.
virtual void	execute ()
	Provides the all the data to the binner.
virtual void	fillDataSource (DataSource *ntuple, bool in_range=false) const
	Fills the DataSource source with the projected values.
virtual void	fillProjectedValues (DataSource *ntuple, bool in_range=false) const
	Fills the NTuple ntuple with the projected values.
void	notifyObservers (Action action) const
	An internal method to iterate over all observers and to send the message action.
Protected Attributes
BinsBase *	m_binner
	The binner object.
std::vector< std::string >	m_pointreps
	Vector of acceptable PointReps.
DataSource *	m_proj_values
	The NTuple representing the result of the projection.
const ProjectorBase *	m_target
	The target projector.
AxisModelBase *	m_x_axis
	The AxisModel along the X axis.
AxisModelBase *	m_y_axis
	The AxisModel along the Y axis.
AxisModelBase *	m_z_axis
	The AxisModel along the Z axis.
std::string	m_z_label
	Dummy member so that getZLabel can return a reference.
Private Attributes
unsigned int	m_binner_dim
	The number of AxesType accepted by the binner.

---

Member Typedef Documentation

typedef void( hippodraw::Observer::* Observable::Action)(const Observable *) [inherited]

The member function of the Observer that is called. Definition at line 83 of file Observable.h.

typedef std::list< hippodraw::Observer * > Observable::ObserverList_t [inherited]

The type of STL container to maintain list of Observer objects. Definition at line 46 of file Observable.h.

---

Constructor & Destructor Documentation

BinningProjector::BinningProjector (  unsigned int  axes  )  [protected]

The following constructor takes the number of axes used by the BinsBase object. Definition at line 38 of file BinningProjector.cxx.

BinningProjector::BinningProjector (  const BinningProjector &  projector  )  [protected]

The copy constructor. Definition at line 44 of file BinningProjector.cxx. References BinsBase::clone(), createNTuple(), fillDataSource(), m_binner, and ProjectorBase::m_proj_values.

BinningProjector::~BinningProjector (   )

The destructor. Definition at line 57 of file BinningProjector.cxx. References m_binner.

---

Member Function Documentation

void Observable::addObserver (  hippodraw::Observer *   )  [inherited]

Adds an Observer to the Observer list. Definition at line 49 of file Observable.cxx. References Observable::m_list. Referenced by CutPlotter::addCutTarget(), XyPlotter::addDataRep(), FunctionRep::FunctionRep(), normalizeTo(), DataRepController::setAxisBindings(), DisplayController::setNTuple(), CutPlotter::setNTuple(), and TextPlotter::setParentDataRep().

virtual void ProjectorBase::addPointReps (   )  [protected, pure virtual, inherited]

Function to add the acceptable point reps. Todo: Why is this in the ProjectorBase and not DataRep ? Implemented in FunctionProjector, Hist1DProjImp, Hist2DProjImp, LineProjector, Map1Projector, Map2Projector, Map3Projector, MapMatrixProjector, Profile2DProjector, ProfileProjector, and StripChartProjector.

void ProjectorBase::addValues (  const std::vector< double > &  v  )  [virtual, inherited]

Add values to the projection. This method is provided as convenience for derived classes that respond to it. The implementation in this class does nothing. Reimplemented in StHist1DProjector, and StHist2DProjector. Definition at line 312 of file ProjectorBase.cxx.

void BinningProjector::checkScaling (   )  [protected, virtual]

Checks and sets if an AxisModelBase object on an axis should be scaled. This method maybe overridden by derived classes such as those that do histogramming. Reimplemented in Hist1DProjImp, and Hist2DProjImp. Definition at line 258 of file BinningProjector.cxx. Referenced by setAxisModel(), setBinnerOn(), ProfileProjector::setBinnerRange(), Profile2DProjector::setBinnerRange(), and setBinWidth().

virtual ProjectorBase* ProjectorBase::clone (   )  [pure virtual, inherited]

The clone function returns an object of its own kind which is a copy of this object at this moment. Implemented in DyHist1DProjector, DyHist2DProjector, FunctionProjector, LineProjector, Map1Projector, Map2Projector, Map3Projector, MapMatrixProjector, Profile2DProjector, ProfileProjector, StHist1DProjector, StHist2DProjector, and StripChartProjector. Referenced by DataRep::DataRep().

DataSource * BinningProjector::createNTuple (   )  const [virtual]

Returns an NTuple representing the binned values. Bug: @ If histogram is empty, then it appears an empty NTuple is returned. Implements ProjectorBase. Definition at line 272 of file BinningProjector.cxx. References BinsBase::createNTuple(), and m_binner. Referenced by BinningProjector(), createOldStyleNTuple(), and setBinner().

const DataSource * BinningProjector::createOldStyleNTuple (   )  const [virtual]

Creates and returns NTuple object. Creates an old style NTuple representation of the projected values, i.e. one in which the NTuple contains the bin width as the XERR instead of the half width. This member function exists for backward compatibility of deprecated functions. Reimplemented from ProjectorBase. Definition at line 84 of file BinningProjector.cxx. References createNTuple(), execute(), fillProjectedValues(), ProjectorBase::isDirty(), and m_binner.

virtual Range ProjectorBase::dataRangeOn (  hippodraw::Axes::Type   )  const [pure virtual, inherited]

Returns the range of the raw data. Implemented in DyHist1DProjector, DyHist2DProjector, FunctionProjector, LineProjector, Map1Projector, Map2Projector, Map3Projector, MapMatrixProjector, NTupleProjector, Profile2DProjector, ProfileProjector, StHist1DProjector, and StHist2DProjector. Referenced by ProjectorBase::preferredRange(), Hist2DProjImp::preferredRange(), Hist1DProjImp::preferredRange(), Hist2DProjImp::valueRange(), and Hist1DProjImp::valueRange().

void BinningProjector::execute (   )  [protected, virtual]

Provides the all the data to the binner. Todo: Is there away to avoid implementing this empty method. Reimplemented in DyHist1DProjector, DyHist2DProjector, Profile2DProjector, and ProfileProjector. Definition at line 253 of file BinningProjector.cxx. Referenced by createOldStyleNTuple(), and prepareValues().

void BinningProjector::fillDataSource (  DataSource *  ntuple, bool  in_range = false )  const [protected, virtual]

Fills the DataSource source with the projected values. Fills the DataSource source with the results of projecting the data source to projected values. Derived classes must implement this method. Clients, such as plotters or fitters, can then use getProjectedValues method to access the projected value data. The default behavior is to fill the DataSource with all values that are accepted by the TupleCut objects, if any. If in_range is equal to true, then the values used to fill the DataSource are further restricted to be within the axes ranges. Some derived classes may always use the default behavior. Implements ProjectorBase. Definition at line 286 of file BinningProjector.cxx. References m_binner. Referenced by BinningProjector(), and prepareValues().

void BinningProjector::fillProjectedValues (  DataSource *  ntuple, bool  in_range = false )  const [protected, virtual]

Fills the NTuple ntuple with the projected values. Fills the NTuple !ntuple with the results of projecting the data source to projected values. Derived classes must implement this method. Clients, such as plotters or fitters, can then use getProjectedValues method to access the projected value data. The default behavior is to fill the NTuple with all values that are accepted by the TupleCut objects, if any. If in_range is equal to true, then the values used to fill the NTuple are further restricted to be within the axes ranges. Some derived classes may always use the default behavior. Implements ProjectorBase. Definition at line 279 of file BinningProjector.cxx. References m_binner. Referenced by createOldStyleNTuple().

double ProjectorBase::getAverage (  hippodraw::Axes::Type  axis  )  const [virtual, inherited]

Get the Average of all projected values on the specified axis. Todo: this should be computed externally with the iterators Reimplemented in DyHist1DProjector, Map1Projector, MapMatrixProjector, NTupleProjector, StHist1DProjector, and StHist2DProjector. Definition at line 268 of file ProjectorBase.cxx. Referenced by AverageTextRep::drawProjectedValues().

const vector< string > & ProjectorBase::getAxisBindings (   )  const [virtual, inherited]

Returns the axis bindings. Returns the name associated with each axis. This member function should only be called with a derived class which can process it in a meaningful way. thus if this method is called on this base class, an assertion is raised. Reimplemented in NTupleProjector. Definition at line 99 of file ProjectorBase.cxx. Referenced by XYPlot::setAxisBindings().

AxisModelBase * ProjectorBase::getAxisModel (  hippodraw::Axes::Type  axis  )  const [virtual, inherited]

Get the AxisModel for axis axis. Definition at line 204 of file ProjectorBase.cxx. References ProjectorBase::m_x_axis, ProjectorBase::m_y_axis, ProjectorBase::m_z_axis, hippodraw::Axes::X, hippodraw::Axes::Y, and hippodraw::Axes::Z. Referenced by CompositePlotter::processReturnValue(), and ContourPointRep::setContourValues().

const BinsBase * BinningProjector::getBinner (   )  const

Returns reference to BinsBase object used by this projector. Definition at line 99 of file BinningProjector.cxx. References m_binner. Referenced by BinningProjectorXML::createChildren().

double BinningProjector::getBinWidth (  hippodraw::Axes::Type  axis  )  const [virtual]

Returns the bin width of the axis. Not all projectors has a notation of a bin width. This interface is declared for those that do. The implementation in this base class is to does nothing. Reimplemented from ProjectorBase. Definition at line 238 of file BinningProjector.cxx. References BinsBase::binWidth(), m_binner, m_binner_dim, hippodraw::Axes::X, hippodraw::Axes::Y, and hippodraw::Axes::Z.

NTuple * ProjectorBase::getNTupleAfterCuts (   )  const [virtual, inherited]

Template for projectors that can return subsets of the NTuple used by the DataRep. Reimplemented in NTupleProjector. Definition at line 324 of file ProjectorBase.cxx. Referenced by DataRep::getNTupleAfterCuts().

int BinningProjector::getNumberOfBins (  hippodraw::Axes::Type  axis  )  const [virtual]

Returns the number of bins. Returns number of bins if axis is binned, otherwise returns 0. Reimplemented from ProjectorBase. Definition at line 137 of file BinningProjector.cxx. References ProjectorBase::getNumberOfBins(), m_binner, m_binner_dim, BinsBase::numberOfBins(), hippodraw::Axes::X, and hippodraw::Axes::Y.

virtual int ProjectorBase::getNumberOfEntries (   )  const [pure virtual, inherited]

Returns the total number of entries that went into creating the projected values. It is up to derived classes to interpret what this means. Some may find it meaningless and raise an exception and/or assertion. Implemented in FunctionProjector, LineProjector, NTupleProjector, StHist1DProjector, and StHist2DProjector. Referenced by TotalTextRep::drawProjectedValues(), normalize(), and QtDisplay::numberOfEntries().

const Observable::ObserverList_t & Observable::getObservers (   )  const [inherited]

Returns the list of observers. Definition at line 57 of file Observable.cxx. References Observable::m_list.

double BinningProjector::getOffset (  hippodraw::Axes::Type  axis  )  const [virtual]

Returns the offset of the axis. Not all projectors has a notation of a bin width. This interface is declared for those that do. The implementation in this base class is to does nothing. Reimplemented from ProjectorBase. Definition at line 223 of file BinningProjector.cxx. References BinsBase::getOffset(), m_binner, m_binner_dim, hippodraw::Axes::X, hippodraw::Axes::Y, and hippodraw::Axes::Z.

const vector< string > & ProjectorBase::getPointReps (   )  const [inherited]

Return the vector of Point Reps. Definition at line 317 of file ProjectorBase.cxx. References ProjectorBase::m_pointreps.

virtual double ProjectorBase::getPosOn (  hippodraw::Axes::Type   )  const [pure virtual, inherited]

Returns the minimum positive value. Todo: Resolve if this method should be here. Implemented in DyHist1DProjector, DyHist2DProjector, FunctionProjector, LineProjector, Map1Projector, Map2Projector, Map3Projector, MapMatrixProjector, Profile2DProjector, ProfileProjector, StHist1DProjector, and StHist2DProjector. Referenced by DataRep::getPosRange(), Hist2DProjImp::setRange(), and Hist1DProjImp::setRange().

const DataSource * ProjectorBase::getProjectedValues (   )  const [inherited]

Returns ntuple representation of projected values. Definition at line 338 of file ProjectorBase.cxx. References ProjectorBase::m_proj_values. Referenced by BinningProjectorXML::createChildren(), ProjectorBase::createOldStyleNTuple(), StHist2DProjector::getAverage(), StHist1DProjector::getAverage(), MapMatrixProjector::getAverage(), Map1Projector::getAverage(), ProjectorBase::getRMS(), and FunctionProjector::initializeFunction().

const Range & ProjectorBase::getRange (  hippodraw::Axes::Type   )  const [virtual, inherited]

Returns the Range along the specified axis. The behavior implemented here is to return the range of the AxisModelBase owned by the PlotterBase. However, derived classes may override this function, such as projectors that have binners, if this behavior is incorrect. Definition at line 145 of file ProjectorBase.cxx. References AxisModelBase::getRange(), ProjectorBase::m_x_axis, ProjectorBase::m_y_axis, ProjectorBase::m_z_axis, hippodraw::Axes::X, hippodraw::Axes::Y, and hippodraw::Axes::Z. Referenced by LineProjector::dataRangeOn(), LineProjector::fillDataSource(), LineProjector::fillProjectedValues(), NTupleProjector::getAverage(), DyHist1DProjector::getAverage(), LineProjector::getPosOn(), and LineProjector::valueRange().

double ProjectorBase::getRMS (  hippodraw::Axes::Type  axis  )  [virtual, inherited]

Returns the RMS. Returns the root mean square of the data points along the axis axis. Definition at line 279 of file ProjectorBase.cxx. References ProjectorBase::getProjectedValues(), ProjectorHelper::stdCoord(), and hippodraw::Axes::X.

virtual const std::string& ProjectorBase::getTitle (   )  const [pure virtual, inherited]

Finds the title of the plot. Implemented in FunctionProjector, LineProjector, NTupleProjector, StHist1DProjector, and StHist2DProjector.

virtual const std::string& ProjectorBase::getXLabel (   )  const [pure virtual, inherited]

Finds the X axis label of the plot. A plotter may ask the projector for the default label. Implemented in FunctionProjector, LineProjector, Map1Projector, MapMatrixProjector, NTupleProjector, StHist1DProjector, and StHist2DProjector. Referenced by CompositePlotter::getLabel().

virtual const std::string& ProjectorBase::getYLabel (  bool  flag = false  )  const [pure virtual, inherited]

Finds the Y axis label of the plot. Derived classes should return a label for the Y axis that is meaningful for the kind of projection. The argument flag can be used to distinguish between two possible labels, depending on some state of the projector. Implemented in DyHist1DProjector, FunctionProjector, LineProjector, Map1Projector, MapMatrixProjector, NTupleProjector, StHist1DProjector, and StHist2DProjector. Referenced by CompositePlotter::getLabel().

const std::string & ProjectorBase::getZLabel (   )  const [virtual, inherited]

Finds the Z axis label of the plot. A plotter may ask the projector for the default label. Reimplemented in FunctionProjector, Hist2DProjImp, Map3Projector, MapMatrixProjector, and Profile2DProjector. Definition at line 292 of file ProjectorBase.cxx. References ProjectorBase::m_z_label. Referenced by NTupleProjector::getAverage(), and CompositePlotter::getLabel().

double BinningProjector::getZValue (  double  x, double  y )  const [virtual]

Get the z value at the specified point (x,y). Reimplemented from ProjectorBase. Definition at line 263 of file BinningProjector.cxx. References BinsBase::getZValue(), and m_binner.

bool ProjectorBase::isAxisBinned (  const std::string &  axis  )  const [virtual, inherited]

Returns true if specified axis is binned. An axis that is binned responds to the width and offset controls. This base class implementation returns false. Reimplemented in DyHist1DProjector, DyHist2DProjector, Profile2DProjector, ProfileProjector, StHist1DProjector, and StHist2DProjector. Definition at line 121 of file ProjectorBase.cxx. Referenced by CompositePlotter::getBinWidth(), CompositePlotter::getOffset(), DisplayController::isAxisBinned(), DisplayController::setBinner(), and setBinnerOn().

bool ProjectorBase::isDirty (   )  const [inherited]

Returns true if the projector has been marked dirty. A dirty projector is one whose projected values are invalid because of some change (e.g., an axis range has changed.) Definition at line 70 of file ProjectorBase.cxx. References ProjectorBase::m_isDirty. Referenced by createOldStyleNTuple(), Profile2DProjector::dataRangeOn(), DataRep::isDirty(), MapMatrixProjector::prepareValues(), Map2Projector::prepareValues(), FunctionProjector::prepareValues(), prepareValues(), and Profile2DProjector::valueRange().

virtual bool ProjectorBase::isEmpty (   )  const [pure virtual, inherited]

Returns true if the data source used by this projector is empty. Returns true if the data source used by this projector is empty, otherwise returns true. The data source is empty, i.e. has no data, then many member functions of this class can not respond with meaning full results. Implemented in FunctionProjector, LineProjector, NTupleProjector, StHist1DProjector, and StHist2DProjector. Referenced by DataRep::hasZeroRows().

bool ProjectorBase::isValueBinned (   )  const [virtual, inherited]

Returns true if the projected values are the result of binning. The implementation in this base class returns false. It maybe overridden in derived classes that do binning. Reimplemented in Hist1DProjImp, and Hist2DProjImp. Definition at line 126 of file ProjectorBase.cxx. Referenced by normalizeTo().

void ProjectorBase::matrixTranspose (  bool  yes  )  [virtual, inherited]

Transposes the X and Y axis. The implementation in this base class does nothing. Reimplemented in MapMatrixProjector. Definition at line 109 of file ProjectorBase.cxx.

void BinningProjector::normalize (   )  [virtual]

Normalizes the projector to its target. Definition at line 332 of file BinningProjector.cxx. References ProjectorBase::getNumberOfEntries(), ProjectorBase::m_target, norm, normalizeTo(), and ProjectorBase::setDirty(). Referenced by normalizeTo(), and update().

void BinningProjector::normalizeTo (  const ProjectorBase *  target  )  [virtual]

Normalize the output of the receiving object's projected values to that of target. Bug: Only works if target projector is binning projector Reimplemented from ProjectorBase. Definition at line 309 of file BinningProjector.cxx. References Observable::addObserver(), ProjectorBase::isValueBinned(), ProjectorBase::m_target, normalize(), Observable::removeObserver(), and setNormalizing().

void BinningProjector::normalizeTo (  double  number  )  [virtual]

Sets a scale factor on the output so that the number of entries appears to be number. This feature might be used, for example, to compare two histograms that have different number of entires by normalizing one to the other. Reimplemented from ProjectorBase. Definition at line 293 of file BinningProjector.cxx. References m_binner. Referenced by normalize().

void Observable::notifyObservers (  Action  action  )  const [protected, inherited]

An internal method to iterate over all observers and to send the message action. Definition at line 69 of file Observable.cxx. References std::bind2nd(), std::for_each(), Observable::m_list, and std::mem_fun().

void Observable::notifyObservers (   )  const [virtual, inherited]

Notifies Observer objects of a change. If interval counting is disabled, then Observer::Update is sent immediately. If interval counting is enabled, then the current count is incremented. If the current count is equal to the interval count, then the Observer::update message is sent and the current count reset to 0. Reimplemented in NTuple, FitsNTuple, RootNTuple, NumArrayTuple, ListTuple, and RootNTuple. Definition at line 90 of file Observable.cxx. References hippodraw::Observer::update(). Referenced by XyPlotter::addDataRep(), XyPlotter::addDataRepStacked(), FunctionController::addFunctionRep(), RTuple::addRow(), StHist2DProjector::addValues(), StHist1DProjector::addValues(), XyPlotter::autoScale(), Inspector::contourLevelsTextBox_returnPressed(), Inspector::contourSlider_valueChanged(), Inspector::contourTextBox_returnPressed(), FunctionRep::fitFunction(), NumArrayTuple::notifyObservers(), NTuple::notifyObservers(), ListTuple::notifyObservers(), RootNTuple::notifyObservers(), FitsNTuple::notifyObservers(), XyPlotter::removeDataRep(), FunctionRep::restoreParameters(), CutPlotter::setActive(), XyPlotter::setAutoRanging(), QtDisplay::setContourLevels(), CutPlotter::setCutColor(), XyPlotter::setCutEnabled(), XyPlotter::setCutInverted(), XyPlotter::setCutRangeAt(), ProjectorBase::setDirty(), DataRep::setErrorDisplay(), XyPlotter::setHighRange(), XyPlotter::setLabel(), PlotterBase::setLabel(), DataSource::setLabelAt(), DataSource::setLabels(), XyPlotter::setLowRange(), DataSource::setName(), DisplayController::setNTuple(), FunctionRep::setParameters(), DataRep::setRepColor(), DyHistogram::setRepresentation(), DataRep::setRepresentation(), DataRep::setRepSize(), DataRep::setRepStyle(), XyPlotter::setScaling(), PlotterBase::setTitle(), DataSource::setTitle(), XyPlotter::setTransform(), XyPlotter::setValueRep(), PlotterBase::update(), NTupleProjector::update(), DataRep::update(), CutPlotter::update(), update(), CutPlotter::updateTargets(), DataRep::~DataRep(), DataSource::~DataSource(), NTuple::~NTuple(), and RTuple::~RTuple().

Range ProjectorBase::preferredRange (  hippodraw::Axes::Type   )  const [virtual, inherited]

Returns the preferred Range. Returns the Range preferred by the projector. The default implementation in this base class is to return full range of the data on the axis. Derived classes, may need to override this implementation. Reimplemented in Hist1DProjImp, and Hist2DProjImp. Definition at line 163 of file ProjectorBase.cxx. References ProjectorBase::dataRangeOn(), Range::length(), Range::low(), Range::setHigh(), Range::setLow(), and hippodraw::Axes::Y. Referenced by DataRep::preferredRange().

void BinningProjector::prepareValues (   )  [virtual]

Prepares the projector for plotting by executing, if needed, the binning procedure. Reimplemented from ProjectorBase. Definition at line 72 of file BinningProjector.cxx. References execute(), fillDataSource(), ProjectorBase::isDirty(), ProjectorBase::m_proj_values, and ProjectorBase::setDirty(). Referenced by BinningProjectorXML::createChildren(), ProfileProjector::dataRangeOn(), Profile2DProjector::dataRangeOn(), Hist2DProjImp::dataRangeOnValue(), Hist1DProjImp::dataRangeOnValue(), StHist2DProjector::getAverage(), StHist1DProjector::getAverage(), and Profile2DProjector::valueRange().

void Observable::removeObserver (  hippodraw::Observer *   )  [inherited]

Removes an Observer from the Observer list. Definition at line 63 of file Observable.cxx. References Observable::m_list. Referenced by normalizeTo(), CutPlotter::removeFromTarget(), DisplayController::removeTextObservers(), NTupleProjector::setNTuple(), FunctionRep::willDelete(), FunctionRep::~FunctionRep(), and NTupleProjector::~NTupleProjector().

void BinningProjector::reset (   )  [virtual]

Resets the bins. This interface is for the StHist1DProjector Reimplemented from ProjectorBase. Reimplemented in Hist1DProjImp, and StHist1DProjector. Definition at line 217 of file BinningProjector.cxx.

void ProjectorBase::setAxisBinding (  const std::string &  axis, const std::string &  label )  [virtual, inherited]

Sets the axis binding. Sets binding of the axis with name axis to entity with name label. It is expected that this member function will only be called on a derived class which can process it in a meaningful way. Thus if this method is called on this base class, an assertion is thrown. Reimplemented in NTupleProjector. Definition at line 84 of file ProjectorBase.cxx.

void ProjectorBase::setAxisBindings (  const std::vector< std::string > &  bindings  )  [virtual, inherited]

Sets the axis binding. Sets binding of all axis entities with name in the vector. This member function should only be called with a derived class which can process it in a meaningful way. Thus if this method is called on this base class, an assertion is thrown. Reimplemented in NTupleProjector. Definition at line 92 of file ProjectorBase.cxx.

void BinningProjector::setAxisModel (  hippodraw::Axes::Type  , AxisModelBase *  )  [virtual]

Sets the AxisModel for axis axis. Reimplemented from ProjectorBase. Definition at line 66 of file BinningProjector.cxx. References checkScaling(), and ProjectorBase::setAxisModel().

void BinningProjector::setBinContents (  const DataSource *  source  )

Sets the contents of the bins from the data source. Note: This method should be called for derived classes which are static version of projection. If called on a dynamic version, the contents of the bins will be refreshed from the data source with which it is bound. Definition at line 365 of file BinningProjector.cxx. References m_binner.

void BinningProjector::setBinner (  BinsBase *  bins  )

Sets the BinsBase object to be used by this projector. Definition at line 106 of file BinningProjector.cxx. References createNTuple(), m_binner, and ProjectorBase::m_proj_values. Referenced by BinningProjectorXML::getObject().

void BinningProjector::setBinnerOn (  BinnerAxis *  binner, hippodraw::Axes::Type  type )  [virtual]

Sets the bin edge calculator to binner on axis axis. Todo: Remove this member function when AxesType is no longer used. Definition at line 118 of file BinningProjector.cxx. References checkScaling(), ProjectorBase::isAxisBinned(), m_binner, BinsBase::setBinnerOn(), ProjectorBase::setDirty(), hippodraw::Axes::X, and hippodraw::Axes::Y. Referenced by DisplayController::setBinner().

virtual void BinningProjector::setBinnerRange (  hippodraw::Axes::Type  axis, const Range &  range, bool  const_width )  [pure virtual]

Sets the Range of the binner. See documentation for derived classes for behavior of this member function. Implemented in DyHist1DProjector, DyHist2DProjector, Profile2DProjector, ProfileProjector, StHist1DProjector, and StHist2DProjector. Referenced by Hist2DProjImp::setRange(), and Hist1DProjImp::setRange().

void BinningProjector::setBinWidth (  const std::string &  axis, int  parm, bool  dragging )  [virtual]

Sets the bin width. This method is intended to be used in conjunction with a slider widget in a graphical user interface. The slider range is assumed to be 0 to 100 with the current value at parm. If the slider is still being dragged, then dragging is true, otherwise it is false. A derived class determines withs own bin width based on the width it had when slider dragging first started. and the current position of the slider. The implementation in this base class does nothing. Reimplemented from ProjectorBase. Reimplemented in DyHist2DProjector, and Profile2DProjector. Definition at line 179 of file BinningProjector.cxx. References BinsBase::calcBinWidth(), m_binner, setBinWidth(), and hippodraw::Axes::X.

void BinningProjector::setBinWidth (  hippodraw::Axes::Type  axis, double  width )  [virtual]

Todo: Derived classes that reimplement this member function do so with only difference being the assert. Redesigned to avoid duplication of code. Reimplemented from ProjectorBase. Reimplemented in Hist2DProjImp, and Profile2DProjector. Definition at line 164 of file BinningProjector.cxx. References checkScaling(), m_binner, BinsBase::setBinWidth(), ProjectorBase::setDirty(), hippodraw::Axes::X, and hippodraw::Axes::Y. Referenced by setBinWidth().

void ProjectorBase::setDirty (  bool  value = true  )  [virtual, inherited]

Sets the dirty flag to value. Definition at line 75 of file ProjectorBase.cxx. References ProjectorBase::m_isDirty, and Observable::notifyObservers(). Referenced by StHist2DProjector::addValues(), StHist1DProjector::addValues(), Profile2DProjector::dataRangeOn(), FunctionProjector::fitFunction(), StHist2DProjector::getAverage(), StHist1DProjector::getAverage(), normalize(), FunctionProjector::prepareAxis(), ProjectorBase::prepareValues(), MapMatrixProjector::prepareValues(), Map3Projector::prepareValues(), Map2Projector::prepareValues(), Map1Projector::prepareValues(), LineProjector::prepareValues(), FunctionProjector::prepareValues(), prepareValues(), StHist1DProjector::reset(), FunctionProjector::restoreParameters(), NTupleProjector::setAxisBinding(), setBinnerOn(), StHist2DProjector::setBinnerRange(), StHist1DProjector::setBinnerRange(), ProfileProjector::setBinnerRange(), Profile2DProjector::setBinnerRange(), DyHist2DProjector::setBinnerRange(), DyHist1DProjector::setBinnerRange(), Profile2DProjector::setBinWidth(), Hist2DProjImp::setBinWidth(), setBinWidth(), DataRep::setDirty(), NTupleProjector::setNTuple(), MapMatrixProjector::setNTuple(), Profile2DProjector::setOffset(), Hist2DProjImp::setOffset(), DyHist2DProjector::setOffset(), setOffset(), FunctionProjector::setParameters(), ProjectorBase::setRange(), Profile2DProjector::setRange(), FunctionProjector::setRange(), NTupleProjector::update(), and willDelete().

void BinningProjector::setNormalizing (  bool  on  )  [virtual]

Sets the scaling number of entries on if on is true, otherwise turns if off. Reimplemented from ProjectorBase. Definition at line 300 of file BinningProjector.cxx. References m_binner. Referenced by normalizeTo(), and willDelete().

void ProjectorBase::setNumberOfBins (  hippodraw::Axes::Type  axis, unsigned int  number )  [virtual, inherited]

Sets the number of bins. Sets the number of bins along the axis axis to number. Not all projectors has a notation of a bin width. This interface is declared for those that do. The implementation in this base class is to does nothing. Reimplemented in MapMatrixProjector. Definition at line 221 of file ProjectorBase.cxx. Referenced by CompositePlotter::setNumberOfBins().

void BinningProjector::setOffset (  hippodraw::Axes::Type  axis, double  offset )  [virtual]

Sets the bin offset. Sets the offset of bins by fraction offset of the bin width. Not all projectors has a notation of a bin width. This interface is declared for those that do. The implementation in this base class is to does nothing. Reimplemented from ProjectorBase. Reimplemented in Hist2DProjImp, and Profile2DProjector. Definition at line 206 of file BinningProjector.cxx. References BinsBase::getRange(), m_binner, ProjectorBase::m_x_axis, ProjectorBase::setDirty(), BinsBase::setOffset(), AxisModelBase::setRange(), hippodraw::Axes::X, and hippodraw::Axes::Y.

void BinningProjector::setOffset (  const std::string &  axis, int  parm, bool  dragging )  [virtual]

Sets the bin offset. See also: setBinWidth ( const std::string &, int, bool ) Reimplemented from ProjectorBase. Reimplemented in DyHist2DProjector, and Profile2DProjector. Definition at line 190 of file BinningProjector.cxx. References BinsBase::calcOffset(), m_binner, ProjectorBase::setDirty(), and hippodraw::Axes::X.

void ProjectorBase::setRange (  hippodraw::Axes::Type  axis, bool  const_width = true )  [virtual, inherited]

Sets the range of the selected axis. The base class implementation only sets the dirty flag. Derived classes may need to do more. The option bool parameter if true indicates a binning projector should hold the bin width parameter constant. Reimplemented in FunctionProjector, Hist1DProjImp, Hist2DProjImp, Profile2DProjector, and ProfileProjector. Definition at line 133 of file ProjectorBase.cxx. References ProjectorBase::m_z_axis, ProjectorBase::setDirty(), hippodraw::Axes::X, hippodraw::Axes::Y, and hippodraw::Axes::Z. Referenced by DataRep::setRange().

void BinningProjector::setRange (  hippodraw::Axes::Type  , const Range &  range, bool  )  [virtual]

Sets the range of the binner. Definition at line 151 of file BinningProjector.cxx. References m_binner, BinsBase::setRange(), hippodraw::Axes::X, and hippodraw::Axes::Y.

void BinningProjector::update (  const Observable *  object  )  [virtual]

Updates the receiving projector. If the projector is normalizing to a target projector and object is the target, then re-normalizes itself. If not, then notifies its observers. Reimplemented from ProjectorBase. Reimplemented in DyHist1DProjector, DyHist2DProjector, Profile2DProjector, and ProfileProjector. Definition at line 343 of file BinningProjector.cxx. References ProjectorBase::m_target, normalize(), and Observable::notifyObservers(). Referenced by ProfileProjector::update(), Profile2DProjector::update(), DyHist2DProjector::update(), and DyHist1DProjector::update().

virtual Range ProjectorBase::valueRange (   )  const [pure virtual, inherited]

Finds the range of the projected values. It is up to derived classes to determine what this means. Todo: Resolve if this method should be here. Implemented in FunctionProjector, Hist1DProjImp, Hist2DProjImp, LineProjector, Map1Projector, Map2Projector, Map3Projector, MapMatrixProjector, Profile2DProjector, and ProfileProjector.

bool ProjectorBase::wantsScaleFactor (  const std::string &  axis  )  const [virtual, inherited]

Returns whether the projector wants scale factor. Returns true if the projector wants to scale the axis, otherwise returns false. A projector supporting a histogram, for example, would want to scale the Y axis by the bin width in order to show entries per bin instead of density. This base class implementation always returns false. Reimplemented in Hist1DProjImp, and Hist2DProjImp. Definition at line 331 of file ProjectorBase.cxx. Referenced by CompositePlotter::checkAxisScaling().

void BinningProjector::willDelete (  const Observable *  object  )  [virtual]

If object is the target of normalization, removes the target and sets normalization off. Reimplemented from hippodraw::Observer. Reimplemented in DyHist1DProjector, DyHist2DProjector, Profile2DProjector, and ProfileProjector. Definition at line 354 of file BinningProjector.cxx. References ProjectorBase::m_target, ProjectorBase::setDirty(), and setNormalizing(). Referenced by ProfileProjector::willDelete(), Profile2DProjector::willDelete(), DyHist2DProjector::willDelete(), and DyHist1DProjector::willDelete().

---

Member Data Documentation

BinsBase* BinningProjector::m_binner [protected]

The binner object. Some derived classes need a BinsBase object to accumulate data before the projection can be accomplished. Such classes should create the appropriate type of binner and store a pointer to it here. A null pointer value signals that the derived class projector does not need a binner. Definition at line 49 of file BinningProjector.h. Referenced by StHist2DProjector::addValues(), StHist1DProjector::addValues(), BinningProjector(), ProfileProjector::changedNTuple(), Profile2DProjector::changedNTuple(), DyHist2DProjector::changedNTuple(), DyHist1DProjector::changedNTuple(), Hist2DProjImp::checkScaling(), Hist1DProjImp::checkScaling(), createNTuple(), createOldStyleNTuple(), StHist2DProjector::dataRangeOn(), StHist1DProjector::dataRangeOn(), ProfileProjector::execute(), Profile2DProjector::execute(), DyHist2DProjector::execute(), DyHist1DProjector::execute(), fillDataSource(), fillProjectedValues(), getBinner(), getBinWidth(), getNumberOfBins(), StHist2DProjector::getNumberOfEntries(), StHist1DProjector::getNumberOfEntries(), getOffset(), getZValue(), Hist1DProjImp::Hist1DProjImp(), Hist2DProjImp::Hist2DProjImp(), normalizeTo(), Profile2DProjector::Profile2DProjector(), ProfileProjector::ProfileProjector(), StHist1DProjector::reset(), setBinContents(), setBinner(), setBinnerOn(), StHist2DProjector::setBinnerRange(), StHist1DProjector::setBinnerRange(), ProfileProjector::setBinnerRange(), Profile2DProjector::setBinnerRange(), DyHist2DProjector::setBinnerRange(), DyHist1DProjector::setBinnerRange(), Profile2DProjector::setBinWidth(), Hist2DProjImp::setBinWidth(), DyHist2DProjector::setBinWidth(), setBinWidth(), setNormalizing(), Profile2DProjector::setOffset(), Hist2DProjImp::setOffset(), DyHist2DProjector::setOffset(), setOffset(), ProfileProjector::setRange(), Hist1DProjImp::setRange(), setRange(), and ~BinningProjector().

unsigned int BinningProjector::m_binner_dim [private]

The number of AxesType accepted by the binner. If the value is 1, then only X is accepted. A value of 2 accepts X and Y, etc. Definition at line 40 of file BinningProjector.h. Referenced by getBinWidth(), getNumberOfBins(), and getOffset().

std::vector< std::string > ProjectorBase::m_pointreps [protected, inherited]

Vector of acceptable PointReps. Definition at line 98 of file ProjectorBase.h. Referenced by StripChartProjector::addPointReps(), ProfileProjector::addPointReps(), Profile2DProjector::addPointReps(), MapMatrixProjector::addPointReps(), Map3Projector::addPointReps(), Map2Projector::addPointReps(), Map1Projector::addPointReps(), Hist2DProjImp::addPointReps(), Hist1DProjImp::addPointReps(), and ProjectorBase::getPointReps().

DataSource* ProjectorBase::m_proj_values [protected, inherited]

The NTuple representing the result of the projection. Note: An NTuple object is probably too heavy for non-binning projectors. In the future, we'll create a class which behaves like one, but maps the data from the data source NTuple to required getRow(). Definition at line 73 of file ProjectorBase.h. Referenced by BinningProjector(), ProfileProjector::dataRangeOn(), Profile2DProjector::dataRangeOn(), Hist2DProjImp::dataRangeOnValue(), Hist1DProjImp::dataRangeOnValue(), DyHist1DProjector::getAverage(), ProfileProjector::getPosOn(), ProjectorBase::getProjectedValues(), Map3Projector::getZValue(), MapMatrixProjector::prepareValues(), Map3Projector::prepareValues(), Map2Projector::prepareValues(), Map1Projector::prepareValues(), LineProjector::prepareValues(), FunctionProjector::prepareValues(), prepareValues(), setBinner(), and ProjectorBase::~ProjectorBase().

const ProjectorBase* ProjectorBase::m_target [protected, inherited]

The target projector. Use of the target depends on derived classes. Target projector are observed, thus some of the implement is define in this base class. Reimplemented in FunctionProjector. Definition at line 104 of file ProjectorBase.h. Referenced by normalize(), normalizeTo(), update(), and willDelete().

AxisModelBase* ProjectorBase::m_x_axis [protected, inherited]

The AxisModel along the X axis. All Projectors have at least an X axis and maybe additional ones. Todo: Should be generalized to n-dimensions by having having a vector of AxisModelBase objects. Definition at line 82 of file ProjectorBase.h. Referenced by LineProjector::dataRangeOn(), FunctionProjector::dataRangeOn(), LineProjector::fillDataSource(), LineProjector::fillProjectedValues(), ProjectorBase::getAxisModel(), LineProjector::getPosOn(), ProjectorBase::getRange(), Map3Projector::getZValue(), NTupleProjector::inRange(), MapMatrixProjector::inRange(), Map1Projector::inRange(), FunctionProjector::prepareAxis(), ProjectorBase::setAxisModel(), FunctionProjector::setAxisModel(), Profile2DProjector::setOffset(), Hist2DProjImp::setOffset(), setOffset(), ProfileProjector::setRange(), Profile2DProjector::setRange(), Hist2DProjImp::setRange(), Hist1DProjImp::setRange(), FunctionProjector::setRange(), and LineProjector::valueRange().

AxisModelBase* ProjectorBase::m_y_axis [protected, inherited]

The AxisModel along the Y axis. All Projectors have at least a Y axis and maybe additional ones. Definition at line 86 of file ProjectorBase.h. Referenced by Hist1DProjImp::checkScaling(), LineProjector::dataRangeOn(), FunctionProjector::dataRangeOn(), LineProjector::fillDataSource(), LineProjector::fillProjectedValues(), StHist1DProjector::getAverage(), DyHist1DProjector::getAverage(), ProjectorBase::getAxisModel(), LineProjector::getPosOn(), ProjectorBase::getRange(), DyHist1DProjector::getYLabel(), Map3Projector::getZValue(), NTupleProjector::inRange(), MapMatrixProjector::inRange(), Map1Projector::inRange(), FunctionProjector::prepareAxis(), ProjectorBase::setAxisModel(), FunctionProjector::setAxisModel(), Profile2DProjector::setOffset(), Hist2DProjImp::setOffset(), Profile2DProjector::setRange(), Hist2DProjImp::setRange(), FunctionProjector::setRange(), and LineProjector::valueRange().

AxisModelBase* ProjectorBase::m_z_axis [protected, inherited]

The AxisModel along the Z axis. May not be used by all Projectors. Definition at line 90 of file ProjectorBase.h. Referenced by Hist2DProjImp::checkScaling(), StHist2DProjector::getAverage(), ProjectorBase::getAxisModel(), ProjectorBase::getRange(), Hist2DProjImp::getZLabel(), NTupleProjector::inRange(), MapMatrixProjector::inRange(), ProjectorBase::setAxisModel(), and ProjectorBase::setRange().

std::string ProjectorBase::m_z_label [protected, inherited]

Dummy member so that getZLabel can return a reference. Todo: Remove when getLabel takes axis argument Reimplemented in FunctionProjector, and StHist2DProjector. Definition at line 95 of file ProjectorBase.h. Referenced by ProjectorBase::getZLabel().

---

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

• BinningProjector.h
• BinningProjector.cxx

---