ITerrainFilter.hpp

#pragma once
 
#include <opals/IModuleBase.hpp>
#include <opals/String.hpp>
#include <opals/Path.hpp>
#include <opals/Vector.hpp>
#include <DM/StatFeature.hpp>
#include <opals/TerrainFilterMethod.hpp>
#include <opals/GridLimit.hpp>
#include <opals/Calculator.hpp>
 
#if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
  #if defined _DEBUG && !defined OPALS_NO_DEBUG
    #pragma comment(lib, "opalsTerrainFilter_d.lib")
  #else
    #pragma comment(lib, "opalsTerrainFilter.lib")
  #endif
#endif
 
namespace opals
{
 
  namespace opts
  {
    /// Options of \ref ModuleTerrainFilter
    namespace TerrainFilter
    {
      /// Options of \ref ModuleTerrainFilter
      using Options =
        IGroup< Names::_,
          IValue< Names::inFile, false, Path  >,
          IValue< Names::method, false, TerrainFilterMethod  >,
          IValue< Names::limit, false, GridLimit  >,
          IValue< Names::filter, false, String  >,
          IValue< Names::tempDirectory, false, Path  >,
          IValue< Names::deleteTempData, false, bool  >,
          IValue< Names::debugOutFile, false, Path  >,
          IValue< Names::writeFilterInfo, false, bool  >,
          IGroup< Names::sigmaApriori,
            IValue< Names::bulkPoints, false, String  >,
            IValue< Names::keyPoints, false, String  >,
            IValue< Names::formLines, false, String  >,
            IValue< Names::breakLines, false, String  >
          >,
          IGroup< Names::robustInterpolation,
            IValue< Names::gridSize, false, double  >,
            IValue< Names::pyramidLevels, false, unsigned  >,
            IValue< Names::feature, false, Vector< DM::StatFeature >  >,
            IValue< Names::filterThresholds, false, Vector< double >  >,
            IValue< Names::lowerThresholdScale, false, double  >,
            IValue< Names::maxSigma, false, double  >,
            IValue< Names::penetration, false, unsigned  >,
            IValue< Names::maxIter, false, unsigned  >,
            IValue< Names::tileSize, false, unsigned  >,
            IValue< Names::robustWFAdpation, false, String  >
          >,
          IValue< Names::classifyOverlap, false, bool  >,
          IValue< Names::setAttribute, false, Calculator<DM::ICalculator::ReadAccess::vectors, DM::ICalculator::WriteAccess::attributes>  >
        >;
    }
  }
 
  /// Classifies a 3D point cloud (ODM) into terrain and off-terrain points.
  /** TODO: 
      More details on opalsTerrainFilter with much more words,
      possibly on several lines. */
  /// \see \ref ModuleTerrainFilter
  class OPALS_API ITerrainFilter : virtual public IModuleBase
  {
 
  public:
    static ITerrainFilter* New();
    static ITerrainFilter* New( IControlObject &controlObject );
    static ITerrainFilter* New( const IModuleBase &parent );
    static ITerrainFilter* New( const IModuleBase &parent, IControlObject &controlObject );
 
    virtual ~ITerrainFilter() {}
 
    /// \name Access to module-specific options.
    ///@{
    using Options = opts::TerrainFilter::Options;
          Options& opts()       override = 0;
    const Options& opts() const override = 0;
    ///@}
 
  };
 
}