AIDA implementation for 1 D histograms using ROOT THD1. More...

#include </builds/gaudi/Gaudi/GaudiCommonSvc/include/GaudiCommonSvc/H1D.h>

Inheritance diagram for Gaudi::Histogram1D:

[legend]

Collaboration diagram for Gaudi::Histogram1D:

[legend]

Public Member Functions
	Histogram1D ()
	Standard constructor.

	Histogram1D (TH1D *rep)
	Standard constructor with initialization. The histogram representation will be adopted.

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

virtual bool	setBinContents (int i, int entries, double height, double error, double centre)
	set bin content (entries and centre are not used )

bool	reset () override

virtual bool	setStatistics (int allEntries, double eqBinEntries, double mean, double rms)
	set histogram statistics

bool	fill (double x, double weight) override
	Fill the Profile1D with a value and the corresponding weight.

bool	setRms (double rms)
	Update histogram RMS.

void	copyFromAida (const AIDA::IHistogram1D &h)
	Create new histogram from any AIDA based histogram.

const CLID &	clID () const override
	Retrieve reference to class defininition identifier.

StreamBuffer &	serialize (StreamBuffer &s)
	Serialization mechanism, Serialize the object for reading.

StreamBuffer &	serialize (StreamBuffer &s) const
	Serialization mechanism, Serialize the object for writing.

Public Member Functions inherited from DataObject
	DataObject ()
	Standard Constructor.

	DataObject (const DataObject &rhs)
	Copy Constructor.

DataObject &	operator= (const DataObject &rhs)
	Assignment Operator.

	DataObject (DataObject &&rhs)
	Move Constructor.

DataObject &	operator= (DataObject &&rhs)
	Move Assignment Operator.

virtual	~DataObject ()
	Standard Destructor.

virtual unsigned long	addRef ()
	Add reference to object.

virtual unsigned long	release ()
	release reference to object

const std::string &	name () const
	Retreive DataObject name. It is the name when registered in the store.

virtual StatusCode	update ()
	Provide empty placeholder for internal object reconfiguration callback.

void	setRegistry (IRegistry *pRegistry)
	Set pointer to Registry.

IRegistry *	registry () const
	Get pointer to Registry.

LinkManager *	linkMgr ()
	Retrieve Link manager.

const LinkManager *	linkMgr () const

unsigned char	version () const
	Retrieve version number of this object representation.

void	setVersion (unsigned char vsn)
	Set version number of this object representation.

unsigned long	refCount () const
	Return the refcount.

virtual std::ostream &	fillStream (std::ostream &s) const
	Fill the output stream (ASCII)

Public Member Functions inherited from Gaudi::Generic1D< AIDA::IHistogram1D, TH1D >
void *	cast (const std::string &className) const

int	binEntries (int index) const

int	binEntries (int index) const

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

	Generic1D ()=default
	Default constructor.

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

void *	cast (const std::string &cl) const override
	Manual cast by class name.

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

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

TObject *	representation () const override
	ROOT object implementation.

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)

Axis &	axis ()
	Access to axis object.

const Axis &	axis () const override
	Get the x axis of the IHistogram1D.

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.

int	binEntries (int index) const override
	Number of entries in the corresponding bin (ie the number of times fill was called for this bin).

int	binEntries (int index) const

int	binEntries (int index) const

virtual double	binRms (int index) const

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.

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	reset () override
	Reset the Histogram; as if just created.

bool	add (const AIDA::IHistogram1D &profile) override
	Modifies this IProfile1D by adding the contents of profile to it.

virtual int	rIndex (int index) const
	operator methods

double	binMean (int index) const override
	The weighted mean of a bin.

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

double	binError (int index) const override
	The error of a given bin.

double	mean () const override
	The mean of the whole IHistogram1D.

double	rms () const override
	The RMS of the whole IHistogram1D.

int	coordToIndex (double coord) const override
	Get the bin number corresponding to a given coordinate along the x axis.

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.

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

Static Public Member Functions
static const CLID &	classID ()

Static Public Member Functions inherited from DataObject
static const CLID &	classID ()
	Retrieve reference to class definition structure (static access)

Protected Attributes
double	m_sumwx = 0
	cache sumwx when setting contents since I don't have bin mean

Protected Attributes inherited from Gaudi::Generic1D< AIDA::IHistogram1D, TH1D >
Axis	m_axis
	Axis member.

AIDA::Annotation	m_annotation
	Object annotations.

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

std::string	m_classType

int	m_sumEntries

Private Member Functions
void	init (const std::string &title, bool initialize_axis=true)

void	initSums ()

Private Attributes
std::mutex	m_fillSerialization

Friends
void	reset (Histogram1D &h)

void	to_json (nlohmann::json &j, Gaudi::Histogram1D const &h)
	conversion to json via nlohmann library

Additional Inherited Members
Public Types inherited from Gaudi::Generic1D< AIDA::IHistogram1D, TH1D >
typedef Generic1D< AIDA::IHistogram1D, TH1D >	Base

Protected Member Functions inherited from Gaudi::Generic1D< AIDA::IHistogram1D, TH1D >
	Generic1D (TH1D *p)
	constructor

Detailed Description

AIDA implementation for 1 D histograms using ROOT THD1.

Author: M.Frank

Definition at line 31 of file H1D.h.

Constructor & Destructor Documentation

◆ Histogram1D() [1/2]

Gaudi::Histogram1D::Histogram1D ( )

Standard constructor.

Definition at line 73 of file H1D.cpp.

73: Base( new TH1D() ) { init( "", false ); }

Gaudi::Generic1D< AIDA::IHistogram1D, TH1D >::Base

Generic1D< AIDA::IHistogram1D, TH1D > Base

Definition Generic1D.h:47

Gaudi::Histogram1D::init

void init(const std::string &title, bool initialize_axis=true)

Definition H1D.cpp:81

◆ Histogram1D() [2/2]

Gaudi::Histogram1D::Histogram1D ( TH1D * rep )

Standard constructor with initialization. The histogram representation will be adopted.

Definition at line 75 of file H1D.cpp.

                                         {
  m_rep.reset( rep );
  init( m_rep->GetTitle() );
  initSums();
}

Member Function Documentation

◆ adoptRepresentation()

void Gaudi::Histogram1D::adoptRepresentation ( TObject * rep )

overridevirtual

Adopt ROOT histogram representation.

Reimplemented from Gaudi::Generic1D< AIDA::IHistogram1D, TH1D >.

Definition at line 108 of file H1D.cpp.

                                                         {
  Gaudi::Generic1D<AIDA::IHistogram1D, TH1D>::adoptRepresentation( rep );
  if ( m_rep ) {
    init( m_rep->GetTitle() );
    initSums();
  }
}

◆ classID()

static const CLID & Gaudi::Histogram1D::classID ( )

inlinestatic

Definition at line 66 of file H1D.h.

66{ return CLID_H1D; }

◆ clID()

const CLID & Gaudi::Histogram1D::clID ( ) const

inlineoverridevirtual

Retrieve reference to class defininition identifier.

Reimplemented from DataObject.

Definition at line 65 of file H1D.h.

65{ return classID(); }

Gaudi::Histogram1D::classID

static const CLID & classID()

Definition H1D.h:66

◆ copyFromAida()

void Gaudi::Histogram1D::copyFromAida ( const AIDA::IHistogram1D & h )

Create new histogram from any AIDA based histogram.

Definition at line 167 of file H1D.cpp.

                                                               {
  // implement here the copy
  std::string title = h.title() + "Copy";
  if ( h.axis().isFixedBinning() ) {
    m_rep.reset(
        new TH1D( title.c_str(), title.c_str(), h.axis().bins(), h.axis().lowerEdge(), h.axis().upperEdge() ) );
  } else {
    Edges e;
    for ( int i = 0; i < h.axis().bins(); ++i ) { e.push_back( h.axis().binLowerEdge( i ) ); }
    // add also upperedges at the end
    e.push_back( h.axis().upperEdge() );
    m_rep.reset( new TH1D( title.c_str(), title.c_str(), e.size() - 1, &e.front() ) );
  }
  m_axis.initialize( m_rep->GetXaxis(), false );
  m_rep->Sumw2();
  m_sumEntries = 0;
  m_sumwx      = 0;
  // sumw
  double sumw = h.sumBinHeights();
  // sumw2
  double sumw2 = 0;
  if ( std::abs( h.equivalentBinEntries() ) > std::numeric_limits<double>::epsilon() )
    sumw2 = ( sumw * sumw ) / h.equivalentBinEntries();
 
  double sumwx  = h.mean() * h.sumBinHeights();
  double sumwx2 = ( h.mean() * h.mean() + h.rms() * h.rms() ) * h.sumBinHeights();
 
  // copy the contents in
  for ( int i = -2; i < axis().bins(); ++i ) {
    // root binning starts from one !
    m_rep->SetBinContent( rIndex( i ), h.binHeight( i ) );
    m_rep->SetBinError( rIndex( i ), h.binError( i ) );
  }
  // need to do set entries after setting contents otherwise root will recalulate them
  // taking into account how many time  SetBinContents() has been called
  m_rep->SetEntries( h.allEntries() );
  // stat vector
  std::vector<double> stat( 11 );
  stat[0] = sumw;
  stat[1] = sumw2;
  stat[2] = sumwx;
  stat[3] = sumwx2;
  m_rep->PutStats( &stat.front() );
}

◆ fill()

bool Gaudi::Histogram1D::fill	(	double	x,
		double	weight )

override

Fill the Profile1D with a value and the corresponding weight.

Definition at line 160 of file H1D.cpp.

                                                     {
  // avoid race conditions when filling the histogram
  auto guard = std::scoped_lock{ m_fillSerialization };
  m_rep->Fill( x, weight );
  return true;
}

◆ init()

void Gaudi::Histogram1D::init	(	const std::string &	title,
		bool	initialize_axis = true )

private

Definition at line 81 of file H1D.cpp.

                                                                          {
  m_classType = "IHistogram1D";
  if ( initialize_axis ) { m_axis.initialize( m_rep->GetXaxis(), false ); }
  const TArrayD* a = m_rep->GetSumw2();
  if ( !a || ( a && a->GetSize() == 0 ) ) m_rep->Sumw2();
  setTitle( title );
  m_rep->SetDirectory( nullptr );
  m_sumEntries = 0;
  m_sumwx      = 0;
}

◆ initSums()

void Gaudi::Histogram1D::initSums ( )

private

Definition at line 92 of file H1D.cpp.

                                {
  m_sumwx      = 0;
  m_sumEntries = 0;
  for ( int i = 1, n = m_rep->GetNbinsX(); i <= n; ++i ) {
    m_sumwx += m_rep->GetBinContent( i ) * m_rep->GetBinCenter( i );
    m_sumEntries += m_rep->GetBinContent( i );
  }
}

◆ reset()

bool Gaudi::Histogram1D::reset ( )

override

Definition at line 101 of file H1D.cpp.

                             {
  m_sumwx      = 0;
  m_sumEntries = 0;
  return Base::reset();
}

◆ serialize() [1/2]

StreamBuffer & Gaudi::Histogram1D::serialize ( StreamBuffer & s )

Serialization mechanism, Serialize the object for reading.

Parameters

s	the StreamBuffer containing the data to be read

Returns: the resulting StreamBuffer, after reading

Definition at line 212 of file H1D.cpp.

                                                           {
  // DataObject::serialize(s);
  std::string title;
  int         size;
  s >> size;
  for ( int j = 0; j < size; j++ ) {
    std::string key, value;
    s >> key >> value;
    if ( !annotation().addItem( key, value ) ) { annotation().setValue( key, value ); };
    if ( "Title" == key ) { title = value; }
  }
  double lowerEdge, upperEdge, binHeight, binError;
  int    isFixedBinning, bins;
  s >> isFixedBinning >> bins;
 
  if ( isFixedBinning ) {
    s >> lowerEdge >> upperEdge;
    m_rep.reset( new TH1D( title.c_str(), title.c_str(), bins, lowerEdge, upperEdge ) );
  } else {
    Edges edges;
    edges.resize( bins );
    for ( int i = 0; i <= bins; ++i ) s >> edges[i];
    m_rep.reset( new TH1D( title.c_str(), title.c_str(), edges.size() - 1, &edges.front() ) );
  }
  m_axis.initialize( m_rep->GetXaxis(), true );
  m_rep->Sumw2();
  m_sumEntries = 0;
  m_sumwx      = 0;
 
  for ( int i = 0; i <= bins + 1; ++i ) {
    s >> binHeight >> binError;
    m_rep->SetBinContent( i, binHeight );
    m_rep->SetBinError( i, binError );
  }
  Stat_t allEntries;
  s >> allEntries;
  m_rep->SetEntries( allEntries );
  Stat_t stats[4]; // stats array
  s >> stats[0] >> stats[1] >> stats[2] >> stats[3];
  m_rep->PutStats( stats );
  return s;
}

◆ serialize() [2/2]

StreamBuffer & Gaudi::Histogram1D::serialize ( StreamBuffer & s ) const

Serialization mechanism, Serialize the object for writing.

Parameters

s	the StreamBuffer where to write the data

Returns: the resulting StreamBuffer, after wrinting

