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

#include <GaudiPI/Generic2D.h>

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

[legend]

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

[legend]

Public Types
typedef Generic2D< INTERFACE, IMPLEMENTATION >	Base

Public Member Functions
	Generic2D ()=default

TObject *	representation () const override
	ROOT object implementation.

void	adoptRepresentation (TObject *rep) override
	Adopt ROOT histogram representation.

std::string	title () const override
	Get the title of the object.

bool	setTitle (const std::string &title) override
	Set the title of the object.

std::string	name () const
	object name

bool	setName (const std::string &newName)
	Set the name of the object.

AIDA::IAnnotation &	annotation () override
	Access annotation object.

const AIDA::IAnnotation &	annotation () const override
	Access annotation object (cons)

const AIDA::IAxis &	xAxis () const override
	Return the X axis.

const AIDA::IAxis &	yAxis () const override
	Return the Y axis.

virtual int	rIndexX (int index) const
	operator methods

virtual int	rIndexY (int index) const
	operator methods

int	entries () const override
	Get the number or all the entries.

int	allEntries () const override
	Get the number or all the entries, both in range and underflow/overflow bins of the IProfile.

int	extraEntries () const override
	Get the number of entries in the underflow and overflow bins.

double	sumBinHeights () const override
	Get the sum of in range bin heights in the IProfile.

double	sumAllBinHeights () const override
	Get the sum of all the bins heights (including underflow and overflow bin).

double	sumExtraBinHeights () const override
	Get the sum of the underflow and overflow bin height.

double	minBinHeight () const override
	Get the minimum height of the in-range bins.

double	maxBinHeight () const override
	Get the maximum height of the in-range bins.

double	binMeanX (int indexX, int indexY) const override
	The weighted mean along x of a given bin.

double	binMeanY (int indexX, int indexY) const override
	The weighted mean along y of a given bin.

int	binEntries (int indexX, int indexY) const override
	The number of entries (ie the number of times fill was called for this bin).

int	binEntriesX (int indexX) const override
	Equivalent to `projectionX().binEntries(indexX)`.

int	binEntriesY (int indexY) const override
	Equivalent to `projectionY().binEntries(indexY)`.

double	binHeight (int indexX, int indexY) const override
	Total height of the corresponding bin (ie the sum of the weights in this bin).

double	binHeightX (int indexX) const override
	Equivalent to `projectionX().binHeight(indexX)`.

double	binHeightY (int indexY) const override
	Equivalent to `projectionY().binHeight(indexY)`.

double	binError (int indexX, int indexY) const override
	The error on this bin.

virtual double	binRms (int indexX, int indexY) const
	The spread (RMS) of this bin.

double	meanX () const override
	Returns the mean of the profile, as calculated on filling-time projected on the X axis.

double	meanY () const override
	Returns the mean of the profile, as calculated on filling-time projected on the Y axis.

double	rmsX () const override
	Returns the rms of the profile as calculated on filling-time projected on the X axis.

double	rmsY () const override
	Returns the rms of the profile as calculated on filling-time projected on the Y axis.

int	coordToIndexX (double coordX) const override
	Convenience method, equivalent to `xAxis().coordToIndex(coord)`.

int	coordToIndexY (double coordY) const override
	Convenience method, equivalent to `yAxis().coordToIndex(coord)`.

virtual double	equivalentBinEntries () const
	Number of equivalent entries, i.e. `SUM[ weight ] ^ 2 / SUM[ weight^2 ]`

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.

bool	add (const INTERFACE &h) override
	Modifies this profile by adding the contents of profile to it.

bool	reset () override

void *	cast (const std::string &className) const override
	Introspection method.

const std::string &	userLevelClassType () const
	The AIDA user-level unterface leaf class type.

int	dimension () const override
	Get the Histogram's dimension.

std::ostream &	print (std::ostream &s) const override
	Print (ASCII) the histogram into the output stream.

std::ostream &	write (std::ostream &s) const override
	Write (ASCII) the histogram table into the output stream.

int	write (const char *file_name) const override
	Write (ASCII) the histogram table into a file.

void *	cast (const std::string &className) const

int	binEntries (int indexX, int indexY) const

void	adoptRepresentation (TObject *rep)
	Adopt ROOT histogram representation.

void *	cast (const std::string &className) const

int	binEntries (int idX, int idY) const

void	adoptRepresentation (TObject *rep)
	Adopt ROOT histogram representation.

Public Member Functions inherited from Gaudi::HistogramBase
virtual	~HistogramBase ()=default

Protected Member Functions
	Generic2D (IMPLEMENTATION *p)
	constructor

Protected Attributes
Axis	m_xAxis
	X axis member.

Axis	m_yAxis
	Y axis member.

AIDA::Annotation	m_annotation
	Object annotations.

std::unique_ptr< IMPLEMENTATION >	m_rep
	Reference to underlying implementation.

std::string	m_classType
	class type

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

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 45 of file Generic2D.h.

Member Typedef Documentation

◆ Base

template<class INTERFACE, class IMPLEMENTATION>

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

Definition at line 47 of file Generic2D.h.

Constructor & Destructor Documentation

◆ Generic2D() [1/2]

template<class INTERFACE, class IMPLEMENTATION>

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

default

◆ Generic2D() [2/2]

template<class INTERFACE, class IMPLEMENTATION>

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

inlineprotected

constructor

Definition at line 53 of file Generic2D.h.

53: m_rep( p ) {}

Gaudi::Generic2D

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

Definition Generic2D.h:45

Gaudi::Generic2D::m_rep

std::unique_ptr< IMPLEMENTATION > m_rep

Reference to underlying implementation.

Definition Generic2D.h:161

Member Function Documentation

◆ add()

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 297 of file Generic2D.h.

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

◆ adoptRepresentation() [1/3]

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

virtual

Adopt ROOT histogram representation.

Implements Gaudi::HistogramBase.

Definition at line 128 of file H2D.cpp.

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

◆ adoptRepresentation() [2/3]

void Gaudi::Generic2D< AIDA::IProfile2D, TProfile2D >::adoptRepresentation ( TObject * rep )

virtual

Adopt ROOT histogram representation.

Implements Gaudi::HistogramBase.

Definition at line 45 of file P2D.cpp.

                                                                                {
    TProfile2D* imp = dynamic_cast<TProfile2D*>( rep );
    if ( !imp ) throw std::runtime_error( "Cannot adopt native histogram representation." );
    m_rep.reset( imp );
    m_xAxis.initialize( m_rep->GetXaxis(), true );
    m_yAxis.initialize( m_rep->GetYaxis(), true );
    setTitle( m_rep->GetTitle() );
  }

◆ adoptRepresentation() [3/3]

template<class INTERFACE, class IMPLEMENTATION>

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

overridevirtual

Adopt ROOT histogram representation.

Implements Gaudi::HistogramBase.

◆ allEntries()

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 189 of file Generic2D.h.

                                                             {
    return m_rep->GetEntries();
  }

◆ annotation() [1/2]

template<class INTERFACE, class IMPLEMENTATION>

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

inlineoverride

Access annotation object (cons)

Definition at line 71 of file Generic2D.h.

71{ return m_annotation; }

Gaudi::Generic2D::m_annotation

AIDA::Annotation m_annotation

Object annotations.

Definition Generic2D.h:159

◆ annotation() [2/2]

template<class INTERFACE, class IMPLEMENTATION>

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

inlineoverride

Access annotation object.

Definition at line 69 of file Generic2D.h.

69{ return m_annotation; }

◆ binEntries() [1/3]

int Gaudi::Generic2D< AIDA::IProfile2D, TProfile2D >::binEntries	(	int	idX,
		int	idY ) const

