DyHist1DProjector Class Reference

#include <DyHist1DProjector.h>

Inheritance diagram for DyHist1DProjector:

[legend]Collaboration diagram for DyHist1DProjector:

[legend]List of all members.

Detailed Description

A derived class of BinningProjector that projects a column of data into a one dimensional histogram.

A vector of ProjValue1D objects is created and presented to a client via an iterator. Since this class is connected to an NTupleProjector, the binning parameters can be changed and this projector can redo the binning, hence it is called dynamic 1D histogram.

Author:

Stephane Bonneaud <gandalf@slac.stanford.edu>

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

Sanket B. Malde <sanket@stanford.edu>

Matan Shacham <matan@slac.stanford.edu>

Oded Wurman <owurman@stanford.edu>

Definition at line 36 of file DyHist1DProjector.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

bool acceptRow (unsigned int i) const

For row i of the column, returns true if all the cuts accept the row.

virtual void addCut (const TupleCut *cut)

Adds the cut to the list of cuts.

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 const std::vector<
std::string > & bindingOptions () const

Returns a vector of strings describing the binding options.

virtual void checkScaling ()

Checks the axis scaling.

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.

DyHist1DProjector ()

The default constructor.

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 current axis bindings.

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.

const std::vector< const TupleCut * > & getCutList () const

Returns the list of TupleCut objects used by this projector.

virtual DataSource * getNTuple ()

Returns the DataSource used by the projector.

virtual const DataSource * getNTuple () const

Returns the DataSoruce used by the projector.

virtual NTuple * getNTupleAfterCuts () const

Template for projectors that can return subsets of the NTuple used by the DataRep.

virtual NTuple * getNTupleAfterCuts () const

Template for projectors that can return subsets of the NTuple used by the DataRep.

virtual const std::string & getNTupleName () const

Returns the name of the NTuple used by this projector.

virtual int getNumberOfBins (hippodraw::Axes::Type axis) const

Returns the number of bins.

int getNumberOfEntries () const

Returns the number of entries in to the projected values list.

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

virtual const std::string & getTitle () const =0

Finds the title of the plot.

virtual const std::string & getXLabel () const

Finds the X axis label of the plot.

virtual const std::string & getXLabel () const =0

Finds the X axis label of the plot.

virtual const std::string & getYLabel (bool density=false) const

Returns the label of the axis.

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

int indexOf (const std::string &label) const

Returns the index of the label.

unsigned int indexOfBindingOption (const std::string &axis) const

Returns an index to the binding option.

virtual bool inRange (int row) const

Checks if the entries in a given row are within the range of the axis model.

virtual bool isAxisBinned (const std::string &axis) const

Returns true if specified axis is binned.

bool isDataValid () const

Returns true if all the data in the bound DataSource is valid.

bool isDirty () const

Returns true if the projector has been marked dirty.

virtual bool isEmpty () const

Returns true if the data source used by this projector is empty.

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.

virtual void removeCut (const TupleCut *cut)

Removes the cut from the cut list.

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 setAxisBinding (const std::string &axis, const std::string &label)

Sets the axis binding.

virtual void setAxisBindings (const std::vector< std::string > &labels)

Sets the axis bindings, Sets, in the order of the binding options, the binding to the NTuple by labels contained in labels.

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 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 setNTuple (const DataSource *source)

Changes the DataSource used for the projections to source.

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, const Range &range, bool)

Sets the range of the binner.

virtual void setRange (hippodraw::Axes::Type, bool)

virtual void setXErrorOption (bool enable)

Sets whether the X error options are to be enabled or not.

virtual void setYErrorOption (bool enable)

Sets whether the Y error options are to be enabled or not.

virtual void update (const Observable *object)

Implements Observer pattern.

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 Y axis.

virtual void willDelete (const Observable *object)

Implements Observer pattern.

Protected Member Functions

virtual void addPointReps ()

Function to add the acceptable point reps.

virtual void changedNTuple ()

This function is called when the NTuple has been changed to a new one.

Range dataRange (int column) const

Returns the range of data on the specified column.

Range dataRangeOnValue () const

Returns the data range on the Y axis.

Range dataRangeWithError (int data, int error) const

Returns a range considering both data and error.

DyHist1DProjector (const DyHist1DProjector &projector)

The copy constructor.

virtual void execute ()

Projects the data source into bins.

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 getPos (int column) const

Returns the minimum positive value on the specified column.

double getPosOnValue () const

Returns the smallest positive value on the Y axis.

double getPosWithError (int data, int error) const

Returns the minimum positive values considering both data and error.

void notifyObservers (Action action) const

An internal method to iterate over all observers and to send the message action.

void setAxisBinding (int axis, const std::string &label)

Sets the axis binding for axis binding option to the column with label label.

