IRadioCal.hpp

#ifndef OPALS_IRADIOCAL_HPP_INCLUDED
#define OPALS_IRADIOCAL_HPP_INCLUDED

#include <opals/IModuleBase.hpp>

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

#include <opals/Path.hpp>
#include <opals/String.hpp>
#include <opals/CalibrationStats.hpp>

namespace opals {

  namespace opts
  {
    namespace RadioCal
    {
      /// Options of \ref ModuleRadioCal
      typedef IGroup< Names::_, false, Cons<
        ILeaf< Names::inFile, false, opals::Vector<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::calRegionFile, false, opals::Vector<opals::Path> >, Cons<
        ILeaf< Names::atmosphericAtt, false, double >, Cons<
        ILeaf< Names::beamDivergence, false, double >, Cons<
        ILeaf< Names::radioCal, false, opals::CalibrationStats >, Cons<
        ILeaf< Names::splitByAttribute, false, opals::String >, Cons<
        ILeaf< Names::maxSigma, false, float >
      > > > > > > > > > > > Options;
    }
  }

  /// Performs radiometric calibration of ALS data and calculates physical quantities (backscatter cross section/coefficient, reflectance) for each return.
  /** TODO: 
      More details on opalsRadioCal */
  /// \see \ref ModuleRadioCal
  class OPALS_API IRadioCal : virtual public IModuleBase
  {

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

    virtual ~IRadioCal() {}

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

  };

};

#endif