RdStationTimeSeriesWindowCutter.cc

Go to the documentation of this file.

#include "RdStationTimeSeriesWindowCutter.h"

#include <fwk/CentralConfig.h>

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

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


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


namespace RdStationTimeSeriesWindowCutter {

  VModule::ResultFlag
  RdStationTimeSeriesWindowCutter::Init()
  {
    Branch topBranch =
      CentralConfig::GetInstance()->GetTopBranch("RdStationTimeSeriesWindowCutter");
    topBranch.GetChild("WindowSize").GetData(fWindowSize);
    topBranch.GetChild("WindowStart").GetData(fWindowStart);

    string tmpstring = topBranch.GetChild("WindowType").Get<string>();
    if (tmpstring == "eUserSignalWindow") {
      fWindowType = eUserSignalWindow;
    } else if (tmpstring == "eRecSignalWindow") {
      fWindowType = eRecSignalWindow;
    } else if (tmpstring == "eUserWindow") {
      fWindowType = eUserWindow;
    } else {
      ERROR("Undefined Window Type in xml - file.");
      return eFailure;
    }

    return eSuccess;
  }


  VModule::ResultFlag
  RdStationTimeSeriesWindowCutter::Run(evt::Event& event)
  {
    // Check if there are events at all
    if(!event.HasREvent()) {
      WARNING("No radio event found!");
      return eContinueLoop;
    }

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

    for (auto& station : rEvent.StationsRange()) {
      auto& sRecData = station.GetRecData();

      switch(fWindowType)
      {
        case eUserWindow:
        {
          // nothing to do here.
          break;
        }

        case eUserSignalWindow:
        {
          if (!station.HasRecData()) {
            info.str("");
            info << "Station " << station.GetId() << " has no reconstructed signal";
            WARNING(info);
            return eContinueLoop;
          }

          if (sRecData.HasParameter(eSignalTime)) {
           fWindowStart = sRecData.GetParameter(eSignalTime) - sRecData.GetParameter(eTraceStartTime)
                        - (fWindowSize / 2.);
            if (fWindowStart < 0) {
              info.str("");
              info << "Station " << station.GetId() << " has window set before starting of the time series"
                   << " - that should never happen. It can happen when eSignalTime is 0 for some reason."
                   << " Maybe you added an empty station and forgot to add noise. Check what went wrong!";
              ERROR(info);
              continue;
            }
          } else {
            if (station.IsCandidate()) {
              // just raise warning if station is candidate <-> not rejected
              info.str("");
              info << "Station " << station.GetId() << " has no SignalTime. Using middle of SignalSearchWindow instead";
              WARNING(info);
            }

           fWindowStart = ((sRecData.GetParameter(eSignalSearchWindowStart)
                          - sRecData.GetParameter(eSignalSearchWindowStop)) / 2.) - (fWindowSize / 2.);
         }

          break;
        }

        case eRecSignalWindow:
        {
          if (!station.HasRecData()) {
            info.str("");
            info << "Station " << station.GetId() << " has no reconstructed signal";
            WARNING(info);
            return eContinueLoop;
          }

          fWindowStart = sRecData.GetParameter(eSignalSearchWindowStart);
          fWindowSize = sRecData.GetParameter(eSignalSearchWindowStop) - fWindowStart;

          break;
        }
      }

      StationTimeSeries& stationTrace = station.GetStationTimeSeries();
      const double binning = stationTrace.GetBinning();
      StationTimeSeries temp;
      temp.SetBinning(binning);

      // resizing the window
      const auto& iBegin = StationTimeSeries::SizeType(fWindowStart / binning);
      const auto& iEnd = StationTimeSeries::SizeType((fWindowStart + fWindowSize) / binning);
      for (auto i = iBegin; i < iEnd; ++i)
        temp.PushBack(stationTrace[i]);
      stationTrace = temp;

      // redefine the start time. keep parameter open because it might be overwritten by other modules
      sRecData.SetParameter(eTraceStartTime, sRecData.GetParameter(eTraceStartTime) + fWindowStart, false);

      // redefine the window sizes
      sRecData.SetParameter(eSignalSearchWindowStart, sRecData.GetParameter(eSignalSearchWindowStart) - fWindowStart, false);
      sRecData.SetParameter(eSignalSearchWindowStop, sRecData.GetParameter(eSignalSearchWindowStop) - fWindowStart, false);
      sRecData.SetParameter(eNoiseWindowStart, sRecData.GetParameter(eNoiseWindowStart) - fWindowStart, false);
      sRecData.SetParameter(eNoiseWindowStop, sRecData.GetParameter(eNoiseWindowStop) - fWindowStart, false);
    }

    return eSuccess;
  }


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

}