Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::Experimental::ProtoBinning Struct Reference

Simple helper class to define a binning structure. More...

#include <acts/blob/sPHENIX/Core/include/Acts/Detector/ProtoBinning.hpp>

+ Collaboration diagram for Acts::Experimental::ProtoBinning:

Public Member Functions

 ProtoBinning (BinningValue bValue, Acts::detail::AxisBoundaryType bType, const std::vector< ActsScalar > &e, std::size_t exp=0u)
 
 ProtoBinning (BinningValue bValue, Acts::detail::AxisBoundaryType bType, ActsScalar minE, ActsScalar maxE, std::size_t nbins, std::size_t exp=0u)
 
std::size_t bins () const
 

Public Attributes

BinningValue binValue = BinningValue::binValues
 The binning value of this.
 
Acts::detail::AxisType axisType = Acts::detail::AxisType::Equidistant
 The axis type: equidistant or variable.
 
Acts::detail::AxisBoundaryType boundaryType
 The axis boundary type: Open, Bound or Closed.
 
std::vector< ActsScalaredges = {}
 The binning edges.
 
std::size_t expansion = 0u
 An expansion for the filling (in bins)
 

Detailed Description

Simple helper class to define a binning structure.

Note
no checks are performed on the consistency, this is only for convenience that the binning can be defined and then translated into concrete axis types

Definition at line 28 of file ProtoBinning.hpp.

View newest version in sPHENIX GitHub at line 28 of file ProtoBinning.hpp

Constructor & Destructor Documentation

Acts::Experimental::ProtoBinning::ProtoBinning ( BinningValue  bValue,
Acts::detail::AxisBoundaryType  bType,
const std::vector< ActsScalar > &  e,
std::size_t  exp = 0u 
)
inline

Convenience constructors - recommended for variable binning

Parameters
bValuethe value/cast in which this is binned
bTypethe axis boundary type
ethe bin edges (variable binning)
expthe expansion (in bins)

Definition at line 47 of file ProtoBinning.hpp.

View newest version in sPHENIX GitHub at line 47 of file ProtoBinning.hpp

References edges, and physmon_ckf_tracking::u.

Acts::Experimental::ProtoBinning::ProtoBinning ( BinningValue  bValue,
Acts::detail::AxisBoundaryType  bType,
ActsScalar  minE,
ActsScalar  maxE,
std::size_t  nbins,
std::size_t  exp = 0u 
)
inline

Convenience constructors - recommended for variable binning

Parameters
bValuethe value/cast in which this is binned
bTypethe axis boundary type
minEthe lowest edge of the binning
maxEthe highest edge of the binning
nbinsthe number of bins
expthe expansion (in bins)

Definition at line 68 of file ProtoBinning.hpp.

View newest version in sPHENIX GitHub at line 68 of file ProtoBinning.hpp

References edges, i, nbins, and physmon_ckf_tracking::u.

Member Function Documentation

std::size_t Acts::Experimental::ProtoBinning::bins ( ) const
inline

Definition at line 89 of file ProtoBinning.hpp.

View newest version in sPHENIX GitHub at line 89 of file ProtoBinning.hpp

References edges, and physmon_ckf_tracking::u.

Member Data Documentation

Acts::detail::AxisType Acts::Experimental::ProtoBinning::axisType = Acts::detail::AxisType::Equidistant

The axis type: equidistant or variable.

Definition at line 32 of file ProtoBinning.hpp.

View newest version in sPHENIX GitHub at line 32 of file ProtoBinning.hpp

BinningValue Acts::Experimental::ProtoBinning::binValue = BinningValue::binValues

The binning value of this.

Definition at line 30 of file ProtoBinning.hpp.

View newest version in sPHENIX GitHub at line 30 of file ProtoBinning.hpp

Acts::detail::AxisBoundaryType Acts::Experimental::ProtoBinning::boundaryType
Initial value:
=
Acts::detail::AxisBoundaryType::Bound

The axis boundary type: Open, Bound or Closed.

Definition at line 34 of file ProtoBinning.hpp.

View newest version in sPHENIX GitHub at line 34 of file ProtoBinning.hpp

Referenced by Acts::Experimental::LayerStructureBuilder::construct().

std::vector<ActsScalar> Acts::Experimental::ProtoBinning::edges = {}

The binning edges.

Definition at line 37 of file ProtoBinning.hpp.

View newest version in sPHENIX GitHub at line 37 of file ProtoBinning.hpp

Referenced by bins(), and ProtoBinning().

std::size_t Acts::Experimental::ProtoBinning::expansion = 0u

An expansion for the filling (in bins)

Definition at line 39 of file ProtoBinning.hpp.

View newest version in sPHENIX GitHub at line 39 of file ProtoBinning.hpp


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