GaussDigitizer.h

#pragma once

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

#define GaussDigitizer_RECURSES

#if !defined GaussDigitizer_h

#define GaussDigitizer_h

// Inclusions
#include <iostream>
#include "DGtal/base/Common.h"
#include "DGtal/kernel/domains/HyperRectDomain.h"
#include "DGtal/kernel/RegularPointEmbedder.h"
#include "DGtal/shapes/CEuclideanOrientedShape.h"
#include "DGtal/shapes/CEuclideanBoundedShape.h"


namespace DGtal
{

  // template class GaussDigitizer
  template <typename TSpace, typename TEuclideanShape>
  class GaussDigitizer
  {
    // ----------------------- Standard services ------------------------------
  public:
    typedef TSpace Space;
    typedef typename Space::Integer Integer;
    typedef typename Space::Point Point;
    typedef typename Space::Vector Vector;
    typedef typename Space::RealPoint RealPoint;
    typedef typename Space::RealPoint RealVector;
    typedef TEuclideanShape EuclideanShape;
    typedef HyperRectDomain<Space> Domain;
    typedef RegularPointEmbedder<Space> PointEmbedder;

    // JOL: GaussDigitizer do not need a bounded shape.
    // BOOST_CONCEPT_ASSERT(( CEuclideanBoundedShape<TEuclideanShape> ));
    
    BOOST_CONCEPT_ASSERT(( CEuclideanOrientedShape<TEuclideanShape> ));

    
    ~GaussDigitizer();

    GaussDigitizer();

    GaussDigitizer & operator= ( const GaussDigitizer & other );

    void attach( const EuclideanShape & shape );

    void init( const RealPoint & xLow, const RealPoint & xUp, 
               typename RealVector::Component gridStep );

    void init( const RealPoint & xLow, const RealPoint & xUp, 
         const RealVector & gridSteps );

    const PointEmbedder & pointEmbedder() const;

    Domain getDomain() const;
    
    Point floor( const RealPoint & p ) const;

    Point ceil( const RealPoint & p ) const;

    Point round( const RealPoint & p ) const;

    RealPoint embed( const Point & p ) const;

    Orientation orientation(const Point &p) const
    { 
      return myEShape->orientation(embed(p));
    }

    bool operator()( const Point & p ) const;

    const Point & getLowerBound() const;

    const Point & getUpperBound() const;
    
    Vector resolution() const;

    RealVector gridSteps() const;


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

    void selfDisplay ( std::ostream & out ) const;

    bool isValid() const;

    // ------------------------- Protected Datas ------------------------------
  protected:
    const EuclideanShape* myEShape;

    RegularPointEmbedder<Space> myPointEmbedder;

    Point myLowerPoint;

    Point myUpperPoint;
    // ------------------------- Private Datas --------------------------------
  private:

    // ------------------------- Hidden services ------------------------------
  private:

    // ------------------------- Internals ------------------------------------
  private:

  }; // end of class GaussDigitizer


  template <typename TSpace, typename TEuclideanShape>
  std::ostream&
  operator<< ( std::ostream & out, 
         const GaussDigitizer<TSpace,TEuclideanShape> & object );

} // namespace DGtal


// Includes inline functions.
#include "DGtal/shapes/GaussDigitizer.ih"

//                                                                           //

#endif // !defined GaussDigitizer_h

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