eventAnalysis  7.0-49-g0ac7482
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
ND::TFgdOnlyModule Class Reference

#include <TFgdOnlyModule.hxx>

+ Inheritance diagram for ND::TFgdOnlyModule:
+ Collaboration diagram for ND::TFgdOnlyModule:

Classes

class  TFgd2DCluster
 TFgd2DCluster The main object that contains information on clusters of hits after the 2D reconstruction stage of the FGD shower-based reconstruciton. More...
 
class  TFgd2DIsoTrack
 
class  TFgd3DIsoTrack
 
class  TFgd3DShowerHyp
 TFgd3DShowerHyp Information on a specific hypothesis of an FGD shower. More...
 
class  TFgd3DShowerPID
 TFgd3DShowerPID Information on an object reconstructed using the FGD shower-based reconstruction. More...
 

Public Member Functions

 TFgdOnlyModule (const char *name="FGDOnly", const char *title="FGD Only Recon Module")
 
virtual ~TFgdOnlyModule ()
 
virtual Bool_t Configure (std::string &option)
 A function that allows the module to be configured from an external class without any dependencies. More...
 
virtual void FillConfigTree (TTree *)
 
Int_t GetBufferSize ()
 ROOT output parameters, usually no need to touch. More...
 
std::string const GetCVSID () const
 
std::string const GetCVSTagName () const
 
std::string const GetDescription () const
 
std::string const GetDirectoryName () const
 Returns the name of the directory which the output of a particular module will be saved in. More...
 
char const * GetName ()
 
TTree const * GetOutputTree () const
 The output tree. More...
 
Int_t GetSplitLevel ()
 ROOT output parameters, usually no need to touch. More...
 
char const * GetTitle ()
 
virtual EType GetTreeType () const
 Returns the type of tree, header, truth, or recon. More...
 
void Initialize (TTree *tree)
 
virtual Bool_t IsEnabled () const
 Whether the module is enable or not. More...
 
virtual Bool_t IsEnabledByDefault () const
 Is the module is enabled by default. More...
 
virtual bool IsFullEventWorthSaving (ND::TND280Event &event)
 Whether the module thinks it is worth saving the entire oaEvent event tree entry for this event. More...
 
virtual Bool_t IsUsedForPreselection () const
 Whether the module should call IsFullEventWorthSaving() function for each event, to decide if the full oaEvent info for that event should be saved in the output. More...
 
void KillOutputTree ()
 
virtual void Print ()
 Prints a simple message describing the module. More...
 
virtual bool Process (ND::TND280Event &event)
 Gets the run and event IDs and calls FillTree with the event, and then actually calls fOutputTree->Fill. More...
 
virtual Bool_t ProcessFirstEvent (ND::TND280Event &event)
 Is called after the first event is loaded in. More...
 
virtual void SayAvailableOpts (std::string indent="")
 Subclasses should override this to let a user know what options are available. More...
 
void SetBufferSize (Int_t buffersize)
 ROOT output parameters, usually no need to touch. More...
 
virtual void SetDisabled ()
 Disables the module. More...
 
virtual void SetEnabled (Bool_t isenabled=true)
 Sets whether the module is enabled. More...
 
void SetInputDirectory (std::string dir)
 
void SetNameTitle (char const *name, char const *title)
 
void SetSplitLevel (Int_t splitlevel)
 ROOT output parameters, usually no need to touch. More...
 
virtual void SetUsedForPreselection (Bool_t isused=true)
 Sets whether the module should call IsFullEventWorthSaving() function for each event, to decide if the full oaEvent info for that event should be saved in the output. More...
 

Public Attributes

TClonesArray * f2DClustersXZ
 2D constituents of showers More...
 
TClonesArray * f2DClustersYZ
 2D constituents of showers More...
 
TClonesArray * f3DShowers
 Showers. More...
 
Int_t fN2DClustersXZ
 Number of 2D constituents of showers. More...
 
Int_t fN2DClustersYZ
 Number of 2D constituents of showers. More...
 
