ITerrainMask.hpp

#pragma once
 
#include <opals/IModuleBase.hpp>
#include <opals/Path.hpp>
#include <opals/Vector.hpp>
 
#if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
  #if defined _DEBUG && !defined OPALS_NO_DEBUG
      #pragma comment(lib, "opalsTerrainMask_d.lib")
  #else
      #pragma comment(lib, "opalsTerrainMask.lib")
  #endif
#endif
 
namespace opals {
 
  namespace opts
  {
    /// Options of \ref ModuleTerrainMask
    namespace TerrainMask
    {
      /// Options of \ref ModuleTerrainMask
      using Options =
        IGroup< Names::_, false,
          ILeaf< Names::inFile, false, Path  >,
          ILeaf< Names::outFile, false, Path  >,
          ILeaf< Names::oFormat, false, String  >,
          ILeaf< Names::minHeight, false, Vector<double>  >,
          ILeaf< Names::maxWidth, false, double  >,
          ILeaf< Names::minConsensus, false, int  >,
          ILeaf< Names::noData, false, float  >,
          ILeaf< Names::debugOutFile, false, bool  >
        >;
    }
  }
 
  /// Identifies open terrain parts of a DSM input raster using the volume based approach by Piltz et al. (2016).
  /** TODO: 
      More details on opalsTerrainMask with much more words,
      possibly on several lines. */
  /// \see \ref ModuleTerrainMask
  class OPALS_API ITerrainMask : virtual public IModuleBase
  {
 
  public:
    static ITerrainMask* New();
    static ITerrainMask* New( IControlObject &controlObject );
    static ITerrainMask* New( const IModuleBase &parent );
    static ITerrainMask* New( const IModuleBase &parent, IControlObject &controlObject );
 
    virtual ~ITerrainMask() {}
 
    /// \name Access to module-specific options.
    ///@{
    using Options = opts::TerrainMask::Options;
    virtual       Options& opts()       = 0;
    virtual const Options& opts() const = 0;
    ///@}
 
  };
 
};