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

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

#include <DyHist1DProjector.h>

Inheritance diagram for DyHist1DProjector:
Inheritance graph
[legend]
Collaboration diagram for DyHist1DProjector:
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

bool acceptRow (unsigned int i, const CutList_t &cut_list) const
 For row i of the column in the DataSource, 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 (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.
virtual ProjectorBaseclone ()
 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 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 (hippodraw::Axes::Type axis) const
 Returns the range of the data on a specified axis.
 DyHist1DProjector ()
 The default constructor.
virtual void fillColumnAfterCuts (const std::string &column, std::vector< double > &columnData) const
 Fill a vector with the data from the named column with the current set of cuts applied.
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 (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 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.
const std::vector< const
TupleCut * > & 
getCutList () const
 Returns the list of TupleCut objects used by this projector.
virtual int getMinEntries ()
 Get the minimum entries/bin.
virtual const DataSourcegetNTuple () const
 Returns the DataSource used by the projector.
virtual DataSourcegetNTuple ()
 Returns the DataSource used by the projector.
virtual NTuplegetNTupleAfterCuts () const
 Template for projectors that can return subsets of the NTuple used by the DataRep.
virtual NTuplegetNTupleAfterCuts () 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 DataSource 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_tgetObservers () const
 Returns the list of observers.
double getOffset (hippodraw::Axes::Type axis) const
 Returns the offset of the axis.
virtual int getOverflow () const
 Returns overflow.
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 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 const std::string & getTitle () const
 Finds the title of the plot.
virtual int getUnderflow () const
 Returns underflow.
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.
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.
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 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 =0
 Returns true if the data source used by this projector is empty.
virtual bool isEmpty () const
 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 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 (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 (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 (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 > &bindings)
 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 DataSource by labels contained in labels.
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 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 setNTuple (const DataSource *source)
 Changes the DataSource used for the projections to source.
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 (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
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.
BinsBasem_binner
 The binner object.
std::vector< unsigned int > m_columns
 A vector containing indexes to the columns of the DataSource.
CutList_t 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 DataSourcem_ntuple
 The pointer to the data source being projected.
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.
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.
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

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

Detailed Description

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

A DataSource object is created and presented to a client. 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 ganda.nosp@m.lf@s.nosp@m.lac.s.nosp@m.tanf.nosp@m.ord.e.nosp@m.du
Paul F. Kunz Paul_.nosp@m.Kunz.nosp@m.@slac.nosp@m..sta.nosp@m.nford.nosp@m..edu
Sanket B. Malde sanke.nosp@m.t@st.nosp@m.anfor.nosp@m.d.ed.nosp@m.u
Matan Shacham matan.nosp@m.@sla.nosp@m.c.sta.nosp@m.nfor.nosp@m.d.edu
Oded Wurman owurm.nosp@m.an@s.nosp@m.tanfo.nosp@m.rd.e.nosp@m.du

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

DyHist1DProjector ( const DyHist1DProjector projector)
protected

The copy constructor.

Note
Must initialize with the copy constructor of ProjectorBase here, otherise the default constructor will be used. This is because it is a virtual base class of the inherited classes.

Definition at line 52 of file DyHist1DProjector.cxx.

The default constructor.

Definition at line 38 of file DyHist1DProjector.cxx.

References NTupleProjector::m_binding_options, and NTupleProjector::m_min_bindings.

Referenced by DyHist1DProjector::clone().

Member Function Documentation

bool acceptRow ( unsigned int  i,
const CutList_t cut_list 
) const
inherited
void addCut ( const TupleCut cut)
virtualinherited

Adds the cut to the list of cuts.

Definition at line 351 of file NTupleProjector.cxx.

References NTupleProjector::m_cut_list.

Referenced by CutController::linkCutAndRep().

void addObserver ( hippodraw::Observer observer)
inherited
void addPointReps ( )
protectedvirtualinherited

Function to add the acceptable point reps.

Implements ProjectorBase.

Definition at line 80 of file Hist1DProjImp.cxx.

References ProjectorBase::m_pointreps.

Referenced by Hist1DProjImp::Hist1DProjImp().

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.

const vector< string > & bindingOptions ( ) const
virtualinherited

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 changedNTuple ( )
protectedvirtual

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 66 of file DyHist1DProjector.cxx.

References DataSource::columns(), BinningProjector::m_binner, NTupleProjector::m_columns, NTupleProjector::m_ntuple, and BinsBase::setDirty().

void checkScaling ( )
virtualinherited

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 90 of file Hist1DProjImp.cxx.

References BinsBase::hasEqualWidths(), BinningProjector::m_binner, ProjectorBase::m_y_axis, BinsBase::scaleFactor(), AxisModelBase::setScaleFactor(), and AxisModelBase::setScaling().

Referenced by DyHist1DProjector::setBinnerRange(), and StHist1DProjector::setBinnerRange().

ProjectorBase * 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 60 of file DyHist1DProjector.cxx.

References DyHist1DProjector::DyHist1DProjector().

DataSource * createNTuple ( ) const
virtualinherited

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

Definition at line 565 of file NTupleProjector.cxx.

References NTupleProjector::createEmptyNTuple(), and NTupleProjector::fillNTuple().

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
Range dataRange ( int  column) const
protectedinherited
Range 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 127 of file DyHist1DProjector.cxx.

References NTupleProjector::dataRange(), Hist1DProjImp::dataRangeOnValue(), NTupleProjector::m_columns, hippodraw::Axes::X, and hippodraw::Axes::Y.

Range dataRangeOnValue ( ) const
protectedinherited
Range dataRangeWithError ( int  data,
int  error 
) const
protectedinherited
void execute ( )
protectedvirtual

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 80 of file DyHist1DProjector.cxx.

References NTupleProjector::acceptRow(), BinsBase::accumulate(), BinningProjector::m_binner, NTupleProjector::m_columns, NTupleProjector::m_cut_list, NTupleProjector::m_ntuple, BinsBase::reset(), and num_util::size().

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

Fill a vector with the data from the named column with the current set of cuts applied.

Reimplemented from ProjectorBase.

Definition at line 550 of file NTupleProjector.cxx.

References NTupleProjector::acceptRow(), DataSource::getColumn(), NTupleProjector::m_cut_list, NTupleProjector::m_ntuple, and DataSource::rows().

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

Fetch the column vector by binding instead of label.

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

Reimplemented from NTupleProjector.

Definition at line 159 of file DyHist1DProjector.cxx.

References NTupleProjector::acceptRow(), NTupleProjector::getNTuple(), AxisModelBase::getRange(), ProjectorBase::getRange(), NTupleProjector::getXLabel(), DyHist1DProjector::getYLabel(), Range::high(), Range::includes(), NTupleProjector::indexOf(), Range::low(), NTupleProjector::m_cut_list, ProjectorBase::m_proj_values, ProjectorBase::m_y_axis, num_util::size(), hippodraw::Axes::X, and hippodraw::Axes::Y.

const std::vector< std::string > & getAxisBindings ( ) const
virtualinherited

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 > & 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
inherited

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
virtualinherited

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.

const vector< const TupleCut * > & getCutList ( ) const
inherited

Returns the list of TupleCut objects used by this projector.

Definition at line 365 of file NTupleProjector.cxx.

References NTupleProjector::m_cut_list.

Referenced by CutController::connectDataRep(), and NTupleProjectorXML::createChildren().

int getMinEntries ( )
virtualinherited

Get the minimum entries/bin.

Reimplemented from ProjectorBase.

Definition at line 334 of file BinningProjector.cxx.

References BinningProjector::m_binner.

const DataSource * getNTuple ( ) const
virtualinherited

Returns the DataSource used by the projector.

Todo:
Should be changed to getDatSource().

Definition at line 430 of file NTupleProjector.cxx.

References NTupleProjector::m_ntuple.

Referenced by NTupleProjectorXML::createElement(), DyHist1DProjector::getAverage(), NTupleProjector::getAverage(), and DisplayController::getDataSourceLabels().

DataSource * getNTuple ( )
virtualinherited

Returns the DataSource used by the projector.

Todo:
Should be changed to getDatSource().

Definition at line 438 of file NTupleProjector.cxx.

References NTupleProjector::m_ntuple.

NTuple * getNTupleAfterCuts ( ) const
virtualinherited

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

Reimplemented from ProjectorBase.

Definition at line 540 of file NTupleProjector.cxx.

References NTupleProjector::createEmptyNTuple(), NTupleProjector::fillNTuple(), and NTupleProjector::m_cut_list.

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

const string & getNTupleName ( ) const
virtualinherited

Returns the name of the DataSource used by this projector.

Definition at line 443 of file NTupleProjector.cxx.

References DataSource::getName(), and NTupleProjector::m_ntuple.

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

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.

int getNumberOfEntries ( ) const
virtualinherited

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

Implements ProjectorBase.

Definition at line 372 of file NTupleProjector.cxx.

References NTupleProjector::acceptRow(), NTupleProjector::inRange(), NTupleProjector::m_cut_list, NTupleProjector::m_ntuple, DataSource::rows(), and num_util::size().

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
virtualinherited

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.

int getOverflow ( ) const
virtual

Returns overflow.

Reimplemented from NTupleProjector.

Definition at line 296 of file DyHist1DProjector.cxx.

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

const vector< string > & getPointReps ( ) const
inherited

Return the vector of Point Reps.

Definition at line 335 of file ProjectorBase.cxx.

References ProjectorBase::m_pointreps.

double getPos ( int  column) const
protectedinherited
double getPosOn ( hippodraw::Axes::Type  axis) const
virtual

Returns the minimum positive value of the data on a specified axis.

Implements ProjectorBase.

Definition at line 113 of file DyHist1DProjector.cxx.

References NTupleProjector::getPos(), Hist1DProjImp::getPosOnValue(), NTupleProjector::m_columns, hippodraw::Axes::X, and hippodraw::Axes::Y.

double getPosOnValue ( ) const
protectedinherited

Returns the smallest positive value on the Y axis.

Definition at line 113 of file Hist1DProjImp.cxx.

References Hist1DProjImp::dataRangeOnValue(), and Range::pos().

Referenced by StHist1DProjector::getPosOn(), and DyHist1DProjector::getPosOn().

double getPosWithError ( int  data,
int  error 
) const
protectedinherited
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.

const string & getTitle ( ) const
virtualinherited

Finds the title of the plot.

This implementation gets the title from the DataSource.

Implements ProjectorBase.

Definition at line 251 of file NTupleProjector.cxx.

References NTupleProjector::m_ntuple, and DataSource::title().

int getUnderflow ( ) const
virtual

Returns underflow.

Reimplemented from NTupleProjector.

Definition at line 288 of file DyHist1DProjector.cxx.

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

const std::string & getXLabel ( ) const
virtualinherited

Finds the X axis label of the plot.

A plotter may ask the projector for the default label.

Implements ProjectorBase.

Reimplemented in MapMatrixProjector, and Map1Projector.

Definition at line 256 of file NTupleProjector.cxx.

References DataSource::getLabelAt(), NTupleProjector::m_columns, and NTupleProjector::m_ntuple.

Referenced by DyHist1DProjector::getAverage(), and NTupleProjector::getAverage().

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

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

Returns the label of the axis.

If density is true, always return the label used when the axis is not scaled. If density is false, then return the label used for scaled axis if the axis is scaled, otherwise return the label for the unscaled axis.

Reimplemented from NTupleProjector.

Definition at line 138 of file DyHist1DProjector.cxx.

References AxisModelBase::isScaling(), ProjectorBase::m_y_axis, Hist1DProjImp::m_y_label_density, and Hist1DProjImp::m_y_label_entries.

Referenced by DyHist1DProjector::getAverage().

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
virtualinherited

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.

Returns true as this projector or derived classes form it have DataSource binding.

Reimplemented from ProjectorBase.

Definition at line 587 of file NTupleProjector.cxx.

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

Definition at line 144 of file NTupleProjector.cxx.

References DataSource::indexOf(), and NTupleProjector::m_ntuple.

Referenced by DyHist1DProjector::getAverage(), and NTupleProjector::getAverage().

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.

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

Returns an index to the binding option.

The parameter axis should match one of the strings returned by binding Options(). If not, an assertion is made.

Definition at line 103 of file NTupleProjector.cxx.

References NTupleProjector::m_binding_options.

Referenced by NTupleProjector::setAxisBinding().

bool inRange ( int  row) const
virtualinherited
bool isAxisBinned ( const std::string &  axis) const
virtual

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

Definition at line 234 of file DyHist1DProjector.cxx.

References NTupleProjector::m_binding_options.

bool isDataValid ( ) const
inherited

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

Definition at line 580 of file NTupleProjector.cxx.

References NTupleProjector::m_is_valid.

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

Implements ProjectorBase.

Definition at line 503 of file NTupleProjector.cxx.

References NTupleProjector::m_ntuple.

bool isImageConvertable ( ) const
virtualinherited

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 as the projected value is the result of accumulation into bins.

Reimplemented from ProjectorBase.

Definition at line 106 of file Hist1DProjImp.cxx.

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

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

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 ( hippodraw::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 from ProjectorBase.

Definition at line 122 of file Hist1DProjImp.cxx.

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

void prepareValues ( )
virtualinherited
void removeCut ( const TupleCut cut)
virtualinherited

Removes the cut from the cut list.

Definition at line 356 of file NTupleProjector.cxx.

References NTupleProjector::m_cut_list.

void removeObserver ( hippodraw::Observer observer)
inherited
void reset ( )
virtualinherited

Resets the bins.

This interface is for the StHist1DProjector

Reimplemented from BinningProjector.

Reimplemented in StHist1DProjector.

Definition at line 174 of file Hist1DProjImp.cxx.

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

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

If the label doesn't exist in the data source, then the axis becomes unbound.

Definition at line 183 of file NTupleProjector.cxx.

References DataSource::indexOf(), NTupleProjector::m_columns, NTupleProjector::m_is_valid, NTupleProjector::m_ntuple, and ProjectorBase::setDirty().

Referenced by NTupleProjector::setAxisBinding(), and NTupleProjector::setAxisBindings().

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

Sets the axis binding.

The parameter axis should match one of the strings returned by bindingOptions(). The parameter label should match one of the column labels of the DataSource. If not, the corresponding axis becomes unbound.

Reimplemented from ProjectorBase.

Definition at line 197 of file NTupleProjector.cxx.

References NTupleProjector::indexOfBindingOption(), and NTupleProjector::setAxisBinding().

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

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

If labels does not contain sufficient number of entries, the remaining bindings are unset.

Reimplemented from ProjectorBase.

Definition at line 207 of file NTupleProjector.cxx.

References NTupleProjector::m_columns, NTupleProjector::m_is_valid, NTupleProjector::m_min_bindings, NTupleProjector::setAxisBinding(), and num_util::size().

Referenced by CutPlotter::setAxisBinding(), and DisplayController::setAxisBindings().

void setAxisModel ( hippodraw::Axes::Type  axis,
AxisModelBase axis_model 
)
virtualinherited

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

Sets the contents of the bins from the data source.

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

Definition at line 319 of file BinningProjector.cxx.

References BinningProjector::m_binner.

void setBinner ( BinsBase bins)
inherited

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 
)
virtualinherited
void setBinnerRange ( hippodraw::Axes::Type  axis,
const Range range,
bool  const_width 
)
virtual

Sets the Range of the binner.

Sets the Range of the BinsBase object for axes axis to range. If const_width is true, the bin width is not changed, otherwise it changes to keep the same number of bins.

Implements BinningProjector.

Definition at line 244 of file DyHist1DProjector.cxx.

References Hist1DProjImp::checkScaling(), BinningProjector::m_binner, ProjectorBase::setDirty(), and Hist1DProjImp::setRange().

const Range & setBinWidth ( hippodraw::Axes::Type  axis,
double  width 
)
virtualinherited
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 
)
virtualinherited

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

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

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

Changes the DataSource used for the projections to source.

The column indexes remain the same if the new DataSource has at least as many columns as the old. Any indexes exceeding the number of columns of the new DataSource are reset to 0.

Reimplemented in MapMatrixProjector.

Definition at line 231 of file NTupleProjector.cxx.

References NTupleProjector::changedNTuple(), DataSource::isNull(), NTupleProjector::m_is_valid, NTupleProjector::m_ntuple, Observable::removeObserver(), and ProjectorBase::setDirty().

Referenced by DataRepController::setAxisBindings(), CutPlotter::setNTuple(), and DisplayController::setNTuple().

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

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

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 ( hippodraw::Axes::Type  axis,
bool  const_width 
)
virtualinherited
void setXErrorOption ( bool  enable)
virtualinherited

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

This base class implementation does nothing.

Reimplemented in MeshProjector, and Map2Projector.

Definition at line 149 of file NTupleProjector.cxx.

void setYErrorOption ( bool  enable)
virtualinherited

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

This base class implementation does nothing.

Reimplemented in MeshProjector, Map1Projector, and Map2Projector.

Definition at line 153 of file NTupleProjector.cxx.

void update ( const Observable object)
virtual

Implements Observer pattern.

Receives the update from the Observable object and directs it to either BinningProject::update or NTupleProjector::update depending on class of object.

Reimplemented from NTupleProjector.

Definition at line 258 of file DyHist1DProjector.cxx.

Range valueRange ( ) const
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.

Implements ProjectorBase.

Definition at line 180 of file Hist1DProjImp.cxx.

References ProjectorBase::dataRangeOn(), and hippodraw::Axes::Y.

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

Returns true if axis is the Y axis.

Reimplemented from ProjectorBase.

Definition at line 187 of file Hist1DProjImp.cxx.

void willDelete ( const Observable object)
virtual

Implements Observer pattern.

Receives the willDelete from the Observable object and directs it to either BinningProjector::update or NTupleProjector::update depending on the class of object.

Reimplemented from NTupleProjector.

Definition at line 273 of file DyHist1DProjector.cxx.

Member Data Documentation

std::vector< std::string > m_binding_options
protectedinherited

The list of binding options for the Projector.

The binding refers to a connection to the data. For example, a 1D histogram binds to one axis and the option might be "X", while a scatter plot binds to two axes with the options "X" and "Y". The binding option is maintained as a string which can be interpreted by derived classes in various ways. For example, a DataSource projector could take the string as a label for a column. Derived classes should initialize this data member in their constructor.

Definition at line 77 of file NTupleProjector.h.

Referenced by NTupleProjector::bindingOptions(), DyHist1DProjector::DyHist1DProjector(), DyHist2DProjector::DyHist2DProjector(), EqualEntriesHist1DProjector::EqualEntriesHist1DProjector(), NTupleProjector::indexOfBindingOption(), ProfileProjector::isAxisBinned(), DyHist2DProjector::isAxisBinned(), DyHist1DProjector::isAxisBinned(), EqualEntriesHist1DProjector::isAxisBinned(), Profile2DProjector::isAxisBinned(), Map1Projector::Map1Projector(), Map2Projector::Map2Projector(), Map3Projector::Map3Projector(), MapMatrixProjector::MapMatrixProjector(), MeshProjector::MeshProjector(), NTupleProjector::NTupleProjector(), Profile2DProjector::Profile2DProjector(), ProfileProjector::ProfileProjector(), Map2Projector::setXErrorOption(), MeshProjector::setXErrorOption(), Map2Projector::setYErrorOption(), Map1Projector::setYErrorOption(), and MeshProjector::setYErrorOption().

std::vector< std::string > m_bindings
mutableprotectedinherited

The list of current bindings.

Definition at line 80 of file NTupleProjector.h.

Referenced by NTupleProjector::getAxisBindings().

BinsBase* m_binner
protectedinherited

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

std::vector< unsigned int > m_columns
protectedinherited

A vector containing indexes to the columns of the DataSource.

The value UINT_MAX indicates that the column is not bound. Derived classes use these indexes in conjunction with m_binding_options.

Definition at line 86 of file NTupleProjector.h.

Referenced by Map3Projector::changedNTuple(), MeshProjector::changedNTuple(), Map2Projector::changedNTuple(), ProfileProjector::changedNTuple(), Profile2DProjector::changedNTuple(), DyHist2DProjector::changedNTuple(), Map1Projector::changedNTuple(), DyHist1DProjector::changedNTuple(), EqualEntriesHist1DProjector::changedNTuple(), MapMatrixProjector::changedNTuple(), Map3Projector::createNTuple(), Map2Projector::createNTuple(), MeshProjector::createNTuple(), MapMatrixProjector::createNTuple(), ProfileProjector::dataRangeOn(), Map3Projector::dataRangeOn(), DyHist2DProjector::dataRangeOn(), Map2Projector::dataRangeOn(), DyHist1DProjector::dataRangeOn(), Profile2DProjector::dataRangeOn(), Map1Projector::dataRangeOn(), EqualEntriesHist1DProjector::dataRangeOn(), MeshProjector::dataRangeOn(), ProfileProjector::execute(), DyHist1DProjector::execute(), Profile2DProjector::execute(), DyHist2DProjector::execute(), StripChartProjector::fillProjectedValues(), Map2Projector::fillProjectedValues(), Map3Projector::fillProjectedValues(), MeshProjector::fillProjectedValues(), Map1Projector::fillProjectedValues(), EqualEntriesHist1DProjector::fillProjectedValues(), MapMatrixProjector::fillProjectedValues(), NTupleProjector::getAxisBindings(), ProfileProjector::getPosOn(), Map3Projector::getPosOn(), DyHist2DProjector::getPosOn(), DyHist1DProjector::getPosOn(), Map2Projector::getPosOn(), Profile2DProjector::getPosOn(), Map1Projector::getPosOn(), EqualEntriesHist1DProjector::getPosOn(), MeshProjector::getPosOn(), MapMatrixProjector::getPosOn(), NTupleProjector::getXLabel(), Map1Projector::getYLabel(), NTupleProjector::getYLabel(), Map3Projector::getZLabel(), Profile2DProjector::getZLabel(), MapMatrixProjector::getZLabel(), MapMatrixProjector::getZValue(), Map1Projector::inRange(), NTupleProjector::inRange(), MeshProjector::inRangeWithZ(), MapMatrixProjector::inRangeWithZ(), MeshProjector::preferredRange(), MapMatrixProjector::preferredRange(), EqualEntriesHist1DProjector::prepareValues(), NTupleProjector::setAxisBinding(), NTupleProjector::setAxisBindings(), Map2Projector::setXErrorOption(), MeshProjector::setXErrorOption(), Map2Projector::setYErrorOption(), Map1Projector::setYErrorOption(), MeshProjector::setYErrorOption(), and Map3Projector::valueRange().

CutList_t m_cut_list
protectedinherited
bool m_fixed
private

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

Definition at line 46 of file DyHist1DProjector.h.

unsigned int m_min_bindings
protectedinherited
const DataSource* m_ntuple
protectedinherited

The pointer to the data source being projected.

It is a pointer because the same data can be shared by multiple projectors.

Definition at line 93 of file NTupleProjector.h.

Referenced by NTupleProjector::acceptRow(), EqualEntriesHist1DProjector::adjustNumberOfBins(), Map3Projector::changedNTuple(), MeshProjector::changedNTuple(), Map2Projector::changedNTuple(), ProfileProjector::changedNTuple(), Profile2DProjector::changedNTuple(), Map1Projector::changedNTuple(), DyHist2DProjector::changedNTuple(), DyHist1DProjector::changedNTuple(), EqualEntriesHist1DProjector::changedNTuple(), MapMatrixProjector::changedNTuple(), NTupleProjector::createEmptyNTuple(), Map3Projector::createNTuple(), Map2Projector::createNTuple(), MeshProjector::createNTuple(), MapMatrixProjector::createNTuple(), NTupleProjector::dataRange(), Map1Projector::dataRangeOn(), NTupleProjector::dataRangeWithError(), ProfileProjector::execute(), DyHist1DProjector::execute(), Profile2DProjector::execute(), DyHist2DProjector::execute(), NTupleProjector::fillColumnAfterCuts(), NTupleProjector::fillNTuple(), StripChartProjector::fillProjectedValues(), Map2Projector::fillProjectedValues(), Map3Projector::fillProjectedValues(), MeshProjector::fillProjectedValues(), Map1Projector::fillProjectedValues(), EqualEntriesHist1DProjector::fillProjectedValues(), MapMatrixProjector::fillProjectedValues(), NTupleProjector::getAverage(), NTupleProjector::getAxisBindings(), NTupleProjector::getNTuple(), NTupleProjector::getNTupleName(), NTupleProjector::getNumberOfEntries(), NTupleProjector::getPos(), Map1Projector::getPosOn(), NTupleProjector::getPosWithError(), NTupleProjector::getTitle(), NTupleProjector::getXLabel(), Map1Projector::getYLabel(), NTupleProjector::getYLabel(), Map3Projector::getZLabel(), Profile2DProjector::getZLabel(), MapMatrixProjector::getZLabel(), MapMatrixProjector::getZValue(), NTupleProjector::indexOf(), Map1Projector::inRange(), NTupleProjector::inRange(), MeshProjector::inRangeWithZ(), MapMatrixProjector::inRangeWithZ(), NTupleProjector::isEmpty(), NTupleProjector::NTupleProjector(), MeshProjector::preferredRange(), MapMatrixProjector::preferredRange(), NTupleProjector::setAxisBinding(), NTupleProjector::setNTuple(), NTupleProjector::willDelete(), and NTupleProjector::~NTupleProjector().

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
std::string m_y_label_density
protectedinherited

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

When the axis is not scaled, the values of the ticks are the density.

Definition at line 44 of file Hist1DProjImp.h.

Referenced by DyHist1DProjector::getYLabel(), and Hist1DProjImp::Hist1DProjImp().

std::string m_y_label_entries
protectedinherited

The label of the y axis when axis is scaled.

When the axis is scaled, the values of the ticks appear to be number of entries per bin instead of the true density.

Definition at line 40 of file Hist1DProjImp.h.

Referenced by DyHist1DProjector::getYLabel(), Hist1DProjImp::Hist1DProjImp(), and StHist1DProjector::setYLabel().

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