Int_t fN3DShowers
 Number of Showers. More...
 
Int_t * fNXYZTracks
 These tracks use only hits unused by the TPC+FGD fits. More...
 
Int_t * fNXYZTracksAllFGD
 All and only FGD hits used for these tracks. More...
 
Int_t * fNXZTracks
 These tracks use only hits unused by the TPC+FGD fits. More...
 
Int_t * fNXZTracksAllFGD
 All and only FGD hits used for these tracks. More...
 
Int_t * fNYZTracks
 These tracks use only hits unused by the TPC+FGD fits. More...
 
Int_t * fNYZTracksAllFGD
 All and only FGD hits used for these tracks. More...
 
TClonesArray ** fXYZTracks
 
TClonesArray ** fXYZTracksAllFGD
 
TClonesArray ** fXZTracks
 
TClonesArray ** fXZTracksAllFGD
 
TClonesArray ** fYZTracks
 
TClonesArray ** fYZTracksAllFGD
 

Protected Types

enum  EType {
  kHeader = 0, kTruth, kRecon, kLowLevel,
  kNTypes
}
 

Protected Member Functions

virtual bool FillTree (ND::TND280Event &)
 Fill all the stuff that goes in the output tree. More...
 
virtual void InitializeBranches ()
 Initialize Branches. Don't do anything else in this function. More...
 
virtual void InitializeModule ()
 Initialize Module, override if necessary. More...
 

Protected Attributes

Int_t fBufferSize
 Buffer Size for TBranch. More...
 
std::string fCVSID
 Defined if an official tagged version. More...
 
std::string fCVSTagName
 Defined if an official tagged version. More...
 
std::string fDescription
 A longish descrition of the analysis. More...
 
Int_t fEventID
 
Bool_t fFilledConfigTree
 
std::string fInputDirectory
 An input directory where analysis modules can search for extra files. More...
 
Bool_t fIsEnabled
 
Bool_t fIsMC
 
Bool_t fIsUsedForPreselection
 
std::string fName
 
TTree * fOutputTree
 
Int_t fPreselected
 
Int_t fRunID
 
Int_t fSplitLevel
 Split Level for TBranch. More...
 
Int_t fSubrunID
 
std::string fTitle
 

Private Member Functions

void Fill2DCluster (TFgd2DCluster *TempObject, ND::THandle< ND::TReconCluster > cluster)
 
void Fill2DIsoTrack (ND::THandle< ND::TReconTrack > tr, ND::THandle< ND::TTrackState > state, TFgd2DIsoTrack *isoTrack, char Axis)
 
void Fill3DIsoTrack (ND::THandle< ND::TReconTrack > tr, ND::THandle< ND::TTrackState > state, TFgd3DIsoTrack *isoTrack)
 
void Fill3DShower (TFgd3DShowerPID *TempObject, ND::THandle< ND::TReconPID > pid)
 
TFgd3DShowerHyp Fill3DShowerHyp (ND::THandle< ND::TReconPID > hyp)
 

Private Attributes

TFGDPid * fFGDPid
 
std::vector< const char * > fPids
 
std::vector< const char * > fTrackAlgorithms
 

Detailed Description

Definition at line 27 of file TFgdOnlyModule.hxx.

Member Enumeration Documentation

enum ND::TAnalysisModuleBase::EType
protectedinherited
Enumerator
kHeader 
kTruth 
kRecon 
kLowLevel 
kNTypes 

Definition at line 54 of file TAnalysisModuleBase.hxx.

Constructor & Destructor Documentation

ND::TFgdOnlyModule::~TFgdOnlyModule ( )
virtual

Definition at line 103 of file TFgdOnlyModule.cxx.

References fFGDPid.

Member Function Documentation

Bool_t ND::TAnalysisModuleBase::Configure ( std::string &  option)
virtualinherited

A function that allows the module to be configured from an external class without any dependencies.

Should be overridden with a function that responds to the string option, and returns true if configuration succedded. Used in TAnalysisLoop.cxx (and RunEventAnalysis.exe) for options of the form: -O TTruthTrajectoriesModule=SaveAll

