DGtal::PlaneProbingParallelepipedEstimator< TPredicate, mode >::NotAbovePredicate Class Reference

#include <DGtal/geometry/surfaces/estimation/PlaneProbingParallelepipedEstimator.h>

Public Types
using	Point = typename Self::Point
using	Integer = typename Self::Integer

Public Member Functions
	NotAbovePredicate (Predicate const &aPredicate, Integer const &aBound, Self *aParallelepipedEstimator)
NotAbovePredicate &	operator= (const NotAbovePredicate &other)
bool	inPlane (Point const &aPoint) const
bool	operator() (Point const &aPoint) const

Private Member Functions
Point	q () const

Private Attributes
const Predicate *	myPredicate = nullptr
Integer	myBound
Self *	myParallelpipedEstimator = nullptr

Detailed Description

template<typename TPredicate, ProbingMode mode>
class DGtal::PlaneProbingParallelepipedEstimator< TPredicate, mode >::NotAbovePredicate

Definition at line 81 of file PlaneProbingParallelepipedEstimator.h.

Member Typedef Documentation

Integer

template<typename TPredicate , ProbingMode mode>

using DGtal::PlaneProbingParallelepipedEstimator< TPredicate, mode >::NotAbovePredicate::Integer = typename Self::Integer

Definition at line 86 of file PlaneProbingParallelepipedEstimator.h.

Point

template<typename TPredicate , ProbingMode mode>

using DGtal::PlaneProbingParallelepipedEstimator< TPredicate, mode >::NotAbovePredicate::Point = typename Self::Point

Definition at line 85 of file PlaneProbingParallelepipedEstimator.h.

Constructor & Destructor Documentation

NotAbovePredicate()

template<typename TPredicate , ProbingMode mode>

DGtal::PlaneProbingParallelepipedEstimator< TPredicate, mode >::NotAbovePredicate::NotAbovePredicate	(	Predicate const &	aPredicate,
		Integer const &	aBound,
		Self *	aParallelepipedEstimator
	)

Constructs the NotAbove predicate.

Parameters

aPredicate	the InPlane predicate.
aBound	the bound used in the NotAbve predicate.
aParallelepipedEstimator	a pointer on a plane-probing parallelepiped estimator (to access the fixed point 'q').

Member Function Documentation

inPlane()

template<typename TPredicate , ProbingMode mode>

bool DGtal::PlaneProbingParallelepipedEstimator< TPredicate, mode >::NotAbovePredicate::inPlane

(

Point const &

aPoint

)

const

A wrapper around the "is a point inside the plane?" predicate.

Parameters

aPoint

any digital point.

Returns

true if the point is inside, false otherwise.

operator()()

template<typename TPredicate , ProbingMode mode>

bool DGtal::PlaneProbingParallelepipedEstimator< TPredicate, mode >::NotAbovePredicate::operator()

(

Point const &

aPoint

)

const

The NotAbove predicate, see [77].

Parameters

aPoint

any digital point.

Returns

true if the point is not above the fixed point, false otherwise.

operator=()

template<typename TPredicate , ProbingMode mode>

NotAbovePredicate& DGtal::PlaneProbingParallelepipedEstimator< TPredicate, mode >::NotAbovePredicate::operator=

(

const NotAbovePredicate &

other

)

Copy assignment operator.

Parameters

other

the object to copy.

Returns

a reference on 'this'.

q()

template<typename TPredicate , ProbingMode mode>

Point DGtal::PlaneProbingParallelepipedEstimator< TPredicate, mode >::NotAbovePredicate::q ( ) const

private

Returns the fixed point 'q'.

Field Documentation

myBound

template<typename TPredicate , ProbingMode mode>

Integer DGtal::PlaneProbingParallelepipedEstimator< TPredicate, mode >::NotAbovePredicate::myBound

private

The bound.

Definition at line 122 of file PlaneProbingParallelepipedEstimator.h.

myParallelpipedEstimator

template<typename TPredicate , ProbingMode mode>

Self* DGtal::PlaneProbingParallelepipedEstimator< TPredicate, mode >::NotAbovePredicate::myParallelpipedEstimator = nullptr

private

A pointer to a plane-probing parallelepiped estimator.

Definition at line 123 of file PlaneProbingParallelepipedEstimator.h.

myPredicate

template<typename TPredicate , ProbingMode mode>

const Predicate* DGtal::PlaneProbingParallelepipedEstimator< TPredicate, mode >::NotAbovePredicate::myPredicate = nullptr

private

A pointer to the InPlane predicate

Definition at line 121 of file PlaneProbingParallelepipedEstimator.h.

---

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

• PlaneProbingParallelepipedEstimator.h