Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
BinningProjector Class Reference

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

#include <BinningProjector.h>

Inheritance diagram for BinningProjector:
Inheritance graph
[legend]
Collaboration diagram for BinningProjector:
Collaboration graph
[legend]

Public Types

typedef void(Observer::* Action )(const Observable *)
 The member function of the Observer that is called.
typedef std::list< Observer * > ObserverList_t
 The type of STL container to maintain list of Observer objects.

Public Member Functions

void addObserver (Observer *)
 Adds an Observer to the Observer list.
virtual void addValues (const std::vector< double > &v)
 Add values to the projection.
virtual ProjectorBaseclone ()=0
 The clone function returns an object of its own kind which is a copy of this object at this moment.
virtual DataSourcecreateNTuple () const
 Returns an data source representing the binned values.
virtual NTuplecreateNTupleWith (const std::vector< TupleCut > &cut_list) const
 Creates a NTuple from the projector's DataSource object using cut_list for not including rows that do not pass the cuts.
virtual const DataSourcecreateOldStyleNTuple () const
virtual Range dataRangeOn (Axes::Type) const =0
 Returns the range of the raw data.
virtual void fillColumnAfterCuts (const std::string &column, std::vector< double > &columnData) const
 Fill the vector with values from named column with the present set of cuts applied.
virtual double getAverage (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 AxisModelBasegetAxisModel (Axes::Type axis) const
 Get the AxisModel for axis axis.
const BinsBasegetBinner () 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 int getMinEntries ()
 Get the minimum entries/bin.
virtual NTuplegetNTupleAfterCuts () 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_tgetObservers () const
 Returns the list of observers.
double getOffset (hippodraw::Axes::Type axis) const
 Returns the offset of the axis.
virtual int getOverflow () const =0
 Returns the number of overflow.
const std::vector< std::string > & getPointReps () const
 Return the vector of Point Reps.
virtual double getPosOn (Axes::Type) const =0
 Returns the minimum positive value.
const DataSourcegetProjectedValues () const
 Returns DataSource representation of projected values.
virtual const RangegetRange (Axes::Type) const
 Returns the Range along the specified axis.
virtual double getRMS (Axes::Type axis)
 Returns the RMS.
const std::vector< unsigned int > & getShape ()
 Get the shape of the projected values.
virtual const std::string & getTitle () const =0
 Finds the title of the plot.
virtual int getUnderflow () const =0
 Returns the number of underflow.
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::vector< double > & getZAfterTransform (TransformBase *transform)
 Return Z values after binary transform.
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).
const std::vector< double > & getZValues ()
 Return all Z values.
virtual bool hasDataSourceBindings () const
 Returns true if projector has binding to a DataSource.
virtual int indexOf (const std::string &label) const
 Returns the index of the label.
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 isImageConvertable () const
 Returns true if projected values are convertable to image.
virtual bool isValueBinned () const
 Returns true if the projected values are the result of binning.
virtual void matrixTranspose (bool yes)
 Transposes the X and Y axis.
virtual void normalize ()
 Normalizes the projector to its target.
virtual void normalizeTo (double number)
 Sets a scale factor on the output so that the number of entries appears to be number.
virtual void normalizeTo (const ProjectorBase *target)
 Normalize the output of the receiving object's projected values to that of target.
virtual void notifyObservers () const
 Notifies Observer objects of a change.
virtual Range preferredRange (Axes::Type) const
 Returns the preferred Range.
virtual void prepareValues ()
 Prepares the projector for plotting by executing, if needed, the binning procedure.
