DGtal: DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer

Aim: Implementation of the linear in time reverse distance transformation for separable metrics. More...

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

Inheritance diagram for DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >:

Public Types
typedef TWeightImage	WeightImage
	Separable Metric type. More...

typedef TPSeparableMetric	PowerSeparableMetric
	Separable Metric type. More...

typedef TImageContainer	ImageContainer
	Image Container type. More...

typedef PowerSeparableMetric::Value	Value
	Separable Metric type value type. More...

typedef TWeightImage::Domain::Space::Point	Point
	Point type. More...

typedef TWeightImage::Domain::Space::Vector	Vector
	Vector type. More...

typedef PowerSeparableMetric::Weight	Weight
	Separable Metric type weight type. More...

typedef ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >	Self
	Definition of the image. More...

typedef PowerMap< TWeightImage, TPSeparableMetric >	Parent

typedef DefaultConstImageRange< Self >	ConstRange
	Definition of the image constRange. More...

typedef PowerMap< TWeightImage, TPSeparableMetric, TImageContainer >::Domain	Domain
	Definition of the image value type. More...

Public Types inherited from DGtal::PowerMap< TWeightImage, TPSeparableMetric, ImageContainerBySTLVector< HyperRectDomain< typename TWeightImage::Domain::Space >, typename TWeightImage::Domain::Space::Vector > >
typedef TWeightImage	WeightImage
	Copy of the distance image types. More...

typedef TWeightImage::Value	Weight

typedef WeightImage::Domain::Space	Space

typedef Space::Vector	Vector

typedef Space::Point	Point

typedef Space::Dimension	Dimension

typedef Space::Size	Size

typedef Space::Point::Coordinate	Abscissa

typedef TImageContainer::Domain	Domain
	Definition of the underlying domain type. More...

typedef TPSeparableMetric	PowerSeparableMetric
	We construct the type associated to the separable metric. More...

typedef ImageContainerBySTLVector< HyperRectDomain< typename TWeightImage::Domain::Space >, typename TWeightImage::Domain::Space::Vector >	OutputImage
	Type of resulting image. More...

typedef Vector	Value
	Definition of the image model value type. More...

typedef OutputImage::ConstRange	ConstRange
	Definition of the image value type. More...

typedef PowerMap< TWeightImage, TPSeparableMetric, ImageContainerBySTLVector< HyperRectDomain< typename TWeightImage::Domain::Space >, typename TWeightImage::Domain::Space::Vector > >	Self
	Self type. More...

typedef std::array< bool, Space::dimension >	PeriodicitySpec
	Periodicity specification type. More...

Public Member Functions
	BOOST_CONCEPT_ASSERT ((concepts::CImage< ImageContainer >))

	ReverseDistanceTransformation (ConstAlias< Domain > aDomain, ConstAlias< WeightImage > aWeightImage, ConstAlias< PowerSeparableMetric > aMetric)

	ReverseDistanceTransformation (ConstAlias< Domain > aDomain, ConstAlias< WeightImage > aWeightImage, ConstAlias< PowerSeparableMetric > aMetric, typename Parent::PeriodicitySpec const &aPeriodicitySpec)

	~ReverseDistanceTransformation ()

const Domain &	domain () const

ConstRange	constRange () const

Value	operator() (const Point &aPoint) const

Vector	getPowerVector (const Point &aPoint) const

const PowerSeparableMetric *	metricPtr () const

void	selfDisplay (std::ostream &out) const

Public Member Functions inherited from DGtal::PowerMap< TWeightImage, TPSeparableMetric, ImageContainerBySTLVector< HyperRectDomain< typename TWeightImage::Domain::Space >, typename TWeightImage::Domain::Space::Vector > >
	BOOST_CONCEPT_ASSERT ((concepts::CImage< ImageContainerBySTLVector< HyperRectDomain< typename TWeightImage::Domain::Space >, typename TWeightImage::Domain::Space::Vector > >))

	BOOST_CONCEPT_ASSERT ((concepts::CConstImage< TWeightImage >))

	BOOST_CONCEPT_ASSERT ((concepts::CPowerSeparableMetric< TPSeparableMetric >))

	BOOST_STATIC_ASSERT ((boost::is_same< typename TWeightImage::Domain::Space, typename TImageContainer::Domain::Space >::value))

	BOOST_STATIC_ASSERT ((boost::is_same< typename TWeightImage::Domain::Space::Vector, typename TImageContainer::Value >::value))

	BOOST_STATIC_ASSERT ((boost::is_same< HyperRectDomain< typename TWeightImage::Domain::Space >, typename TImageContainer::Domain >::value))

	PowerMap (ConstAlias< Domain > aDomain, ConstAlias< WeightImage > aWeightImage, ConstAlias< PowerSeparableMetric > aMetric)

	PowerMap (ConstAlias< Domain > aDomain, ConstAlias< WeightImage > aWeightImage, ConstAlias< PowerSeparableMetric > aMetric, PeriodicitySpec const &aPeriodicitySpec)

	PowerMap ()=delete

	~PowerMap ()=default

