IEchoRatio.hpp

#pragma once
 
#include <opals/IModuleBase.hpp>
#include <opals/String.hpp>
#include <opals/Path.hpp>
#include <opals/EchoRatioMode.hpp>
 
#if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
  #if defined _DEBUG && !defined OPALS_NO_DEBUG
      #pragma comment(lib, "opalsEchoRatio_d.lib")
  #else
      #pragma comment(lib, "opalsEchoRatio.lib")
  #endif
#endif
 
namespace opals {
 
  namespace opts
  {
    /// Options of \ref ModuleEchoRatio
    namespace EchoRatio
    {
      /// Options of \ref ModuleEchoRatio
      using Options =
        IGroup< Names::_,
          IValue< Names::inFile, false, Path  >,
          IValue< Names::searchRadius, false, float  >,
          IValue< Names::ratioMode, false, EchoRatioMode  >,
          IValue< Names::filter, false, Vector<String>  >,
          IValue< Names::maxSigma, false, float  >
        >;
    }
  }
 
  /// Derives and stores the echo ratio (ER) attribute for points of an OPALS data manager.
  /** TODO: 
      More details on opalsEchoRatio */
  /// \see \ref ModuleEchoRatio
  class OPALS_API IEchoRatio : virtual public IModuleBase
  {
 
  public:
    static IEchoRatio* New();
    static IEchoRatio* New( IControlObject &controlObject );
    static IEchoRatio* New( const IModuleBase &parent );
    static IEchoRatio* New( const IModuleBase &parent, IControlObject &controlObject );
 
    virtual ~IEchoRatio() {}
 
    /// \name Access to module-specific options.
    ///@{
    using Options = opts::EchoRatio::Options;
          Options& opts()       override = 0;
    const Options& opts() const override = 0;
    ///@}
 
  };
 
};