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

Specification for a set of histograms. More...

#include <HistogramDefSet.hh>

Collaboration diagram for HistogramDefSet:
Collaboration graph

Public Types

enum class  writewhat {
  all , particles , ions , topN ,
  topNParticles , topNIons
}
 

Public Member Functions

 HistogramDefSet (const std::string &branchNameIn, const HistogramDef *baseDefinitionIn, const std::set< ParticleSpec > &particlesSpecs={}, const std::string &particleSpecificationIn="")
 
std::string RemoveSubString (const std::string &stringIn, const std::string &wordToRemove) const
 Remove a substring from a string.
 

Static Public Member Functions

static std::string AddPDGFilterToSelection (const ParticleSpec &particleSpec, const std::string &selection, const std::string &branchName)
 

Data Fields

std::string branchName
 
HistogramDefbaseDefinition
 
std::map< ParticleSpec, HistogramDef * > definitions
 
std::vector< HistogramDef * > definitionsV
 Vector version for easy iteration.
 
bool dynamicallyStoreIons
 
bool dynamicallyStoreParticles
 Dynamically store all non-ions.
 
writewhat what
 
int topN
 

Friends

std::ostream & operator<< (std::ostream &out, const HistogramDefSet &s)
 

Detailed Description

Specification for a set of histograms.

Author
L. Nevay

Definition at line 35 of file HistogramDefSet.hh.

Member Enumeration Documentation

◆ writewhat

enum class HistogramDefSet::writewhat
strong

Definition at line 61 of file HistogramDefSet.hh.

Constructor & Destructor Documentation

◆ HistogramDefSet()

HistogramDefSet::HistogramDefSet ( const std::string &  branchNameIn,
const HistogramDef baseDefinitionIn,
const std::set< ParticleSpec > &  particlesSpecs = {},
const std::string &  particleSpecificationIn = "" 
)

Definition at line 30 of file HistogramDefSet.cc.

◆ ~HistogramDefSet()

HistogramDefSet::~HistogramDefSet ( )

Definition at line 113 of file HistogramDefSet.cc.

Member Function Documentation

◆ AddPDGFilterToSelection()

std::string HistogramDefSet::AddPDGFilterToSelection ( const ParticleSpec &  particleSpec,
const std::string &  selection,
const std::string &  branchName 
)
static

Definition at line 140 of file HistogramDefSet.cc.

◆ RemoveSubString()

std::string HistogramDefSet::RemoveSubString ( const std::string &  stringIn,
const std::string &  wordToRemove 
) const

Remove a substring from a string.

Definition at line 120 of file HistogramDefSet.cc.

Friends And Related Function Documentation

◆ operator<<

std::ostream & operator<< ( std::ostream &  out,
const HistogramDefSet s 
)
friend

Definition at line 132 of file HistogramDefSet.cc.

Field Documentation

◆ baseDefinition

HistogramDef* HistogramDefSet::baseDefinition

Definition at line 55 of file HistogramDefSet.hh.

◆ branchName

std::string HistogramDefSet::branchName

Definition at line 54 of file HistogramDefSet.hh.

◆ definitions

std::map<ParticleSpec, HistogramDef*> HistogramDefSet::definitions

Definition at line 56 of file HistogramDefSet.hh.

◆ definitionsV

std::vector<HistogramDef*> HistogramDefSet::definitionsV

Vector version for easy iteration.

Definition at line 57 of file HistogramDefSet.hh.

Referenced by EventAnalysis::FillHistogram().

◆ dynamicallyStoreIons

bool HistogramDefSet::dynamicallyStoreIons

Definition at line 58 of file HistogramDefSet.hh.

◆ dynamicallyStoreParticles

bool HistogramDefSet::dynamicallyStoreParticles

Dynamically store all non-ions.

Definition at line 59 of file HistogramDefSet.hh.

◆ topN

int HistogramDefSet::topN

Definition at line 63 of file HistogramDefSet.hh.

◆ what

writewhat HistogramDefSet::what

Definition at line 62 of file HistogramDefSet.hh.


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