psc_correlator.hpp

/* psc_correlator.hpp */
/* $Id$ */
#ifndef __psc_correlator_hpp
#define __psc_correlator_hpp

#include <utility>

#ifdef GE_BUILD
#include <dba_seismic.hpp>
#include <psc_service.hpp>
#include <psc_weights_store.hpp>
#else
#include <s2proc/dba_seismic.hpp>
#include <s2proc/psc_service.hpp>
#include <s2proc/psc_weights_store.hpp>
#endif

namespace psc
{
  class Correlator
  {
  public:
    
    struct Params
    {
      Params():
    t0(0),
    tSize(0),
    ccfSize(0),
    maxStride(0),
    corrDirMask(CorrDirMask::COMPLETE_2D),
    maxZerosPart(1.)
      {offsetsRange[0] = offsetsRange[1] = 0;}
      
      Trace::TimeT t0;                
      Trace::TimeT tSize;             
      Trace::TimeT ccfSize;           
      unsigned int maxStride;         
      int corrDirMask;                
      float maxZerosPart;             
      Trace::OffsetT offsetsRange[2]; 
    };
    
    Correlator(const Params &params);
    
    virtual ~Correlator();
    
    
    virtual bool operator()(const dba::Seismic &in_seis_db, 
                dba::Seismic &out_seis_db,
                WeightsStore *pwstore = NULL) const;
    
    
    virtual int ccfsTraceSize(const dba::Seismic &in_seis_db) const;
    
    
    const Params& params() const;
    
    void setParams(const Params &params);
    
    
    static std::pair<int, int> gridStep(const unsigned int dir,
                    const int stride,
                    const std::pair<int, int> &sp_rp_ids);
    
  protected:
    
    typedef std::vector< std::pair <unsigned int, unsigned int> > StrideDirVec;
    
    
    Params m_params;
    
    
    virtual void progress(const int /* current */, const int /* all */) const
    {/* Should be reimplemented. */}
        
    
    bool correlate(const StrideDirVec &dir_stride_vec,
           const dba::Seismic &in_seis_db, 
           const Trace &tr, 
           Trace &ccfs, 
           WeightsStore *pwstore) const;
    
    bool calc_ccf(const int corr_dir,
          const unsigned int stride,
          const dba::Seismic &in_seis_db, 
          const Trace &tr,
          Trace &ccfs) const;
    
    Trace::TimeT corr_trace_size() const;
    
    int corr_trace_size(const dba::Seismic &in_seis_db) const;    
  };
}; // namespace psc

#endif /* psc_correlator.hpp */