Ponca::Basket< P, NF, Ext0, Exts > Class Template Reference

Aggregator class used to declare specialized structures using CRTP. More...

#include <basket.h>

Inheritance diagram for Ponca::Basket< P, NF, Ext0, Exts >:

Collaboration diagram for Ponca::Basket< P, NF, Ext0, Exts >:

Public Types
using	Base = typename internal::BasketAggregate< P, NF, Ext0, Exts... >::type
	Base type, which aggregates all the computational objects using the CRTP.
using	Scalar = typename P::Scalar
	Scalar type used for computation, as defined from template parameter P
using	VectorType = typename P::VectorType
using	DataPoint = P
	Point type used for computation.
using	NeighborFilter = NF
	Weighting function.
Public Types inherited from Ponca::BasketComputeObject< Basket< P, NF, Ext0, Exts... >, internal::BasketAggregate< P, NF, Ext0, Exts... >::type >
using	Base = internal::BasketAggregate< P, NF, Ext0, Exts... >::type
using	Derived = Basket< P, NF, Ext0, Exts... >
	<
using	Scalar = typename Base::Scalar
	Alias to the Derived type.

Public Member Functions
void	init ()
	Initialize the fit.
void	startNewPass ()
	Start a new iteration over neighbor.
FIT_RESULT	finalize ()
	Finalize the fitting procedure.
bool	addNeighbor (const DataPoint &_nei)
	Add a neighbor to perform the fit.
void	addLocalNeighbor (typename P::Scalar _w, const typename P::VectorType &_localQ, const P &_nei)
	Add a local neighbor to perform the fit.
Public Member Functions inherited from Ponca::BasketComputeObject< Basket< P, NF, Ext0, Exts... >, internal::BasketAggregate< P, NF, Ext0, Exts... >::type >
FIT_RESULT	compute (const IteratorBegin &begin, const IteratorEnd &end)
	Convenience function for STL-like iterators Add neighbors stored in a container using STL-like iterators, and call finalize at the end.
FIT_RESULT	computeWithIds (IndexRange ids, const PointContainer &points)
	Convenience function to iterate over a subset of samples in a PointContainer Add neighbors stored in a PointContainer and sampled using indices stored in ids.
Public Member Functions inherited from Ponca::ComputeObject< Derived >
template<typename Container >
FIT_RESULT	compute (const Container &c)
	Convenience function for STL-like container.
template<typename IteratorBegin , typename IteratorEnd >
FIT_RESULT	compute (const IteratorBegin &, const IteratorEnd &)
	Convenience function for STL-like iterators.
template<typename IndexRange , typename PointContainer >
FIT_RESULT	computeWithIds (IndexRange, const PointContainer &)
	Convenience function to iterate over a subset of samples in a PointContainer.

Additional Inherited Members
Protected Member Functions inherited from Ponca::ComputeObject< Derived >
Derived &	derived ()
	Retrieve the top layer object Returns a reference to the derived class so that we can use its overwritten methods.

Detailed Description

template<class P, class NF, template< class, class, typename > class Ext0, template< class, class, typename > class... Exts>
requires IsPoint<P>
class Ponca::Basket< P, NF, Ext0, Exts >

Aggregator class used to declare specialized structures using CRTP.

Base ComputeObject for the Basket classes.

Implements the compute methods for fitting: compute, computeWithIds, ... Checkout Fitting Module: User Manual for more details

The various implementations of Ponca::Concept are mixed through specializations of the BasketDiff and Basket classes:

  using myFitDer =
  BasketDiff <BasketType,           // Existing Basket, to be differentiated
  DiffType,                         // Differentiation space: FitScaleDer, FitSpaceDer, or
FitScaleDer|FitSpaceDer ComputationalDerivativesConcept1, // Implementation of ComputationalDerivativesConcept
  ComputationalDerivativesConcept2, // Implementation of ComputationalDerivativesConcept
  ... ,                             //
  >;                                // Final structure to fit and derive a primitive over weighted samples

Template Parameters

Derived	Derived class that provides the addNeighbor method (either Basket or BasketDiff)
Base	Base class that provides, through the CRTP the init, startNewPass, addNeighbor and finalize methods
P	Implements PointConcept
W	Implements WeightKernelConcept
Ext0	Implements ComputationalObjectConcept
Exts	Implements ComputationalObjectConcept (optional)

Definition at line 292 of file basket.h.

Member Typedef Documentation

Base

template<class P , class NF , template< class, class, typename > class Ext0, template< class, class, typename > class... Exts>

using Ponca::Basket< P, NF, Ext0, Exts >::Base = typename internal::BasketAggregate<P, NF, Ext0, Exts...>::type

Base type, which aggregates all the computational objects using the CRTP.

Definition at line 300 of file basket.h.

DataPoint

template<class P , class NF , template< class, class, typename > class Ext0, template< class, class, typename > class... Exts>

using Ponca::Basket< P, NF, Ext0, Exts >::DataPoint = P

Point type used for computation.

Definition at line 305 of file basket.h.

NeighborFilter

template<class P , class NF , template< class, class, typename > class Ext0, template< class, class, typename > class... Exts>

using Ponca::Basket< P, NF, Ext0, Exts >::NeighborFilter = NF

Weighting function.

Definition at line 307 of file basket.h.

Scalar

template<class P , class NF , template< class, class, typename > class Ext0, template< class, class, typename > class... Exts>

using Ponca::Basket< P, NF, Ext0, Exts >::Scalar = typename P::Scalar

Scalar type used for computation, as defined from template parameter P

Definition at line 302 of file basket.h.

VectorType

template<class P , class NF , template< class, class, typename > class Ext0, template< class, class, typename > class... Exts>

using Ponca::Basket< P, NF, Ext0, Exts >::VectorType = typename P::VectorType

Definition at line 303 of file basket.h.

Member Function Documentation

addLocalNeighbor()

template<class P , class NF , template< class, class, typename > class Ext0, template< class, class, typename > class... Exts>
requires IsPoint<P>

void Ponca::Basket< P, NF, Ext0, Exts >::addLocalNeighbor	(	typename P::Scalar	_w,
		const typename P::VectorType &	_localQ,
		const P &	_nei
	)

Add a local neighbor to perform the fit.

When called directly, don't forget to call Fit::startNewPass when starting multiple passes

See also

compute Prefer when using a range of Points

computeWithIds Prefer when using a range of ids

Parameters

w	The weight of the neighbor
localQ	The location expressed in local coordinates
_nei	The neighbor

Returns

false if param nei is not a valid neighbor (weight = 0)

Definition at line 100 of file basket.hpp.

addNeighbor()

template<class P , class NF , template< class, class, typename > class Ext0, template< class, class, typename > class... Exts>
requires IsPoint<P>

bool Ponca::Basket< P, NF, Ext0, Exts >::addNeighbor

(

const DataPoint &

_nei

)

Add a neighbor to perform the fit.

When called directly, don't forget to call BasketBaseUnit::startNewPass when starting multiple passes

See also

compute Prefer when using a range of Points

computeWithIds Prefer when using a range of ids

Returns

false if param nei is not a valid neighbor (weight = 0)

Definition at line 84 of file basket.hpp.

finalize()

template<class P , class NF , template< class, class, typename > class Ext0, template< class, class, typename > class... Exts>
requires IsPoint<P>

FIT_RESULT Ponca::Basket< P, NF, Ext0, Exts >::finalize

(

)

Finalize the fitting procedure.

Definition at line 76 of file basket.hpp.

init()

template<class P , class NF , template< class, class, typename > class Ext0, template< class, class, typename > class... Exts>
requires IsPoint<P>

void Ponca::Basket< P, NF, Ext0, Exts >::init

(

)

Initialize the fit.

Definition at line 60 of file basket.hpp.

startNewPass()

template<class P , class NF , template< class, class, typename > class Ext0, template< class, class, typename > class... Exts>
requires IsPoint<P>

void Ponca::Basket< P, NF, Ext0, Exts >::startNewPass

(

)

Start a new iteration over neighbor.

/!\ Do not forget to use this function when multiple pass are needed

Definition at line 68 of file basket.hpp.