wtn_filter.hpp

/* wtn_filter.hpp */
/* $Id: wtn_filter.hpp 22094 2013-03-28 07:21:57Z fern $ */
#ifndef __wtn_filter_hpp
#define __wtn_filter_hpp

#include <mth/lev.h>
#include <s2proc/wave_field.hpp>
#include <mix/General.h>

/* SHOULD BE CHANGED!!! */
enum { MULT, PRD, AVER };

#warning "New extrapolation is not finished/tested."
//#define WTNF_NEW_EXTRAPOL

#define WTNF_REAL_ZERO 1e-20

/*----  Wavelet noise filtering ----*/
typedef struct {
  char sOutMdfR[NMOD_LEN], sOutMdfN[NMOD_LEN];
  
  int sgType; 
  int insp1, insp2;
  
  float tabase;   /* Amplitude Estimation Time Base Size, ms */
  float agldl;    /* Amplitude Global Discrimination Level */
  float lwmax;    /* Noise Wavelet Maximal Available Length, ms */
  int  avtcnt;    /* Trace Count of Average Amplitude estimation */
  float avwin;    /* Time Windowof of Average Amplitude estimation, ms */
  float avdel;    /* Deleted Samples Part of Average Amplitude estimation */
  float alcdl;    /* Amplitude Local Discrimination Level */
  int  crtcnt;    /* Trace Count of Correlation Discrimination */
  float crshift;  /* Max Trace Shift of Correlation Discrimination */
  float crclv;    /* Critical Level of Correlation Discrimination */
  bool tar_l;     /* Trace Amplitudes Recovery option: Yes/No */
  int wrtyp;      /* Recovery Type: PRD or AVER */
  int watcnt;     /* Wave Averaging Trace Count */
  float nslw;     /* Noise amplitude attenuation slope width, ms */
  float cfred;    /* Factor of ampls reduction to local amplitude average*/
} WletFl;


typedef struct {
  int jbs;       /* trace order index */
  int nsp;
  int nmgl;
  float hcab;
  Trace body;
} TrDat;

typedef std::vector<TrDat> TrDataSet;

/* Row output DB parameters */
typedef struct WOutPar {
  int nwavs;     /* noise wavelets detected count */
  float nsrat;   /* noise to signal ratio */ 
  WOutPar() : nwavs(0), nsrat(0.) {}
};




int calcPredOper(double *opr, double *acf, int lopr);

int TrExtrapol(float *tr, int lgate, int ibwav, int iewav, int extra_side);

float WavNsSigRat(const Trace& trin, const Trace& trout);

class WTNFilter
{
public:

  typedef struct {
    int ib,ie;    /* start and end indeces of amplitude estimation sample */ 
    double amp;   /* trace local max amplitude */   
    double avAm;  /* average median ampl in amp and trace vicinity */
    bool nsAm;   /* noise mark: TRUE if noise ampl */
  } AmpTr;
  
  typedef struct {
    float Dt;
    int samples_count;
    int base_count;
  } TraceParams;
  
  WTNFilter(WletFl wltf);
  
  WTNFilter(WletFl wltf, WaveField* wf);
  
  /* =========== Modifiers =========== */
  
  void setWFData(WaveField* wf);
  
  void setFilterData(WletFl wltf);
  
    
  /* =========== Members access =========== */
  
  bool ready() { return m_ready; }
  
  /* =========== Calculation methods =========== */
  
  int filterSeism(std::vector<WOutPar>& outPar,
          WaveField& wf_res, 
          WaveField& wf_init);
  
  int filterSeism(WaveField* wf, 
          std::vector<WOutPar>& outPar, 
          WaveField& wf_res, 
          WaveField& wf_init);
  
protected:
  
  WTNFilter();
  
  int AWavNsFil(int jr, int ntr, TrDataSet *trb, float *trout, int *nwavs);
  
  void fill2DMaxAmplMatrix(int jbeg, TrDataSet *trb, AmpTr **&aTr2D);
  
  void fillMedianData(int jra, Trace& body, AmpTr **aTr2D);
  
  void waveletNoisesProcessing(int jr, int ntr, TrDataSet *trb, AmpTr *aTr1D, float *trout, int *nwavs);
  
  void traceAmplRecovery(int nwav, int nwav3, AmpTr *aTr1D, float *trout, int *ist, int *ift, bool *lnm, int *ibam, int *ieam);
  
  int countZeroSamples(const Trace& body);
  
  bool m_ready;         
  WletFl m_wltf;        
  WaveField* m_wf;      
  TraceParams m_tr_par;
};



int TrRightExtrapol(int lgate, float *tr, int ibwav, int iewav);
int TrLeftExtrapol(int lgate, float *tr, int ibwav, int iewav);


#endif /* wtn_filter.hpp */