DGtal: DGtal::DigitalSurfaceRegularization< TDigitalSurface

Aim: Implements Digital Surface Regularization as described in [31]. More...

#include <DGtal/geometry/surfaces/DigitalSurfaceRegularization.h>

Public Types
typedef TDigitalSurface	DigSurface
	DigitalSurface type. More...

typedef TDigitalSurface::DigitalSurfaceContainer	DigitalSurfaceContainer
	Digital Surface Container type. More...

typedef Shortcuts< Z3i::KSpace >	SH3
	We rely on the Shortcuts 3D types. More...

typedef ShortcutsGeometry< Z3i::KSpace >	SHG3
	We rely on the ShortcutsGeometry 3D types. More...

typedef std::vector< Z3i::RealPoint >	Positions
	Pointels position container. More...

typedef std::vector< Z3i::RealVector >	Normals
	Pointels position container. More...

Public Member Functions
	BOOST_CONCEPT_ASSERT ((concepts::CDigitalSurfaceContainer< DigitalSurfaceContainer >))

	DigitalSurfaceRegularization (CountedPtr< DigSurface > aDigSurf)

	~DigitalSurfaceRegularization ()=default

	DigitalSurfaceRegularization (const DigitalSurfaceRegularization &other)=delete

	DigitalSurfaceRegularization (DigitalSurfaceRegularization &&other)=delete

DigitalSurfaceRegularization &	operator= (const DigitalSurfaceRegularization &other)=delete

DigitalSurfaceRegularization &	operator= (DigitalSurfaceRegularization &&other)=delete

void	attachNormalVectors (const std::function< SHG3::RealVector(SH3::SCell &)> &normalFunc)

void	attachConvolvedTrivialNormalVectors (const Parameters someParams=SH3::defaultParameters()\|SHG3::defaultParameters())

void	init (const double alpha=0.001, const double beta=1.0, const double gamma=0.05)
	Initialize the parameters of the energy function. More...

void	init (ConstAlias< std::vector< double > > alphas, ConstAlias< std::vector< double > > betas, ConstAlias< std::vector< double > > gammas)
	Initialize the parameters of the energy function. More...

double	computeGradient ()

double	computeGradientLocalWeights ()

template<typename AdvectionFunction >
double	regularize (const unsigned int nbIters, const double dt, const double epsilon, const AdvectionFunction &advectionFunc)
	Main regularization loop. More...

double	regularize (const unsigned int nbIters=200, const double dt=1.0, const double epsilon=0.0001)
	Main regularization loop. More...

SHG3::RealPoint	getRegularizedPosition (const SH3::Cell &aPointel)

const Positions &	getRegularizedPositions () const

const Positions &	getOriginalPositions () const

const SH3::Cell2Index &	getCellIndex () const

const Normals &	getNormalVectors () const

const SH3::Surfel2Index &	getSurfelIndex () const

void	reset ()

void	selfDisplay (std::ostream &out) const

bool	isValid () const

void	enableVerbose ()

void	disasbleVerbose ()

Static Public Member Functions
static void	clampedAdvection (SHG3::RealPoint &p, const SHG3::RealPoint &orig, const SHG3::RealVector &v)

Private Member Functions
void	cacheInit ()

Private Attributes
double	myAlpha
	Data attachment term coefficient. More...

double	myBeta
	Alignment term coefficient. More...

double	myGamma
	Fairness term coefficient. More...

const std::vector< double > *	myAlphas
	Data attachment term local coefficients. More...

const std::vector< double > *	myBetas
	Alignment attachment term local coefficients. More...

const std::vector< double > *	myGammas
	Fairness attachment term local coefficients. More...

bool	myConstantCoeffs
	Flag if the gradient has constant weights for the init method and gradient. More...

bool	myInit
	Flag if the object has been set up properly. More...

bool	myVerbose
	Flag for verbose messages. More...

CountedPtr< DigSurface >	myDigitalSurface
	Input DigitalSurface to regularize. More...

Positions	myOriginalPositions
	Copy of the input pointels positions. More...

Positions	myRegularizedPositions
	Regularized vertices. More...

Normals	myNormals
	Normals. More...

Positions	myGradient
	Gradient of the energy w.r.t. vertex positons. More...

