RdChannelResponseIncorporator.h

Go to the documentation of this file.

#ifndef _RdChannelResponseIncorporator_RdChannelResponseIncorporator_h_
#define _RdChannelResponseIncorporator_RdChannelResponseIncorporator_h_

#include <fwk/VModule.h>
#include <boost/tuple/tuple.hpp>
#include <vector>


namespace revt {
  class Channel;
}

namespace utl {
  class TabulatedFunctionComplexLgAmpPhase;
  class ResponseMap;
  class RandomEngine;
}


namespace RdChannelResponseIncorporator {

  class RdChannelResponseIncorporator : public fwk::VModule {

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

    typedef boost::tuple<utl::ResponseMap, utl::TabulatedFunctionComplexLgAmpPhase, long> CacheRecord;

  private:
    unsigned int fNumResponsesToCache = 5;
    bool fForwardResponseOnFirstCall = false;
    mutable long fCacheAsks = 0;
    mutable long fCacheHits = 0;
    mutable std::vector<CacheRecord> fCacheRegistry;
    bool fInverseBandLimitsOverride = false;
    double fInverseLowerFrequency = 0;
    double fInverseUpperFrequency = 0;
    bool fForwardBandLimitsOverride = false;
    double fForwardLowerFrequency = 0;
    double fForwardUpperFrequency = 0;

    bool fSmearChannelTraceToMimicInaccurateHardwareDescription = false;
    double fRelativeGaussianUcertainty = 0.0;

    utl::RandomEngine *fRandomEngine = nullptr;

    const utl::TabulatedFunctionComplexLgAmpPhase& GetCachedOverallResponse(const utl::ResponseMap& responsemap) const;
    utl::TabulatedFunctionComplexLgAmpPhase CalculateOverallResponse(const utl::ResponseMap& responsemap) const;
    void ApplyResponse(revt::Channel& channel, const utl::TabulatedFunctionComplexLgAmpPhase& response,
                       bool inverse, double lowerfreq, double upperfreq) const;

    REGISTER_MODULE("RdChannelResponseIncorporator", RdChannelResponseIncorporator);
  };

}


#endif