Aim: Constructs a domain limited to the given digital set. More...

#include <DGtal/kernel/sets/DigitalSetDomain.h>

Inheritance diagram for DGtal::DigitalSetDomain< TDigitalSet >:

Public Types
typedef TDigitalSet	DigitalSet
typedef DigitalSet::Domain	Domain
typedef Domain::Space	Space
typedef Domain::Integer	Integer
typedef NumberTraits< Integer >::IsBounded	IsBounded
typedef Domain::Point	Point
typedef Domain::Vector	Vector
typedef Domain::Size	Size
typedef Domain::Dimension	Dimension
typedef DigitalSet::ConstIterator	ConstIterator
typedef DigitalSet	Predicate

Public Member Functions
	~DigitalSetDomain ()
	DigitalSetDomain (ConstAlias< DigitalSet > aSet)
	DigitalSetDomain (const DigitalSetDomain &other)
ConstIterator	begin (const Point &aPoint) const
ConstIterator	begin () const
ConstIterator	end () const
const Point &	lowerBound () const
const Point &	upperBound () const
Size	size () const
bool	isInside (const Point &p) const
const Predicate &	predicate () const
void	selfDisplay (std::ostream &out) const
bool	isValid () const

Protected Member Functions
	DigitalSetDomain ()

Private Member Functions
DigitalSetDomain &	operator= (const DigitalSetDomain &other)

Private Attributes
const DigitalSet *	mySet
Point	myUpperBound
Point	myLowerBound

Detailed Description

template<typename TDigitalSet>
class DGtal::DigitalSetDomain< TDigitalSet >

Aim: Constructs a domain limited to the given digital set.

Description of template class 'DigitalSetDomain'

Examples: images/exampleConstImageAdapter.cpp.

Definition at line 59 of file DigitalSetDomain.h.

Member Typedef Documentation

◆ ConstIterator

template<typename TDigitalSet>

typedef DigitalSet::ConstIterator DGtal::DigitalSetDomain< TDigitalSet >::ConstIterator

Definition at line 72 of file DigitalSetDomain.h.

◆ DigitalSet

template<typename TDigitalSet>

typedef TDigitalSet DGtal::DigitalSetDomain< TDigitalSet >::DigitalSet

Definition at line 63 of file DigitalSetDomain.h.

◆ Dimension

template<typename TDigitalSet>

typedef Domain::Dimension DGtal::DigitalSetDomain< TDigitalSet >::Dimension

Definition at line 71 of file DigitalSetDomain.h.

◆ Domain

template<typename TDigitalSet>

typedef DigitalSet::Domain DGtal::DigitalSetDomain< TDigitalSet >::Domain

Definition at line 64 of file DigitalSetDomain.h.

◆ Integer

template<typename TDigitalSet>

typedef Domain::Integer DGtal::DigitalSetDomain< TDigitalSet >::Integer

Definition at line 66 of file DigitalSetDomain.h.

◆ IsBounded

template<typename TDigitalSet>

typedef NumberTraits<Integer>::IsBounded DGtal::DigitalSetDomain< TDigitalSet >::IsBounded

Definition at line 67 of file DigitalSetDomain.h.

◆ Point

template<typename TDigitalSet>

typedef Domain::Point DGtal::DigitalSetDomain< TDigitalSet >::Point

Definition at line 68 of file DigitalSetDomain.h.

◆ Predicate

template<typename TDigitalSet>

typedef DigitalSet DGtal::DigitalSetDomain< TDigitalSet >::Predicate

Definition at line 73 of file DigitalSetDomain.h.

◆ Size

template<typename TDigitalSet>

typedef Domain::Size DGtal::DigitalSetDomain< TDigitalSet >::Size

Definition at line 70 of file DigitalSetDomain.h.

◆ Space

template<typename TDigitalSet>

typedef Domain::Space DGtal::DigitalSetDomain< TDigitalSet >::Space

Definition at line 65 of file DigitalSetDomain.h.

◆ Vector

template<typename TDigitalSet>

typedef Domain::Vector DGtal::DigitalSetDomain< TDigitalSet >::Vector

Definition at line 69 of file DigitalSetDomain.h.

Constructor & Destructor Documentation

◆ ~DigitalSetDomain()

template<typename TDigitalSet>

DGtal::DigitalSetDomain< TDigitalSet >::~DigitalSetDomain ( )

Destructor.

◆ DigitalSetDomain() [1/3]

template<typename TDigitalSet>

DGtal::DigitalSetDomain< TDigitalSet >::DigitalSetDomain ( ConstAlias< DigitalSet > aSet )

Constructor from set.

Parameters

aSet	the digital set (only aliased).

◆ DigitalSetDomain() [2/3]

template<typename TDigitalSet>

DGtal::DigitalSetDomain< TDigitalSet >::DigitalSetDomain ( const DigitalSetDomain< TDigitalSet > & other )

Copy constructor.

Parameters

other the object to clone.

◆ DigitalSetDomain() [3/3]

template<typename TDigitalSet>

DGtal::DigitalSetDomain< TDigitalSet >::DigitalSetDomain ( )

protected

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

Member Function Documentation

◆ begin() [1/2]

template<typename TDigitalSet>

ConstIterator DGtal::DigitalSetDomain< TDigitalSet >::begin ( ) const

Returns: an iterator on the first element of the domain.

◆ begin() [2/2]

template<typename TDigitalSet>

ConstIterator DGtal::DigitalSetDomain< TDigitalSet >::begin ( const Point & aPoint ) const

Returns: an iterator on a given point in the domain.

Parameters

aPoint the point to get an iterator on.

◆ end()

template<typename TDigitalSet>

ConstIterator DGtal::DigitalSetDomain< TDigitalSet >::end ( ) const

Returns: an iterator on the element after the last of the domain.

◆ isInside()

template<typename TDigitalSet>

bool DGtal::DigitalSetDomain< TDigitalSet >::isInside ( const Point & p ) const

Parameters

p	any point.

Returns: 'true' if point [p] is inside this domain.

◆ isValid()

template<typename TDigitalSet>

bool DGtal::DigitalSetDomain< TDigitalSet >::isValid ( ) const

Checks the validity/consistency of the object.

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

◆ lowerBound()

template<typename TDigitalSet>

const Point & DGtal::DigitalSetDomain< TDigitalSet >::lowerBound ( ) const

Returns the lowest point of the space diagonal.

◆ operator=()

template<typename TDigitalSet>

DigitalSetDomain & DGtal::DigitalSetDomain< TDigitalSet >::operator= ( const DigitalSetDomain< TDigitalSet > & other )

private

Assignment.

Parameters

other the object to copy.

Returns: a reference on 'this'. Forbidden by default.

◆ predicate()

template<typename TDigitalSet>

const Predicate & DGtal::DigitalSetDomain< TDigitalSet >::predicate ( ) const

Returns: a light "IsInside" predicate.

◆ selfDisplay()

template<typename TDigitalSet>

void DGtal::DigitalSetDomain< TDigitalSet >::selfDisplay ( std::ostream & out ) const

Writes/Displays the object on an output stream.

Parameters

out	the output stream where the object is written.

◆ size()

template<typename TDigitalSet>

Size DGtal::DigitalSetDomain< TDigitalSet >::size ( ) const

Returns the size.

◆ upperBound()

template<typename TDigitalSet>

const Point & DGtal::DigitalSetDomain< TDigitalSet >::upperBound ( ) const

Returns the highest point of the space diagonal.

Field Documentation

◆ myLowerBound

template<typename TDigitalSet>

Point DGtal::DigitalSetDomain< TDigitalSet >::myLowerBound

private

lower bound of the bounding box.

Definition at line 178 of file DigitalSetDomain.h.

◆ mySet

template<typename TDigitalSet>

const DigitalSet* DGtal::DigitalSetDomain< TDigitalSet >::mySet

private

The set describing the points of the domain.

Definition at line 168 of file DigitalSetDomain.h.

◆ myUpperBound

template<typename TDigitalSet>

Point DGtal::DigitalSetDomain< TDigitalSet >::myUpperBound

private

upper bound of the bounding box.

Definition at line 173 of file DigitalSetDomain.h.

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

DigitalSetDomain.h

Public Types

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ConstIterator

◆ DigitalSet

◆ Dimension

◆ Domain

◆ Integer

◆ IsBounded

◆ Point

◆ Predicate

◆ Size

◆ Space

◆ Vector

Constructor & Destructor Documentation

◆ ~DigitalSetDomain()

◆ DigitalSetDomain() [1/3]

◆ DigitalSetDomain() [2/3]

◆ DigitalSetDomain() [3/3]

Member Function Documentation

◆ begin() [1/2]

◆ begin() [2/2]

◆ end()

◆ isInside()

◆ isValid()

◆ lowerBound()

◆ operator=()

◆ predicate()

◆ selfDisplay()

◆ size()

◆ upperBound()

Field Documentation

◆ myLowerBound

◆ mySet

◆ myUpperBound