IAlgebra.hpp

#pragma once
 
#include <opals/IModuleBase.hpp>
#include <opals/ResamplingMethod.hpp>
#include <opals/MultiGridLimit.hpp>
#include <opals/Calculator.hpp>
#include <opals/String.hpp>
#include <opals/Path.hpp>
#include <opals/Vector.hpp>
#include <opals/NoDataType.hpp>
 
#if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
  #if defined _DEBUG && !defined OPALS_NO_DEBUG
      #pragma comment(lib, "opalsAlgebra_d.lib")
  #else
      #pragma comment(lib, "opalsAlgebra.lib")
  #endif
#endif
 
namespace opals {
 
  namespace opts
  {
    /// Options of \ref ModuleAlgebra
    namespace Algebra
    {
      /// Options of \ref ModuleAlgebra
      using Options =
        IGroup< Names::_, false,
          ILeaf< Names::inFile, false, Vector<Path>  >,
          ILeaf< Names::outFile, false, Path  >,
          ILeaf< Names::oFormat, false, String  >,
          ILeaf< Names::formula, false, CalculatorWithPythonSupport<DM::ICalculator::ReadAccess::vectors | DM::ICalculator::ReadAccess::rasters, DM::ICalculator::WriteAccess::coordinates | DM::ICalculator::WriteAccess::attributes | DM::ICalculator::WriteAccess::rasters>  >,
          ILeaf< Names::gridSize, false, Vector<double>  >,
          ILeaf< Names::noData, false, NoDataType  >,
          ILeaf< Names::limit, false, MultiGridLimit  >,
          ILeaf< Names::resampling, false, ResamplingMethod  >,
          ILeaf< Names::maxMemory, false, unsigned  >,
          ILeaf< Names::skipVoidAreas, false, bool  >
        >;
    }
  }
 
  /// Provides a generic raster algebra calculator featuring mathematical, statistical and conditional operators.
  /** Multiple input rasters are combined by means of a generic, user defined formula
      If necessary, automatical resampling (nearest, bilinear, bicubic) is performed on the fly */
  /// \see \ref ModuleAlgebra
  class OPALS_API IAlgebra : virtual public IModuleBase
  {
 
  public:
    static IAlgebra* New();
    static IAlgebra* New( IControlObject &controlObject );
    static IAlgebra* New( const IModuleBase &parent );
    static IAlgebra* New( const IModuleBase &parent, IControlObject &controlObject );
 
    virtual ~IAlgebra() {}
 
    /// \name Access to module-specific options.
    ///@{
    using Options = opts::Algebra::Options;
    virtual       Options& opts()       = 0;
    virtual const Options& opts() const = 0;
    ///@}
 
  };
 
};