#include </builds/gaudi/Gaudi/GaudiKernel/include/Gaudi/Accumulators/HistogramWrapper.h>

Collaboration diagram for Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >:

[legend]

Public Types
using	AxisTupleType = typename HistogramType::AxisTupleType
using	AxisArithmeticType = typename HistogramType::AxisArithmeticType
using	BufferType = typename HistogramType::BufferType
template<unsigned int I>
using	AxisType = std::tuple_element_t<I, AxisTupleType>

Public Member Functions
template<typename OWNER>
	HistogramWrapperInternal (OWNER *owner, std::string const &name, std::string const &title="", typename HistogramType::AxisTupleType axis={}, bool doNotInitialize=false)
	constructor, only creates a set of Properties
template<typename OWNER>
	HistogramWrapperInternal (OWNER const *owner, std::string const &name, std::string const &title="", typename HistogramType::AxisTupleType axis={})
	constructor with const owner (i.e.
template<typename OWNER>
	HistogramWrapperInternal (OWNER *owner, std::string const &name, std::string const &title, AxisType< ND >... allAxis)
	constructor with more natural syntax for axis
auto	operator[] (typename HistogramType::AxisTupleArithmeticType v)
	override of operator[] with extra checking that initialization happened
template<typename OWNER>
void	createHistogram (OWNER &owner)
	creation of the internal histogram, from the properties
void	setTitle (std::string const &title)
template<unsigned int N>
void	setAxis (std::tuple_element_t< N, typename HistogramType::AxisTupleType > const &axis)
template<unsigned int N>
auto &	axis () const
auto &	axis () const
void	reset ()
auto	buffer ()

Private Member Functions
std::string	basePropertyName () const
std::string	titlePropertyName () const
template<unsigned int N>
std::string	axisPropertyName () const

Private Attributes
std::string	m_name {}
std::string	m_title {}
HistogramType::AxisTupleType	m_axis {}
std::optional< HistogramType >	m_histo {}

Friends
void	to_json (nlohmann::json &j, HistogramWrapperInternal const &h)

Detailed Description

template<typename HistogramType, unsigned int... ND>
class Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >

Definition at line 43 of file HistogramWrapper.h.

Member Typedef Documentation

◆ AxisArithmeticType

template<typename HistogramType, unsigned int... ND>

using Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >::AxisArithmeticType = typename HistogramType::AxisArithmeticType

Definition at line 46 of file HistogramWrapper.h.

◆ AxisTupleType

template<typename HistogramType, unsigned int... ND>

using Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >::AxisTupleType = typename HistogramType::AxisTupleType

Definition at line 45 of file HistogramWrapper.h.

◆ AxisType

template<typename HistogramType, unsigned int... ND>

template<unsigned int I>

using Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >::AxisType = std::tuple_element_t<I, AxisTupleType>

Definition at line 49 of file HistogramWrapper.h.

◆ BufferType

template<typename HistogramType, unsigned int... ND>

using Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >::BufferType = typename HistogramType::BufferType

Definition at line 47 of file HistogramWrapper.h.

Constructor & Destructor Documentation

◆ HistogramWrapperInternal() [1/3]

template<typename HistogramType, unsigned int... ND>

template<typename OWNER>

Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >::HistogramWrapperInternal	(	OWNER *	owner,
		std::string const &	name,
		std::string const &	title = "",
		typename HistogramType::AxisTupleType	axis = {},
		bool	doNotInitialize = false )

inline

constructor, only creates a set of Properties

Definition at line 53 of file HistogramWrapper.h.

                                                                       {}, bool doNotInitialize = false )
        : m_name{ name }, m_title{ title }, m_axis{ axis } {
      // Create associated properties
      owner->declareProperty( titlePropertyName(), m_title, std::format( "Title of histogram {}", name ) )
          ->template setOwnerType<OWNER>();
      ( owner
            ->declareProperty( axisPropertyName<ND>(), std::get<ND>( m_axis ),
                               std::format( "Axis {} of histogram {}", ND, name ) )
            ->template setOwnerType<OWNER>(),
        ... );
      // register creation of the Histogram at initialization time
      if ( !doNotInitialize ) {
        if ( owner->FSMState() >= Gaudi::StateMachine::INITIALIZED ) {
          // if the owner is already initialized (e.g. the histogram is being created during `start()`)
          // it is too late to register the callback
          createHistogram( *owner );
        } else {
          owner->registerCallBack( StateMachine::INITIALIZE, [this, owner]() { createHistogram( *owner ); } );
        }
      }
    }

