StiScanPrgOptions Class Reference

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

#include <StiScanPrgOptions.h>

Inheritance diagram for StiScanPrgOptions:

Public Member Functions
	StiScanPrgOptions ()
	StiScanPrgOptions (int argc, char **argv, const std::string &stiTreeName="t", const std::string &geantStepTreeName="stepping")
	~StiScanPrgOptions ()
bool	DoGeantStepTree () const
bool	DoAutoHistRange () const
TChain *	GetGeantStepChain ()
double	GetHistZMin () const
double	GetHistZMax () const
double	GetHistRMin () const
double	GetHistRMax () const
void	SetHistZRange (double minZ, double maxZ)
void	SetHistRMax (double maxR)
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...

Protected Member Functions
virtual void	VerifyOptions ()
virtual void	AddToInputChains (std::string stiTreeRootFileName)
Protected Member Functions inherited from PrgOptionProcessor
void	BuildInputChains ()

Protected Attributes
bool	fDoGeantStepTree
	A flag to process geant tree if set. More...
bool	fDoAutoHistRange
	A flag to find optimal range for histogram axises automatically. More...
TChain *	fGeantStepChain
double	fHistZMin
double	fHistZMax
double	fHistRMin
double	fHistRMax
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 24 of file StiScanPrgOptions.h.

Constructor & Destructor Documentation

StiScanPrgOptions::StiScanPrgOptions

(

)

Definition at line 10 of file StiScanPrgOptions.cxx.

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

Definition at line 13 of file StiScanPrgOptions.cxx.

StiScanPrgOptions::~StiScanPrgOptions

(

)

Definition at line 29 of file StiScanPrgOptions.cxx.

Member Function Documentation

void StiScanPrgOptions::AddToInputChains ( std::string  stiTreeRootFileName )

protectedvirtual

This private method takes a path to a valid ROOT file as input. No check is done to make sure the input chains exist.

XXX: Need to add a check to validate the tree in the file.

Reimplemented from PrgOptionProcessor.

Definition at line 53 of file StiScanPrgOptions.cxx.

bool StiScanPrgOptions::DoAutoHistRange ( ) const

inline

Definition at line 33 of file StiScanPrgOptions.h.

bool StiScanPrgOptions::DoGeantStepTree ( ) const

inline

Definition at line 32 of file StiScanPrgOptions.h.

TChain* StiScanPrgOptions::GetGeantStepChain ( )

inline

Definition at line 34 of file StiScanPrgOptions.h.

double StiScanPrgOptions::GetHistRMax ( ) const

inline

Definition at line 38 of file StiScanPrgOptions.h.

double StiScanPrgOptions::GetHistRMin ( ) const

inline

Definition at line 37 of file StiScanPrgOptions.h.

double StiScanPrgOptions::GetHistZMax ( ) const

inline

Definition at line 36 of file StiScanPrgOptions.h.

double StiScanPrgOptions::GetHistZMin ( ) const

inline

Definition at line 35 of file StiScanPrgOptions.h.

void StiScanPrgOptions::SetHistRMax ( double  maxR )

inline

Definition at line 40 of file StiScanPrgOptions.h.

void StiScanPrgOptions::SetHistZRange ( double  minZ, double  maxZ  )

inline

Definition at line 39 of file StiScanPrgOptions.h.

void StiScanPrgOptions::VerifyOptions ( )

protectedvirtual

Reimplemented from PrgOptionProcessor.

Definition at line 35 of file StiScanPrgOptions.cxx.

Member Data Documentation

bool StiScanPrgOptions::fDoAutoHistRange

protected

A flag to find optimal range for histogram axises automatically.

Definition at line 48 of file StiScanPrgOptions.h.

bool StiScanPrgOptions::fDoGeantStepTree

protected

A flag to process geant tree if set.

Definition at line 47 of file StiScanPrgOptions.h.

TChain* StiScanPrgOptions::fGeantStepChain

protected

Definition at line 49 of file StiScanPrgOptions.h.

double StiScanPrgOptions::fHistRMax

protected

Definition at line 53 of file StiScanPrgOptions.h.

double StiScanPrgOptions::fHistRMin

protected

Definition at line 52 of file StiScanPrgOptions.h.

double StiScanPrgOptions::fHistZMax

protected

Definition at line 51 of file StiScanPrgOptions.h.

double StiScanPrgOptions::fHistZMin

protected

Definition at line 50 of file StiScanPrgOptions.h.

---

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

• StiScan/StiScanPrgOptions.h
• StiScan/StiScanPrgOptions.cxx