Protected Attributes

std::vector< std::string > m_binding_options

The list of binding options for the Projector.

std::vector< std::string > m_bindings

The list of current bindings.

BinsBase * m_binner

The binner object.

std::vector< unsigned int > m_columns

A vector containing indexes to the columns of the NTuple.

std::vector< const TupleCut * > m_cut_list

A list of cuts that filter the projection.

unsigned int m_min_bindings

The minimum number of columns that must be bound.

const DataSource * m_ntuple

The pointer to the data source being projected.

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.

std::string m_y_label_density

The label of the y axis when axis is not scaled.

std::string m_y_label_entries

The label of the y axis when axis is scaled.

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

bool m_fixed

Sets true if the bins are disconnected from the data source and are, thus, fixed.

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

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

The copy constructor.

Definition at line 50 of file DyHist1DProjector.cxx.

DyHist1DProjector::DyHist1DProjector ( )

The default constructor.

Definition at line 41 of file DyHist1DProjector.cxx.
References NTupleProjector::m_binding_options, and NTupleProjector::m_min_bindings.
Referenced by clone().

Member Function Documentation

bool NTupleProjector::acceptRow ( unsigned int i ) const [inherited]

For row i of the column, returns true if all the cuts accept the row.

Definition at line 159 of file NTupleProjector.cxx.
References NTupleProjector::m_cut_list, NTupleProjector::m_ntuple, and num_util::size().
Referenced by ProfileProjector::execute(), Profile2DProjector::execute(), DyHist2DProjector::execute(), execute(), MapMatrixProjector::fillDataSource(), Map3Projector::fillDataSource(), Map2Projector::fillDataSource(), Map1Projector::fillDataSource(), StripChartProjector::fillProjectedValues(), MapMatrixProjector::fillProjectedValues(), Map3Projector::fillProjectedValues(), Map2Projector::fillProjectedValues(), Map1Projector::fillProjectedValues(), NTupleProjector::getAverage(), getAverage(), NTupleProjector::getNTupleAfterCuts(), and NTupleProjector::getNumberOfEntries().

void NTupleProjector::addCut ( const TupleCut * cut ) [virtual, inherited]

Adds the cut to the list of cuts.

Definition at line 348 of file NTupleProjector.cxx.
References NTupleProjector::m_cut_list.
Referenced by NTupleProjectorXML::addCuts(), and CutController::linkCutAndRep().

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 Hist1DProjImp::addPointReps ( ) [protected, virtual, inherited]

Function to add the acceptable point reps.

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

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.

const vector< string > & NTupleProjector::bindingOptions ( ) const [virtual, inherited]

Returns a vector of strings describing the binding options.

Definition at line 97 of file NTupleProjector.cxx.
References NTupleProjector::m_binding_options.
Referenced by DataRepController::bindingOptions().

void DyHist1DProjector::changedNTuple ( ) [protected, virtual]

This function is called when the NTuple has been changed to a new one.
The column indexes are checked for validity, and they are reset to the last column if they are invalid. The weight index is set to negative if it was invalid.
Implements NTupleProjector.
Definition at line 62 of file DyHist1DProjector.cxx.
References DataSource::columns(), BinningProjector::m_binner, NTupleProjector::m_columns, NTupleProjector::m_ntuple, and BinsBase::setDirty().

void Hist1DProjImp::checkScaling ( ) [virtual, inherited]

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

ProjectorBase * DyHist1DProjector::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 57 of file DyHist1DProjector.cxx.
References DyHist1DProjector().

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 NTupleProjector::dataRange ( int column ) const [protected, inherited]

Returns the range of data on the specified column.
The range may need to be calculated.
Definition at line 288 of file NTupleProjector.cxx.
References DataSource::columns(), NTupleProjector::m_is_valid, and NTupleProjector::m_ntuple.
Referenced by ProfileProjector::dataRangeOn(), Profile2DProjector::dataRangeOn(), MapMatrixProjector::dataRangeOn(), Map3Projector::dataRangeOn(), Map2Projector::dataRangeOn(), Map1Projector::dataRangeOn(), DyHist2DProjector::dataRangeOn(), dataRangeOn(), and Map3Projector::valueRange().

Range DyHist1DProjector::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.
Implements NTupleProjector.
Definition at line 123 of file DyHist1DProjector.cxx.
References NTupleProjector::dataRange(), Hist1DProjImp::dataRangeOnValue(), NTupleProjector::m_columns, hippodraw::Axes::X, and hippodraw::Axes::Y.

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

Returns the data range on the Y axis.

Definition at line 130 of file Hist1DProjImp.cxx.
References ProjectorBase::m_proj_values, BinningProjector::prepareValues(), and hippodraw::Axes::Y.
Referenced by StHist1DProjector::dataRangeOn(), dataRangeOn(), and Hist1DProjImp::getPosOnValue().

