InterpIdw.h

Go to the documentation of this file.

#pragma once
//------------------------------------------------------------------------------
//------------------------------------------------------------------------------

//----- Included files ---------------------------------------------------------
#include <xmscore/misc/base_macros.h>
#include <xmsinterp/interpolate/InterpBase.h>
#include <xmscore/points/ptsfwd.h>
#include <xmscore/stl/vector.h>
#include <xmscore/misc/boost_defines.h>

//----- Forward declarations ---------------------------------------------------

//----- Namespace declaration --------------------------------------------------
namespace xms
{
class Observer;

//----- Constants / Enumerations -----------------------------------------------

//----- Structs / Classes ------------------------------------------------------
class InterpIdw : public InterpBase
{
public:
  static BSHP<InterpIdw> New();
  virtual ~InterpIdw();

  enum WeightEnum { CLASSIC, MODIFIED };
  enum NodalFuncEnum { CONSTANT, GRAD_PLANE, QUADRATIC };


  virtual void SetPtsTris(BSHP<VecPt3d> a_, BSHP<VecInt> a_tris) override = 0;
  virtual void SetScalars(const float* a_scalar, size_t a_n) override = 0;
  virtual void SetScalars(BSHP<VecFlt> a_scalar) override = 0;
  virtual void SetPts(BSHP<VecPt3d> a_, bool a_2d) = 0;
  virtual float InterpToPt(const Pt3d& a_pt) override = 0;
  // this method will run parallel
  virtual void InterpToPts(const VecPt3d& a_pts,
                           VecFlt& a_scalars) override = 0;
  virtual void SetPtActivity(DynBitset& a_activity) override = 0;
  // bitset is number of triangles in length not numtri*3 like the tris array
  virtual void SetTriActivity(DynBitset& a_activity) override = 0;
  virtual const BSHP<VecPt3d> GetPts() const override = 0;
  virtual const BSHP<VecInt> GetTris() const override = 0;
  virtual const BSHP<VecFlt> GetScalars() const override = 0;
  virtual DynBitset GetPtActivity() const override = 0;
  virtual DynBitset GetTriActivity() const override = 0;
  virtual void SetTrunc(double a_sMax, double a_sMin) override = 0;

  virtual bool GetTruncateInterpolatedValues() const = 0;
  virtual double GetTruncMin() const = 0;
  virtual double GetTruncMax() const = 0;
  virtual double GetPower() const = 0;
  virtual int GetSearchOptsNumNearestPts() const = 0;
  virtual bool GetSearchOptsUseQuadrantSearch() const = 0;
  virtual WeightEnum GetWeightCalcMethod() const = 0;
  virtual NodalFuncEnum GetNodalFunctionType() const = 0;
  virtual int GetNodalFunctionNumNearestPts() const = 0;
  virtual bool GetNodalFunctionUseQuadrantSearch() const = 0;


  // various IDW options
  virtual void SetObserver(BSHP<Observer> a_) = 0;
  virtual void SetPower(double a_) = 0;
  virtual void SetSearchOpts(int a_nNearestPoints, bool a_quad_oct_Search) = 0;
  virtual void SetWeightCalcMethod(WeightEnum a_) = 0;
  virtual void SetNodalFunction(NodalFuncEnum a_,
                                int a_nNearests,
                                bool a_quad_oct,
                                BSHP<Observer> a_prog) = 0;

  virtual void SetSaveWeights(bool a_) = 0; // used by pilot points

  virtual void InterpWeights(
    const Pt3d& a_pt, // interp weights from the points to the passed in a_pt
    VecInt& a_idx,
    VecDbl& a_wt) const = 0;

  virtual void SetMultiThreading(bool a_) = 0;

  virtual std::string ToString() const override = 0;

private:
  XM_DISALLOW_COPY_AND_ASSIGN(InterpIdw);

protected:
  InterpIdw();
};
//----- Function prototypes ----------------------------------------------------
}