IEdgeDetect.hpp

#ifndef OPALS_IEDGEDETECT_HPP_INCLUDED
#define OPALS_IEDGEDETECT_HPP_INCLUDED

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

#include <opals/IModuleBase.hpp>
#include <opals/Path.hpp>
#include <opals/Vector.hpp>
#include <opals/EdgeDetector.hpp>
#include <opals/GridLimit.hpp>
#include <opals/Array.hpp>
typedef opals::Array<double,2> ArrayD2;

namespace opals {

  namespace opts
  {
    namespace EdgeDetect
    {
      /// Options of \ref ModuleEdgeDetect
      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::detector, false, opals::EdgeDetector::Type >, Cons<
        ILeaf< Names::sigmaSmooth, false, float >, Cons<
        ILeaf< Names::threshold, false, ArrayD2 >, Cons<
        ILeaf< Names::tempDirectory, false, opals::Path >, Cons<
        ILeaf< Names::debugOutFile, false, bool >, Cons<
        ILeaf< Names::limit, false, opals::GridLimit >
      > > > > > > > > > > Options;
    }
  }

  /// Provides different raster based edge detection algorithms (e.g. Canny).
  /** The aim of opalsEdgeDetect is to provide an interface for different edge detectors. 
      Based on an input raster file and an appropriate set of parameters for the respective 
      edge detection algorithm, a binary output raster is derived containing the detected 
      edge pixels.  */
  /// \see \ref ModuleEdgeDetect
  class OPALS_API IEdgeDetect : virtual public IModuleBase
  {

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

    virtual ~IEdgeDetect() {}

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

  };

}

#endif