Range NTupleProjector::dataRangeWithError ( int data,

int error

) const [protected, inherited]

Returns a range considering both data and error.

Definition at line 263 of file NTupleProjector.cxx.
References DataSource::columns(), NTupleProjector::getPosWithError(), NTupleProjector::m_ntuple, std::max(), std::min(), and num_util::size().
Referenced by Map2Projector::dataRangeOn(), and Map1Projector::dataRangeOn().

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

Projects the data source into bins.

Bug:
When restoring and refitting a function, it appears that this member function is called.
Should only be called once.
Reimplemented from BinningProjector.
Definition at line 76 of file DyHist1DProjector.cxx.
References NTupleProjector::acceptRow(), BinsBase::accumulate(), BinningProjector::m_binner, NTupleProjector::m_columns, NTupleProjector::m_ntuple, BinsBase::reset(), and num_util::size().

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 DyHist1DProjector::getAverage ( hippodraw::Axes::Type axis ) const [virtual]

Get the Average of all projected values on the specified axis.

Todo:
Remove duplicated code that is also in NTupleProjector.

Todo:
Fetch the column vector by binding instead of label.

Todo:
Should be able to reuse global functions instead of implementation here.

Reimplemented from NTupleProjector.
Definition at line 155 of file DyHist1DProjector.cxx.
References NTupleProjector::acceptRow(), NTupleProjector::getNTuple(), ProjectorBase::getRange(), AxisModelBase::getRange(), AxisModelBase::getScaleFactor(), NTupleProjector::getXLabel(), getYLabel(), Range::high(), Range::includes(), NTupleProjector::indexOf(), Range::low(), ProjectorBase::m_proj_values, ProjectorBase::m_y_axis, std::max(), std::min(), num_util::size(), hippodraw::Axes::X, and hippodraw::Axes::Y.

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

Returns the current axis bindings.
Returns the label for each column to which the projector is bound. If column is not bound, returns the string "nil" for that column.
Reimplemented from ProjectorBase.
Definition at line 124 of file NTupleProjector.cxx.
References DataSource::getLabelAt(), NTupleProjector::m_bindings, NTupleProjector::m_columns, NTupleProjector::m_ntuple, and num_util::size().
Referenced by DisplayController::axisBindings(), and NTupleProjectorXML::createElement().

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.

const vector< const TupleCut * > & NTupleProjector::getCutList ( ) const [inherited]

Returns the list of TupleCut objects used by this projector.

Definition at line 362 of file NTupleProjector.cxx.
References NTupleProjector::m_cut_list.
Referenced by CutController::connectDataRep(), and NTupleProjectorXML::createChildren().

DataSource * NTupleProjector::getNTuple ( ) [virtual, inherited]

Returns the DataSource used by the projector.

Todo:
Should be changed to getDatSource().

Definition at line 420 of file NTupleProjector.cxx.
References NTupleProjector::m_ntuple.

const DataSource * NTupleProjector::getNTuple ( ) const [virtual, inherited]

Returns the DataSoruce used by the projector.

Todo:
Should be changed to getDatSource().

Definition at line 412 of file NTupleProjector.cxx.
References NTupleProjector::m_ntuple.
Referenced by NTupleProjectorXML::createElement(), NTupleProjector::getAverage(), getAverage(), DisplayController::getDataSourceLabels(), and DisplayController::getNTuple().

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

Template for projectors that can return subsets of the NTuple used by the DataRep.

Reimplemented from ProjectorBase.
Definition at line 492 of file NTupleProjector.cxx.
References NTupleProjector::acceptRow(), DataSource::columns(), DataSource::getLabels(), NTupleProjector::m_ntuple, DataSource::rows(), NTuple::setLabels(), and num_util::size().

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

const string & NTupleProjector::getNTupleName ( ) const [virtual, inherited]

Returns the name of the NTuple used by this projector.

Definition at line 425 of file NTupleProjector.cxx.
References DataSource::getName(), and NTupleProjector::m_ntuple.
Referenced by DisplayController::getDataSourceName().

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 NTupleProjector::getNumberOfEntries ( ) const [virtual, inherited]

Returns the number of entries in to the projected values list.

Implements ProjectorBase.
Definition at line 369 of file NTupleProjector.cxx.
References NTupleProjector::acceptRow(), NTupleProjector::inRange(), NTupleProjector::m_ntuple, DataSource::rows(), and num_util::size().

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


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
bool	acceptRow (unsigned int i) const
	For row i of the column, returns `true` if all the cuts accept the row.
virtual void	addCut (const TupleCut *cut)
	Adds the cut to the list of cuts.
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 const std::vector< std::string > &	bindingOptions () const
	Returns a vector of strings describing the binding options.
