IGridMerge.hpp

#pragma once
 
#include <opals/IModuleBase.hpp>
#include <opals/String.hpp>
#include <opals/Path.hpp>
#include <opals/Array.hpp>
#include <opals/Vector.hpp>
#include <opals/ResamplingMethod.hpp>
#include <opals/MultiGridLimit.hpp>
 
#if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
  #if defined _DEBUG && !defined OPALS_NO_DEBUG
      #pragma comment(lib, "opalsGridMerge_d.lib")
  #else
      #pragma comment(lib, "opalsGridMerge.lib")
  #endif
#endif
 
namespace opals {
 
  namespace opts
  {
    /// Options of \ref ModuleGridMerge
    namespace GridMerge
    {
      /// Options of \ref ModuleGridMerge
      using Options =
        IGroup< Names::_,
          IValue< Names::inFile, false, Vector<Path>  >,
          IValue< Names::outFile, false, Path  >,
          IValue< Names::oFormat, false, String  >,
          IValue< Names::gridSize, false, Vector<double>  >,
          IValue< Names::sigmaApriori, false, Vector<double>  >,
          IValue< Names::mergeWidth, false, double  >,
          IValue< Names::mergeFunc, false, String  >,
          IValue< Names::nonOverlapMerge, false, bool  >,
          IValue< Names::activateBorderMerge, false, bool  >,
          IValue< Names::limit, false, MultiGridLimit  >,
          IValue< Names::resampling, false, ResamplingMethod  >,
          IGroup< Names::byproduct,
            IValue< Names::processStructure, false, Path  >,
            IValue< Names::weighting, false, Path  >,
            IValue< Names::deviation, false, Path  >
          >
        >;
    }
  }
 
  /// Merging multi raster files with different resolutions and accuracies into one continuous file
  /** TODO: 
      More details on module GridMerge with much more words,
      possibly on several lines. */
  /// \see \ref ModuleGridMerge
  class OPALS_API IGridMerge : virtual public IModuleBase
  {
 
  public:
    static IGridMerge* New();
    static IGridMerge* New( IControlObject &controlObject );
    static IGridMerge* New( const IModuleBase &parent );
    static IGridMerge* New( const IModuleBase &parent, IControlObject &controlObject );
 
    virtual ~IGridMerge() {}
 
    /// \name Access to module-specific options.
    ///@{
    using Options = opts::GridMerge::Options;
          Options& opts()       override = 0;
    const Options& opts() const override = 0;
    ///@}
 
  };
 
};