Task to create digis from waveforms. More...

#include <BSEmcExtractDigisFromWaveforms.h>

Inheritance diagram for BSEmcExtractDigisFromWaveforms< ParSet >:

Public Member Functions
	BSEmcExtractDigisFromWaveforms (const std::string &t_detectorname="Barrel", Bool_t t_storedigis=kTRUE)

virtual	~BSEmcExtractDigisFromWaveforms ()

virtual InitStatus	Init ()
	Init Task. More...

virtual void	Exec (Option_t *)
	Runs the task. More...

void	SetStorageOfData (Bool_t t_val)

void	SetDigiBranchName (const TString &t_digiBranchName)

void	SetWaveformBranchName (const TString &t_digiBranchName)

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

Protected Member Functions
virtual void	SetParContainers ()

virtual Double_t	GetTimeStamp (BSEmcWaveform *t_waveform, Double_t t_digi_time) const

virtual BSEmcDigi::eGAIN	GetGainType (BSEmcWaveform *t_waveform, Int_t t_dep) const =0

virtual void	DefinePSA ()=0

	ClassDef (BSEmcExtractDigisFromWaveforms, 1)

Protected Attributes
const std::string	fDetectorName {""}

TString	fMCDepositBranchName {""}

PndTCAMutableContainer< BSEmcDigi >	fDigiArray {"Emc", kTRUE}

TClonesArray *	fWaveformArray {nullptr}

TString	fDigiBranchName {""}

TString	fWaveformBranchName {""}

Double_t	fEnergyDigiThreshold {0}

BSEmcAbsPSA *	fPSA {nullptr}

ParSet *	fDigiPar {nullptr}
	Timebased Digitisation parameter container. More...

Detailed Description

template<class ParSet>
class BSEmcExtractDigisFromWaveforms< ParSet >

Task to create digis from waveforms.

This is an alternative to BSEmcWaveformToDigi, which despite its name could be used for all the EMC, not just FwEndcap.

Author: Ph. Mahlberg mahlb.nosp@m.erg@.nosp@m.hiskp.nosp@m..uni.nosp@m.-bonn.nosp@m..de

Definition at line 40 of file BSEmcExtractDigisFromWaveforms.h.

Constructor & Destructor Documentation

◆ BSEmcExtractDigisFromWaveforms()

template<class ParSet>

BSEmcExtractDigisFromWaveforms< ParSet >::BSEmcExtractDigisFromWaveforms	(	const std::string &	t_detectorname = `"Barrel"`,
		Bool_t	t_storedigis = `kTRUE`
	)

inline

Definition at line 43 of file BSEmcExtractDigisFromWaveforms.h.

     : PndPersistencyTask("BSEmcExtractDigisFromWaveforms"), fDetectorName(t_detectorname)
   {
     SetPersistency(t_storedigis);
   }

◆ ~BSEmcExtractDigisFromWaveforms()

template<class ParSet>

virtual BSEmcExtractDigisFromWaveforms< ParSet >::~BSEmcExtractDigisFromWaveforms ( )

inlinevirtual

Definition at line 50 of file BSEmcExtractDigisFromWaveforms.h.

   {
     if (fPSA != nullptr) {
       delete fPSA;
       fPSA = nullptr;
     }
   }

Member Function Documentation

◆ ClassDef()

template<class ParSet>

BSEmcExtractDigisFromWaveforms< ParSet >::ClassDef	(	BSEmcExtractDigisFromWaveforms< ParSet >	,
		1
	)

protected

◆ DefinePSA()

template<class ParSet>

virtual void BSEmcExtractDigisFromWaveforms< ParSet >::DefinePSA ( )

protectedpure virtual

Implemented in BSEmcFwEndcapDigi, and BSEmcBwEndcapDigi.

Referenced by BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::GetTimeStamp(), and BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::Init().

◆ Exec()

template<class ParSet>

virtual void BSEmcExtractDigisFromWaveforms< ParSet >::Exec ( Option_t * )

inlinevirtual

Runs the task.

The task loops over the waveforms and uses the pulse shape analyser (BSEmcAbsPSA) to extract signal height and timing. If the energy is above the threshold (fEnergyDigiThreshold), a BSEmcDigi is created.

Parameters

opt unused

Returns: void

Definition at line 125 of file BSEmcExtractDigisFromWaveforms.h.

   {
     fDigiArray.Reset();
     // fDigiArray->Delete();
     TStopwatch timer;
     timer.Start();
 
     Double_t energy = NAN;
     Double_t digi_time = NAN;
     Int_t nDeposits = 0;
     Int_t detId = 0;
     Int_t nWaveforms = fWaveformArray->GetEntriesFast();
     BSEmcWaveform *theWaveform = nullptr;
 
     for (Int_t iWaveform = 0; iWaveform < nWaveforms; iWaveform++) {
 
       theWaveform = (BSEmcWaveform *)fWaveformArray->At(iWaveform);
       detId = theWaveform->GetDetectorId();
 
       nDeposits = fPSA->Process(theWaveform);
 
       for (Int_t iDeposit = 0; iDeposit < nDeposits; ++iDeposit) {
         fPSA->GetHit(iDeposit, energy, digi_time);
 
         // if (energy > fEnergyDigiThreshold) {
         Double_t timestamp = GetTimeStamp(theWaveform, digi_time);
         BSEmcDigi *myDigi = fDigiArray.CreateCopy(BSEmcDigi(detId, energy, timestamp));
         // BSEmcDigi *myDigi = new ((*fDigiArray)[fDigiArray->GetEntriesFast()]) BSEmcDigi(detId, energy, timestamp);
         myDigi->SetGainType(GetGainType(theWaveform, iDeposit));
         myDigi->ResetLinks();
         myDigi->AddLinks(theWaveform->GetLinksWithType(FairRootManager::Instance()->GetBranchId(fMCDepositBranchName)));
         FairMultiLinkedData mcdeplinks = myDigi->GetLinksWithType(FairRootManager::Instance()->GetBranchId(fMCDepositBranchName));
         for (const FairLink &link : mcdeplinks.GetLinks()) {
           LOG(debug) << link;
         }
         LOG(debug) << "BSEmcExtractDigisFromWaveforms for " << fDetectorName << " created Digi(detId: " << detId << ", energy: " << energy << ", timestamp: " << timestamp
                    << ") and has " << myDigi->GetLinksWithType(FairRootManager::Instance()->GetBranchId(fMCDepositBranchName)).GetNLinks() << " links to EmcMCDeposits";
         // }
       }
     }
 
     timer.Stop();
     Double_t rtime = timer.RealTime();
     Double_t ctime = timer.CpuTime();
     LOG(debug) << "BSEmcExtractDigisFromWaveforms, Real time " << rtime << " s, CPU time " << ctime << " s";
   }

◆ GetGainType()

template<class ParSet>

virtual BSEmcDigi::eGAIN BSEmcExtractDigisFromWaveforms< ParSet >::GetGainType	(	BSEmcWaveform *	t_waveform,
		Int_t	t_dep
	)		const

protectedpure virtual

Implemented in BSEmcFwEndcapDigi, and BSEmcBwEndcapDigi.

Referenced by BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::Exec(), and BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::GetTimeStamp().

◆ GetTimeStamp()

template<class ParSet>

virtual Double_t BSEmcExtractDigisFromWaveforms< ParSet >::GetTimeStamp	(	BSEmcWaveform *	t_waveform,
		Double_t	t_digi_time
	)		const

inlineprotectedvirtual

Reimplemented in BSEmcBwEndcapDigi.

Definition at line 196 of file BSEmcExtractDigisFromWaveforms.h.

Referenced by BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::Exec().

   {
     Double_t sampleRate = t_waveform->GetSampleRate();
 
     t_digi_time /= sampleRate;
     t_digi_time *= 1e9; // ns
     return t_waveform->GetTimeStamp() + t_digi_time;
   }

◆ Init()

template<class ParSet>

virtual InitStatus BSEmcExtractDigisFromWaveforms< ParSet >::Init ( )

inlinevirtual

Init Task.

Prepares the TClonesArray of BSEmcMultiWaveform for reading and BSEmcDigi for writing. Also reads the EMC parameters and prepares the pulseshapes (BSEmcAbsPulseshape) and pulse shape analyser (BSEmcAbsPSA)

Returns: InitStatus

