DGtal  1.5.beta
Public Member Functions | Data Fields
DGtal::PlaneProbingLNeighborhood< TPredicate >::ClosestGridPoint Struct Reference

Aim: Used to store the closest grid point associated to a vertex of the triangle and two extra boolean values about the local configuration at that vertex. More...

Public Member Functions

 ClosestGridPoint ()=default
 
 ClosestGridPoint (const GridPoint &aGridPoint, const bool &aFirst, const bool &aSecond)
 

Data Fields

GridPoint myGridPoint
 
std::pair< bool, bool > myPair
 

Detailed Description

template<typename TPredicate>
struct DGtal::PlaneProbingLNeighborhood< TPredicate >::ClosestGridPoint

Aim: Used to store the closest grid point associated to a vertex of the triangle and two extra boolean values about the local configuration at that vertex.

Description of data structure 'ClosestGridPoint'

More precisely, given a triplet of vectors \( (m_k)_{0 \leq k \leq 2} \) and a point \( q \), let us denote \( v \) the vertex equal to \( q - m_k \). The first boolean value is 'true' iff the predicate returns 'true' on \( v - m_{k+1} \) and,
similarly, the second boolean value is 'true' iff the predicate returns 'true' on \( v - m_{k+2} \) (the indices are taken modulo 3).

Definition at line 101 of file PlaneProbingLNeighborhood.h.

Constructor & Destructor Documentation

◆ ClosestGridPoint() [1/2]

template<typename TPredicate >
DGtal::PlaneProbingLNeighborhood< TPredicate >::ClosestGridPoint::ClosestGridPoint ( )
default

Default constructor.

◆ ClosestGridPoint() [2/2]

template<typename TPredicate >
DGtal::PlaneProbingLNeighborhood< TPredicate >::ClosestGridPoint::ClosestGridPoint ( const GridPoint &  aGridPoint,
const bool &  aFirst,
const bool &  aSecond 
)
inline

Constructor

Parameters
aGridPointthe closest grid point (possibly invalid)
aFirstthe first boolean value
aSecondthe second boolean value

Definition at line 115 of file PlaneProbingLNeighborhood.h.

117  : myGridPoint(aGridPoint), myPair(std::make_pair(aFirst,aSecond)) {}

Field Documentation

◆ myGridPoint

template<typename TPredicate >
GridPoint DGtal::PlaneProbingLNeighborhood< TPredicate >::ClosestGridPoint::myGridPoint

a grid point, which can be invalid if no grid point belong to the underlying surface

Definition at line 119 of file PlaneProbingLNeighborhood.h.

◆ myPair

template<typename TPredicate >
std::pair<bool,bool> DGtal::PlaneProbingLNeighborhood< TPredicate >::ClosestGridPoint::myPair

pair of boolean values that encode the local configuration

Definition at line 122 of file PlaneProbingLNeighborhood.h.

The documentation for this struct was generated from the following file: