BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
Loading...
Searching...
No Matches
Public Member Functions | Data Fields
BDSBH4D< T > Class Template Reference

4D histogram classes with linear, logarithmic and user-defined energy binning. More...

#include <BDSBH4D.hh>

Inheritance diagram for BDSBH4D< T >:
Inheritance graph
Collaboration diagram for BDSBH4D< T >:
Collaboration graph

Public Member Functions

 BDSBH4D (std::string &name, std::string &title, const std::string &eScale, unsigned int nxbins, double xmin, double xmax, unsigned int nybins, double ymin, double ymax, unsigned int nzbins, double zmin, double zmax, unsigned int nebins, double emin, double emax)
 
 BDSBH4D (std::string &name, std::string &title, const std::string &eScale, const std::vector< double > &eBinsEdges, unsigned int nxbins, double xmin, double xmax, unsigned int nybins, double ymin, double ymax, unsigned int nzbins, double zmin, double zmax)
 
BDSBH4DBaseoperator+= (const BDSBH4DBase &other) override
 
void Reset_BDSBH4D () override
 
BDSBH4DClone (const char *) const override
 
void Fill_BDSBH4D (double, double, double, double) override
 
void Set_BDSBH4D (int, int, int, int, double) override
 
void SetError_BDSBH4D (int, int, int, int, double) override
 
void Add_BDSBH4D (BDSBH4DBase *) override
 
double At (int, int, int, int) override
 
double AtError (int, int, int, int) override
 
double LowBinEdgeAt (int, int, int, int) override
 
double HighBinEdgeAt (int, int, int, int) override
 
void Print_BDSBH4D (bool with_zero_values=true) override
 
void Print_BDSBH4D (int, int, int, int) override
 
 ClassDef (BDSBH4D, 1)
 
 BDSBH4D (std::string &name, std::string &title, const std::string &eScale, unsigned int nxbins, double xmin, double xmax, unsigned int nybins, double ymin, double ymax, unsigned int nzbins, double zmin, double zmax, unsigned int nebins, double emin, double emax)
 
 BDSBH4D (std::string &name, std::string &title, const std::string &eScale, unsigned int nxbins, double xmin, double xmax, unsigned int nybins, double ymin, double ymax, unsigned int nzbins, double zmin, double zmax, unsigned int nebins, double emin, double emax)
 
 BDSBH4D (std::string &name, std::string &title, const std::string &eScale, const std::vector< double > &eBinEdgesIn, unsigned int nxbins, double xmin, double xmax, unsigned int nybins, double ymin, double ymax, unsigned int nzbins, double zmin, double zmax)
 
- Public Member Functions inherited from BDSBH4DBase
 BDSBH4DBase (unsigned int h_nxbinsIn, unsigned int h_nybinsIn, unsigned int h_nzbinsIn, unsigned int h_nebinsIn, double xminIn, double xmaxIn, double yminIn, double ymaxIn, double zminIn, double zmaxIn, double eminIn, double emaxIn, const std::string &nameIn, const std::string &titleIn, const std::string &escaleIn)
 Constructor where 'e' dimension specifications are given.
 
 BDSBH4DBase (unsigned int h_nxbinsIn, unsigned int h_nybinsIn, unsigned int h_nzbinsIn, double xminIn, double xmaxIn, double yminIn, double ymaxIn, double zminIn, double zmaxIn, const std::string &nameIn, const std::string &titleIn, const std::string &escaleIn, const std::vector< double > &eBinEdgesIn)
 Alternative where the 'e' dimension specifications are determined from a supplied vector of edges.
 
int GetNbinsX () const final
 
int GetNbinsY () const final
 
int GetNbinsZ () const final
 
int GetNbinsE () const
 
const char * GetName () const override
 
const char * GetTitle () const override
 
unsigned long GetEntries_BDSBH4D ()
 
void SetName (const char *) override
 
void SetTitle (const char *) override
 
void SetEntries_BDSBH4D (double)
 
virtual BDSBH4DBaseoperator+= (const BDSBH4DBase &other)=0
 
virtual void Reset_BDSBH4D ()=0
 
BDSBH4DBaseClone (const char *) const override=0
 
virtual void Fill_BDSBH4D (double, double, double, double)=0
 
virtual void Set_BDSBH4D (int, int, int, int, double)=0
 
virtual void SetError_BDSBH4D (int, int, int, int, double)=0
 
virtual void Add_BDSBH4D (BDSBH4DBase *)=0
 
virtual double At (int, int, int, int)=0
 
virtual double AtError (int, int, int, int)=0
 
virtual double LowBinEdgeAt (int, int, int, int)=0
 
virtual double HighBinEdgeAt (int, int, int, int)=0
 
virtual void Print_BDSBH4D (bool with_zero_values=true)=0
 
virtual void Print_BDSBH4D (int, int, int, int)=0
 
 ClassDefOverride (BDSBH4DBase, 1)
 

Data Fields

h
 
h_err
 
- Data Fields inherited from BDSBH4DBase
unsigned int h_nxbins
 
unsigned int h_nybins
 
unsigned int h_nzbins
 
unsigned int h_nebins
 
double h_xmin
 
double h_xmax
 
double h_ymin
 
double h_ymax
 
double h_zmin
 
double h_zmax
 
double h_emin
 
double h_emax
 
std::string h_name
 
std::string h_title
 
std::string h_escale
 
std::vector< double > h_ebinsedges
 
unsigned long h_entries
 

Detailed Description

template<class T>
class BDSBH4D< T >

4D histogram classes with linear, logarithmic and user-defined energy binning.

Author
Eliott Ramoisiaux

Definition at line 40 of file BDSBH4D.hh.

Constructor & Destructor Documentation

