Ponca  a42f65f0b5a9ccdb8262b77f96627cee7b1744ae
Point Cloud Analysis library
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
Ponca::BasketDiff< BasketType, Type, Ext0, Exts > Class Template Reference

Aggregator class used to declare specialized structures with derivatives computations, using CRTP. More...

#include <basket.h>

+ Inheritance diagram for Ponca::BasketDiff< BasketType, Type, Ext0, Exts >:
+ Collaboration diagram for Ponca::BasketDiff< BasketType, Type, Ext0, Exts >:

Public Types

using Base = typename internal::BasketDiffAggregate< BasketType, Type, Ext0, Exts... >::type
 Base type, which aggregates all the computational objects using the CRTP.
 
using WeightFunction = typename BasketType::WeightFunction
 Weighting function.
 
using DataPoint = typename BasketType::DataPoint
 Point type used for computation.
 
using Scalar = typename DataPoint::Scalar
 Scalar type used for computation, as defined from Basket.
 

Public Member Functions

template<typename IteratorBegin , typename IteratorEnd >
FIT_RESULT compute (const IteratorBegin &begin, const IteratorEnd &end)
 Convenience function for STL-like iterators

 
template<typename IndexRange , typename PointContainer >
FIT_RESULT computeWithIds (IndexRange ids, const PointContainer &points)
 Convenience function to iterate over a subset of samples in a PointContainer

 
bool addNeighbor (const DataPoint &_nei)
 Add a neighbor to perform the fit.
 
- Public Member Functions inherited from Ponca::ComputeObject< BasketDiff< BasketType, Type, Ext0, Exts... > >
FIT_RESULT compute (const Container &c)
 Convenience function for STL-like container

 
FIT_RESULT compute (const IteratorBegin &begin, const IteratorEnd &end)
 Convenience function for STL-like iterators.
 
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< BasketDiff< BasketType, Type, Ext0, Exts... > >
BasketDiff< BasketType, Type, Ext0, Exts... > & derived ()
 Retrieve the top layer object Returns a reference to the derived class so that we can use its overwritten methods.
 

Detailed Description

template<typename BasketType, int Type, template< class, class, int, typename > class Ext0, template< class, class, int, typename > class... Exts>
class Ponca::BasketDiff< BasketType, Type, Ext0, Exts >

Aggregator class used to declare specialized structures with derivatives computations, using CRTP.

This is one of the central classes of the library (even if it does not perform any computation on its own). Checkout Fitting Module: User Manual for more details, and Basket class.

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

typedef
BasketDiff <BasketType, // Existing Basket, to be differentiated
DiffType, // Differentiation space: FitScaleDer, FitSpaceDer, or FitScaleDer|FitSpaceDer
ComputationalDerivativesConcept1, // Implementation of ComputationalDerivativesConcept
ComputationalDerivativesConcept2, // Implementation of ComputationalDerivativesConcept
... , //
> myFitDer; // Final structure to fit and derive a primitive over weighted samples
Ponca::BasketDiff
Aggregator class used to declare specialized structures with derivatives computations,...
Definition basket.h:184
Ponca::DiffType
DiffType
Flags defining which derivatives need to be computed.
Definition enums.h:34
See also
Basket for the aggregation of ComputationalObjectConcept
Template Parameters
BasketTypeExisting Basket, to be differentiated
TypeDifferentiation space: FitScaleDer, FitSpaceDer, or FitScaleDer|FitSpaceDer
Ext0Implements ComputationalDerivativesConcept
ExtsImplements ComputationalDerivativesConcept (optional)

Definition at line 183 of file basket.h.

Member Typedef Documentation

◆ Base

template<typename BasketType , int Type, template< class, class, int, typename > class Ext0, template< class, class, int, typename > class... Exts>
using Ponca::BasketDiff< BasketType, Type, Ext0, Exts >::Base = typename internal::BasketDiffAggregate<BasketType, Type, Ext0, Exts...>::type

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

Definition at line 189 of file basket.h.

◆ DataPoint

template<typename BasketType , int Type, template< class, class, int, typename > class Ext0, template< class, class, int, typename > class... Exts>
using Ponca::BasketDiff< BasketType, Type, Ext0, Exts >::DataPoint = typename BasketType::DataPoint

Point type used for computation.

Definition at line 193 of file basket.h.

◆ Scalar

template<typename BasketType , int Type, template< class, class, int, typename > class Ext0, template< class, class, int, typename > class... Exts>
using Ponca::BasketDiff< BasketType, Type, Ext0, Exts >::Scalar = typename DataPoint::Scalar

Scalar type used for computation, as defined from Basket.

Definition at line 195 of file basket.h.

◆ WeightFunction

template<typename BasketType , int Type, template< class, class, int, typename > class Ext0, template< class, class, int, typename > class... Exts>
using Ponca::BasketDiff< BasketType, Type, Ext0, Exts >::WeightFunction = typename BasketType::WeightFunction

Weighting function.

Definition at line 191 of file basket.h.

Member Function Documentation

◆ addNeighbor()

template<typename BasketType , int Type, template< class, class, int, typename > class Ext0, template< class, class, int, typename > class... Exts>
bool Ponca::BasketDiff< BasketType, Type, Ext0, Exts >::addNeighbor ( const DataPoint &  _nei)
inline

Add a neighbor to perform the fit.

When called directly, don't forget to call PrimitiveBase::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 201 of file basket.h.

◆ compute()

template<typename BasketType , int Type, template< class, class, int, typename > class Ext0, template< class, class, int, typename > class... Exts>
template<typename IteratorBegin , typename IteratorEnd >
FIT_RESULT Ponca::BasketDiff< BasketType, Type, Ext0, Exts >::compute ( const IteratorBegin &  begin,
const IteratorEnd &  end 
)
inline

Convenience function for STL-like iterators

Add neighbors stored in a container using STL-like iterators, and call finalize at the end.

The fit is evaluated multiple time if needed (see NEED_OTHER_PASS)

See also
addNeighbor()

Definition at line 198 of file basket.h.

◆ computeWithIds()

template<typename BasketType , int Type, template< class, class, int, typename > class Ext0, template< class, class, int, typename > class... Exts>
template<typename IndexRange , typename PointContainer >
FIT_RESULT Ponca::BasketDiff< BasketType, Type, Ext0, Exts >::computeWithIds ( IndexRange  ids,
const PointContainer &  points 
)
inline

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.

Template Parameters
IndexRangeSTL-Like range storing indices of the neighbors
PointContainerSTL-like container storing the points
See also
compute(const IteratorBegin& begin, const IteratorEnd& end)

Definition at line 198 of file basket.h.