RdChannelUpsampler.cc

Go to the documentation of this file.

#include "RdChannelUpsampler.h"

#include <fwk/CentralConfig.h>

#include <utl/ErrorLogger.h>
#include <utl/Reader.h>
#include <utl/config.h>
#include <utl/TraceAlgorithm.h>
#include <utl/FFTDataContainerAlgorithm.h>

#include <evt/Event.h>
#include <revt/REvent.h>
#include <revt/Station.h>
#include <revt/Channel.h>


using namespace fwk;
using namespace utl;
using namespace std;
using namespace revt;


namespace RdChannelUpsampler {


  VModule::ResultFlag
  RdChannelUpsampler::Init()
  {
    // Read in the configurations of the xml file
    Branch topBranch =
      CentralConfig::GetInstance()->GetTopBranch("RdChannelUpsampler");
    topBranch.GetChild("InfoLevel").GetData(fInfoLevel);
    topBranch.GetChild("RemoveOffset").GetData(fRemoveOffset);
    topBranch.GetChild("UseTargetFrequency").GetData(fUseTargetFrequency);
    topBranch.GetChild("UpsamplingFactor").GetData(fUpsamplingFactor);
    topBranch.GetChild("TargetFrequency").GetData(fTargetFrequency);

    ostringstream info;
    info << "RdChannelUpsampler set up with UpsamplingFactor of "
         << fUpsamplingFactor << " and RemoveOffset " << fRemoveOffset << ".";
    INFOIntermediate(info);

    return eSuccess;
  }


  VModule::ResultFlag
  RdChannelUpsampler::Run(evt::Event& event)
  {
    // Check if upsampling shall be done at all
    if (fUpsamplingFactor < 2) {
      WARNING("No upsampling will be done as UpsamplingFactor < 2!");
      return eContinueLoop;
    }

    // Check if there are events at all
    if (!event.HasREvent()) {
      WARNING("No radio event found!");
      return eContinueLoop;
    }

    REvent& rEvent = event.GetREvent();
    ostringstream info;

    // loop through stations and for every station through every channel
    for (auto& station : rEvent.StationsRange()) {
      for (auto& channel : station.ChannelsRange()) {

        if (!channel.IsActive())
          continue;

        unsigned int upsamplingFactor = 0;
        if (!fUseTargetFrequency)
          upsamplingFactor = fUpsamplingFactor;
        else {
          const double frequency = 1. / channel.GetChannelTimeSeries().GetBinning();
          const double ratio = fTargetFrequency / frequency;
          constexpr double eps = 1e-6;
          const unsigned int intratio = int(ratio + eps);

          if (ratio <= 0 || abs(ratio - intratio) > eps) {
             ERROR ("Wrong target frequency!");
             return eFailure;
          }
          upsamplingFactor = intratio;
        }

        FFTDataContainerAlgorithm::UpsampleTimeSeries(channel.GetFFTDataContainer(),
                                                      upsamplingFactor, fRemoveOffset);

        info << "Upsampling of channel " << channel.GetId()
             << " of station " << channel.GetStationId()
             << " by a factor of " << upsamplingFactor << ".";
        INFOIntermediate(info);
      }
    }

    return eSuccess;
  }


  VModule::ResultFlag
  RdChannelUpsampler::Finish()
  {
    return eSuccess;
  }

}