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

Namespaces
namespace	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.

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

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

Functions
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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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.

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

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

GAUDI_API std::string	format (const AIDA::IProfile1D *histo, const std::string &fmt)
	Make the string representation of the profile histogram according to the specified format.

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

GAUDI_API std::string	format (const AIDA::IProfile1D *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

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

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

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.

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

GAUDI_API StatusCode	fromXml (TH1D &result, std::string_view input)
	parse the histogram from standard ROOT XML

GAUDI_API StatusCode	fromXml (TH2D &result, std::string_view input)
	parse the histogram from standard ROOT XML

GAUDI_API StatusCode	fromXml (TH3D &result, std::string_view input)
	parse the histogram from standard ROOT XML

GAUDI_API StatusCode	fromXml (TProfile &result, std::string_view input)
	parse the histogram from standard ROOT XML

GAUDI_API StatusCode	fromXml (TProfile2D &result, std::string_view input)
	parse the histogram from standard ROOT XML

GAUDI_API StatusCode	fromXml (TH1F &result, std::string_view input)
	parse the histogram from standard ROOT XML

GAUDI_API StatusCode	fromXml (TH2F &result, std::string_view input)
	parse the histogram from standard ROOT XML

GAUDI_API StatusCode	fromXml (TH3F &result, std::string_view input)
	parse the histogram from standard ROOT XML

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

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

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

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

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

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

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

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

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

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

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

◆ BinLabel

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

Typedef for a bin number and its associated label.

Definition at line 34 of file HistoLabels.h.

◆ BinLabels

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

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

Definition at line 36 of file HistoLabels.h.

◆ Labels

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

Typedef for a list of labels.

Definition at line 32 of file HistoLabels.h.

Function Documentation

◆ format() [1/5]

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

Make the string representation of the histogram 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 233 of file HistoTableFormat.cpp.

                                                                                        {
  if ( !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
      % ( "\"" + _title( histo ) + "\"" )               //  2) title
      % histo->allEntries()                             //  3) # entries
      % histo->binEntries( AIDA::IAxis::UNDERFLOW_BIN ) //  4) # underflow
      % histo->binEntries( AIDA::IAxis::OVERFLOW_BIN )  //  5) # overflow
      % HistoStats::nEff( histo )                       //  6) equivalent entries
      % histo->sumBinHeights()                          //  7) integral
      % HistoStats::mean( histo )                       //  8) mean value
      % HistoStats::meanErr( histo )                    //  9) error in mean
      % HistoStats::rms( histo )                        // 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();
}

◆ format() [2/5]

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 325 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();
}

◆ format() [3/5]

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

Make the string representation of the profile histogram according to the specified format.

The method could be used to access/print various quantities

using namespace Gaudi::Utils::Histos ;
 
const AIDA::IProfile1D* 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 ;

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 279 of file HistoTableFormat.cpp.

                                                                                      {
  if ( !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
      % ( "\"" + _title( histo ) + "\"" )               //  2) title
      % histo->allEntries()                             //  3) # entries
      % histo->binEntries( AIDA::IAxis::UNDERFLOW_BIN ) //  4) # underflow
      % histo->binEntries( AIDA::IAxis::OVERFLOW_BIN )  //  5) # overflow
      % HistoStats::nEff( histo )                       //  6) equivalent entries
      % histo->sumBinHeights()                          //  7) integral
      % HistoStats::mean( histo )                       //  8) mean value
      % HistoStats::meanErr( histo )                    //  9) error in mean
      % HistoStats::rms( histo )                        // 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();
}

◆ format() [4/5]

std::string Gaudi::Utils::Histos::format	(	const AIDA::IProfile1D *	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::IProfile1D* 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 342 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();
}

◆ format() [5/5]

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 357 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();
}

◆ fromXml() [1/18]

StatusCode Gaudi::Utils::Histos::fromXml	(	AIDA::IHistogram1D &	result,
		std::string_view	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 431 of file HistoXML.cpp.

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

◆ fromXml() [2/18]

StatusCode Gaudi::Utils::Histos::fromXml	(	AIDA::IHistogram2D &	result,
		std::string_view	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 442 of file HistoXML.cpp.

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

◆ fromXml() [3/18]

StatusCode Gaudi::Utils::Histos::fromXml	(	AIDA::IHistogram3D &	result,
		std::string_view	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 453 of file HistoXML.cpp.

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

◆ fromXml() [4/18]

StatusCode Gaudi::Utils::Histos::fromXml	(	AIDA::IProfile1D &	result,
		std::string_view	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 464 of file HistoXML.cpp.

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

◆ fromXml() [5/18]

StatusCode Gaudi::Utils::Histos::fromXml	(	AIDA::IProfile2D &	result,
		std::string_view	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 475 of file HistoXML.cpp.

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

◆ fromXml() [6/18]

StatusCode Gaudi::Utils::Histos::fromXml	(	TH1D &	result,
		std::string_view	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 199 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;
}

◆ fromXml() [7/18]

StatusCode Gaudi::Utils::Histos::fromXml	(	TH1D *&	result,
		std::string_view	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 345 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;
}

◆ fromXml() [8/18]

StatusCode Gaudi::Utils::Histos::fromXml	(	TH1F &	result,
		std::string_view	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 254 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;
}

◆ fromXml() [9/18]

StatusCode Gaudi::Utils::Histos::fromXml	(	TH2D &	result,
		std::string_view	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 218 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;
}

◆ fromXml() [10/18]

StatusCode Gaudi::Utils::Histos::fromXml	(	TH2D *&	result,
		std::string_view	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 362 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;
}

◆ fromXml() [11/18]

StatusCode Gaudi::Utils::Histos::fromXml	(	TH2F &	result,
		std::string_view	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 272 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;
}

◆ fromXml() [12/18]

StatusCode Gaudi::Utils::Histos::fromXml	(	TH3D &	result,
		std::string_view	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 236 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;
}

◆ fromXml() [13/18]

StatusCode Gaudi::Utils::Histos::fromXml	(	TH3D *&	result,
		std::string_view	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 379 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;
}

◆ fromXml() [14/18]

StatusCode Gaudi::Utils::Histos::fromXml	(	TH3F &	result,
		std::string_view	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<TH3F>( input );
  if ( !histo ) { return StatusCode::FAILURE; } // RETURN
  //
  histo->Copy( result );
  //
  return StatusCode::SUCCESS;
}

◆ fromXml() [15/18]

StatusCode Gaudi::Utils::Histos::fromXml	(	TProfile &	result,
		std::string_view	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 308 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;
}

◆ fromXml() [16/18]

StatusCode Gaudi::Utils::Histos::fromXml	(	TProfile *&	result,
		std::string_view	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 397 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;
}

◆ fromXml() [17/18]

StatusCode Gaudi::Utils::Histos::fromXml	(	TProfile2D &	result,
		std::string_view	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 326 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;
}

◆ fromXml() [18/18]

StatusCode Gaudi::Utils::Histos::fromXml	(	TProfile2D *&	result,
		std::string_view	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 414 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;
}

◆ histoDump() [1/4]

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 559 of file HistoDump.cpp.

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

◆ histoDump() [2/4]

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 610 of file HistoDump.cpp.

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

◆ histoDump() [3/4]

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 656 of file HistoDump.cpp.

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

◆ histoDump() [4/4]

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 698 of file HistoDump.cpp.

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

◆ path()

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 218 of file HistoTableFormat.cpp.

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

◆ printList() [1/2]

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 315 of file HistoTableFormat.h.

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

◆ printList() [2/2]

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 286 of file HistoTableFormat.h.

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

◆ printMap() [1/2]

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<std::string,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 418 of file HistoTableFormat.h.

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

◆ printMap() [2/2]

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<std::string,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 364 of file HistoTableFormat.h.

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

◆ setAxisLabels() [1/4]

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 133 of file HistoLabels.cpp.

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

◆ setAxisLabels() [2/4]

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 141 of file HistoLabels.cpp.

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

◆ setAxisLabels() [3/4]

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 137 of file HistoLabels.cpp.

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

◆ setAxisLabels() [4/4]

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 145 of file HistoLabels.cpp.

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

◆ setBinLabels() [1/8]

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 83 of file HistoLabels.cpp.

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

◆ setBinLabels() [2/8]

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 91 of file HistoLabels.cpp.

91{ return setBinLabels_( hist, labels ); }

◆ setBinLabels() [3/8]

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 108 of file HistoLabels.cpp.

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

◆ setBinLabels() [4/8]

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 95 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 ) );
      }

◆ setBinLabels() [5/8]

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 87 of file HistoLabels.cpp.

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

◆ setBinLabels() [6/8]

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 93 of file HistoLabels.cpp.

93{ return setBinLabels_( hist, labels ); }

◆ setBinLabels() [7/8]

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 126 of file HistoLabels.cpp.

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

◆ setBinLabels() [8/8]

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 113 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 ) );
      }

