EIC Software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
dfe::OverflowAxis< T > Class Template Reference

#include <acts/blob/sPHENIX/thirdparty/dfelibs/dfe/dfe_histogram.hpp>

+ Collaboration diagram for dfe::OverflowAxis< T >:

Public Types

using Value = T
 

Public Member Functions

 OverflowAxis (T lower, T upper, std::size_t nbins)
 
constexpr std::size_t nbins () const
 Total number of bins along this axis including under/overflow bins.
 
constexpr std::size_t index (T value) const
 Compute bin number for a test value.
 

Private Attributes

std::size_t m_ndatabins
 
T m_lower
 
T m_upper
 

Detailed Description

template<typename T>
class dfe::OverflowAxis< T >

Uniform binning with under/overflow bins.

The first and last bin index correspond to the under/overflow bin.

Definition at line 109 of file dfe_histogram.hpp.

View newest version in sPHENIX GitHub at line 109 of file dfe_histogram.hpp

Member Typedef Documentation

template<typename T >
using dfe::OverflowAxis< T >::Value = T

Definition at line 111 of file dfe_histogram.hpp.

View newest version in sPHENIX GitHub at line 111 of file dfe_histogram.hpp

Constructor & Destructor Documentation

template<typename T >
dfe::OverflowAxis< T >::OverflowAxis ( T  lower,
T  upper,
std::size_t  nbins 
)
inline
Parameters
lowerLower inclusive boundary
upperUpper exclusive boundary
nbinsNumber of data bins within those boundaries

Definition at line 268 of file dfe_histogram.hpp.

View newest version in sPHENIX GitHub at line 268 of file dfe_histogram.hpp

Member Function Documentation

template<typename T >
constexpr std::size_t dfe::OverflowAxis< T >::index ( T  value) const

Compute bin number for a test value.

Definition at line 274 of file dfe_histogram.hpp.

View newest version in sPHENIX GitHub at line 274 of file dfe_histogram.hpp

template<typename T >
constexpr std::size_t dfe::OverflowAxis< T >::nbins ( ) const
inline

Total number of bins along this axis including under/overflow bins.

Definition at line 119 of file dfe_histogram.hpp.

View newest version in sPHENIX GitHub at line 119 of file dfe_histogram.hpp

References dfe::OverflowAxis< T >::m_ndatabins.

Member Data Documentation

template<typename T >
T dfe::OverflowAxis< T >::m_lower
private

Definition at line 125 of file dfe_histogram.hpp.

View newest version in sPHENIX GitHub at line 125 of file dfe_histogram.hpp

template<typename T >
std::size_t dfe::OverflowAxis< T >::m_ndatabins
private

Definition at line 124 of file dfe_histogram.hpp.

View newest version in sPHENIX GitHub at line 124 of file dfe_histogram.hpp

Referenced by dfe::OverflowAxis< T >::nbins().

template<typename T >
T dfe::OverflowAxis< T >::m_upper
private

Definition at line 126 of file dfe_histogram.hpp.

View newest version in sPHENIX GitHub at line 126 of file dfe_histogram.hpp


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