IFullwave.hpp

#ifndef OPALS_IFULLWAVE_HPP_INCLUDED
#define OPALS_IFULLWAVE_HPP_INCLUDED

#include <opals/IModuleBase.hpp>

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

#include <opals/Path.hpp>
#include <opals/Vector.hpp>
#include <opals/FullwaveAlgorithm.hpp>
#include <opals/Array.hpp>

typedef opals::Array<double, 2> ArrayD2;

namespace opals {

  namespace opts
  {
    namespace Fullwave
    {
      /// Options of \ref ModuleFullwave
      typedef IGroup< Names::_, false, Cons<
        ILeaf< Names::inFile, false, opals::Path >, Cons<
        ILeaf< Names::outFile, false, opals::Path >, Cons<
        ILeaf< Names::oFormat, false, opals::String >, Cons<
        ILeaf< Names::fullWaveAlg, false, opals::FullwaveAlgorithm::Type >, Cons<
        ILeaf< Names::detectThrLow, false, int >, Cons<
        ILeaf< Names::mtaZone, false, int >, Cons<
        ILeaf< Names::timeRange, false, ArrayD2 >, Cons<
        ILeaf< Names::filter, false, opals::String >
      > > > > > > > > > Options;
    }
  }

  /// Performs decomposition of the full waveform signal and provides 3D coordinates (scanner system) and additional attributes for each return.
  /** The module provides echo extraction from raw full waveform data.
      Together with the 3D coordinates of these echoes, additional attributes
      such as amplitude and echo width are derived.
      
      As there are scanners allowing for multiple laser pulses in air (multiple-time around, MTA)
      an MTA zone can be provided (parameter mtaZone, 1-..) or detected and adapted automatically (0).
      
      The output is stored in the scanner's own coordinate system (SOCS).
      For proper georeferencing, opalsDirectGeoref is intended to be used after fullwave echo extraction. */
  /// \see \ref ModuleFullwave
  class OPALS_API IFullwave : virtual public IModuleBase
  {

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

    virtual ~IFullwave() {}

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

  };

};

#endif