star-travex
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | Private Attributes | List of all members
StiHifyPrgOptions Class Reference

Processes and controls user options provided in the command line. More...

#include <StiHifyPrgOptions.h>

Inheritance diagram for StiHifyPrgOptions:
PrgOptionProcessor

Public Member Functions

 StiHifyPrgOptions ()
 
 StiHifyPrgOptions (int argc, char **argv, const std::string &stiTreeName="t")
 
bool AcceptCandidateHit () const
 
bool SplitHistsByVolume () const
 
double GetHistZMin () const
 
double GetHistZMax () const
 
double GetHistYMin () const
 
double GetHistYMax () const
 
void SetHistZRange (double minZ, double maxZ)
 
void SetHistYRange (double minY, double maxY)
 
- Public Member Functions inherited from PrgOptionProcessor
 PrgOptionProcessor ()
 
 PrgOptionProcessor (int argc, char **argv, const std::string &stiTreeName="t")
 
 ~PrgOptionProcessor ()
 
std::string PathToStiTreeFile () const
 
std::string PathToGeometryFile () const
 
const std::set< std::string > & GetVolumeList () const
 
TChain * GetStiTChain ()
 
void ProcessOptions ()
 Takes the standard command line arguments and parses them with the boost program_options utility. More...
 
bool MatchedVolName (const std::string &volName) const
 Note that the function returns true when the internal list of regex'es formed by the user specified options is empty. More...
 

Private Attributes

bool fAcceptCandidateHit
 A flag to force closest candidate hit to be the accepted track node hit. More...
 
bool fSplitHistsByVolume
 A flag to produce separate histograms for each volume matching the regex. More...
 
double fHistZMin
 
double fHistZMax
 
double fHistYMin
 
double fHistYMax
 

Additional Inherited Members

- Protected Member Functions inherited from PrgOptionProcessor
void BuildInputChains ()
 
virtual void VerifyOptions ()
 
virtual void AddToInputChains (std::string stiTreeRootFileName)
 This private method takes a path to a valid ROOT file as input. More...
 
- Protected Attributes inherited from PrgOptionProcessor
std::string fGeomFilePath
 Full path to a ROOT file with TGeo geometry. More...
 
std::string fVolumeListFile
 Full path to a text file with Sti/TGeo volume names. More...
 
std::string fVolumePattern
 Regex pattern provided by the user in the command line. More...
 
std::set< std::string > fVolumeList
 A list of volume names to consider. More...
 
TChain * fStiTChain
 A (chained) TTree from the input file. More...
 

Detailed Description

Processes and controls user options provided in the command line.

Definition at line 21 of file StiHifyPrgOptions.h.

Constructor & Destructor Documentation

StiHifyPrgOptions::StiHifyPrgOptions ( )

Definition at line 4 of file StiHifyPrgOptions.cxx.

StiHifyPrgOptions::StiHifyPrgOptions ( int  argc,
char **  argv,
const std::string &  stiTreeName = "t" 
)

Definition at line 7 of file StiHifyPrgOptions.cxx.

Member Function Documentation

bool StiHifyPrgOptions::AcceptCandidateHit ( ) const
inline

Definition at line 28 of file StiHifyPrgOptions.h.

double StiHifyPrgOptions::GetHistYMax ( ) const
inline

Definition at line 33 of file StiHifyPrgOptions.h.

double StiHifyPrgOptions::GetHistYMin ( ) const
inline

Definition at line 32 of file StiHifyPrgOptions.h.

double StiHifyPrgOptions::GetHistZMax ( ) const
inline

Definition at line 31 of file StiHifyPrgOptions.h.

double StiHifyPrgOptions::GetHistZMin ( ) const
inline

Definition at line 30 of file StiHifyPrgOptions.h.

void StiHifyPrgOptions::SetHistYRange ( double  minY,
double  maxY 
)
inline

Definition at line 35 of file StiHifyPrgOptions.h.

void StiHifyPrgOptions::SetHistZRange ( double  minZ,
double  maxZ 
)
inline

Definition at line 34 of file StiHifyPrgOptions.h.

bool StiHifyPrgOptions::SplitHistsByVolume ( ) const
inline

Definition at line 29 of file StiHifyPrgOptions.h.

Member Data Documentation

bool StiHifyPrgOptions::fAcceptCandidateHit
private

A flag to force closest candidate hit to be the accepted track node hit.

Definition at line 40 of file StiHifyPrgOptions.h.

double StiHifyPrgOptions::fHistYMax
private

Definition at line 48 of file StiHifyPrgOptions.h.

double StiHifyPrgOptions::fHistYMin
private

Definition at line 47 of file StiHifyPrgOptions.h.

double StiHifyPrgOptions::fHistZMax
private

Definition at line 46 of file StiHifyPrgOptions.h.

double StiHifyPrgOptions::fHistZMin
private

Definition at line 45 of file StiHifyPrgOptions.h.

bool StiHifyPrgOptions::fSplitHistsByVolume
private

A flag to produce separate histograms for each volume matching the regex.

Definition at line 43 of file StiHifyPrgOptions.h.


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