DigitalSurfaceEmbedderWithNormalVectorEstimator.h

#pragma once

#if defined(DigitalSurfaceEmbedderWithNormalVectorEstimator_RECURSES)
#error Recursive header files inclusion detected in DigitalSurfaceEmbedderWithNormalVectorEstimator.h
#else // defined(DigitalSurfaceEmbedderWithNormalVectorEstimator_RECURSES)

#define DigitalSurfaceEmbedderWithNormalVectorEstimator_RECURSES

#if !defined DigitalSurfaceEmbedderWithNormalVectorEstimator_h

#define DigitalSurfaceEmbedderWithNormalVectorEstimator_h

// Inclusions
#include <iostream>
#include "DGtal/base/Common.h"
#include "DGtal/kernel/NumberTraits.h"
#include "DGtal/topology/CDigitalSurfaceEmbedder.h"

namespace DGtal
{

  // Forward declaration.
  template < typename TDigitalSurfaceEmbedder,
             typename TNormalVectorEstimator >
  struct DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap;


  template < typename TDigitalSurfaceEmbedder,
             typename TNormalVectorEstimator >
  class DigitalSurfaceEmbedderWithNormalVectorEstimator
  {
  public:
    typedef DigitalSurfaceEmbedderWithNormalVectorEstimator
    < TDigitalSurfaceEmbedder, TNormalVectorEstimator > Self;
    BOOST_CONCEPT_ASSERT(( CDigitalSurfaceEmbedder<TDigitalSurfaceEmbedder> ));

    typedef TDigitalSurfaceEmbedder DigitalSurfaceEmbedder;
    typedef TNormalVectorEstimator NormalVectorEstimator;
    
    typedef typename DigitalSurfaceEmbedder::KSpace KSpace;
    typedef typename DigitalSurfaceEmbedder::Surface Surface;
    typedef typename DigitalSurfaceEmbedder::SCell SCell;
    typedef typename DigitalSurfaceEmbedder::RealPoint RealPoint;
    typedef typename DigitalSurfaceEmbedder::Argument Argument;
    typedef typename DigitalSurfaceEmbedder::Value Value;

    typedef typename KSpace::Space Space;
    typedef typename Space::RealVector RealVector;
    typedef typename NormalVectorEstimator::Quantity Quantity;
    typedef typename NormalVectorEstimator::DigitalSurface NVESurface;

    BOOST_STATIC_ASSERT(( ConceptUtils::SameType< RealVector, Quantity >::value ));
    BOOST_STATIC_ASSERT(( ConceptUtils::SameType< Surface, NVESurface >::value ));

    typedef DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap<DigitalSurfaceEmbedder,NormalVectorEstimator> GradientMap;


    DigitalSurfaceEmbedderWithNormalVectorEstimator();

    Self & operator=( const Self & other );
    
    DigitalSurfaceEmbedderWithNormalVectorEstimator
    ( const DigitalSurfaceEmbedder & aDSEmbedder,
      const NormalVectorEstimator & anEstimator );

    DigitalSurfaceEmbedderWithNormalVectorEstimator
    ( const Self & other );

    ~DigitalSurfaceEmbedderWithNormalVectorEstimator();

    // ----------------------- Interface --------------------------------------
  public:

    RealPoint operator()( const SCell & scell ) const;

    const Surface & surface() const;

    GradientMap gradientMap() const;

    RealVector gradient( const SCell & scell ) const;
   
    // ----------------------- Interface --------------------------------------
  public:
    
    void selfDisplay ( std::ostream & out ) const;

    bool isValid() const;

    // ------------------------- Protected Datas ------------------------------
  private:
    // ------------------------- Private Datas --------------------------------
  private:
   
    const DigitalSurfaceEmbedder* myDSEmbedder;
    const NormalVectorEstimator* myEstimator;
   
    // ------------------------- Hidden services ------------------------------
  protected:
    
  }; // end of class DigitalSurfaceEmbedderWithNormalVectorEstimator

  template < typename TDigitalSurfaceEmbedder,
             typename TNormalVectorEstimator >
  class DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap
  {
  public:
    typedef DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap<TDigitalSurfaceEmbedder,TNormalVectorEstimator> Self;
    BOOST_CONCEPT_ASSERT(( CDigitalSurfaceEmbedder<TDigitalSurfaceEmbedder> ));

    typedef TDigitalSurfaceEmbedder DigitalSurfaceEmbedder;
    typedef TNormalVectorEstimator NormalVectorEstimator;

    typedef DigitalSurfaceEmbedderWithNormalVectorEstimator< DigitalSurfaceEmbedder, NormalVectorEstimator > Embedder;
    typedef typename Embedder::SCell Argument;
    typedef typename Embedder::RealVector Value;

    ~DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap();

    DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap();

    Self & operator=( const Self & other );

    DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap
    ( const Self & other );

    DigitalSurfaceEmbedderWithNormalVectorEstimatorGradientMap
    ( const Embedder & embedder );

    Value operator()( const Argument & arg ) const;

  protected:
    const Embedder* myEmbedder;

  private:

  };

  template < typename TDigitalSurfaceEmbedder, typename TNormalVectorEstimator >
  std::ostream&
  operator<< ( std::ostream & out, 
               const DigitalSurfaceEmbedderWithNormalVectorEstimator<TDigitalSurfaceEmbedder, TNormalVectorEstimator> & object );

} // namespace DGtal


// Includes inline functions.
#include "DGtal/geometry/surfaces/estimation/DigitalSurfaceEmbedderWithNormalVectorEstimator.ih"

//                                                                           //

#endif // !defined DigitalSurfaceEmbedderWithNormalVectorEstimator_h

#undef DigitalSurfaceEmbedderWithNormalVectorEstimator_RECURSES
#endif // else defined(DigitalSurfaceEmbedderWithNormalVectorEstimator_RECURSES)