StHist2DProjector Class Reference

#include <StHist2DProjector.h>

Inheritance diagram for StHist2DProjector:

[legend]Collaboration diagram for StHist2DProjector:

[legend]List of all members.

---

Detailed Description

A derived class of ProjectorBase that projects data accumulated by calls to its addValues function into a two dimensional histogram.

A NTuple is created and presented to a clients. The binning parameters are fixed hence it is called static 2D histogram.

Author:

Paul_Kunz@slac.stanford.edu>

Definition at line 27 of file StHist2DProjector.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 the values to the histogram.
ProjectorBase *	clone ()
	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 axis) const
	Returns the range of the data on a specified axis.
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
	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 axis) const
	Returns the minimum positive value of the data on a specified axis.
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
	Finds the title of the plot.
const std::string &	getXLabel () const
	Returns the label (title) of the X axis.
const std::string &	getYLabel (bool flag=false) const
	Returns the label (title) of the Y axis.
const std::string &	getZLabel () const
	Returns the label (title) of the z axis.
const std::string &	getZLabel (bool flag=false) const
	Returns the label for the Z axis.
virtual double	getZValue (double x, double y) const
	Get the z value at the specified point (x,y).
virtual bool	hasZAxis () const
	A test function.
virtual bool	isAxisBinned (const std::string &axis) const
	Returns true if the intended axis is "X", otherwise returns false.
bool	isDirty () const
	Returns true if the projector has been marked dirty.
bool	isEmpty () const
	Returns false as this class' data source is never empty even if no filling has occurred yet.
virtual bool	isValueBinned () const
	Returns true as the projected value is the result of accumulation into bins.
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)
	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 v)
	This function sets the binWidth.
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 (const std::string &axis, int parm, bool dragging)
	Sets the bin offset.
virtual void	setOffset (hippodraw::Axes::Type axis, double v)
	Sets the bin offset.
virtual void	setRange (hippodraw::Axes::Type, const Range &range, bool)
	Sets the range of the binner.
virtual void	setRange (hippodraw::Axes::Type axis, bool)
	Sets the range of the selected axis.
void	setYLabel ()
	Sets the Y axis label.
	StHist2DProjector (const StHist2DProjector &projector)
	The copy constructor.
	StHist2DProjector ()
	The default constructor.
virtual void	update (const Observable *object)
	Updates the receiving projector.
virtual Range	valueRange () const
	Finds the range of the projected values.
virtual bool	wantsScaleFactor (const std::string &axis) const
	Returns true if axis is the Z axis.
virtual void	willDelete (const Observable *object)
	If object is the target of normalization, removes the target and sets normalization off.
Protected Member Functions
virtual void	addPointReps ()
	Function to add the acceptable point reps.
virtual void	checkScaling ()
	Checks the axis scaling.
Range	dataRangeOnValue () const
	Returns the data range on the Z axis.
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.
double	getPosOnValue () const
	Returns the smallest positive value on the Y axis.
void	notifyObservers (Action action) const
	An internal method to iterate over all observers and to send the message action.
void	setZLabel ()
	Sets the variable so that it can be modified.
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.
Private Attributes
std::string	m_title
	The title of the histogram.
std::string	m_x_label
	The label of the x axis.
std::string	m_y_label
	The label of the y axis.
std::string	m_z_label
	The label of the y axis.

---

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

StHist2DProjector::StHist2DProjector (   )

The default constructor. Definition at line 48 of file StHist2DProjector.cxx. References m_z_label. Referenced by clone().

StHist2DProjector::StHist2DProjector (  const StHist2DProjector &  projector  )

The copy constructor. Todo: Extra data members need to be copied. Definition at line 56 of file StHist2DProjector.cxx.

---

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(), BinningProjector::normalizeTo(), DataRepController::setAxisBindings(), DisplayController::setNTuple(), CutPlotter::setNTuple(), and TextPlotter::setParentDataRep().

void Hist2DProjImp::addPointReps (   )  [protected, virtual, inherited]

Function to add the acceptable point reps. Implements ProjectorBase. Definition at line 208 of file Hist2DProjImp.cxx. References ProjectorBase::m_pointreps. Referenced by Hist2DProjImp::Hist2DProjImp().

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

Add the values to the histogram. The first two elements of the vector is the value to be accumulated into the histogram. If the size of the vector is 3, then the third element is the weight, otherwise the weight is 1.0. Reimplemented from ProjectorBase. Definition at line 194 of file StHist2DProjector.cxx. References std::accumulate(), BinningProjector::m_binner, Observable::notifyObservers(), and ProjectorBase::setDirty().

