IConvolution.hpp

#pragma once
 
#include <opals/IModuleBase.hpp>
#include <opals/String.hpp>
#include <opals/Path.hpp>
#include <opals/EdgeHandling.hpp>
#include <opals/ConvolutionKernel.hpp>
#include <opals/GridLimit.hpp>
 
#if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
  #if defined _DEBUG && !defined OPALS_NO_DEBUG
      #pragma comment(lib, "opalsConvolution_d.lib")
  #else
      #pragma comment(lib, "opalsConvolution.lib")
  #endif
#endif
 
namespace opals {
 
  namespace opts
  {
    /// Options of \ref ModuleConvolution
    namespace Convolution
    {
      /// Options of \ref ModuleConvolution
      using Options =
        IGroup< Names::_,
          IValue< Names::inFile, false, Path  >,
          IValue< Names::outFile, false, Path  >,
          IValue< Names::oFormat, false, String  >,
          IValue< Names::kernel, false, ConvolutionKernel  >,
          IValue< Names::edgeHandling, false, EdgeHandling  >,
          IValue< Names::ignoreNoData, false, bool  >,
          IValue< Names::normalize, false, bool  >,
          IValue< Names::limit, false, GridLimit  >,
          IValue< Names::noData, false, float  >,
          IValue< Names::gridSize, false, int  >
        >;
    }
  }
 
  /// Performs convolutional filtering operations on a raster image.
  /** TODO: 
      More details on opalsConv with much more words,
      possibly on several lines. */
  /// \see \ref ModuleConvolution
  class OPALS_API IConvolution : virtual public IModuleBase
  {
 
  public:
    static IConvolution* New();
    static IConvolution* New( IControlObject &controlObject );
    static IConvolution* New( const IModuleBase &parent );
    static IConvolution* New( const IModuleBase &parent, IControlObject &controlObject );
 
    virtual ~IConvolution() {}
 
    /// \name Access to module-specific options.
    ///@{
    using Options = opts::Convolution::Options;
          Options& opts()       override = 0;
    const Options& opts() const override = 0;
    ///@}
 
  };
 
};