RdChannelLinearPredictorRFISuppressor.h

Go to the documentation of this file.

#ifndef _RdChannelLinearPredictorRFISuppressor_h_
#define _RdChannelLinearPredictorRFISuppressor_h_

#include <vector>

#include <fwk/VModule.h>
#include <revt/Channel.h>
#include <revt/Station.h>


namespace RdChannelLinearPredictorRFISuppressor {

  // A simple struct to store the information about the samples in the trace and the regions that they belong to
  struct SampleData {
    std::string HelpOutput();

    double fBinning = 0;
    unsigned int fNumCoefficients = 0;
    unsigned int fDelayLine = 0;
    // N.B. TrainRegion (LP) and NoiseWindow are separate entities and should be disjoint!
    unsigned int fTrainRegionStart = 0;
    unsigned int fTrainRegionStop = 0;
    unsigned int fMinimumTrainRegionLength = 0;
    unsigned int fTraceLength = 0;
    // These values will contain the regions that are occupied by the SignalSearchWindow and the SignalNoiseWindow with extra margins added
    unsigned int fOccupiedRegion1Start = 0;
    unsigned int fOccupiedRegion1Stop = 0;
    unsigned int fOccupiedRegion2Start = 0;
    unsigned int fOccupiedRegion2Stop = 0;
    unsigned int fTotalTraceLength = 0;
    // Values may become negative: then something is wrong and an error is generated but first it must be allowed to become negative
    int fTrainRegionLength = 0;
  };

  class RdChannelLinearPredictorRFISuppressor : public fwk::VModule {

  public:
    fwk::VModule::ResultFlag Init() override;
    fwk::VModule::ResultFlag Run(evt::Event& event) override;
    fwk::VModule::ResultFlag Finish() override;

    void FillSampleDataWithRelevantValuesForFirstChannel(SampleData &samples,
        revt::ChannelTimeSeries const &timeseries, revt::Station const &station);
    fwk::VModule::ResultFlag TestSampleDataForConsistency(SampleData &samples,
        revt::ChannelTimeSeries const &timeseries);

  private:
    double fSegmentLength = 0;
    double fDelayLine = 0;
    double fTrainRegionStartOverride = 0;
    double fTrainRegionStopOverride = 0;
    double fFudgeFactor = 0;
    double fMinimumTrainRegionLength = 0;
    double fWindowMargins = 0;
    unsigned int fNumChannels = 0;
    unsigned int fOptimization = 0;

    unsigned int TranslateTimeToSample(double time, double binning, char const *name);
    bool TestOverlap(int a1, int a2, int b1, int b2);

    REGISTER_MODULE("RdChannelLinearPredictorRFISuppressor", RdChannelLinearPredictorRFISuppressor);
  };

}


#endif