Public Types | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes

DGtal::DigitalSetDomain< TDigitalSet > Class Template Reference

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

#include <DigitalSetDomain.h>

Inheritance diagram for DGtal::DigitalSetDomain< TDigitalSet >:
Inheritance graph
[legend]
Collaboration diagram for DGtal::DigitalSetDomain< TDigitalSet >:
Collaboration graph
[legend]

Public Types

typedef TDigitalSet DigitalSet
typedef DigitalSet::DomainType Domain
typedef Domain::Space Space
typedef Domain::Integer Integer
typedef Domain::Point Point
typedef Domain::Vector Vector
typedef Domain::Size Size
typedef Domain::Dimension Dimension
typedef DigitalSet::ConstIterator ConstIterator
typedef SetPredicate< DigitalSetPredicate

Public Member Functions

 ~DigitalSetDomain ()
 DigitalSetDomain (const DigitalSet &aSet)
 DigitalSetDomain (const DigitalSetDomain &other)
ConstIterator begin () const
ConstIterator end () const
const PointlowerBound () const
const PointupperBound () const
bool isInside (const Point &p) const
const Predicatepredicate () const
void selfDisplay (std::ostream &out) const
bool isValid () const

Protected Member Functions

 DigitalSetDomain ()

Private Member Functions

DigitalSetDomainoperator= (const DigitalSetDomain &other)

Private Attributes

const DigitalSetmySet
Point myUpperBound
Point myLowerBound
Predicate myPredicate

Detailed Description

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

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

Description of template class 'DigitalSetDomain'


Member Typedef Documentation

template<typename TDigitalSet>
typedef DigitalSet::ConstIterator DGtal::DigitalSetDomain< TDigitalSet >::ConstIterator
template<typename TDigitalSet>
typedef TDigitalSet DGtal::DigitalSetDomain< TDigitalSet >::DigitalSet
template<typename TDigitalSet>
typedef Domain::Dimension DGtal::DigitalSetDomain< TDigitalSet >::Dimension
template<typename TDigitalSet>
typedef DigitalSet::DomainType DGtal::DigitalSetDomain< TDigitalSet >::Domain
template<typename TDigitalSet>
typedef Domain::Integer DGtal::DigitalSetDomain< TDigitalSet >::Integer
template<typename TDigitalSet>
typedef Domain::Point DGtal::DigitalSetDomain< TDigitalSet >::Point
template<typename TDigitalSet>
typedef SetPredicate<DigitalSet> DGtal::DigitalSetDomain< TDigitalSet >::Predicate
template<typename TDigitalSet>
typedef Domain::Size DGtal::DigitalSetDomain< TDigitalSet >::Size
template<typename TDigitalSet>
typedef Domain::Space DGtal::DigitalSetDomain< TDigitalSet >::Space
template<typename TDigitalSet>
typedef Domain::Vector DGtal::DigitalSetDomain< TDigitalSet >::Vector

Constructor & Destructor Documentation

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

Destructor.

template<typename TDigitalSet>
DGtal::DigitalSetDomain< TDigitalSet >::DigitalSetDomain ( const DigitalSet aSet  ) 

Coonstructor from set.

Parameters:
aSet the digital set.
template<typename TDigitalSet>
DGtal::DigitalSetDomain< TDigitalSet >::DigitalSetDomain ( const DigitalSetDomain< TDigitalSet > &  other  ) 

Copy constructor.

Parameters:
other the object to clone.
template<typename TDigitalSet>
DGtal::DigitalSetDomain< TDigitalSet >::DigitalSetDomain (  )  [protected]

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


Member Function Documentation

template<typename TDigitalSet>
ConstIterator DGtal::DigitalSetDomain< TDigitalSet >::begin (  )  const
Returns:
an iterator on the first element of the domain.
template<typename TDigitalSet>
ConstIterator DGtal::DigitalSetDomain< TDigitalSet >::end (  )  const
Returns:
an iterator on the element after the last of the domain.
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.
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.
template<typename TDigitalSet>
const Point& DGtal::DigitalSetDomain< TDigitalSet >::lowerBound (  )  const

Returns the lowest point of the space diagonal.

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.
template<typename TDigitalSet>
const Predicate& DGtal::DigitalSetDomain< TDigitalSet >::predicate (  )  const
Returns:
a const reference to the "IsInside" predicate.
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.
template<typename TDigitalSet>
const Point& DGtal::DigitalSetDomain< TDigitalSet >::upperBound (  )  const

Returns the highest point of the space diagonal.


Field Documentation

template<typename TDigitalSet>
Point DGtal::DigitalSetDomain< TDigitalSet >::myLowerBound [private]

lower bound of the bounding box.

template<typename TDigitalSet>
Predicate DGtal::DigitalSetDomain< TDigitalSet >::myPredicate [private]

The "IsInside" predicate.

template<typename TDigitalSet>
const DigitalSet& DGtal::DigitalSetDomain< TDigitalSet >::mySet [private]

The set describing the points of the domain.

template<typename TDigitalSet>
Point DGtal::DigitalSetDomain< TDigitalSet >::myUpperBound [private]

upper bound of the bounding box.


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