RdStationTimeWindowConsolidator.cc

Go to the documentation of this file.

#include "RdStationTimeWindowConsolidator.h"

#include <fwk/CentralConfig.h>

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

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

#include <string>


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


namespace RdStationTimeWindowConsolidatorOG {


  VModule::ResultFlag
  RdStationTimeWindowConsolidator::Init()
  {
    Branch topBranch =
      CentralConfig::GetInstance()->GetTopBranch("RdStationTimeWindowConsolidator");

    topBranch.GetChild("InfoLevel").GetData(fInfoLevel);
    fRejectStationIfWindowTruncated =
      (topBranch.GetChild("RejectStationIfSignalSearchWindowTruncated").Get<string>() == "yes");

    return eSuccess;
  }


  VModule::ResultFlag
  RdStationTimeWindowConsolidator::Run(Event& event)
  {
    if (!event.HasREvent())
      return eSuccess;

    REvent& rEvent = event.GetREvent();

    for (auto& station : rEvent.StationsRange()) {
      if (!station.HasRecData())
        continue;

      StationRecData& recData = station.GetRecData();

      if (!recData.HasParameter(eSignalSearchWindowStart)) {
        ostringstream err;
        err << "Trying to consolidate signal search window start-time for "
            << "station id=" << station.GetId() << ", but no signal search "
            << "window information available in ParameterStorage!";
        ERROR(err);
        return eFailure;
      }

      // by default, the signal search windows have not been truncated
      bool windowTruncated = false;

      // fixme TH: why do we obey the trace stop time (but interpret it as inclusive rather than exclusive), but not the trace start time?
      double maximaltime = 0;

      for(const auto& channel : station.ChannelsRange()) {
        if(!channel.IsActive())
          continue;

        const double tsstop = channel.GetChannelTimeSeries().GetStop()
            * channel.GetChannelTimeSeries().GetBinning();
        if(maximaltime < tsstop)
          maximaltime = tsstop;
      }

      // retrieve currently stored signal search window of the station
      double searchWindowStart = recData.GetParameter(eSignalSearchWindowStart);
      double searchWindowStop = recData.GetParameter(eSignalSearchWindowStop);

      ostringstream info;
      info << "Signal seach window of station " << station.GetId() << ": "
           << searchWindowStart << " to " << searchWindowStop;
      INFODebug(info);

      // check start time
      if(searchWindowStart < 0) {
        if(fRejectStationIfWindowTruncated) {
          INFOFinal("eSignalSearchWindowStart < 0, rejecting station" + to_string(station.GetId()));
          station.SetRejectedReason(eSignalSearchWindowInvalid);
        } else {
          searchWindowStart = 0;
          windowTruncated = true;
        }
      }

      // check stop time
      if(searchWindowStop > maximaltime) {
        if(fRejectStationIfWindowTruncated) {
          INFOFinal("End of the signal window after trace end, rejecting station" +
                     to_string(station.GetId()));
          station.SetRejectedReason(eSignalSearchWindowInvalid);

          ostringstream info;
          info << "searchWindowStop ( " << searchWindowStop << " ) > maximaltime ( "
               << maximaltime << " )";
          INFODebug(info);
        } else {
          searchWindowStop = maximaltime;
          windowTruncated = true;
        }
      }

      // reject a station completely if no part of the signalsearchwindow is in the trace
      if(searchWindowStart >= maximaltime || searchWindowStop <= 0) {
        ostringstream info;
        info << "No part of the signal search window (" << searchWindowStart / ns
             << " to " << searchWindowStop / ns << " ns) is inside the trace."
             << " Rejecting station " << station.GetId();
        INFOFinal(info);
        station.SetRejectedReason(eSignalSearchWindowInvalid);
      }

      // store the consolidated values in the parameter storage
      recData.SetParameter(eSignalSearchWindowStart, searchWindowStart, false);
      recData.SetParameter(eSignalSearchWindowStop, searchWindowStop, false);

      //store information whether signal search window has been truncated
      recData.SetParameter(eSignalSearchWindowTruncated, windowTruncated);

      if (windowTruncated)
        fStationsWithTruncatedWindows++;
    }

    return eSuccess;
  }


  VModule::ResultFlag
  RdStationTimeWindowConsolidator::Finish()
  {
    ostringstream info;
    info << "Found " << fStationsWithTruncatedWindows
         << " stations with a truncated signal search window.";
    INFO(info);

    return eSuccess;
  }

}