Return values

kSUCCESS success

Definition at line 68 of file BSEmcExtractDigisFromWaveforms.h.

   {
 
     LOG(debug) << "BSEmcExtractDigisFromWaveforms<ParSet>::Init";
     fMCDepositBranchName = BSEmcDataBranchNames::fgMCDepositBranchName + fDetectorName;
     if (fWaveformBranchName == "") {
       fWaveformBranchName = BSEmcDataBranchNames::fgMultiWaveformBranchName + fDetectorName;
     }
     if (fDigiBranchName == "") {
       fDigiBranchName = BSEmcDataBranchNames::fgDigiBranchName + fDetectorName;
     }
     // Get RootManager
     FairRootManager *ioman = FairRootManager::Instance();
     if (ioman == nullptr) {
       LOG(error) << "BSEmcExtractDigisFromWaveforms<ParSet>::Init: "
                  << "RootManager not instantiated!";
       return kFATAL;
     }
     fDigiArray.SetBranchName(fDigiBranchName);
     fDigiArray.SetTCA(dynamic_cast<TClonesArray *>(ioman->GetObject(fDigiBranchName)));
 
     LOG(debug) << "BSEmcExtractDigisFromWaveforms<ParSet>::Init: Registered " << fDigiBranchName;
     // Get input array
     fWaveformArray = (TClonesArray *)ioman->GetObject(fWaveformBranchName);
     if (fWaveformArray == nullptr) {
       // check if EmcWaveform contains MultiWaveforms
       fWaveformArray = (TClonesArray *)ioman->GetObject(fWaveformBranchName);
       if ((fWaveformArray == nullptr) || (!fWaveformArray->GetClass()->InheritsFrom("BSEmcMultiWaveform"))) {
         LOG(error) << "BSEmcExtractDigisFromWaveforms<ParSet>::Init: "
                    << "No BSEmcWaveform array containing multi waveforms!";
         return kFATAL;
       }
     }
 
     DefinePSA();
     if (fPSA == nullptr) {
       LOG(error) << "No PSA was defined. Aborting!";
       return kFATAL;
     }
 
     fEnergyDigiThreshold = fDigiPar->GetEnergyDigiThreshold();
 
     LOG(debug) << "BSEmcExtractDigisFromWaveforms: Intialization successfull";
     return kSUCCESS;
   }

◆ SetDigiBranchName()

template<class ParSet>

void BSEmcExtractDigisFromWaveforms< ParSet >::SetDigiBranchName ( const TString & t_digiBranchName )

inline

Definition at line 177 of file BSEmcExtractDigisFromWaveforms.h.

177 { fDigiBranchName = t_digiBranchName; }

BSEmcExtractDigisFromWaveforms::fDigiBranchName

TString fDigiBranchName

Definition: BSEmcExtractDigisFromWaveforms.h:216

◆ SetParContainers()

template<class ParSet>

virtual void BSEmcExtractDigisFromWaveforms< ParSet >::SetParContainers ( )

inlineprotectedvirtual

Get parameter containers

Definition at line 182 of file BSEmcExtractDigisFromWaveforms.h.

   {
     // Get run and runtime database
     FairRun *run = FairRun::Instance();
     if (run == nullptr) {
       Fatal("SetParContainers", "No analysis run");
     }
     FairRuntimeDb *db = run->GetRuntimeDb();
     if (db == nullptr) {
       Fatal("SetParContainers", "No runtime database");
     }
     // Get Emc digitisation parameter container
     fDigiPar = dynamic_cast<ParSet *>(db->getContainer(ParSet::fgParameterName.c_str()));
   }

◆ SetStorageOfData()

template<class ParSet>

void BSEmcExtractDigisFromWaveforms< ParSet >::SetStorageOfData ( Bool_t t_val )

inline

Definition at line 172 of file BSEmcExtractDigisFromWaveforms.h.

   {
     SetPersistency(t_val);
     return;
   }

◆ SetWaveformBranchName()

template<class ParSet>

void BSEmcExtractDigisFromWaveforms< ParSet >::SetWaveformBranchName ( const TString & t_digiBranchName )

inline

Definition at line 178 of file BSEmcExtractDigisFromWaveforms.h.

