Gaudi::Generic1D< INTERFACE, IMPLEMENTATION > Class Template Reference

#include <GaudiPI/Generic1D.h>

Inheritance diagram for Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >:

Collaboration diagram for Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >:

Public Types
typedef Generic1D< INTERFACE, IMPLEMENTATION >	Base

Public Member Functions
	Generic1D ()=default
	Default constructor. More...
virtual const std::string &	userLevelClassType () const
	The AIDA user-level unterface leaf class type. More...
void *	cast (const std::string &cl) const override
	Manual cast by class name. More...
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...
Axis &	axis ()
	Access to axis object. More...
const Axis &	axis () const override
	Get the x axis of the IHistogram1D. 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...
int	binEntries (int index) const override
	Number of entries in the corresponding bin (ie the number of times fill was called for this bin). More...
virtual double	binRms (int index) const
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...
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	reset () override
	Reset the Histogram; as if just created. More...
bool	add (const INTERFACE &profile) override
	Modifies this IProfile1D by adding the contents of profile to it. More...
virtual int	rIndex (int index) const
	operator methods More...
double	binMean (int index) const override
	The weighted mean of a bin. More...
double	binHeight (int index) const override
	Total height of the corresponding bin (ie the sum of the weights in this bin). More...
double	binError (int index) const override
	The error of a given bin. More...
double	mean () const override
	The mean of the whole IHistogram1D. More...
double	rms () const override
	The RMS of the whole IHistogram1D. More...
int	coordToIndex (double coord) const override
	Get the bin number corresponding to a given coordinate along the x axis. More...
int	dimension () const override
	Get the Histogram's dimension. More...
std::ostream &	print (std::ostream &s) const override
	Print (ASCII) the histogram into the output stream. More...
