SEvent/PMT.h

Go to the documentation of this file.

#ifndef _sevt_PMT_h_
#define _sevt_PMT_h_

#include <utl/ShadowPtr.h>
#include <utl/MultiTrace.h>
#include <utl/IteratorRange.h>

#include <sevt/StationConstants.h>
#include <sevt/PMTSimData.h>
#include <sevt/PMTRecData.h>
#include <sevt/PMTCalibData.h>
#include <sevt/PMTQuality.h>

#include <sdet/PMTConstants.h>


namespace sevt {

  class Station;


  class PMT {

  public:
    unsigned int GetId() const { return fId; }

    // return PMT type (e.g. eWaterCherenkovLarge)
    sdet::PMTConstants::PMTType GetType() const { return fPMTType; }

    int GetStationId() const { return fStationId; }

    PMTSimData& GetSimData() { return *fPMTSimData; }
    const PMTSimData& GetSimData() const { return *fPMTSimData; }
    void MakeSimData();
    bool HasSimData() const { return bool(fPMTSimData); }

    PMTRecData& GetRecData() { return *fPMTRecData; }
    const PMTRecData& GetRecData() const { return *fPMTRecData; }
    void MakeRecData();
    bool HasRecData() const { return bool(fPMTRecData); }

    PMTCalibData& GetCalibData() { return *fPMTCalibData; }
    const PMTCalibData& GetCalibData() const { return *fPMTCalibData; }
    void MakeCalibData();
    bool HasCalibData() const { return bool(fPMTCalibData); }

    PMTQuality& GetQuality() { return *fPMTQuality; }
    const PMTQuality& GetQuality() const { return *fPMTQuality; }
    void MakeQuality();
    bool HasQuality() const { return bool(fPMTQuality); }

    utl::TraceI& GetFADCTrace(const sdet::PMTConstants::PMTGain gain = sdet::PMTConstants::eHighGain,
                              const StationConstants::SignalComponent source = StationConstants::eTotal)
    { return fFADCTrace[gain].GetTrace(source); }
    const utl::TraceI& GetFADCTrace(const sdet::PMTConstants::PMTGain gain = sdet::PMTConstants::eHighGain,
                                    const StationConstants::SignalComponent source = StationConstants::eTotal) const
    { return fFADCTrace[gain].GetTrace(source); }

    void MakeFADCTrace(const StationConstants::SignalComponent source = StationConstants::eTotal);

    bool HasFADCTrace(const StationConstants::SignalComponent source = StationConstants::eTotal) const
    { return fFADCTrace[sdet::PMTConstants::eHighGain].HasLabel(source); }

    const utl::MultiTraceI& GetMultiFADCTrace(const sdet::PMTConstants::PMTGain gain = sdet::PMTConstants::eHighGain) const
    { return fFADCTrace[gain]; }

    typedef utl::MultiTraceI::Iterator FADCTraceIterator;
    typedef utl::MultiTraceI::ConstIterator ConstFADCTraceIterator;

    FADCTraceIterator FADCTracesBegin(const sdet::PMTConstants::PMTGain gain = sdet::PMTConstants::eHighGain)
    { return fFADCTrace[gain].Begin(); }
    FADCTraceIterator FADCTracesEnd(const sdet::PMTConstants::PMTGain gain = sdet::PMTConstants::eHighGain)
    { return fFADCTrace[gain].End(); }
    ConstFADCTraceIterator FADCTracesBegin(const sdet::PMTConstants::PMTGain gain = sdet::PMTConstants::eHighGain) const
    { return fFADCTrace[gain].Begin(); }
    ConstFADCTraceIterator FADCTracesEnd(const sdet::PMTConstants::PMTGain gain = sdet::PMTConstants::eHighGain) const
    { return fFADCTrace[gain].End(); }
    OFFLINE_MAKE_BOTH_ITERATOR_RANGES_ARG(FADCTraceIterator, ConstFADCTraceIterator, FADCTraces, const sdet::PMTConstants::PMTGain arg = sdet::PMTConstants::eHighGain)

    // these should be removed in FatBastard
    FADCTraceIterator FADCHGTracesBegin() { return fFADCTrace[sdet::PMTConstants::eHighGain].Begin(); }
    FADCTraceIterator FADCHGTracesEnd() { return fFADCTrace[sdet::PMTConstants::eHighGain].End(); }
    ConstFADCTraceIterator FADCHGTracesBegin() const { return fFADCTrace[sdet::PMTConstants::eHighGain].Begin(); }
    ConstFADCTraceIterator FADCHGTracesEnd() const { return fFADCTrace[sdet::PMTConstants::eHighGain].End(); }
    OFFLINE_MAKE_BOTH_ITERATOR_RANGES(FADCTraceIterator, ConstFADCTraceIterator, FADCHGTraces)

