Anaphe Home Page Reference Documentation

Main Page     Namespaces     Classes     Source Code    

I_Histo Class Reference

#include <I_Histo.h>

List of all members.


Detailed Description

Both transient and persistent histograms inherit from and implement this interface. Most of the features that are provided are for read-access only. The default "interface" for numerical values is double. Other objects types have interfaces that begin with I_ .

Definition at line 20 of file I_Histo.h.

Public Types

typedef HTL_STD::vector< IndexI_Bin_Location
typedef HTL_STD::vector< Extra_IndexI_Extra_Bin_Location
enum  { UNDERFLOW_BIN = -2, OVERFLOW_BIN = -1 }

Public Methods

 H_IID_IMPLEMENT (I_Histo)
 Very simple RTTI feature.

virtual const char * name () const=0
 Name/Title attached to this histogram.

virtual I_Bini_bin (I_Bin_Location &a_location)=0
 In-range bin associated with location a_location.

virtual I_Bini_bin (I_Bin_Location &a_location) const=0
 In-range bin associated with location a_location (const version).

virtual I_Bini_extra_bin (I_Extra_Bin_Location &a_location)=0
 Extra bin associated with extra location a_location If the location is in range, no meaningful extra bin is associated with this value.

virtual I_Bini_extra_bin (I_Extra_Bin_Location &a_location) const=0
 Extra bin associated with extra location a_location (const version).

virtual Size bin_count () const=0
 Number of in-range bins.

virtual Size extra_bin_count () const=0
 Number of extra bins.

virtual Size dim () const=0
 Dimension of the histo. i.e. of the problem space.

virtual I_Partitioni_partition (Index p=0)=0
 (Elementary) Partition interface associated with this histo.

virtual I_Partitioni_partition (Index p=0) const=0
 (Elementary) Partition interface associated with this histo (const version).

virtual void reset ()=0
 Reset histogram content.

virtual void start_update ()=0
 Start update.

virtual I_Bini_bin (Index i)=0
 Retrieve any bin (in-range or extra) whose index is i Note: this is a linear access.

virtual I_Bini_bin (Index i) const=0
 Retrieve any bin (in-range or extra) whose index is i .

virtual int version () const=0
 Histogram version.

virtual I_Bini_any_bin (I_Bin_Location &a_location) const=0
 Any bin associated with location a_location (const version).


Protected Methods

 I_Histo ()
virtual ~I_Histo ()


Member Typedef Documentation

typedef HTL_STD::vector< Index > I_Histo::I_Bin_Location
 

Definition at line 29 of file I_Histo.h.

Referenced by H_2D_Helper::band(), P_Histo3DVar::bin_center(), P_Histo3D::bin_center(), P_ProfileHisto2DVar::bin_center(), P_ProfileHisto2D::bin_center(), P_Histo2DVar::bin_center(), P_Histo2DF::bin_center(), P_Histo2D::bin_center(), P_Histo1DVar_FTS::bin_center(), P_Histo1D_FTS::bin_center(), P_ProfileHisto1DVar::bin_center(), P_ProfileHisto1D::bin_center(), P_Histo1DVar::bin_center(), P_Histo1D::bin_center(), H_Bin_Helper::bin_center(), H_Printout::print2(), H_2D_Helper::project(), HistoTable3D::write(), and HistoTable2D::write().

typedef HTL_STD::vector< Extra_Index > I_Histo::I_Extra_Bin_Location
 

Definition at line 30 of file I_Histo.h.

Referenced by H_2D_Helper::project(), and H_Printout::un_ov_value().


Member Enumeration Documentation

anonymous enum
 

Enumeration values:
UNDERFLOW_BIN 
OVERFLOW_BIN 

Definition at line 24 of file I_Histo.h.


Constructor & Destructor Documentation

I_Histo::I_Histo   [inline, protected]
 

Definition at line 32 of file I_Histo.h.

virtual I_Histo::~I_Histo   [inline, protected, virtual]
 

Definition at line 33 of file I_Histo.h.


Member Function Documentation

virtual Size I_Histo::bin_count   const [pure virtual]
 

Referenced by H_Printout::print1(), and HistoTable1D::write().

virtual Size I_Histo::dim   const [pure virtual]
 

Referenced by H_2D_Helper::band(), H_Bin_Helper::bin_center(), H_Printout::print(), H_Printout::print2(), H_2D_Helper::project(), HistoTable3D::write(), HistoTable2D::write(), and HistoTable1D::write().

virtual Size I_Histo::extra_bin_count   const [pure virtual]
 

I_Histo::H_IID_IMPLEMENT I_Histo   
 

virtual I_Bin& I_Histo::i_any_bin I_Bin_Location   a_location const [pure virtual]
 

Location element can be either bin number or one of the constants: { UNDERFLOW_BIN = -2, OVERFLOW_BIN = -1 } according to the AIDA specifications.

Referenced by H_2D_Helper::band(), and H_2D_Helper::project().

virtual I_Bin& I_Histo::i_bin Index    i const [pure virtual]
 

Const version. Note: this is a linear access. You must know how bins are stored to safely use this method.

virtual I_Bin& I_Histo::i_bin Index    i [pure virtual]
 

You must know how bins are stored to safely use this method.

virtual I_Bin& I_Histo::i_bin I_Bin_Location   a_location const [pure virtual]
 

virtual I_Bin& I_Histo::i_bin I_Bin_Location   a_location [pure virtual]
 

Referenced by H_2D_Helper::band(), H_Printout::print1(), H_Printout::print2(), H_2D_Helper::project(), HistoTable3D::write(), HistoTable2D::write(), and HistoTable1D::write().

virtual I_Bin& I_Histo::i_extra_bin I_Extra_Bin_Location   a_location const [pure virtual]
 

If the location is in range, no meaningful extra bin is associated with this value.

virtual I_Bin& I_Histo::i_extra_bin I_Extra_Bin_Location   a_location [pure virtual]
 

Referenced by H_Printout::un_ov_value().

virtual I_Partition& I_Histo::i_partition Index    p = 0 const [pure virtual]
 

Parameters:
1st  partition: p = 0
2nd  partition: p = 1 ...

virtual I_Partition& I_Histo::i_partition Index    p = 0 [pure virtual]
 

Parameters:
1st  partition: p = 0
2nd  partition: p = 1 ...

Referenced by H_2D_Helper::band(), H_Printout::print1(), H_Printout::print2(), H_2D_Helper::project(), HistoTable3D::write(), HistoTable2D::write(), H_2D_Helper::xBand(), and H_2D_Helper::yBand().

virtual const char* I_Histo::name   const [pure virtual]
 

Referenced by H_Printout::print1(), and H_Printout::print2().

virtual void I_Histo::reset   [pure virtual]
 

virtual void I_Histo::start_update   [pure virtual]
 

By default the interface only offers read access to bins and their contents; call this method to enable the later modification of the contents -- via set_value(..), etc.

virtual int I_Histo::version   const [pure virtual]
 

Can either be stored in the histogram or computed


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

Anaphe documentation generated by Doxygen (www.doxygen.org)