178 { fWaveformBranchName = t_digiBranchName; }

BSEmcExtractDigisFromWaveforms::fWaveformBranchName

TString fWaveformBranchName

Definition: BSEmcExtractDigisFromWaveforms.h:217

Member Data Documentation

◆ fDetectorName

template<class ParSet>

const std::string BSEmcExtractDigisFromWaveforms< ParSet >::fDetectorName {""}

protected

Definition at line 209 of file BSEmcExtractDigisFromWaveforms.h.

Referenced by BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::Exec(), and BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::Init().

◆ fDigiArray

template<class ParSet>

PndTCAMutableContainer<BSEmcDigi> BSEmcExtractDigisFromWaveforms< ParSet >::fDigiArray {"Emc", kTRUE}

protected

Input array of BSEmcWaveforms

Definition at line 213 of file BSEmcExtractDigisFromWaveforms.h.

Referenced by BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::Exec(), and BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::Init().

◆ fDigiBranchName

template<class ParSet>

TString BSEmcExtractDigisFromWaveforms< ParSet >::fDigiBranchName {""}

protected

Definition at line 216 of file BSEmcExtractDigisFromWaveforms.h.

Referenced by BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::Init(), and BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::SetDigiBranchName().

◆ fDigiPar

template<class ParSet>

ParSet* BSEmcExtractDigisFromWaveforms< ParSet >::fDigiPar {nullptr}

protected

Timebased Digitisation parameter container.

Definition at line 222 of file BSEmcExtractDigisFromWaveforms.h.

Referenced by BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::Init(), and BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::SetParContainers().

◆ fEnergyDigiThreshold

template<class ParSet>

Double_t BSEmcExtractDigisFromWaveforms< ParSet >::fEnergyDigiThreshold {0}

protected

Definition at line 218 of file BSEmcExtractDigisFromWaveforms.h.

Referenced by BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::Init().

◆ fMCDepositBranchName

template<class ParSet>

TString BSEmcExtractDigisFromWaveforms< ParSet >::fMCDepositBranchName {""}

protected

Definition at line 210 of file BSEmcExtractDigisFromWaveforms.h.

Referenced by BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::Exec(), and BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::Init().

◆ fPSA

template<class ParSet>

BSEmcAbsPSA* BSEmcExtractDigisFromWaveforms< ParSet >::fPSA {nullptr}

protected

Definition at line 220 of file BSEmcExtractDigisFromWaveforms.h.

Referenced by BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::Exec(), BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::Init(), and BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::~BSEmcExtractDigisFromWaveforms().

◆ fWaveformArray

template<class ParSet>

TClonesArray* BSEmcExtractDigisFromWaveforms< ParSet >::fWaveformArray {nullptr}

protected

Definition at line 214 of file BSEmcExtractDigisFromWaveforms.h.

Referenced by BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::Exec(), and BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::Init().

◆ fWaveformBranchName

template<class ParSet>

TString BSEmcExtractDigisFromWaveforms< ParSet >::fWaveformBranchName {""}

protected

Definition at line 217 of file BSEmcExtractDigisFromWaveforms.h.

Referenced by BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::Init(), and BSEmcExtractDigisFromWaveforms< BSEmcFwEndcapDigiPar >::SetWaveformBranchName().

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

BSEmcExtractDigisFromWaveforms.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<class ParSet> class BSEmcExtractDigisFromWaveforms< ParSet >

Constructor & Destructor Documentation

◆ BSEmcExtractDigisFromWaveforms()

◆ ~BSEmcExtractDigisFromWaveforms()

Member Function Documentation

◆ ClassDef()

◆ DefinePSA()

◆ Exec()

◆ GetGainType()

◆ GetTimeStamp()

◆ Init()

◆ SetDigiBranchName()

◆ SetParContainers()

◆ SetStorageOfData()

◆ SetWaveformBranchName()

Member Data Documentation

◆ fDetectorName

◆ fDigiArray

◆ fDigiBranchName

◆ fDigiPar

◆ fEnergyDigiThreshold

◆ fMCDepositBranchName

◆ fPSA

◆ fWaveformArray

◆ fWaveformBranchName

template<class ParSet>
class BSEmcExtractDigisFromWaveforms< ParSet >