RdChannelNoisePulseCounter.h

Go to the documentation of this file.

#ifndef _RdChannelNoisePulseCounter_RdChannelNoisePulseCounter_h_
#define _RdChannelNoisePulseCounter_RdChannelNoisePulseCounter_h_

#include <string>
#include <revt/Station.h>

#include <fwk/VModule.h>


// you should assign your module to a namespace

namespace RdChannelNoisePulseCounter {

struct NoisePulseData {
  std::vector<double> SNRs;
  std::vector<int> GPSsecods;
  long unsigned int numberOfPulses; // the number of traces that had a pulse above noise threshold
  long unsigned int numberOfTraces; // the number of traces that has been read in
  double totalSignalSerachWindow;   // the sum of the signal search window of all condidered traces

  NoisePulseData() : numberOfPulses(0), numberOfTraces(0), totalSignalSerachWindow(0) {}
};


enum InfoLevel {
  eNone = 0, eFinal = 1, eIntermediate = 2, eObscure = 3, eDebug = 4
};


class RdChannelNoisePulseCounter : public fwk::VModule {

public:
  // If you define a constructor, you MUST provide an implementation
  // for it, otherwise the REGISTER_MODULE macro will not register
  // your module. (Here, implementation is in RdChannelNoisePulseCounter.cc)
  RdChannelNoisePulseCounter();
  //virtual ~RdChannelNoisePulseCounter();

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

private:
  double FindPulse(revt::Station& station);

  int fInfoLevel;
  double fSNRThreshold;
  bool fFirstEvent;
  int fNumberOfEvents;  // counts number  of events
  std::string fOutputPath;
  std::string fOutputFilename;
  int fMinimumStationId;
  int fMaximumStationId;
  double fMaximumNeighborDistance;
  NoisePulseData fNoisePulseData;
  std::map<int, NoisePulseData> fStationNoisePulseData;
  std::map<int, int> fCoincidentPulses; // number of time coincident pulses in spatially connected stations

  // The REGISTER_MODULE macro makes the framework aware of your module.
  // You need to put this macro at the very end of your module class definition.
  // Give your module a name (first argument) and specify its
  // class name (second argument).  In the ModuleSequenceExample.xml file,
  // you can see this module being refered to by the name we give it here.

  REGISTER_MODULE("RdChannelNoisePulseCounter", RdChannelNoisePulseCounter);

};

}


#endif

// Configure (x)emacs for this file ...
// Local Variables:
// mode: c++
// compile-command: "make -k"
// End: