RdChannelNoiseGenerator.h

Go to the documentation of this file.

#ifndef _RdChannelNoiseGenerator_RdChannelNoiseGenerator_h_
#define _RdChannelNoiseGenerator_RdChannelNoiseGenerator_h_

#include <fwk/VModule.h>
#include <utl/ShadowPtr.h>
#include <utl/NoiseSaS.h>
#include <revt/Station.h>

#include <boost/random.hpp>
#include <boost/random/exponential_distribution.hpp>
#include <boost/random/uniform_real.hpp>


namespace evt {
  class Event;
}

namespace revt {
  class Channel;
}

namespace utl {
  class Noise;
}


namespace RdChannelNoiseGenerator {

  class RdChannelNoiseGenerator : public fwk::VModule {

  public:
    // If you define a constructor, you MUST provide an implementation
    // for it, otherwise the REGISTER_MODULE macro will not register
    // your module. (Here, implementation in RdChannelNoiseGenerator.cc)
    RdChannelNoiseGenerator();
    ~RdChannelNoiseGenerator() override { }

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

  private:
    std::string fNoiseType;
    enum InfoLevel {
      eNone = 0,
      eFinal = 1,
      eIntermediate = 2,
      eObscure = 3,
      eDebug = 4
    };

    // xml settings
    int fInfoLevel;
    double fSaSSigmaOverride;
    double fSaSAlphaOverride;
    double fNoiseRMS;

    boost::mt19937 randgen;
    boost::uniform_real<double> interval_noise;
    boost::uniform_real<double> interval_h;
    boost::variate_generator<boost::mt19937, boost::uniform_real<double> > randomGenerator_sigma;
    boost::variate_generator<boost::mt19937, boost::uniform_real<double> > randomGenerator_h;
    utl::ShadowPtr<utl::Noise> fNoise;
    utl::ShadowPtr<utl::NoiseSaS> fNoise_time_domain;
    friend class utl::ShadowPtr<utl::Noise>;// necessary so that ShadowPtr can delete members of FFTDataContainer

    // The REGISTER_MODULE macro makes the framework aware of your module.
    // You need to put this macro at the very end of your module class definition.
    // Give your module a name (first argument) and specify its
    // class name (second argument).  In the ModuleSequenceExample.xml file,
    // you can see this module being refered to by the name we give it here.

    REGISTER_MODULE("RdChannelNoiseGenerator", RdChannelNoiseGenerator);

  };

}


#endif

// Configure (x)emacs for this file ...
// Local Variables:
// mode: c++
// compile-command: "make -k"
// End: