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

Specification for 1D histogram. More...

#include <HistogramDef1D.hh>

Inheritance diagram for HistogramDef1D:
Inheritance graph
Collaboration diagram for HistogramDef1D:
Collaboration graph

Public Member Functions

 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 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 1D histogram.

Author
L. Nevay

Definition at line 34 of file HistogramDef1D.hh.

Constructor & Destructor Documentation

◆ HistogramDef1D()

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

Definition at line 30 of file HistogramDef1D.cc.

◆ ~HistogramDef1D()

HistogramDef1D::~HistogramDef1D ( )
virtual

Definition at line 40 of file HistogramDef1D.cc.

Member Function Documentation

◆ Clone()

virtual HistogramDef * HistogramDef1D::Clone ( ) const
inlinevirtual

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

Implements HistogramDef.

Reimplemented in HistogramDef2D, and HistogramDef3D.

Definition at line 51 of file HistogramDef1D.hh.

References HistogramDef1D().

Here is the call graph for this function:

◆ GetBinningString()

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

Return n bins and ranges.

Implements HistogramDef.

Reimplemented in HistogramDef2D, HistogramDef3D, and HistogramDef4D.

Definition at line 43 of file HistogramDef1D.cc.

References BinSpecification::GetBinString().

Here is the call graph for this function:

◆ GetHistogramString()

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

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

Implements HistogramDef.

Reimplemented in HistogramDef2D, HistogramDef3D, and HistogramDef4D.

Definition at line 49 of file HistogramDef1D.cc.

Field Documentation

◆ xBinning

BinSpecification HistogramDef1D::xBinning

Definition at line 59 of file HistogramDef1D.hh.


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