virtual void	checkScaling ()
	Checks the axis scaling.
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.
	DyHist1DProjector ()
	The default constructor.
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 current axis bindings.
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.
const std::vector< const TupleCut * > &	getCutList () const
	Returns the list of TupleCut objects used by this projector.
virtual DataSource *	getNTuple ()
	Returns the DataSource used by the projector.
virtual const DataSource *	getNTuple () const
	Returns the DataSoruce used by the projector.
virtual NTuple *	getNTupleAfterCuts () const
	Template for projectors that can return subsets of the NTuple used by the DataRep.
virtual NTuple *	getNTupleAfterCuts () const
	Template for projectors that can return subsets of the NTuple used by the DataRep.
virtual const std::string &	getNTupleName () const
	Returns the name of the NTuple used by this projector.
virtual int	getNumberOfBins (hippodraw::Axes::Type axis) const
	Returns the number of bins.
int	getNumberOfEntries () const
	Returns the number of entries in to the projected values list.
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 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.
virtual const std::string &	getTitle () const =0
	Finds the title of the plot.
virtual const std::string &	getXLabel () const
	Finds the X axis label of the plot.
virtual const std::string &	getXLabel () const =0
	Finds the X axis label of the plot.
virtual const std::string &	getYLabel (bool density=false) const
	Returns the label of the axis.
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).
int	indexOf (const std::string &label) const
	Returns the index of the label.
unsigned int	indexOfBindingOption (const std::string &axis) const
	Returns an index to the binding option.
virtual bool	inRange (int row) const
	Checks if the entries in a given row are within the range of the axis model.
virtual bool	isAxisBinned (const std::string &axis) const
	Returns `true` if specified axis is binned.
bool	isDataValid () const
	Returns `true` if all the data in the bound DataSource is valid.
bool	isDirty () const
	Returns `true` if the projector has been marked dirty.
virtual bool	isEmpty () const
	Returns `true` if the data source used by this projector is empty.
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.
virtual void	removeCut (const TupleCut *cut)
	Removes the cut from the cut list.
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	setAxisBinding (const std::string &axis, const std::string &label)
	Sets the axis binding.
virtual void	setAxisBindings (const std::vector< std::string > &labels)
	Sets the axis bindings, Sets, in the order of the binding options, the binding to the NTuple by labels contained in labels.
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 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	setNTuple (const DataSource *source)
	Changes the DataSource used for the projections to source.
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, const Range &range, bool)
	Sets the range of the binner.
virtual void	setRange (hippodraw::Axes::Type, bool)
virtual void	setXErrorOption (bool enable)
	Sets whether the X error options are to be enabled or not.
virtual void	setYErrorOption (bool enable)
	Sets whether the Y error options are to be enabled or not.
virtual void	update (const Observable *object)
	Implements Observer pattern.
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 Y axis.
virtual void	willDelete (const Observable *object)
	Implements Observer pattern.
Protected Member Functions
virtual void	addPointReps ()
	Function to add the acceptable point reps.
virtual void	changedNTuple ()
	This function is called when the NTuple has been changed to a new one.
Range	dataRange (int column) const
	Returns the range of data on the specified column.
Range	dataRangeOnValue () const
	Returns the data range on the Y axis.
Range	dataRangeWithError (int data, int error) const
	Returns a range considering both data and error.
	DyHist1DProjector (const DyHist1DProjector &projector)
	The copy constructor.
virtual void	execute ()
	Projects the data source into bins.
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	getPos (int column) const
	Returns the minimum positive value on the specified column.
double	getPosOnValue () const
	Returns the smallest positive value on the Y axis.
double	getPosWithError (int data, int error) const
	Returns the minimum positive values considering both data and error.
void	notifyObservers (Action action) const
	An internal method to iterate over all observers and to send the message action.
void	setAxisBinding (int axis, const std::string &label)
	Sets the axis binding for axis binding option to the column with label label.
Protected Attributes
std::vector< std::string >	m_binding_options
	The list of binding options for the Projector.
std::vector< std::string >	m_bindings
	The list of current bindings.
BinsBase *	m_binner
	The binner object.
std::vector< unsigned int >	m_columns
	A vector containing indexes to the columns of the NTuple.
std::vector< const TupleCut * >	m_cut_list
	A list of cuts that filter the projection.
unsigned int	m_min_bindings
	The minimum number of columns that must be bound.
const DataSource *	m_ntuple
	The pointer to the data source being projected.
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.
std::string	m_y_label_density
	The label of the y axis when axis is not scaled.
std::string	m_y_label_entries
	The label of the y axis when axis is scaled.
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
bool	m_fixed
	Sets true if the bins are disconnected from the data source and are, thus, fixed.