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

Specification for 3D Histogram. More...

#include <HistogramDef3D.hh>

Inheritance diagram for HistogramDef3D:
Inheritance graph
Collaboration diagram for HistogramDef3D:
Collaboration graph

Public Member Functions

 HistogramDef3D ()
 Public constructor only for compatibility with ROOT - not intended for use.
 
 HistogramDef3D (const std::string &treeNameIn, const std::string &histNameIn, const BinSpecification &xBinningIn, const BinSpecification &yBinningIn, const BinSpecification &zBinningIn, const std::string &variableIn, const std::string &selectionIn="1", bool perEntryIn=true)
 Use this constructor.
 
virtual HistogramDefClone () const
 Copy this instance. Virtual to be overridden in derived classes.
 
virtual std::string GetBinningString () const
 Return n bins and ranges.
 
virtual std::string GetHistogramString () const
 Get the first string that defines the histogram in rebdsim for feedback.
 
 ClassDef (HistogramDef3D, 1)
 
- Public Member Functions inherited from HistogramDef2D
 HistogramDef2D ()
 Public constructor only for compatibility with ROOT - not intended for use.
 
 HistogramDef2D (const std::string &treeNameIn, const std::string &histNameIn, const BinSpecification &xBinningIn, const BinSpecification &yBinningIn, const std::string &variableIn, const std::string &selectionIn="1", bool perEntryIn=true)
 Use this constructor.
 
virtual HistogramDefClone () const
 Copy this instance. Virtual to be overridden in derived classes.
 
virtual std::string GetBinningString () const
 Return n bins and ranges.
 
virtual std::string GetHistogramString () const
 Get the first string that defines the histogram in rebdsim for feedback.
 
 ClassDef (HistogramDef2D, 1)
 
- Public Member Functions inherited from HistogramDef1D
 HistogramDef1D ()
 Public constructor only for compatibility with ROOT - not intended for use.
 
 HistogramDef1D (const std::string &treeNameIn, const std::string &histNameIn, const BinSpecification &xBinningIn, const std::string &variableIn, const std::string &selectionIn="1", bool perEntryIn=true)
 Use this constructor.
 
virtual HistogramDefClone () const
 Copy this instance. Virtual to be overridden in derived classes.
 
virtual std::string GetBinningString () const
 Return n bins and ranges.
 
virtual std::string GetHistogramString () const
 Get the first string that defines the histogram in rebdsim for feedback.
 
 ClassDef (HistogramDef1D, 1)
 
- Public Member Functions inherited from HistogramDef
 HistogramDef ()
 Public constructor only for compatibility with ROOT - not intended for use.
 
 HistogramDef (const std::string &treeNameIn, const std::string &histNameIn, int nDimensionsIn, const std::string &variable, const std::string &selectionIn="1", bool perEnetry=true)
 Use this constructor.
 
virtual HistogramDefClone () const =0
 Copy this instance. Virtual to be overridden in derived classes.
 
virtual std::string GetBinningString () const =0
 Provide the binning string in the original input format for feedback.
 
virtual std::string GetHistogramString () const =0
 Get the first string that defines the histogram in rebdsim for feedback.
 
 ClassDef (HistogramDef, 1)
 

Data Fields

BinSpecification zBinning
 
- Data Fields inherited from HistogramDef2D
BinSpecification yBinning
 
- Data Fields inherited from HistogramDef1D
BinSpecification xBinning
 
- Data Fields inherited from HistogramDef
std::string treeName
 
std::string histName
 
int nDimensions
 
std::string variable
 
std::string selection
 
bool perEntry
 

Detailed Description

Specification for 3D Histogram.

Author
L. Nevay

Definition at line 34 of file HistogramDef3D.hh.

Constructor & Destructor Documentation

◆ HistogramDef3D()

HistogramDef3D::HistogramDef3D ( const std::string &  treeNameIn,
const std::string &  histNameIn,
const BinSpecification xBinningIn,
const BinSpecification yBinningIn,
const BinSpecification zBinningIn,
const std::string &  variableIn,
const std::string &  selectionIn = "1",
bool  perEntryIn = true 
)

Use this constructor.

Definition at line 30 of file HistogramDef3D.cc.

◆ ~HistogramDef3D()

HistogramDef3D::~HistogramDef3D ( )
virtual

Definition at line 44 of file HistogramDef3D.cc.

Member Function Documentation

◆ Clone()

virtual HistogramDef * HistogramDef3D::Clone ( ) const
inlinevirtual

Copy this instance. Virtual to be overridden in derived classes.

Reimplemented from HistogramDef2D.

Definition at line 53 of file HistogramDef3D.hh.

References HistogramDef3D().

Here is the call graph for this function:

◆ GetBinningString()

std::string HistogramDef3D::GetBinningString ( ) const
virtual

Return n bins and ranges.

Reimplemented from HistogramDef2D.

Reimplemented in HistogramDef4D.

Definition at line 47 of file HistogramDef3D.cc.

References BinSpecification::GetBinString().

Here is the call graph for this function:

◆ GetHistogramString()

std::string HistogramDef3D::GetHistogramString ( ) const
virtual

Get the first string that defines the histogram in rebdsim for feedback.

Reimplemented from HistogramDef2D.

Reimplemented in HistogramDef4D.

Definition at line 54 of file HistogramDef3D.cc.

References BinSpecification::GetLogString().

Here is the call graph for this function:

Field Documentation

◆ zBinning

BinSpecification HistogramDef3D::zBinning

Definition at line 61 of file HistogramDef3D.hh.


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