ISegmentation.hpp

#ifndef OPALS_ISEGMENTATION_HPP_INCLUDED
#define OPALS_ISEGMENTATION_HPP_INCLUDED

#include <opals/IModuleBase.hpp>
#include <DM/IPointIndexLeaf.hpp>

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

#include <opals/Path.hpp>
#include <opals/String.hpp>
#include <opals/Vector.hpp>
#include <opals/SearchMode.hpp>
#include <opals/SegmentationMethod.hpp>
#include <opals/SegmentSort.hpp>
#include <opals/SharedPtr.hpp>
#include <opals/ISegmentManager.hpp>

namespace opals {

  namespace opts
  {
    namespace Segmentation
    {
      /// Options of \ref ModuleSegmentation
      typedef IGroup< Names::_, false, Cons<
        ILeaf< Names::inFile, false, opals::Path >, Cons<
        ILeaf< Names::method, false, opals::SegmentationMethod::Type >, Cons<
        ILeaf< Names::searchRadius, false, opals::Vector< float > >, Cons<
        ILeaf< Names::searchMode, false, opals::SearchMode::Type >, Cons<
        ILeaf< Names::minSegSize, false, unsigned >, Cons<
        ILeaf< Names::filter, false, opals::Vector<opals::String> >, Cons<
        IGroup< Names::condClustering, false,  Cons<
          ILeaf< Names::criterion, false, opals::String >, Cons<
          ILeaf< Names::alphaShapeRefPlane, false, opals::Vector<double> >
        > > >, Cons<
        IGroup< Names::planeExtraction, false,  Cons<
          ILeaf< Names::maxDist, false, double >, Cons<
          ILeaf< Names::maxSigma, false, double >, Cons<
          ILeaf< Names::seedCalculator, false, opals::String >
        > > > >, Cons<
        ILeaf< Names::alphaRadius, false, double >, Cons<
        ILeaf< Names::sort, false, opals::SegmentSort::Type >, Cons<
        ILeaf< Names::debugOutFile, false, opals::Path >, Cons<
        ILeaf< Names::segments, true, opals::SharedPtr<opals::ISegmentManager> >
      > > > > > > > > > > > > > Options;
    }
  }

  /// Provides methods for point cloud segmentation based on local homogeneity using either a generic region growing approach or an adapted region growing for plane extraction.
    /** TODO: 
      More details on opalsSegmentation with much more words,
      possibly on several lines. */
    /// \see \ref ModuleSegmentation
    class OPALS_API ISegmentation : virtual public IModuleBase
  {

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

    virtual ~ISegmentation() {}

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

    /// \brief Static method for an external calculation of segments for points in a local tree
    virtual opals::SharedPtr<opals::ISegmentManager> calculateSegments(DM::PointIndexLeafHandle localtree) const = 0;
  };

};

#endif