DGtal: DGtal::DigitalMetricAdapter< TMetric, TInteger

Aim: simple adapter class which adapts any models of concepts::CMetricSpace to a model of concepts::CDigitalMetricSpace. More...

#include <DGtal/geometry/volumes/distance/DigitalMetricAdapter.h>

Public Types
typedef TMetric	Metric
	Input metric type. More...

typedef TInteger	Value
	Values are integer numbers. More...

typedef Metric::Point	Point
	Point type. More...

typedef Metric::Space	Space
	Space type. More...

typedef Value	RawValue
	RawValue type. More...

Public Member Functions
	BOOST_CONCEPT_ASSERT ((concepts::CMetricSpace< Metric >))

	BOOST_CONCEPT_ASSERT ((concepts::CInteger< Value >))

	DigitalMetricAdapter (ConstAlias< Metric > aMetric)

	DigitalMetricAdapter (const DigitalMetricAdapter &anotherMetric)

	~DigitalMetricAdapter ()

DigitalMetricAdapter &	operator= (const DigitalMetricAdapter &other)

Value	operator() (const Point &p, const Point &q) const

Value	rawDistance (const Point &p, const Point &q) const

DGtal::Closest	closest (const Point &a, const Point &p, const Point &q) const

void	selfDisplay (std::ostream &out) const

bool	isValid () const

Protected Member Functions
	DigitalMetricAdapter ()

Private Attributes
const Metric *	myMetric

Detailed Description

template<typename TMetric, typename TInteger = typename TMetric::Space::Integer>
class DGtal::DigitalMetricAdapter< TMetric, TInteger >

Aim: simple adapter class which adapts any models of concepts::CMetricSpace to a model of concepts::CDigitalMetricSpace.

Description of template class 'DigitalMetricAdapter'

This class uses the ceil function to perform the adaptation. This class is thus a model of CDigitalMetricSpace

Template Parameters

TMetric	any model of concepts::CMetricSpace.
TInteger	any model of concepts::CInteger to be used as value type. By default, it corresponds to the Integer type of the digital space in which the TMetric is defined.

Definition at line 71 of file DigitalMetricAdapter.h.

Member Typedef Documentation

◆ Metric

template<typename TMetric , typename TInteger = typename TMetric::Space::Integer>

typedef TMetric DGtal::DigitalMetricAdapter< TMetric, TInteger >::Metric

Input metric type.

Definition at line 77 of file DigitalMetricAdapter.h.

◆ Point

template<typename TMetric , typename TInteger = typename TMetric::Space::Integer>

typedef Metric::Point DGtal::DigitalMetricAdapter< TMetric, TInteger >::Point

Point type.

Definition at line 86 of file DigitalMetricAdapter.h.

◆ RawValue

template<typename TMetric , typename TInteger = typename TMetric::Space::Integer>

typedef Value DGtal::DigitalMetricAdapter< TMetric, TInteger >::RawValue

RawValue type.

Definition at line 92 of file DigitalMetricAdapter.h.

◆ Space

template<typename TMetric , typename TInteger = typename TMetric::Space::Integer>

typedef Metric::Space DGtal::DigitalMetricAdapter< TMetric, TInteger >::Space

Space type.

Definition at line 89 of file DigitalMetricAdapter.h.

◆ Value

template<typename TMetric , typename TInteger = typename TMetric::Space::Integer>

typedef TInteger DGtal::DigitalMetricAdapter< TMetric, TInteger >::Value

Values are integer numbers.

Definition at line 81 of file DigitalMetricAdapter.h.

Constructor & Destructor Documentation

◆ DigitalMetricAdapter() [1/3]

template<typename TMetric , typename TInteger = typename TMetric::Space::Integer>

DGtal::DigitalMetricAdapter< TMetric, TInteger >::DigitalMetricAdapter ( ConstAlias< Metric > aMetric )

inline

Constructor from a CMetricSpace model.

Parameters

aMetric the metric to adapt.

Definition at line 100 of file DigitalMetricAdapter.h.

100 :

101 myMetric(&aMetric) {}

DGtal::DigitalMetricAdapter::myMetric

const Metric * myMetric

Definition: DigitalMetricAdapter.h:202

◆ DigitalMetricAdapter() [2/3]

template<typename TMetric , typename TInteger = typename TMetric::Space::Integer>

DGtal::DigitalMetricAdapter< TMetric, TInteger >::DigitalMetricAdapter ( const DigitalMetricAdapter< TMetric, TInteger > & anotherMetric )

inline

Copy Constructor

Parameters

anotherMetric the digital metric adapter to copy.

Definition at line 109 of file DigitalMetricAdapter.h.

     {
        if (this != &anotherMetric)
          this->myMetric = anotherMetric.myMetric;
     }

References DGtal::DigitalMetricAdapter< TMetric, TInteger >::myMetric.

◆ ~DigitalMetricAdapter()

template<typename TMetric , typename TInteger = typename TMetric::Space::Integer>

DGtal::DigitalMetricAdapter< TMetric, TInteger >::~DigitalMetricAdapter ( )

inline

Destructor.

Definition at line 119 of file DigitalMetricAdapter.h.

119 {}

◆ DigitalMetricAdapter() [3/3]

template<typename TMetric , typename TInteger = typename TMetric::Space::Integer>

DGtal::DigitalMetricAdapter< TMetric, TInteger >::DigitalMetricAdapter ( )

protected

Constructor. Forbidden by default (protected to avoid g++ warnings).

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT() [1/2]

template<typename TMetric , typename TInteger = typename TMetric::Space::Integer>

DGtal::DigitalMetricAdapter< TMetric, TInteger >::BOOST_CONCEPT_ASSERT ( (concepts::CInteger< Value >) )

◆ BOOST_CONCEPT_ASSERT() [2/2]