Positions	myGradientAlign
	Internal members to store precomputed topological informations. More...

SH3::KSpace	myK
	Instance of the KSpace. More...

SH3::SurfelRange	mySurfels
	Indexed surface elements. More...

SH3::Surfel2Index	mySurfelIndex
	Surfel Index. More...

SH3::Cell2Index	myPointelIndex
	Indices for pointels. More...

std::vector< SH3::Idx >	myAlignPointelsIdx
	Indices of adjacent pointels for the Alignement energy term. More...

std::vector< SH3::Cell >	myAlignPointels
	Adjacent pointels for the Alignement energy term. More...

std::vector< unsigned char >	myNumberAdjEdgesToPointel
	Number of adjacent edges to pointels. More...

std::vector< SH3::Idx >	myFairnessPointelsIdx
	Indices of cells foor the Fairness term. More...

std::vector< unsigned char >	myNbAdjacent
	Number of adjacent faces to given vertex. More...

SH3::PolygonalSurface::FaceRange	myFaces
	All faces of the dual digital surfacce. More...

Detailed Description

template<typename TDigitalSurface>
class DGtal::DigitalSurfaceRegularization< TDigitalSurface >

Aim: Implements Digital Surface Regularization as described in [31].

Description of template class 'DigitalSurfaceRegularization'

Given a digital surface and a normal vector field attached to the surfels, this class performs a regularization of the digital surface vertices to obtain a piecewise smooth surface such that each quad of the output surface is as perpendicular as possible to the given input normal vector field.

Note: The digital surface must be a closed.

If \(P\) denotes the vertices of the input digital surface, \(F\) the set of (quadrilateral) faces and \(n_f\) an estimated normal vector on the face \(f\), we want the quad surface vertex positions \(P^*\) that minimizes the following energy function:

\[\mathcal{E}(P) := \alpha \sum_{i=1}^{n} \|p_i - \hat{p}_i\|^2 + \beta \sum_{f\in F} \sum_{{e_j} \in \partial{f} } ( e_j \cdot n_{f} )^2 + \gamma \sum_{i=1}^{n} \|\hat{p}_i - \hat{b}_i\|^2\,.\]

where \("\cdot"\) is the standard \(\mathbb{R}^3\) scalar product, \(e_j\in \partial{f}\) is an edge of the face \(f\) (and is equal to some \(p_k - p_l\)) and \( \hat{b}_i\) is the barycenter of the vertices adjacent to \(\hat{p}_i\).

To minimize this energy, instead of solving the associated sparse linear system as described in [31], we perform a gradient descent strategy which allows us a finer control over the vertices displacement (see advection methods).

See also: testDigitalSurfaceRegularization.cpp

Template Parameters

TDigitalSurface a Digital Surface type (see DigitalSurface).

Definition at line 88 of file DigitalSurfaceRegularization.h.

Member Typedef Documentation

◆ DigitalSurfaceContainer

template<typename TDigitalSurface >

typedef TDigitalSurface::DigitalSurfaceContainer DGtal::DigitalSurfaceRegularization< TDigitalSurface >::DigitalSurfaceContainer

Digital Surface Container type.

Definition at line 96 of file DigitalSurfaceRegularization.h.

◆ DigSurface

template<typename TDigitalSurface >

typedef TDigitalSurface DGtal::DigitalSurfaceRegularization< TDigitalSurface >::DigSurface

DigitalSurface type.

Definition at line 94 of file DigitalSurfaceRegularization.h.

◆ Normals

template<typename TDigitalSurface >

typedef std::vector<Z3i::RealVector> DGtal::DigitalSurfaceRegularization< TDigitalSurface >::Normals

Pointels position container.

Definition at line 109 of file DigitalSurfaceRegularization.h.

◆ Positions

template<typename TDigitalSurface >

typedef std::vector<Z3i::RealPoint> DGtal::DigitalSurfaceRegularization< TDigitalSurface >::Positions

Pointels position container.

Definition at line 106 of file DigitalSurfaceRegularization.h.

◆ SH3

template<typename TDigitalSurface >

typedef Shortcuts<Z3i::KSpace> DGtal::DigitalSurfaceRegularization< TDigitalSurface >::SH3

We rely on the Shortcuts 3D types.

Definition at line 100 of file DigitalSurfaceRegularization.h.

◆ SHG3

template<typename TDigitalSurface >

typedef ShortcutsGeometry<Z3i::KSpace> DGtal::DigitalSurfaceRegularization< TDigitalSurface >::SHG3

We rely on the ShortcutsGeometry 3D types.

Definition at line 103 of file DigitalSurfaceRegularization.h.

Constructor & Destructor Documentation

◆ DigitalSurfaceRegularization() [1/3]

template<typename TDigitalSurface >

DGtal::DigitalSurfaceRegularization< TDigitalSurface >::DigitalSurfaceRegularization ( CountedPtr< DigSurface > aDigSurf )

inline

Default constructor.

Definition at line 114 of file DigitalSurfaceRegularization.h.

     :  myInit(false), myVerbose(false), myDigitalSurface(aDigSurf)
     {
       myK = SH3::getKSpace( myDigitalSurface );
     }

References DGtal::Shortcuts< TKSpace >::getKSpace(), DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myDigitalSurface, and DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myK.

◆ ~DigitalSurfaceRegularization()

template<typename TDigitalSurface >

DGtal::DigitalSurfaceRegularization< TDigitalSurface >::~DigitalSurfaceRegularization ( )

default

Destructor.

◆ DigitalSurfaceRegularization() [2/3]

template<typename TDigitalSurface >

DGtal::DigitalSurfaceRegularization< TDigitalSurface >::DigitalSurfaceRegularization ( const DigitalSurfaceRegularization< TDigitalSurface > & other )

delete

Copy constructor.

Parameters

other the object to clone.

◆ DigitalSurfaceRegularization() [3/3]

template<typename TDigitalSurface >

DGtal::DigitalSurfaceRegularization< TDigitalSurface >::DigitalSurfaceRegularization ( DigitalSurfaceRegularization< TDigitalSurface > && other )

delete

Move constructor.

Parameters

other the object to move.

Member Function Documentation

◆ attachConvolvedTrivialNormalVectors()

template<typename TDigitalSurface >

void DGtal::DigitalSurfaceRegularization< TDigitalSurface >::attachConvolvedTrivialNormalVectors ( const Parameters someParams = SH3::defaultParameters()|SHG3::defaultParameters() )

Attach convolved trivial normal vectors to the digital surface (cf ShortCutsGeometry::getCTrivialNormalVectors).

An important parameter is the radius used to estimate the normal vectors (t-ring, default=3.0).

Parameters

someParams the parameters (t-ring, default=3.0 used in the local convolution).

Referenced by main(), and TEST_CASE().

◆ attachNormalVectors()

template<typename TDigitalSurface >

void DGtal::DigitalSurfaceRegularization< TDigitalSurface >::attachNormalVectors ( const std::function< SHG3::RealVector(SH3::SCell &)> & normalFunc )

Attach normal vectors from a generic function that associates a normal vector to each surfel.

Parameters

normalFunc a function (or a lambda, or a functor) that maps surfels (SH3::SCell) to normal vectors (SH3::RealVector).

Referenced by TEST_CASE().

◆ BOOST_CONCEPT_ASSERT()

template<typename TDigitalSurface >

DGtal::DigitalSurfaceRegularization< TDigitalSurface >::BOOST_CONCEPT_ASSERT ( (concepts::CDigitalSurfaceContainer< DigitalSurfaceContainer >) )

◆ cacheInit()

template<typename TDigitalSurface >

void DGtal::DigitalSurfaceRegularization< TDigitalSurface >::cacheInit ( )

private

Internal init method to set up topological caches.

◆ clampedAdvection()

template<typename TDigitalSurface >

static void DGtal::DigitalSurfaceRegularization< TDigitalSurface >::clampedAdvection	(	SHG3::RealPoint &	p,
		const SHG3::RealPoint &	orig,
		const SHG3::RealVector &	v
	)

inlinestatic

Static method to be used in regularize() that clamps to regularized point p when shifted by v in the unit cube centered at orig.

Parameters

[in,out]	p	the point to advect.
[in]	orig	the associated point in the original surface.
[in]	v	the advection vector.

Definition at line 292 of file DigitalSurfaceRegularization.h.

     {
       p += v;
       for(auto i=0; i < 3; ++i)
         if ((p[i]-orig[i])> 0.5) p[i]=orig[i]+0.5;
         else
           if ((p[i]-orig[i])< -0.5) p[i]=orig[i]-0.5;
     }

◆ computeGradient()

template<typename TDigitalSurface >

double DGtal::DigitalSurfaceRegularization< TDigitalSurface >::computeGradient ( )

Compute the energy gradient vector and return the energy value.

Note: init() method must have been called and normal vectors must be have been attached to the surfels.

Returns: the energy value.

Referenced by TEST_CASE().

◆ computeGradientLocalWeights()

template<typename TDigitalSurface >

double DGtal::DigitalSurfaceRegularization< TDigitalSurface >::computeGradientLocalWeights ( )

Compute the energy gradient vector and return the energy value.

This method assumes that you have local alpha, beta and gamma weights.

Note: init(alphas,betas,gammas) method must have been called and normal vectors must have been attached to the surfels.

Returns: the energy value.

◆ disasbleVerbose()

template<typename TDigitalSurface >

void DGtal::DigitalSurfaceRegularization< TDigitalSurface >::disasbleVerbose ( )

inline

Disable verbose messages.

Definition at line 404 of file DigitalSurfaceRegularization.h.

404 {myVerbose=false;}

References DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myVerbose.

◆ enableVerbose()

template<typename TDigitalSurface >

void DGtal::DigitalSurfaceRegularization< TDigitalSurface >::enableVerbose ( )

inline

Enable verbose messages.

Definition at line 399 of file DigitalSurfaceRegularization.h.

399 {myVerbose=true;}

References DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myVerbose.

◆ getCellIndex()

template<typename TDigitalSurface >

const SH3::Cell2Index& DGtal::DigitalSurfaceRegularization< TDigitalSurface >::getCellIndex ( ) const

inline

Returns: the CellIndex (Cell->Index map) for the positions and normal vectors containers.

Note: the init() method must have been called.

Definition at line 343 of file DigitalSurfaceRegularization.h.

     {
       ASSERT_MSG(myInit, "The init() method must be called first.");
       return myPointelIndex;
     }

References DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myInit, and DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myPointelIndex.

Referenced by TEST_CASE().

◆ getNormalVectors()

template<typename TDigitalSurface >

const Normals& DGtal::DigitalSurfaceRegularization< TDigitalSurface >::getNormalVectors ( ) const

inline

Returns: the input normal vectors (see getSurfelIndex for the Cell->Index map).

Note: the init() method must have been called.

Definition at line 353 of file DigitalSurfaceRegularization.h.

     {
       ASSERT_MSG(myInit, "The init() method must be called first.");
       return myNormals;
     }

References DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myInit, and DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myNormals.

Referenced by TEST_CASE().

◆ getOriginalPositions()

template<typename TDigitalSurface >

const Positions& DGtal::DigitalSurfaceRegularization< TDigitalSurface >::getOriginalPositions ( ) const

inline

Returns: the input vertices positions (see getCellIndex for the Cell->Index map).

Note: the init() method must have been called.

Definition at line 333 of file DigitalSurfaceRegularization.h.

     {
       ASSERT_MSG(myInit, "The init() method must be called first.");
       return myOriginalPositions;
     }

References DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myInit, and DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myOriginalPositions.

Referenced by TEST_CASE().

◆ getRegularizedPosition()

template<typename TDigitalSurface >

SHG3::RealPoint DGtal::DigitalSurfaceRegularization< TDigitalSurface >::getRegularizedPosition ( const SH3::Cell & aPointel )

inline

Returns: the regularized position of a given pointel aPointel.

Parameters

[in] aPointel the digital surface pointel.

Note: the init() method must have been called. For relevant results, the regularize() methods should have been also called before accessing the new positions.

Definition at line 311 of file DigitalSurfaceRegularization.h.

     {
       ASSERT_MSG(myInit, "The init() method must be called first.");
       ASSERT_MSG(myK.uDim(aPointel) == 0, "The cell must be a pointel (0-cell)");
       return myRegularizedPositions[ myPointelIndex[ aPointel] ];
     }

References DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myInit, DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myK, DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myPointelIndex, and DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myRegularizedPositions.

Referenced by TEST_CASE().

◆ getRegularizedPositions()

template<typename TDigitalSurface >

const Positions& DGtal::DigitalSurfaceRegularization< TDigitalSurface >::getRegularizedPositions ( ) const

inline

Returns: the regularized vertices positions (see getCellIndex for the Cell->Index map).

Note: the init() method must have been called.

Definition at line 323 of file DigitalSurfaceRegularization.h.

     {
       ASSERT_MSG(myInit, "The init() method must be called first.");
       return myRegularizedPositions;
     }

References DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myInit, and DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myRegularizedPositions.

Referenced by main(), and TEST_CASE().

◆ getSurfelIndex()

template<typename TDigitalSurface >

const SH3::Surfel2Index& DGtal::DigitalSurfaceRegularization< TDigitalSurface >::getSurfelIndex ( ) const

inline

Returns: the CellIndex (Cell->Index map) for the positions and normal vectors containers.

Note: the init() method must have been called.

Definition at line 364 of file DigitalSurfaceRegularization.h.

     {
       ASSERT_MSG(myInit, "The init() method must be called first.");
       return mySurfelIndex;
     }

References DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myInit, and DGtal::DigitalSurfaceRegularization< TDigitalSurface >::mySurfelIndex.

Referenced by TEST_CASE().

◆ init() [1/2]

template<typename TDigitalSurface >

void DGtal::DigitalSurfaceRegularization< TDigitalSurface >::init	(	const double	alpha = `0.001`,
		const double	beta = `1.0`,
		const double	gamma = `0.05`
	)

Initialize the parameters of the energy function.

This init() method attaches the same weights to all vertices.

Parameters

[in]	alpha	the data attachment term coeff. (default=0.001)
[in]	beta	the alignemnt term coeff. (default=1.0)
[in]	gamma	the fairness term coeef. (default=0.05)

Referenced by main(), and TEST_CASE().

◆ init() [2/2]

template<typename TDigitalSurface >

void DGtal::DigitalSurfaceRegularization< TDigitalSurface >::init	(	ConstAlias< std::vector< double > >	alphas,
		ConstAlias< std::vector< double > >	betas,
		ConstAlias< std::vector< double > >	gammas
	)

Initialize the parameters of the energy function.

This init() method considers local weights per vertex (all verctors must have the same size: the number of pointels of the original surface).

Parameters

[in]	alphas	the data attachment term coeff.
[in]	betas	the alignemnt term coeff.
[in]	gammas	the fairness term coeef.

◆ isValid()

template<typename TDigitalSurface >

bool DGtal::DigitalSurfaceRegularization< TDigitalSurface >::isValid ( ) const

Checks the validity/consistency of the object.

Returns: 'true' if the object is valid, 'false' otherwise.

Referenced by TEST_CASE().

◆ operator=() [1/2]

template<typename TDigitalSurface >

DigitalSurfaceRegularization& DGtal::DigitalSurfaceRegularization< TDigitalSurface >::operator= ( const DigitalSurfaceRegularization< TDigitalSurface > & other )

delete

Copy assignment operator.

Parameters

other the object to copy.

Returns: a reference on 'this'.

◆ operator=() [2/2]

template<typename TDigitalSurface >

DigitalSurfaceRegularization& DGtal::DigitalSurfaceRegularization< TDigitalSurface >::operator= ( DigitalSurfaceRegularization< TDigitalSurface > && other )

delete

Move assignment operator.

Parameters

other the object to move.

Returns: a reference on 'this'.

◆ regularize() [1/2]

template<typename TDigitalSurface >

template<typename AdvectionFunction >

double DGtal::DigitalSurfaceRegularization< TDigitalSurface >::regularize	(	const unsigned int	nbIters,
		const double	dt,
		const double	epsilon,
		const AdvectionFunction &	advectionFunc
	)

Main regularization loop.

This method performs the main minimization loop of the energy using a gradient descent scheme (with automatic update of the learning step). The iterative process stops either when the number of steps reaches nbIters, or when the \(l_\infty\) norm of the energy gradient is below epsilon.

