eventAnalysis  7.0-49-g0ac7482
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
ND::TBasicHeaderModule Class Reference

An analysis module which carries some simple event-level header information. More...

#include <TBasicHeaderModule.hxx>

+ Inheritance diagram for ND::TBasicHeaderModule:
+ Collaboration diagram for ND::TBasicHeaderModule:

Public Member Functions

 TBasicHeaderModule (const char *name="BasicHeader", const char *title="Basic Header Module")
 For questions or suggestions about this module please contact the current responsible and CC in the eventAnalysis package manager. More...
 
virtual ~TBasicHeaderModule ()
 
Bool_t Configure (std::string &)
 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...
 
UInt_t GetEventTime ()
 
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 ()
 
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 ()
 
Bool_t P0DWaterStatus ()
 
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...
 
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

UInt_t fAlignmentId [5]
 Event Alignment SHA1 Hash (ID) The alignment identifier is a SHA1 hash code of the alignment constants plus a documentation string. More...
 
Double_t fCosmicPrescaleWeight
 MC event weighting to correct for differences between cosmic MC and data. More...
 
ULong64_t fCTMTriggerPattern [3]
 Contains the bit patterns from the cosmic trigger module. More...
 
UInt_t fEventTime
 Time of the relevant ND::TND280Event's last GPS pulse in Unix time. More...
 
Bool_t fFGDCosmicEvent
 FGD Cosmic trigger flag. More...
 
UInt_t fGeometryHash [5]
 Event Geometry SHA1 Hash (ID) More...
 
Bool_t fIsDetector
 Whether this is detector data. More...
 
Bool_t fIsMC
 Whether this is an MC event. More...
 
Bool_t fIsSand
 Whether this is a Sand Muon MC event. More...
 
Double_t fMagneticFieldStrength
 The magnetic field strength at the center of TPC1. More...
 
Float_t fMCIntensity
 MC "intensity", will be 0 if unused. More...
 
Bool_t fP0DWaterStatus
 Whether the P0D is filled with water or not. More...
 
Int_t fPartition
 The subdetector configuration in which the data was taken Valid values are defined in ND::TND280Context as. More...
 
std::string fSoftwareOverrideVersionString
 Holder for the Software Override Version String. More...
 
Char_t fSoftwareVersion [50]
 The software version string. More...
 
Int_t fSpill
 Event Spill number. More...
 
Int_t fTimeStamp
 The unix time stamp of the event context. More...
 
ULong64_t fTriggerWord
 Bits containing various information from the MCMs including event/spill numbers and trigger flags. More...
 
Bool_t fTripTCosmicEvent
 TRIP-t Cosmic trigger flag. More...
 
Int_t fTripTCosmicTriggerType
 TripT Cosmic Trigger type: trigger codes from 0-14, -1 means off. More...
 
Int_t fTripTCosmicTriggerUpward
 If cosmic muon is detmined to be upward going, 0 or 1. More...
 

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 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 Attributes

bool fFoundSoftwareVersion
 Whether we have found the version already, so no need to do it again. More...
 
bool fSoftware
 Whether we are saving the software version from $ND280ROOT. More...
 
Bool_t fSoftwareUseOverrideVersion
 Whether we are using a supplied software version. Will override fSoftware. More...
 

Detailed Description

An analysis module which carries some simple event-level header information.

It contains the RunID, EventNumber, and a TRef reference back to the original event file. The latter does not work at this time.

Definition at line 25 of file TBasicHeaderModule.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::TBasicHeaderModule::TBasicHeaderModule ( const char *  name = "BasicHeader",
const char *  title = "Basic Header Module" 
)

For questions or suggestions about this module please contact the current responsible and CC in the eventAnalysis package manager.

23-May-2014: Current responsible for this module is, Luke Pickering (lp208 [a*t] ic.ac.uk)

Definition at line 24 of file TBasicHeaderModule.cxx.

References CVSID, CVSTAG, ND::TAnalysisModuleBase::fCVSID, ND::TAnalysisModuleBase::fCVSTagName, ND::TAnalysisModuleBase::fDescription, ND::TAnalysisModuleBase::fIsEnabled, fSoftware, fSoftwareUseOverrideVersion, and ND::TAnalysisModuleBase::SetNameTitle().

ND::TBasicHeaderModule::~TBasicHeaderModule ( )
virtual

