gridops.hh

Go to the documentation of this file.

#ifndef __TSOPT_GRIDPP_OPS__
#define __TSOPT_GRIDPP_OPS__

#include "rn.hh"
#include "op.hh"
#include "productspace.hh"
#include "mpiserialfo.hh"

#ifdef IWAVE_USE_MPI
#include "mpigridpp.hh"
#else
#include "gridpp.hh"
#endif
// required for old NCAR-fft-based helmholtz
//#include <f2c.h>

using RVL::ScalarFieldTraits;
using RVL::SpaceTest;
using RVL::Operator;
using RVL::LinearOp;
using RVL::Space;
using RVL::ProductSpace;
using RVL::Vector;
using RVL::Components;
using RVL::ProtectedDivision;
using RVL::RnArray;
using RVL::RVLScale;

template<typename Scalar>
inline Scalar window(Scalar a, Scalar b, Scalar w, Scalar x) {
  return min(min(ScalarFieldTraits<Scalar>::One(),max(ScalarFieldTraits<Scalar>::Zero(),(x-a)/w)),min(ScalarFieldTraits<Scalar>::One(),max(ScalarFieldTraits<Scalar>::Zero(),(b-x)/w)));
}

namespace TSOpt {

  using RVL::BinaryLocalFunctionObject;
  using RVL::RVLException;
  using RVL::ContentPackage;
  using RVL::LocalDataContainer;

    
  class GridMaskFO: public BinaryLocalFunctionObject<float> {
        
  private:
        
    IPNT siw;     // mask start points in gridpoints
    IPNT eiw;     // mask end points in gridpoints
    RPNT width; 
    bool bias;
    GridMaskFO();
        
  public:
        
    GridMaskFO(IPNT const & _siw, IPNT const & _eiw, RPNT const & _width, bool _bias=false)
      : bias(_bias){
      IASN(siw,_siw);
      IASN(eiw,_eiw);
      RASN(width,_width);
    }
        
    GridMaskFO(GridMaskFO const & f)
    : bias(f.bias){
      IASN(siw,f.siw);
      IASN(eiw,f.eiw);
      RASN(width,f.width);
    }
        
    using RVL::LocalEvaluation<float>::operator();
    void operator()(LocalDataContainer<float> &,
            LocalDataContainer<float> const &);
        
    string getName() const { string tmp = "GridMaskFO"; return tmp; }
        
  };
    
  class GridMaskOp: public Operator<float> {
        
  private:
        
    Space<float> const & dom;
    Vector<float> const & bg;
    IPNT siw;
    IPNT eiw;
    RPNT width;
    GridMaskOp();
        
  protected:
        
    void apply(Vector<float> const &,
           Vector<float> &) const;
    void applyDeriv(Vector<float> const &,
            Vector<float> const &,
            Vector<float> &) const;
    void applyAdjDeriv(Vector<float> const &,
               Vector<float> const &,
               Vector<float> &) const;
    void applyDeriv2(const Vector<float> &,
             const Vector<float> &,
             const Vector<float> &,
             Vector<float> & dy) const { dy.zero(); }
    void applyAdjDeriv2(const Vector<float> &,
            const Vector<float> &,
            const Vector<float> &,
            Vector<float> & dx1) const { dx1.zero(); }
        
    Operator<float> * clone() const { return new GridMaskOp(*this); }
        
  public:
        
    GridMaskOp(Space<float> const & _dom,
           Vector<float> const & _bg,
           RPNT const & sw = RPNT_0, RPNT const & ew = RPNT_0, 
               RPNT const & width = RPNT_1);
        
    GridMaskOp(GridMaskOp const & op)
    : dom(op.dom), bg(op.bg) {
      IASN(siw,op.siw);
      IASN(eiw,op.eiw);
      RASN(width,op.width);
    }
        
    ~GridMaskOp() {}
        
    Space<float> const & getDomain() const { return dom; }
    Space<float> const & getRange() const { return bg.getSpace(); }
        
    ostream & write(ostream & str) const;
  };
    
  class GridWindowFO: public BinaryLocalFunctionObject<float> {

  private:

    IPNT iw;     // window width in gridpoints
    bool bias;   // add windowed values if set, else overwrite
    
    GridWindowFO();
    
  public:
    
    GridWindowFO(IPNT const & _iw, bool _bias=false) 
      : bias(_bias) { 
      IASN(iw,_iw);
    }

    GridWindowFO(GridWindowFO const & f) 
    : bias(f.bias) {
      IASN(iw,f.iw);
    }

    using RVL::LocalEvaluation<float>::operator();
    void operator()(LocalDataContainer<float> & x,
            LocalDataContainer<float> const & y);
    
    string getName() const { string tmp = "GridWindoFO"; return tmp; }
    
  };

  class GridWindowOp: public Operator<float> {

  private:

    std::shared_ptr<Space<float> > dom;
    std::shared_ptr<Vector<float> > bg;
    IPNT iw;
    void initialize(RPNT const w);
    GridWindowOp();

  protected:

    void apply(Vector<float> const &,
           Vector<float> &) const;
    void applyDeriv(Vector<float> const &,
            Vector<float> const &,
            Vector<float> &) const;
    void applyAdjDeriv(Vector<float> const &,
               Vector<float> const &,
               Vector<float> &) const;
    void applyDeriv2(const Vector<float> &,
             const Vector<float> &,
             const Vector<float> &,
             Vector<float> & dy) const { dy.zero(); }
    void applyAdjDeriv2(const Vector<float> &,
            const Vector<float> &,
            const Vector<float> &,
            Vector<float> & dx1) const { dx1.zero(); }

    Operator<float> * clone() const { return new GridWindowOp(*this); }
    
  public:
    
    GridWindowOp(Space<float> const & _dom,
         Vector<float> const & _bg,
             RPNT const sw = RPNT_0);

    GridWindowOp(Space<float> const & _dom,
         shared_ptr<RVL::Vector<float> > const _bg,
             RPNT const sw = RPNT_0);

    GridWindowOp(GridWindowOp const & op) 
      : dom(op.dom), bg(op.bg) {
      IASN(iw,op.iw);
    }

    ~GridWindowOp() {}
    
    Space<float> const & getDomain() const { return *dom; }
    Space<float> const & getRange() const { return bg->getSpace(); }

    ostream & write(ostream & str) const;
  };

  class GridFwdDerivFO: public BinaryLocalFunctionObject<float> {

  private:

    int dir;
    float fac; 

    GridFwdDerivFO();

  public:
    GridFwdDerivFO(int _dir, float _fac)
      : dir(_dir), fac(_fac) {}
    GridFwdDerivFO(GridFwdDerivFO const & a)
    : dir(a.dir), fac(a.fac) {}
    
    using RVL::LocalEvaluation<float>::operator();
    void operator()(LocalDataContainer<float> & x,
            LocalDataContainer<float> const & y);
    
    string getName() const { string tmp = "GridFwdDerivFO"; return tmp; }
  };

  class GridAdjDerivFO: public BinaryLocalFunctionObject<float> {

  private:

    int dir;
    float fac; 

    GridAdjDerivFO();

  public:
    GridAdjDerivFO(int _dir, float _fac)
      : dir(_dir), fac(_fac) {}
    GridAdjDerivFO(GridAdjDerivFO const & a)
    : dir(a.dir), fac(a.fac) {}
    
    using RVL::LocalEvaluation<float>::operator();
    void operator()(LocalDataContainer<float> & x,
            LocalDataContainer<float> const & y);
    
    string getName() const { string tmp = "GridAdjDerivFO"; return tmp; }
  };

  class GridDerivOp: public LinearOp<float> {
    
  private:
    
    int dir;
    std::vector<float> fac;
    Space<float> const & dom;

    GridDerivOp();

  protected:

    void apply(Vector<float> const & x,
           Vector<float> & y) const;
    void applyAdj(Vector<float> const & x,
          Vector<float> & y) const;

    Operator<float> * clone() const { return new GridDerivOp(*this); }
    
  public:
    
    GridDerivOp(Space<float> const & _dom, int _dir, float scale = REAL_ONE);

    GridDerivOp(GridDerivOp const & op);

    ~GridDerivOp() {}
    
    Space<float> const & getDomain() const { return dom; }
    Space<float> const & getRange() const { return dom; }

    ostream & write(ostream & str) const;
  };    

  class GridFwdExtendFO: public BinaryLocalFunctionObject<float> {

  private:

    int n_ext;
    bool ext;
    float fac; 

    GridFwdExtendFO();

  public:
    GridFwdExtendFO(int _n_ext, bool _ext, float _fac)
      : n_ext(_n_ext), ext(_ext), fac(_fac) {}
    GridFwdExtendFO(GridFwdExtendFO const & a)
    : n_ext(a.n_ext), ext(a.ext), fac(a.fac) {}
    
    using RVL::LocalEvaluation<float>::operator();
    void operator()(LocalDataContainer<float> & x,
            LocalDataContainer<float> const & y);
    
    string getName() const { string tmp = "GridFwdExtendFO"; return tmp; }
  };