void removeObserver (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 const RangesetBinWidth (hippodraw::Axes::Type axis, double width)
virtual const RangesetBinWidth (hippodraw::Axes::Type axis, int parm, bool dragging)
 Sets the bin width.
virtual void setDirty (bool value=true)
 Sets the dirty flag to value.
virtual void setMinEntries (int entries)
 Set the minimum entries/bin.
virtual void setNormalizing (bool on)
 Sets the scaling number of entries on if on is true, otherwise turns if off.
virtual void setNumberOfBins (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 offset)
 Sets the bin offset.
virtual void setRange (Axes::Type axis, bool const_width=true)
 Sets the range of the selected axis.
virtual void update (const Observable *object)
 Updates the receiving projector.
virtual Range valueRange () const =0
 Finds the range of the projected values.
virtual bool wantsScaleFactor (const std::string &axis) const
 Returns whether the projector wants scale factor.
virtual void willDelete (const Observable *object)
 If object is the target of normalization, removes the target and sets normalization off.
virtual ~BinningProjector ()
 The destructor.

Protected Member Functions

virtual void addPointReps ()=0
 Function to add the acceptable point reps.
 BinningProjector (unsigned int axes)
 The following constructor takes the number of axes used by the BinsBase object.
 BinningProjector (const BinningProjector &projector)
 The copy constructor.
virtual void checkScaling ()
 Checks and sets if an AxisModelBase object on an axis should be scaled.
virtual void execute ()
 Provides the all the data to the binner.
virtual void fillDataSource (DataSource *ntuple, bool in_range=false) const
void notifyObservers (Action action) const
 An internal method to iterate over all observers and to send the message action.

Protected Attributes

BinsBasem_binner
 The binner object.
std::vector< std::string > m_pointreps
 Vector of acceptable PointReps.
DataSourcem_proj_values
 The NTuple representing the result of the projection.
const ProjectorBasem_target
 The target projector.
AxisModelBasem_x_axis
 The AxisModel along the X axis.
AxisModelBasem_y_axis
 The AxisModel along the Y axis.
AxisModelBasem_z_axis
 The AxisModel along the Z axis.
std::string m_z_label
 Dummy member so that getZLabel can return a reference.
std::vector< double > m_zval
 Sorted Z values in this projector.

Private Attributes

unsigned int m_binner_dim
 The number of AxesType accepted by the binner.

Detailed Description

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

Author
Stephane Bonneaud ganda.nosp@m.lf@s.nosp@m.lac.s.nosp@m.tanf.nosp@m.ord.e.nosp@m.du
Xie Fang xiefa.nosp@m.ng@s.nosp@m.tanfo.nosp@m.rd.e.nosp@m.du
Paul F. Kunz Paul_.nosp@m.Kunz.nosp@m.@slac.nosp@m..sta.nosp@m.nford.nosp@m..edu
Oded Wurman owurm.nosp@m.an@s.nosp@m.tanfo.nosp@m.rd.e.nosp@m.du

Definition at line 34 of file BinningProjector.h.

Member Typedef Documentation

typedef void( Observer::* Action)(const Observable *)
inherited

The member function of the Observer that is called.

Definition at line 86 of file Observable.h.

typedef std::list< Observer * > ObserverList_t
inherited

The type of STL container to maintain list of Observer objects.

Definition at line 45 of file Observable.h.

Constructor & Destructor Documentation

BinningProjector ( unsigned int  axes)
protected

The following constructor takes the number of axes used by the BinsBase object.

Definition at line 35 of file BinningProjector.cxx.

BinningProjector ( const BinningProjector projector)
protected
~BinningProjector ( )
virtual

The destructor.

Definition at line 53 of file BinningProjector.cxx.

References BinningProjector::m_binner.

Member Function Documentation

void addObserver ( hippodraw::Observer observer)
inherited
virtual void addPointReps ( )
protectedpure virtualinherited
void addValues ( const std::vector< double > &  v)
virtualinherited

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 StHist2DProjector, and StHist1DProjector.

Definition at line 330 of file ProjectorBase.cxx.

void checkScaling ( )
protectedvirtual

Checks and sets if an AxisModelBase object on an axis should be scaled.

This method maybe overridden by derived classes such as those that do histogramming.

Reimplemented from ProjectorBase.

Reimplemented in Hist1DProjImp, and Hist2DProjImp.

Definition at line 221 of file BinningProjector.cxx.

Referenced by BinningProjector::setAxisModel(), BinningProjector::setBinnerOn(), ProfileProjector::setBinnerRange(), Profile2DProjector::setBinnerRange(), and BinningProjector::setBinWidth().

virtual ProjectorBase* clone ( )
pure virtualinherited
DataSource * createNTuple ( ) const
virtual

Returns an data source representing the binned values.

Implements ProjectorBase.

Definition at line 233 of file BinningProjector.cxx.

References BinsBase::createNTuple(), and BinningProjector::m_binner.

Referenced by BinningProjector::BinningProjector(), and BinningProjector::setBinner().

NTuple * createNTupleWith ( const std::vector< TupleCut > &  cut_list) const
virtualinherited

Creates a NTuple from the projector's DataSource object using cut_list for not including rows that do not pass the cuts.

Note
This base class implementation returns a null pointer.

Reimplemented in NTupleProjector.

Definition at line 356 of file ProjectorBase.cxx.

const DataSource * createOldStyleNTuple ( ) const
virtualinherited
virtual Range dataRangeOn ( Axes::Type  ) const
pure virtualinherited
void execute ( )
protectedvirtual

Provides the all the data to the binner.

Todo:
Is there away to avoid implementing this empty method.

Reimplemented in DyHist2DProjector, Profile2DProjector, DyHist1DProjector, and ProfileProjector.

Definition at line 217 of file BinningProjector.cxx.

Referenced by BinningProjector::prepareValues().

void fillColumnAfterCuts ( const std::string &  column,
std::vector< double > &  columnData 
) const
virtualinherited

Fill the vector with values from named column with the present set of cuts applied.

This default implementation does nothing.

Reimplemented in NTupleProjector.

Definition at line 349 of file ProjectorBase.cxx.

Referenced by DataRep::fillColumnAfterCuts().

void fillDataSource ( DataSource ntuple,
bool  in_range = false 
) const
protectedvirtual
double getAverage ( Axes::Type  axis) const
virtualinherited

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

Todo:
this should be computed externally with the iterators
Todo:
Resolve if this method should be done exterior to the projector class by a functor using iterators.

Reimplemented in NTupleProjector, MapMatrixProjector, StHist2DProjector, Map1Projector, EqualEntriesHist1DProjector, DyHist1DProjector, and StHist1DProjector.

Definition at line 278 of file ProjectorBase.cxx.

Referenced by AverageTextRep::drawProjectedValues().

const vector< string > & getAxisBindings ( ) const
virtualinherited

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 VariableMesh::setAxisBindings(), and XYPlot::setAxisBindings().

AxisModelBase * getAxisModel ( Axes::Type  axis) const
virtualinherited
const BinsBase * getBinner ( ) const

Returns reference to BinsBase object used by this projector.

Definition at line 80 of file BinningProjector.cxx.

References BinningProjector::m_binner.

Referenced by BinningProjectorXML::createChildren().

double getBinWidth ( hippodraw::Axes::Type  axis) const
virtual

Returns the bin width of the axis.

Not all projectors has a notation of a bin width. This interface is declared for those that do. The implementation in this base class is to does nothing.

Reimplemented from ProjectorBase.

Definition at line 203 of file BinningProjector.cxx.

References BinsBase::binWidth(), BinningProjector::m_binner, BinningProjector::m_binner_dim, hippodraw::Axes::X, hippodraw::Axes::Y, and hippodraw::Axes::Z.

int getMinEntries ( )
virtual

Get the minimum entries/bin.

Reimplemented from ProjectorBase.

Definition at line 334 of file BinningProjector.cxx.

References BinningProjector::m_binner.

NTuple * getNTupleAfterCuts ( ) const
virtualinherited

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

Reimplemented in NTupleProjector.

Definition at line 342 of file ProjectorBase.cxx.

Referenced by DataRep::getNTupleAfterCuts().

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

Returns the number of bins.

Returns number of bins if axis is binned, otherwise returns 0.

Reimplemented from ProjectorBase.

Definition at line 116 of file BinningProjector.cxx.

References BinningProjector::m_binner, BinningProjector::m_binner_dim, BinsBase::numberOfBins(), hippodraw::Axes::X, and hippodraw::Axes::Y.

virtual int getNumberOfEntries ( ) const
pure virtualinherited

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 NTupleProjector, FunctionProjector, StHist2DProjector, StHist1DProjector, and LineProjector.

Referenced by TotalTextRep::drawProjectedValues(), BinningProjector::normalize(), and QtDisplay::numberOfEntries().

const Observable::ObserverList_t & getObservers ( ) const
inherited

Returns the list of observers.

Definition at line 60 of file Observable.cxx.

double getOffset ( hippodraw::Axes::Type  axis) const
virtual

Returns the offset of the axis.

Not all projectors has a notation of a bin width. This interface is declared for those that do. The implementation in this base class is to does nothing.

Reimplemented from ProjectorBase.

Definition at line 188 of file BinningProjector.cxx.

References BinsBase::getOffset(), BinningProjector::m_binner, BinningProjector::m_binner_dim, hippodraw::Axes::X, hippodraw::Axes::Y, and hippodraw::Axes::Z.

virtual int getOverflow ( ) const
pure virtualinherited
const vector< string > & getPointReps ( ) const
inherited

Return the vector of Point Reps.

Definition at line 335 of file ProjectorBase.cxx.

References ProjectorBase::m_pointreps.

virtual double getPosOn ( Axes::Type  ) const
pure virtualinherited
const DataSource * getProjectedValues ( ) const
inherited
const Range & getRange ( Axes::Type  axis) const
virtualinherited
double getRMS ( Axes::Type  axis)
virtualinherited

Returns the RMS.

Returns the root mean square of the data points along the axis axis.

Requests:
Can do better than use only the projected values in some derived classes.

Definition at line 289 of file ProjectorBase.cxx.

References ProjectorBase::getProjectedValues(), ProjectorHelper::stdCoord(), and hippodraw::Axes::X.

const std::vector< unsigned int > & getShape ( )
inherited

Get the shape of the projected values.

Used to export FITS file.

Definition at line 444 of file ProjectorBase.cxx.

References ProjectorBase::getProjectedValues(), and DataSource::getShape().

Referenced by ProjectorBase::getZValues().

virtual const std::string& getTitle ( ) const
pure virtualinherited

Finds the title of the plot.

Implemented in NTupleProjector, FunctionProjector, StHist2DProjector, StHist1DProjector, and LineProjector.

virtual int getUnderflow ( ) const
pure virtualinherited
virtual const std::string& getXLabel ( ) const
pure virtualinherited

Finds the X axis label of the plot.

A plotter may ask the projector for the default label.

Implemented in NTupleProjector, MapMatrixProjector, FunctionProjector, Map1Projector, StHist2DProjector, StHist1DProjector, and LineProjector.

Referenced by CompositePlotter::getLabel().

virtual const std::string& getYLabel ( bool  flag = false) const
pure virtualinherited

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 NTupleProjector, MapMatrixProjector, FunctionProjector, Map1Projector, EqualEntriesHist1DProjector, StHist2DProjector, DyHist1DProjector, StHist1DProjector, and LineProjector.

Referenced by CompositePlotter::getLabel().

const std::vector< double > & getZAfterTransform ( TransformBase transform)
inherited

Return Z values after binary transform.

Todo:
This is the only method in all the classes of this directory that needs a heder file from transform directory. Is there a better way?

Definition at line 456 of file ProjectorBase.cxx.

References ProjectorBase::getZValue(), BinaryTransform::inverseTransform(), and ProjectorBase::m_zval.

const std::string & getZLabel ( ) const
virtualinherited

Finds the Z axis label of the plot.

A plotter may ask the projector for the default label.

Todo:
Change to fetch labels by AxesType or its replacement.

Reimplemented in MapMatrixProjector, FunctionProjector, Profile2DProjector, Hist2DProjImp, MeshProjector, and Map3Projector.

Definition at line 302 of file ProjectorBase.cxx.

References ProjectorBase::m_z_label.

Referenced by NTupleProjector::getAverage(), and CompositePlotter::getLabel().

double getZValue ( double  x,
double  y 
) const
virtual

Get the z value at the specified point (x,y).

Reimplemented from ProjectorBase.

Definition at line 226 of file BinningProjector.cxx.

References BinsBase::getZValue(), and BinningProjector::m_binner.

const std::vector< double > & getZValues ( )
inherited
bool hasDataSourceBindings ( ) const
virtualinherited

Returns true if projector has binding to a DataSource.

This base class implementation returns false. Derived classes that have DataSource binding should override this member function and return true.

Reimplemented in NTupleProjector.

Definition at line 518 of file ProjectorBase.cxx.

Referenced by BinningProjectorXML::createChildren().

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

Returns the index of the label.

For example, the column index.

Reimplemented in NTupleProjector.

Definition at line 309 of file ProjectorBase.cxx.

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

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 Profile2DProjector, EqualEntriesHist1DProjector, DyHist1DProjector, DyHist2DProjector, StHist2DProjector, StHist1DProjector, and ProfileProjector.

Definition at line 121 of file ProjectorBase.cxx.

Referenced by CompositePlotter::getBinWidth(), CompositePlotter::getOffset(), DisplayController::isAxisBinned(), DisplayController::setBinner(), and BinningProjector::setBinnerOn().

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

virtual bool isEmpty ( ) const
pure virtualinherited

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 NTupleProjector, FunctionProjector, StHist2DProjector, LineProjector, and StHist1DProjector.

Referenced by DataRep::hasZeroRows().

bool isImageConvertable ( ) const
virtual

Returns true if projected values are convertable to image.

Returns true if number of binned axis is equal to two and if bins have equal widths on both axes, otherwise returns false.

Requests:
Allow axis to be on log scale, but this will require generating the X and Y coordinates for the image.

Reimplemented from ProjectorBase.

Definition at line 341 of file BinningProjector.cxx.

References BinningProjector::m_binner, and BinningProjector::m_binner_dim.

bool isValueBinned ( ) const
virtualinherited

Returns true if the projected values are the result of binning.

The implementation in this base class returns false. It maybe overridden in derived classes that do binning.

Reimplemented in Hist2DProjImp, and Hist1DProjImp.

Definition at line 126 of file ProjectorBase.cxx.

Referenced by BinningProjector::normalizeTo().

void matrixTranspose ( bool  yes)
virtualinherited

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 normalize ( )
virtual
void normalizeTo ( double  number)
virtual

Sets a scale factor on the output so that the number of entries appears to be number.

This feature might be used, for example, to compare two histograms that have different number of entries by normalizing one to the other.

Reimplemented from ProjectorBase.

Definition at line 247 of file BinningProjector.cxx.

References BinningProjector::m_binner.

Referenced by BinningProjector::normalize().

void normalizeTo ( const ProjectorBase target)
virtual

Normalize the output of the receiving object's projected values to that of target.

Bug:
Only works if target projector is binning projector

Reimplemented from ProjectorBase.

Definition at line 263 of file BinningProjector.cxx.

References Observable::addObserver(), ProjectorBase::isValueBinned(), ProjectorBase::m_target, BinningProjector::normalize(), Observable::removeObserver(), and BinningProjector::setNormalizing().

void notifyObservers ( ) const
virtualinherited

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, RootNTuple, NumArrayTuple, ListTuple, and FitsNTuple.

Definition at line 93 of file Observable.cxx.

References Observer::update().

Referenced by XyPlotter::addDataRep(), XyPlotter::addDataRepStacked(), FunctionController::addFunctionRep(), StHist1DProjector::addValues(), StHist2DProjector::addValues(), XyPlotter::autoScale(), Inspector::contourLevelsTextBox_returnPressed(), Inspector::contourSlider_valueChanged(), Inspector::contourTextBox_returnPressed(), FunctionRep::fitFunction(), XyPlotter::removeDataRep(), FunctionRep::restoreParameters(), DataRep::set(), CutPlotter::setActive(), PlotterBase::setAspectRatio(), XyPlotter::setAutoRanging(), XyPlotter::setBoxEdge(), QtDisplay::setContourLevels(), CutPlotter::setCutColor(), XyPlotter::setCutEnabled(), XyPlotter::setCutInverted(), XyPlotter::setCutRangeAt(), ProjectorBase::setDirty(), DataRep::setErrorDisplay(), XyPlotter::setHighRange(), PlotterBase::setLabel(), XyPlotter::setLabel(), DataSource::setLabelAt(), DataSource::setLabels(), XyPlotter::setLowRange(), DataSource::setName(), DisplayController::setNTuple(), FunctionRep::setParameters(), DyHistogram::setPointRep(), DyHistogramEqualEntries::setPointRep(), DataRep::setPointRep(), TextPlotter::setRepColor(), DataRep::setRepColor(), DataRep::setRepSize(), DataRep::setRepStyle(), XyPlotter::setReverse(), XyPlotter::setScaling(), XyPlotter::setShowGrid(), DataSource::setTitle(), PlotterBase::setTitle(), XyPlotter::setTransform(), XyPlotter::setValueRep(), NTupleProjector::update(), BinningProjector::update(), DataRep::update(), PlotterBase::update(), CutPlotter::update(), CutPlotter::updateTargets(), DataRep::~DataRep(), DataSource::~DataSource(), PlotterBase::~PlotterBase(), and RTuple::~RTuple().

void notifyObservers ( Action  action) const
protectedinherited

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

Definition at line 72 of file Observable.cxx.

Range preferredRange ( Axes::Type  axis) const
virtualinherited

Returns the preferred Range.

Returns the Range preferred by the projector. The default implementation in this base class is to return full range of the data on the axis. Derived classes, may need to override this implementation.

Reimplemented in MapMatrixProjector, MeshProjector, Hist2DProjImp, and Hist1DProjImp.

Definition at line 163 of file ProjectorBase.cxx.

References ProjectorBase::dataRangeOn(), Range::length(), Range::low(), Range::setHigh(), Range::setLow(), and hippodraw::Axes::Y.

Referenced by DataRep::preferredRange().

void prepareValues ( )
virtual
void removeObserver ( hippodraw::Observer observer)
inherited
void reset ( )
virtual

Resets the bins.

This interface is for the StHist1DProjector

Reimplemented from ProjectorBase.

Reimplemented in StHist1DProjector, and Hist1DProjImp.

Definition at line 182 of file BinningProjector.cxx.

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

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

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 setAxisModel ( hippodraw::Axes::Type  axis,
AxisModelBase axis_model 
)
virtual

Sets the AxisModel for axis axis.

Reimplemented from ProjectorBase.

Definition at line 62 of file BinningProjector.cxx.

References BinningProjector::checkScaling().

void setBinContents ( const DataSource source)

Sets the contents of the bins from the data source.

Note
This method should be called for derived classes which are static version of projection. If called on a dynamic version, the contents of the bins will be refreshed from the data source with which it is bound.

Definition at line 319 of file BinningProjector.cxx.

References BinningProjector::m_binner.

void setBinner ( BinsBase bins)

Sets the BinsBase object to be used by this projector.

Definition at line 87 of file BinningProjector.cxx.

References BinningProjector::createNTuple(), BinningProjector::m_binner, and ProjectorBase::m_proj_values.

Referenced by BinningProjectorXML::getObject().

void setBinnerOn ( BinnerAxis binner,
hippodraw::Axes::Type  axis 
)
virtual
virtual void setBinnerRange ( hippodraw::Axes::Type  axis,
const Range range,
bool  const_width 
)
pure virtual

Sets the Range of the binner.

See documentation for derived classes for behavior of this member function.

Implemented in Profile2DProjector, StHist2DProjector, StHist1DProjector, DyHist1DProjector, DyHist2DProjector, and ProfileProjector.

Referenced by Hist1DProjImp::setRange(), and Hist2DProjImp::setRange().

const Range & setBinWidth ( hippodraw::Axes::Type  axis,
double  width 
)
virtual
Todo:
Derived classes that re-implement this member function do so with only difference being the assert. Redesigned to avoid duplication of code.

Reimplemented from ProjectorBase.

Reimplemented in Profile2DProjector, and Hist2DProjImp.

Definition at line 134 of file BinningProjector.cxx.

References BinningProjector::checkScaling(), BinningProjector::m_binner, BinsBase::setBinWidth(), ProjectorBase::setDirty(), and hippodraw::Axes::X.

Referenced by BinningProjector::setBinWidth().

const Range & setBinWidth ( hippodraw::Axes::Type  axis,
int  parm,
bool  dragging 
)
virtual

Sets the bin width.

This method is intended to be used in conjunction with a slider widget in a graphical user interface. The slider range is assumed to be 0 to 100 with the current value at parm. If the slider is still being dragged, then dragging is true, otherwise it is false. A derived class determines withs own bin width based on the width it had when slider dragging first started. and the current position of the slider. The implementation in this base class does nothing.

Reimplemented from ProjectorBase.

Reimplemented in Profile2DProjector, and DyHist2DProjector.

Definition at line 148 of file BinningProjector.cxx.

References BinsBase::calcBinWidth(), BinningProjector::m_binner, and BinningProjector::setBinWidth().

void setDirty ( bool  value = true)
virtualinherited

Sets the dirty flag to value.

Definition at line 75 of file ProjectorBase.cxx.

References ProjectorBase::m_isDirty, and Observable::notifyObservers().

Referenced by StHist1DProjector::addValues(), StHist2DProjector::addValues(), Profile2DProjector::dataRangeOn(), FunctionProjector::fitFunction(), StHist1DProjector::getAverage(), StHist2DProjector::getAverage(), BinningProjector::normalize(), LineProjector::prepareValues(), Map3Projector::prepareValues(), Map2Projector::prepareValues(), MeshProjector::prepareValues(), Map1Projector::prepareValues(), EqualEntriesHist1DProjector::prepareValues(), BinningProjector::prepareValues(), ProjectorBase::prepareValues(), MapMatrixProjector::prepareValues(), StHist1DProjector::reset(), FunctionProjector::restoreParameters(), NTupleProjector::setAxisBinding(), BinningProjector::setBinnerOn(), ProfileProjector::setBinnerRange(), DyHist2DProjector::setBinnerRange(), DyHist1DProjector::setBinnerRange(), StHist1DProjector::setBinnerRange(), StHist2DProjector::setBinnerRange(), Profile2DProjector::setBinnerRange(), BinningProjector::setBinWidth(), Hist2DProjImp::setBinWidth(), Profile2DProjector::setBinWidth(), EqualEntriesHist1DProjector::setBinWidth(), DataRep::setDirty(), BinningProjector::setMinEntries(), MapMatrixProjector::setNTuple(), NTupleProjector::setNTuple(), DyHist2DProjector::setOffset(), BinningProjector::setOffset(), Hist2DProjImp::setOffset(), Profile2DProjector::setOffset(), FunctionProjector::setParameters(), Profile2DProjector::setRange(), FunctionProjector::setRange(), ProjectorBase::setRange(), NTupleProjector::update(), and BinningProjector::willDelete().

void setMinEntries ( int  entries)
virtual

Set the minimum entries/bin.

Reimplemented from ProjectorBase.

Definition at line 326 of file BinningProjector.cxx.

References BinningProjector::m_binner, and ProjectorBase::setDirty().

void setNormalizing ( bool  on)
virtual

Sets the scaling number of entries on if on is true, otherwise turns if off.

Reimplemented from ProjectorBase.

Definition at line 254 of file BinningProjector.cxx.

References BinningProjector::m_binner.

Referenced by BinningProjector::normalizeTo(), and BinningProjector::willDelete().

void setNumberOfBins ( Axes::Type  axis,
unsigned int  number 
)
virtualinherited

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 228 of file ProjectorBase.cxx.

Referenced by CompositePlotter::setNumberOfBins().

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

Sets the bin offset.

See Also
setBinWidth ( const std::string &, int, bool )

Reimplemented from ProjectorBase.

Reimplemented in Profile2DProjector, and DyHist2DProjector.

Definition at line 157 of file BinningProjector.cxx.

References BinsBase::calcOffset(), BinningProjector::m_binner, ProjectorBase::setDirty(), and hippodraw::Axes::X.

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

Sets the bin offset.

Sets the offset of bins by fraction offset of the bin width.

Not all projectors has a notation of a bin width. This interface is declared for those that do. The implementation in this base class is to does nothing.

Reimplemented from ProjectorBase.

Reimplemented in Profile2DProjector, and Hist2DProjImp.

Definition at line 171 of file BinningProjector.cxx.

References BinsBase::getRange(), BinningProjector::m_binner, ProjectorBase::m_x_axis, ProjectorBase::setDirty(), BinsBase::setOffset(), AxisModelBase::setRange(), hippodraw::Axes::X, and hippodraw::Axes::Y.

void setRange ( Axes::Type  axis,
bool  const_width = true 
)
virtualinherited

Sets the range of the selected axis.

The base class implementation only sets the dirty flag. Derived classes may need to do more. The option bool parameter if true indicates a binning projector should hold the bin width parameter constant.

Reimplemented in FunctionProjector, Profile2DProjector, Hist2DProjImp, Hist1DProjImp, and ProfileProjector.

Definition at line 133 of file ProjectorBase.cxx.

References ProjectorBase::m_z_axis, ProjectorBase::setDirty(), hippodraw::Axes::X, hippodraw::Axes::Y, and hippodraw::Axes::Z.

Referenced by DataRep::setRange().

void update ( const Observable object)
virtual

Updates the receiving projector.

If the projector is normalizing to a target projector and object is the target, then re-normalizes itself. If not, then notifies its observers.

Reimplemented from ProjectorBase.

Reimplemented in Profile2DProjector, DyHist1DProjector, DyHist2DProjector, and ProfileProjector.

Definition at line 297 of file BinningProjector.cxx.

References ProjectorBase::m_target, BinningProjector::normalize(), and Observable::notifyObservers().

virtual Range valueRange ( ) const
pure virtualinherited

Finds the range of the projected values.

It is up to derived classes to determine what this means.

Todo:
Resolve if this method should be here.

Implemented in MapMatrixProjector, FunctionProjector, MeshProjector, EqualEntriesHist1DProjector, Hist1DProjImp, Hist2DProjImp, Map1Projector, Map2Projector, Profile2DProjector, Map3Projector, LineProjector, and ProfileProjector.

bool wantsScaleFactor ( const std::string &  axis) const
virtualinherited

Returns whether the projector wants scale factor.

Returns true if the projector wants to scale the axis, otherwise returns false. A projector supporting a histogram, for example, would want to scale the Y axis by the bin width in order to show entries per bin instead of density. This base class implementation always returns false.

Reimplemented in Hist2DProjImp, and Hist1DProjImp.

Definition at line 364 of file ProjectorBase.cxx.

Referenced by CompositePlotter::checkAxisScaling().

void willDelete ( const Observable object)
virtual

If object is the target of normalization, removes the target and sets normalization off.

Reimplemented from Observer.

Reimplemented in Profile2DProjector, DyHist1DProjector, DyHist2DProjector, and ProfileProjector.

Definition at line 308 of file BinningProjector.cxx.

References ProjectorBase::m_target, ProjectorBase::setDirty(), and BinningProjector::setNormalizing().

Member Data Documentation

BinsBase* m_binner
protected

The binner object.

Some derived classes need a BinsBase object to accumulate data before the projection can be accomplished. Such classes should create the appropriate type of binner and store a pointer to it here. A null pointer value signals that the derived class projector does not need a binner.

Definition at line 51 of file BinningProjector.h.

Referenced by StHist1DProjector::addValues(), StHist2DProjector::addValues(), BinningProjector::BinningProjector(), ProfileProjector::changedNTuple(), Profile2DProjector::changedNTuple(), DyHist2DProjector::changedNTuple(), DyHist1DProjector::changedNTuple(), Hist2DProjImp::checkScaling(), Hist1DProjImp::checkScaling(), BinningProjector::createNTuple(), StHist1DProjector::dataRangeOn(), StHist2DProjector::dataRangeOn(), ProfileProjector::execute(), DyHist1DProjector::execute(), Profile2DProjector::execute(), DyHist2DProjector::execute(), BinningProjector::fillDataSource(), BinningProjector::getBinner(), BinningProjector::getBinWidth(), BinningProjector::getMinEntries(), BinningProjector::getNumberOfBins(), StHist1DProjector::getNumberOfEntries(), StHist2DProjector::getNumberOfEntries(), BinningProjector::getOffset(), StHist1DProjector::getOverflow(), StHist2DProjector::getOverflow(), DyHist1DProjector::getOverflow(), StHist1DProjector::getUnderflow(), StHist2DProjector::getUnderflow(), DyHist1DProjector::getUnderflow(), BinningProjector::getZValue(), Hist1DProjImp::Hist1DProjImp(), Hist2DProjImp::Hist2DProjImp(), BinningProjector::isImageConvertable(), BinningProjector::normalizeTo(), Profile2DProjector::Profile2DProjector(), ProfileProjector::ProfileProjector(), StHist1DProjector::reset(), BinningProjector::setBinContents(), BinningProjector::setBinner(), BinningProjector::setBinnerOn(), ProfileProjector::setBinnerRange(), DyHist2DProjector::setBinnerRange(), DyHist1DProjector::setBinnerRange(), StHist1DProjector::setBinnerRange(), StHist2DProjector::setBinnerRange(), Profile2DProjector::setBinnerRange(), BinningProjector::setBinWidth(), DyHist2DProjector::setBinWidth(), Hist2DProjImp::setBinWidth(), Profile2DProjector::setBinWidth(), BinningProjector::setMinEntries(), BinningProjector::setNormalizing(), DyHist2DProjector::setOffset(), BinningProjector::setOffset(), Hist2DProjImp::setOffset(), Profile2DProjector::setOffset(), ProfileProjector::setRange(), Hist1DProjImp::setRange(), and BinningProjector::~BinningProjector().

unsigned int m_binner_dim
private

The number of AxesType accepted by the binner.

If the value is 1, then only X is accepted. A value of 2 accepts X and Y, etc.

Definition at line 42 of file BinningProjector.h.

Referenced by BinningProjector::getBinWidth(), BinningProjector::getNumberOfBins(), BinningProjector::getOffset(), and BinningProjector::isImageConvertable().

std::vector< std::string > m_pointreps
protectedinherited
DataSource* m_proj_values
protectedinherited
const ProjectorBase* m_target
protectedinherited

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.

Definition at line 110 of file ProjectorBase.h.

Referenced by BinningProjector::normalize(), BinningProjector::normalizeTo(), BinningProjector::update(), and BinningProjector::willDelete().

AxisModelBase* m_x_axis
protectedinherited
AxisModelBase* m_y_axis
protectedinherited
AxisModelBase* m_z_axis
protectedinherited
std::string m_z_label
protectedinherited

Dummy member so that getZLabel can return a reference.

Todo:
Remove when getLabel takes axis argument

Definition at line 101 of file ProjectorBase.h.

Referenced by ProjectorBase::getZLabel().

std::vector< double > m_zval
mutableprotectedinherited

Sorted Z values in this projector.

Used to export FITS file.

Definition at line 119 of file ProjectorBase.h.

Referenced by ProjectorBase::getZAfterTransform(), and ProjectorBase::getZValues().


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

Generated for HippoDraw Class Library by doxygen