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

Specification for 2D histogram. More...

#include <HistogramDef2D.hh>

Inheritance diagram for HistogramDef2D:
Inheritance graph
Collaboration diagram for HistogramDef2D:
Collaboration graph

Public Member Functions

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

Author
L. Nevay

Definition at line 34 of file HistogramDef2D.hh.

Constructor & Destructor Documentation

◆ HistogramDef2D()

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

Definition at line 30 of file HistogramDef2D.cc.

◆ ~HistogramDef2D()

HistogramDef2D::~HistogramDef2D ( )
virtual

Definition at line 43 of file HistogramDef2D.cc.

Member Function Documentation

◆ Clone()

virtual HistogramDef * HistogramDef2D::Clone ( ) const
inlinevirtual

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

Reimplemented from HistogramDef1D.

Reimplemented in HistogramDef3D.

Definition at line 52 of file HistogramDef2D.hh.

References HistogramDef2D().

Here is the call graph for this function:

◆ GetBinningString()

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

Return n bins and ranges.

Reimplemented from HistogramDef1D.

Reimplemented in HistogramDef3D, and HistogramDef4D.

Definition at line 46 of file HistogramDef2D.cc.

References BinSpecification::GetBinString().

Here is the call graph for this function:

◆ GetHistogramString()

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

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

Reimplemented from HistogramDef1D.

Reimplemented in HistogramDef3D, and HistogramDef4D.

Definition at line 53 of file HistogramDef2D.cc.

References BinSpecification::GetLogString().

Here is the call graph for this function:

Field Documentation

◆ yBinning

BinSpecification HistogramDef2D::yBinning

Definition at line 60 of file HistogramDef2D.hh.


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