Reimplemented in ND::TTrackerECALReconModule::OutputManager, ND::TGlobalReconModule, ND::TBeamSummaryDataModule, ND::TTruthTrajectoriesModule, ND::TBasicHeaderModule, and ND::TTagsModule.

Definition at line 17 of file TAnalysisModuleBase.cxx.

bool ND::TFgdOnlyModule::FillTree ( ND::TND280Event &  )
protectedvirtual

Fill all the stuff that goes in the output tree.

Return true if everything went well. Otherwise, the module may be disabled! (return definition changed Apr 2009!)

Implements ND::TAnalysisModuleBase.

Definition at line 197 of file TFgdOnlyModule.cxx.

References f2DClustersXZ, f2DClustersYZ, f3DShowers, Fill2DCluster(), Fill2DIsoTrack(), Fill3DIsoTrack(), Fill3DShower(), fN2DClustersXZ, fN2DClustersYZ, fN3DShowers, fNXYZTracks, fNXYZTracksAllFGD, fNXZTracks, fNXZTracksAllFGD, fNYZTracks, fNYZTracksAllFGD, fTrackAlgorithms, fXYZTracks, fXYZTracksAllFGD, fXZTracks, fXZTracksAllFGD, fYZTracks, and fYZTracksAllFGD.

Int_t ND::TAnalysisModuleBase::GetBufferSize ( )
inherited

ROOT output parameters, usually no need to touch.

Definition at line 123 of file TAnalysisModuleBase.hxx.

References ND::TAnalysisModuleBase::fBufferSize.

std::string const ND::TAnalysisModuleBase::GetCVSID ( ) const
inherited

Definition at line 136 of file TAnalysisModuleBase.hxx.

References ND::TAnalysisModuleBase::fCVSID.

std::string const ND::TAnalysisModuleBase::GetCVSTagName ( ) const
inherited

Definition at line 135 of file TAnalysisModuleBase.hxx.

References ND::TAnalysisModuleBase::fCVSTagName.

std::string const ND::TAnalysisModuleBase::GetDescription ( ) const
inherited

Definition at line 134 of file TAnalysisModuleBase.hxx.

References ND::TAnalysisModuleBase::fDescription.

std::string const ND::TAnalysisModuleBase::GetDirectoryName ( ) const
inherited

Returns the name of the directory which the output of a particular module will be saved in.

Definition at line 22 of file TAnalysisModuleBase.cxx.

Referenced by ND::TAnalysisLoop::Initialize().

TTree const* ND::TAnalysisModuleBase::GetOutputTree ( ) const
inherited

The output tree.

Definition at line 139 of file TAnalysisModuleBase.hxx.

References ND::TAnalysisModuleBase::fOutputTree.

Int_t ND::TAnalysisModuleBase::GetSplitLevel ( )
inherited

ROOT output parameters, usually no need to touch.

Definition at line 129 of file TAnalysisModuleBase.hxx.

References ND::TAnalysisModuleBase::fSplitLevel.

char const * ND::TAnalysisModuleBase::GetTitle ( )
inherited

Definition at line 118 of file TAnalysisModuleBase.cxx.

Referenced by ND::TAnalysisLoop::Initialize().

virtual EType ND::TAnalysisReconModuleBase::GetTreeType ( ) const
virtualinherited

Returns the type of tree, header, truth, or recon.

This is overridden in the derived base classes such as TAnalysisReconModuleBase, so users do not need to override it explicitly

Implements ND::TAnalysisModuleBase.

Reimplemented in ND::TP0DReconModule, and ND::TSFGReconModule.

Definition at line 17 of file TAnalysisReconModuleBase.hxx.

References ND::TAnalysisModuleBase::kRecon.

void ND::TAnalysisModuleBase::Initialize ( TTree *  tree)
inherited

Definition at line 37 of file TAnalysisModuleBase.cxx.

Referenced by ND::TAnalysisLoop::Initialize().

virtual void ND::TAnalysisModuleBase::InitializeModule ( )
protectedvirtualinherited
virtual Bool_t ND::TAnalysisModuleBase::IsEnabled ( ) const
virtualinherited

Whether the module is enable or not.

Definition at line 84 of file TAnalysisModuleBase.hxx.

References ND::TAnalysisModuleBase::fIsEnabled.

Referenced by ND::TAnalysisLoop::Initialize(), and ND::TAnalysisLoop::operator()().

virtual Bool_t ND::TAnalysisModuleBase::IsEnabledByDefault ( ) const
virtualinherited
bool ND::TAnalysisModuleBase::IsFullEventWorthSaving ( ND::TND280Event &  event)
virtualinherited

Whether the module thinks it is worth saving the entire oaEvent event tree entry for this event.

eventAnalysis can be used for event pre-selection in this way. Activated with the –oaEvent-preselection=<moduleclass>> command- line argument

Reimplemented in ND::TTrackerECALReconModule::OutputManager, ND::TReconPerformanceEvalModule, and ND::TTRExReconModule.

Definition at line 90 of file TAnalysisModuleBase.cxx.

virtual Bool_t ND::TAnalysisModuleBase::IsUsedForPreselection ( ) const
virtualinherited

Whether the module should call IsFullEventWorthSaving() function for each event, to decide if the full oaEvent info for that event should be saved in the output.

Definition at line 93 of file TAnalysisModuleBase.hxx.

References ND::TAnalysisModuleBase::fIsUsedForPreselection.

Referenced by ND::TAnalysisLoop::Initialize(), and ND::TAnalysisLoop::operator()().

void ND::TAnalysisModuleBase::KillOutputTree ( )
inherited

Definition at line 140 of file TAnalysisModuleBase.hxx.

References ND::TAnalysisModuleBase::fOutputTree.

void ND::TAnalysisModuleBase::Print ( )
virtualinherited

Prints a simple message describing the module.

Should be overridden for more detail

Definition at line 99 of file TAnalysisModuleBase.cxx.

Referenced by ND::TAnalysisLoop::Initialize().

bool ND::TAnalysisModuleBase::Process ( ND::TND280Event &  event)
virtualinherited

Gets the run and event IDs and calls FillTree with the event, and then actually calls fOutputTree->Fill.

Definition at line 77 of file TAnalysisModuleBase.cxx.

Referenced by ND::TAnalysisLoop::operator()().

Bool_t ND::TFgdOnlyModule::ProcessFirstEvent ( ND::TND280Event &  )
virtual

Is called after the first event is loaded in.

This is a good time to save persistent quantities in the module's data members, which will be retrievable from the eventAnalysis output file. Not intended for filling in the tree with the first event, as Process() will also be called.

Implements ND::TAnalysisModuleBase.

Definition at line 110 of file TFgdOnlyModule.cxx.

virtual void ND::TAnalysisModuleBase::SayAvailableOpts ( std::string  indent = "")
virtualinherited

Subclasses should override this to let a user know what options are available.

Reimplemented in ND::TTrackerECALReconModule::OutputManager, ND::TGlobalReconModule, ND::TTagsModule, and ND::TBasicHeaderModule.

Definition at line 156 of file TAnalysisModuleBase.hxx.

void ND::TAnalysisModuleBase::SetBufferSize ( Int_t  buffersize)
inherited

ROOT output parameters, usually no need to touch.

Definition at line 126 of file TAnalysisModuleBase.hxx.

References ND::TAnalysisModuleBase::fBufferSize.

virtual void ND::TAnalysisModuleBase::SetDisabled ( )
virtualinherited

Disables the module.

Is called when an exception is thrown inside the module.

Definition at line 74 of file TAnalysisModuleBase.hxx.

References ND::TAnalysisModuleBase::SetEnabled().

Referenced by ND::TAnalysisLoop::Initialize(), and ND::TAnalysisLoop::operator()().