  class GridAdjExtendFO: public BinaryLocalFunctionObject<float> {

  private:

    int n_ext;
    bool ext;
    float fac; 

    GridAdjExtendFO();

  public:

    GridAdjExtendFO(int _n_ext, bool _ext, float _fac)
      : n_ext(_n_ext), ext(_ext), fac(_fac) {}
    GridAdjExtendFO(GridAdjExtendFO const & a)
    : n_ext(a.n_ext), ext(a.ext), fac(a.fac) {}
    
    using RVL::LocalEvaluation<float>::operator();
    void operator()(LocalDataContainer<float> & x,
            LocalDataContainer<float> const & y);
    
    string getName() const { string tmp = "GridAdjExtendFO"; return tmp; }
  };

  class GridExtendOp: public LinearOp<float> {
    
  private:
    
    Space<float> const & dom;
    Space<float> const & rng;
    std::vector<int> n_ext;
    std::vector<bool> ext;
    std::vector<float> fac;

    GridExtendOp();

  protected:

    void apply(Vector<float> const & x,
           Vector<float> & y) const;
    void applyAdj(Vector<float> const & x,
          Vector<float> & y) const;

    Operator<float> * clone() const { return new GridExtendOp(*this); }
    
  public:
    
    GridExtendOp(Space<float> const & _dom, Space<float> const & _rng);

    GridExtendOp(GridExtendOp const & op);

    ~GridExtendOp() {}
    
    Space<float> const & getDomain() const { return dom; }
    Space<float> const & getRange() const { return rng; }

    ostream & write(ostream & str) const;
  };    

  /* lenwork must be > 6*n1*n2+3*max(n2,2*n1)+21 */

  /*
#ifdef IWAVE_USE_MPI
  typedef MPIGridSpace myGridSpace;
#else
  typedef GridSpace myGridSpace;
#endif
    
  class HelmFO: public BinaryLocalFunctionObject<float> {
    
  private:
    float scale1, scale2;
    float power, datum;
    int DirichletSides;
    IPNT n_arr;
    RPNT d_arr;
    HelmFO();
        
  public:
    HelmFO(IPNT const & _narr,
       RPNT const & _darr,
       float _scale1=1.0f,
       float _scale2=1.0f,
       float _power=0.0f,
       float _datum=0.0f,
       int _DirichletSides=0)
      : scale1(_scale1),scale2(_scale2),power(_power), datum(_datum), DirichletSides(_DirichletSides){
      IASN(n_arr,_narr);
      RASN(d_arr,_darr);
    }
        
    HelmFO(HelmFO const & f)
    : scale1(f.scale1), scale2(f.scale2), power(f.power), datum(f.datum), DirichletSides(f.DirichletSides){
      IASN(n_arr,f.n_arr);
      RASN(d_arr,f.d_arr);
    }
        
    using RVL::LocalEvaluation<float>::operator();
    void operator()(LocalDataContainer<float> & x,
            LocalDataContainer<float> const & y);
        
    string getName() const { string tmp = "HelmFO"; return tmp; }
        
  };
  
  class GridHelmOp: public LinearOp<float> {
  private:
        
    Space<float> const & dom;
    RPNT weights;
    float power, datum;
    int DirichletSides;
        
    // default construction disabled
    GridHelmOp();
        
  protected:
        
    void apply(const Vector<float> & x,
           Vector<float> & y) const;
        
    void applyAdj(const Vector<float> & x,
          Vector<float> & y) const;
        
  public:
        
    GridHelmOp(GridHelmOp const & A)
    : dom(A.dom),
      power(A.power), datum(A.datum), DirichletSides(A.DirichletSides) {
      RASN(weights,A.weights);
    }
        
    GridHelmOp(Space<float> const & _dom,
           RPNT _weights,
           float _power=0.0f,
           float _datum=0.0f,
           int _DirichletSides=0):
      dom(_dom),
      power(_power), datum(_datum), DirichletSides(_DirichletSides){
      try{
    RASN(weights,_weights);
      }
      catch (RVLException & e) {
    e<<"\ncalled from GridHelmOp constructor\n";
    throw e;
      }
    }
        
    ~GridHelmOp() {}
        
    // this class is considered terminal, with no overrides foreseen,
    // so clone method is not virtual
    LinearOp<float> * clone() const { return new GridHelmOp(*this); }
        
    // access to domain, range
    const Space<float> & getDomain() const { return dom; }
    const Space<float> & getRange() const { return dom; }
        
    ostream & write(ostream & str) const {
      str<<"GridHelmOp\n";
      return str;
    }
        
  };
  */
}
#endif

---