REvent/Channel.h

Go to the documentation of this file.

#ifndef _revt_Channel_h_
#define _revt_Channel_h_

#include <revt/ChannelRecData.h>

#include <utl/ShadowPtr.h>
#include <utl/FFTDataContainer.h>
#include <utl/ClassHelpers.h>

namespace revt {

  class Station;


  typedef utl::Trace<int> ChannelADCTimeSeries;
  typedef utl::Trace<double> ChannelTimeSeries;
  typedef utl::Trace<std::complex<double>> ChannelFrequencySpectrum;
  typedef utl::FFTDataContainer<utl::Trace, double, std::complex<double>> ChannelFFTDataContainer;


  class Channel {

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

    int GetStationId() const { return fStationId; }

    unsigned int GetNyquistZone() const { return fFFTDataContainer.GetNyquistZone(); }
    void SetNyquistZone(const unsigned int zone) { fFFTDataContainer.SetNyquistZone(zone); }

    double GetFrequencyOfBin(const ChannelFrequencySpectrum::SizeType bin) const { return fFFTDataContainer.GetFrequencyOfBin(bin); }

    double GetMinimumFrequency() const
    { return std::min(GetFrequencyOfBin(0), GetFrequencyOfBin(fFFTDataContainer.GetConstFrequencySpectrum().GetSize() - 1)); }

    double GetMaximumFrequency() const
    { return std::max(GetFrequencyOfBin(0), GetFrequencyOfBin(fFFTDataContainer.GetConstFrequencySpectrum().GetSize() - 1)); }

    ChannelTimeSeries& GetChannelTimeSeries() { return fFFTDataContainer.GetTimeSeries(); }
    const ChannelTimeSeries& GetChannelTimeSeries() const { return fFFTDataContainer.GetConstTimeSeries(); }

    ChannelFrequencySpectrum& GetChannelFrequencySpectrum() { return fFFTDataContainer.GetFrequencySpectrum(); }
    const ChannelFrequencySpectrum& GetChannelFrequencySpectrum() const { return fFFTDataContainer.GetConstFrequencySpectrum(); }

    ChannelFFTDataContainer& GetFFTDataContainer() { return OFFLINE_CAST_CONST_METHOD(GetFFTDataContainer()); }
    const ChannelFFTDataContainer& GetFFTDataContainer() const { return fFFTDataContainer; }

    ChannelADCTimeSeries& GetChannelADCTimeSeries() { return OFFLINE_CAST_CONST_METHOD(GetChannelADCTimeSeries()); }
    const ChannelADCTimeSeries& GetChannelADCTimeSeries() const { return fChannelADCTrace; }

    void SetSaturated() { fIsSaturated = true; }
    void SetNotSaturated(){ fIsSaturated = false; }
    bool IsSaturated() const { return fIsSaturated; }

    void SetActive() { fIsActive = true; }
    void SetNotActive() { fIsActive = false; }
    bool IsActive() const { return fIsActive; }

    void SetSignalThreshold(const unsigned int thresh) { fSignalThreshold = thresh; }  
    void SetNoiseThreshold(const unsigned int thresh) { fNoiseThreshold = thresh; }  
    unsigned int GetSignalThreshold() const { return fSignalThreshold; }  
    unsigned int GetNoiseThreshold() const { return fNoiseThreshold; }  

    void SetScintHighVoltage(const double scinthv) { fScintHighVoltage = scinthv; }
    double GetScintHighVoltage() const { return fScintHighVoltage; }

    ChannelRecData& GetRecData() { return *fRecData; }
    const ChannelRecData& GetRecData() const { return *fRecData; }

    void MakeRecData();
    bool HasRecData() const { return bool(fRecData); }

    unsigned int GetParity() const { return fParity; }
    void SetParity(const unsigned int parity) { fParity = parity; }

  private:
    Channel(const int stationId, const int id) : fStationId(stationId), fId(id) { }

    int fStationId = 0;
    int fId = 0;
    bool fIsSaturated = false;
    bool fIsActive = true;
    unsigned int fSignalThreshold = 0;
    unsigned int fNoiseThreshold = 0;
    double fScintHighVoltage = 0;
    ChannelADCTimeSeries fChannelADCTrace;
    unsigned int fParity = 0;
    utl::ShadowPtr<ChannelRecData> fRecData;
    ChannelFFTDataContainer fFFTDataContainer;

    friend class revt::Station;

  };
}


#endif