IShade.hpp

#ifndef OPALS_ISHADE_HPP_INCLUDED
#define OPALS_ISHADE_HPP_INCLUDED

#include <opals/IModuleBase.hpp>

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

#include <opals/ShadingMethod.hpp>
#include <opals/ResamplingMethod.hpp>
#include <opals/GridFeature.hpp>
#include <opals/GridLimit.hpp>
#include <opals/String.hpp>
#include <opals/Path.hpp>
#include <opals/Array.hpp>
#include <opals/Vector.hpp>

typedef opals::Array<double,2> ArrayD2;

namespace opals {

  namespace opts
  {
    namespace Shade
    {
      /// Options of \ref ModuleShade
      typedef IGroup< Names::_, false, Cons<
        ILeaf< Names::inFile, false, opals::Vector<opals::Path> >, Cons<
        ILeaf< Names::feature, false, opals::Vector<opals::GridFeature::Type> >, Cons<
        ILeaf< Names::outFile, false, opals::Path >, Cons<
        ILeaf< Names::oFormat, false, opals::String >, Cons<
        ILeaf< Names::pixelSize, false, float >, Cons<
        ILeaf< Names::limit, false, opals::GridLimit >, Cons<
        ILeaf< Names::shading, false, opals::ShadingMethod::Type >, Cons<
        ILeaf< Names::sunPosition, false, ArrayD2 >
      > > > > > > > > > Options;
    }
  }

  /// Derives shaded relief raster maps (geo-coded hill shading) of DEM grids.
  /** Hill shading is a method to visualize a surface grid model by illuminating it using a light source shining from a certain direction. 
      Artificial shadows are calculated depending on the slope (steepness) and exposition of the surface w.r.t the direction of the light source.
      Depending on the artificial shadow length, grey values (0=shaded..255=exposed) are assigned to each cell of the output raster. */
  /// \see \ref ModuleShade
  class OPALS_API IShade : virtual public IModuleBase
  {

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

    virtual ~IShade() {}

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

  };

};

#endif