Hist2DProjImp Class Reference

#include <Hist2DProjImp.h>

Inheritance diagram for Hist2DProjImp:

[legend]Collaboration diagram for Hist2DProjImp:

[legend]List of all members.

Detailed Description

A derived class of BinningProjector projects to a two dimensional histogram.

A NTuple is created with the projected values for presentation to clients.

Requests:: Be able to convert 2D histogram into fITS image file.

Should it be done in Python or C++?

Author:

Stephane Bonneaud <gandalf@slac.stanford.edu>

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

Sanket B. Malde <sanket@slac.stanford.edu>

Matan Shacham <matan@slac.stanford.edu>

Oded Wurman <owurman@stanford.edu>

Definition at line 34 of file Hist2DProjImp.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.

const std::string & getZLabel () const

Returns the label (title) of 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.

Hist2DProjImp ()

The default constructor.

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

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.

~Hist2DProjImp ()

The destructor.

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.

Hist2DProjImp (const Hist2DProjImp &projector)

The copy constructor.

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.

std::string m_z_label

Dummy member so that getZLabel can return a reference.

Private Attributes

Range m_value_range

The range of the accumulated values.

std::string m_z_label_density

The label of the z axis when displaying density.

std::string m_z_label_entries

The label of the z axis when displaying number of entries per bin.

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

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

The copy constructor.

Definition at line 57 of file Hist2DProjImp.cxx.
References addPointReps().

Hist2DProjImp::Hist2DProjImp ( )

The default constructor.

Definition at line 38 of file Hist2DProjImp.cxx.
References addPointReps(), Factory< Type >::create(), BinsFactory::instance(), BinnerAxisFactory::instance(), BinningProjector::m_binner, m_z_label_density, m_z_label_entries, BinsBase::setBinnerOn(), hippodraw::Axes::X, and hippodraw::Axes::Y.

Hist2DProjImp::~Hist2DProjImp ( )

The destructor.

Definition at line 66 of file Hist2DProjImp.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]

Function to add the acceptable point reps.

Implements ProjectorBase.
Definition at line 208 of file Hist2DProjImp.cxx.
References ProjectorBase::m_pointreps.
Referenced by Hist2DProjImp().

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 Hist2DProjImp::checkScaling ( ) [protected, virtual]

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 StHist2DProjector::setBinnerRange(), DyHist2DProjector::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, 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.

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(), preferredRange(), Hist1DProjImp::preferredRange(), valueRange(), and Hist1DProjImp::valueRange().

Range Hist2DProjImp::dataRangeOnValue ( ) const [protected]

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 StHist2DProjector::dataRangeOn(), DyHist2DProjector::dataRangeOn(), and 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 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 [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.

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

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(), setRange(), and Hist1DProjImp::setRange().

double Hist2DProjImp::getPosOnValue ( ) const [protected]

Returns the smallest positive value on the Y axis.

Definition at line 77 of file Hist2DProjImp.cxx.
References dataRangeOnValue(), and Range::pos().
Referenced by StHist2DProjector::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(), 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 string & Hist2DProjImp::getZLabel ( ) const [virtual]

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, m_z_label_density, and m_z_label_entries.

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]

A test function.

Definition at line 187 of file Hist2DProjImp.cxx.

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 BinningProjector::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 BinningProjector::createOldStyleNTuple(), Profile2DProjector::dataRangeOn(), DataRep::isDirty(), MapMatrixProjector::prepareValues(), Map2Projector::prepareValues(), FunctionProjector::prepareValues(), BinningProjector::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 Hist2DProjImp::isValueBinned ( ) const [virtual]

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


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.
const std::string &	getZLabel () const
	Returns the label (title) of 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.
	Hist2DProjImp ()
	The default constructor.
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` 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)=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 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.
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.
	~Hist2DProjImp ()
	The destructor.
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.
	Hist2DProjImp (const Hist2DProjImp &projector)
	The copy constructor.
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.
std::string	m_z_label
	Dummy member so that getZLabel can return a reference.
Private Attributes
Range	m_value_range
	The range of the accumulated values.
std::string	m_z_label_density
	The label of the z axis when displaying density.
std::string	m_z_label_entries
	The label of the z axis when displaying number of entries per bin.