Definition at line 40 of file TBasicHeaderModule.cxx.

Member Function Documentation

Bool_t ND::TBasicHeaderModule::Configure ( std::string &  option)
virtual

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 from ND::TAnalysisModuleBase.

Definition at line 44 of file TBasicHeaderModule.cxx.

void ND::TAnalysisModuleBase::FillConfigTree ( TTree *  configTree)
virtualinherited

Reimplemented in ND::TGlobalReconModule, ND::TReconPerformanceEvalModule, ND::TTrackerReconModule, ND::TBeamSummaryDataModule, ND::TRooTrackerVtxModuleBase, ND::TGRooTrackerVtxModule, and ND::TNRooTrackerVtxModule.

Definition at line 52 of file TAnalysisModuleBase.cxx.

References CVSID.

Referenced by ND::TRooTrackerVtxModuleBase::FillConfigTree(), ND::TBeamSummaryDataModule::FillConfigTree(), ND::TTrackerReconModule::FillConfigTree(), ND::TReconPerformanceEvalModule::FillConfigTree(), ND::TGlobalReconModule::FillConfigTree(), and ND::TAnalysisLoop::Finalize().

bool ND::TBasicHeaderModule::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 153 of file TBasicHeaderModule.cxx.

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().

UInt_t ND::TBasicHeaderModule::GetEventTime ( )

Definition at line 44 of file TBasicHeaderModule.hxx.

References fEventTime.

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

Definition at line 114 of file TAnalysisModuleBase.cxx.

Referenced by ND::TTrackerReconModule::FillConfigTree(), ND::TGlobalReconModule::FillConfigTree(), ND::TTrackerECALReconModule::OutputManager::FillHoughTransformInformation(), ND::TAnalysisLoop::Finalize(), ND::TAnalysisLoop::Initialize(), and ND::TAnalysisLoop::operator()().

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().

EType ND::TAnalysisHeaderModuleBase::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 TAnalysisHeaderModuleBase.hxx.

References ND::TAnalysisModuleBase::kHeader.

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

Definition at line 37 of file TAnalysisModuleBase.cxx.

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

void ND::TBasicHeaderModule::InitializeBranches ( )
protectedvirtual

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

Implements ND::TAnalysisModuleBase.

Definition at line 113 of file TBasicHeaderModule.cxx.

virtual void ND::TAnalysisModuleBase::InitializeModule ( )
protectedvirtualinherited

Initialize Module, override if necessary.

Reimplemented in ND::TP0DReconModule, ND::TTrackerECALReconModule::OutputManager, ND::TGlobalReconModule, ND::TSFGReconModule, ND::TReconPerformanceEvalModule, ND::TTrackerReconModule, ND::TSmrdReconModule, ND::TP0DECALReconModule, ND::TTRExReconModule, ND::TBeamSummaryDataModule, and ND::TECALTestbeamModule.

Definition at line 164 of file TAnalysisModuleBase.hxx.

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::TBasicHeaderModule::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 30 of file TBasicHeaderModule.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.

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.

bool ND::TBasicHeaderModule::P0DWaterStatus ( )

Definition at line 290 of file TBasicHeaderModule.cxx.

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::TBasicHeaderModule::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 287 of file TBasicHeaderModule.cxx.

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

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

Reimplemented from ND::TAnalysisModuleBase.

Definition at line 31 of file TBasicHeaderModule.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::SetNameTitle ( char const *  name,
char const *  title 
)
inherited

Definition at line 108 of file TAnalysisModuleBase.cxx.

Referenced by ND::TTrackerECALReconModule::OutputManager::OutputManager(), TBasicHeaderModule(), ND::TBeamSummaryDataModule::TBeamSummaryDataModule(), ND::TECALTestbeamModule::TECALTestbeamModule(), ND::TFgdOnlyModule::TFgdOnlyModule(), ND::TGeometrySummaryModule::TGeometrySummaryModule(), ND::TGlobalReconModule::TGlobalReconModule(), ND::TGRooTrackerVtxModule::TGRooTrackerVtxModule(), ND::TLowLevelInfoModule::TLowLevelInfoModule(), ND::TNRooTrackerVtxModule::TNRooTrackerVtxModule(), ND::TP0DECALReconModule::TP0DECALReconModule(), ND::TReconPerformanceEvalModule::TReconPerformanceEvalModule(), ND::TSFGReconModule::TSFGReconModule(), ND::TSmrdReconModule::TSmrdReconModule(), ND::TTagsModule::TTagsModule(), ND::TTrackerReconModule::TTrackerReconModule(), ND::TTRExReconModule::TTRExReconModule(), ND::TTruthTrajectoriesModule::TTruthTrajectoriesModule(), and ND::TTruthVerticesModule::TTruthVerticesModule().

void ND::TAnalysisModuleBase::SetSplitLevel ( Int_t  splitlevel)
inherited

ROOT output parameters, usually no need to touch.

Definition at line 132 of file TAnalysisModuleBase.hxx.

References ND::TAnalysisModuleBase::fSplitLevel.

Referenced by ND::TTrackerReconModule::InitializeBranches(), ND::TGlobalReconModule::InitializeBranches(), and ND::TP0DECALReconModule::TP0DECALReconModule().

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

UInt_t ND::TBasicHeaderModule::fAlignmentId[5]

Event Alignment SHA1 Hash (ID) The alignment identifier is a SHA1 hash code of the alignment constants plus a documentation string.

Event Alignment SHA1 Hash (ID)

Definition at line 166 of file TBasicHeaderModule.hxx.

Int_t ND::TAnalysisModuleBase::fBufferSize
protectedinherited

Buffer Size for TBranch.

Has a default value that can be changed per module.

Definition at line 184 of file TAnalysisModuleBase.hxx.

Referenced by ND::TAnalysisModuleBase::GetBufferSize(), ND::TFgdOnlyModule::InitializeBranches(), ND::TSmrdReconModule::InitializeBranches(), ND::TTrackerReconModule::InitializeBranches(), ND::TSFGReconModule::InitializeBranches(), ND::TGlobalReconModule::InitializeBranches(), ND::TTrackerECALReconModule::OutputManager::InitializeBranches(), and ND::TAnalysisModuleBase::SetBufferSize().

Double_t ND::TBasicHeaderModule::fCosmicPrescaleWeight

MC event weighting to correct for differences between cosmic MC and data.

Weights individual cosmic trigger configurations, e.g. SMRD Primitive 5 + DsECal Primitive 32. See http://www.t2k.org/nd280/physics/cosmics/meetings/May09/Clarkprescale for detailed explanation.

Definition at line 122 of file TBasicHeaderModule.hxx.

ULong64_t ND::TBasicHeaderModule::fCTMTriggerPattern[3]

Contains the bit patterns from the cosmic trigger module.

Definition at line 82 of file TBasicHeaderModule.hxx.

std::string ND::TAnalysisModuleBase::fCVSID
protectedinherited

Defined if an official tagged version.

Definition at line 192 of file TAnalysisModuleBase.hxx.

Referenced by ND::TAnalysisModuleBase::GetCVSID(), ND::TTrackerECALReconModule::OutputManager::OutputManager(), TBasicHeaderModule(), ND::TBeamSummaryDataModule::TBeamSummaryDataModule(), ND::TECALTestbeamModule::TECALTestbeamModule(), ND::TFgdOnlyModule::TFgdOnlyModule(), ND::TGeometrySummaryModule::TGeometrySummaryModule(), ND::TGlobalReconModule::TGlobalReconModule(), ND::TP0DECALReconModule::TP0DECALReconModule(), ND::TReconPerformanceEvalModule::TReconPerformanceEvalModule(), ND::TSFGReconModule::TSFGReconModule(), ND::TSmrdReconModule::TSmrdReconModule(), ND::TTagsModule::TTagsModule(), ND::TTrackerReconModule::TTrackerReconModule(), ND::TTRExReconModule::TTRExReconModule(), ND::TTruthTrajectoriesModule::TTruthTrajectoriesModule(), and ND::TTruthVerticesModule::TTruthVerticesModule().

std::string ND::TAnalysisModuleBase::fCVSTagName
protectedinherited

Defined if an official tagged version.

Definition at line 190 of file TAnalysisModuleBase.hxx.

