The Gaudi Framework  v30r3 (a5ef0a68)
Gaudi::Generic2D< INTERFACE, IMPLEMENTATION > Class Template Reference

Common AIDA implementation stuff for histograms and profiles using ROOT implementations. More...

#include <GaudiPI/Generic2D.h>

Inheritance diagram for Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >:
Collaboration diagram for Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >:

Public Types

typedef Generic2D< INTERFACE, IMPLEMENTATION > Base
 

Public Member Functions

 Generic2D ()=default
 
TObject * representation () const override
 ROOT object implementation. More...
 
void adoptRepresentation (TObject *rep) override
 Adopt ROOT histogram representation. More...
 
std::string title () const override
 Get the title of the object. More...
 
bool setTitle (const std::string &title) override
 Set the title of the object. More...
 
std::string name () const
 object name More...
 
bool setName (const std::string &newName)
 Set the name of the object. More...
 
AIDA::IAnnotation & annotation () override
 Access annotation object. More...
 
const AIDA::IAnnotation & annotation () const override
 Access annotation object (cons) More...
 
const AIDA::IAxis & xAxis () const override
 Return the X axis. More...
 
const AIDA::IAxis & yAxis () const override
 Return the Y axis. More...
 
virtual int rIndexX (int index) const
 operator methods More...
 
virtual int rIndexY (int index) const
 operator methods More...
 
int entries () const override
 Get the number or all the entries. More...
 
int allEntries () const override
 Get the number or all the entries, both in range and underflow/overflow bins of the IProfile. More...
 
int extraEntries () const override
 Get the number of entries in the underflow and overflow bins. More...
 
double sumBinHeights () const override
 Get the sum of in range bin heights in the IProfile. More...
 
double sumAllBinHeights () const override
 Get the sum of all the bins heights (including underflow and overflow bin). More...
 
double sumExtraBinHeights () const override
 Get the sum of the underflow and overflow bin height. More...
 
double minBinHeight () const override
 Get the minimum height of the in-range bins. More...
 
double maxBinHeight () const override
 Get the maximum height of the in-range bins. More...
 
double binMeanX (int indexX, int indexY) const override
 The weighted mean along x of a given bin. More...
 
double binMeanY (int indexX, int indexY) const override
 The weighted mean along y of a given bin. More...
 
int binEntries (int indexX, int indexY) const override
 The number of entries (ie the number of times fill was called for this bin). More...
 
int binEntriesX (int indexX) const override
 Equivalent to projectionX().binEntries(indexX). More...
 
int binEntriesY (int indexY) const override
 Equivalent to projectionY().binEntries(indexY). More...
 
double binHeight (int indexX, int indexY) const override
 Total height of the corresponding bin (ie the sum of the weights in this bin). More...
 
double binHeightX (int indexX) const override
 Equivalent to projectionX().binHeight(indexX). More...
 
double binHeightY (int indexY) const override
 Equivalent to projectionY().binHeight(indexY). More...
 
double binError (int indexX, int indexY) const override
 The error on this bin. More...
 
virtual double binRms (int indexX, int indexY) const
 The spread (RMS) of this bin. More...
 
double meanX () const override
 Returns the mean of the profile, as calculated on filling-time projected on the X axis. More...
 
double meanY () const override
 Returns the mean of the profile, as calculated on filling-time projected on the Y axis. More...
 
double rmsX () const override
 Returns the rms of the profile as calculated on filling-time projected on the X axis. More...
 
double rmsY () const override
 Returns the rms of the profile as calculated on filling-time projected on the Y axis. More...
 
int coordToIndexX (double coordX) const override
 Convenience method, equivalent to xAxis().coordToIndex(coord). More...
 
int coordToIndexY (double coordY) const override
 Convenience method, equivalent to yAxis().coordToIndex(coord). More...
 
virtual double equivalentBinEntries () const
 Number of equivalent entries, i.e. SUM[ weight ] ^ 2 / SUM[ weight^2 ] More...
 
virtual bool scale (double scaleFactor)
 Scale the weights and the errors of all the IHistogram's bins (in-range and out-of-range ones) by a given scale factor. More...
 
bool add (const INTERFACE &h) override
 Modifies this profile by adding the contents of profile to it. More...
 
bool reset () override
 
void * cast (const std::string &className) const override
 Introspection method. More...
 
const std::stringuserLevelClassType () const
 The AIDA user-level unterface leaf class type. More...
 
int dimension () const override
 Get the Histogram's dimension. More...
 
std::ostreamprint (std::ostream &s) const override
 Print (ASCII) the histogram into the output stream. More...
 
std::ostreamwrite (std::ostream &s) const override
 Write (ASCII) the histogram table into the output stream. More...
 
int write (const char *file_name) const override
 Write (ASCII) the histogram table into a file. More...
 
template<>
void * cast (const std::string &className) const
 
template<>
int binEntries (int indexX, int indexY) const
 
template<>
void adoptRepresentation (TObject *rep)
 Adopt ROOT histogram representation. More...
 
template<>
void * cast (const std::string &className) const
 
template<>
int binEntries (int idX, int idY) const
 
template<>
void adoptRepresentation (TObject *rep)
 Adopt ROOT histogram representation. More...
 
- Public Member Functions inherited from Gaudi::HistogramBase
virtual ~HistogramBase ()=default
 

Protected Member Functions

 Generic2D (IMPLEMENTATION *p)
 constructor More...
 

Protected Attributes

Axis m_xAxis
 X axis member. More...
 
Axis m_yAxis
 Y axis member. More...
 
AIDA::Annotation m_annotation
 Object annotations. More...
 
std::unique_ptr< IMPLEMENTATION > m_rep
 Reference to underlying implementation. More...
 
std::string m_classType
 class type More...
 
int m_sumEntries = 0
 cache sumEntries (allEntries) when setting contents since Root can't compute by himself More...
 

Detailed Description

template<class INTERFACE, class IMPLEMENTATION>
class Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >

Common AIDA implementation stuff for histograms and profiles using ROOT implementations.

Credits: This code is the result of some stripdown implementation of LCG/PI. Credits to them!

Author
M.Frank

Definition at line 36 of file Generic2D.h.

Member Typedef Documentation

template<class INTERFACE, class IMPLEMENTATION>
typedef Generic2D<INTERFACE, IMPLEMENTATION> Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::Base

Definition at line 39 of file Generic2D.h.

Constructor & Destructor Documentation

template<class INTERFACE, class IMPLEMENTATION>
Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::Generic2D ( )
default
template<class INTERFACE, class IMPLEMENTATION>
Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::Generic2D ( IMPLEMENTATION *  p)
inlineprotected

constructor

Definition at line 45 of file Generic2D.h.

45 : m_rep( p ) {}
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153

Member Function Documentation

template<class INTERFACE, class IMPLEMENTATION >
bool Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::add ( const INTERFACE &  h)
override

Modifies this profile by adding the contents of profile to it.

Definition at line 314 of file Generic2D.h.

315  {
316  const Base* p = dynamic_cast<const Base*>( &hist );
317  if ( !p ) throw std::runtime_error( "Cannot add profile histograms of different implementations." );
318  m_rep->Add( p->m_rep.get() );
319  return true;
320  }
Generic2D< INTERFACE, IMPLEMENTATION > Base
Definition: Generic2D.h:39
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
template<>
void Gaudi::Generic2D< AIDA::IProfile2D, TProfile2D >::adoptRepresentation ( TObject *  rep)
virtual

Adopt ROOT histogram representation.

Implements Gaudi::HistogramBase.

Definition at line 42 of file P2D.cpp.

43  {
44  TProfile2D* imp = dynamic_cast<TProfile2D*>( rep );
45  if ( !imp ) throw std::runtime_error( "Cannot adopt native histogram representation." );
46  m_rep.reset( imp );
47  m_xAxis.initialize( m_rep->GetXaxis(), true );
48  m_yAxis.initialize( m_rep->GetYaxis(), true );
49  setTitle( m_rep->GetTitle() );
50  }
Axis m_xAxis
X axis member.
Definition: Generic2D.h:147
T reset(T...args)
void initialize(TAxis *itaxi, bool)
Definition: Axis.h:67
bool setTitle(const std::string &title) override
Set the title of the object.
Definition: Generic2D.h:161
Axis m_yAxis
Y axis member.
Definition: Generic2D.h:149
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
template<class INTERFACE, class IMPLEMENTATION>
void Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::adoptRepresentation ( TObject *  rep)
overridevirtual