The last parameter is a function that describes how regularized points are advected during the gradient descent. By default, points are shifted by a fraction of the energy gradient vector (and the default function is thus \( p \leftarrow p + v\) with \( v = -dt \nabla E_p\)). See

See also: clampedAdvection for another advection strategy.

The energy at the final step is returned.

Parameters

[in]	nbIters	maxium number of steps
[in]	dt	initial learning rate
[in]	epsilon	minimum l_infity norm of the gradient vector
[in]	advectionFunc	advection function/functor/lambda to move a regularized point &a p associated with the original point o w.r.t to a displacement vector v (default = p+v)

Template Parameters

AdvectionFunction type of advection function, functor or lambda (RealPoint, RealPoint, RealVector)->RealPoint.

Returns: the energy at the final step.

Referenced by main(), DGtal::DigitalSurfaceRegularization< TDigitalSurface >::regularize(), and TEST_CASE().

◆ regularize() [2/2]

template<typename TDigitalSurface >

double DGtal::DigitalSurfaceRegularization< TDigitalSurface >::regularize	(	const unsigned int	nbIters = `200`,
		const double	dt = `1.0`,
		const double	epsilon = `0.0001`
	)

inline

Main regularization loop.

This methods uses the default advection function \( p = p + v\).

The energy at the final step is returned.

Parameters

[in]	nbIters	maxium number of steps (default=200)
[in]	dt	initial learning rate (default = 1.0)
[in]	epsilon	minimum l_infity norm of the gradient vector (default = 0.0001)

Returns: the energy at the final step.

Definition at line 273 of file DigitalSurfaceRegularization.h.

        {
          return regularize(nbIters,dt,epsilon,
                            [](SHG3::RealPoint& p,SHG3::RealPoint& o,SHG3::RealVector& v){ (void)o; p += v; });
        }

References dt, and DGtal::DigitalSurfaceRegularization< TDigitalSurface >::regularize().

◆ reset()

template<typename TDigitalSurface >

void DGtal::DigitalSurfaceRegularization< TDigitalSurface >::reset ( )

inline

Reset the regularized vertices positions to the original one.

Note: the init() method must have been called.

Definition at line 374 of file DigitalSurfaceRegularization.h.

     {
       ASSERT_MSG(myInit, "The init() method must be called first.");
       std::copy(myOriginalPositions.begin(), myOriginalPositions.end(), myRegularizedPositions.begin());
     }

References DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myInit, DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myOriginalPositions, and DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myRegularizedPositions.

Referenced by TEST_CASE().

◆ selfDisplay()

template<typename TDigitalSurface >

void DGtal::DigitalSurfaceRegularization< TDigitalSurface >::selfDisplay ( std::ostream & out ) const

Writes/Displays the object on an output stream.

Parameters

out	the output stream where the object is written.

Field Documentation

◆ myAlignPointels

template<typename TDigitalSurface >

std::vector< SH3::Cell > DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myAlignPointels

private

Adjacent pointels for the Alignement energy term.

Definition at line 479 of file DigitalSurfaceRegularization.h.

◆ myAlignPointelsIdx

template<typename TDigitalSurface >

std::vector< SH3::Idx > DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myAlignPointelsIdx

private

Indices of adjacent pointels for the Alignement energy term.

Definition at line 477 of file DigitalSurfaceRegularization.h.

◆ myAlpha

template<typename TDigitalSurface >

double DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myAlpha

private

Data attachment term coefficient.

Definition at line 419 of file DigitalSurfaceRegularization.h.

◆ myAlphas

template<typename TDigitalSurface >

const std::vector<double>* DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myAlphas

private

Data attachment term local coefficients.

Definition at line 426 of file DigitalSurfaceRegularization.h.

◆ myBeta

template<typename TDigitalSurface >

double DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myBeta

private

Alignment term coefficient.

Definition at line 421 of file DigitalSurfaceRegularization.h.

◆ myBetas

template<typename TDigitalSurface >

const std::vector<double>* DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myBetas

private

Alignment attachment term local coefficients.

Definition at line 428 of file DigitalSurfaceRegularization.h.

◆ myConstantCoeffs

template<typename TDigitalSurface >

bool DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myConstantCoeffs

private