std::ostream &	write (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...
void *	cast (const std::string &className) const
int	binEntries (int index) const
void	adoptRepresentation (TObject *rep)
	Adopt ROOT histogram representation. More...
int	binEntries (int index) const
void *	cast (const std::string &className) const
void	adoptRepresentation (TObject *rep)
	Adopt ROOT histogram representation. More...
Public Member Functions inherited from Gaudi::HistogramBase
virtual	~HistogramBase ()=default

Protected Member Functions
	Generic1D (IMPLEMENTATION *p)
	constructor More...

Protected Attributes
Axis	m_axis
	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
int	m_sumEntries { 0 }

Detailed Description

template<class INTERFACE, class IMPLEMENTATION>
class Gaudi::Generic1D< 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 46 of file Generic1D.h.

Member Typedef Documentation

Base

template<class INTERFACE , class IMPLEMENTATION >

typedef Generic1D<INTERFACE, IMPLEMENTATION> Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::Base

Definition at line 48 of file Generic1D.h.

Constructor & Destructor Documentation

Generic1D() [1/2]

template<class INTERFACE , class IMPLEMENTATION >

Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::Generic1D ( )

default

Default constructor.

Generic1D() [2/2]

template<class INTERFACE , class IMPLEMENTATION >

Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::Generic1D ( IMPLEMENTATION *  p )

inlineprotected

constructor

Definition at line 54 of file Generic1D.h.

: m_rep( p ) {}

Member Function Documentation

add()

template<class INTERFACE , class IMPLEMENTATION >

bool Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::add ( const INTERFACE &  profile )

override

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

Definition at line 209 of file Generic1D.h.

                                                                     {
    const Generic1D<INTERFACE, IMPLEMENTATION>* p = dynamic_cast<const Generic1D<INTERFACE, IMPLEMENTATION>*>( &h );
    if ( p ) {
      m_rep->Add( p->m_rep.get() );
      return true;
    }
    throw std::runtime_error( "Cannot add profile histograms of different implementations." );
  }

adoptRepresentation() [1/3]

void Gaudi::Generic1D< AIDA::IHistogram1D, TH1D >::adoptRepresentation ( TObject *  rep )

virtual

Adopt ROOT histogram representation.

Implements Gaudi::HistogramBase.

Definition at line 71 of file H1D.cpp.

                                                                            {
    TH1D* imp = dynamic_cast<TH1D*>( rep );
    if ( !imp ) throw std::runtime_error( "Cannot adopt native histogram representation." );
    m_rep.reset( imp );
  }

adoptRepresentation() [2/3]

void Gaudi::Generic1D< AIDA::IProfile1D, TProfile >::adoptRepresentation ( TObject *  rep )

virtual

Adopt ROOT histogram representation.

Implements Gaudi::HistogramBase.

Definition at line 75 of file P1D.cpp.

                                                                              {
    TProfile* imp = dynamic_cast<TProfile*>( rep );
    if ( !imp ) throw std::runtime_error( "Cannot adopt native histogram representation." );
    m_rep.reset( imp );
    m_axis.initialize( m_rep->GetXaxis(), true );
    const TArrayD* a = m_rep->GetSumw2();
    if ( !a || ( a && a->GetSize() == 0 ) ) m_rep->Sumw2();
    setTitle( m_rep->GetTitle() );
  }

adoptRepresentation() [3/3]

template<class INTERFACE , class IMPLEMENTATION >

void Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::adoptRepresentation ( TObject *  rep )

overridevirtual

Adopt ROOT histogram representation.

Implements Gaudi::HistogramBase.

allEntries()

template<class INTERFACE , class IMPLEMENTATION >

int Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::allEntries ( ) const

inlineoverride

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

Definition at line 85 of file Generic1D.h.

{ return m_rep->GetEntries(); }

annotation() [1/2]

template<class INTERFACE , class IMPLEMENTATION >

const AIDA::IAnnotation& Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::annotation ( ) const

inlineoverride

Access annotation object (cons)

Definition at line 76 of file Generic1D.h.

{ return m_annotation; }

annotation() [2/2]

template<class INTERFACE , class IMPLEMENTATION >

AIDA::IAnnotation& Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::annotation ( )

inlineoverride

Access annotation object.

Definition at line 74 of file Generic1D.h.

{ return m_annotation; }

axis() [1/2]

template<class INTERFACE , class IMPLEMENTATION >

Axis& Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::axis ( )

inline

Access to axis object.

Definition at line 78 of file Generic1D.h.

{ return m_axis; }

axis() [2/2]

template<class INTERFACE , class IMPLEMENTATION >

const Axis& Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::axis ( ) const

inlineoverride

Get the x axis of the IHistogram1D.

Definition at line 80 of file Generic1D.h.

{ return m_axis; }

binEntries() [1/3]

int Gaudi::Generic1D< AIDA::IProfile1D, TProfile >::binEntries

(

int

index

)

const

Definition at line 60 of file P1D.cpp.

                                                                       {
    return int( m_rep->GetBinEntries( rIndex( index ) ) + 0.5 );
  }

binEntries() [2/3]

int Gaudi::Generic1D< AIDA::IHistogram1D, TH1D >::binEntries

(

int

index

)

const

Definition at line 64 of file H1D.cpp.

                                                                     {
    if ( binHeight( index ) <= 0 ) return 0;
    double xx = binHeight( index ) / binError( index );
    return int( xx * xx + 0.5 );
  }

binEntries() [3/3]

template<class INTERFACE , class IMPLEMENTATION >

int Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::binEntries ( int  index ) const

override

Number of entries in the corresponding bin (ie the number of times fill was called for this bin).

binError()

template<class INTERFACE , class IMPLEMENTATION >

double Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::binError ( int  index ) const

override

The error of a given bin.

Definition at line 179 of file Generic1D.h.

                                                                         {
    return m_rep->GetBinError( rIndex( index ) );
  }

binHeight()

template<class INTERFACE , class IMPLEMENTATION >

double Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::binHeight ( int  index ) const

override

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

Definition at line 174 of file Generic1D.h.

                                                                          {
    return m_rep->GetBinContent( rIndex( index ) );
  }

binMean()

template<class INTERFACE , class IMPLEMENTATION >

double Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::binMean ( int  index ) const

override

The weighted mean of a bin.

Definition at line 169 of file Generic1D.h.

                                                                        {
    return m_rep->GetBinCenter( rIndex( index ) );
  }

binRms()

template<class INTERFACE , class IMPLEMENTATION >

double Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::binRms ( int  index ) const

virtual

Definition at line 164 of file Generic1D.h.

                                                                       {
    return m_rep->GetBinError( rIndex( index ) );
  }

cast() [1/3]

template<class INTERFACE , class IMPLEMENTATION >

void* Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::cast ( const std::string &  cl ) const

override

Manual cast by class name.

cast() [2/3]

void * Gaudi::Generic1D< AIDA::IHistogram1D, TH1D >::cast

(

const std::string &

className

)

const

Definition at line 57 of file H1D.cpp.

                                                                                  {
    if ( className == "AIDA::IHistogram1D" ) return const_cast<AIDA::IHistogram1D*>( (AIDA::IHistogram1D*)this );
    if ( className == "AIDA::IHistogram" ) return const_cast<AIDA::IHistogram*>( (AIDA::IHistogram*)this );
    return nullptr;
  }

cast() [3/3]

void * Gaudi::Generic1D< AIDA::IProfile1D, TProfile >::cast

(

const std::string &

className

)

const

Definition at line 65 of file P1D.cpp.

                                                                                    {
    return className == "AIDA::IProfile1D"
               ? const_cast<AIDA::IProfile1D*>( static_cast<const AIDA::IProfile1D*>( this ) )
           : className == "AIDA::IProfile" ? const_cast<AIDA::IProfile*>( static_cast<const AIDA::IProfile*>( this ) )
           : className == "AIDA::IBaseHistogram"
               ? const_cast<AIDA::IBaseHistogram*>( static_cast<const AIDA::IBaseHistogram*>( this ) )
               : nullptr;
  }

coordToIndex()

template<class INTERFACE , class IMPLEMENTATION >

int Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::coordToIndex ( double  coord ) const

inlineoverride

Get the bin number corresponding to a given coordinate along the x axis.

Definition at line 125 of file Generic1D.h.

{ return axis().coordToIndex( coord ); }

dimension()

template<class INTERFACE , class IMPLEMENTATION >

int Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::dimension ( ) const

inlineoverride

Get the Histogram's dimension.

Definition at line 127 of file Generic1D.h.

{ return 1; }

entries()

template<class INTERFACE , class IMPLEMENTATION >

int Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::entries ( ) const

inlineoverride

Get the number or all the entries.

Definition at line 83 of file Generic1D.h.

{ return m_rep->GetEntries(); }

equivalentBinEntries()

template<class INTERFACE , class IMPLEMENTATION >

double Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::equivalentBinEntries

virtual

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

Definition at line 195 of file Generic1D.h.

                                                                          {
    if ( sumBinHeights() <= 0 ) return 0;
    Stat_t stats[11]; // cover up to 3D...
    m_rep->GetStats( stats );
    return stats[0] * stats[0] / stats[1];
  }

extraEntries()

template<class INTERFACE , class IMPLEMENTATION >

int Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::extraEntries

override

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

Definition at line 184 of file Generic1D.h.

                                                               {
    return binEntries( AIDA::IAxis::UNDERFLOW_BIN ) + binEntries( AIDA::IAxis::OVERFLOW_BIN );
  }

maxBinHeight()

template<class INTERFACE , class IMPLEMENTATION >

double Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::maxBinHeight ( ) const

inlineoverride

Get the maximum height of the in-range bins.

Definition at line 101 of file Generic1D.h.

{ return m_rep->GetMaximum(); }

mean()

template<class INTERFACE , class IMPLEMENTATION >

double Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::mean ( ) const

inlineoverride

The mean of the whole IHistogram1D.

Definition at line 121 of file Generic1D.h.

{ return m_rep->GetMean(); }

minBinHeight()

template<class INTERFACE , class IMPLEMENTATION >

double Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::minBinHeight ( ) const

inlineoverride

Get the minimum height of the in-range bins.

Definition at line 99 of file Generic1D.h.

{ return m_rep->GetMinimum(); }

name()

template<class INTERFACE , class IMPLEMENTATION >

std::string Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::name ( ) const

inline

object name

Definition at line 70 of file Generic1D.h.

{ return m_annotation.value( "Name" ); }

print()

template<class INTERFACE , class IMPLEMENTATION >

std::ostream & Gaudi::Generic1D< 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 219 of file Generic1D.h.

                                                                               {
    m_rep->Print( "all" );
    return s;
  }

representation()

template<class INTERFACE , class IMPLEMENTATION >

TObject* Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::representation ( ) const

inlineoverridevirtual

ROOT object implementation.

Implements Gaudi::HistogramBase.

Definition at line 62 of file Generic1D.h.

{ return m_rep.get(); }

reset()

template<class INTERFACE , class IMPLEMENTATION >

bool Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::reset

override

Reset the Histogram; as if just created.

Definition at line 188 of file Generic1D.h.

                                                   {
    m_sumEntries = 0;
    m_rep->Reset();
    return true;
  }

rIndex()

template<class INTERFACE , class IMPLEMENTATION >

virtual int Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::rIndex ( int  index ) const

inlinevirtual

operator methods

Definition at line 113 of file Generic1D.h.

{ return m_axis.rIndex( index ); }

rms()

template<class INTERFACE , class IMPLEMENTATION >

double Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::rms ( ) const

inlineoverride

The RMS of the whole IHistogram1D.

Definition at line 123 of file Generic1D.h.

{ return m_rep->GetRMS(); }

scale()

template<class INTERFACE , class IMPLEMENTATION >

bool Gaudi::Generic1D< 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 203 of file Generic1D.h.

                                                                       {
    m_rep->Scale( scaleFactor );
    return true;
  }

setName()

template<class INTERFACE , class IMPLEMENTATION >

bool Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::setName

(

const std::string &

newName

)

Set the name of the object.

Definition at line 157 of file Generic1D.h.

                                                                               {
    m_rep->SetName( newName.c_str() );
    m_annotation.setValue( "Name", newName );
    return true;
  }

setTitle()

template<class INTERFACE , class IMPLEMENTATION >

bool Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::setTitle ( const std::string &  title )

override

Set the title of the object.

Definition at line 149 of file Generic1D.h.

                                                                              {
    m_rep->SetTitle( title.c_str() );
    if ( !annotation().addItem( "Title", title ) ) m_annotation.setValue( "Title", title );
    if ( !annotation().addItem( "title", title ) ) annotation().setValue( "title", title );
    return true;
  }

sumAllBinHeights()

template<class INTERFACE , class IMPLEMENTATION >

double Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::sumAllBinHeights ( ) const

inlineoverride

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

Definition at line 95 of file Generic1D.h.

{ return m_rep->GetSum(); }

sumBinHeights()

template<class INTERFACE , class IMPLEMENTATION >

double Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::sumBinHeights ( ) const

inlineoverride

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

Definition at line 93 of file Generic1D.h.

{ return m_rep->GetSumOfWeights(); }

sumExtraBinHeights()

template<class INTERFACE , class IMPLEMENTATION >

double Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::sumExtraBinHeights ( ) const

inlineoverride

Get the sum of the underflow and overflow bin height.

Definition at line 97 of file Generic1D.h.

{ return sumAllBinHeights() - sumBinHeights(); }

title()

template<class INTERFACE , class IMPLEMENTATION >

std::string Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::title ( ) const

inlineoverride

Get the title of the object.

Definition at line 66 of file Generic1D.h.

{ return m_annotation.value( "Title" ); }

userLevelClassType()

template<class INTERFACE , class IMPLEMENTATION >

virtual const std::string& Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::userLevelClassType ( ) const

inlinevirtual

The AIDA user-level unterface leaf class type.

Definition at line 58 of file Generic1D.h.

{ return m_classType; }

write() [1/2]

template<class INTERFACE , class IMPLEMENTATION >

int Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::write ( const char *  file_name ) const

overridevirtual

Write (ASCII) the histogram table into a file.

Implements Gaudi::HistogramBase.

Definition at line 238 of file Generic1D.h.

                                                                               {
    TFile* f      = TFile::Open( file_name, "RECREATE" );
    Int_t  nbytes = m_rep->Write();
    f->Close();
    return nbytes;
  }

write() [2/2]

template<class INTERFACE , class IMPLEMENTATION >

std::ostream & Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::write ( std::ostream &  s ) const

overridevirtual

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

Implements Gaudi::HistogramBase.

Definition at line 227 of file Generic1D.h.

                                                                               {
    s << "\n1D Histogram Table: " << std::endl;
    s << "Bin, Height, Error " << std::endl;
    for ( int i = 0; i < axis().bins(); ++i )
      s << binMean( i ) << ", " << binHeight( i ) << ", " << binError( i ) << std::endl;
    s << std::endl;
    return s;
  }

Member Data Documentation

m_annotation

template<class INTERFACE , class IMPLEMENTATION >

AIDA::Annotation Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::m_annotation

mutableprotected

Object annotations.

Definition at line 139 of file Generic1D.h.

m_axis

template<class INTERFACE , class IMPLEMENTATION >

Axis Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::m_axis

protected

Axis member.

Definition at line 137 of file Generic1D.h.

m_classType

template<class INTERFACE , class IMPLEMENTATION >

std::string Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::m_classType

protected

Definition at line 143 of file Generic1D.h.

m_rep

template<class INTERFACE , class IMPLEMENTATION >

std::unique_ptr<IMPLEMENTATION> Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::m_rep

protected

Reference to underlying implementation.

Definition at line 141 of file Generic1D.h.

m_sumEntries

template<class INTERFACE , class IMPLEMENTATION >

int Gaudi::Generic1D< INTERFACE, IMPLEMENTATION >::m_sumEntries { 0 }

protected

Definition at line 145 of file Generic1D.h.

---

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

• GaudiCommonSvc/include/GaudiCommonSvc/Generic1D.h