IFillGaps.hpp

#ifndef OPALS_IFILLGAPS_HPP_INCLUDED
#define OPALS_IFILLGAPS_HPP_INCLUDED

#include <opals/IModuleBase.hpp>

#if !defined(OPALS_EXPORTS) && !defined(OPALS_MODULE_EXPORTS)
  #if defined _DEBUG && !defined OPALS_NO_DEBUG
      #pragma comment(lib, "opalsFillGaps_d.lib")
  #else
      #pragma comment(lib, "opalsFillGaps.lib")
  #endif
#endif

#include <opals/Path.hpp>
#include <opals/Vector.hpp>
#include <opals/GridLimit.hpp>
#include <opals/FillMethod.hpp>
#include <opals/GapInfo.hpp>

namespace opals {

  namespace opts
  {
    namespace FillGaps
    {
      /// Options of \ref ModuleFillGaps
      typedef IGroup< Names::_, false, Cons<
        ILeaf< Names::inFile, false, opals::Path >, Cons<
        ILeaf< Names::outFile, false, opals::Path >, Cons<
        ILeaf< Names::oFormat, false, opals::String >, Cons<
        ILeaf< Names::method, false, opals::FillMethod::Type >, Cons<
        IGroup< Names::adaptive, false,  Cons<
          ILeaf< Names::weightFunc, false, opals::String >, Cons<
          ILeaf< Names::maxPixelRigorous, false, double >, Cons<
          ILeaf< Names::gridSize, false, unsigned >
        > > > >, Cons<
        ILeaf< Names::boundaryRatio, false, float >, Cons<
        ILeaf< Names::fillMask, false, opals::Path >, Cons<
        ILeaf< Names::maxArea, false, double >, Cons<
        ILeaf< Names::gapInfo, false, opals::Vector<opals::GapInfo::Type> >
      > > > > > > > > > > Options;
    }
  }

  /// Detects gaps (i.e. void pixels) in raster models and provides several interpolation methods to close them.
  /** The generation of Digital Terrain Models (DTM) usually leads to void pixels where buildings and vegetation were removed. Module FillGaps aims to close these gaps with qualified approximation of void pixel using the neighbouring pixel of a gap. */
  /// \see \ref ModuleFillGaps
  class OPALS_API IFillGaps : virtual public IModuleBase
  {

  public:
    static IFillGaps* New();
    static IFillGaps* New( IControlObject &controlObject );
    static IFillGaps* New( const IModuleBase &parent );
    static IFillGaps* New( const IModuleBase &parent, IControlObject &controlObject );

    virtual ~IFillGaps() {}

    /// \name Access to module-specific options.
    ///@{
    typedef opts::FillGaps::Options Options;
    virtual       Options& opts()       = 0;
    virtual const Options& opts() const = 0;
    ///}@

  };

};

#endif