◆ HistogramWrapperInternal() [2/3]

template<typename HistogramType, unsigned int... ND>

template<typename OWNER>

Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >::HistogramWrapperInternal	(	OWNER const *	owner,
		std::string const &	name,
		std::string const &	title = "",
		typename HistogramType::AxisTupleType	axis = {} )

inline

constructor with const owner (i.e.

outside of constructor or initialize), equivalent to the StaticHistogram case (create immediately)

Definition at line 78 of file HistogramWrapper.h.

                                                                       {} )
        : m_name{ name }, m_title{ title }, m_axis{ axis } {
      createHistogram( *owner );
    }

◆ HistogramWrapperInternal() [3/3]

template<typename HistogramType, unsigned int... ND>

template<typename OWNER>

Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >::HistogramWrapperInternal	(	OWNER *	owner,
		std::string const &	name,
		std::string const &	title,
		AxisType< ND >...	allAxis )

inline

constructor with more natural syntax for axis

Definition at line 85 of file HistogramWrapper.h.

86 : HistogramWrapperInternal( owner, name, title, std::make_tuple( allAxis... ) ) {}

Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >::HistogramWrapperInternal

HistogramWrapperInternal(OWNER *owner, std::string const &name, std::string const &title="", typename HistogramType::AxisTupleType axis={}, bool doNotInitialize=false)

constructor, only creates a set of Properties

Definition HistogramWrapper.h:53

Member Function Documentation

◆ axis() [1/2]

template<typename HistogramType, unsigned int... ND>

auto & Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >::axis ( ) const

inline

Definition at line 132 of file HistogramWrapper.h.

                       {
      if ( !m_histo )
        throw std::logic_error(
            std::format( "Cannot get axis of histogram {} before it has been initialized", m_name ) );
      return m_histo->axis();
    }

◆ axis() [2/2]

template<typename HistogramType, unsigned int... ND>

template<unsigned int N>

auto & Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >::axis ( ) const

inline

Definition at line 125 of file HistogramWrapper.h.

                       {
      if ( !m_histo )
        throw std::logic_error(
            std::format( "Cannot get axis {} of histogram {} before it has been initialized", N, m_name ) );
      return m_histo->template axis<N>();
    }

◆ axisPropertyName()

template<typename HistogramType, unsigned int... ND>

template<unsigned int N>

std::string Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >::axisPropertyName ( ) const

inlineprivate

Definition at line 159 of file HistogramWrapper.h.

                                       {
      return std::format( "{}_Axis{}", basePropertyName(), N );
    }

◆ basePropertyName()

template<typename HistogramType, unsigned int... ND>

std::string Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >::basePropertyName ( ) const

inlineprivate

Definition at line 149 of file HistogramWrapper.h.

                                       {
      // properties are used as identifiers in python and thus cannot anything alse than _, letters and numbers
      // we thus replace anything else with '_' in the property names
      std::string name = m_name;
      std::replace_if(
          begin( name ), end( name ), []( auto& c ) { return !std::isalnum( c ); }, '_' );
      return name;
    }

◆ buffer()

template<typename HistogramType, unsigned int... ND>

auto Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >::buffer ( )

inline

Definition at line 142 of file HistogramWrapper.h.

                  {
      if ( !m_histo )
        throw std::logic_error( std::format( "`buffer()` called on histogram {} before being initialized", m_name ) );
      return m_histo->buffer();
    }

◆ createHistogram()

template<typename HistogramType, unsigned int... ND>

template<typename OWNER>

void Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >::createHistogram ( OWNER & owner )

inline

creation of the internal histogram, from the properties

