ICell.hpp

#ifndef OPALS_ICELL_HPP_INCLUDED
#define OPALS_ICELL_HPP_INCLUDED

#include <opals/IModuleBase.hpp>
#include <opals/StatFeature.hpp>
#include <opals/GridLimit.hpp>
#include <opals/String.hpp>
#include <opals/Path.hpp>
#include <opals/Vector.hpp>

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

namespace opals {

  namespace opts
  {
    namespace Cell
    {
      /// Options of \ref ModuleCell
      typedef IGroup< Names::_, false, Cons<
        ILeaf< Names::inFile, false, opals::Vector<opals::Path> >, Cons<
        ILeaf< Names::outFile, false, opals::Vector< opals::Path > >, Cons<
        ILeaf< Names::oFormat, false, opals::String >, Cons<
        ILeaf< Names::cellSize, false, opals::Vector< float > >, Cons<
        ILeaf< Names::attribute, false, opals::String >, Cons<
        ILeaf< Names::feature, false, opals::Vector< opals::StatFeature > >, Cons<
        ILeaf< Names::limit, false, opals::GridLimit >, Cons<
        ILeaf< Names::filter, false, opals::String >, Cons<
        ILeaf< Names::noData, false, float >, Cons<
        ILeaf< Names::multiBand, false, bool >
      > > > > > > > > > > > Options;
    }
  }

  /// Calculates statistical features of user defined attributes and stores them as raster models or rasterized point clouds.
  /** Module cell accumulates a certain data attribute within a raster cell derives statistical
      features like min, mean, median, max, variance, quantiles, etc. The accumulated features are
      either stored as raster models or as rasterized point clouds. For selective features, referring to
      a single point within a raster cell (e.g. minimum height), the respective point including all point
      available point attributes are stored rather then the center point of the cell. In all other cases
      the cell center serves as representative point of a raster cell. */
  /// \see \ref ModuleCell
  class OPALS_API ICell : virtual public IModuleBase
  {

  public:
    static ICell* New();
    static ICell* New( IControlObject &controlObject );
    static ICell* New( const IModuleBase &parent );
    static ICell* New( const IModuleBase &parent, IControlObject &controlObject );

    virtual ~ICell() {}

    /// \name Access to module-specific options.
    ///@{
    typedef opts::Cell::Options Options;
    virtual       Options& opts()       = 0;
    virtual const Options& opts() const = 0;
    ///}@

  };

};

#endif