ExplicitDigitalSurface.h

 
#pragma once
 
#if defined(ExplicitDigitalSurface_RECURSES)
#error Recursive header files inclusion detected in ExplicitDigitalSurface.h
#else // defined(ExplicitDigitalSurface_RECURSES)
#define ExplicitDigitalSurface_RECURSES
 
#if !defined ExplicitDigitalSurface_h
#define ExplicitDigitalSurface_h
 
// Inclusions
#include <iostream>
#include <vector>
#include "DGtal/base/Common.h"
#include "DGtal/base/ConstAlias.h"
#include "DGtal/topology/CSurfelPredicate.h"
#include "DGtal/topology/Topology.h"
#include "DGtal/topology/SurfelAdjacency.h"
#include "DGtal/topology/SurfelNeighborhood.h"
 
namespace DGtal
{
 
  // template class ExplicitDigitalSurface
  template <typename TKSpace, typename TSurfelPredicate>
  class ExplicitDigitalSurface
  {
  public:
 
    class Tracker
    {
    public:
      // -------------------- associated types --------------------
      typedef Tracker Self;
      typedef ExplicitDigitalSurface<TKSpace,TSurfelPredicate>
      DigitalSurfaceContainer;
      typedef typename TKSpace::SCell Surfel;
 
      // -------------------- inner types --------------------
      typedef TKSpace KSpace;
      typedef SurfelNeighborhood<KSpace> Neighborhood;
 
    public:
      Tracker( ConstAlias<DigitalSurfaceContainer> aSurface, 
               const Surfel & s );
 
      Tracker( const Tracker & other );
 
      ~Tracker();
 
      const DigitalSurfaceContainer & surface() const;
      const Surfel & current() const;
      Dimension orthDir() const;
 
      void move( const Surfel & s );
      
      uint8_t adjacent( Surfel & s, Dimension d, bool pos ) const;
      
    private:
      const DigitalSurfaceContainer & mySurface;
      Neighborhood myNeighborhood;
 
    };
 
    // ----------------------- associated types ------------------------------
  public:
    typedef ExplicitDigitalSurface<TKSpace,TSurfelPredicate> Self;
    typedef TKSpace KSpace;
    typedef typename KSpace::SCell Surfel;
    typedef typename KSpace::Size Size;
    // Model of CSurfelPredicate
    typedef TSurfelPredicate SurfelPredicate;
 
    // BOOST_CONCEPT_ASSERT(( CCellularGridSpaceND< KSpace > ));
    BOOST_CONCEPT_ASSERT(( concepts::CSurfelPredicate< SurfelPredicate > ));
 
    // -------------------- specific types ------------------------------
    typedef typename std::vector<Surfel> SurfelStorage;
    typedef typename SurfelStorage::const_iterator SurfelConstIterator;
    typedef typename KSpace::Space Space;
    typedef typename KSpace::Point Point;
    typedef Tracker DigitalSurfaceTracker;
 
    // ----------------------- other types ------------------------------
  public:
    typedef SurfelAdjacency<KSpace::dimension> Adjacency;
    typedef typename KSpace::Cell Cell;
    typedef typename KSpace::SCell SCell;
    typedef typename KSpace::CellSet CellSet;
    typedef typename KSpace::SCellSet SCellSet;
 
    // ----------------------- Standard services ------------------------------
  public:
 
    ~ExplicitDigitalSurface();
 
    ExplicitDigitalSurface ( const ExplicitDigitalSurface & other );
 
    ExplicitDigitalSurface( ConstAlias<KSpace> aKSpace,
                            const SurfelPredicate & aSP,
                            const Adjacency & adj,
                            const Surfel & s,
                            bool closed = false );
 
    const Adjacency & surfelAdjacency() const;
    Adjacency & surfelAdjacency();
    const SurfelPredicate & surfelPredicate() const;
 
    // --------- CDigitalSurfaceContainer realization -------------------------
  public:
 
    const KSpace & space() const;
    bool isInside( const Surfel & s ) const;
 
    SurfelConstIterator begin() const;
 
    SurfelConstIterator end() const;
 
    Size nbSurfels() const;
 
    bool empty() const;
 
    DigitalSurfaceTracker* newTracker( const Surfel & s ) const;
 
    Connectedness connectedness() const;
 
    // ----------------------- Interface --------------------------------------
  public:
 
    void selfDisplay ( std::ostream & out ) const;
 
    bool isValid() const;
 
    // ------------------------- Protected Datas ------------------------------
  private:
    // ------------------------- Private Datas --------------------------------
  private:
    const KSpace & myKSpace;
    const SurfelPredicate & mySurfelPredicate;
    Adjacency mySurfelAdjacency;
    SurfelStorage mySurfels;
 
    // ------------------------- Hidden services ------------------------------
  protected:
    void computeSurfels( const Surfel & p,
                         bool closed );
 
 
  private:
 
    ExplicitDigitalSurface & operator= ( const ExplicitDigitalSurface & other );
 
    // ------------------------- Internals ------------------------------------
  private:
 
  }; // end of class ExplicitDigitalSurface
 
 
  template <typename TKSpace, typename TSurfelPredicate>
  std::ostream&
  operator<< ( std::ostream & out, 
               const ExplicitDigitalSurface<TKSpace, TSurfelPredicate> & object );
 
} // namespace DGtal
 
 
// Includes inline functions.
#include "DGtal/topology/ExplicitDigitalSurface.ih"
 
//                                                                           //
 
#endif // !defined ExplicitDigitalSurface_h
 
#undef ExplicitDigitalSurface_RECURSES
#endif // else defined(ExplicitDigitalSurface_RECURSES)