PndEmcAbsWaveformSimulator.h

Go to the documentation of this file.

//****************************************************************************
//*                   This file is part of PandaRoot.                        *
//*                                                                          *
//*            PandaRoot is distributed under the terms of the               *
//*              GNU General Public License (GPL) version 3,                 *
//*                 copied verbatim in the file "LICENSE".                   *
//*                                                                          *
//*  Copyright (C) 2006 - 2024 FAIR GmbH and copyright holders of PandaRoot  *
//*     The copyright holders are listed in the file "COPYRIGHTHOLDERS".     *
//*               The authors are listed in the file "AUTHORS".              *
//****************************************************************************

#pragma once

#ifndef PNDEMCABSWAVEFORMSIMULATOR_H_
#define PNDEMCABSWAVEFORMSIMULATOR_H_

#include "TObject.h"
#include "TMath.h"
#include "TList.h"
#include "PndEmcAbsWaveformModifier.h"

class TClonesArray;
class PndEmcWaveform;
class PndEmcWaveformData;

#include "TROOT.h"
#include "TClonesArray.h"

class PndEmcAbsWaveformSimulator : public TObject {
 public:
  virtual PndEmcWaveform *Simulate(PndEmcWaveformData *wfData, TClonesArray *arrayToStore = nullptr) { return CallModifiers(MakeWaveform(wfData, arrayToStore)); }

  virtual PndEmcWaveform *SimulateSinglePulse(Double_t hitEnergy, Double_t hitTime, TClonesArray *arrayToStore = nullptr, Int_t detId = -1, Int_t trackId = -1, Int_t hitIndex = -1)
  {
    return CallModifiers(MakeSingleWaveform(hitEnergy, hitTime, arrayToStore, detId, trackId, hitIndex));
  }

  virtual PndEmcWaveform *Get1GevWaveform() = 0;

  virtual void GetAbsoluteTimeInterval(PndEmcWaveformData *wfData, Double_t &startTime, Double_t &activeTime) = 0; // in ns

  virtual Double_t GetTimeBeforeFirstHit(PndEmcWaveformData *) { return 0; } // in ns  // wfData //[R.K.03/2017] unused variable(s)

  virtual Double_t GetScale() = 0;

  virtual Double_t GetTotalScale()
  {
    Double_t totalScale = GetScale();

    TIter iterModifiers(&fListOfWaveformModifiers);
    while (PndEmcAbsWaveformModifier *wfmod = (PndEmcAbsWaveformModifier *)iterModifiers()) {
      totalScale *= wfmod->GetScale();
    }

    return totalScale;
  }

  virtual Double_t GetSampleRate() { return fSampleRate; }

  virtual void AddModifier(PndEmcAbsWaveformModifier *wfModifier) { fListOfWaveformModifiers.Add(wfModifier); }

 protected:
  PndEmcAbsWaveformSimulator() : fSampleRate(0){};
  PndEmcAbsWaveformSimulator(Double_t sampleRate) : fSampleRate(sampleRate){};

  virtual PndEmcWaveform *MakeWaveform(PndEmcWaveformData *wfData, TClonesArray *arrayToStore = nullptr) = 0;
  virtual PndEmcWaveform *
  MakeSingleWaveform(Double_t hitEnergy, Double_t hitTime, TClonesArray *arrayToStore = nullptr, Int_t detId = -1, Int_t trackId = -1, Int_t hitIndex = -1) = 0;

  /* sync adc clock with absolute time */
  inline void SyncWithADCClock(Double_t &time) { time = TMath::Floor(time * fSampleRate) / fSampleRate; };
 
  virtual PndEmcWaveform *CallModifiers(PndEmcWaveform *wf)
  {
    TIter iterModifiers(&fListOfWaveformModifiers);
    while (PndEmcAbsWaveformModifier *wfmod = (PndEmcAbsWaveformModifier *)iterModifiers()) {
      wfmod->Modify(wf);
    }
    return wf;
  }

  TList fListOfWaveformModifiers;
  Double_t fSampleRate; 

  ClassDef(PndEmcAbsWaveformSimulator, 3);
};

#endif