Adopt ROOT histogram representation.

Implements Gaudi::HistogramBase.

template<>
void Gaudi::Generic2D< AIDA::IHistogram2D, TH2D >::adoptRepresentation ( TObject *  rep)
virtual

Adopt ROOT histogram representation.

Implements Gaudi::HistogramBase.

Definition at line 127 of file H2D.cpp.

128  {
129  TH2D* imp = dynamic_cast<TH2D*>( rep );
130  if ( !imp ) throw std::runtime_error( "Cannot adopt native histogram representation." );
131  m_rep.reset( imp );
132  m_xAxis.initialize( m_rep->GetXaxis(), true );
133  m_yAxis.initialize( m_rep->GetYaxis(), true );
134  const TArrayD* a = m_rep->GetSumw2();
135  if ( !a || ( a && a->GetSize() == 0 ) ) m_rep->Sumw2();
136  setTitle( m_rep->GetTitle() );
137  }
Axis m_xAxis
X axis member.
Definition: Generic2D.h:147
T reset(T...args)
void initialize(TAxis *itaxi, bool)
Definition: Axis.h:67
bool setTitle(const std::string &title) override
Set the title of the object.
Definition: Generic2D.h:161
Axis m_yAxis
Y axis member.
Definition: Generic2D.h:149
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
template<class INTERFACE , class IMPLEMENTATION >
int Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::allEntries ( ) const
override

Get the number or all the entries, both in range and underflow/overflow bins of the IProfile.

Definition at line 184 of file Generic2D.h.

185  {
186  return m_rep->GetEntries();
187  }
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
template<class INTERFACE, class IMPLEMENTATION>
AIDA::IAnnotation& Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::annotation ( )
inlineoverride

Access annotation object.

Definition at line 61 of file Generic2D.h.

61 { return m_annotation; }
AIDA::Annotation m_annotation
Object annotations.
Definition: Generic2D.h:151
template<class INTERFACE, class IMPLEMENTATION>
const AIDA::IAnnotation& Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::annotation ( ) const
inlineoverride

Access annotation object (cons)

Definition at line 63 of file Generic2D.h.

63 { return m_annotation; }
AIDA::Annotation m_annotation
Object annotations.
Definition: Generic2D.h:151
template<>
int Gaudi::Generic2D< AIDA::IProfile2D, TProfile2D >::binEntries ( int  idX,
int  idY 
) const

Definition at line 35 of file P2D.cpp.

36  {
37  int rBin = m_rep->GetBin( rIndexX( idX ), rIndexY( idY ) );
38  return int( m_rep->GetBinEntries( rBin ) + 0.5 );
39  }
virtual int rIndexX(int index) const
operator methods
Definition: Generic2D.h:70
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
virtual int rIndexY(int index) const
operator methods
Definition: Generic2D.h:72
template<class INTERFACE, class IMPLEMENTATION>
int Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::binEntries ( int  indexX,
int  indexY 
) const
override

The number of entries (ie the number of times fill was called for this bin).

template<>
int Gaudi::Generic2D< IHistogram2D, TH2D >::binEntries ( int  indexX,
int  indexY 
) const

Definition at line 119 of file H2D.cpp.

120  {
121  if ( binHeight( indexX, indexY ) <= 0 ) return 0;
122  double xx = binHeight( indexX, indexY ) / binError( indexX, indexY );
123  return int( xx * xx + 0.5 );
124  }
double binError(int indexX, int indexY) const override
The error on this bin.
Definition: Generic2D.h:272
double binHeight(int indexX, int indexY) const override
Total height of the corresponding bin (ie the sum of the weights in this bin).
Definition: Generic2D.h:248
template<class INTERFACE , class IMPLEMENTATION >
int Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::binEntriesX ( int  indexX) const
override