template<typename TMetric , typename TInteger = typename TMetric::Space::Integer>

DGtal::DigitalMetricAdapter< TMetric, TInteger >::BOOST_CONCEPT_ASSERT ( (concepts::CMetricSpace< Metric >) )

◆ closest()

template<typename TMetric , typename TInteger = typename TMetric::Space::Integer>

DGtal::Closest DGtal::DigitalMetricAdapter< TMetric, TInteger >::closest	(	const Point &	a,
		const Point &	p,
		const Point &	q
	)		const

inline

closest operator.

Parameters

[in]	a	the origin point.
[in]	p	a first point.
[in]	q	a second point.

Returns: decides which point from p and q is closer to a.

Definition at line 169 of file DigitalMetricAdapter.h.

     {
       if (this->operator()(a,p) < this->operator()(a,q))
         return DGtal::ClosestFIRST;
       if (this->operator()(a,p) > this->operator()(a,q))
         return DGtal::ClosestSECOND;
       return DGtal::ClosestBOTH;
     }

References DGtal::ClosestBOTH, DGtal::ClosestFIRST, and DGtal::ClosestSECOND.

◆ isValid()

template<typename TMetric , typename TInteger = typename TMetric::Space::Integer>

bool DGtal::DigitalMetricAdapter< TMetric, TInteger >::isValid ( ) const

inline

Checks the validity/consistency of the object.

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

Definition at line 195 of file DigitalMetricAdapter.h.

195 { return (myMetric != NULL); }

References DGtal::DigitalMetricAdapter< TMetric, TInteger >::myMetric.

◆ operator()()

template<typename TMetric , typename TInteger = typename TMetric::Space::Integer>

Value DGtal::DigitalMetricAdapter< TMetric, TInteger >::operator()	(	const Point &	p,
		const Point &	q
	)		const

inline

Distance operator.

Parameters

[in]	p	a first point.
[in]	q	a second point.

Returns: the casted distance from p to q

Definition at line 144 of file DigitalMetricAdapter.h.

     {
       return static_cast<Value>( std::ceil ( NumberTraits<typename Metric::Value>::castToDouble( myMetric->operator()(p,q))));
     }

References DGtal::DigitalMetricAdapter< TMetric, TInteger >::myMetric.

Referenced by DGtal::DigitalMetricAdapter< TMetric, TInteger >::rawDistance().

◆ operator=()

template<typename TMetric , typename TInteger = typename TMetric::Space::Integer>

DigitalMetricAdapter& DGtal::DigitalMetricAdapter< TMetric, TInteger >::operator= ( const DigitalMetricAdapter< TMetric, TInteger > & other )

inline

Assignment.

Parameters

other the object to copy.

Returns: a reference on 'this'.

Definition at line 131 of file DigitalMetricAdapter.h.

     {
       myMetric = other.myMetric;
       return *this;
     }

References DGtal::DigitalMetricAdapter< TMetric, TInteger >::myMetric.

◆ rawDistance()

template<typename TMetric , typename TInteger = typename TMetric::Space::Integer>

Value DGtal::DigitalMetricAdapter< TMetric, TInteger >::rawDistance	(	const Point &	p,
		const Point &	q
	)		const

inline

RawDistance operator.

Parameters

[in]	p	a first point.
[in]	q	a second point.

Returns: the casted distance from p to q

Definition at line 156 of file DigitalMetricAdapter.h.

     {
       return this->operator()(p,q);
     }

References DGtal::DigitalMetricAdapter< TMetric, TInteger >::operator()().

◆ selfDisplay()

template<typename TMetric , typename TInteger = typename TMetric::Space::Integer>

void DGtal::DigitalMetricAdapter< TMetric, TInteger >::selfDisplay ( std::ostream & out ) const

inline

Writes/Displays the object on an output stream.

Parameters

out	the output stream where the object is written.

Definition at line 186 of file DigitalMetricAdapter.h.

     {
       out << "[DigitalMetricAdapter] adapted from "<< *myMetric;
     }

References DGtal::DigitalMetricAdapter< TMetric, TInteger >::myMetric.

Field Documentation

◆ myMetric

template<typename TMetric , typename TInteger = typename TMetric::Space::Integer>

const Metric* DGtal::DigitalMetricAdapter< TMetric, TInteger >::myMetric

private

Definition at line 202 of file DigitalMetricAdapter.h.

Referenced by DGtal::DigitalMetricAdapter< TMetric, TInteger >::DigitalMetricAdapter(), DGtal::DigitalMetricAdapter< TMetric, TInteger >::isValid(), DGtal::DigitalMetricAdapter< TMetric, TInteger >::operator()(), DGtal::DigitalMetricAdapter< TMetric, TInteger >::operator=(), and DGtal::DigitalMetricAdapter< TMetric, TInteger >::selfDisplay().

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

DigitalMetricAdapter.h

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

template<typename TMetric, typename TInteger = typename TMetric::Space::Integer> class DGtal::DigitalMetricAdapter< TMetric, TInteger >

Member Typedef Documentation

◆ Metric

◆ Point

◆ RawValue

◆ Space

◆ Value

Constructor & Destructor Documentation

◆ DigitalMetricAdapter() [1/3]

◆ DigitalMetricAdapter() [2/3]

◆ ~DigitalMetricAdapter()

◆ DigitalMetricAdapter() [3/3]

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT() [1/2]

◆ BOOST_CONCEPT_ASSERT() [2/2]

◆ closest()

◆ isValid()

◆ operator()()

◆ operator=()

◆ rawDistance()

◆ selfDisplay()

Field Documentation

◆ myMetric

template<typename TMetric, typename TInteger = typename TMetric::Space::Integer>
class DGtal::DigitalMetricAdapter< TMetric, TInteger >