ISegmentation.hpp

#pragma once
 
#include <opals/IModuleBase.hpp>
#include <DM/IPointIndexLeaf.hpp>
#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>
 
#if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
#  if defined _DEBUG && !defined OPALS_NO_DEBUG
#    pragma comment(lib, "opalsSegmentation_d.lib")
#  else
#    pragma comment(lib, "opalsSegmentation.lib")
#  endif
#endif
 
namespace opals {
 
  namespace opts
  {
    /// Options of \ref ModuleSegmentation
    namespace Segmentation
    {
      /// Options of \ref ModuleSegmentation
      using Options =
        IGroup< Names::_,
          IValue< Names::inFile, false, Path  >,
          IValue< Names::method, false, SegmentationMethod  >,
          IValue< Names::searchRadius, false, Vector< float >  >,
          IValue< Names::searchMode, false, SearchMode  >,
          IValue< Names::minSegSize, false, unsigned  >,
          IValue< Names::filter, false, Vector<String>  >,
          IGroup< Names::condClustering,
            IValue< Names::criterion, false, String  >,
            IValue< Names::alphaShapeRefPlane, false, Vector<double>  >
          >,
          IGroup< Names::planeExtraction,
            IValue< Names::maxDist, false, double  >,
            IValue< Names::maxSigma, false, double  >,
            IValue< Names::seedCalculator, false, String  >,
            IValue< Names::refinePlanes, false, bool  >
          >,
          IValue< Names::alphaRadius, false, double  >,
          IValue< Names::sort, false, SegmentSort  >,
          IValue< Names::byproduct, false, Path  >,
          IValue< Names::segments, true, SharedPtr<ISegmentManager>  >
        >;
    }
  }
 
  /// 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.
    ///@{
    using Options = opts::Segmentation::Options;
          Options& opts()       override = 0;
    const Options& opts() const override = 0;
    ///@}
 
    /// \brief Static method for an external calculation of segments for points in a local tree
    virtual SharedPtr<ISegmentManager> calculateSegments(DM::PointIndexLeafHandle localtree) const = 0;
  };
 
};