Referenced by ND::TAnalysisModuleBase::GetCVSTagName(), ND::TTrackerECALReconModule::OutputManager::OutputManager(), TBasicHeaderModule(), ND::TBeamSummaryDataModule::TBeamSummaryDataModule(), ND::TECALTestbeamModule::TECALTestbeamModule(), ND::TFgdOnlyModule::TFgdOnlyModule(), ND::TGeometrySummaryModule::TGeometrySummaryModule(), ND::TGlobalReconModule::TGlobalReconModule(), ND::TP0DECALReconModule::TP0DECALReconModule(), ND::TReconPerformanceEvalModule::TReconPerformanceEvalModule(), ND::TSFGReconModule::TSFGReconModule(), ND::TSmrdReconModule::TSmrdReconModule(), ND::TTagsModule::TTagsModule(), ND::TTrackerReconModule::TTrackerReconModule(), ND::TTRExReconModule::TTRExReconModule(), ND::TTruthTrajectoriesModule::TTruthTrajectoriesModule(), and ND::TTruthVerticesModule::TTruthVerticesModule().

std::string ND::TAnalysisModuleBase::fDescription
protectedinherited

A longish descrition of the analysis.

Definition at line 188 of file TAnalysisModuleBase.hxx.

Referenced by ND::TAnalysisModuleBase::GetDescription(), ND::TTrackerECALReconModule::OutputManager::OutputManager(), TBasicHeaderModule(), ND::TBeamSummaryDataModule::TBeamSummaryDataModule(), ND::TECALTestbeamModule::TECALTestbeamModule(), ND::TFgdOnlyModule::TFgdOnlyModule(), ND::TGeometrySummaryModule::TGeometrySummaryModule(), ND::TGlobalReconModule::TGlobalReconModule(), ND::TGRooTrackerVtxModule::TGRooTrackerVtxModule(), ND::TLowLevelInfoModule::TLowLevelInfoModule(), ND::TNRooTrackerVtxModule::TNRooTrackerVtxModule(), ND::TP0DECALReconModule::TP0DECALReconModule(), ND::TReconPerformanceEvalModule::TReconPerformanceEvalModule(), ND::TSFGReconModule::TSFGReconModule(), ND::TSmrdReconModule::TSmrdReconModule(), ND::TTagsModule::TTagsModule(), ND::TTrackerReconModule::TTrackerReconModule(), ND::TTRExReconModule::TTRExReconModule(), ND::TTruthTrajectoriesModule::TTruthTrajectoriesModule(), and ND::TTruthVerticesModule::TTruthVerticesModule().

Int_t ND::TAnalysisModuleBase::fEventID
protectedinherited

Definition at line 198 of file TAnalysisModuleBase.hxx.

UInt_t ND::TBasicHeaderModule::fEventTime

Time of the relevant ND::TND280Event's last GPS pulse in Unix time.

Revtrieved from the ND::TND280Event header like

Definition at line 57 of file TBasicHeaderModule.hxx.

Referenced by GetEventTime().

Bool_t ND::TBasicHeaderModule::fFGDCosmicEvent

FGD Cosmic trigger flag.

Uses bits from TBasicHeaderModule::fTriggerWord

ULong64_t shift = one << 55;

Definition at line 69 of file TBasicHeaderModule.hxx.

Bool_t ND::TAnalysisModuleBase::fFilledConfigTree
protectedinherited

Definition at line 174 of file TAnalysisModuleBase.hxx.

Referenced by ND::TTrackerReconModule::FillConfigTree(), and ND::TGlobalReconModule::FillConfigTree().

bool ND::TBasicHeaderModule::fFoundSoftwareVersion
private

Whether we have found the version already, so no need to do it again.

Definition at line 190 of file TBasicHeaderModule.hxx.

UInt_t ND::TBasicHeaderModule::fGeometryHash[5]

Event Geometry SHA1 Hash (ID)

Event Geometry SHA1 Hash

Definition at line 162 of file TBasicHeaderModule.hxx.

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::TBasicHeaderModule::fIsDetector

Whether this is detector data.

Retrieved from ND::TND280Context::IsDetector Whether this is detector data.

Definition at line 142 of file TBasicHeaderModule.hxx.

Bool_t ND::TAnalysisModuleBase::fIsEnabled
protectedinherited

Definition at line 176 of file TAnalysisModuleBase.hxx.

Referenced by ND::TAnalysisModuleBase::IsEnabled(), ND::TTrackerECALReconModule::OutputManager::OutputManager(), ND::TAnalysisModuleBase::SetEnabled(), TBasicHeaderModule(), ND::TBeamSummaryDataModule::TBeamSummaryDataModule(), ND::TECALTestbeamModule::TECALTestbeamModule(), ND::TFgdOnlyModule::TFgdOnlyModule(), ND::TGeometrySummaryModule::TGeometrySummaryModule(), ND::TGlobalReconModule::TGlobalReconModule(), ND::TGRooTrackerVtxModule::TGRooTrackerVtxModule(), ND::TLowLevelInfoModule::TLowLevelInfoModule(), ND::TNRooTrackerVtxModule::TNRooTrackerVtxModule(), ND::TP0DECALReconModule::TP0DECALReconModule(), ND::TReconPerformanceEvalModule::TReconPerformanceEvalModule(), ND::TSFGReconModule::TSFGReconModule(), ND::TSmrdReconModule::TSmrdReconModule(), ND::TTagsModule::TTagsModule(), ND::TTrackerReconModule::TTrackerReconModule(), ND::TTRExReconModule::TTRExReconModule(), ND::TTruthTrajectoriesModule::TTruthTrajectoriesModule(), and ND::TTruthVerticesModule::TTruthVerticesModule().

Bool_t ND::TBasicHeaderModule::fIsMC

Whether this is an MC event.

Retrieved from ND::TND280Context::IsMC Whether this is an MC event

Definition at line 145 of file TBasicHeaderModule.hxx.

Bool_t ND::TBasicHeaderModule::fIsSand

Whether this is a Sand Muon MC event.

Calculated from the run number, assumes that it of the form described in http://www.t2k.org/nd280/datacomp/production005/mcp/sand_mc
Run Number 9ABCDEEE, where IsSand = true if tt>fIsMC == true and D == 7.

Warning
This is no longer definite as the Gas Interaction control sample uses D == 7. This branch will be turned off for now. 2015-3-30 Whether this is a Sand Muon MC event.

Definition at line 153 of file TBasicHeaderModule.hxx.

Bool_t ND::TAnalysisModuleBase::fIsUsedForPreselection
protectedinherited

Definition at line 178 of file TAnalysisModuleBase.hxx.

Referenced by ND::TAnalysisModuleBase::IsUsedForPreselection(), and ND::TAnalysisModuleBase::SetUsedForPreselection().

Double_t ND::TBasicHeaderModule::fMagneticFieldStrength

The magnetic field strength at the center of TPC1.

Definition at line 183 of file TBasicHeaderModule.hxx.

Float_t ND::TBasicHeaderModule::fMCIntensity

MC "intensity", will be 0 if unused.

The intensity corresponds to Protons/Spill for Beam MC. The intensity corresponds to Protons/Spill for Beam MC.

Definition at line 169 of file TBasicHeaderModule.hxx.

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

Definition at line 203 of file TAnalysisModuleBase.hxx.

TTree* ND::TAnalysisModuleBase::fOutputTree
protectedinherited

Definition at line 180 of file TAnalysisModuleBase.hxx.

Referenced by ND::TAnalysisModuleBase::GetOutputTree(), ND::TFgdOnlyModule::InitializeBranches(), ND::TSmrdReconModule::InitializeBranches(), ND::TTrackerReconModule::InitializeBranches(), ND::TSFGReconModule::InitializeBranches(), ND::TGlobalReconModule::InitializeBranches(), ND::TTrackerECALReconModule::OutputManager::InitializeBranches(), and ND::TAnalysisModuleBase::KillOutputTree().

Bool_t ND::TBasicHeaderModule::fP0DWaterStatus

Whether the P0D is filled with water or not.

Ascertained by querying the geometry.

