PandaRoot
BSEmcClusteringTask Class Reference

Task to orchestrate the full reconstruction line from BSEmcDigis into BSEmcRecoHits. More...

#include <BSEmcClusteringTask.h>

Inheritance diagram for BSEmcClusteringTask:
PndProcessTask PndPersistencyTask PndProcessHandler

Public Member Functions

 BSEmcClusteringTask (const std::string &t_detectorName="Barrel", Bool_t t_storeclusters=kTRUE)
 
virtual ~BSEmcClusteringTask ()
 
void SetMCDepositBranchName (const std::string &t_branchname)
 
void SetDigiBranchName (const std::string &t_branchname)
 
void SetDigiBranchAsMutable (Bool_t t_mutable)
 
void SetPreclusterBranchName (const std::string &t_branchname)
 
void SetClusterBranchName (const std::string &t_branchname)
 
void SetSubClusterBranchName (const std::string &t_branchname)
 
void SetRecoHitBranchName (const std::string &t_branchname)
 
- Public Member Functions inherited from PndProcessTask
 PndProcessTask (const std::string &t_detectorName)
 
virtual ~PndProcessTask ()
 
virtual InitStatus Init () final
 Initialise this task. This must be called AFTER SetParContainers(), otherwise we will try to pass the parameters to the PndProcesses, while the parameter were not fetched yet. More...
 
virtual void Exec (Option_t *t_opt=nullptr)
 Prepare Task for processing of PndProcess (e.g. reset data arrays), process the PndProcesses and do cleanup during the PostProcessing. More...
 
virtual void Finish ()
 End the task, call TearDown for all PndProcesses. More...
 
- Public Member Functions inherited from PndPersistencyTask
 PndPersistencyTask ()
 
 PndPersistencyTask (const char *name, Int_t iVerbose=1)
 
virtual ~PndPersistencyTask ()
 
void SetPersistency (Bool_t val=kTRUE)
 
Bool_t GetPersistency ()
 
- Public Member Functions inherited from PndProcessHandler
 PndProcessHandler (const std::string &t_detectorname="")
 
virtual ~PndProcessHandler ()
 
void AddProcess (PndProcess *)
 Add a PndProcess of appropriate type to the list of PndProcesses to be managed. More...
 
void CallProcesses ()
 Call for all PndProcesses the PreProcess/Process/PosProcess functions. More...
 
void SetupProcesses ()
 Call for each PndProcess the SetupParameter. More...
 
const std::vector< PndProcess * > & GetProcesses ()
 
PndParameterRegisterGetParameterRegister ()
 
const PndParameterRegisterGetParameterRegister () const
 
const std::string & GetDetectorName () const
 
virtual void GetRequiredDataContainerInfo ()
 
virtual void PassDataContainersToProcesses ()
 

Protected Member Functions

virtual void SetupDataArrays ()
 Define which data containers need to be fetched from the FairRootManager, pass the data container addresses into a simple struct to distribute the addresses to the PndProcesses so they can read and write the data to them. Needs to be implemented in the derived PndProcessTask, such as the BSEmcClusteringTask. More...
 
virtual void PreProcessing (Option_t *)
 Do some task preparation before PndProcesses are run once per event. More...
 
virtual void PostProcessing (Option_t *)
 Do some task post clean up after PndProcesses are run once per event. More...
 
- Protected Member Functions inherited from PndProcessTask
void SetParContainers () final
 Fetch the FairRuntimeDb and populate the PndParameterRegister with all requested parameter. Has to be called before Init() More...
 
template<class T >
Bool_t DispatchRequest (const PndContainerRegister::PndContainerType_t &t_container, PndContainerRegister *t_register, const TString &t_defaultName)
 
TClonesArray * GetInputArray (const TString &t_branchname, const TString &t_classtype)
 
TClonesArray * GetOutputArray (const TString &t_branchname, const TString &t_classtype, const TString &t_foldername, Bool_t t_persistenxy)
 
template<class T >
Bool_t HandledRequest (const PndContainerRegister::PndContainerType_t &t_container, PndContainerRegister *t_register, const TString &t_defaultName)
 