Definition at line 255 of file H1D.cpp.

                                                                 {
  // DataObject::serialize(s);
  s << static_cast<int>( annotation().size() );
  for ( int i = 0; i < annotation().size(); i++ ) {
    s << annotation().key( i );
    s << annotation().value( i );
  }
  const AIDA::IAxis& axis( this->axis() );
  const int          isFixedBinning = axis.isFixedBinning();
  const int          bins           = axis.bins();
  s << isFixedBinning << bins;
  if ( isFixedBinning ) {
    s << axis.lowerEdge();
  } else {
    for ( int i = 0; i < bins; ++i ) s << axis.binLowerEdge( i );
  }
  s << axis.upperEdge();
  for ( int i = 0; i <= bins + 1; ++i ) s << m_rep->GetBinContent( i ) << m_rep->GetBinError( i );
 
  s << m_rep->GetEntries();
  Stat_t stats[4]; // stats array
  m_rep->GetStats( stats );
  s << stats[0] << stats[1] << stats[2] << stats[3];
  return s;
}

◆ setBinContents()

bool Gaudi::Histogram1D::setBinContents	(	int	i,
		int	entries,
		double	height,
		double	error,
		double	centre )

virtual

set bin content (entries and centre are not used )

Definition at line 116 of file H1D.cpp.

                                                                                                      {
  m_rep->SetBinContent( rIndex( i ), height );
  m_rep->SetBinError( rIndex( i ), error );
  // accumulate sumwx for in range bins
  if ( i != AIDA::IAxis::UNDERFLOW_BIN && i != AIDA::IAxis::OVERFLOW_BIN ) m_sumwx += centre * height;
  m_sumEntries += entries;
  return true;
}

◆ setRms()

bool Gaudi::Histogram1D::setRms ( double rms )

Update histogram RMS.

Definition at line 125 of file H1D.cpp.

                                          {
  m_rep->SetEntries( m_sumEntries );
  std::vector<double> stat( 11 );
  // sum weights
  stat[0] = sumBinHeights();
  stat[1] = 0;
  if ( std::abs( equivalentBinEntries() ) > std::numeric_limits<double>::epsilon() )
    stat[1] = ( sumBinHeights() * sumBinHeights() ) / equivalentBinEntries();
  stat[2]     = m_sumwx;
  double mean = 0;
  if ( std::abs( sumBinHeights() ) > std::numeric_limits<double>::epsilon() ) mean = m_sumwx / sumBinHeights();
  stat[3] = ( mean * mean + rms * rms ) * sumBinHeights();
  m_rep->PutStats( &stat.front() );
  return true;
}

◆ setStatistics()

bool Gaudi::Histogram1D::setStatistics	(	int	allEntries,
		double	eqBinEntries,
		double	mean,
		double	rms )

virtual

set histogram statistics

Definition at line 142 of file H1D.cpp.

                                                                                                   {
  m_rep->SetEntries( allEntries );
  // fill statistcal vector for Root
  std::vector<double> stat( 11 );
  // sum weights
  stat[0] = sumBinHeights();
  // sum weights **2
  stat[1] = 0;
  if ( std::abs( eqBinEntries ) > std::numeric_limits<double>::epsilon() )
    stat[1] = ( sumBinHeights() * sumBinHeights() ) / eqBinEntries;
  // sum weights * x
  stat[2] = mean * sumBinHeights();
  // sum weight * x **2
  stat[3] = ( mean * mean + rms * rms ) * sumBinHeights();
  m_rep->PutStats( &stat.front() );
  return true;
}

Friends And Related Symbol Documentation

◆ reset

void reset ( Histogram1D & h )

friend

Definition at line 53 of file H1D.h.

53{ h.reset(); }

◆ to_json

void to_json	(	nlohmann::json &	j,
		Gaudi::Histogram1D const &	h )

friend

conversion to json via nlohmann library

Definition at line 55 of file H1D.h.

55{ j = *h.m_rep.get(); }

Member Data Documentation

◆ m_fillSerialization

std::mutex Gaudi::Histogram1D::m_fillSerialization

private

Definition at line 80 of file H1D.h.

◆ m_sumwx

double Gaudi::Histogram1D::m_sumwx = 0

protected

cache sumwx when setting contents since I don't have bin mean

Definition at line 38 of file H1D.h.

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

GaudiCommonSvc/include/GaudiCommonSvc/H1D.h
GaudiCommonSvc/src/HistogramSvc/H1D.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Histogram1D() [1/2]

◆ Histogram1D() [2/2]

Member Function Documentation

◆ adoptRepresentation()

◆ classID()

◆ clID()

◆ copyFromAida()

◆ fill()

◆ init()

◆ initSums()

◆ reset()

◆ serialize() [1/2]

◆ serialize() [2/2]

◆ setBinContents()

◆ setRms()

◆ setStatistics()

Friends And Related Symbol Documentation

◆ reset

◆ to_json

Member Data Documentation

◆ m_fillSerialization

◆ m_sumwx