RdChannelTimeSeriesClipper.cc

Go to the documentation of this file.

#include "RdChannelTimeSeriesClipper.h"

#include <fwk/CentralConfig.h>
#include <fwk/RunController.h>

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

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


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


namespace RdChannelTimeSeriesClipper {

  VModule::ResultFlag
  RdChannelTimeSeriesClipper::Init()
  {
    Branch topBranch = CentralConfig::GetInstance()->GetTopBranch("RdChannelTimeSeriesClipper");
    topBranch.GetChild("InfoLevel").GetData(fInfoLevel);
    topBranch.GetChild("NumberOfSamplesToKeep").GetData(fNumberOfSamplesToKeep);
    topBranch.GetChild("NumberOfSamplesToRemove").GetData(fNumberOfSamplesToRemove);
    topBranch.GetChild("ClippingMethod").GetData(fMethodTypeString);

    //setting the clipping method
    if (fMethodTypeString == "RemoveSamplesFromFront") {
      fMethod = eRemoveSamplesFromFront;
    } else if (fMethodTypeString == "RemoveSamplesFromBack") {
      fMethod = eRemoveSamplesFromBack;
    } else {
      fMethod = eUndefined;
    }

    ostringstream info;

    // check for valid xml input
    if ((fNumberOfSamplesToKeep > 0 && fNumberOfSamplesToRemove > 0) ||
        (fNumberOfSamplesToKeep == 0 && fNumberOfSamplesToRemove == 0)) {
      ERROR("One of the fields (NumberOfSamplesToKeep, NumberOfSamplesToRemove) must be zero to define the stragegy");
      return eFailure;
    }

    info.str("");
    if (fNumberOfSamplesToKeep > 0) {
      info << "Will set all the trace to a size of " << fNumberOfSamplesToKeep << " samples";
      INFOFinal(info);
    } else {
      info << "Will remove " << fNumberOfSamplesToRemove << " samples from the trace";
      INFOFinal(info);
    }

    return eSuccess;
  }


  VModule::ResultFlag
  RdChannelTimeSeriesClipper::Run(evt::Event& event)
  {
    // Check if there are events at all
    if (!event.HasREvent()) {
      INFO("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()) // skip inactive channels
          continue;

        // Work on the time trace of this channel
        ChannelTimeSeries& timeSeries = channel.GetChannelTimeSeries();
        const int samplesInTrace = timeSeries.GetSize();

        if ((fMethod == eRemoveSamplesFromBack || fMethod == eRemoveSamplesFromFront) &&
            samplesInTrace < fNumberOfSamplesToRemove && fNumberOfSamplesToKeep == 0) {
          info.str("");
          info << "Station "<< station.GetId() << " Channel " << channel.GetId()
               << ": You want to remove " << fNumberOfSamplesToRemove
               << " samples which is more than the length of the time series: " << samplesInTrace
               << ", skip to next channel";
          WARNING(info);

          continue;
        }

        if ((fMethod == eRemoveSamplesFromBack || fMethod == eRemoveSamplesFromFront) &&
             fNumberOfSamplesToKeep > 0 && fNumberOfSamplesToKeep > samplesInTrace) {
          info.str("");
          info << "Station " << station.GetId() << " Channel " << channel.GetId()
               << ": You want to keep " << fNumberOfSamplesToKeep
               << " samples which is more than the length of the time series: " << samplesInTrace
               << ", skip to next channel";
          WARNING(info);

          continue;
        }

        if (fNumberOfSamplesToKeep != 0) {
          fNumberOfSamplesToRemove = samplesInTrace - fNumberOfSamplesToKeep;
        }

        if (fInfoLevel > eInfoIntermediate) {
          info.str("");
          info << "get size: " << samplesInTrace << "\n"
               << "fNumberOfSamplesToRemove = " << fNumberOfSamplesToRemove;

          if (fNumberOfSamplesToKeep > 0)
            info << "\nfNumberOfSamplesToKeep = " << fNumberOfSamplesToKeep;

          INFOIntermediate(info);
        }

        // clipping the time series
        switch(fMethod)
        {
          case eRemoveSamplesFromBack:
          {
            for (int i = 0; i < fNumberOfSamplesToRemove; ++i)
              timeSeries.PopBack();
            break;
          }

          case eRemoveSamplesFromFront:
          {
            ChannelTimeSeries tempTimeSeries;
            tempTimeSeries.SetBinning(timeSeries.GetBinning());

            ChannelTimeSeries::SizeType iBegin = ChannelTimeSeries::SizeType(fNumberOfSamplesToRemove);
            for (ChannelTimeSeries::SizeType i = iBegin; i < timeSeries.GetSize(); ++i)
              tempTimeSeries.PushBack(timeSeries[i]);

            timeSeries = tempTimeSeries;  // overwrite timetrace!

            // redefining the start time. keep parameter open because it might be overwritten by other modules
            const double newStartTime =  station.GetRecData().GetParameter(eTraceStartTime) +
              fNumberOfSamplesToRemove * timeSeries.GetBinning();
            station.GetRecData().SetParameter(eTraceStartTime, newStartTime, false);
            break;
          }

          case eUndefined:
          {
            WARNING("Undefined ClippingMethod. No Clipping performed");
            return eSuccess;
            break;
          }
        }
      }
    }

    return eSuccess;
  }


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

}