bool ND::TBasicHeaderModule::P0DWaterStatus() {
double depth = ND::TGeomInfo::Get().P0D().TargetDepth();
if (depth < 1000.0) {
return false;
} else {

Definition at line 160 of file TBasicHeaderModule.hxx.

Int_t ND::TBasicHeaderModule::fPartition

The subdetector configuration in which the data was taken Valid values are defined in ND::TND280Context as.

  • kGlobalPartition = 1
  • kP0DClockPresent = 1<<1
  • kTPCClockPresent = 1<<2
  • kFGDClockPresent = 1<<3
  • kECalClockPresent = 1<<4
  • kSMRDClockPresent = 1<<5
  • kINGRIDClockPresent = 1<<6
  • kMCData = 1<<16

subdetector configuration

Definition at line 136 of file TBasicHeaderModule.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.

bool ND::TBasicHeaderModule::fSoftware
private

Whether we are saving the software version from $ND280ROOT.

Definition at line 186 of file TBasicHeaderModule.hxx.

Referenced by TBasicHeaderModule().

std::string ND::TBasicHeaderModule::fSoftwareOverrideVersionString

Holder for the Software Override Version String.

Software Override Version

Definition at line 178 of file TBasicHeaderModule.hxx.

Bool_t ND::TBasicHeaderModule::fSoftwareUseOverrideVersion
private

Whether we are using a supplied software version. Will override fSoftware.

Definition at line 188 of file TBasicHeaderModule.hxx.

Referenced by TBasicHeaderModule().

Char_t ND::TBasicHeaderModule::fSoftwareVersion[50]

The software version string.

If -O TBasicHeaderModule=*version* is passed on the CLI then this will get its value from the envvar $ND280ROOT If -O TBasicHeadModule=OverrideSWVersion_v123r456p789 is passed on the CLI then this will be set to v123r456p789.

Note
The OverrideVersion version will take precedence. The nd280 software version

Definition at line 176 of file TBasicHeaderModule.hxx.

Int_t ND::TBasicHeaderModule::fSpill

Event Spill number.

Retrieved from ND::TND280Context::GetSpill Spill number

Definition at line 125 of file TBasicHeaderModule.hxx.

Int_t ND::TAnalysisModuleBase::fSplitLevel
protectedinherited

Split Level for TBranch.

Definition at line 186 of file TAnalysisModuleBase.hxx.

Referenced by ND::TAnalysisModuleBase::GetSplitLevel(), ND::TFgdOnlyModule::InitializeBranches(), ND::TSmrdReconModule::InitializeBranches(), ND::TTrackerReconModule::InitializeBranches(), ND::TSFGReconModule::InitializeBranches(), ND::TGlobalReconModule::InitializeBranches(), ND::TTrackerECALReconModule::OutputManager::InitializeBranches(), and ND::TAnalysisModuleBase::SetSplitLevel().

Int_t ND::TAnalysisModuleBase::fSubrunID
protectedinherited

Definition at line 197 of file TAnalysisModuleBase.hxx.

Int_t ND::TBasicHeaderModule::fTimeStamp

The unix time stamp of the event context.

Retrieved from ND::TND280Context::GetTimeStamp unix time stamp of the event

Definition at line 139 of file TBasicHeaderModule.hxx.

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

Definition at line 204 of file TAnalysisModuleBase.hxx.

ULong64_t ND::TBasicHeaderModule::fTriggerWord

Bits containing various information from the MCMs including event/spill numbers and trigger flags.

For bit definitions see ND::TND280Event::Header::GetTriggerWord

Definition at line 63 of file TBasicHeaderModule.hxx.

Bool_t ND::TBasicHeaderModule::fTripTCosmicEvent

TRIP-t Cosmic trigger flag.

Uses bits from TBasicHeaderModule::fTriggerWord

Definition at line 76 of file TBasicHeaderModule.hxx.

Int_t ND::TBasicHeaderModule::fTripTCosmicTriggerType

TripT Cosmic Trigger type: trigger codes from 0-14, -1 means off.

if (event.Has<ND::TIntegerDatum>("triptCosmicTriggerType")) {
fTripTCosmicTriggerType =
event.Get<ND::TIntegerDatum>("triptCosmicTriggerType")->GetValue();
}
From comments in cosmicTriggerGeant4Sim/src/TTripTTrigger.cxx:1196
Value corresponds to which "detector walls" were hit:

  • -1. Unused
  • 0. Top and Bottom
  • 1. Top and Left
  • 2. Top and Right
  • 3. Left and Bottom
  • 4. Top and Bottom
  • 5. Left and Right
  • 6. Top and Front(P0D)
  • 7. Top and End(DsECal)
  • 8. Left and Front(P0D)
  • 9. Left and End(DsECal)
  • 10. Right and Front(P0D)
  • 11. Right and End(DsECal)
  • 12. Front and Bottom
  • 13. End(DsECal) and Back
  • 14. Front(P0D) and End(DsECal)

TripT Cosmic Trigger type:

Definition at line 106 of file TBasicHeaderModule.hxx.

Int_t ND::TBasicHeaderModule::fTripTCosmicTriggerUpward

If cosmic muon is detmined to be upward going, 0 or 1.

Definition at line 112 of file TBasicHeaderModule.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:01 for eventAnalysis by doxygen 1.8.5