TOPDigitizerModule.h

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#pragma once
 
#include <framework/core/Module.h>
 
#include <framework/datastore/StoreArray.h>
#include <top/dataobjects/TOPSimHit.h>
#include <top/dataobjects/TOPSimCalPulse.h>
#include <top/dataobjects/TOPDigit.h>
#include <top/dataobjects/TOPRawDigit.h>
#include <top/dataobjects/TOPRawWaveform.h>
#include <mdst/dataobjects/MCParticle.h>
#include <simulation/dataobjects/SimClockState.h>
 
#include <framework/database/DBObjPtr.h>
#include <top/dbobjects/TOPSampleTimes.h>
#include <top/dbobjects/TOPCalTimebase.h>
#include <top/dbobjects/TOPCalChannelT0.h>
#include <top/dbobjects/TOPCalAsicShift.h>
#include <top/dbobjects/TOPCalModuleT0.h>
#include <top/dbobjects/TOPCalCommonT0.h>
#include <top/dbobjects/TOPCalChannelPulseHeight.h>
#include <top/dbobjects/TOPCalChannelThreshold.h>
#include <top/dbobjects/TOPCalChannelNoise.h>
#include <top/dbobjects/TOPFrontEndSetting.h>
#include <top/dbobjects/TOPCalTimeWalk.h>
 
#include <top/modules/TOPDigitizer/PulseHeightGenerator.h>
 
 
namespace Belle2 {
  class TOPDigitizerModule : public Module {
 
  public:
 
    TOPDigitizerModule();
 
    virtual void initialize() override;
 
    virtual void beginRun() override;
 
    virtual void event() override;
 
  private:
 
    struct TimeOffset {
      double value = 0; 
      double error = 0; 
      int windowShift = 0; 
      double timeShift = 0; 
      TimeOffset(double v, double e, int n, double t):
        value(v), error(e), windowShift(n), timeShift(t)
      {}
    };
 
    TimeOffset getTimeOffset(double trgOffset, int moduleID, int pixelID);
 
    double generatePulseHeight(int moduleID, int pixelID) const;
 
    // module steering parameters
    double m_timeZeroJitter;       
    double m_electronicJitter;     
    double m_darkNoise;            
    double m_ADCx0; 
    double m_ADCp1; 
    double m_ADCp2; 
    double m_ADCmax; 
    double m_rmsNoise; 
    int m_threshold; 
    int m_hysteresis; 
    int m_thresholdCount; 
    bool m_useWaveforms; 
    bool m_useDatabase;  
    bool m_useSampleTimeCalibration;   
    bool m_simulateTTS; 
    bool m_allChannels; 
    double m_minWidthXheight;  
    int m_lookBackWindows;     
    // datastore objects
    StoreArray<TOPSimHit> m_simHits;        
    StoreArray<TOPSimCalPulse> m_simCalPulses; 
    StoreArray<MCParticle> m_mcParticles;   
    StoreObjPtr<SimClockState> m_simClockState; 
    StoreArray<TOPRawWaveform> m_waveforms; 
    StoreArray<TOPRawDigit> m_rawDigits;    
    StoreArray<TOPDigit> m_digits;          
    // constants from conditions DB
    DBObjPtr<TOPCalTimebase> m_timebases; 
    DBObjPtr<TOPCalChannelT0> m_channelT0; 
    DBObjPtr<TOPCalAsicShift> m_asicShift; 
    DBObjPtr<TOPCalModuleT0> m_moduleT0;   
    DBObjPtr<TOPCalCommonT0> m_commonT0;   
    DBObjPtr<TOPCalChannelPulseHeight> m_pulseHeights; 
    DBObjPtr<TOPCalChannelThreshold> m_thresholds; 
    DBObjPtr<TOPCalChannelNoise> m_noises; 
    OptionalDBObjPtr<TOPCalTimeWalk> m_timeWalk;   
    DBObjPtr<TOPFrontEndSetting> m_feSetting;   
    // default for no DB or calibration not available
    TOPSampleTimes m_sampleTimes; 
    TOP::PulseHeightGenerator m_pulseHeightGenerator; 
    // other
    double m_syncTimeBase = 0; 
  };
 
} // Belle2 namespace