IGridFeature.hpp

#ifndef OPALS_IGRIDFEATURE_HPP_INCLUDED
#define OPALS_IGRIDFEATURE_HPP_INCLUDED

#include <opals/IModuleBase.hpp>
#include <opals/GridFeature.hpp>
#include <opals/GridLimit.hpp>

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

#include <opals/Path.hpp>
#include <opals/Vector.hpp>
#include <opals/String.hpp>
#include <opals/KernelShape.hpp>

namespace opals {

  namespace opts
  {
    namespace GridFeature
    {
      /// Options of \ref ModuleGridFeature
      typedef IGroup< Names::_, false, Cons<
        ILeaf< Names::inFile, false, opals::Path >, Cons<
        ILeaf< Names::outFile, false, opals::Vector<opals::Path> >, Cons<
        ILeaf< Names::oFormat, false, opals::String >, Cons<
        ILeaf< Names::feature, false, opals::Vector<opals::GridFeature::Type> >, Cons<
        ILeaf< Names::kernelShape, false, opals::KernelShape::Type >, Cons<
        ILeaf< Names::kernelSize, false, int >, Cons<
        ILeaf< Names::limit, false, opals::GridLimit >, Cons<
        ILeaf< Names::noData, false, float >
      > > > > > > > > > Options;
    }
  }

  /// Derives feature models (slope, curvature, roughness, etc.) from grid models based on the local grid neighbourhood defined by a kernel.
  /** The module opalsGridFeature reads a raster image in GDAL suppurted format and produces 
      one or more output rasters containing specified grid features like slope, expositionm, differenct 
      curvature measures, etc. For each output raster pixel the respective grid feature is calculated 
      based on a kernel neighbourhood.  */
  /// \see \ref ModuleGridFeature
  class OPALS_API IGridFeature : virtual public IModuleBase
  {

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

    virtual ~IGridFeature() {}

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

  };

};

#endif