Collection of useful utilities for manipulations with AIDA hisgograms. More...

Namespaces
	Formats
	The 15 format fields are predefined now:

Classes
class	HistoStrings
	Helper class to produce "good" dictionaries. More...

class	Table
	Simple class for the customizeble printout of the histogram tables. More...

Typedefs
typedef std::vector< std::string >	Labels
	Typedef for a list of labels. More...

typedef std::pair< unsigned, std::string >	BinLabel
	Typedef for a bin number and its associated label. More...

typedef std::vector< BinLabel >	BinLabels
	Typedef for a list of bin numbers and their associated label. More...

Functions
GAUDI_API void	fill (AIDA::IHistogram1D *histo, const double value, const double weight=1.0)
	simple function to fill AIDA::IHistogram1D objects More...

GAUDI_API void	fill (AIDA::IHistogram2D *histo, const double valueX, const double valueY, const double weight=1.0)
	simple function to fill AIDA::IHistogram2D objects More...

GAUDI_API void	fill (AIDA::IHistogram3D *histo, const double valueX, const double valueY, const double valueZ, const double weight=1.0)
	simple function to fill AIDA::IHistogram3D objects More...

GAUDI_API void	fill (AIDA::IProfile1D *histo, const double valueX, const double valueY, const double weight=1.0)
	simple function to fill AIDA::IProfile1D objects More...

GAUDI_API void	fill (AIDA::IProfile2D *histo, const double valueX, const double valueY, const double valueZ, const double weight=1.0)
	simple function to fill AIDA::IProfile2D objects More...

GAUDI_API std::string	htitle (const AIDA::IBaseHistogram *histo, const std::string &title="")
	get the title More...

GAUDI_API std::string	htitle (const AIDA::IHistogram *histo, const std::string &title="")
	get the title More...

GAUDI_API std::string	htitle (const AIDA::IHistogram1D *histo, const std::string &title="")
	get the title More...

GAUDI_API std::string	htitle (const AIDA::IHistogram2D *histo, const std::string &title="")
	get the title More...

GAUDI_API std::string	htitle (const AIDA::IHistogram3D *histo, const std::string &title="")
	get the title More...

GAUDI_API std::string	htitle (const AIDA::IProfile *histo, const std::string &title="")
	get the title More...

GAUDI_API std::string	htitle (const AIDA::IProfile1D *histo, const std::string &title="")
	get the title More...

GAUDI_API std::string	htitle (const AIDA::IProfile2D *histo, const std::string &title="")
	get the title More...

GAUDI_API AIDA::IBaseHistogram *	toBase (AIDA::IHistogram1D *histo)

GAUDI_API AIDA::IBaseHistogram *	toBase (AIDA::IHistogram2D *histo)

GAUDI_API AIDA::IBaseHistogram *	toBase (AIDA::IHistogram3D *histo)

GAUDI_API AIDA::IBaseHistogram *	toBase (AIDA::IProfile1D *histo)

GAUDI_API AIDA::IBaseHistogram *	toBase (AIDA::IProfile2D *histo)

GAUDI_API std::ostream &	histoDump_ (const AIDA::IHistogram1D *histo, std::ostream &stream, const std::size_t width=80, const std::size_t height=50, const bool errors=false)
	dump the text representation of the histogram More...

GAUDI_API std::string	histoDump (const AIDA::IHistogram1D *histo, const std::size_t width=80, const std::size_t height=50, const bool errors=false)
	dump the text representation of the histogram More...

GAUDI_API std::ostream &	histoDump_ (const AIDA::IProfile1D *histo, std::ostream &stream, const std::size_t width=80, const std::size_t height=50, const bool spread=true)
	dump the text representation of 1D-profile More...

GAUDI_API std::string	histoDump (const AIDA::IProfile1D *histo, const std::size_t width=80, const std::size_t height=50, const bool spread=true)
	dump the text representation of the 1D-profile More...

GAUDI_API std::ostream &	histoDump_ (const TProfile *histo, std::ostream &stream, const std::size_t width=80, const std::size_t height=50)
	dump the text representation of the Profile More...

GAUDI_API std::string	histoDump (const TProfile *histo, const std::size_t width=80, const std::size_t height=50)
	dump the text representation of the histogram More...

GAUDI_API std::ostream &	histoDump_ (const TH1 *histo, std::ostream &stream, const std::size_t width=80, const std::size_t height=50, const bool errors=false)
	dump the text representation of the histogram More...

GAUDI_API std::string	histoDump (const TH1 *histo, const std::size_t width=80, const std::size_t height=50, const bool errors=false)
	dump the text representation of the histogram More...

GAUDI_API bool	setBinLabels (AIDA::IHistogram1D *hist, const Labels &labels)
	Set the Bin labels for a given 1D histogram. More...

GAUDI_API bool	setBinLabels (AIDA::IHistogram1D *hist, const BinLabels &labels)
	Set the Bin labels for a given 1D histogram. More...

GAUDI_API bool	setBinLabels (AIDA::IProfile1D *hist, const Labels &labels)
	Set the Bin labels for a given 1D profile histogram. More...

GAUDI_API bool	setBinLabels (AIDA::IProfile1D *hist, const BinLabels &labels)
	Set the Bin labels for a given 1D profile histogram. More...

GAUDI_API bool	setBinLabels (AIDA::IHistogram2D *hist, const Labels &xlabels, const Labels &ylabels)
	Set the Bin labels for a given 2D histogram. More...

GAUDI_API bool	setBinLabels (AIDA::IHistogram2D *hist, const BinLabels &xlabels, const BinLabels &ylabels)
	Set the Bin labels for a given 2D histogram. More...

GAUDI_API bool	setBinLabels (AIDA::IProfile2D *hist, const Labels &xlabels, const Labels &ylabels)
	Set the Bin labels for a given 2D profile histogram. More...

GAUDI_API bool	setBinLabels (AIDA::IProfile2D *hist, const BinLabels &xlabels, const BinLabels &ylabels)
	Set the Bin labels for a given 2D profile histogram. More...

GAUDI_API bool	setAxisLabels (AIDA::IHistogram1D *hist, const std::string &xAxis, const std::string &yAxis)
	Set the axis labels for the given 1D histogram. More...

GAUDI_API bool	setAxisLabels (AIDA::IProfile1D *hist, const std::string &xAxis, const std::string &yAxis)
	Set the axis labels for the given 1D profile histogram. More...

GAUDI_API bool	setAxisLabels (AIDA::IHistogram2D *hist, const std::string &xAxis, const std::string &yAxis)
	Set the axis labels for the given 2D histogram. More...

GAUDI_API bool	setAxisLabels (AIDA::IProfile2D *hist, const std::string &xAxis, const std::string &yAxis)
	Set the axis labels for the given 2D profile histogram. More...

GAUDI_API std::string	path (const AIDA::IBaseHistogram *aida)
	get the path in THS for AIDA histogram More...

GAUDI_API std::string	format (const AIDA::IHistogram1D *histo, const std::string &fmt)
	Make the string representation of the historgam according to the specified format. More...

GAUDI_API std::string	format (const AIDA::IHistogram1D *histo, const std::string &ID, const std::string &fmt1, const std::string &fmt2)
	format a full row in table, including ID, label, path or any other "extra" identifier in string form More...

template<class HISTO , class STREAM , class TERMINATOR >
STREAM &	printList (HISTO first, HISTO last, const std::string &fmt, STREAM &stream, TERMINATOR term)
	print the simple sequence (list-like) of histograms as table More...

template<class LIST , class STREAM , class TERMINATOR >
STREAM &	printList (const LIST &histos, const std::string &fmt, STREAM &stream, TERMINATOR term)
	print the simple container of histograms as table More...

