RegularPointEmbedder.h

#pragma once

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

#define RegularPointEmbedder_RECURSES

#if !defined RegularPointEmbedder_h

#define RegularPointEmbedder_h

// Inclusions
#include <iostream>
#include "DGtal/base/Common.h"
#include "DGtal/kernel/CSpace.h"


namespace DGtal
{

  // template class RegularPointEmbedder
  template <typename TSpace>
  class RegularPointEmbedder
  {
    BOOST_CONCEPT_ASSERT(( CSpace< TSpace > ));

    // ----------------------- Standard services ------------------------------
  public:
    typedef TSpace Space;
    typedef typename Space::Point Point;
    typedef typename Space::RealPoint RealPoint;
    typedef Point Argument;
    typedef RealPoint Value;

    typedef typename Space::Integer Integer;
    typedef typename Space::RealVector RealVector;

    ~RegularPointEmbedder();

    RegularPointEmbedder();

    RegularPointEmbedder & operator= ( const RegularPointEmbedder & other );

    void init( typename RealVector::Component gridStep );

    void init( const RealVector & gridSteps );

    Point floor( const RealPoint & p ) const;

    Point ceil( const RealPoint & p ) const;

    Point round( const RealPoint & p ) const;

    RealPoint embed( const Point & p ) const;

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

    
    RealVector gridSteps() const;


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

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

    bool isValid() const;

    // ------------------------- Protected Datas ------------------------------
  protected:
    RealVector myGridSteps;

    // ------------------------- Private Datas --------------------------------
  private:

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

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

  }; // end of class RegularPointEmbedder


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

} // namespace DGtal


// Includes inline functions.
#include "DGtal/kernel/RegularPointEmbedder.ih"

//                                                                           //

#endif // !defined RegularPointEmbedder_h

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