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

eventAnalysis module for storing the truth information for primary vertices in events More...

#include <TTruthVerticesModule.hxx>

+ Inheritance diagram for ND::TTruthVerticesModule:
+ Collaboration diagram for ND::TTruthVerticesModule:

Classes

class  TTruthVertex
 Class used by the Truth Vertices Module to store information relating to an individual true primary vertex. More...
 

Public Member Functions

 TTruthVerticesModule (const char *name="Vertices", const char *title="True Primary Vertex information")
 
virtual ~TTruthVerticesModule ()
 
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 *)
 
virtual bool FillTree (ND::TND280Event &)
 Fill all the stuff that goes in the output tree. More...
 
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 void InitializeBranches ()
 Initialize Branches. Don't do anything else in this function. More...
 
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 &)
 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

Int_t fNVtx
 The total number of vertices recorded. More...
 
Int_t fNVtxBrlECal
 The number of vertices recorded in the Barrel ECal. More...
 
Int_t fNVtxDsECal
 The number of vertices recorded in the Downstream ECal. More...
 
Int_t fNVtxFGD1
 The number of vertices recorded in FGD 1. More...
 
Int_t fNVtxFGD2
 The number of vertices recorded in FGD 2. More...
 
Int_t fNVtxINGRID
 The number of vertices recorded in INGRID. More...
 
Int_t fNVtxOther
 The number of vertices recorded anywhere which does not fall into the other available categories. More...
 
Int_t fNVtxP0D
 The number of vertices recorded in the P0D. More...
 
Int_t fNVtxP0DECal
 The number of vertices recorded in the P0D ECal. More...
 
Int_t fNVtxRestOfOffAxis
 The number of vertices recorded in the rest of the off-axis detector. More...
 
Int_t fNVtxSFG
 The number of vertices recorded in SFG. More...
 
Int_t fNVtxSMRD
 The number of vertices recorded in the SMRD. More...
 
Int_t fNVtxTPC1
 The number of vertices recorded in TPC 1. More...
 
Int_t fNVtxTPC2
 The number of vertices recorded in TPC 2. More...
 
Int_t fNVtxTPC3
 The number of vertices recorded in TPC 3. More...
 
TClonesArray * fVertices
 The TClonesArray storing the TTruthVertex objects holding the information relating to each vertex. More...
 

Protected Types

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

Protected Member Functions

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

Bool_t IsGeantinoVtx (ND::TG4PrimaryVertex vtx)
 

Private Attributes

const unsigned int fMaxNVertices
 The maximum number of vertices that the module will be saved in a single event. More...
 

Detailed Description

eventAnalysis module for storing the truth information for primary vertices in events

Definition at line 35 of file TTruthVerticesModule.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::TTruthVerticesModule::TTruthVerticesModule ( const char *  name = "Vertices",
const char *  title = "True Primary Vertex information" 
)
ND::TTruthVerticesModule::~TTruthVerticesModule ( )
virtual

Definition at line 49 of file TTruthVerticesModule.cxx.

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::TTruthVerticesModule::FillTree ( ND::TND280Event &  )
virtual

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!)

Fill primary particle trajectory information. These are particles leaving the vertex.

Implements ND::TAnalysisModuleBase.

Definition at line 83 of file TTruthVerticesModule.cxx.

References ND::TTruthVerticesModule::TTruthVertex::Fiducial, ND::TTruthVerticesModule::TTruthVertex::Generator, ND::TTruthVerticesModule::TTruthVertex::ID, IsGeantinoVtx(), eventAnalysisEnums::kBrlECalBottom, eventAnalysisEnums::kBrlECalLeft, eventAnalysisEnums::kBrlECalRight, eventAnalysisEnums::kBrlECalTop, eventAnalysisEnums::kDsECal, eventAnalysisEnums::kFGD1, eventAnalysisEnums::kFGD2, eventAnalysisEnums::kINGRID, eventAnalysisEnums::kOffAxis, eventAnalysisEnums::kP0D, eventAnalysisEnums::kP0DECalBottom, eventAnalysisEnums::kP0DECalLeft, eventAnalysisEnums::kP0DECalRight, eventAnalysisEnums::kP0DECalTop, eventAnalysisEnums::kSFG, eventAnalysisEnums::kSMRD, eventAnalysisEnums::kTPC1, eventAnalysisEnums::kTPC2, eventAnalysisEnums::kTPC3, ND::TTruthVerticesModule::TTruthVertex::NeutrinoMomentum, ND::TTruthVerticesModule::TTruthVertex::NeutrinoPDG, ND::TTruthVerticesModule::TTruthVertex::NPrimaryTraj, eventAnalysisEnums::PathToSubdetector(), ND::TTruthVerticesModule::TTruthVertex::Position, ND::TTruthVerticesModule::TTruthVertex::PrimaryTrajIDs, ND::TTruthVerticesModule::TTruthVertex::ReactionCode, ND::TTruthVerticesModule::TTruthVertex::Subdetector, ND::TTruthVerticesModule::TTruthVertex::TargetMomentum, and ND::TTruthVerticesModule::TTruthVertex::TargetPDG.

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::TAnalysisTruthModuleBase::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.

Definition at line 17 of file TAnalysisTruthModuleBase.hxx.

References ND::TAnalysisModuleBase::kTruth.

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

Definition at line 37 of file TAnalysisModuleBase.cxx.

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

void ND::TTruthVerticesModule::InitializeBranches ( )
virtual

Initialize Branches. Don't do anything else in this function.

Implements ND::TAnalysisModuleBase.

Definition at line 51 of file TTruthVerticesModule.cxx.

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::TTruthVerticesModule::IsEnabledByDefault ( ) const
virtual

Is the module is enabled by default.

Default is to enable module. To set to disable override this method in the derived module.

Reimplemented from ND::TAnalysisModuleBase.

Definition at line 43 of file TTruthVerticesModule.hxx.

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.

Bool_t ND::TTruthVerticesModule::IsGeantinoVtx ( ND::TG4PrimaryVertex  vtx)
private

Definition at line 333 of file TTruthVerticesModule.cxx.

Referenced by FillTree().

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::TTruthVerticesModule::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 75 of file TTruthVerticesModule.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

Int_t ND::TAnalysisModuleBase::fEventID
protectedinherited

Definition at line 198 of file TAnalysisModuleBase.hxx.

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
const unsigned int ND::TTruthVerticesModule::fMaxNVertices
private

The maximum number of vertices that the module will be saved in a single event.

Definition at line 53 of file TTruthVerticesModule.hxx.

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

Definition at line 203 of file TAnalysisModuleBase.hxx.

Int_t ND::TTruthVerticesModule::fNVtx

The total number of vertices recorded.

Definition at line 60 of file TTruthVerticesModule.hxx.

Int_t ND::TTruthVerticesModule::fNVtxBrlECal

The number of vertices recorded in the Barrel ECal.

Definition at line 78 of file TTruthVerticesModule.hxx.

Int_t ND::TTruthVerticesModule::fNVtxDsECal

The number of vertices recorded in the Downstream ECal.

Definition at line 75 of file TTruthVerticesModule.hxx.

Int_t ND::TTruthVerticesModule::fNVtxFGD1

The number of vertices recorded in FGD 1.

Definition at line 63 of file TTruthVerticesModule.hxx.

Int_t ND::TTruthVerticesModule::fNVtxFGD2

The number of vertices recorded in FGD 2.

Definition at line 66 of file TTruthVerticesModule.hxx.

Int_t ND::TTruthVerticesModule::fNVtxINGRID

The number of vertices recorded in INGRID.

Definition at line 99 of file TTruthVerticesModule.hxx.

Int_t ND::TTruthVerticesModule::fNVtxOther

The number of vertices recorded anywhere which does not fall into the other available categories.

Definition at line 102 of file TTruthVerticesModule.hxx.

Int_t ND::TTruthVerticesModule::fNVtxP0D

The number of vertices recorded in the P0D.

Definition at line 72 of file TTruthVerticesModule.hxx.

Int_t ND::TTruthVerticesModule::fNVtxP0DECal

The number of vertices recorded in the P0D ECal.

Definition at line 81 of file TTruthVerticesModule.hxx.

Int_t ND::TTruthVerticesModule::fNVtxRestOfOffAxis

The number of vertices recorded in the rest of the off-axis detector.

Definition at line 96 of file TTruthVerticesModule.hxx.

Int_t ND::TTruthVerticesModule::fNVtxSFG

The number of vertices recorded in SFG.

Definition at line 69 of file TTruthVerticesModule.hxx.

Int_t ND::TTruthVerticesModule::fNVtxSMRD

The number of vertices recorded in the SMRD.

Definition at line 93 of file TTruthVerticesModule.hxx.

Int_t ND::TTruthVerticesModule::fNVtxTPC1

The number of vertices recorded in TPC 1.

Definition at line 84 of file TTruthVerticesModule.hxx.

Int_t ND::TTruthVerticesModule::fNVtxTPC2

The number of vertices recorded in TPC 2.

Definition at line 87 of file TTruthVerticesModule.hxx.

Int_t ND::TTruthVerticesModule::fNVtxTPC3

The number of vertices recorded in TPC 3.

Definition at line 90 of file TTruthVerticesModule.hxx.

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.

TClonesArray* ND::TTruthVerticesModule::fVertices

The TClonesArray storing the TTruthVertex objects holding the information relating to each vertex.

The array is sorted by the vertices ID number to enable more efficient retrieval by analysis tools.

Definition at line 104 of file TTruthVerticesModule.hxx.


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:04 for eventAnalysis by doxygen 1.8.5