virtual void ND::TAnalysisModuleBase::SetEnabled ( Bool_t  isenabled = true)
virtualinherited

Sets whether the module is enabled.

This only refer to modules which have been included for consideration by being instantiated in TAnalysisLoop.cxx or similar.

Definition at line 70 of file TAnalysisModuleBase.hxx.

References ND::TAnalysisModuleBase::fIsEnabled.

Referenced by ND::TAnalysisLoop::Initialize(), ND::TAnalysisModuleBase::SetDisabled(), and ND::TAnalysisLoop::SetOption().

void ND::TAnalysisModuleBase::SetInputDirectory ( std::string  dir)
inherited

Definition at line 158 of file TAnalysisModuleBase.hxx.

References ND::TAnalysisModuleBase::fInputDirectory.

void ND::TAnalysisModuleBase::SetSplitLevel ( Int_t  splitlevel)
inherited
virtual void ND::TAnalysisModuleBase::SetUsedForPreselection ( Bool_t  isused = true)
virtualinherited

Sets whether the module should call IsFullEventWorthSaving() function for each event, to decide if the full oaEvent info for that event should be saved in the output.

Definition at line 79 of file TAnalysisModuleBase.hxx.

References ND::TAnalysisModuleBase::fIsUsedForPreselection.

Referenced by ND::TAnalysisLoop::SetOption().

Member Data Documentation

TClonesArray* ND::TFgdOnlyModule::f2DClustersXZ

2D constituents of showers

Definition at line 266 of file TFgdOnlyModule.hxx.

Referenced by FillTree(), InitializeBranches(), and TFgdOnlyModule().

TClonesArray* ND::TFgdOnlyModule::f2DClustersYZ

2D constituents of showers

Definition at line 271 of file TFgdOnlyModule.hxx.

Referenced by FillTree(), InitializeBranches(), and TFgdOnlyModule().

TClonesArray* ND::TFgdOnlyModule::f3DShowers

Showers.

Definition at line 261 of file TFgdOnlyModule.hxx.

Referenced by FillTree(), InitializeBranches(), and TFgdOnlyModule().

Int_t ND::TAnalysisModuleBase::fEventID
protectedinherited

Definition at line 198 of file TAnalysisModuleBase.hxx.

TFGDPid* ND::TFgdOnlyModule::fFGDPid
private

Definition at line 276 of file TFgdOnlyModule.hxx.

Referenced by Fill3DIsoTrack(), TFgdOnlyModule(), and ~TFgdOnlyModule().

Bool_t ND::TAnalysisModuleBase::fFilledConfigTree
protectedinherited
std::string ND::TAnalysisModuleBase::fInputDirectory
protectedinherited

An input directory where analysis modules can search for extra files.

Definition at line 201 of file TAnalysisModuleBase.hxx.

Referenced by ND::TAnalysisModuleBase::SetInputDirectory().

Bool_t ND::TAnalysisModuleBase::fIsUsedForPreselection
protectedinherited
Int_t ND::TFgdOnlyModule::fN2DClustersXZ

Number of 2D constituents of showers.

Definition at line 264 of file TFgdOnlyModule.hxx.

Referenced by FillTree(), InitializeBranches(), and TFgdOnlyModule().

Int_t ND::TFgdOnlyModule::fN2DClustersYZ

Number of 2D constituents of showers.

Definition at line 269 of file TFgdOnlyModule.hxx.

Referenced by FillTree(), and InitializeBranches().

Int_t ND::TFgdOnlyModule::fN3DShowers

Number of Showers.

Definition at line 259 of file TFgdOnlyModule.hxx.

Referenced by FillTree(), InitializeBranches(), and TFgdOnlyModule().

std::string ND::TAnalysisModuleBase::fName
protectedinherited

Definition at line 203 of file TAnalysisModuleBase.hxx.

Int_t* ND::TFgdOnlyModule::fNXYZTracks

These tracks use only hits unused by the TPC+FGD fits.

Definition at line 243 of file TFgdOnlyModule.hxx.