Flag if the gradient has constant weights for the init method and gradient.

Definition at line 433 of file DigitalSurfaceRegularization.h.

◆ myDigitalSurface

template<typename TDigitalSurface >

CountedPtr<DigSurface> DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myDigitalSurface

private

Input DigitalSurface to regularize.

Definition at line 442 of file DigitalSurfaceRegularization.h.

Referenced by DGtal::DigitalSurfaceRegularization< TDigitalSurface >::DigitalSurfaceRegularization().

◆ myFaces

template<typename TDigitalSurface >

SH3::PolygonalSurface::FaceRange DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myFaces

private

All faces of the dual digital surfacce.

Definition at line 487 of file DigitalSurfaceRegularization.h.

◆ myFairnessPointelsIdx

template<typename TDigitalSurface >

std::vector< SH3::Idx > DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myFairnessPointelsIdx

private

Indices of cells foor the Fairness term.

Definition at line 483 of file DigitalSurfaceRegularization.h.

◆ myGamma

template<typename TDigitalSurface >

double DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myGamma

private

Fairness term coefficient.

Definition at line 423 of file DigitalSurfaceRegularization.h.

◆ myGammas

template<typename TDigitalSurface >

const std::vector<double>* DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myGammas

private

Fairness attachment term local coefficients.

Definition at line 430 of file DigitalSurfaceRegularization.h.

◆ myGradient

template<typename TDigitalSurface >

Positions DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myGradient

private

Gradient of the energy w.r.t. vertex positons.

Definition at line 454 of file DigitalSurfaceRegularization.h.

◆ myGradientAlign

template<typename TDigitalSurface >

Positions DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myGradientAlign

private

Internal members to store precomputed topological informations.

Gradient of the quad alignement w.r.t. vertex positons

Definition at line 462 of file DigitalSurfaceRegularization.h.

◆ myInit

template<typename TDigitalSurface >

bool DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myInit

private

Flag if the object has been set up properly.

Definition at line 436 of file DigitalSurfaceRegularization.h.

Referenced by DGtal::DigitalSurfaceRegularization< TDigitalSurface >::getCellIndex(), DGtal::DigitalSurfaceRegularization< TDigitalSurface >::getNormalVectors(), DGtal::DigitalSurfaceRegularization< TDigitalSurface >::getOriginalPositions(), DGtal::DigitalSurfaceRegularization< TDigitalSurface >::getRegularizedPosition(), DGtal::DigitalSurfaceRegularization< TDigitalSurface >::getRegularizedPositions(), DGtal::DigitalSurfaceRegularization< TDigitalSurface >::getSurfelIndex(), and DGtal::DigitalSurfaceRegularization< TDigitalSurface >::reset().

◆ myK

template<typename TDigitalSurface >

SH3::KSpace DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myK

private

Instance of the KSpace.

Definition at line 465 of file DigitalSurfaceRegularization.h.

Referenced by DGtal::DigitalSurfaceRegularization< TDigitalSurface >::DigitalSurfaceRegularization(), and DGtal::DigitalSurfaceRegularization< TDigitalSurface >::getRegularizedPosition().

◆ myNbAdjacent

template<typename TDigitalSurface >

std::vector< unsigned char > DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myNbAdjacent

private

Number of adjacent faces to given vertex.

Definition at line 485 of file DigitalSurfaceRegularization.h.

◆ myNormals

template<typename TDigitalSurface >

Normals DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myNormals

private

Normals.

Definition at line 451 of file DigitalSurfaceRegularization.h.

Referenced by DGtal::DigitalSurfaceRegularization< TDigitalSurface >::getNormalVectors().

◆ myNumberAdjEdgesToPointel

template<typename TDigitalSurface >

std::vector<unsigned char> DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myNumberAdjEdgesToPointel

private

Number of adjacent edges to pointels.

Definition at line 481 of file DigitalSurfaceRegularization.h.

◆ myOriginalPositions

template<typename TDigitalSurface >

Positions DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myOriginalPositions

private

Copy of the input pointels positions.

Definition at line 445 of file DigitalSurfaceRegularization.h.

Referenced by DGtal::DigitalSurfaceRegularization< TDigitalSurface >::getOriginalPositions(), and DGtal::DigitalSurfaceRegularization< TDigitalSurface >::reset().

