ILineModeler.hpp

#ifndef OPALS_ILINEMODELER_HPP_INCLUDED
#define OPALS_ILINEMODELER_HPP_INCLUDED

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

#include <opals/IModuleBase.hpp>
#include <opals/Path.hpp>
#include <opals/Vector.hpp>

namespace opals
{

  namespace opts
  {
    namespace LineModeler
    {
      /// Options of \ref ModuleLineModeler
      typedef IGroup< Names::_, false, Cons<
        ILeaf< Names::inFile, false, opals::Vector<opals::Path> >, Cons<
        ILeaf< Names::approxFile, false, opals::Path >, Cons<
        ILeaf< Names::outFile, false, opals::Path >, Cons<
        ILeaf< Names::oFormat, false, opals::String >, Cons<
        ILeaf< Names::filter, false, opals::String >, Cons<
        ILeaf< Names::processId, false, opals::Vector<opals::String> >, Cons<
        ILeaf< Names::ignoreId, false, opals::Vector<opals::String> >, Cons<
        ILeaf< Names::patchLength, false, opals::Vector<double> >, Cons<
        ILeaf< Names::patchWidth, false, opals::Vector<double> >, Cons<
        ILeaf< Names::overlap, false, opals::Vector<double> >, Cons<
        ILeaf< Names::minAngle, false, double >, Cons<
        ILeaf< Names::minLength, false, double >, Cons<
        ILeaf< Names::samplingDist, false, double >, Cons<
        ILeaf< Names::pointCount, false, opals::Vector<unsigned> >, Cons<
        ILeaf< Names::sigmaApriori, false, opals::Vector<double> >, Cons<
        ILeaf< Names::spikeRemoval, false, bool >, Cons<
        ILeaf< Names::debugOutFile, false, opals::Path >
      > > > > > > > > > > > > > > > > > > Options;
    }
  }

  /// Models 3D structure lines based on a point cloud (ODM) and 2D line approximations.
  /** TODO: 
      More details on opalsLineModeler with much more words,
      possibly on several lines. */
  /// \see \ref ModuleLineModeler
  class OPALS_API ILineModeler : virtual public IModuleBase
  {

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

    virtual ~ILineModeler() {}

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

  };

}

#endif