Self &	operator= (const Self &aOtherPowerMap)=default

const Domain &	domain () const

ConstRange	constRange () const

Value	operator() (const Point &aPoint) const

const PowerSeparableMetric *	metricPtr () const

const WeightImage *	weightImagePtr () const

PeriodicitySpec const &	getPeriodicitySpec () const

bool	isPeriodic (const Dimension n) const

Point	projectPoint (Point aPoint) const

void	selfDisplay (std::ostream &out) const

Protected Member Functions
	ReverseDistanceTransformation ()

Additional Inherited Members
Protected Attributes inherited from DGtal::PowerMap< TWeightImage, TPSeparableMetric, ImageContainerBySTLVector< HyperRectDomain< typename TWeightImage::Domain::Space >, typename TWeightImage::Domain::Space::Vector > >
const PowerSeparableMetric *	myMetricPtr
	Pointer to the separable metric instance. More...

CountedPtr< OutputImage >	myImagePtr
	Power map image. More...

const WeightImage *	myWeightImagePtr
	Pointer to the point predicate. More...

PeriodicitySpec	myPeriodicitySpec
	Periodicity along each dimension. More...

Detailed Description

template<typename TWeightImage, typename TPSeparableMetric, typename TImageContainer = ImageContainerBySTLVector<HyperRectDomain<typename TWeightImage::Domain::Space>, typename TWeightImage::Domain::Space::Vector>>
class DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >

Aim: Implementation of the linear in time reverse distance transformation for separable metrics.

Description of template class 'ReverseDistanceTransformation'

This class is a wrapper around a power map construction (see PowerMap). More precisely, at a point p, since the PowerMap at p returns a vector to the closest power site, this class adapts the operator() in order to returns the power distance to the closest weighted site for the considered metric.

Please refer to PowerMap documentation for details on the computational cost and parameter description.

This class is a model of CConstImage.

Template Parameters

TWeightImage	model of CConstImage
TPSeparableMetric	model of CPowerSeparableMetric
TImageContainer	any model of CImage to store the PowerMap (default: ImageContainerBySTLVector). The space of the image container and the TSpace should match. Furthermore the container value type must be TSpace::Vector.

Definition at line 93 of file ReverseDistanceTransformation.h.

Member Typedef Documentation

◆ ConstRange

template<typename TWeightImage , typename TPSeparableMetric , typename TImageContainer = ImageContainerBySTLVector<HyperRectDomain<typename TWeightImage::Domain::Space>, typename TWeightImage::Domain::Space::Vector>>

typedef DefaultConstImageRange<Self> DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >::ConstRange

Definition of the image constRange.

Definition at line 129 of file ReverseDistanceTransformation.h.

◆ Domain

typedef PowerMap< TWeightImage,TPSeparableMetric, TImageContainer >::Domain DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >::Domain

Definition of the image value type.

Definition at line 134 of file ReverseDistanceTransformation.h.

◆ ImageContainer

typedef TImageContainer DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >::ImageContainer

Image Container type.

Definition at line 106 of file ReverseDistanceTransformation.h.

◆ Parent

typedef PowerMap<TWeightImage,TPSeparableMetric> DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >::Parent

Definition at line 126 of file ReverseDistanceTransformation.h.

◆ Point

typedef TWeightImage::Domain::Space::Point DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >::Point

Point type.

Definition at line 113 of file ReverseDistanceTransformation.h.

◆ PowerSeparableMetric

typedef TPSeparableMetric DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >::PowerSeparableMetric

Separable Metric type.

Definition at line 103 of file ReverseDistanceTransformation.h.

◆ Self

typedef ReverseDistanceTransformation<TWeightImage, TPSeparableMetric, TImageContainer> DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >::Self

Definition of the image.

Definition at line 124 of file ReverseDistanceTransformation.h.

◆ Value

typedef PowerSeparableMetric::Value DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >::Value

Separable Metric type value type.

Definition at line 110 of file ReverseDistanceTransformation.h.

◆ Vector

typedef TWeightImage::Domain::Space::Vector DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >::Vector

Vector type.

Definition at line 116 of file ReverseDistanceTransformation.h.

◆ Weight

typedef PowerSeparableMetric::Weight DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >::Weight

Separable Metric type weight type.

Definition at line 119 of file ReverseDistanceTransformation.h.

◆ WeightImage

typedef TWeightImage DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >::WeightImage

Separable Metric type.

Definition at line 100 of file ReverseDistanceTransformation.h.

Constructor & Destructor Documentation

◆ ReverseDistanceTransformation() [1/3]

DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >::ReverseDistanceTransformation	(	ConstAlias< Domain >	aDomain,
		ConstAlias< WeightImage >	aWeightImage,
		ConstAlias< PowerSeparableMetric >	aMetric
	)

inline

Constructor in the non-periodic case.

See documentation of PowerMap constructor.

Definition at line 142 of file ReverseDistanceTransformation.h.

                                                                            :
       PowerMap<TWeightImage,TPSeparableMetric,TImageContainer>(aDomain,
                                                                aWeightImage,
                                                                aMetric)
     {}