void Hist2DProjImp::checkScaling (   )  [protected, virtual, inherited]

Checks the axis scaling. If bins are all same width, then sets the Z axis scale factor. Otherwise, turns off the scale factor on the Z axis. Reimplemented from BinningProjector. Definition at line 192 of file Hist2DProjImp.cxx. References BinsBase::hasEqualWidths(), BinningProjector::m_binner, ProjectorBase::m_z_axis, BinsBase::scaleFactor(), AxisModelBase::setScaleFactor(), and AxisModelBase::setScaling(). Referenced by setBinnerRange(), DyHist2DProjector::setBinnerRange(), and Hist2DProjImp::setBinWidth().

ProjectorBase * StHist2DProjector::clone (   )  [virtual]

The clone function returns an object of its own kind which is a copy of this object at this moment. Implements ProjectorBase. Definition at line 65 of file StHist2DProjector.cxx. References StHist2DProjector().

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

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 BinningProjector::m_binner. Referenced by BinningProjector::BinningProjector(), BinningProjector::createOldStyleNTuple(), and BinningProjector::setBinner().

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

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 BinningProjector::createNTuple(), BinningProjector::execute(), BinningProjector::fillProjectedValues(), ProjectorBase::isDirty(), and BinningProjector::m_binner.

Range StHist2DProjector::dataRangeOn (  hippodraw::Axes::Type  axis  )  const [virtual]

Returns the range of the data on a specified axis. For the X axis, it returns the range of the data. For the Y axis, it returns the range of the binned data. Todo: Implement special handling if histogram is empty. Implements ProjectorBase. Definition at line 93 of file StHist2DProjector.cxx. References Hist2DProjImp::dataRangeOnValue(), BinsBase::getRange(), BinningProjector::m_binner, hippodraw::Axes::X, hippodraw::Axes::Y, and hippodraw::Axes::Z.

Range Hist2DProjImp::dataRangeOnValue (   )  const [protected, inherited]

Returns the data range on the Z axis. Definition at line 101 of file Hist2DProjImp.cxx. References ProjectorBase::m_proj_values, BinningProjector::prepareValues(), and hippodraw::Axes::Z. Referenced by dataRangeOn(), DyHist2DProjector::dataRangeOn(), and Hist2DProjImp::getPosOnValue().

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

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 BinningProjector::createOldStyleNTuple(), and BinningProjector::prepareValues().

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

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 BinningProjector::m_binner. Referenced by BinningProjector::BinningProjector(), and BinningProjector::prepareValues().

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

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 BinningProjector::m_binner. Referenced by BinningProjector::createOldStyleNTuple().

double StHist2DProjector::getAverage (  hippodraw::Axes::Type  axis  )  const [virtual]

Get the Average of all projected values on the specified axis. Reimplemented from ProjectorBase. Definition at line 126 of file StHist2DProjector.cxx. References std::accumulate(), num_util::data(), ProjectorBase::getProjectedValues(), inner_product(), ProjectorBase::m_z_axis, BinningProjector::prepareValues(), ProjectorBase::setDirty(), hippodraw::Axes::X, hippodraw::Axes::Y, and hippodraw::Axes::Z.

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 [inherited]

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

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

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(), BinningProjector::m_binner, BinningProjector::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, inherited]

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(), BinningProjector::m_binner, BinningProjector::m_binner_dim, BinsBase::numberOfBins(), hippodraw::Axes::X, and hippodraw::Axes::Y.

int StHist2DProjector::getNumberOfEntries (   )  const [virtual]

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. Implements ProjectorBase. Definition at line 185 of file StHist2DProjector.cxx. References BinsBase::getNumberOfEntries(), and BinningProjector::m_binner.

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, inherited]

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(), BinningProjector::m_binner, BinningProjector::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.

double StHist2DProjector::getPosOn (  hippodraw::Axes::Type  axis  )  const [virtual]

Returns the minimum positive value of the data on a specified axis. Implements ProjectorBase. Definition at line 84 of file StHist2DProjector.cxx. References Hist2DProjImp::getPosOnValue(), hippodraw::Axes::X, hippodraw::Axes::Y, and hippodraw::Axes::Z.

double Hist2DProjImp::getPosOnValue (   )  const [protected, inherited]

Returns the smallest positive value on the Y axis. Definition at line 77 of file Hist2DProjImp.cxx. References Hist2DProjImp::dataRangeOnValue(), and Range::pos(). Referenced by getPosOn().

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(), 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.

const std::string & StHist2DProjector::getTitle (   )  const [virtual]

Finds the title of the plot. Implements ProjectorBase. Definition at line 178 of file StHist2DProjector.cxx. References m_title.

