IStatFilter.hpp

#pragma once
 
#include <opals/IModuleBase.hpp>
#include <opals/String.hpp>
#include <opals/Path.hpp>
#include <opals/KernelShape.hpp>
#include <DM/StatFeature.hpp>
#include <opals/GridLimit.hpp>
#include <opals/GridResolution.hpp>
#include <opals/HistoMode.hpp>
#include <opals/NoDataType.hpp>
 
#if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
  #if defined _DEBUG && !defined OPALS_NO_DEBUG
      #pragma comment(lib, "opalsStatFilter_d.lib")
  #else
      #pragma comment(lib, "opalsStatFilter.lib")
  #endif
#endif
 
namespace opals {
 
  namespace opts
  {
    /// Options of \ref ModuleStatFilter
    namespace StatFilter
    {
      /// Options of \ref ModuleStatFilter
      using Options =
        IGroup< Names::_,
          IValue< Names::inFile, false, Path  >,
          IValue< Names::outFile, false, Path  >,
          IValue< Names::oFormat, false, String  >,
          IValue< Names::feature, false, DM::StatFeature  >,
          IValue< Names::kernelShape, false, KernelShape  >,
          IValue< Names::kernelSize, false, int  >,
          IValue< Names::limit, false, GridLimit  >,
          IValue< Names::noData, false, NoDataType  >,
          IValue< Names::procMode, false, HistoMode  >,
          IValue< Names::gridSize, false, GridResolution  >
        >;
    }
  }
 
  /// Performs statistical filtering of raster datasets with a sliding kernel of arbitrary shape and size.
  /** The module opalsStatFilter reads a raster image in GDAL suppurted format and produces 
      a statistically filtered output raster. For each output raster pixel a statistical  
      feature (e.g. min, max, mean, etc.) is evaluated based on a kernel neighbourhood.  */
  /// \see \ref ModuleStatFilter
  class OPALS_API IStatFilter : virtual public IModuleBase
  {
 
  public:
    static IStatFilter* New();
    static IStatFilter* New( IControlObject &controlObject );
    static IStatFilter* New( const IModuleBase &parent );
    static IStatFilter* New( const IModuleBase &parent, IControlObject &controlObject );
 
    virtual ~IStatFilter() {}
 
    /// \name Access to module-specific options.
    ///@{
    using Options = opts::StatFilter::Options;
          Options& opts()       override = 0;
    const Options& opts() const override = 0;
    ///@}
 
  };
 
};