Definition at line 39 of file P2D.cpp.

                                                                                {
    int rBin = m_rep->GetBin( rIndexX( idX ), rIndexY( idY ) );
    return int( m_rep->GetBinEntries( rBin ) + 0.5 );
  }

◆ binEntries() [2/3]

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

Definition at line 121 of file H2D.cpp.

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

◆ binEntries() [3/3]

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

◆ binEntriesX()

template<class INTERFACE, class IMPLEMENTATION>

int Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::binEntriesX ( int indexX ) const

override

Equivalent to projectionX().binEntries(indexX).

Definition at line 229 of file Generic2D.h.

                                                                         {
    int n = 0;
    for ( int iY = -2; iY < yAxis().bins(); ++iY ) n += binEntries( index, iY );
    return n;
  }

◆ binEntriesY()

template<class INTERFACE, class IMPLEMENTATION>

int Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::binEntriesY ( int indexY ) const

override

Equivalent to projectionY().binEntries(indexY).

Definition at line 236 of file Generic2D.h.

                                                                         {
    int n = 0;
    for ( int iX = -2; iX < xAxis().bins(); ++iX ) n += binEntries( iX, index );
    return n;
  }

◆ binError()

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 262 of file Generic2D.h.

                                                                                      {
    return m_rep->GetBinError( rIndexX( indexX ), rIndexY( indexY ) );
  }

◆ binHeight()

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 243 of file Generic2D.h.

                                                                                       {
    return m_rep->GetBinContent( rIndexX( indexX ), rIndexY( indexY ) );
  }

◆ binHeightX()

template<class INTERFACE, class IMPLEMENTATION>

double Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::binHeightX ( int indexX ) const

override

Equivalent to projectionX().binHeight(indexX).

Definition at line 248 of file Generic2D.h.

                                                                           {
    double s = 0;
    for ( int iY = -2; iY < yAxis().bins(); ++iY ) { s += binHeight( index, iY ); }
    return s;
  }

◆ binHeightY()

template<class INTERFACE, class IMPLEMENTATION>

double Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::binHeightY ( int indexY ) const

override

Equivalent to projectionY().binHeight(indexY).

Definition at line 255 of file Generic2D.h.

                                                                           {
    double s = 0;
    for ( int iX = -2; iX < xAxis().bins(); ++iX ) s += binHeight( iX, index );
    return s;
  }

◆ binMeanX()

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 219 of file Generic2D.h.

                                                                               {
    return m_rep->GetXaxis()->GetBinCenter( rIndexX( indexX ) );
  }

◆ binMeanY()

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 224 of file Generic2D.h.

                                                                               {
    return m_rep->GetYaxis()->GetBinCenter( rIndexY( indexY ) );
  }

◆ binRms()

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.

                                                                                    {
    return m_rep->GetBinError( rIndexX( indexX ), rIndexY( indexY ) );
  }

◆ cast() [1/3]

void * Gaudi::Generic2D< IHistogram2D, TH2D >::cast ( const std::string & className ) const

Definition at line 112 of file H2D.cpp.

                                                                              {
    if ( className == "AIDA::IHistogram2D" )
      return (IHistogram2D*)this;
    else if ( className == "AIDA::IHistogram" )
      return (IHistogram*)this;
    return nullptr;
  }

◆ cast() [2/3]

void * Gaudi::Generic2D< AIDA::IProfile2D, TProfile2D >::cast ( const std::string & className ) const

Definition at line 29 of file P2D.cpp.

                                                                                      {
    return className == "AIDA::IProfile2D"
               ? const_cast<AIDA::IProfile2D*>( static_cast<const AIDA::IProfile2D*>( 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;
  }

◆ cast() [3/3]

template<class INTERFACE, class IMPLEMENTATION>

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

override

Introspection method.

◆ coordToIndexX()

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 287 of file Generic2D.h.

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

◆ coordToIndexY()

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 292 of file Generic2D.h.

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

◆ dimension()

template<class INTERFACE, class IMPLEMENTATION>

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

inlineoverride

Get the Histogram's dimension.

Definition at line 145 of file Generic2D.h.

145{ return 2; }

◆ entries()

template<class INTERFACE, class IMPLEMENTATION>

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

override

Get the number or all the entries.

Definition at line 184 of file Generic2D.h.

                                                          {
    return m_rep->GetEntries();
  }

◆ equivalentBinEntries()

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 313 of file Generic2D.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::Generic2D< INTERFACE, IMPLEMENTATION >::extraEntries ( ) const

override

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

Definition at line 305 of file Generic2D.h.

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

◆ maxBinHeight()

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 199 of file Generic2D.h.

                                                                  {
    return m_rep->GetMaximum();
  }

◆ meanX()

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 267 of file Generic2D.h.

                                                           {
    return m_rep->GetMean( 1 );
  }

◆ meanY()

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 272 of file Generic2D.h.

                                                           {
    return m_rep->GetMean( 2 );
  }

◆ minBinHeight()

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 194 of file Generic2D.h.

                                                                  {
    return m_rep->GetMinimum();
  }

◆ name()

template<class INTERFACE, class IMPLEMENTATION>

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

inline

object name

Definition at line 65 of file Generic2D.h.

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

◆ print()

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 334 of file Generic2D.h.

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

◆ representation()

template<class INTERFACE, class IMPLEMENTATION>

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

inlineoverridevirtual

ROOT object implementation.

Implements Gaudi::HistogramBase.

Definition at line 57 of file Generic2D.h.

57{ return m_rep.get(); }

◆ reset()

template<class INTERFACE, class IMPLEMENTATION>

bool Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::reset ( )

override

Definition at line 327 of file Generic2D.h.

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

◆ rIndexX()

template<class INTERFACE, class IMPLEMENTATION>

virtual int Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::rIndexX ( int index ) const

inlinevirtual

operator methods

Definition at line 78 of file Generic2D.h.

78{ return m_xAxis.rIndex( index ); }

◆ rIndexY()

template<class INTERFACE, class IMPLEMENTATION>

virtual int Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::rIndexY ( int index ) const

inlinevirtual

operator methods

Definition at line 80 of file Generic2D.h.

80{ return m_yAxis.rIndex( index ); }

◆ rmsX()

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 277 of file Generic2D.h.

                                                          {
    return m_rep->GetRMS( 1 );
  }

◆ rmsY()

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 282 of file Generic2D.h.

                                                          {
    return m_rep->GetRMS( 2 );
  }

◆ scale()

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 321 of file Generic2D.h.

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

◆ setName()

template<class INTERFACE, class IMPLEMENTATION>

bool Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::setName ( const std::string & newName )

Set the name of the object.

Definition at line 177 of file Generic2D.h.

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

◆ setTitle()

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 169 of file Generic2D.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::Generic2D< INTERFACE, IMPLEMENTATION >::sumAllBinHeights ( ) const

override

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

Definition at line 209 of file Generic2D.h.

                                                                      {
    return m_rep->GetSum();
  }

◆ sumBinHeights()

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 204 of file Generic2D.h.

                                                                   {
    return m_rep->GetSumOfWeights();
  }

◆ sumExtraBinHeights()

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 93 of file Generic2D.h.

93{ return sumAllBinHeights() - sumBinHeights(); }

Gaudi::Generic2D::sumAllBinHeights

double sumAllBinHeights() const override

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

Definition Generic2D.h:209

◆ title()

template<class INTERFACE, class IMPLEMENTATION>

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

inlineoverride

Get the title of the object.

Definition at line 61 of file Generic2D.h.

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

◆ userLevelClassType()

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 143 of file Generic2D.h.

143{ return m_classType; }

Gaudi::Generic2D::m_classType

std::string m_classType

class type

Definition Generic2D.h:163

◆ write() [1/2]

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 357 of file Generic2D.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::Generic2D< INTERFACE, IMPLEMENTATION >::write ( std::ostream & s ) const

overridevirtual

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

Implements Gaudi::HistogramBase.

Definition at line 342 of file Generic2D.h.

                                                                               {
    s << std::endl << "2D Histogram Table: " << std::endl;
    s << "BinX, BinY, Height, Error " << std::endl;
    for ( int i = 0; i < xAxis().bins(); ++i ) {
      for ( int j = 0; j < yAxis().bins(); ++j ) {
        s << binMeanX( i, j ) << ", " << binMeanY( i, j ) << ", " << binHeight( i, j ) << ", " << binError( i, j )
          << std::endl;
      }
    }
    s << std::endl;
    return s;
  }

◆ xAxis()

template<class INTERFACE, class IMPLEMENTATION>

const AIDA::IAxis & Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::xAxis ( ) const

inlineoverride

Return the X axis.

Definition at line 74 of file Generic2D.h.

74{ return m_xAxis; }

◆ yAxis()

template<class INTERFACE, class IMPLEMENTATION>

const AIDA::IAxis & Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::yAxis ( ) const

inlineoverride

Return the Y axis.

Definition at line 76 of file Generic2D.h.

76{ return m_yAxis; }

Member Data Documentation

◆ m_annotation

template<class INTERFACE, class IMPLEMENTATION>

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

mutableprotected

Object annotations.

Definition at line 159 of file Generic2D.h.

◆ m_classType

template<class INTERFACE, class IMPLEMENTATION>

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

protected

class type

Definition at line 163 of file Generic2D.h.

◆ m_rep

template<class INTERFACE, class IMPLEMENTATION>

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

protected

Reference to underlying implementation.

Definition at line 161 of file Generic2D.h.

◆ m_sumEntries

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 165 of file Generic2D.h.

◆ m_xAxis

template<class INTERFACE, class IMPLEMENTATION>

Axis Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::m_xAxis

protected

X axis member.

Definition at line 155 of file Generic2D.h.

◆ m_yAxis

template<class INTERFACE, class IMPLEMENTATION>

Axis Gaudi::Generic2D< INTERFACE, IMPLEMENTATION >::m_yAxis

protected

Y axis member.

Definition at line 157 of file Generic2D.h.

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

GaudiCommonSvc/include/GaudiCommonSvc/Generic2D.h

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Base

Constructor & Destructor Documentation

◆ Generic2D() [1/2]

◆ Generic2D() [2/2]

Member Function Documentation

◆ add()

◆ adoptRepresentation() [1/3]

◆ adoptRepresentation() [2/3]

◆ adoptRepresentation() [3/3]

◆ allEntries()

◆ annotation() [1/2]

◆ annotation() [2/2]

◆ binEntries() [1/3]

◆ binEntries() [2/3]

◆ binEntries() [3/3]

◆ binEntriesX()

◆ binEntriesY()

◆ binError()

◆ binHeight()

◆ binHeightX()

◆ binHeightY()

◆ binMeanX()

◆ binMeanY()

◆ binRms()

◆ cast() [1/3]

◆ cast() [2/3]

◆ cast() [3/3]

◆ coordToIndexX()

◆ coordToIndexY()

◆ dimension()

◆ entries()

◆ equivalentBinEntries()

◆ extraEntries()

◆ maxBinHeight()

◆ meanX()

◆ meanY()

◆ minBinHeight()

◆ name()

◆ print()

◆ representation()

◆ reset()

◆ rIndexX()

◆ rIndexY()

◆ rmsX()

◆ rmsY()

◆ scale()

◆ setName()

◆ setTitle()

◆ sumAllBinHeights()

◆ sumBinHeights()

◆ sumExtraBinHeights()

◆ title()

◆ userLevelClassType()

◆ write() [1/2]

◆ write() [2/2]

◆ xAxis()

◆ yAxis()

Member Data Documentation

◆ m_annotation

◆ m_classType

◆ m_rep

◆ m_sumEntries

◆ m_xAxis

◆ m_yAxis