const string & StHist2DProjector::getXLabel (   )  const [virtual]

Returns the label (title) of the X axis. Implements ProjectorBase. Definition at line 107 of file StHist2DProjector.cxx. References m_x_label.

const string & StHist2DProjector::getYLabel (  bool  flag = false  )  const [virtual]

Returns the label (title) of the Y axis. The argument flag is ignored. Implements ProjectorBase. Definition at line 112 of file StHist2DProjector.cxx. References m_y_label.

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

Returns the label (title) of the z axis. Reimplemented from ProjectorBase. Definition at line 179 of file Hist2DProjImp.cxx. References AxisModelBase::isScaling(), ProjectorBase::m_z_axis, Hist2DProjImp::m_z_label_density, and Hist2DProjImp::m_z_label_entries.

const string & StHist2DProjector::getZLabel (  bool  flag = false  )  const

Returns the label for the Z axis. Returns the label for the Z axis. The argument @ flag is ignored. Definition at line 117 of file StHist2DProjector.cxx. References m_z_label.

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

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 BinningProjector::m_binner.

bool Hist2DProjImp::hasZAxis (   )  const [virtual, inherited]

A test function. Definition at line 187 of file Hist2DProjImp.cxx.

bool StHist2DProjector::isAxisBinned (  const std::string &  axis  )  const [virtual]

Returns true if the intended axis is "X", otherwise returns false. Todo: This method could have common implementation with DyHist2DProjector if the static projector initialized it binding options even thought they do not bind to NTuple. Reimplemented from ProjectorBase. Definition at line 74 of file StHist2DProjector.cxx.

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 BinningProjector::createOldStyleNTuple(), Profile2DProjector::dataRangeOn(), DataRep::isDirty(), MapMatrixProjector::prepareValues(), Map2Projector::prepareValues(), FunctionProjector::prepareValues(), BinningProjector::prepareValues(), and Profile2DProjector::valueRange().

bool StHist2DProjector::isEmpty (   )  const [virtual]

Returns false as this class' data source is never empty even if no filling has occurred yet. Implements ProjectorBase. Definition at line 208 of file StHist2DProjector.cxx. Referenced by setBinnerRange().

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

Returns true as the projected value is the result of accumulation into bins. Reimplemented from ProjectorBase. Definition at line 70 of file Hist2DProjImp.cxx.

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, inherited]

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

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

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, BinningProjector::normalize(), Observable::removeObserver(), and BinningProjector::setNormalizing().

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

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 BinningProjector::m_binner. Referenced by BinningProjector::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(), 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(), BinningProjector::update(), CutPlotter::updateTargets(), DataRep::~DataRep(), DataSource::~DataSource(), NTuple::~NTuple(), and RTuple::~RTuple().

Range Hist2DProjImp::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 from ProjectorBase. Definition at line 87 of file Hist2DProjImp.cxx. References ProjectorBase::dataRangeOn(), Range::setLow(), and hippodraw::Axes::Z.

void BinningProjector::prepareValues (   )  [virtual, inherited]

Prepares the projector for plotting by executing, if needed, the binning procedure. Reimplemented from ProjectorBase. Definition at line 72 of file BinningProjector.cxx. References BinningProjector::execute(), BinningProjector::fillDataSource(), ProjectorBase::isDirty(), ProjectorBase::m_proj_values, and ProjectorBase::setDirty(). Referenced by BinningProjectorXML::createChildren(), ProfileProjector::dataRangeOn(), Profile2DProjector::dataRangeOn(), Hist2DProjImp::dataRangeOnValue(), Hist1DProjImp::dataRangeOnValue(), 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 BinningProjector::normalizeTo(), CutPlotter::removeFromTarget(), DisplayController::removeTextObservers(), NTupleProjector::setNTuple(), FunctionRep::willDelete(), FunctionRep::~FunctionRep(), and NTupleProjector::~NTupleProjector().

void BinningProjector::reset (   )  [virtual, inherited]

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, inherited]

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

void BinningProjector::setBinContents (  const DataSource *  source  )  [inherited]

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 BinningProjector::m_binner.

void BinningProjector::setBinner (  BinsBase *  bins  )  [inherited]

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

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

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 BinningProjector::checkScaling(), ProjectorBase::isAxisBinned(), BinningProjector::m_binner, BinsBase::setBinnerOn(), ProjectorBase::setDirty(), hippodraw::Axes::X, and hippodraw::Axes::Y. Referenced by DisplayController::setBinner().

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

