BDSIM
BDSIM is a Geant4 extension toolkit for simulation of particle transport in accelerator beamlines.
Loading...
Searching...
No Matches
Public Member Functions | Data Fields
BDSBH4DBase Class Referenceabstract

Base class for the 4D histogram classes. More...

#include <BDSBH4DBase.hh>

Inheritance diagram for BDSBH4DBase:
Inheritance graph
Collaboration diagram for BDSBH4DBase:
Collaboration graph

Public Member Functions

 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

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

Base class for the 4D histogram classes.

Author
Eliott Ramoisiaux

Definition at line 36 of file BDSBH4DBase.hh.

Constructor & Destructor Documentation

◆ BDSBH4DBase() [1/2]

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.

Definition at line 41 of file BDSBH4DBase.cc.

◆ BDSBH4DBase() [2/2]

BDSBH4DBase::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.

Definition at line 59 of file BDSBH4DBase.cc.

Member Function Documentation

◆ GetEntries_BDSBH4D()

unsigned long BDSBH4DBase::GetEntries_BDSBH4D ( )

Definition at line 114 of file BDSBH4DBase.cc.

◆ GetName()

const char * BDSBH4DBase::GetName ( ) const
override

Definition at line 104 of file BDSBH4DBase.cc.

◆ GetNbinsE()

int BDSBH4DBase::GetNbinsE ( ) const

Definition at line 99 of file BDSBH4DBase.cc.

◆ GetNbinsX()

int BDSBH4DBase::GetNbinsX ( ) const
final

Definition at line 84 of file BDSBH4DBase.cc.

◆ GetNbinsY()

int BDSBH4DBase::GetNbinsY ( ) const
final

Definition at line 89 of file BDSBH4DBase.cc.

◆ GetNbinsZ()

int BDSBH4DBase::GetNbinsZ ( ) const
final

Definition at line 94 of file BDSBH4DBase.cc.

◆ GetTitle()

const char * BDSBH4DBase::GetTitle ( ) const
override

Definition at line 109 of file BDSBH4DBase.cc.

◆ SetEntries_BDSBH4D()

void BDSBH4DBase::SetEntries_BDSBH4D ( double  i)

Definition at line 129 of file BDSBH4DBase.cc.

◆ SetName()

void BDSBH4DBase::SetName ( const char *  name)
override

Definition at line 119 of file BDSBH4DBase.cc.

◆ SetTitle()

void BDSBH4DBase::SetTitle ( const char *  title)
override

Definition at line 124 of file BDSBH4DBase.cc.

Field Documentation

◆ h_ebinsedges

std::vector<double> BDSBH4DBase::h_ebinsedges

Definition at line 100 of file BDSBH4DBase.hh.

◆ h_emax

double BDSBH4DBase::h_emax

Definition at line 96 of file BDSBH4DBase.hh.

◆ h_emin

double BDSBH4DBase::h_emin

Definition at line 95 of file BDSBH4DBase.hh.

◆ h_entries

unsigned long BDSBH4DBase::h_entries

Definition at line 101 of file BDSBH4DBase.hh.

◆ h_escale

std::string BDSBH4DBase::h_escale

Definition at line 99 of file BDSBH4DBase.hh.

◆ h_name

std::string BDSBH4DBase::h_name

Definition at line 97 of file BDSBH4DBase.hh.

◆ h_nebins

unsigned int BDSBH4DBase::h_nebins

Definition at line 88 of file BDSBH4DBase.hh.

◆ h_nxbins

unsigned int BDSBH4DBase::h_nxbins

Definition at line 85 of file BDSBH4DBase.hh.

◆ h_nybins

unsigned int BDSBH4DBase::h_nybins

Definition at line 86 of file BDSBH4DBase.hh.

◆ h_nzbins

unsigned int BDSBH4DBase::h_nzbins

Definition at line 87 of file BDSBH4DBase.hh.

◆ h_title

std::string BDSBH4DBase::h_title

Definition at line 98 of file BDSBH4DBase.hh.

◆ h_xmax

double BDSBH4DBase::h_xmax

Definition at line 90 of file BDSBH4DBase.hh.

◆ h_xmin

double BDSBH4DBase::h_xmin

Definition at line 89 of file BDSBH4DBase.hh.

◆ h_ymax

double BDSBH4DBase::h_ymax

Definition at line 92 of file BDSBH4DBase.hh.

◆ h_ymin

double BDSBH4DBase::h_ymin

Definition at line 91 of file BDSBH4DBase.hh.

◆ h_zmax

double BDSBH4DBase::h_zmax

Definition at line 94 of file BDSBH4DBase.hh.

◆ h_zmin

double BDSBH4DBase::h_zmin

Definition at line 93 of file BDSBH4DBase.hh.


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