◆ myPointelIndex

template<typename TDigitalSurface >

SH3::Cell2Index DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myPointelIndex

private

Indices for pointels.

Definition at line 474 of file DigitalSurfaceRegularization.h.

Referenced by DGtal::DigitalSurfaceRegularization< TDigitalSurface >::getCellIndex(), and DGtal::DigitalSurfaceRegularization< TDigitalSurface >::getRegularizedPosition().

◆ myRegularizedPositions

template<typename TDigitalSurface >

Positions DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myRegularizedPositions

private

Regularized vertices.

Definition at line 448 of file DigitalSurfaceRegularization.h.

Referenced by DGtal::DigitalSurfaceRegularization< TDigitalSurface >::getRegularizedPosition(), DGtal::DigitalSurfaceRegularization< TDigitalSurface >::getRegularizedPositions(), and DGtal::DigitalSurfaceRegularization< TDigitalSurface >::reset().

◆ mySurfelIndex

template<typename TDigitalSurface >

SH3::Surfel2Index DGtal::DigitalSurfaceRegularization< TDigitalSurface >::mySurfelIndex

private

Surfel Index.

Definition at line 471 of file DigitalSurfaceRegularization.h.

Referenced by DGtal::DigitalSurfaceRegularization< TDigitalSurface >::getSurfelIndex().

◆ mySurfels

template<typename TDigitalSurface >

SH3::SurfelRange DGtal::DigitalSurfaceRegularization< TDigitalSurface >::mySurfels

private

Indexed surface elements.

Definition at line 468 of file DigitalSurfaceRegularization.h.

◆ myVerbose

template<typename TDigitalSurface >

bool DGtal::DigitalSurfaceRegularization< TDigitalSurface >::myVerbose

private

Flag for verbose messages.

Definition at line 439 of file DigitalSurfaceRegularization.h.

Referenced by DGtal::DigitalSurfaceRegularization< TDigitalSurface >::disasbleVerbose(), and DGtal::DigitalSurfaceRegularization< TDigitalSurface >::enableVerbose().

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

DigitalSurfaceRegularization.h

Public Types

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

template<typename TDigitalSurface> class DGtal::DigitalSurfaceRegularization< TDigitalSurface >

Member Typedef Documentation

◆ DigitalSurfaceContainer

◆ DigSurface

◆ Normals

◆ Positions

◆ SH3

◆ SHG3

Constructor & Destructor Documentation

◆ DigitalSurfaceRegularization() [1/3]

◆ ~DigitalSurfaceRegularization()

◆ DigitalSurfaceRegularization() [2/3]

◆ DigitalSurfaceRegularization() [3/3]

Member Function Documentation

◆ attachConvolvedTrivialNormalVectors()

◆ attachNormalVectors()

◆ BOOST_CONCEPT_ASSERT()

◆ cacheInit()

◆ clampedAdvection()

◆ computeGradient()

◆ computeGradientLocalWeights()

◆ disasbleVerbose()

◆ enableVerbose()

◆ getCellIndex()

◆ getNormalVectors()

◆ getOriginalPositions()

◆ getRegularizedPosition()

◆ getRegularizedPositions()

◆ getSurfelIndex()

◆ init() [1/2]

◆ init() [2/2]

◆ isValid()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ regularize() [1/2]

◆ regularize() [2/2]

◆ reset()

◆ selfDisplay()

Field Documentation

◆ myAlignPointels

◆ myAlignPointelsIdx

◆ myAlpha

◆ myAlphas

◆ myBeta

◆ myBetas

◆ myConstantCoeffs

◆ myDigitalSurface

◆ myFaces

◆ myFairnessPointelsIdx

◆ myGamma

◆ myGammas

◆ myGradient

◆ myGradientAlign

◆ myInit

◆ myK

◆ myNbAdjacent

◆ myNormals

◆ myNumberAdjEdgesToPointel

◆ myOriginalPositions

◆ myPointelIndex

◆ myRegularizedPositions

◆ mySurfelIndex

◆ mySurfels

◆ myVerbose

template<typename TDigitalSurface>
class DGtal::DigitalSurfaceRegularization< TDigitalSurface >