IGridFeature.hpp

#pragma once
 
#include <opals/IModuleBase.hpp>
#include <opals/GridFeature.hpp>
#include <opals/GridLimit.hpp>
#include <opals/KernelShape.hpp>
#include <opals/Path.hpp>
#include <opals/RasterBand.hpp>
#include <opals/String.hpp>
#include <opals/Vector.hpp>
#include <opals/NoDataType.hpp>
 
#if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
  #if defined _DEBUG && !defined OPALS_NO_DEBUG
      #pragma comment(lib, "opalsGridFeature_d.lib")
  #else
      #pragma comment(lib, "opalsGridFeature.lib")
  #endif
#endif
 
namespace opals {
 
  namespace opts
  {
    /// Options of \ref ModuleGridFeature
    namespace GridFeature
    {
      /// Options of \ref ModuleGridFeature
      using Options =
        IGroup< Names::_,
          IValue< Names::inFile, false, RasterBand  >,
          IValue< Names::outFile, false, Vector<Path>  >,
          IValue< Names::oFormat, false, String  >,
          IValue< Names::feature, false, Vector<opals::GridFeature::Enum>  >,
          IValue< Names::kernelShape, false, KernelShape  >,
          IValue< Names::kernelSize, false, int  >,
          IValue< Names::limit, false, GridLimit  >,
          IValue< Names::noData, false, NoDataType  >
        >;
    }
  }
 
  /// 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.
    ///@{
    using Options = opts::GridFeature::Options;
          Options& opts()       override = 0;
    const Options& opts() const override = 0;
    ///@}
 
  };
 
};