DGtal::PlaneProbingDigitalSurfaceLocalEstimator< TSurface, TInternalProbingAlgorithm >::ProbingFrame Struct Reference

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

Public Member Functions
ProbingFrame	rotatedCopy () const
Point	shift () const

Data Fields
Point	p
Point	b1
Point	b2
Point	normal

Detailed Description

template<typename TSurface, typename TInternalProbingAlgorithm>
struct DGtal::PlaneProbingDigitalSurfaceLocalEstimator< TSurface, TInternalProbingAlgorithm >::ProbingFrame

A probing frame represents a 3D orthogonal frame, that is internally used to define the starting position of a plane-probing algorithm.

Definition at line 85 of file PlaneProbingDigitalSurfaceLocalEstimator.h.

Member Function Documentation

rotatedCopy()

template<typename TSurface, typename TInternalProbingAlgorithm>

ProbingFrame DGtal::PlaneProbingDigitalSurfaceLocalEstimator< TSurface, TInternalProbingAlgorithm >::ProbingFrame::rotatedCopy ( ) const

inline

Returns

a copy of the current probing frame rotated clockwise.

Definition at line 95 of file PlaneProbingDigitalSurfaceLocalEstimator.h.

          {
              Point newP      = p + b1,
                    newB1     = b2,
                    newB2     = -b1,
                    newNormal = newB1.crossProduct(newB2);
 
              return  { newP, newB1, newB2, newNormal };
          }

References b1, b2, and p.

shift()

template<typename TSurface, typename TInternalProbingAlgorithm>

Point DGtal::PlaneProbingDigitalSurfaceLocalEstimator< TSurface, TInternalProbingAlgorithm >::ProbingFrame::shift ( ) const

inline

Returns

the 'shift' vector of the frame i.e. the octant that it represents.

Definition at line 108 of file PlaneProbingDigitalSurfaceLocalEstimator.h.

          {
              return b1 + b2 + normal;
          }

References b1, b2, and normal.

Field Documentation

b1

template<typename TSurface, typename TInternalProbingAlgorithm>

Point DGtal::PlaneProbingDigitalSurfaceLocalEstimator< TSurface, TInternalProbingAlgorithm >::ProbingFrame::b1

The first base vector.

Definition at line 88 of file PlaneProbingDigitalSurfaceLocalEstimator.h.

Referenced by rotatedCopy(), and shift().

b2

template<typename TSurface, typename TInternalProbingAlgorithm>

Point DGtal::PlaneProbingDigitalSurfaceLocalEstimator< TSurface, TInternalProbingAlgorithm >::ProbingFrame::b2

The second base vector.

Definition at line 89 of file PlaneProbingDigitalSurfaceLocalEstimator.h.

Referenced by rotatedCopy(), and shift().

normal

template<typename TSurface, typename TInternalProbingAlgorithm>

Point DGtal::PlaneProbingDigitalSurfaceLocalEstimator< TSurface, TInternalProbingAlgorithm >::ProbingFrame::normal

A vector that is orthogonal to b1 and b2.

Definition at line 90 of file PlaneProbingDigitalSurfaceLocalEstimator.h.

Referenced by shift().

p

template<typename TSurface, typename TInternalProbingAlgorithm>

Point DGtal::PlaneProbingDigitalSurfaceLocalEstimator< TSurface, TInternalProbingAlgorithm >::ProbingFrame::p

The base point/

Definition at line 87 of file PlaneProbingDigitalSurfaceLocalEstimator.h.

Referenced by rotatedCopy().

---

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

• PlaneProbingDigitalSurfaceLocalEstimator.h