IConvolution.hpp

#ifndef OPALS_ICONVOLUTION_HPP_INCLUDED
#define OPALS_ICONVOLUTION_HPP_INCLUDED

#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(OPALS_EXPORTS) && !defined(OPALS_MODULE_EXPORTS)
  #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
  {
    namespace Convolution
    {
      /// Options of \ref ModuleConvolution
      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::kernel, false, opals::ConvolutionKernel >, Cons<
        ILeaf< Names::edgeHandling, false, opals::EdgeHandling::Type >, Cons<
        ILeaf< Names::ignoreNoData, false, bool >, Cons<
        ILeaf< Names::normalize, false, bool >, Cons<
        ILeaf< Names::limit, false, opals::GridLimit >, Cons<
        ILeaf< Names::noData, false, float >, Cons<
        ILeaf< Names::gridSize, false, int >
      > > > > > > > > > > > Options;
    }
  }

  /// 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.
    ///@{
    typedef opts::Convolution::Options Options;
    virtual       Options& opts()       = 0;
    virtual const Options& opts() const = 0;
    ///}@

  };

};

#endif