Equivalent to projectionX().binEntries(indexX).

Definition at line 232 of file Generic2D.h.

233  {
234  int n = 0;
235  for ( int iY = -2; iY < yAxis().bins(); ++iY ) n += binEntries( index, iY );
236  return n;
237  }
int binEntries(int indexX, int indexY) const override
The number of entries (ie the number of times fill was called for this bin).
const AIDA::IAxis & yAxis() const override
Return the Y axis.
Definition: Generic2D.h:68
template<class INTERFACE , class IMPLEMENTATION >
int Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::binEntriesY ( int  indexY) const
override

Equivalent to projectionY().binEntries(indexY).

Definition at line 240 of file Generic2D.h.

241  {
242  int n = 0;
243  for ( int iX = -2; iX < xAxis().bins(); ++iX ) n += binEntries( iX, index );
244  return n;
245  }
int binEntries(int indexX, int indexY) const override
The number of entries (ie the number of times fill was called for this bin).
const AIDA::IAxis & xAxis() const override
Return the X axis.
Definition: Generic2D.h:66
template<class INTERFACE , class IMPLEMENTATION >
double Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::binError ( int  indexX,
int  indexY 
) const
override

The error on this bin.

Definition at line 272 of file Generic2D.h.

273  {
274  return m_rep->GetBinError( rIndexX( indexX ), rIndexY( indexY ) );
275  }
virtual int rIndexX(int index) const
operator methods
Definition: Generic2D.h:70
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
virtual int rIndexY(int index) const
operator methods
Definition: Generic2D.h:72
template<class INTERFACE , class IMPLEMENTATION >
double Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::binHeight ( int  indexX,
int  indexY 
) const
override

Total height of the corresponding bin (ie the sum of the weights in this bin).

Definition at line 248 of file Generic2D.h.

249  {
250  return m_rep->GetBinContent( rIndexX( indexX ), rIndexY( indexY ) );
251  }
virtual int rIndexX(int index) const
operator methods
Definition: Generic2D.h:70
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
virtual int rIndexY(int index) const
operator methods
Definition: Generic2D.h:72
template<class INTERFACE , class IMPLEMENTATION >
double Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::binHeightX ( int  indexX) const
override

Equivalent to projectionX().binHeight(indexX).

Definition at line 254 of file Generic2D.h.

255  {
256  double s = 0;
257  for ( int iY = -2; iY < yAxis().bins(); ++iY ) {
258  s += binHeight( index, iY );
259  }
260  return s;
261  }
string s
Definition: gaudirun.py:253
const AIDA::IAxis & yAxis() const override
Return the Y axis.
Definition: Generic2D.h:68
double binHeight(int indexX, int indexY) const override
Total height of the corresponding bin (ie the sum of the weights in this bin).
Definition: Generic2D.h:248
template<class INTERFACE , class IMPLEMENTATION >
double Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::binHeightY ( int  indexY) const
override

Equivalent to projectionY().binHeight(indexY).

Definition at line 264 of file Generic2D.h.

265  {
266  double s = 0;
267  for ( int iX = -2; iX < xAxis().bins(); ++iX ) s += binHeight( iX, index );
268  return s;
269  }
string s
Definition: gaudirun.py:253
const AIDA::IAxis & xAxis() const override
Return the X axis.
Definition: Generic2D.h:66
double binHeight(int indexX, int indexY) const override
Total height of the corresponding bin (ie the sum of the weights in this bin).
Definition: Generic2D.h:248
template<class INTERFACE , class IMPLEMENTATION >
double Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::binMeanX ( int  indexX,
int  indexY 
) const
override

The weighted mean along x of a given bin.

Definition at line 220 of file Generic2D.h.

221  {
222  return m_rep->GetXaxis()->GetBinCenter( rIndexX( indexX ) );
223  }
virtual int rIndexX(int index) const
operator methods
Definition: Generic2D.h:70
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
template<class INTERFACE , class IMPLEMENTATION >
double Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::binMeanY ( int  indexX,
int  indexY 
) const
override

