ACTS
Experiment-independent tracking
Loading...
Searching...
No Matches
Acts::Experimental::Histogram< Dim > Class Template Reference

Multi-dimensional histogram wrapper using boost::histogram for data collection. More...

#include <Acts/Utilities/Histogram.hpp>

Inheritance diagram for Acts::Experimental::Histogram< Dim >:
[legend]

Public Member Functions

 Histogram (std::string name, std::string title, const std::array< AxisVariant, Dim > &axes)
 Construct multi-dimensional histogram from axes.
void fill (const std::array< double, Dim > &values)
 Fill histogram with values.
const BoostHisthistogram () const
 Direct access to boost::histogram (for converters and tests).
const std::string & name () const
 Get histogram name.
const std::string & title () const
 Get histogram title.

Static Public Member Functions

static constexpr std::size_t rank ()
 Get number of dimensions (compile-time constant).

Detailed Description

template<std::size_t Dim>
class Acts::Experimental::Histogram< Dim >

Multi-dimensional histogram wrapper using boost::histogram for data collection.

This class wraps boost::histogram to provide a ROOT-independent histogram implementation with compile-time dimensionality.

Template Parameters
DimNumber of dimensions

Constructor & Destructor Documentation

◆ Histogram()

template<std::size_t Dim>
Acts::Experimental::Histogram< Dim >::Histogram ( std::string name,
std::string title,
const std::array< AxisVariant, Dim > & axes )

Construct multi-dimensional histogram from axes.

Parameters
nameHistogram name (for identification and output)
titleHistogram title (for plotting)
axesArray of axes with binning and metadata

Member Function Documentation

◆ fill()

template<std::size_t Dim>
void Acts::Experimental::Histogram< Dim >::fill ( const std::array< double, Dim > & values)

Fill histogram with values.

Parameters
valuesValues to fill (one per axis)

◆ histogram()

template<std::size_t Dim>
const BoostHist & Acts::Experimental::Histogram< Dim >::histogram ( ) const

Direct access to boost::histogram (for converters and tests).

◆ name()

template<std::size_t Dim>
const std::string & Acts::Experimental::Histogram< Dim >::name ( ) const

Get histogram name.

◆ rank()

template<std::size_t Dim>
constexpr std::size_t Acts::Experimental::Histogram< Dim >::rank ( )
staticconstexpr

Get number of dimensions (compile-time constant).

◆ title()

template<std::size_t Dim>
const std::string & Acts::Experimental::Histogram< Dim >::title ( ) const

Get histogram title.