Ponca::CenteredNeighborhoodFrame< DataPoint > Class Template Reference

NeighborhoodFrame that express 3d points relatively to a prescribed center. More...

#include <frame.h>

Inheritance diagram for Ponca::CenteredNeighborhoodFrame< DataPoint >:

Collaboration diagram for Ponca::CenteredNeighborhoodFrame< DataPoint >:

Public Types
using	Scalar = typename DataPoint::Scalar
	Scalar type from DataPoint.
using	VectorType = typename DataPoint::VectorType
	Vector type from DataPoint.

Public Member Functions
	CenteredNeighborhoodFrame (const VectorType &_evalPos=VectorType::Zero())
	CenteredNeighborhoodFrame (const DataPoint &_evalPoint)
VectorType	center ()
VectorType	center () const
void	changeNeighborhoodFrame (const VectorType &_newEvalPos)
	Change neighborhood frame (move basis center)
VectorType	convertToGlobalBasis (const VectorType &_q, bool _isPositionVector=true) const
	Convert query from local to global coordinate system, such as \(\mathbf{x}=\mathbf{x}'+\mathbf{p}\).
VectorType	convertToLocalBasis (const VectorType &_q, bool _isPositionVector=true) const
	Convert query from global to local coordinate system, such as \(\mathbf{x}'=\mathbf{x}-\mathbf{p}\).

Static Public Attributes
static constexpr bool	hasLocalFrame = true
	Flag indicating that this class modifies the coordinates when passing from global to local.

Detailed Description

template<class DataPoint>
class Ponca::CenteredNeighborhoodFrame< DataPoint >

NeighborhoodFrame that express 3d points relatively to a prescribed center.

This class is useful to get all coordinates centered around a point, which ease weights computation, and limits issues with big numbers and rounding errors.

Express points \(\mathbf{x}\) relatively to a center \(\mathbf{p}\), ie. \(\mathbf{x}'=\mathbf{x}-\mathbf{p}\). This frame does not apply rotation.

Note

This class is designed to serve as a Base class for the definition of NeighborFilters, and cannot be used directly

Template Parameters

DataPoint

Point type used for computation

Definition at line 27 of file frame.h.

Member Typedef Documentation

Scalar

template<class DataPoint >

using Ponca::CenteredNeighborhoodFrame< DataPoint >::Scalar = typename DataPoint::Scalar

Scalar type from DataPoint.

Definition at line 31 of file frame.h.

VectorType

template<class DataPoint >

using Ponca::CenteredNeighborhoodFrame< DataPoint >::VectorType = typename DataPoint::VectorType

Vector type from DataPoint.

Definition at line 33 of file frame.h.

Constructor & Destructor Documentation

CenteredNeighborhoodFrame() [1/2]

template<class DataPoint >

Ponca::CenteredNeighborhoodFrame< DataPoint >::CenteredNeighborhoodFrame ( const VectorType &  _evalPos = VectorType::Zero() )

inlineexplicit

Definition at line 38 of file frame.h.

CenteredNeighborhoodFrame() [2/2]

template<class DataPoint >

Ponca::CenteredNeighborhoodFrame< DataPoint >::CenteredNeighborhoodFrame ( const DataPoint &  _evalPoint )

inlineexplicit

Definition at line 43 of file frame.h.

Member Function Documentation

center() [1/2]

template<class DataPoint >

VectorType Ponca::CenteredNeighborhoodFrame< DataPoint >::center ( )

inline

Definition at line 47 of file frame.h.

center() [2/2]

template<class DataPoint >

VectorType Ponca::CenteredNeighborhoodFrame< DataPoint >::center ( ) const

inline

Definition at line 48 of file frame.h.

changeNeighborhoodFrame()

template<class DataPoint >

void Ponca::CenteredNeighborhoodFrame< DataPoint >::changeNeighborhoodFrame ( const VectorType &  _newEvalPos )

inline

Change neighborhood frame (move basis center)

Warning

Calling this method invalidates any primitive defined relatively to the previous frame. In this situation, it is recommended to use ProvidesImplicitPrimitive::changeBasis instead.

Definition at line 53 of file frame.h.

convertToGlobalBasis()

template<class DataPoint >

VectorType Ponca::CenteredNeighborhoodFrame< DataPoint >::convertToGlobalBasis ( const VectorType &  _q, bool  _isPositionVector = true  ) const

inline

Convert query from local to global coordinate system, such as \(\mathbf{x}=\mathbf{x}'+\mathbf{p}\).

Parameters

_q	Vector expressed relatively to the basis center
_isPositionVector	Indicate if the input vector _q is a position that is influenced by translations (e.g., in contrast to displacement or normal vectors)

Returns

Vector expressed in the global coordinate system

See also

convertToLocalBasis

Definition at line 65 of file frame.h.

convertToLocalBasis()

template<class DataPoint >

VectorType Ponca::CenteredNeighborhoodFrame< DataPoint >::convertToLocalBasis ( const VectorType &  _q, bool  _isPositionVector = true  ) const

inline

Convert query from global to local coordinate system, such as \(\mathbf{x}'=\mathbf{x}-\mathbf{p}\).

Parameters

_q	Input Vector in global coordinate system
_isPositionVector	Indicate if the input vector _q is a position that is influenced by translations (e.g., in contrast to displacement or normal vectors)

Returns

Vector expressed relatively to the basis center

See also

convertToGlobalBasis

Definition at line 82 of file frame.h.

Member Data Documentation

hasLocalFrame

template<class DataPoint >

constexpr bool Ponca::CenteredNeighborhoodFrame< DataPoint >::hasLocalFrame = true

staticconstexpr

Flag indicating that this class modifies the coordinates when passing from global to local.

Definition at line 36 of file frame.h.