The weighted mean along y of a given bin.

Definition at line 226 of file Generic2D.h.

227  {
228  return m_rep->GetYaxis()->GetBinCenter( rIndexY( indexY ) );
229  }
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
virtual int rIndexY(int index) const
operator methods
Definition: Generic2D.h:72
template<class INTERFACE , class IMPLEMENTATION >
double Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::binRms ( int  indexX,
int  indexY 
) const
virtual

The spread (RMS) of this bin.

Definition at line 214 of file Generic2D.h.

215  {
216  return m_rep->GetBinError( rIndexX( indexX ), rIndexY( indexY ) );
217  }
virtual int rIndexX(int index) const
operator methods
Definition: Generic2D.h:70
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
virtual int rIndexY(int index) const
operator methods
Definition: Generic2D.h:72
template<>
void * Gaudi::Generic2D< AIDA::IProfile2D, TProfile2D >::cast ( const std::string className) const

Definition at line 23 of file P2D.cpp.

24  {
25  if ( className == "AIDA::IProfile2D" )
26  return const_cast<AIDA::IProfile2D*>( (AIDA::IProfile2D*)this );
27  else if ( className == "AIDA::IProfile" )
28  return const_cast<AIDA::IProfile*>( (AIDA::IProfile*)this );
29  else if ( className == "AIDA::IBaseHistogram" )
30  return const_cast<AIDA::IBaseHistogram*>( (AIDA::IBaseHistogram*)this );
31  return nullptr;
32  }
template<>
void * Gaudi::Generic2D< IHistogram2D, TH2D >::cast ( const std::string className) const

Definition at line 109 of file H2D.cpp.

110  {
111  if ( className == "AIDA::IHistogram2D" )
112  return (IHistogram2D*)this;
113  else if ( className == "AIDA::IHistogram" )
114  return (IHistogram*)this;
115  return nullptr;
116  }
template<class INTERFACE, class IMPLEMENTATION>
void* Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::cast ( const std::string className) const
override

Introspection method.

template<class INTERFACE , class IMPLEMENTATION >
int Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::coordToIndexX ( double  coordX) const
override

Convenience method, equivalent to xAxis().coordToIndex(coord).

Definition at line 302 of file Generic2D.h.

303  {
304  return xAxis().coordToIndex( coord );
305  }
const AIDA::IAxis & xAxis() const override
Return the X axis.
Definition: Generic2D.h:66
template<class INTERFACE , class IMPLEMENTATION >
int Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::coordToIndexY ( double  coordY) const
override

Convenience method, equivalent to yAxis().coordToIndex(coord).

Definition at line 308 of file Generic2D.h.

309  {
310  return yAxis().coordToIndex( coord );
311  }
const AIDA::IAxis & yAxis() const override
Return the Y axis.
Definition: Generic2D.h:68
template<class INTERFACE, class IMPLEMENTATION>
int Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::dimension ( ) const
inlineoverride

Get the Histogram's dimension.

Definition at line 137 of file Generic2D.h.

137 { return 2; }
template<class INTERFACE , class IMPLEMENTATION >
int Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::entries ( ) const
override

Get the number or all the entries.

Definition at line 178 of file Generic2D.h.

179  {
180  return m_rep->GetEntries();
181  }
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
template<class INTERFACE , class IMPLEMENTATION >
double Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::equivalentBinEntries ( ) const
virtual

Number of equivalent entries, i.e. SUM[ weight ] ^ 2 / SUM[ weight^2 ]

Definition at line 332 of file Generic2D.h.

333  {
334  if ( sumBinHeights() <= 0 ) return 0;
335  Stat_t stats[11]; // cover up to 3D...
336  m_rep->GetStats( stats );
337  return stats[0] * stats[0] / stats[1];
338  }
double sumBinHeights() const override
Get the sum of in range bin heights in the IProfile.
Definition: Generic2D.h:202
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
template<class INTERFACE , class IMPLEMENTATION >
int Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::extraEntries ( ) const
override