◆ ~BDSBH4D()

template<class T >
BDSBH4D< T >::~BDSBH4D
virtual

Definition at line 156 of file BDSBH4D.cc.

◆ BDSBH4D() [1/5]

BDSBH4D< boost_histogram_log >::BDSBH4D ( )

Definition at line 55 of file BDSBH4D.cc.

◆ BDSBH4D() [2/5]

BDSBH4D< boost_histogram_variable >::BDSBH4D ( )

Definition at line 72 of file BDSBH4D.cc.

◆ BDSBH4D() [3/5]

BDSBH4D< boost_histogram_linear >::BDSBH4D ( std::string &  name,
std::string &  title,
const std::string &  eScale,
unsigned int  nxbins,
double  xmin,
double  xmax,
unsigned int  nybins,
double  ymin,
double  ymax,
unsigned int  nzbins,
double  zmin,
double  zmax,
unsigned int  nebins,
double  emin,
double  emax 
)

Definition at line 89 of file BDSBH4D.cc.

◆ BDSBH4D() [4/5]

BDSBH4D< boost_histogram_log >::BDSBH4D ( std::string &  name,
std::string &  title,
const std::string &  eScale,
unsigned int  nxbins,
double  xmin,
double  xmax,
unsigned int  nybins,
double  ymin,
double  ymax,
unsigned int  nzbins,
double  zmin,
double  zmax,
unsigned int  nebins,
double  emin,
double  emax 
)

Definition at line 112 of file BDSBH4D.cc.

◆ BDSBH4D() [5/5]

BDSBH4D< boost_histogram_variable >::BDSBH4D ( std::string &  name,
std::string &  title,
const std::string &  eScale,
const std::vector< double > &  eBinEdgesIn,
unsigned int  nxbins,
double  xmin,
double  xmax,
unsigned int  nybins,
double  ymin,
double  ymax,
unsigned int  nzbins,
double  zmin,
double  zmax 
)

Definition at line 135 of file BDSBH4D.cc.

Member Function Documentation

◆ Add_BDSBH4D()

template<class T >
void BDSBH4D< T >::Add_BDSBH4D ( BDSBH4DBase otherHistogram)
overridevirtual

Implements BDSBH4DBase.

Definition at line 204 of file BDSBH4D.cc.

◆ At()

template<class T >
double BDSBH4D< T >::At ( int  x,
int  y,
int  z,
int  e 
)
overridevirtual

Implements BDSBH4DBase.

Definition at line 211 of file BDSBH4D.cc.

◆ AtError()

template<class T >
double BDSBH4D< T >::AtError ( int  x,
int  y,
int  z,
int  e 
)
overridevirtual

Implements BDSBH4DBase.

Definition at line 241 of file BDSBH4D.cc.

◆ Clone()

template<class T >
BDSBH4D< T > * BDSBH4D< T >::Clone ( const char *  newname) const
overridevirtual

Implements BDSBH4DBase.

Definition at line 167 of file BDSBH4D.cc.

◆ Fill_BDSBH4D()

template<class T >
void BDSBH4D< T >::Fill_BDSBH4D ( double  xValue,
double  yValue,
double  zValue,
double  eValue 
)
overridevirtual

Implements BDSBH4DBase.

Definition at line 175 of file BDSBH4D.cc.

◆ HighBinEdgeAt()

template<class T >
double BDSBH4D< T >::HighBinEdgeAt ( int  x,
int  y,
int  z,
int  e 
)
overridevirtual

Implements BDSBH4DBase.

Definition at line 229 of file BDSBH4D.cc.

◆ LowBinEdgeAt()

template<class T >
double BDSBH4D< T >::LowBinEdgeAt ( int  x,
int  y,
int  z,
int  e 
)
overridevirtual

Implements BDSBH4DBase.

Definition at line 217 of file BDSBH4D.cc.

◆ operator+=()

template<class T >
BDSBH4DBase & BDSBH4D< T >::operator+= ( const BDSBH4DBase other)
inlineoverridevirtual

Implements BDSBH4DBase.

Definition at line 59 of file BDSBH4D.hh.

◆ Print_BDSBH4D() [1/2]

template<class T >
void BDSBH4D< T >::Print_BDSBH4D ( bool  with_zero_values = true)
overridevirtual

Implements BDSBH4DBase.

Definition at line 247 of file BDSBH4D.cc.

◆ Print_BDSBH4D() [2/2]

template<class T >
void BDSBH4D< T >::Print_BDSBH4D ( int  x,
int  y,
int  z,
int  e 
)
overridevirtual

Implements BDSBH4DBase.

Definition at line 277 of file BDSBH4D.cc.

◆ Reset_BDSBH4D()

template<class T >
void BDSBH4D< T >::Reset_BDSBH4D
overridevirtual

Implements BDSBH4DBase.

Definition at line 160 of file BDSBH4D.cc.

◆ Set_BDSBH4D()

template<class T >
void BDSBH4D< T >::Set_BDSBH4D ( int  x,
int  y,
int  z,
int  e,
double  value 
)
overridevirtual

Implements BDSBH4DBase.

Definition at line 184 of file BDSBH4D.cc.

◆ SetError_BDSBH4D()

template<class T >
void BDSBH4D< T >::SetError_BDSBH4D ( int  x,
int  y,
int  z,
int  e,
double  value 
)
overridevirtual

Implements BDSBH4DBase.

Definition at line 194 of file BDSBH4D.cc.

Field Documentation

◆ h

template<class T >
T BDSBH4D< T >::h

Definition at line 56 of file BDSBH4D.hh.

◆ h_err

template<class T >
T BDSBH4D< T >::h_err

Definition at line 57 of file BDSBH4D.hh.


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