Sets the Range of the binner. If the BinsBase object is empty, the sets the Range of the BinsBase object for axes axis to range. If const_width is true, the bin width is not changed, otherwise it changes to keep the same number of bins. If the BinsBase object is not empty, does nothing. Implements BinningProjector. Definition at line 215 of file StHist2DProjector.cxx. References Hist2DProjImp::checkScaling(), isEmpty(), BinningProjector::m_binner, ProjectorBase::setDirty(), and Hist2DProjImp::setRange().

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

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(), BinningProjector::m_binner, BinningProjector::setBinWidth(), and hippodraw::Axes::X.

void Hist2DProjImp::setBinWidth (  hippodraw::Axes::Type  axis, double  v )  [virtual, inherited]

This function sets the binWidth. It is needed when the HippoDraw user wants to manually change the bin size. The parameter width is of type float because that is how the java interface works, but the cast is done here. Todo: Protect against an excessive number of bins, which will undoubtedly lead to an excessive drawing time. Reimplemented from BinningProjector. Definition at line 146 of file Hist2DProjImp.cxx. References Hist2DProjImp::checkScaling(), BinningProjector::m_binner, BinsBase::setBinWidth(), ProjectorBase::setDirty(), hippodraw::Axes::X, hippodraw::Axes::Y, and hippodraw::Axes::Z. Referenced by DyHist2DProjector::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 addValues(), StHist1DProjector::addValues(), Profile2DProjector::dataRangeOn(), FunctionProjector::fitFunction(), getAverage(), StHist1DProjector::getAverage(), BinningProjector::normalize(), FunctionProjector::prepareAxis(), ProjectorBase::prepareValues(), MapMatrixProjector::prepareValues(), Map3Projector::prepareValues(), Map2Projector::prepareValues(), Map1Projector::prepareValues(), LineProjector::prepareValues(), FunctionProjector::prepareValues(), BinningProjector::prepareValues(), StHist1DProjector::reset(), FunctionProjector::restoreParameters(), NTupleProjector::setAxisBinding(), BinningProjector::setBinnerOn(), setBinnerRange(), StHist1DProjector::setBinnerRange(), ProfileProjector::setBinnerRange(), Profile2DProjector::setBinnerRange(), DyHist2DProjector::setBinnerRange(), DyHist1DProjector::setBinnerRange(), Profile2DProjector::setBinWidth(), Hist2DProjImp::setBinWidth(), BinningProjector::setBinWidth(), DataRep::setDirty(), NTupleProjector::setNTuple(), MapMatrixProjector::setNTuple(), Profile2DProjector::setOffset(), Hist2DProjImp::setOffset(), DyHist2DProjector::setOffset(), BinningProjector::setOffset(), FunctionProjector::setParameters(), ProjectorBase::setRange(), Profile2DProjector::setRange(), FunctionProjector::setRange(), NTupleProjector::update(), and BinningProjector::willDelete().

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

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 BinningProjector::m_binner. Referenced by BinningProjector::normalizeTo(), and BinningProjector::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 (  const std::string &  axis, int  parm, bool  dragging )  [virtual, inherited]

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(), BinningProjector::m_binner, ProjectorBase::setDirty(), and hippodraw::Axes::X.

void Hist2DProjImp::setOffset (  hippodraw::Axes::Type  axis, double  v )  [virtual, inherited]

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 BinningProjector. Definition at line 159 of file Hist2DProjImp.cxx. References BinsBase::getRange(), BinningProjector::m_binner, ProjectorBase::m_x_axis, ProjectorBase::m_y_axis, ProjectorBase::setDirty(), BinsBase::setOffset(), AxisModelBase::setRange(), hippodraw::Axes::X, hippodraw::Axes::Y, and hippodraw::Axes::Z. Referenced by DyHist2DProjector::setOffset().

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

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

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

Sets the range of the selected axis. Todo: Should not be changing the AxisModelBase Range. Reimplemented from ProjectorBase. Definition at line 121 of file Hist2DProjImp.cxx. References ProjectorBase::getPosOn(), AxisModelBase::getRange(), Range::high(), AxisModelBase::isLog(), Range::low(), ProjectorBase::m_x_axis, ProjectorBase::m_y_axis, BinningProjector::setBinnerRange(), AxisModelBase::setRange(), hippodraw::Axes::X, hippodraw::Axes::Y, and hippodraw::Axes::Z. Referenced by setBinnerRange(), and DyHist2DProjector::setBinnerRange().

void StHist2DProjector::setYLabel (   )

Sets the Y axis label.

void Hist2DProjImp::setZLabel (   )  [protected, inherited]

Sets the variable so that it can be modified. Definition at line 174 of file Hist2DProjImp.cxx. References Hist2DProjImp::m_z_label_entries.

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

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, BinningProjector::normalize(), and Observable::notifyObservers(). Referenced by ProfileProjector::update(), Profile2DProjector::update(), DyHist2DProjector::update(), and DyHist1DProjector::update().

