IStatFilter.hpp

#ifndef OPALS_ISTATFILTER_HPP_INCLUDED
#define OPALS_ISTATFILTER_HPP_INCLUDED

#include <opals/IModuleBase.hpp>

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

#include <opals/String.hpp>
#include <opals/Path.hpp>
#include <opals/KernelShape.hpp>
#include <opals/StatFeature.hpp>
#include <opals/GridLimit.hpp>
#include <opals/GridResolution.hpp>

namespace opals {

  namespace opts
  {
    namespace StatFilter
    {
      /// Options of \ref ModuleStatFilter
      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::feature, false, opals::StatFeature >, Cons<
        ILeaf< Names::kernelShape, false, opals::KernelShape::Type >, Cons<
        ILeaf< Names::kernelSize, false, int >, Cons<
        ILeaf< Names::limit, false, opals::GridLimit >, Cons<
        ILeaf< Names::noData, false, float >, Cons<
        ILeaf< Names::gridSize, false, opals::GridResolution::Type >
      > > > > > > > > > > Options;
    }
  }

  /// 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.
    ///@{
    typedef opts::StatFilter::Options Options;
    virtual       Options& opts()       = 0;
    virtual const Options& opts() const = 0;
    ///}@

  };

};

#endif