◆ ReverseDistanceTransformation() [2/3]

DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >::ReverseDistanceTransformation	(	ConstAlias< Domain >	aDomain,
		ConstAlias< WeightImage >	aWeightImage,
		ConstAlias< PowerSeparableMetric >	aMetric,
		typename Parent::PeriodicitySpec const &	aPeriodicitySpec
	)

inline

Constructor with periodicity specification.

See documentation of PowerMap constructor.

Definition at line 155 of file ReverseDistanceTransformation.h.

       : PowerMap<TWeightImage,TPSeparableMetric,TImageContainer>(aDomain,
                                                                  aWeightImage,
                                                                  aMetric,
                                                                  aPeriodicitySpec)
     {}

◆ ~ReverseDistanceTransformation()

DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >::~ReverseDistanceTransformation ( )

inline

Default destructor

Definition at line 168 of file ReverseDistanceTransformation.h.

168 {};

◆ ReverseDistanceTransformation() [3/3]

DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >::ReverseDistanceTransformation ( )

protected

Default Constructor.

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT()

DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >::BOOST_CONCEPT_ASSERT ( (concepts::CImage< ImageContainer >) )

◆ constRange()

ConstRange DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >::constRange ( ) const

inline

Returns a const range on the ReverseDistanceMap values.

Returns: a const range

Definition at line 186 of file ReverseDistanceTransformation.h.

     {
       return ConstRange(*this);
     }

◆ domain()

const Domain& DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >::domain ( ) const

inline

Returns a const range on the ReverseDistanceMap values.

Returns: a const range

Definition at line 177 of file ReverseDistanceTransformation.h.

     {
       return Parent::domain();
     }

References DGtal::PowerMap< TWeightImage, TPowerSeparableMetric, TImageContainer >::domain().

◆ getPowerVector()

Vector DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >::getPowerVector ( const Point & aPoint ) const

inline

Access to a ReverseDistanceMap value (a.k.a. the norm of the associated Voronoi vector) at a point.

Parameters

aPoint the point to probe.

Definition at line 210 of file ReverseDistanceTransformation.h.

     {
       return this->myImagePtr->operator()(aPoint);
     }

References aPoint(), and DGtal::PowerMap< TWeightImage, TPSeparableMetric, ImageContainerBySTLVector< HyperRectDomain< typename TWeightImage::Domain::Space >, typename TWeightImage::Domain::Space::Vector > >::myImagePtr.

◆ metricPtr()

const PowerSeparableMetric* DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >::metricPtr ( ) const

inline

Returns: Returns the underlying metric.

Definition at line 218 of file ReverseDistanceTransformation.h.

     {
       return Parent::metricPtr();
     }

References DGtal::PowerMap< TWeightImage, TPowerSeparableMetric, TImageContainer >::metricPtr().

◆ operator()()

Value DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >::operator() ( const Point & aPoint ) const

inline

Access to a ReverseDistanceMap value (a.k.a. the norm of the associated Power vector) at a point.

Parameters

aPoint the point to probe.

Definition at line 197 of file ReverseDistanceTransformation.h.

     {
       return this->myMetricPtr->powerDistance(aPoint,
                                               this->myImagePtr->operator()(aPoint),
                                               this->myWeightImagePtr->operator()( this->myImagePtr->operator()(aPoint)));
     }

References aPoint(), DGtal::PowerMap< TWeightImage, TPSeparableMetric, ImageContainerBySTLVector< HyperRectDomain< typename TWeightImage::Domain::Space >, typename TWeightImage::Domain::Space::Vector > >::myImagePtr, and DGtal::PowerMap< TWeightImage, TPSeparableMetric, ImageContainerBySTLVector< HyperRectDomain< typename TWeightImage::Domain::Space >, typename TWeightImage::Domain::Space::Vector > >::myMetricPtr.

◆ selfDisplay()

void DGtal::ReverseDistanceTransformation< TWeightImage, TPSeparableMetric, TImageContainer >::selfDisplay ( std::ostream & out ) const

inline

Self Display method.

Parameters

out	output stream

Definition at line 228 of file ReverseDistanceTransformation.h.

     {
       out << "[ReverseDistanceTransformation] underlying PowerMap={";
       Parent::selfDisplay(out);
       out << "}";
     }

References DGtal::PowerMap< TWeightImage, TPowerSeparableMetric, TImageContainer >::selfDisplay().

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

ReverseDistanceTransformation.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ ConstRange

◆ Domain

◆ ImageContainer

◆ Parent

◆ Point

◆ PowerSeparableMetric

◆ Self

◆ Value

◆ Vector

◆ Weight

◆ WeightImage

Constructor & Destructor Documentation

◆ ReverseDistanceTransformation() [1/3]

◆ ReverseDistanceTransformation() [2/3]

◆ ~ReverseDistanceTransformation()

◆ ReverseDistanceTransformation() [3/3]

Member Function Documentation

◆ BOOST_CONCEPT_ASSERT()

◆ constRange()

◆ domain()

◆ getPowerVector()

◆ metricPtr()

◆ operator()()

◆ selfDisplay()