Range Hist2DProjImp::valueRange (   )  const [virtual, inherited]

Finds the range of the projected values. The range of the accumulated bins is returned. Implements ProjectorBase. Definition at line 113 of file Hist2DProjImp.cxx. References ProjectorBase::dataRangeOn(), and hippodraw::Axes::Z. Referenced by DyHist2DProjector::getPosOn().

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

Returns true if axis is the Z axis. Reimplemented from ProjectorBase. Definition at line 216 of file Hist2DProjImp.cxx.

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

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 BinningProjector::setNormalizing(). Referenced by ProfileProjector::willDelete(), Profile2DProjector::willDelete(), DyHist2DProjector::willDelete(), and DyHist1DProjector::willDelete().

---

Member Data Documentation

BinsBase* BinningProjector::m_binner [protected, inherited]

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 addValues(), StHist1DProjector::addValues(), BinningProjector::BinningProjector(), ProfileProjector::changedNTuple(), Profile2DProjector::changedNTuple(), DyHist2DProjector::changedNTuple(), DyHist1DProjector::changedNTuple(), Hist2DProjImp::checkScaling(), Hist1DProjImp::checkScaling(), BinningProjector::createNTuple(), BinningProjector::createOldStyleNTuple(), dataRangeOn(), StHist1DProjector::dataRangeOn(), ProfileProjector::execute(), Profile2DProjector::execute(), DyHist2DProjector::execute(), DyHist1DProjector::execute(), BinningProjector::fillDataSource(), BinningProjector::fillProjectedValues(), BinningProjector::getBinner(), BinningProjector::getBinWidth(), BinningProjector::getNumberOfBins(), getNumberOfEntries(), StHist1DProjector::getNumberOfEntries(), BinningProjector::getOffset(), BinningProjector::getZValue(), Hist1DProjImp::Hist1DProjImp(), Hist2DProjImp::Hist2DProjImp(), BinningProjector::normalizeTo(), Profile2DProjector::Profile2DProjector(), ProfileProjector::ProfileProjector(), StHist1DProjector::reset(), BinningProjector::setBinContents(), BinningProjector::setBinner(), BinningProjector::setBinnerOn(), setBinnerRange(), StHist1DProjector::setBinnerRange(), ProfileProjector::setBinnerRange(), Profile2DProjector::setBinnerRange(), DyHist2DProjector::setBinnerRange(), DyHist1DProjector::setBinnerRange(), Profile2DProjector::setBinWidth(), Hist2DProjImp::setBinWidth(), DyHist2DProjector::setBinWidth(), BinningProjector::setBinWidth(), BinningProjector::setNormalizing(), Profile2DProjector::setOffset(), Hist2DProjImp::setOffset(), DyHist2DProjector::setOffset(), BinningProjector::setOffset(), ProfileProjector::setRange(), Hist1DProjImp::setRange(), BinningProjector::setRange(), and BinningProjector::~BinningProjector().

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::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(), BinningProjector::prepareValues(), BinningProjector::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 BinningProjector::normalize(), BinningProjector::normalizeTo(), BinningProjector::update(), and BinningProjector::willDelete().

std::string StHist2DProjector::m_title [private]

The title of the histogram. Definition at line 33 of file StHist2DProjector.h. Referenced by getTitle().

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(), BinningProjector::setOffset(), ProfileProjector::setRange(), Profile2DProjector::setRange(), Hist2DProjImp::setRange(), Hist1DProjImp::setRange(), FunctionProjector::setRange(), and LineProjector::valueRange().

std::string StHist2DProjector::m_x_label [private]

The label of the x axis. Definition at line 37 of file StHist2DProjector.h. Referenced by getXLabel().

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().

std::string StHist2DProjector::m_y_label [private]

The label of the y axis. Definition at line 41 of file StHist2DProjector.h. Referenced by getYLabel().

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(), getAverage(), ProjectorBase::getAxisModel(), ProjectorBase::getRange(), Hist2DProjImp::getZLabel(), NTupleProjector::inRange(), MapMatrixProjector::inRange(), ProjectorBase::setAxisModel(), and ProjectorBase::setRange().

std::string StHist2DProjector::m_z_label [private]

The label of the y axis. It depends on whether the bin widths are equal or not. Reimplemented from ProjectorBase. Definition at line 46 of file StHist2DProjector.h. Referenced by getZLabel(), and StHist2DProjector().

---

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

• StHist2DProjector.h
• StHist2DProjector.cxx

---