template<class HISTO , class STREAM , class TERMINATOR >
STREAM &	printMap (HISTO begin, HISTO end, const std::string &fmt1, const std::string &fmt2, STREAM &stream, TERMINATOR term)
	Print the "associative sequence" (e.g. More...

template<class MAP , class STREAM , class TERMINATOR >
STREAM &	printMap (const MAP &histos, const std::string &fmt1, const std::string &fmt2, STREAM &stream, TERMINATOR term)
	Print the "associative sequence" (e.g. More...

GAUDI_API std::string	format (const std::string &val1, const std::string &val2, const std::string &fmt)
	helper method to merge the headers for short format table More...

GAUDI_API std::ostream &	toXml (const TH1D &histo, std::ostream &stream)
	stream the ROOT histogram into output stream as XML More...

GAUDI_API std::ostream &	toXml (const TH2D &histo, std::ostream &stream)
	stream the ROOT histogram into output stream as XML More...

GAUDI_API std::ostream &	toXml (const TH3D &histo, std::ostream &stream)
	stream the ROOT histogram into output stream as XML More...

GAUDI_API std::ostream &	toXml (const TProfile &histo, std::ostream &stream)
	stream the ROOT histogram into output stream as XML More...

GAUDI_API std::ostream &	toXml (const TProfile2D &histo, std::ostream &stream)
	stream the ROOT histogram into output stream as XML More...

GAUDI_API std::ostream &	toXml (const AIDA::IHistogram1D &histo, std::ostream &stream)
	stream the AIDA histogram into the output stream as XML More...

GAUDI_API std::ostream &	toXml (const AIDA::IHistogram2D &histo, std::ostream &stream)
	stream the AIDA histogram into the output stream as XML More...

GAUDI_API std::ostream &	toXml (const AIDA::IHistogram3D &histo, std::ostream &stream)
	stream the AIDA histogram into the output stream as XML More...

GAUDI_API std::ostream &	toXml (const AIDA::IProfile1D &histo, std::ostream &stream)
	stream the AIDA histogram into the output stream as XML More...

GAUDI_API std::ostream &	toXml (const TH1F &histo, std::ostream &stream)
	stream the ROOT histogram into output stream as XML More...

GAUDI_API std::ostream &	toXml (const TH2F &histo, std::ostream &stream)
	stream the ROOT histogram into output stream as XML More...

GAUDI_API std::ostream &	toXml (const TH3F &histo, std::ostream &stream)
	stream the ROOT histogram into output stream as XML More...

GAUDI_API std::ostream &	toXml (const AIDA::IProfile2D &histo, std::ostream &stream)
	stream the AIDA histogram into the output stream as XML More...

GAUDI_API StatusCode	fromXml (TH1D &result, const std::string &input)
	parse the histogram from standard ROOT XML More...

GAUDI_API StatusCode	fromXml (TH2D &result, const std::string &input)
	parse the histogram from standard ROOT XML More...

GAUDI_API StatusCode	fromXml (TH3D &result, const std::string &input)
	parse the histogram from standard ROOT XML More...

GAUDI_API StatusCode	fromXml (TProfile &result, const std::string &input)
	parse the histogram from standard ROOT XML More...

GAUDI_API StatusCode	fromXml (TProfile2D &result, const std::string &input)
	parse the histogram from standard ROOT XML More...

GAUDI_API StatusCode	fromXml (TH1F &result, const std::string &input)
	parse the histogram from standard ROOT XML More...

GAUDI_API StatusCode	fromXml (TH2F &result, const std::string &input)
	parse the histogram from standard ROOT XML More...

GAUDI_API StatusCode	fromXml (TH3F &result, const std::string &input)
	parse the histogram from standard ROOT XML More...

GAUDI_API StatusCode	fromXml (TH1D *&result, const std::string &input)
	parse the histogram from standard ROOT XML More...

GAUDI_API StatusCode	fromXml (TH2D *&result, const std::string &input)
	parse the histogram from standard ROOT XML More...

GAUDI_API StatusCode	fromXml (TH3D *&result, const std::string &input)
	parse the histogram from standard ROOT XML More...

GAUDI_API StatusCode	fromXml (TProfile *&result, const std::string &input)
	parse the histogram from standard ROOT XML More...

GAUDI_API StatusCode	fromXml (TProfile2D *&result, const std::string &input)
	parse the histogram from standard ROOT XML More...

GAUDI_API StatusCode	fromXml (AIDA::IHistogram1D &result, const std::string &input)
	parse the histogram from standard ROOT XML More...

GAUDI_API StatusCode	fromXml (AIDA::IHistogram2D &result, const std::string &input)
	parse the histogram from standard ROOT XML More...

GAUDI_API StatusCode	fromXml (AIDA::IHistogram3D &result, const std::string &input)
	parse the histogram from standard ROOT XML More...

GAUDI_API StatusCode	fromXml (AIDA::IProfile1D &result, const std::string &input)
	parse the histogram from standard ROOT XML More...

GAUDI_API StatusCode	fromXml (AIDA::IProfile2D &result, const std::string &input)
	parse the histogram from standard ROOT XML More...

Detailed Description

Collection of useful utilities for manipulations with AIDA hisgograms.

Author: Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date: 2007-08-08

Typedef Documentation

typedef std::pair<unsigned,std::string> Gaudi::Utils::Histos::BinLabel

Typedef for a bin number and its associated label.

Definition at line 29 of file HistoLabels.h.

typedef std::vector<BinLabel> Gaudi::Utils::Histos::BinLabels

Typedef for a list of bin numbers and their associated label.

Definition at line 31 of file HistoLabels.h.

typedef std::vector<std::string> Gaudi::Utils::Histos::Labels

Typedef for a list of labels.

Definition at line 27 of file HistoLabels.h.

Function Documentation

void Gaudi::Utils::Histos::fill	(	AIDA::IHistogram1D *	histo,
		const double	value,
		const double	weight = `1.0`
	)

simple function to fill AIDA::IHistogram1D objects

See also: AIDA::IHistogram1D

Parameters

histo	pointer to the histogram
value	value to be added to the histogram
weight	the "weight" assciated with this entry

Author: Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date: 2007-10-02

Definition at line 36 of file Fill.cpp.

 {
   if ( histo ) { histo->fill ( value , weight ) ; }
 }

void Gaudi::Utils::Histos::fill	(	AIDA::IHistogram2D *	histo,
		const double	valueX,
		const double	valueY,
		const double	weight = `1.0`
	)

simple function to fill AIDA::IHistogram2D objects

See also: AIDA::IHistogram2D

Parameters

histo	pointer to the histogram
valueX	value to be added to the histogram
valueY	value to be added to the histogram
weight	the "weight" assciated with this entry

Author: Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date: 2007-10-02

Definition at line 54 of file Fill.cpp.

 {
   if ( histo ) { histo -> fill ( valueX , valueY , weight ) ; }
 }

void Gaudi::Utils::Histos::fill	(	AIDA::IHistogram3D *	histo,
		const double	valueX,
		const double	valueY,
		const double	valueZ,
		const double	weight = `1.0`
	)

simple function to fill AIDA::IHistogram3D objects

See also: AIDA::IHistogram3D

Parameters

histo	pointer to the histogram
valueX	value to be added to the histogram
valueY	value to be added to the histogram
valueZ	value to be added to the histogram
weight	the "weight" assciated with this entry

Author: Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date: 2007-10-02

Definition at line 74 of file Fill.cpp.

 {
   if ( histo ) { histo -> fill ( valueX , valueY , valueZ , weight ) ; }
 }

void Gaudi::Utils::Histos::fill	(	AIDA::IProfile1D *	histo,
		const double	valueX,
		const double	valueY,
		const double	weight = `1.0`
	)

simple function to fill AIDA::IProfile1D objects

See also: AIDA::IProfile1D

Parameters

histo	pointer to the histogram
valueX	value to be added to the histogram
valueY	value to be added to the histogram
weight	the "weight" assciated with this entry

Author: Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date: 2007-10-02

Definition at line 94 of file Fill.cpp.

 {
   if ( histo ) { histo -> fill ( valueX , valueY , weight ) ; }
 }

void Gaudi::Utils::Histos::fill	(	AIDA::IProfile2D *	histo,
		const double	valueX,
		const double	valueY,
		const double	valueZ,
		const double	weight = `1.0`
	)

simple function to fill AIDA::IProfile2D objects

See also: AIDA::IProfile2D

Parameters

histo	pointer to the histogram
valueX	value to be added to the histogram
valueY	value to be added to the histogram
valueZ	value to be added to the histogram
weight	the "weight" assciated with this entry

Author: Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date: 2007-10-02

Definition at line 114 of file Fill.cpp.

 {
   if ( histo ) { histo -> fill ( valueX , valueY , valueZ , weight ) ; }
 }

std::string Gaudi::Utils::Histos::format	(	const AIDA::IHistogram1D *	histo,
		const std::string &	fmt
	)

Make the string representation of the historgam according to the specified format.

The method could be used to access/print various quantities

using namespace Gaudi::Utils::Histos ;
const AIDA::IHistogram1D* histo = ... ;
// print title in a free format:
std::cout << format   ( histo , "%2%" ) << std::endl ;
// print the path in HTS in a free format:
std::cout << format   ( histo , " path in HTS: %1% " ) << std::endl ;
// print the formatted nEntries/Overflow/Underflow:
std::cout <<
   format   ( histo , " #nEntries/Overflow/Underflow=%3%/%4%/%5%" )
          << std::endl ;
// print the formatted Mean+-ErrorMean:
std::cout <<
   format   ( histo , " Mean+-Error=(%8%+-%9%)" )
          << std::endl ;
// print the skewness and kurtosis:
std::cout <<
   format   ( histo , " Skewness/Kurtosis=%12%/%14% " )
          << std::endl ;

Parameters

histo	reference to the histogram
fmt	the printout format

Author: Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date: 2007-08-08

Definition at line 209 of file HistoTableFormat.cpp.

 {
   if ( 0 == histo ) { return "<NULL>" ; }
   using namespace Gaudi::Utils ;
   using namespace boost::io ;
   boost::format _fmt ( fmt ) ;
   // allow various number of arguments
   _fmt.exceptions ( all_error_bits ^ ( too_many_args_bit | too_few_args_bit ) ) ;
 
   _fmt
     % ( "\"" + path ( histo )    + "\"" )   //  1) histogram path
     % ( "\"" + histo -> title () + "\"" )   //  2) title
     % histo -> allEntries            ()     //  3) # entries
     % histo -> binEntries ( AIDA::IAxis::UNDERFLOW_BIN ) // 4) # underflow
     % histo -> binEntries ( AIDA::IAxis::OVERFLOW_BIN  ) // 5) # overflow
     % histo -> equivalentBinEntries  ()     //  6) equivalent entries
     % histo -> sumBinHeights         ()     //  7) integral
     % histo -> mean                  ()     //  8) mean value
     % HistoStats:: meanErr    ( histo )     //  9) error in mean
     % histo -> rms                   ()     // 10) rms
     % HistoStats::rmsErr      ( histo )     // 11) error in rms
     % HistoStats::skewness    ( histo )     // 12) skewness
     % HistoStats::skewnessErr ( histo )     // 13) error in skewness
     % HistoStats::kurtosis    ( histo )     // 14) kurtosis
     % HistoStats::kurtosisErr ( histo )     // 15) error in kurtosis
     //
     % histo -> sumAllBinHeights      ()     // 16) full integral (in and out range)
     % HistoStats::sumAllBinHeightErr ( histo ) // 17) error on 16
     % HistoStats::sumBinHeightErr    ( histo ) // 18) error on  7
     //
     % ( 100 * HistoStats::underflowEntriesFrac     ( histo ) ) // 19) fraction of underflow entries
     % ( 100 * HistoStats::underflowEntriesFracErr  ( histo ) ) // 20) error on 19
     % ( 100 * HistoStats::overflowEntriesFrac      ( histo ) ) // 21) fraction of overflow entries
     % ( 100 * HistoStats::overflowEntriesFracErr   ( histo ) ) // 22) error on 21
     //
     % HistoStats::underflowIntegralFrac    ( histo ) // 23) fraction of underflow integral
     % HistoStats::underflowIntegralFracErr ( histo ) // 24) error on 23
     % HistoStats::overflowIntegralFrac     ( histo ) // 25) fraction of overflow intergal
     % HistoStats::overflowIntegralFracErr  ( histo ) ; // 26) error on 25
   //
   return _fmt.str() ;
 }

std::string Gaudi::Utils::Histos::format	(	const AIDA::IHistogram1D *	histo,
		const std::string &	ID,
		const std::string &	fmt1,
		const std::string &	fmt2
	)

format a full row in table, including ID, label, path or any other "extra" identifier in string form

using namespace Gaudi::Utils::Histos
const AIDA::IHistogram1D* histo = ... ;
// define short format
const std::string fmt1 = " |%1$-30.30s %|33t| %2" ;
// define format for the histogram
const std::string fmt2 = ... ;
info () <<
      format   ( "My Histo" , histo , fmt1 , fmt2 )
        << endmsg ;

Parameters

histo	pointer to the histogram
ID	historgam ID, title, label or other extra information
fmt1	"short" format used for the table
fmt2	format used for the histogram printout

Returns: formatted row

Author: Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date: 2007-08-08

Definition at line 258 of file HistoTableFormat.cpp.

 {
   using namespace boost::io ;
   boost::format _fmt ( fmt1 ) ;
   // allow various number of arguments
   _fmt.exceptions ( all_error_bits ^ ( too_many_args_bit | too_few_args_bit ) ) ;
   //
   _fmt
     % ID                         // format ID
     % format ( histo , fmt2 )  ; // format the histogram
   //
   return _fmt.str() ;
 }

std::string Gaudi::Utils::Histos::format	(	const std::string &	val1,
		const std::string &	val2,
		const std::string &	fmt
	)

helper method to merge the headers for short format table

Author: Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date: 2007-08-07

Definition at line 278 of file HistoTableFormat.cpp.

 {
   using namespace boost::io ;
   boost::format _fmt ( fmt ) ;
   // allow various number of arguments
   _fmt.exceptions ( all_error_bits ^ ( too_many_args_bit | too_few_args_bit ) ) ;
   //
   _fmt
     % val1   // format ID
     % val2 ; // format the histogram
   //
   return _fmt.str() ;
 }

StatusCode Gaudi::Utils::Histos::fromXml	(	TH1D &	result,
		const std::string &	input
	)

parse the histogram from standard ROOT XML

See also: TBufferXML; TBufferXML::ConvertFromXML

Parameters

result	(OUTPUT) the parsed histogram
input	(INPUT) the input XML string

Returns: status code

Definition at line 229 of file HistoXML.cpp.

 {
   //
   result.Reset() ;                                 // RESET old histogram
   //
   
   auto histo = _Xml<TH1D>( input ) ;
   if ( !histo ) { return StatusCode::FAILURE ; }        // RETURN
   //
   histo->Copy ( result ) ;
   //
   return StatusCode::SUCCESS ;
 }

StatusCode Gaudi::Utils::Histos::fromXml	(	TH2D &	result,
		const std::string &	input
	)

parse the histogram from standard ROOT XML

See also: TBufferXML; TBufferXML::ConvertFromXML

Parameters

result	(OUTPUT) the parsed histogram
input	(INPUT) the input XML string

Returns: status code

Definition at line 250 of file HistoXML.cpp.

 {
   //
   result.Reset() ;                                 // RESET old histogram
   //
   auto histo = _Xml<TH2D>( input ) ;
   if ( !histo ) { return StatusCode::FAILURE ; }        // RETURN
   //
   histo->Copy ( result ) ;
   //
   return StatusCode::SUCCESS ;
 }

StatusCode Gaudi::Utils::Histos::fromXml	(	TH3D &	result,
		const std::string &	input
	)

parse the histogram from standard ROOT XML

See also: TBufferXML; TBufferXML::ConvertFromXML

Parameters

result	(OUTPUT) the parsed histogram
input	(INPUT) the input XML string

Returns: status code

Definition at line 270 of file HistoXML.cpp.

 {
   //
   result.Reset() ;                                 // RESET old histogram
   //
   auto histo = _Xml<TH3D>( input ) ;
   if ( !histo ) { return StatusCode::FAILURE ; }        // RETURN
   //
   histo->Copy ( result ) ;
   //
   return StatusCode::SUCCESS ;
 }

StatusCode Gaudi::Utils::Histos::fromXml	(	TProfile &	result,
		const std::string &	input
	)

parse the histogram from standard ROOT XML

See also: TBufferXML; TBufferXML::ConvertFromXML

Parameters

result	(OUTPUT) the parsed histogram
input	(INPUT) the input XML string

Returns: status code

Definition at line 350 of file HistoXML.cpp.

 {
   //
   result.Reset() ;                                 // RESET old histogram
   //
   auto histo = _Xml<TProfile>( input ) ;
   if ( !histo ) { return StatusCode::FAILURE ; }        // RETURN
   //
   histo->Copy ( result ) ;
   //
   return StatusCode::SUCCESS ;
 }

StatusCode Gaudi::Utils::Histos::fromXml	(	TProfile2D &	result,
		const std::string &	input
	)

parse the histogram from standard ROOT XML

See also: TBufferXML; TBufferXML::ConvertFromXML

Parameters

result	(OUTPUT) the parsed histogram
input	(INPUT) the input XML string

Returns: status code

Definition at line 370 of file HistoXML.cpp.

 {
   //
   result.Reset() ;                                 // RESET old histogram
   //
   auto histo = _Xml<TProfile2D>( input ) ;
   if ( !histo ) { return StatusCode::FAILURE ; }        // RETURN
   //
   histo->Copy ( result ) ;
   //
   return StatusCode::SUCCESS ;
 }

StatusCode Gaudi::Utils::Histos::fromXml	(	TH1F &	result,
		const std::string &	input
	)

parse the histogram from standard ROOT XML

See also: TBufferXML; TBufferXML::ConvertFromXML

Parameters

result	(OUTPUT) the parsed histogram
input	(INPUT) the input XML string

Returns: status code

Definition at line 290 of file HistoXML.cpp.

 {
   //
   result.Reset() ;                                 // RESET old histogram
   //
   auto histo =  _Xml<TH1F>( input ) ;
   if ( !histo ) { return StatusCode::FAILURE ; }        // RETURN
   //
   histo->Copy ( result ) ;
   //
   return StatusCode::SUCCESS ;
 }

StatusCode Gaudi::Utils::Histos::fromXml	(	TH2F &	result,
		const std::string &	input
	)

parse the histogram from standard ROOT XML

See also: TBufferXML; TBufferXML::ConvertFromXML

Parameters

result	(OUTPUT) the parsed histogram
input	(INPUT) the input XML string

Returns: status code

Definition at line 310 of file HistoXML.cpp.

 {
   //
   result.Reset() ;                                 // RESET old histogram
   //
   auto histo = _Xml<TH2F>( input ) ;
   if ( !histo ) { return StatusCode::FAILURE ; }        // RETURN
   //
   histo->Copy ( result ) ;
   //
   return StatusCode::SUCCESS ;
 }

StatusCode Gaudi::Utils::Histos::fromXml	(	TH3F &	result,
		const std::string &	input
	)

parse the histogram from standard ROOT XML

See also: TBufferXML; TBufferXML::ConvertFromXML

Parameters

result	(OUTPUT) the parsed histogram
input	(INPUT) the input XML string

Returns: status code

Definition at line 330 of file HistoXML.cpp.

 {
   //
   result.Reset() ;                                 // RESET old histogram
   //
   auto histo =_Xml<TH3F>( input ) ;
   if ( !histo ) { return StatusCode::FAILURE ; }        // RETURN
   //
   histo->Copy ( result ) ;
   //
   return StatusCode::SUCCESS ;
 }

StatusCode Gaudi::Utils::Histos::fromXml	(	TH1D *&	result,
		const std::string &	input
	)

parse the histogram from standard ROOT XML

See also: TBufferXML; TBufferXML::ConvertFromXML

Parameters

result	(OUTPUT) the parsed histogram
input	(INPUT) the input XML string

Returns: status code

Definition at line 392 of file HistoXML.cpp.

 {
   if ( result ) { return fromXml ( *result , input ) ; }
   //
   auto histo = _Xml<TH1D>( input ) ;
   if ( !histo ) { return StatusCode::FAILURE ; }       // RETURN
   //
   result = histo.release() ;                                     // ASSIGN
   //
   return StatusCode::SUCCESS ;
 }

StatusCode Gaudi::Utils::Histos::fromXml	(	TH2D *&	result,
		const std::string &	input
	)

parse the histogram from standard ROOT XML

See also: TBufferXML; TBufferXML::ConvertFromXML

Parameters

result	(OUTPUT) the parsed histogram
input	(INPUT) the input XML string

Returns: status code

Definition at line 411 of file HistoXML.cpp.

 {
   if ( result ) { return fromXml ( *result , input ) ; }
   //
   auto histo = _Xml<TH2D>( input ) ;
   if ( !histo ) { return StatusCode::FAILURE ; }       // RETURN
   //
   result = histo.release() ;                                     // ASSIGN
   //
   return StatusCode::SUCCESS ;
 }

StatusCode Gaudi::Utils::Histos::fromXml	(	TH3D *&	result,
		const std::string &	input
	)

parse the histogram from standard ROOT XML

See also: TBufferXML; TBufferXML::ConvertFromXML

Parameters

result	(OUTPUT) the parsed histogram
input	(INPUT) the input XML string

Returns: status code

Definition at line 430 of file HistoXML.cpp.

 {
   if ( result ) { return fromXml ( *result , input ) ; }
   //
   auto histo = _Xml<TH3D>( input ) ;
   if ( !histo ) { return StatusCode::FAILURE ; }       // RETURN
   //
   result = histo.release() ;                                     // ASSIGN
   //
   return StatusCode::SUCCESS ;
 }

StatusCode Gaudi::Utils::Histos::fromXml	(	TProfile *&	result,
		const std::string &	input
	)

parse the histogram from standard ROOT XML

See also: TBufferXML; TBufferXML::ConvertFromXML

Parameters

result	(OUTPUT) the parsed histogram
input	(INPUT) the input XML string

Returns: status code

Definition at line 450 of file HistoXML.cpp.

 {
   if ( result ) { return fromXml ( *result , input ) ; }
   //
   auto histo = _Xml<TProfile>( input ) ;
   if ( !histo ) { return StatusCode::FAILURE ; }       // RETURN
   //
   result = histo.release() ;                                     // ASSIGN
   //
   return StatusCode::SUCCESS ;
 }

StatusCode Gaudi::Utils::Histos::fromXml	(	TProfile2D *&	result,
		const std::string &	input
	)

parse the histogram from standard ROOT XML

See also: TBufferXML; TBufferXML::ConvertFromXML

Parameters

result	(OUTPUT) the parsed histogram
input	(INPUT) the input XML string

Returns: status code

Definition at line 469 of file HistoXML.cpp.

 {
   if ( result ) { return fromXml ( *result , input ) ; }
   //
   auto histo = _Xml<TProfile2D>( input ) ;
   if ( !histo ) { return StatusCode::FAILURE ; }       // RETURN
   //
   result = histo.release() ;                                     // ASSIGN
   //
   return StatusCode::SUCCESS ;
 }

StatusCode Gaudi::Utils::Histos::fromXml	(	AIDA::IHistogram1D &	result,
		const std::string &	input
	)

parse the histogram from standard ROOT XML

See also: TBufferXML; TBufferXML::ConvertFromXML

Parameters

result	(OUTPUT) the parsed histogram
input	(INPUT) the input XML string

Returns: status code

Definition at line 488 of file HistoXML.cpp.

 {
   auto root = Gaudi::Utils::Aida2ROOT::aida2root ( &result ) ;
   return root ? fromXml ( *root , input ) : StatusCode::FAILURE ; // RETURN
 }

StatusCode Gaudi::Utils::Histos::fromXml	(	AIDA::IHistogram2D &	result,
		const std::string &	input
	)

parse the histogram from standard ROOT XML

See also: TBufferXML; TBufferXML::ConvertFromXML

Parameters

result	(OUTPUT) the parsed histogram
input	(INPUT) the input XML string

Returns: status code

Definition at line 501 of file HistoXML.cpp.

 {
   auto root = Gaudi::Utils::Aida2ROOT::aida2root ( &result ) ;
   return root ? fromXml ( *root , input ) : StatusCode::FAILURE; // RETURN
 }

StatusCode Gaudi::Utils::Histos::fromXml	(	AIDA::IHistogram3D &	result,
		const std::string &	input
	)

parse the histogram from standard ROOT XML

See also: TBufferXML; TBufferXML::ConvertFromXML

Parameters

result	(OUTPUT) the parsed histogram
input	(INPUT) the input XML string

Returns: status code

Definition at line 514 of file HistoXML.cpp.

 {
   auto root = Gaudi::Utils::Aida2ROOT::aida2root ( &result ) ;
   return root ? fromXml ( *root , input ) : StatusCode::FAILURE; // RETURN
 }

StatusCode Gaudi::Utils::Histos::fromXml	(	AIDA::IProfile1D &	result,
		const std::string &	input
	)

parse the histogram from standard ROOT XML

See also: TBufferXML; TBufferXML::ConvertFromXML

Parameters

result	(OUTPUT) the parsed histogram
input	(INPUT) the input XML string

Returns: status code

Definition at line 527 of file HistoXML.cpp.

 {
   auto root = Gaudi::Utils::Aida2ROOT::aida2root ( &result ) ;
   return root ? fromXml ( *root , input ) : StatusCode::FAILURE; // RETURN
 }

StatusCode Gaudi::Utils::Histos::fromXml	(	AIDA::IProfile2D &	result,
		const std::string &	input
	)

parse the histogram from standard ROOT XML

See also: TBufferXML; TBufferXML::ConvertFromXML

Parameters

result	(OUTPUT) the parsed histogram
input	(INPUT) the input XML string

Returns: status code

Definition at line 540 of file HistoXML.cpp.

 {
   auto root = Gaudi::Utils::Aida2ROOT::aida2root ( &result ) ;
   return root ? fromXml ( *root , input ) : StatusCode::FAILURE; // RETURN
 }

std::string Gaudi::Utils::Histos::histoDump	(	const AIDA::IHistogram1D *	histo,
		const std::size_t	width = `80`,
		const std::size_t	height = `50`,
		const bool	errors = `false`
	)

dump the text representation of the histogram

Parameters

histo	(INPUT) the histogram
width	(INPUT) the maximal column width
height	(INPUT) the proposed column height
erorrs	(INPUT) print/plot errors

Returns: string representation of the histogram

Author: Vanya BELYAEV Ivan..nosp@m.BEly.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date: 2009-09-19

Definition at line 699 of file HistoDump.cpp.

 {
   std::ostringstream stream ;
   histoDump_ ( histo , stream , width , height , errors );
   return stream.str() ;
 }

std::string Gaudi::Utils::Histos::histoDump	(	const AIDA::IProfile1D *	histo,
		const std::size_t	width = `80`,
		const std::size_t	height = `50`,
		const bool	spread = `true`
	)

dump the text representation of the 1D-profile

Parameters

histo	(INPUT) the histogram
width	(INPUT) the maximal column width
height	(INPUT) the proposed column height
spread	(INPUT) print/plto spread vs rms

Returns: string representation of the histogram

Author: Vanya BELYAEV Ivan..nosp@m.BEly.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date: 2009-09-19

Definition at line 796 of file HistoDump.cpp.

 {
   std::ostringstream stream ;
   histoDump_ ( histo , stream , width , height , spread );
   return stream.str() ;
 }

std::string Gaudi::Utils::Histos::histoDump	(	const TProfile *	histo,
		const std::size_t	width = `80`,
		const std::size_t	height = `50`
	)

dump the text representation of the histogram

Parameters

histo	(INPUT) the histogram
width	(INPUT) the maximal column width
height	(INPUT) the propsoed coulmn height
erorrs	(INPUT) print/plot errors

Returns: string representation of the histogram

Author: Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date: 2009-09-19

Definition at line 965 of file HistoDump.cpp.

 {
   std::ostringstream stream ;
   histoDump_ ( histo , stream , width , height );
   return stream.str() ;
 }

std::string Gaudi::Utils::Histos::histoDump	(	const TH1 *	histo,
		const std::size_t	width = `80`,
		const std::size_t	height = `50`,
		const bool	errors = `false`
	)

dump the text representation of the histogram

Parameters

histo	(INPUT) the histogram
width	(INPUT) the maximal column width
height	(INPUT) the propsoed coulmn height
erorrs	(INPUT) print/plot errors

Returns: string representation of the histogram

Author: Vanya BELYAEV Ivan..nosp@m.Bely.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date: 2009-09-19

Definition at line 945 of file HistoDump.cpp.

 {
   std::ostringstream stream ;
   histoDump_ ( histo , stream , width , height , errors );
   return stream.str() ;
 }

std::ostream & Gaudi::Utils::Histos::histoDump_	(	const AIDA::IHistogram1D *	histo,
		std::ostream &	stream,
		const std::size_t	width = `80`,
		const std::size_t	height = `50`,
		const bool	errors = `false`
	)

dump the text representation of the histogram

Parameters

histo	(INPUT) the histogram
stream	(OUTUT) the stream
width	(INPUT) the maximal column width
height	(INPUT) the proposed column height
errors	(INPUT) print/plot errors

Returns: the stream

Author: Vanya BELYAEV Ivan..nosp@m.BEly.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date: 2009-09-19

Definition at line 610 of file HistoDump.cpp.

 {
   stream << std::endl ;
   if ( !histo     ) { return stream ; }  // RETURN
   Histo hist ;
   StatusCode sc = _getHisto ( histo , hist ) ;
   if ( sc.isFailure() ) { return stream ; }  // RETURN
   //
   stream
     << boost::format ( " Histo TES   : \"%s\"") % path ( histo )
     << std::endl
     << boost::format ( " Histo Title : \"%s\"") % histo->title()
     << std::endl
     << std::endl ;
   //
   stream
     << boost::format ( " Mean        : %11.5g +- %-10.4g ")
     % Gaudi::Utils::HistoStats::mean        ( histo )
     % Gaudi::Utils::HistoStats::meanErr     ( histo )
     << std::endl
     << boost::format ( " Rms         : %11.5g +- %-10.4g ")
     % Gaudi::Utils::HistoStats::rms         ( histo )
     % Gaudi::Utils::HistoStats::rmsErr      ( histo )
     << std::endl
     << boost::format ( " Skewness    : %11.5g +- %-10.4g ")
     % Gaudi::Utils::HistoStats::skewness    ( histo )
     % Gaudi::Utils::HistoStats::skewnessErr ( histo )
     << std::endl
     << boost::format ( " Kurtosis    : %11.5g +- %-10.4g ")
     % Gaudi::Utils::HistoStats::kurtosis    ( histo )
     % Gaudi::Utils::HistoStats::kurtosisErr ( histo )
     << std::endl
     << std::endl ;
   //
   stream
     << boost::format ( " Entries     :\n | %=9s | %=9s | %=9s | %9s | %=11s | %=11s | %=11s |")
     % "All"
     % "In Range"
     % "Underflow"
     % "Overflow"
     % "#Equivalent"
     % "Integral"
     % "Total"
     << std::endl
     << boost::format ( " | %=9d | %=9d | %=9d | %=9d | %=11.5g | %=11.5g | %=11.5g |")
     % histo -> allEntries ()
     % histo -> entries    ()
     % histo -> binEntries ( AIDA::IAxis::UNDERFLOW_BIN )
     % histo -> binEntries ( AIDA::IAxis::OVERFLOW_BIN  )
     % histo -> equivalentBinEntries ()
     % histo -> sumBinHeights        ()
     % histo -> sumAllBinHeights     ()
     << std::endl
     << std::endl ;
   //
   const AIDA::IAnnotation& a = histo->annotation () ;
   if ( 0 != a.size() )
   {
     stream << " Annotation" << std::endl ;
     for ( int i = 0 ; i < a.size() ; ++i )
     {
       stream
         << boost::format ( " | %-25.25s : %-45.45s | ")
         % a.key   ( i )
         % a.value ( i )
         << std::endl ;
     }
     stream << std::endl ;
   }
   //
   return dumpText ( hist , width , height , errors , stream ) ;
 }

std::ostream & Gaudi::Utils::Histos::histoDump_	(	const AIDA::IProfile1D *	histo,
		std::ostream &	stream,
		const std::size_t	width = `80`,
		const std::size_t	height = `50`,
		const bool	spread = `true`
	)

dump the text representation of 1D-profile

Parameters

histo	(INPUT) the 1D-profile
stream	(OUTUT) the stream
width	(INPUT) the maximal column width
height	(INPUT) the proposed column height
spread	(INPUT) print/plot spread/rms ?

Returns: the stream

Author: Vanya BELYAEV Ivan..nosp@m.BEly.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date: 2009-09-19

Definition at line 721 of file HistoDump.cpp.

 {
   stream << std::endl ;
   if ( !histo     ) { return stream ; }  // RETURN
   Histo hist ;
   StatusCode sc = _getHisto ( histo , hist , spread ) ;
   if ( sc.isFailure() ) { return stream ; }  // RETURN
   //
   stream
     << boost::format ( " Histo TES   : \"%s\"") % path ( histo )
     << std::endl
     << boost::format ( " Histo Title : \"%s\"") % histo->title()
     << std::endl
     << std::endl ;
   //
   stream
     << boost::format ( " Mean        : %11.5g ") % histo->mean()
     << std::endl
     << boost::format ( " Rms         : %11.5g ") % histo->rms ()
     << std::endl
     << std::endl ;
   //
   stream
     << boost::format ( " Entries     :\n | %=9s | %=9s | %=9s | %9s | %=11s | %=11s |")
     % "All"
     % "In Range"
     % "Underflow"
     % "Overflow"
     // % "#Equivalent"
     % "Integral"
     % "Total"
     << std::endl
     << boost::format ( " | %=9d | %=9d | %=9d | %=9d | %=11.5g | %=11.5g |")
     % histo -> allEntries ()
     % histo -> entries    ()
     % histo -> binEntries ( AIDA::IAxis::UNDERFLOW_BIN )
     % histo -> binEntries ( AIDA::IAxis::OVERFLOW_BIN  )
     // % histo -> equivalentBinEntries ()
     % histo -> sumBinHeights        ()
     % histo -> sumAllBinHeights     ()
     << std::endl
     << std::endl ;
   //
   const AIDA::IAnnotation& a = histo->annotation () ;
   if ( 0 != a.size() )
   {
     stream << " Annotation" << std::endl ;
     for ( int i = 0 ; i < a.size() ; ++i )
     {
       stream
         << boost::format ( " | %-25.25s : %-45.45s | ")
         % a.key   ( i )
         % a.value ( i )
         << std::endl ;
     }
     stream << std::endl ;
   }
   //
   return dumpText ( hist , width , height , true , stream ) ;
 }

std::ostream & Gaudi::Utils::Histos::histoDump_	(	const TProfile *	histo,
		std::ostream &	stream,
		const std::size_t	width = `80`,
		const std::size_t	height = `50`
	)

dump the text representation of the Profile

Parameters

histo	(INPUT) the histogram
stream	(OUTUT) the stream
width	(INPUT) the maximal column width
height	(INPUT) the proposed coulmn height
spread	(INPUT) print/plot rms versus erorr

Returns: the stream

Author: Vanya BELYAEV Ivan..nosp@m.BEly.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date: 2009-09-19

Definition at line 890 of file HistoDump.cpp.

 {
   stream << std::endl ;
   if ( ! histo     ) { return stream ; }  // RETURN
   Histo hist ;
   StatusCode sc = _getHisto ( histo , hist , true ) ;
   if ( sc.isFailure() ) { return stream ; }  // RETURN
   //
   stream
     << boost::format ( " Profile Name  : \"%s\"")
     % histo -> GetName ()
     << std::endl
     << boost::format ( " Profile Title : \"%s\"")
     % histo -> GetTitle ()
     << std::endl
     << std::endl ;
   //
   stream
     << boost::format ( " Mean          : %11.5g ") % histo -> GetMean      ()
     << std::endl
     << boost::format ( " Rms           : %11.5g ") % histo -> GetRMS      ()
     << std::endl
     << std::endl ;
   //
   stream
     << boost::format ( " Entries       :\n | %=11s | %=11s | %=11s | %=11s |")
     % "All"
     % "Underflow"
     % "Overflow"
     % "Integral"
     << std::endl
     << boost::format ( " | %=11.5g | %=11.5g | %=11.5g | %=11.5g |")
     % histo -> GetEntries ()
     % histo -> GetBinContent ( 0                       )
     % histo -> GetBinContent ( histo->GetNbinsX() + 1  )
     % histo -> Integral             ()
     << std::endl
     << std::endl ;
   //
   return dumpText ( hist , width , height , true , stream ) ;
 }

std::ostream & Gaudi::Utils::Histos::histoDump_	(	const TH1 *	histo,
		std::ostream &	stream,
		const std::size_t	width = `80`,
		const std::size_t	height = `50`,
		const bool	errors = `false`
	)

dump the text representation of the histogram

Parameters

histo	(INPUT) the histogram
stream	(OUTUT) the stream
width	(INPUT) the maximal column width
height	(INPUT) the proposed coulmn height
errors	(INPUT) print/plot errors

Returns: the stream

Author: Vanya BELYAEV Ivan..nosp@m.BEly.nosp@m.aev@n.nosp@m.ikhe.nosp@m.f.nl

Date: 2009-09-19

Definition at line 817 of file HistoDump.cpp.

 {
   const TProfile* profile = dynamic_cast<const TProfile*> ( histo ) ;
   if ( profile )
   { return histoDump_ ( profile , stream , width , height ) ; }
   //
   stream << std::endl ;
   if ( !histo     ) { return stream ; }  // RETURN
   Histo hist ;
   StatusCode sc = _getHisto ( histo , hist ) ;
   if ( sc.isFailure() ) { return stream ; }  // RETURN
   //
   stream
     << boost::format ( " Histo Name  : \"%s\"")
     % histo -> GetName ()
     << std::endl
     << boost::format ( " Histo Title : \"%s\"")
     % histo -> GetTitle ()
     << std::endl
     << std::endl ;
   //
   stream
     << boost::format ( " Mean        : %11.5g +- %-10.4g ")
     % histo -> GetMean      ()
     % histo -> GetMeanError ()
     << std::endl
     << boost::format ( " Rms         : %11.5g +- %-10.4g ")
     % histo -> GetRMS      ()
     % histo -> GetRMSError ()
     << std::endl
     << boost::format ( " Skewness    : %11.5g            ")
     % histo -> GetSkewness ()
     << std::endl
     << boost::format ( " Kurtosis    : %11.5g            ")
     % histo -> GetKurtosis ()
     << std::endl
     << std::endl ;
   //
   stream
     << boost::format ( " Entries     :\n | %=11s | %=11s | %=11s | %=11s | %=11s |")
     % "All"
     % "Underflow"
     % "Overflow"
     % "#Equivalent"
     % "Integral"
     << std::endl
     << boost::format ( " | %=11.5g | %=11.5g | %=11.5g | %=11.5g | %=11.5g |")
     % histo -> GetEntries ()
     % histo -> GetBinContent ( 0                       )
     % histo -> GetBinContent ( histo->GetNbinsX() + 1  )
     % histo -> GetEffectiveEntries  ()
     % histo -> Integral             ()
     << std::endl
     << std::endl ;
   //
   return dumpText ( hist , width , height , errors , stream ) ;
 }

std::string Gaudi::Utils::Histos::htitle	(	const AIDA::IBaseHistogram *	histo,
		const std::string &	title = `""`
	)

get the title

Definition at line 138 of file Fill.cpp.

140 { return htitle_ ( histo , title ) ; }

std::string Gaudi::Utils::Histos::htitle	(	const AIDA::IHistogram *	histo,
		const std::string &	title = `""`
	)

get the title

Definition at line 145 of file Fill.cpp.

147 { return htitle_ ( histo , title ) ; }

std::string Gaudi::Utils::Histos::htitle	(	const AIDA::IHistogram1D *	histo,
		const std::string &	title = `""`
	)

get the title

Definition at line 152 of file Fill.cpp.

154 { return htitle_ ( histo , title ) ; }

std::string Gaudi::Utils::Histos::htitle	(	const AIDA::IHistogram2D *	histo,
		const std::string &	title = `""`
	)

get the title

Definition at line 159 of file Fill.cpp.

161 { return htitle_ ( histo , title ) ; }

std::string Gaudi::Utils::Histos::htitle	(	const AIDA::IHistogram3D *	histo,
		const std::string &	title = `""`
	)

get the title

Definition at line 166 of file Fill.cpp.

168 { return htitle_ ( histo , title ) ; }

std::string Gaudi::Utils::Histos::htitle	(	const AIDA::IProfile *	histo,
		const std::string &	title = `""`
	)

get the title

Definition at line 173 of file Fill.cpp.

175 { return htitle_ ( histo , title ) ; }

std::string Gaudi::Utils::Histos::htitle	(	const AIDA::IProfile1D *	histo,
		const std::string &	title = `""`
	)

get the title

Definition at line 180 of file Fill.cpp.

182 { return htitle_ ( histo , title ) ; }

std::string Gaudi::Utils::Histos::htitle	(	const AIDA::IProfile2D *	histo,
		const std::string &	title = `""`
	)

get the title

Definition at line 187 of file Fill.cpp.

189 { return htitle_ ( histo , title ) ; }

std::string Gaudi::Utils::Histos::path ( const AIDA::IBaseHistogram * aida )

get the path in THS for AIDA histogram

Author: Vanya BELYAEV ibely.nosp@m.aev@.nosp@m.physi.nosp@m.cs.s.nosp@m.yr.ed.nosp@m.u

Date: 2007-08-08

Definition at line 191 of file HistoTableFormat.cpp.

 {
   if ( 0 == aida     ) { return "" ; }                          // RETURN
   const DataObject* object   = dynamic_cast<const DataObject*>( aida ) ;
   if ( 0 == object   ) { return "" ; }                          // RETURN
   IRegistry*        registry = object->registry() ;
   if ( 0 == registry ) { return "" ; }                          // RETURN
   std::string _path = registry->identifier() ;
   std::string::size_type n = _path.find("/stat/") ;
   if ( 0 == n ) { return std::string(_path,6) ; }               // RETURN
   return _path ;                                                // RETURN
 }

template<class HISTO , class STREAM , class TERMINATOR >

STREAM& Gaudi::Utils::Histos::printList	(	HISTO	first,
		HISTO	last,
		const std::string &	fmt,
		STREAM &	stream,
		TERMINATOR	term
	)

inline

print the simple sequence (list-like) of histograms as table

SEQUENCE histos = ... ;
// print a table with three colums  path, title and #entries
Gaudi::Utils::Histos::printList
  ( histos.begin () ,
    histos.end   () ,
    " | %1$|-40.40s | %2$-30.30s | %3$=7d | " ,
    std::cout       ,
    '\n'            ) ;

Parameters

first	begin-iterator for the sequence
last	end-iterator for the sequence
stream	the stream to be used for printout
term	the terminmator for the stream
fmt	the format to be used

Definition at line 231 of file HistoTableFormat.h.

       {
         for ( ; first != last ; ++first )
         { stream << format   ( *first , fmt ) << term ; }  // print table rows
         return stream ;                                    // RETURN
       }

template<class LIST , class STREAM , class TERMINATOR >

STREAM& Gaudi::Utils::Histos::printList	(	const LIST &	histos,
		const std::string &	fmt,
		STREAM &	stream,
		TERMINATOR	term
	)

inline

print the simple container of histograms as table

using namespace Gaudi::Utils::Histos ;
SEQUENCE histos = ... ;
// print a table with three columns:  path, title and #entries
printList
  ( histos          ,
    " | %1$|-40.40s | %2$-30.30s | %3$=7d | " ,
    std::cout       ,
    '\n'            ) ;

Parameters

histos	the sequence of histograms
stream	the stream to be used for printout
term	the terminmator for the stream
fmt	the format to be used

Definition at line 267 of file HistoTableFormat.h.

       {
         return printList
           ( histos.begin () , histos.end  () , fmt , stream , term ) ;
       }

template<class HISTO , class STREAM , class TERMINATOR >

STREAM& Gaudi::Utils::Histos::printMap	(	HISTO	begin,
		HISTO	end,
		const std::string &	fmt1,
		const std::string &	fmt2,
		STREAM &	stream,
		TERMINATOR	term
	)

inline

Print the "associative sequence" (e.g.

part of std:map) of histograms as table:

using namespace Gaudi::Utils::Histos ;
const std::map<std::string,AIDA::IHistogram1D*>& m = ... ;
printMap
 ( m.begin () ,
   m.end   () ,
   "| %1$-10.10s | %2% " , // short format
   Gaudi::Utils::Histos::Formats::histoFormatOnly ,
   always()   ,
   endmsg     ) ;

Print only mean and rms:

using namespace Gaudi::Utils::Histos ;
const std::map<GaudiAlg::ID,AIDA::IHistogram1D*>& m = ... ;
printMap
  ( m.begin () ,
    m.end   () ,
    "| %1$-10.10s | %2% "    , // short format
    " %8$10.5g+-%10$-10.5g|", // mean+-rms
    always()   ,
    endmsg     ) ;

Parameters

begin	'begin'-iterator for the mapping sequence
end	'end'-iterator for the mapping sequence
fmt1	'short' format for the table printout
fmt3	format for the printout of the histogram
stream	the stream for printout
term	stream terminator

Definition at line 322 of file HistoTableFormat.h.

       {
         for ( ; begin != end ; ++begin )
         {
           stream << format
             ( begin -> second , // the histogram
               begin -> first  , // the key
               fmt1  ,  fmt2   ) << term ;
         }
         return stream ;
       }

template<class MAP , class STREAM , class TERMINATOR >

STREAM& Gaudi::Utils::Histos::printMap	(	const MAP &	histos,
		const std::string &	fmt1,
		const std::string &	fmt2,
		STREAM &	stream,
		TERMINATOR	term
	)

inline

Print the "associative sequence" (e.g.

part of std:map) of histograms as table:

using namespace Gaudi::Utils::Histos ;
const std::map<std::string,AIDA::IHistogram1D*>& m = ... ;
printMap
 ( m          ,
   "| %1$-10.10s | %2% " , // short format
   Gaudi::Utils::Histos::Formats::histoFormatOnly ,
   always()   ,
   endmsg     ) ;

Print only mean and rms:

using namespace Gaudi::Utils::Histos ;
const std::map<GaudiAlg::ID,AIDA::IHistogram1D*>& m = ... ;
printMap
  ( m          ,
    "| %1$-10.10s | %2% "    , // short format
    " %8$10.5g+-%10$-10.5g|", // mean+-rms
    always()   ,
    endmsg     ) ;

Parameters

begin	'begin'-iterator for the mapping sequence
end	'end'-iterator for the mapping sequence
fmt1	'short' format for the table printout
fmt3	format for the printout of the histogram
stream	the stream for printout
term	stream terminator

Definition at line 383 of file HistoTableFormat.h.

       {
         return printMap
           ( histos.begin () , histos.end() , fmt1 , fmt2 , stream , term ) ;
       }

bool Gaudi::Utils::Histos::setAxisLabels	(	AIDA::IHistogram1D *	hist,
		const std::string &	xAxis,
		const std::string &	yAxis
	)

Set the axis labels for the given 1D histogram.

Parameters

hist	Pointer to the histogram
xAxis	Label for the x axis
yAxis	Label for the y axis

Returns: Boolean indicating if the labels were successfully applied or not

Return values

TRUE	Labels were applied OK
FALSE	Labels were NOT applied

Definition at line 186 of file HistoLabels.cpp.

       {
         return setAxisLabels_<TH1D>( hist, xAxis, yAxis );
       }

bool Gaudi::Utils::Histos::setAxisLabels	(	AIDA::IProfile1D *	hist,
		const std::string &	xAxis,
		const std::string &	yAxis
	)

Set the axis labels for the given 1D profile histogram.

Parameters

hist	Pointer to the histogram
xAxis	Label for the x axis
yAxis	Label for the y axis

Returns: Boolean indicating if the labels were successfully applied or not

Return values

TRUE	Labels were applied OK
FALSE	Labels were NOT applied

Definition at line 193 of file HistoLabels.cpp.

       {
         return setAxisLabels_<TProfile>( hist, xAxis, yAxis );
       }

bool Gaudi::Utils::Histos::setAxisLabels	(	AIDA::IHistogram2D *	hist,
		const std::string &	xAxis,
		const std::string &	yAxis
	)

Set the axis labels for the given 2D histogram.

Parameters

hist	Pointer to the histogram
xAxis	Label for the x axis
yAxis	Label for the y axis

Returns: Boolean indicating if the labels were successfully applied or not

Return values

TRUE	Labels were applied OK
FALSE	Labels were NOT applied

Definition at line 200 of file HistoLabels.cpp.

       {
         return setAxisLabels_<TH2D>( hist, xAxis, yAxis );
       }

bool Gaudi::Utils::Histos::setAxisLabels	(	AIDA::IProfile2D *	hist,
		const std::string &	xAxis,
		const std::string &	yAxis
	)

Set the axis labels for the given 2D profile histogram.

Parameters

hist	Pointer to the histogram
xAxis	Label for the x axis
yAxis	Label for the y axis

Returns: Boolean indicating if the labels were successfully applied or not

Return values

TRUE	Labels were applied OK
FALSE	Labels were NOT applied

Definition at line 207 of file HistoLabels.cpp.

       {
         return setAxisLabels_<TProfile2D>( hist, xAxis, yAxis );
       }

bool Gaudi::Utils::Histos::setBinLabels	(	AIDA::IHistogram1D *	hist,
		const Labels &	labels
	)

Set the Bin labels for a given 1D histogram.

The labels will be applied in the order they appear in the list, starting at the first bin. If the list of labels is too short, the later bins will be missing a label. If the list is too long, only the first N will be used, where N is the number of bins in the histogram

Parameters

hist	Pointer to the histogram
labels	The list of labels

Returns: Boolean indicating if the labels were successfully applied or not

Return values

TRUE	Labels were applied OK
FALSE	Labels were NOT applied

Definition at line 106 of file HistoLabels.cpp.

       {
         return setBinLabels_(hist,labels);
       }

bool Gaudi::Utils::Histos::setBinLabels	(	AIDA::IHistogram1D *	hist,
		const BinLabels &	labels
	)

Set the Bin labels for a given 1D histogram.

Each entry in 'labels' gives the bin number and its associated label

Parameters

hist	Pointer to the histogram
labels	The list of labels

Returns: Boolean indicating if the labels were successfully applied or not

Return values

TRUE	Labels were applied OK
FALSE	Labels were NOT applied

Definition at line 94 of file HistoLabels.cpp.

       {
         return setBinLabels_<TH1D>(hist,labels);
       }

bool Gaudi::Utils::Histos::setBinLabels	(	AIDA::IProfile1D *	hist,
		const Labels &	labels
	)

Set the Bin labels for a given 1D profile histogram.

The labels will be applied in the order they appear in the list, starting at the first bin. If the list of labels is too short, the later bins will be missing a label. If the list is too long, only the first N will be used, where N is the number of bins in the histogram

Parameters

hist	Pointer to the histogram
labels	The list of labels

Returns: Boolean indicating if the labels were successfully applied or not

Return values

TRUE	Labels were applied OK
FALSE	Labels were NOT applied

Definition at line 112 of file HistoLabels.cpp.

       {
         return setBinLabels_(hist,labels);
       }

bool Gaudi::Utils::Histos::setBinLabels	(	AIDA::IProfile1D *	hist,
		const BinLabels &	labels
	)

Set the Bin labels for a given 1D profile histogram.

Each entry in 'labels' gives the bin number and its associated label

Parameters

hist	Pointer to the histogram
labels	The list of bin numbers and the associated label

Returns: Boolean indicating if the labels were successfully applied or not

Return values

TRUE	Labels were applied OK
FALSE	Labels were NOT applied

Definition at line 100 of file HistoLabels.cpp.

       {
         return setBinLabels_<TProfile>(hist,labels);
       }

bool Gaudi::Utils::Histos::setBinLabels	(	AIDA::IHistogram2D *	hist,
		const Labels &	xlabels,
		const Labels &	ylabels
	)

Set the Bin labels for a given 2D histogram.

The labels will be applied in the order they appear in the lists, starting at the first bin. If the list of labels is too short, the later bins will be missing a label. If the list is too long, only the first N will be used, where N is the number of bins in the histogram

Parameters

hist	Pointer to the histogram
xlabels	The list of x labels
ylabels	The list of y labels

Returns: Boolean indicating if the labels were successfully applied or not

Return values

TRUE	Labels were applied OK
FALSE	Labels were NOT applied

Definition at line 118 of file HistoLabels.cpp.

       {
         if (!hist) return false;
         TH2D * h2d = Gaudi::Utils::Aida2ROOT::aida2root( hist );
         if (!h2d)  return false;
         BinLabels lx;
         lx.reserve(xlabels.size());
         for ( unsigned int i = 0; i < xlabels.size(); ++i )
         {
           lx.emplace_back( i , xlabels[i] );
         }
         BinLabels ly;
         ly.reserve(ylabels.size());
         for ( unsigned int i = 0; i < ylabels.size(); ++i )
         {
           ly.emplace_back( i , ylabels[i] );
         }
         return ( setBinLabels_( h2d->GetXaxis(), lx ) &&
                  setBinLabels_( h2d->GetYaxis(), ly ) );
       }

bool Gaudi::Utils::Histos::setBinLabels	(	AIDA::IHistogram2D *	hist,
		const BinLabels &	xlabels,
		const BinLabels &	ylabels
	)

Set the Bin labels for a given 2D histogram.

Each entry in 'labels' lists gives the bin number and its associated label

Parameters

hist	Pointer to the histogram
xlabels	The list of x bin numbers and the associated label
ylabels	The list of y bin numbers and the associated label

Returns: Boolean indicating if the labels were successfully applied or not

Return values

TRUE	Labels were applied OK
FALSE	Labels were NOT applied

Definition at line 141 of file HistoLabels.cpp.

       {
         TH2D * h2d = Gaudi::Utils::Aida2ROOT::aida2root( hist );
         return ( h2d &&
                  setBinLabels_( h2d->GetXaxis(), xlabels ) &&
                  setBinLabels_( h2d->GetYaxis(), ylabels ) );
       }

bool Gaudi::Utils::Histos::setBinLabels	(	AIDA::IProfile2D *	hist,
		const Labels &	xlabels,
		const Labels &	ylabels
	)

Set the Bin labels for a given 2D profile histogram.

The labels will be applied in the order they appear in the lists, starting at the first bin. If the list of labels is too short, the later bins will be missing a label. If the list is too long, only the first N will be used, where N is the number of bins in the histogram

Parameters

hist	Pointer to the histogram
xlabels	The list of x labels
ylabels	The list of y labels

Returns: Boolean indicating if the labels were successfully applied or not

Return values

TRUE	Labels were applied OK
FALSE	Labels were NOT applied

Definition at line 151 of file HistoLabels.cpp.

       {
         if (!hist) return false;
         TProfile2D * h2d = Gaudi::Utils::Aida2ROOT::aida2root( hist );
         if (!h2d)  return false;
         BinLabels lx;
         lx.reserve(xlabels.size());
         for ( unsigned int i = 0; i < xlabels.size(); ++i )
         {
           lx.emplace_back( i , xlabels[i] );
         }
         BinLabels ly;
         ly.reserve(ylabels.size());
         for ( unsigned int i = 0; i < ylabels.size(); ++i )
         {
           ly.emplace_back( i , ylabels[i] );
         }
         return ( setBinLabels_( h2d->GetXaxis(), lx ) &&
                  setBinLabels_( h2d->GetYaxis(), ly ) );
       }

bool Gaudi::Utils::Histos::setBinLabels	(	AIDA::IProfile2D *	hist,
		const BinLabels &	xlabels,
		const BinLabels &	ylabels
	)

Set the Bin labels for a given 2D profile histogram.

Each entry in 'labels' lists gives the bin number and its associated label

Parameters

hist	Pointer to the histogram
xlabels	The list of x bin numbers and the associated label
ylabels	The list of y bin numbers and the associated label

Returns: Boolean indicating if the labels were successfully applied or not

Return values

TRUE	Labels were applied OK
FALSE	Labels were NOT applied

Definition at line 174 of file HistoLabels.cpp.

       {
         TProfile2D * h2d = Gaudi::Utils::Aida2ROOT::aida2root( hist );
         return ( h2d &&
                  setBinLabels_( h2d->GetXaxis(), xlabels ) &&
                  setBinLabels_( h2d->GetYaxis(), ylabels ) );
       }

AIDA::IBaseHistogram * Gaudi::Utils::Histos::toBase ( AIDA::IHistogram1D * histo )

Definition at line 193 of file Fill.cpp.

193 { return histo ; }

AIDA::IBaseHistogram * Gaudi::Utils::Histos::toBase ( AIDA::IHistogram2D * histo )

Definition at line 197 of file Fill.cpp.

197 { return histo ; }

AIDA::IBaseHistogram * Gaudi::Utils::Histos::toBase ( AIDA::IHistogram3D * histo )

Definition at line 201 of file Fill.cpp.

201 { return histo ; }

AIDA::IBaseHistogram * Gaudi::Utils::Histos::toBase ( AIDA::IProfile1D * histo )

Definition at line 205 of file Fill.cpp.

205 { return histo ; }

AIDA::IBaseHistogram * Gaudi::Utils::Histos::toBase ( AIDA::IProfile2D * histo )

Definition at line 209 of file Fill.cpp.

209 { return histo ; }

std::ostream & Gaudi::Utils::Histos::toXml	(	const TH1D &	histo,
		std::ostream &	stream
	)

stream the ROOT histogram into output stream as XML

See also: TBufferXML; TBufferXML::ConvertToXML

Parameters

histo	(INPUT) the histogram to be streamed
stream	(OUTPUT) the stream

Definition at line 67 of file HistoXML.cpp.

 {
   return stream << TBufferXML::ConvertToXML( &histo ) ;
 }

std::ostream & Gaudi::Utils::Histos::toXml	(	const TH2D &	histo,
		std::ostream &	stream
	)

stream the ROOT histogram into output stream as XML

See also: TBufferXML; TBufferXML::ConvertToXML

Parameters

histo	(INPUT) the histogram to be streamed
stream	(OUTPUT) the stream

Definition at line 79 of file HistoXML.cpp.

 {
   return stream << TBufferXML::ConvertToXML( &histo ) ;
 }

std::ostream & Gaudi::Utils::Histos::toXml	(	const TH3D &	histo,
		std::ostream &	stream
	)

stream the ROOT histogram into output stream as XML

See also: TBufferXML; TBufferXML::ConvertToXML

Parameters

histo	(INPUT) the histogram to be streamed
stream	(OUTPUT) the stream

Definition at line 91 of file HistoXML.cpp.

 {
   return stream << TBufferXML::ConvertToXML(  &histo ) ;
 }

std::ostream & Gaudi::Utils::Histos::toXml	(	const TProfile &	histo,
		std::ostream &	stream
	)

stream the ROOT histogram into output stream as XML

See also: TBufferXML; TBufferXML::ConvertToXML

Parameters

histo	(INPUT) the histogram to be streamed
stream	(OUTPUT) the stream

Definition at line 139 of file HistoXML.cpp.

 {
   return stream << TBufferXML::ConvertToXML(  &histo ) ;
 }

std::ostream & Gaudi::Utils::Histos::toXml	(	const TProfile2D &	histo,
		std::ostream &	stream
	)

stream the ROOT histogram into output stream as XML

See also: TBufferXML; TBufferXML::ConvertToXML

Parameters

histo	(INPUT) the histogram to be streamed
stream	(OUTPUT) the stream

Definition at line 151 of file HistoXML.cpp.

 {
   return stream << TBufferXML::ConvertToXML (  &histo ) ;
 }

std::ostream & Gaudi::Utils::Histos::toXml	(	const AIDA::IHistogram1D &	histo,
		std::ostream &	stream
	)

stream the AIDA histogram into the output stream as XML

Parameters

histo	(INPUT) the histogram to be streamed
stream	(OUTPUT) the stream

Definition at line 163 of file HistoXML.cpp.

 {
   auto root = Gaudi::Utils::Aida2ROOT::aida2root ( &histo ) ;
   return root ? toXml( *root , stream ) : stream;
 }

std::ostream & Gaudi::Utils::Histos::toXml	(	const AIDA::IHistogram2D &	histo,
		std::ostream &	stream
	)

stream the AIDA histogram into the output stream as XML

Parameters

histo	(INPUT) the histogram to be streamed
stream	(OUTPUT) the stream

Definition at line 176 of file HistoXML.cpp.

 {
   auto root = Gaudi::Utils::Aida2ROOT::aida2root ( &histo ) ;
   return root ? toXml( *root , stream ) : stream;
 }

std::ostream & Gaudi::Utils::Histos::toXml	(	const AIDA::IHistogram3D &	histo,
		std::ostream &	stream
	)

stream the AIDA histogram into the output stream as XML

Parameters

histo	(INPUT) the histogram to be streamed
stream	(OUTPUT) the stream

Definition at line 189 of file HistoXML.cpp.

 {
   auto root = Gaudi::Utils::Aida2ROOT::aida2root ( &histo ) ;
   return root ? toXml( *root , stream ) : stream;
 }

std::ostream & Gaudi::Utils::Histos::toXml	(	const AIDA::IProfile1D &	histo,
		std::ostream &	stream
	)

stream the AIDA histogram into the output stream as XML

Parameters

histo	(INPUT) the histogram to be streamed
stream	(OUTPUT) the stream

Definition at line 202 of file HistoXML.cpp.

 {
   auto root = Gaudi::Utils::Aida2ROOT::aida2root ( &histo ) ;
   return root ? toXml( *root , stream ) : stream;
 }

std::ostream & Gaudi::Utils::Histos::toXml	(	const TH1F &	histo,
		std::ostream &	stream
	)

stream the ROOT histogram into output stream as XML

See also: TBufferXML; TBufferXML::ConvertToXML

Parameters

histo	(INPUT) the histogram to be streamed
stream	(OUTPUT) the stream

Definition at line 103 of file HistoXML.cpp.

 {
   return stream << TBufferXML::ConvertToXML( &histo ) ;
 }

std::ostream & Gaudi::Utils::Histos::toXml	(	const TH2F &	histo,
		std::ostream &	stream
	)

stream the ROOT histogram into output stream as XML

See also: TBufferXML; TBufferXML::ConvertToXML

Parameters

histo	(INPUT) the histogram to be streamed
stream	(OUTPUT) the stream

Definition at line 115 of file HistoXML.cpp.

 {
   return stream << TBufferXML::ConvertToXML(  &histo ) ;
 }

std::ostream & Gaudi::Utils::Histos::toXml	(	const TH3F &	histo,
		std::ostream &	stream
	)

stream the ROOT histogram into output stream as XML

See also: TBufferXML; TBufferXML::ConvertToXML

Parameters

histo	(INPUT) the histogram to be streamed
stream	(OUTPUT) the stream

Definition at line 127 of file HistoXML.cpp.

 {
   return stream << TBufferXML::ConvertToXML(  &histo ) ;
 }

std::ostream & Gaudi::Utils::Histos::toXml	(	const AIDA::IProfile2D &	histo,
		std::ostream &	stream
	)

stream the AIDA histogram into the output stream as XML

Parameters

histo	(INPUT) the histogram to be streamed
stream	(OUTPUT) the stream

Definition at line 215 of file HistoXML.cpp.

 {
   auto root = Gaudi::Utils::Aida2ROOT::aida2root ( &histo ) ;
   return root ? toXml( *root , stream ) : stream;
 }

Namespaces

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

Function Documentation