◆ toXml() [1/13]

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 148 of file HistoXML.cpp.

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

◆ toXml() [2/13]

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 158 of file HistoXML.cpp.

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

◆ toXml() [3/13]

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 168 of file HistoXML.cpp.

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

◆ toXml() [4/13]

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 178 of file HistoXML.cpp.

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

◆ toXml() [5/13]

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 188 of file HistoXML.cpp.

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

◆ toXml() [6/13]

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 76 of file HistoXML.cpp.

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

◆ toXml() [7/13]

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 );
}

◆ toXml() [8/13]

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 85 of file HistoXML.cpp.

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

◆ toXml() [9/13]

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 112 of file HistoXML.cpp.

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

◆ toXml() [10/13]

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 94 of file HistoXML.cpp.

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

◆ toXml() [11/13]

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 121 of file HistoXML.cpp.

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

◆ toXml() [12/13]

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 130 of file HistoXML.cpp.

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

◆ toXml() [13/13]

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 139 of file HistoXML.cpp.

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

Namespaces

Classes

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ BinLabel

◆ BinLabels

◆ Labels

Function Documentation

◆ format() [1/5]

◆ format() [2/5]

◆ format() [3/5]

◆ format() [4/5]

◆ format() [5/5]

◆ fromXml() [1/18]

◆ fromXml() [2/18]

◆ fromXml() [3/18]

◆ fromXml() [4/18]

◆ fromXml() [5/18]

◆ fromXml() [6/18]

◆ fromXml() [7/18]

◆ fromXml() [8/18]

◆ fromXml() [9/18]

◆ fromXml() [10/18]

◆ fromXml() [11/18]

◆ fromXml() [12/18]

◆ fromXml() [13/18]

◆ fromXml() [14/18]

◆ fromXml() [15/18]

◆ fromXml() [16/18]

◆ fromXml() [17/18]

◆ fromXml() [18/18]

◆ histoDump() [1/4]

◆ histoDump() [2/4]

◆ histoDump() [3/4]

◆ histoDump() [4/4]

◆ path()

◆ printList() [1/2]

◆ printList() [2/2]

◆ printMap() [1/2]

◆ printMap() [2/2]

◆ setAxisLabels() [1/4]

◆ setAxisLabels() [2/4]

◆ setAxisLabels() [3/4]

◆ setAxisLabels() [4/4]

◆ setBinLabels() [1/8]

◆ setBinLabels() [2/8]

◆ setBinLabels() [3/8]

◆ setBinLabels() [4/8]

◆ setBinLabels() [5/8]

◆ setBinLabels() [6/8]

◆ setBinLabels() [7/8]

◆ setBinLabels() [8/8]

◆ toXml() [1/13]

◆ toXml() [2/13]

◆ toXml() [3/13]

◆ toXml() [4/13]

◆ toXml() [5/13]

◆ toXml() [6/13]

◆ toXml() [7/13]

◆ toXml() [8/13]

◆ toXml() [9/13]

◆ toXml() [10/13]

◆ toXml() [11/13]

◆ toXml() [12/13]

◆ toXml() [13/13]