IStatFilter.hpp
1 #pragma once
2 
3 #include <opals/IModuleBase.hpp>
4 #include <opals/String.hpp>
5 #include <opals/Path.hpp>
6 #include <opals/KernelShape.hpp>
7 #include <DM/StatFeature.hpp>
8 #include <opals/GridLimit.hpp>
9 #include <opals/GridResolution.hpp>
10 #include <opals/HistoMode.hpp>
11 
12 #if defined(_MSC_VER) && !defined(OPALS_NO_AUTOLINK)
13  #if defined _DEBUG && !defined OPALS_NO_DEBUG
14  #pragma comment(lib, "opalsStatFilter_d.lib")
15  #else
16  #pragma comment(lib, "opalsStatFilter.lib")
17  #endif
18 #endif
19 
20 namespace opals {
21 
22  namespace opts
23  {
24  /// Options of \ref ModuleStatFilter
25  namespace StatFilter
26  {
27  /// Options of \ref ModuleStatFilter
28  using Options =
29  IGroup< Names::_, false,
40  >;
41  }
42  }
43 
44  /// Performs statistical filtering of raster datasets with a sliding kernel of arbitrary shape and size.
45  /** The module opalsStatFilter reads a raster image in GDAL suppurted format and produces
46  a statistically filtered output raster. For each output raster pixel a statistical
47  feature (e.g. min, max, mean, etc.) is evaluated based on a kernel neighbourhood. */
48  /// \see \ref ModuleStatFilter
49  class OPALS_API IStatFilter : virtual public IModuleBase
50  {
51 
52  public:
53  static IStatFilter* New();
54  static IStatFilter* New( IControlObject &controlObject );
55  static IStatFilter* New( const IModuleBase &parent );
56  static IStatFilter* New( const IModuleBase &parent, IControlObject &controlObject );
57 
58  virtual ~IStatFilter() {}
59 
60  /// \name Access to module-specific options.
61  ///@{
63  virtual Options& opts() = 0;
64  virtual const Options& opts() const = 0;
65  ///@}
66 
67  };
68 
69 };
Leaf that holds a read-only value.
Definition: IOption.hpp:63
Performs statistical filtering of raster datasets with a sliding kernel of arbitrary shape and size.
Definition: IStatFilter.hpp:49
Contains the public interface of OPALS.
Definition: AbsValueOrQuantile.hpp:8
Abstract base class of all opals modules.
Definition: IModuleBase.hpp:13
Interface for retrieving status and progress information from a module run.
Definition: c++_api/inc/opals/IControlObject.hpp:30
IGroup< Names::_, false, ILeaf< Names::inFile, false, Path >, ILeaf< Names::outFile, false, Path >, ILeaf< Names::oFormat, false, String >, ILeaf< Names::feature, false, DM::StatFeature >, ILeaf< Names::kernelShape, false, KernelShape >, ILeaf< Names::kernelSize, false, int >, ILeaf< Names::limit, false, GridLimit >, ILeaf< Names::noData, false, float >, ILeaf< Names::procMode, false, HistoMode >, ILeaf< Names::gridSize, false, GridResolution > > Options
Options of Module StatFilter.
Definition: IStatFilter.hpp:40
A group of options.
Definition: IOption.hpp:108