Definition at line 98 of file HistogramWrapper.h.

                                         {
      m_histo.emplace( &owner, m_name, m_title, m_axis );
    }

◆ operator[]()

template<typename HistogramType, unsigned int... ND>

auto Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >::operator[] ( typename HistogramType::AxisTupleArithmeticType v )

inlinenodiscard

override of operator[] with extra checking that initialization happened

Definition at line 89 of file HistogramWrapper.h.

                                                                                     {
      if ( !m_histo ) {
        throw std::logic_error( std::format( "Histogram {} is used before being initialized", m_name ) );
      }
      return m_histo.value()[v];
    }

◆ reset()

template<typename HistogramType, unsigned int... ND>

void Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >::reset ( )

inline

Definition at line 139 of file HistogramWrapper.h.

139{ m_histo.reset(); }

◆ setAxis()

template<typename HistogramType, unsigned int... ND>

template<unsigned int N>

void Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >::setAxis ( std::tuple_element_t< N, typename HistogramType::AxisTupleType > const & axis )

inline

Definition at line 117 of file HistogramWrapper.h.

                                                                                           {
      if ( m_histo )
        throw std::logic_error(
            std::format( "Cannot modify axis {} of histogram {} after it has been initialized", N, m_name ) );
      std::get<N>( m_axis ) = axis;
    }

◆ setTitle()

template<typename HistogramType, unsigned int... ND>

void Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >::setTitle ( std::string const & title )

inline

Definition at line 110 of file HistogramWrapper.h.

                                            {
      if ( m_histo )
        throw std::logic_error(
            std::format( "Cannot modify title of histogram {} after it has been initialized", m_name ) );
      m_title = title;
    }

◆ titlePropertyName()

template<typename HistogramType, unsigned int... ND>

std::string Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >::titlePropertyName ( ) const

inlineprivate

Definition at line 157 of file HistogramWrapper.h.

157{ return std::format( "{}_Title", basePropertyName() ); }

◆ to_json

template<typename HistogramType, unsigned int... ND>

void to_json	(	nlohmann::json &	j,
		HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > > const &	h )

friend

Definition at line 102 of file HistogramWrapper.h.

                                                                              {
      if ( !h.m_histo ) {
        throw std::logic_error( std::format( "Histogram {} is converted to json before being initialized", h.m_name ) );
      }
      j = h.m_histo.value();
    }

Member Data Documentation

◆ m_axis

template<typename HistogramType, unsigned int... ND>

HistogramType::AxisTupleType Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >::m_axis {}

private

Definition at line 166 of file HistogramWrapper.h.

166{};

◆ m_histo

template<typename HistogramType, unsigned int... ND>

std::optional<HistogramType> Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >::m_histo {}

private

Definition at line 167 of file HistogramWrapper.h.

167{};

◆ m_name

template<typename HistogramType, unsigned int... ND>

std::string Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >::m_name {}

private

Definition at line 164 of file HistogramWrapper.h.

164{};

◆ m_title

template<typename HistogramType, unsigned int... ND>

std::string Gaudi::Accumulators::HistogramWrapperInternal< HistogramType, std::integer_sequence< unsigned int, ND... > >::m_title {}

private

Definition at line 165 of file HistogramWrapper.h.

165{};

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

GaudiKernel/include/Gaudi/Accumulators/HistogramWrapper.h

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ AxisArithmeticType

◆ AxisTupleType

◆ AxisType

◆ BufferType

Constructor & Destructor Documentation

◆ HistogramWrapperInternal() [1/3]

◆ HistogramWrapperInternal() [2/3]

◆ HistogramWrapperInternal() [3/3]

Member Function Documentation

◆ axis() [1/2]

◆ axis() [2/2]

◆ axisPropertyName()

◆ basePropertyName()

◆ buffer()

◆ createHistogram()

◆ operator[]()

◆ reset()

◆ setAxis()

◆ setTitle()

◆ titlePropertyName()

Friends And Related Symbol Documentation

◆ to_json

Member Data Documentation

◆ m_axis

◆ m_histo

◆ m_name

◆ m_title