RdStationSignalReconstructorWithBgSubtraction.h

Go to the documentation of this file.

#ifndef _RdStationSignalReconstructorWithBgSubtraction_RdStationSignalReconstructorWithBgSubtraction_h_
#define _RdStationSignalReconstructorWithBgSubtraction_RdStationSignalReconstructorWithBgSubtraction_h_

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

#include "Minuit2/MnUserParameters.h"
#include "Minuit2/MnUserParameterState.h"
#include <Minuit2/FCNBase.h>
#include <TF1.h>


namespace utl {
  class AnalyticWindow;
}

namespace evt {
  class Event;
}

namespace revt {
  class Channel;
}


namespace RdStationSignalReconstructorWithBgSubtraction {

  class RdStationSignalReconstructorWithBgSubtraction : public fwk::VModule {

  public:
    RdStationSignalReconstructorWithBgSubtraction() { }
    virtual ~RdStationSignalReconstructorWithBgSubtraction() { }

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

  private:
    // calculates Mean and RMS in selected noise window
    void Noisefinder(const revt::ChannelTimeSeries& channeltrace,
                     double& RMSNoise, double& MeanNoise, double NoiseWindowStart, double NoiseWindowStop) const;

    // calculates the amplitude and the position of the maximum in the signal search window
    void Pulsefinder(const revt::ChannelTimeSeries& channeltrace,
                     double& PeakAmplitude, double& PeakTime, double& PeakTimeError,
                     double SignalSearchWindowStart, double SignalSearchWindowStop, unsigned int& sample) const;

    // calculates the FWHM and the integral of the signal in the FWHM
    void PulseFWHMIntegrator(const revt::ChannelTimeSeries& channeltrace,unsigned int sample, double PeakAmplitude, double& SignalFWHM, double& IntegratedSignal, double& SignalWindowStart, double& SignalWindowStop) const;

    //void PulseFixedWindowIntegrator(const revt::ChannelTimeSeries& channeltrace, unsigned int sample, double IntegrationTime, double& IntegratedSignal, double& SignalWindowStart, double& SignalWindowStop, const bool usePower) const;

    // calculates the integrated signal in a fixed window
    void EnergyFluenceIntegral(revt::ChannelFrequencySpectrum& channeltrace, const std::vector<double>& uncertainty, double& integratedSignal, double& energyFluenceUncertainty, const bool usePower) const;

    void CalculateTheBGAverage(revt::ChannelFFTDataContainer& Long_FFTDataContainer, unsigned int nWindows, int nBin, int ntimeBin, double* const sigmaB, double* const meanB) const;

    /* 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;

    // xml settings
    unsigned int fVectorialComponent = 0;
    bool fUseEnvelope = false;
    double fSignalIntegrationWindowSize = 0;
    double fEnergyFluenceIntegrationWindowStart = 0;
    double fEnergyFluenceIntegrationWindowStop = 0;

    double fMinSignal = 0;
    double fMinSignalToNoise = 0;
    double fWindowSizeOnEachSide = 0;
    double fDefaultAntennaUncertainty = 0;
    double fButterflyAntennaUncertainty = 0;
    double fBlackSpiderAntennaUncertainty = 0;
    double fRelativeAmplitudeUncertainty = 0;

    bool fSelfTriggeredSNcut = true;
    bool fBackGroundSubtraction = false;

    unsigned int fTotalNumberOfEvents = 0;
    unsigned int fNumberOfEvents1SignalStations = 0;
    unsigned int fNumberOfEvents2SignalStations = 0;
    unsigned int fNumberOfEvents3SignalStations = 0;
    unsigned int fNumberOfEvents4SignalStations = 0;
    unsigned int fNumberOfEvents5SignalStations = 0;
    unsigned int fNumberOfEvents5plusSignalStations = 0;

    int fInfoLevel = 0;

    // this factor converts the integral of the squared signal amplitudes into an energy fluence in units of [eV/m^2]
    // a simple use of Offline's unit package is not possible in this case, because it is not just a change of units
    // but the evaluation and integration of the Poynting vector (so a multiplication with c and mu_0
    const double fConversionSignalToEnergyFluence = 2.65441729 * 1e-3 * 1.e-9 * 6.24150934 * 1e6;
    utl::AnalyticWindow* fWindow = nullptr;
    TF1* f_sigmoind = nullptr;

    REGISTER_MODULE("RdStationSignalReconstructorWithBgSubtraction", RdStationSignalReconstructorWithBgSubtraction);

  };

}


#endif