RdBeamFormer.h

Go to the documentation of this file.

/* #################################################################

  The class evt/BeamQuantities.h and further support in the framework
  have been deleted with r34469 (29.10.21).

################################################################# */

#ifndef _RdBeamFormer_h_
#define _RdBeamFormer_h_

#include "RdWaveModel.h"

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

#include <utl/Vector.h>
#include <utl/AxialVector.h>
#include <utl/Trace.h>
#include <utl/Triple.h>

#include <fwk/VModule.h>

#include <string>
#include <vector>

namespace evt {
  class Event;
}

namespace revt {
  class Station;
}

namespace RdBeamFormer {

  enum gridtype_t { none = 0, polar = 1, carthesian = 2};

  class RdBeamFormer : 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 RdBeamFormer.cc)
    RdBeamFormer();
    ~RdBeamFormer();

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

    //shift the radio traces according to the calculated time delays
    double shiftTraces(std::vector<revt::StationFFTDataContainer>& stationData, int& nStat, double& binning, int& start, int& stop, 
                       evt::Event& event);
    //calculate the cross-correlation beam
    utl::TraceD crosscorr (std::vector<revt::StationFFTDataContainer>& stationData, int nStat, double binning, int start, int stop);
    //calculate the power-beam
    utl::TraceD powertrace (std::vector<revt::StationFFTDataContainer>& stationData, int nStat, double binning, int start, int stop);
    //calculate the x-beam
    utl::TraceD xtrace (utl::TraceD ccTrace, utl::TraceD ccNormal, utl::TraceD pwNormal);

  protected:
    RdWaveModel* waveModel; //specify which wavefront model to use
    std::string waveModelConf;

    int startbin, stopbin; //configured start and stop times of the traces in bins
    double offsetfactor; //configured artificial time offset for the traces in ns

    enum gridtype_t gridtype; // configured type of ASCII output grid                             
    std::string outfile; // configured output ASCII file name which is prefixed by cc_, pw_ and x_.

    //find the maximum value and corresponding time of the beam-forming trace and calculate its RMS and SNR
    evt::BeamPeak findPeak (const utl::TraceD& trace, const double timeOffset);

  private:    
    utl::CoordinateSystemPtr coreCS;
    //helper function for the cross-correlation beam calculation
    inline void efieldproduct (const revt::StationTimeSeries& in1, const revt::StationTimeSeries& in2,
                               utl::TraceD& out, int start, int stop);
    //helper function for the power-beam calculation
    inline void efieldtopower (const revt::StationTimeSeries& in, utl::TraceD& out, int start, int stop);

    //write out results into ASCII file using either polar or carthesian coordinate system
    void WriteASCII (const utl::TraceD &cc, const utl::TraceD &power, const utl::TraceD &x,
                     const evt::BeamPeak &ccPeak, const evt::BeamPeak &pwPeak, const evt::BeamPeak &xPeak,
                     const evt::Event& event) const;
    
    //write the whole beam-forming trace into ASCII file
    void WriteTrace(const utl::TraceD& trace, const evt::BeamPeak& Peak,
                    const std::string& filename, const evt::ShowerRRecData& rrec) const;

    //write just the maximum value of the beam-forming trace into ASCII file
    void WritePeak(const evt::BeamPeak& Peak, const std::string& filename, const evt::ShowerRRecData& rrec) const;    

    mutable long fNumCalls; //needed to shape the output in ASCII files (to put a blank line in a proper place) in the form Gnuplot can deal with

    // 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("RdBeamFormer", RdBeamFormer);
  };
}

#endif

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