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

An analysis module which add the data quality branch to the HeaderDir branch. More...

#include <TBasicDataQualityModule.hxx>

+ Inheritance diagram for ND::TBasicDataQualityModule:
+ Collaboration diagram for ND::TBasicDataQualityModule:

Public Member Functions

 TBasicDataQualityModule (const char *name="BasicDataQuality", const char *title="Basic DataQuality Module")
 
virtual ~TBasicDataQualityModule ()
 
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...
 
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 ()
 
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

ND::TDataQuality dqObject
 DQ object. More...
 
Int_t fBarECALFlag
 BarECAL flag. More...
 
Int_t fDSECALFlag
 DSECAL flag. More...
 
Int_t fECALFlag
 ECAL flag. More...
 
UInt_t fEventTime
 Event timestamp. More...
 
Int_t fFGD1Flag
 FGD1 flag. More...
 
Int_t fFGD2Flag
 FGD2 flag. More...
 
Int_t fFGDFlag
 FGD flag. More...
 
Int_t fINGRIDFlag
 INGRID flag. More...
 
Int_t fMAGNETFlag
 MAGNET flag. More...
 
Int_t fND280OffFlag
 ND280 Off flag. More...
 
Int_t fP0DECALFlag
 P0DECAL flag. More...
 
Int_t fP0DFlag
 P0D flag. More...
 
Int_t fSMRDFlag
 SMRD flag. More...
 
Int_t fTPC1Flag
 TPC1 flag. More...
 
Int_t fTPC2Flag
 TPC2 flag. More...
 
Int_t fTPC3Flag
 TPC3 flag. More...
 
Int_t fTPCFlag
 TPC flag. 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 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
 

Detailed Description

An analysis module which add the data quality branch to the HeaderDir branch.

It contains the data quality flags for the ND280 off-axis sub-detectors, the global ND280 off-axis detector (ie when all the sub-detectors are quality-assessed good) and the INGRID detector. For ND280 off-axis, the data to be used for the analyses are the ones with the global ND280 off-axis detector assessed good. By convention, the data quality flag is 0 if the event is good, >0 if otherwise.

Definition at line 34 of file TBasicDataQualityModule.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::TBasicDataQualityModule::TBasicDataQualityModule ( const char *  name = "BasicDataQuality",
const char *  title = "Basic DataQuality Module" 
)

Definition at line 11 of file TBasicDataQualityModule.cxx.

References CVSID, and CVSTAG.

ND::TBasicDataQualityModule::~TBasicDataQualityModule ( )
virtual

Definition at line 39 of file TBasicDataQualityModule.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::TBasicDataQualityModule::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 67 of file TBasicDataQualityModule.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::TBasicDataQualityModule::GetEventTime ( )

Definition at line 43 of file TBasicDataQualityModule.hxx.

References fEventTime.

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::TBasicDataQualityModule::InitializeBranches ( )
protectedvirtual

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

Implements ND::TAnalysisModuleBase.

Definition at line 41 of file TBasicDataQualityModule.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::TBasicDataQualityModule::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 41 of file TBasicDataQualityModule.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.

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::TBasicDataQualityModule::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 94 of file TBasicDataQualityModule.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

ND::TDataQuality ND::TBasicDataQualityModule::dqObject

DQ object.

Definition at line 53 of file TBasicDataQualityModule.hxx.

Int_t ND::TBasicDataQualityModule::fBarECALFlag

BarECAL flag.

Definition at line 80 of file TBasicDataQualityModule.hxx.

Int_t ND::TBasicDataQualityModule::fDSECALFlag

DSECAL flag.

Definition at line 78 of file TBasicDataQualityModule.hxx.

Int_t ND::TBasicDataQualityModule::fECALFlag

ECAL flag.

Definition at line 76 of file TBasicDataQualityModule.hxx.

Int_t ND::TAnalysisModuleBase::fEventID
protectedinherited

Definition at line 198 of file TAnalysisModuleBase.hxx.

UInt_t ND::TBasicDataQualityModule::fEventTime

Event timestamp.

Definition at line 58 of file TBasicDataQualityModule.hxx.

Referenced by GetEventTime().

Int_t ND::TBasicDataQualityModule::fFGD1Flag

FGD1 flag.

Definition at line 72 of file TBasicDataQualityModule.hxx.

Int_t ND::TBasicDataQualityModule::fFGD2Flag

FGD2 flag.

Definition at line 74 of file TBasicDataQualityModule.hxx.

Int_t ND::TBasicDataQualityModule::fFGDFlag

FGD flag.

Definition at line 70 of file TBasicDataQualityModule.hxx.

Bool_t ND::TAnalysisModuleBase::fFilledConfigTree
protectedinherited
Int_t ND::TBasicDataQualityModule::fINGRIDFlag

INGRID flag.

Definition at line 90 of file TBasicDataQualityModule.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::TAnalysisModuleBase::fIsUsedForPreselection
protectedinherited
Int_t ND::TBasicDataQualityModule::fMAGNETFlag

MAGNET flag.

Definition at line 88 of file TBasicDataQualityModule.hxx.

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

Definition at line 203 of file TAnalysisModuleBase.hxx.

Int_t ND::TBasicDataQualityModule::fND280OffFlag

ND280 Off flag.

Definition at line 60 of file TBasicDataQualityModule.hxx.

Int_t ND::TBasicDataQualityModule::fP0DECALFlag

P0DECAL flag.

Definition at line 82 of file TBasicDataQualityModule.hxx.

Int_t ND::TBasicDataQualityModule::fP0DFlag

P0D flag.

Definition at line 84 of file TBasicDataQualityModule.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::TBasicDataQualityModule::fSMRDFlag

SMRD flag.

Definition at line 86 of file TBasicDataQualityModule.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.

Int_t ND::TBasicDataQualityModule::fTPC1Flag

TPC1 flag.

Definition at line 64 of file TBasicDataQualityModule.hxx.

Int_t ND::TBasicDataQualityModule::fTPC2Flag

TPC2 flag.

Definition at line 66 of file TBasicDataQualityModule.hxx.

Int_t ND::TBasicDataQualityModule::fTPC3Flag

TPC3 flag.

Definition at line 68 of file TBasicDataQualityModule.hxx.

Int_t ND::TBasicDataQualityModule::fTPCFlag

TPC flag.

Definition at line 62 of file TBasicDataQualityModule.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:00 for eventAnalysis by doxygen 1.8.5