    FADCTraceIterator FADCLGTracesBegin() { return fFADCTrace[sdet::PMTConstants::eLowGain].Begin(); }
    FADCTraceIterator FADCLGTracesEnd() { return fFADCTrace[sdet::PMTConstants::eLowGain].End(); }
    ConstFADCTraceIterator FADCLGTracesBegin() const { return fFADCTrace[sdet::PMTConstants::eLowGain].Begin(); }
    ConstFADCTraceIterator FADCLGTracesEnd() const { return fFADCTrace[sdet::PMTConstants::eLowGain].End(); }
    OFFLINE_MAKE_BOTH_ITERATOR_RANGES(FADCTraceIterator, ConstFADCTraceIterator, FADCLGTraces)

    
    utl::TraceD& GetFADCTraceD(const sdet::PMTConstants::PMTGain gain = sdet::PMTConstants::eHighGain,
                               const StationConstants::SignalComponent source = StationConstants::eTotal)
    { return fFADCTraceD[gain].GetTrace(source); }
    const utl::TraceD& GetFADCTraceD(const sdet::PMTConstants::PMTGain gain = sdet::PMTConstants::eHighGain,
                                     const StationConstants::SignalComponent source = StationConstants::eTotal) const
    { return fFADCTraceD[gain].GetTrace(source); }

    const utl::MultiTraceD& GetMultiFADCTraceD(const sdet::PMTConstants::PMTGain gain = sdet::PMTConstants::eHighGain) const
    { return fFADCTraceD[gain]; }

    typedef utl::MultiTraceD::Iterator FADCTraceIteratorD;
    typedef utl::MultiTraceD::ConstIterator ConstFADCTraceIteratorD;

    FADCTraceIteratorD FADCTracesDBegin(const sdet::PMTConstants::PMTGain gain = sdet::PMTConstants::eHighGain)
    { return fFADCTraceD[gain].Begin(); }
    FADCTraceIteratorD FADCTracesDEnd(const sdet::PMTConstants::PMTGain gain = sdet::PMTConstants::eHighGain)
    { return fFADCTraceD[gain].End(); }
    ConstFADCTraceIteratorD FADCTracesDBegin(const sdet::PMTConstants::PMTGain gain = sdet::PMTConstants::eHighGain) const
    { return fFADCTraceD[gain].Begin(); }
    ConstFADCTraceIteratorD FADCTracesDEnd(const sdet::PMTConstants::PMTGain gain = sdet::PMTConstants::eHighGain) const
    { return fFADCTraceD[gain].End(); }
    OFFLINE_MAKE_BOTH_ITERATOR_RANGES(FADCTraceIteratorD, ConstFADCTraceIteratorD, FADCTracesD)

  private:
    PMT(const unsigned int id, const int stationId,
        const sdet::PMTConstants::PMTType ptype = sdet::PMTConstants::eWaterCherenkovLarge)
      : fId(id), fStationId(stationId), fPMTType(ptype) { }

    ~PMT() = default;

    unsigned int fId = 0;
    int fStationId = 0;
    sdet::PMTConstants::PMTType fPMTType = sdet::PMTConstants::eWaterCherenkovLarge;

    utl::ShadowPtr<PMTSimData> fPMTSimData;
    utl::ShadowPtr<PMTRecData> fPMTRecData;
    utl::ShadowPtr<PMTCalibData> fPMTCalibData;
    utl::ShadowPtr<PMTQuality> fPMTQuality;

    utl::MultiTraceI fFADCTrace[sdet::PMTConstants::eNumberOfGains];
    utl::MultiTraceD fFADCTraceD[sdet::PMTConstants::eNumberOfGains];  // <-- rename this to fAnalogTrace

    friend class Station;

  };


  class PMTFilter {
  public:
    PMTFilter(const sdet::PMTConstants::PMTType type) : fType(type) { }

    bool operator()(const PMT& pmt) const
    { return fType == sdet::PMTConstants::eAnyType || pmt.GetType() == fType; }

  private:
    const sdet::PMTConstants::PMTType fType;
  };

}


#endif