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

Analysis of the options tree. More...

#include <OptionsAnalysis.hh>

Inheritance diagram for OptionsAnalysis:
Inheritance graph
Collaboration diagram for OptionsAnalysis:
Collaboration graph

Public Member Functions

 OptionsAnalysis ()
 
 OptionsAnalysis (Options *optionsIn, TChain *chain, bool perEntryAnalysis=true, bool debugIn=false)
 Constructor intended for use to construct an options analysis object.
 
virtual void Process ()
 Operate on each entry in the options tree.
 
- Public Member Functions inherited from Analysis
 Analysis (const std::string &treeNameIn, TChain *chainIn, const std::string &mergedHistogramNameIn, bool perEntryAnalysis=true, bool debugIn=false)
 
virtual void Execute ()
 Method which calls all other methods in order.
 
virtual void Process ()=0
 
virtual void UserProcess ()
 Virtual function for user to overload and use. Does nothing by default.
 
virtual void SimpleHistograms ()
 Process histogram definitions from configuration instance.
 
void PreparePerEntryHistograms ()
 Create structures necessary for per entry histograms.
 
void AccumulatePerEntryHistograms (long int entryNumber)
 Accumulate means and variances for per entry histograms.
 
void TerminatePerEntryHistograms ()
 Prepare result of per entry histogram accumulation.
 
virtual void Terminate ()
 
virtual void Write (TFile *outputFile)
 Write rebdsim histograms.
 

Protected Member Functions

 ClassDef (OptionsAnalysis, 1)
 
- Protected Member Functions inherited from Analysis
void FillHistogram (HistogramDef *definition, std::vector< TH1 * > *outputHistograms=nullptr)
 Create an individual histogram based on a definition.
 

Protected Attributes

Optionsoptions
 Options object that data loaded from the file will be loaded into.
 
- Protected Attributes inherited from Analysis
std::string treeName
 
TChain * chain
 
std::string mergedHistogramName
 Name of directory for merged histograms.
 
std::vector< TH1 * > simpleHistograms
 
std::vector< PerEntryHistogram * > perEntryHistograms
 
HistogramMeanFromFilehistoSum
 Merge of per event stored histograms.
 
bool debug
 Whether debug print out is used or not.
 
long int entries
 Number of entries in the chain.
 
bool perEntry
 Whether to analyse each entry in the tree in a for loop or not.
 

Detailed Description

Analysis of the options tree.

Author
Stuart Walker.

Definition at line 35 of file OptionsAnalysis.hh.

Constructor & Destructor Documentation

◆ OptionsAnalysis() [1/2]

OptionsAnalysis::OptionsAnalysis ( )

The default constructor is not intended for use and will not work for the purpose of analysis. It is required by the ROOT C++ reflection system in case you wish to save the object.

◆ OptionsAnalysis() [2/2]

OptionsAnalysis::OptionsAnalysis ( Options optionsIn,
TChain *  chain,
bool  perEntryAnalysis = true,
bool  debugIn = false 
)

Constructor intended for use to construct an options analysis object.

Definition at line 29 of file OptionsAnalysis.cc.

◆ ~OptionsAnalysis()

OptionsAnalysis::~OptionsAnalysis ( )
virtualnoexcept

Definition at line 37 of file OptionsAnalysis.cc.

Member Function Documentation

◆ Process()

void OptionsAnalysis::Process ( )
virtual

Operate on each entry in the options tree.

Implements Analysis.

Definition at line 40 of file OptionsAnalysis.cc.

References Analysis::AccumulatePerEntryHistograms(), and Analysis::entries.

Here is the call graph for this function:

Field Documentation

◆ options

Options* OptionsAnalysis::options
protected

Options object that data loaded from the file will be loaded into.

Definition at line 55 of file OptionsAnalysis.hh.


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