Referenced by FillTree(), InitializeBranches(), and TFgdOnlyModule().

Int_t* ND::TFgdOnlyModule::fNXYZTracksAllFGD

All and only FGD hits used for these tracks.

Definition at line 255 of file TFgdOnlyModule.hxx.

Referenced by FillTree(), InitializeBranches(), and TFgdOnlyModule().

Int_t* ND::TFgdOnlyModule::fNXZTracks

These tracks use only hits unused by the TPC+FGD fits.

Definition at line 235 of file TFgdOnlyModule.hxx.

Referenced by FillTree(), InitializeBranches(), and TFgdOnlyModule().

Int_t* ND::TFgdOnlyModule::fNXZTracksAllFGD

All and only FGD hits used for these tracks.

Definition at line 247 of file TFgdOnlyModule.hxx.

Referenced by FillTree(), InitializeBranches(), and TFgdOnlyModule().

Int_t* ND::TFgdOnlyModule::fNYZTracks

These tracks use only hits unused by the TPC+FGD fits.

Definition at line 239 of file TFgdOnlyModule.hxx.

Referenced by FillTree(), InitializeBranches(), and TFgdOnlyModule().

Int_t* ND::TFgdOnlyModule::fNYZTracksAllFGD

All and only FGD hits used for these tracks.

Definition at line 251 of file TFgdOnlyModule.hxx.

Referenced by FillTree(), InitializeBranches(), and TFgdOnlyModule().

std::vector<const char*> ND::TFgdOnlyModule::fPids
private

Definition at line 275 of file TFgdOnlyModule.hxx.

Referenced by TFgdOnlyModule().

Int_t ND::TAnalysisModuleBase::fPreselected
protectedinherited

Definition at line 199 of file TAnalysisModuleBase.hxx.

Int_t ND::TAnalysisModuleBase::fRunID
protectedinherited

Definition at line 196 of file TAnalysisModuleBase.hxx.

Int_t ND::TAnalysisModuleBase::fSubrunID
protectedinherited

Definition at line 197 of file TAnalysisModuleBase.hxx.

std::string ND::TAnalysisModuleBase::fTitle
protectedinherited

Definition at line 204 of file TAnalysisModuleBase.hxx.

std::vector<const char*> ND::TFgdOnlyModule::fTrackAlgorithms
private

Definition at line 274 of file TFgdOnlyModule.hxx.

Referenced by FillTree(), InitializeBranches(), and TFgdOnlyModule().

TClonesArray** ND::TFgdOnlyModule::fXYZTracks

Definition at line 244 of file TFgdOnlyModule.hxx.

Referenced by FillTree(), InitializeBranches(), and TFgdOnlyModule().

TClonesArray** ND::TFgdOnlyModule::fXYZTracksAllFGD

Definition at line 256 of file TFgdOnlyModule.hxx.

Referenced by FillTree(), InitializeBranches(), and TFgdOnlyModule().

TClonesArray** ND::TFgdOnlyModule::fXZTracks

Definition at line 236 of file TFgdOnlyModule.hxx.

Referenced by FillTree(), InitializeBranches(), and TFgdOnlyModule().

TClonesArray** ND::TFgdOnlyModule::fXZTracksAllFGD

Definition at line 248 of file TFgdOnlyModule.hxx.

Referenced by FillTree(), InitializeBranches(), and TFgdOnlyModule().

TClonesArray** ND::TFgdOnlyModule::fYZTracks

Definition at line 240 of file TFgdOnlyModule.hxx.

Referenced by FillTree(), InitializeBranches(), and TFgdOnlyModule().

TClonesArray** ND::TFgdOnlyModule::fYZTracksAllFGD

Definition at line 252 of file TFgdOnlyModule.hxx.

Referenced by FillTree(), InitializeBranches(), and TFgdOnlyModule().


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

Package Summary
Package Name: eventAnalysis
Package Version: 7.0-49-g0ac7482
Package Manager:

Generated on Mon Mar 25 2024 14:44:01 for eventAnalysis by doxygen 1.8.5