RdStationSignalReconstructor/RdStationSignalReconstructor.h

Go to the documentation of this file.

#ifndef _RdStationSignalReconstructor_RdStationSignalReconstructor_h_
#define _RdStationSignalReconstructor_RdStationSignalReconstructor_h_

#include <fwk/VModule.h>
#include <map>


namespace revt {
  class Station;
}


namespace RdStationSignalReconstructor {

  class RdStationSignalReconstructor : public fwk::VModule {

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

  private:
    unsigned int fVectorialComponent = 0;
    bool fUseEnvelope = false;
    double fSignalIntegrationWindowSize = 0;

    bool fAddNoiseToUncertainty = false;

    double fMinSignal = 0;
    double fMinSignalToNoise = 0;
    double fAmplitudeUncertainty = 0;
    double fDefaultAntennaUncertainty = 0;
    double fButterflyAntennaUncertainty = 0;
    double fBlackSpiderAntennaUncertainty = 0;
    double fSallaRDAntennaUncertainty = 0;

    bool fSelfTriggeredSNcut = true;
    bool fAdjustSignalAmplitude = false;
    bool fLockParameterStorage = false;

    std::map<unsigned int, unsigned int> fNumberOfStationsInEvents;

    /* the formula is documented in GAP 2013-059
     * the input is the SNR defined as the maximum of the Hilbert envelope squared divided by the RMS of the Hilbert envelope squared
     */
    double GetSignalUncertainty(const double signalAmplitude, const double SNR) const;

    /* the formula is documented in PhD thesis of C. Glaser (RWTH Aachen University 2016)
     * the input is the SNR defined as the maximum of the Hilbert envelope squared divided by the RMS of the Hilbert envelope squared
     */
    double GetSignalTimeUncertainty(const double SNR) const;

    double GetAdjustedSignalAmplitude(const double signalAmpitude, const double SNR) const;

    double GetAntennaToAntennaUncertainty(const revt::Station& station) const;

    REGISTER_MODULE("RdStationSignalReconstructor", RdStationSignalReconstructor);
  };

}


#endif