PlaneProbingNeighborhood.h

 
#pragma once

 
#if defined(PlaneProbingNeighborhood_RECURSES)
#error Recursive header files inclusion detected in PlaneProbingNeighborhood.h
#else // defined(PlaneProbingNeighborhood_RECURSES)
#define PlaneProbingNeighborhood_RECURSES
 
#if !defined PlaneProbingNeighborhood_h
#define PlaneProbingNeighborhood_h

// Inclusions
#include <cassert>
#include <iostream>
#include <vector>
#include "DGtal/base/Common.h"
#include "DGtal/geometry/helpers/PlaneProbingEstimatorHelper.h"
#include "DGtal/kernel/CPointPredicate.h"
 
namespace DGtal
{

  // template class PlaneProbingNeighborhood
  template <typename TPredicate>
  class PlaneProbingNeighborhood
  {
    BOOST_CONCEPT_ASSERT((concepts::CPointPredicate<TPredicate>));
 
    // ----------------------- Public types ------------------------------
  public:
      using Predicate         = TPredicate;
      using Point             = typename Predicate::Point;
      using Vector            = Point;
      using Integer           = typename Point::Coordinate;
      using Triangle          = std::array<Vector, 3>;
      using Index             = std::size_t;
    using PointOnProbingRay = detail::PointOnProbingRay<Integer,Index>;

      enum class HexagonState
      {
          Empty, 
          NonConvex, 
          NonPlanar, 
          Planar, 
      };

      struct UpdateOperation
      {
          std::array<Index, 3>     sigma;
          std::array<Integer, 3> coeffs;
      };
 
    // ----------------------- Standard services ------------------------------
  public:
    PlaneProbingNeighborhood() = delete;

    PlaneProbingNeighborhood(Predicate const& aPredicate, Point const& aQ, Triangle const& aM);

    virtual ~PlaneProbingNeighborhood();

    PlaneProbingNeighborhood ( const PlaneProbingNeighborhood & other ) = delete;

    PlaneProbingNeighborhood ( PlaneProbingNeighborhood && other ) = delete;

    PlaneProbingNeighborhood & operator= ( const PlaneProbingNeighborhood & other ) = delete;

    PlaneProbingNeighborhood & operator= ( PlaneProbingNeighborhood && other ) = delete;
 
    // ----------------------- Plane Probing services ------------------------------
  public:
    /*
     * @param aNeighbors a list of rays to filter the candidates (if empty, there is no filtering).
     */
    void setNeighbors (std::vector<PointOnProbingRay> const& aNeighbors);

    virtual HexagonState hexagonState () = 0;

    virtual UpdateOperation closestCandidate ();

    UpdateOperation getOperation (PointOnProbingRay const& aClosest) const;

    HexagonState classify (std::array<bool, 6> const& aState) const;
 
    // ----------------------- Interface --------------------------------------
  public:

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

    bool isValid() const;
 
    // ------------------------- Protected Data ------------------------------
  protected:
    Predicate const& myPredicate; 
    Point const& myQ; 
    Triangle const& myM; 
    std::vector<PointOnProbingRay> myCandidates; 
 
    static const PointOnProbingRay myNeighborhood[6]; 
    std::vector<PointOnProbingRay> myNeighbors; 
 
    // ------------------------- Private Data --------------------------------
  private:
 
    // ------------------------- Hidden services ------------------------------
  protected:
    template <class TPointAdapter>
    TPointAdapter closestPointInList (std::vector<TPointAdapter> const& aPoints) const;

    bool isNeighbor (PointOnProbingRay const& aRay) const;

    bool isSmallest (Point const& aX, Point const& aY) const;

    template <class TPointAdapter>
    Point relativePoint (TPointAdapter const& aPoint) const;

    template <class TPointAdapter>
    Point absolutePoint (TPointAdapter const& aPoint) const;
 
    // ------------------------- Internals ------------------------------------
  private:
 
  }; // end of class PlaneProbingNeighborhood
 

  template <typename TPredicate>
  std::ostream&
  operator<< ( std::ostream & out, const PlaneProbingNeighborhood<TPredicate> & object );
 
} // namespace DGtal
 

// Includes inline functions.
#include "DGtal/geometry/surfaces/estimation/PlaneProbingNeighborhood.ih"
 
//                                                                           //
 
#endif // !defined PlaneProbingNeighborhood_h
 
#undef PlaneProbingNeighborhood_RECURSES
#endif // else defined(PlaneProbingNeighborhood_RECURSES)