Get the number of entries in the underflow and overflow bins.

Definition at line 323 of file Generic2D.h.

324  {
325  return binEntries( AIDA::IAxis::UNDERFLOW_BIN, AIDA::IAxis::UNDERFLOW_BIN ) +
326  binEntries( AIDA::IAxis::UNDERFLOW_BIN, AIDA::IAxis::OVERFLOW_BIN ) +
327  binEntries( AIDA::IAxis::OVERFLOW_BIN, AIDA::IAxis::UNDERFLOW_BIN ) +
328  binEntries( AIDA::IAxis::OVERFLOW_BIN, AIDA::IAxis::OVERFLOW_BIN );
329  }
int binEntries(int indexX, int indexY) const override
The number of entries (ie the number of times fill was called for this bin).
template<class INTERFACE , class IMPLEMENTATION >
double Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::maxBinHeight ( ) const
override

Get the maximum height of the in-range bins.

Definition at line 196 of file Generic2D.h.

197  {
198  return m_rep->GetMaximum();
199  }
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
template<class INTERFACE , class IMPLEMENTATION >
double Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::meanX ( ) const
override

Returns the mean of the profile, as calculated on filling-time projected on the X axis.

Definition at line 278 of file Generic2D.h.

279  {
280  return m_rep->GetMean( 1 );
281  }
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
template<class INTERFACE , class IMPLEMENTATION >
double Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::meanY ( ) const
override

Returns the mean of the profile, as calculated on filling-time projected on the Y axis.

Definition at line 284 of file Generic2D.h.

285  {
286  return m_rep->GetMean( 2 );
287  }
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
template<class INTERFACE , class IMPLEMENTATION >
double Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::minBinHeight ( ) const
override

Get the minimum height of the in-range bins.

Definition at line 190 of file Generic2D.h.

191  {
192  return m_rep->GetMinimum();
193  }
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
template<class INTERFACE, class IMPLEMENTATION>
std::string Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::name ( ) const
inline

object name

Definition at line 57 of file Generic2D.h.

57 { return m_annotation.value( "Name" ); }
AIDA::Annotation m_annotation
Object annotations.
Definition: Generic2D.h:151
std::string value(const std::string &key) const override
Retrieve the value for a given key.
Definition: Annotation.h:102
template<class INTERFACE , class IMPLEMENTATION >
std::ostream & Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::print ( std::ostream s) const
overridevirtual

Print (ASCII) the histogram into the output stream.

bin contents and errors are printed for all bins including under and overflows

Implements Gaudi::HistogramBase.

Definition at line 356 of file Generic2D.h.

357  {
359  m_rep->Print( "all" );
360  return s;
361  }
string s
Definition: gaudirun.py:253
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
template<class INTERFACE, class IMPLEMENTATION>
TObject* Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::representation ( ) const
inlineoverridevirtual

ROOT object implementation.

Implements Gaudi::HistogramBase.

Definition at line 49 of file Generic2D.h.

49 { return m_rep.get(); }
T get(T...args)
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
template<class INTERFACE , class IMPLEMENTATION >
bool Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::reset ( )
override

Definition at line 348 of file Generic2D.h.

349  {
350  m_sumEntries = 0;
351  m_rep->Reset();
352  return true;
353  }
int m_sumEntries
cache sumEntries (allEntries) when setting contents since Root can&#39;t compute by himself ...
Definition: Generic2D.h:157
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
template<class INTERFACE, class IMPLEMENTATION>
virtual int Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::rIndexX ( int  index) const
inlinevirtual

operator methods

Definition at line 70 of file Generic2D.h.

70 { return m_xAxis.rIndex( index ); }
Axis m_xAxis
X axis member.
Definition: Generic2D.h:147
int rIndex(int index) const
Convert a AIDA bin number on the axis to the ROOT bin number.
Definition: Axis.h:53
template<class INTERFACE, class IMPLEMENTATION>
virtual int Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::rIndexY ( int  index) const
inlinevirtual

operator methods

Definition at line 72 of file Generic2D.h.

72 { return m_yAxis.rIndex( index ); }
Axis m_yAxis
Y axis member.
Definition: Generic2D.h:149
int rIndex(int index) const
Convert a AIDA bin number on the axis to the ROOT bin number.
Definition: Axis.h:53
template<class INTERFACE , class IMPLEMENTATION >
double Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::rmsX ( ) const
override

Returns the rms of the profile as calculated on filling-time projected on the X axis.

Definition at line 290 of file Generic2D.h.

291  {
292  return m_rep->GetRMS( 1 );
293  }
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
template<class INTERFACE , class IMPLEMENTATION >
double Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::rmsY ( ) const
override

Returns the rms of the profile as calculated on filling-time projected on the Y axis.

Definition at line 296 of file Generic2D.h.

297  {
298  return m_rep->GetRMS( 2 );
299  }
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
template<class INTERFACE , class IMPLEMENTATION >
bool Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::scale ( double  scaleFactor)
virtual

Scale the weights and the errors of all the IHistogram's bins (in-range and out-of-range ones) by a given scale factor.

Definition at line 341 of file Generic2D.h.

342  {
343  m_rep->Scale( scaleFactor );
344  return true;
345  }
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
template<class INTERFACE , class IMPLEMENTATION >
bool Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::setName ( const std::string newName)

Set the name of the object.

Definition at line 170 of file Generic2D.h.

171  {
172  m_rep->SetName( newName.c_str() );
173  m_annotation.setValue( "Name", newName );
174  return true;
175  }
void setValue(const std::string &key, const std::string &value) override
Set value for a given key.
Definition: Annotation.h:108
AIDA::Annotation m_annotation
Object annotations.
Definition: Generic2D.h:151
T c_str(T...args)
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
template<class INTERFACE , class IMPLEMENTATION >
bool Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::setTitle ( const std::string title)
override

Set the title of the object.

Definition at line 161 of file Generic2D.h.

162  {
163  m_rep->SetTitle( title.c_str() );
164  if ( !annotation().addItem( "Title", title ) ) m_annotation.setValue( "Title", title );
165  if ( !annotation().addItem( "title", title ) ) annotation().setValue( "title", title );
166  return true;
167  }
void setValue(const std::string &key, const std::string &value) override
Set value for a given key.
Definition: Annotation.h:108
AIDA::IAnnotation & annotation() override
Access annotation object.
Definition: Generic2D.h:61
AIDA::Annotation m_annotation
Object annotations.
Definition: Generic2D.h:151
T c_str(T...args)
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
template<class INTERFACE , class IMPLEMENTATION >
double Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::sumAllBinHeights ( ) const
override

Get the sum of all the bins heights (including underflow and overflow bin).

Definition at line 208 of file Generic2D.h.

209  {
210  return m_rep->GetSum();
211  }
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
template<class INTERFACE , class IMPLEMENTATION >
double Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::sumBinHeights ( ) const
override

Get the sum of in range bin heights in the IProfile.

Definition at line 202 of file Generic2D.h.

203  {
204  return m_rep->GetSumOfWeights();
205  }
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
template<class INTERFACE, class IMPLEMENTATION>
double Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::sumExtraBinHeights ( ) const
inlineoverride

Get the sum of the underflow and overflow bin height.

Definition at line 85 of file Generic2D.h.

85 { return sumAllBinHeights() - sumBinHeights(); }
double sumBinHeights() const override
Get the sum of in range bin heights in the IProfile.
Definition: Generic2D.h:202
double sumAllBinHeights() const override
Get the sum of all the bins heights (including underflow and overflow bin).
Definition: Generic2D.h:208
template<class INTERFACE, class IMPLEMENTATION>
std::string Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::title ( ) const
inlineoverride

Get the title of the object.

Definition at line 53 of file Generic2D.h.

53 { return m_annotation.value( "Title" ); }
AIDA::Annotation m_annotation
Object annotations.
Definition: Generic2D.h:151
std::string value(const std::string &key) const override
Retrieve the value for a given key.
Definition: Annotation.h:102
template<class INTERFACE, class IMPLEMENTATION>
const std::string& Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::userLevelClassType ( ) const
inline

The AIDA user-level unterface leaf class type.

Definition at line 135 of file Generic2D.h.

135 { return m_classType; }
std::string m_classType
class type
Definition: Generic2D.h:155
template<class INTERFACE , class IMPLEMENTATION >
std::ostream & Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::write ( std::ostream s) const
overridevirtual

Write (ASCII) the histogram table into the output stream.

Implements Gaudi::HistogramBase.

Definition at line 365 of file Generic2D.h.

366  {
367  s << std::endl << "2D Histogram Table: " << std::endl;
368  s << "BinX, BinY, Height, Error " << std::endl;
369  for ( int i = 0; i < xAxis().bins(); ++i ) {
370  for ( int j = 0; j < yAxis().bins(); ++j ) {
371  s << binMeanX( i, j ) << ", " << binMeanY( i, j ) << ", " << binHeight( i, j ) << ", " << binError( i, j )
372  << std::endl;
373  }
374  }
375  s << std::endl;
376  return s;
377  }
T endl(T...args)
double binMeanY(int indexX, int indexY) const override
The weighted mean along y of a given bin.
Definition: Generic2D.h:226
double binError(int indexX, int indexY) const override
The error on this bin.
Definition: Generic2D.h:272
string s
Definition: gaudirun.py:253
double binMeanX(int indexX, int indexY) const override
The weighted mean along x of a given bin.
Definition: Generic2D.h:220
const AIDA::IAxis & yAxis() const override
Return the Y axis.
Definition: Generic2D.h:68
const AIDA::IAxis & xAxis() const override
Return the X axis.
Definition: Generic2D.h:66
double binHeight(int indexX, int indexY) const override
Total height of the corresponding bin (ie the sum of the weights in this bin).
Definition: Generic2D.h:248
template<class INTERFACE , class IMPLEMENTATION >
int Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::write ( const char *  file_name) const
overridevirtual

Write (ASCII) the histogram table into a file.

Implements Gaudi::HistogramBase.

Definition at line 381 of file Generic2D.h.

382  {
383  TFile* f = TFile::Open( file_name, "RECREATE" );
384  Int_t nbytes = m_rep->Write();
385  f->Close();
386  return nbytes;
387  }
std::unique_ptr< IMPLEMENTATION > m_rep
Reference to underlying implementation.
Definition: Generic2D.h:153
template<class INTERFACE, class IMPLEMENTATION>
const AIDA::IAxis& Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::xAxis ( ) const
inlineoverride

Return the X axis.

Definition at line 66 of file Generic2D.h.

66 { return m_xAxis; }
Axis m_xAxis
X axis member.
Definition: Generic2D.h:147
template<class INTERFACE, class IMPLEMENTATION>
const AIDA::IAxis& Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::yAxis ( ) const
inlineoverride

Return the Y axis.

Definition at line 68 of file Generic2D.h.

68 { return m_yAxis; }
Axis m_yAxis
Y axis member.
Definition: Generic2D.h:149

Member Data Documentation

template<class INTERFACE, class IMPLEMENTATION>
AIDA::Annotation Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::m_annotation
mutableprotected

Object annotations.

Definition at line 151 of file Generic2D.h.

template<class INTERFACE, class IMPLEMENTATION>
std::string Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::m_classType
protected

class type

Definition at line 155 of file Generic2D.h.

template<class INTERFACE, class IMPLEMENTATION>
std::unique_ptr<IMPLEMENTATION> Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::m_rep
protected

Reference to underlying implementation.

Definition at line 153 of file Generic2D.h.

template<class INTERFACE, class IMPLEMENTATION>
int Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::m_sumEntries = 0
protected

cache sumEntries (allEntries) when setting contents since Root can't compute by himself

Definition at line 157 of file Generic2D.h.

template<class INTERFACE, class IMPLEMENTATION>
Axis Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::m_xAxis
protected

X axis member.

Definition at line 147 of file Generic2D.h.

template<class INTERFACE, class IMPLEMENTATION>
Axis Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::m_yAxis
protected

Y axis member.

Definition at line 149 of file Generic2D.h.


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