- Protected Member Functions inherited from PndProcessHandler
virtual void SetupProcess (PndProcess *t_process)
 

Additional Inherited Members

- Protected Attributes inherited from PndProcessHandler
std::vector< PndProcess * > fProcesses {}
 
std::unique_ptr< PndParameterRegisterfParameterRegister {new PndParameterRegister}
 
std::unique_ptr< PndContainerRegisterfContainerRegister {new PndContainerRegister}
 
std::string fDetectorName {""}
 

Detailed Description

Task to orchestrate the full reconstruction line from BSEmcDigis into BSEmcRecoHits.

Attache Clustering/Reco-Processes to this task.

Author
Ben Salisbury salis.nosp@m.bury.nosp@m.@hisk.nosp@m.p.un.nosp@m.i-bon.nosp@m.n.de, HISKP Bonn
Date
2021-02

Definition at line 41 of file BSEmcClusteringTask.h.

Constructor & Destructor Documentation

◆ BSEmcClusteringTask()

BSEmcClusteringTask::BSEmcClusteringTask ( const std::string &  t_detectorName = "Barrel",
Bool_t  t_storeclusters = kTRUE 
)

◆ ~BSEmcClusteringTask()

virtual BSEmcClusteringTask::~BSEmcClusteringTask ( )
virtual

Member Function Documentation

◆ PostProcessing()

virtual void BSEmcClusteringTask::PostProcessing ( Option_t *  )
protectedvirtual

Do some task post clean up after PndProcesses are run once per event.

Reimplemented from PndProcessTask.

Referenced by SetRecoHitBranchName().

◆ PreProcessing()

virtual void BSEmcClusteringTask::PreProcessing ( Option_t *  )
protectedvirtual

Do some task preparation before PndProcesses are run once per event.

Reimplemented from PndProcessTask.

Referenced by SetRecoHitBranchName().

◆ SetClusterBranchName()

void BSEmcClusteringTask::SetClusterBranchName ( const std::string &  t_branchname)
inline

Definition at line 52 of file BSEmcClusteringTask.h.

52 { fClusterBranchname = t_branchname; }

◆ SetDigiBranchAsMutable()

void BSEmcClusteringTask::SetDigiBranchAsMutable ( Bool_t  t_mutable)
inline

Definition at line 50 of file BSEmcClusteringTask.h.

50 { fMutableDigiBranch = t_mutable; }

◆ SetDigiBranchName()

void BSEmcClusteringTask::SetDigiBranchName ( const std::string &  t_branchname)
inline

Definition at line 49 of file BSEmcClusteringTask.h.

49 { fDigiBranchname = t_branchname; }

◆ SetMCDepositBranchName()

void BSEmcClusteringTask::SetMCDepositBranchName ( const std::string &  t_branchname)
inline

Definition at line 48 of file BSEmcClusteringTask.h.

48 { fMCDepositBranchname = t_branchname; }

◆ SetPreclusterBranchName()

void BSEmcClusteringTask::SetPreclusterBranchName ( const std::string &  t_branchname)
inline

Definition at line 51 of file BSEmcClusteringTask.h.

51 { fPreclusterBranchname = t_branchname; }

◆ SetRecoHitBranchName()

void BSEmcClusteringTask::SetRecoHitBranchName ( const std::string &  t_branchname)
inline

Definition at line 54 of file BSEmcClusteringTask.h.

References PostProcessing(), PreProcessing(), and SetupDataArrays().

54 { fRecoHitBranchname = t_branchname; }

◆ SetSubClusterBranchName()

void BSEmcClusteringTask::SetSubClusterBranchName ( const std::string &  t_branchname)
inline

Definition at line 53 of file BSEmcClusteringTask.h.

53 { fSubClusterBranchname = t_branchname; }

◆ SetupDataArrays()

virtual void BSEmcClusteringTask::SetupDataArrays ( )
protectedvirtual

Define which data containers need to be fetched from the FairRootManager, pass the data container addresses into a simple struct to distribute the addresses to the PndProcesses so they can read and write the data to them. Needs to be implemented in the derived PndProcessTask, such as the BSEmcClusteringTask.

Implements PndProcessTask.

Referenced by SetRecoHitBranchName().


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