#include <ImageContainerBySTLVector.h>

Inheritance diagram for DGtal::ImageContainerBySTLVector< TDomain, TValue >:

Collaboration diagram for DGtal::ImageContainerBySTLVector< TDomain, TValue >:

Data Structures
class	SpanIterator

Public Types
typedef ImageContainerBySTLVector < TDomain, TValue >	Self
typedef TDomain	Domain
typedef Domain::Point	Point
typedef Domain::Vector	Vector
typedef Domain::Integer	Integer
typedef Domain::Size	Size
typedef Domain::Dimension	Dimension
typedef Point	Vertex
typedef TValue	Value
typedef vector< Value >::iterator	Iterator
typedef vector< Value > ::const_iterator	ConstIterator
typedef vector< Value > ::reverse_iterator	ReverseIterator
typedef vector< Value > ::const_reverse_iterator	ConstReverseIterator
typedef vector< Value > ::difference_type	Difference
typedef vector< Value >::iterator	OutputIterator
typedef vector< Value > ::reverse_iterator	ReverseOutputIterator
typedef SimpleRandomAccessConstRangeFromPoint < ConstIterator, DistanceFunctorFromPoint< Self > >	ConstRange
typedef SimpleRandomAccessRangeFromPoint < ConstIterator, Iterator, DistanceFunctorFromPoint< Self > >	Range

Public Member Functions
	BOOST_CONCEPT_ASSERT ((CDomain< TDomain >))
	BOOST_STATIC_ASSERT ((boost::is_same< Domain, HyperRectDomain< SpaceND< dimension, Integer > > >::value))
	BOOST_CONCEPT_ASSERT ((CLabel< TValue >))
	ImageContainerBySTLVector (const Domain &aDomain)
	ImageContainerBySTLVector (const ImageContainerBySTLVector &other)
ImageContainerBySTLVector &	operator= (const ImageContainerBySTLVector &other)
	~ImageContainerBySTLVector ()
Value	operator() (const Point &aPoint) const
void	setValue (const Point &aPoint, const Value &aValue)
const Domain &	domain () const
Vector	extent () const
void	translateDomain (const Vector &aShift)
void	selfDisplay (std::ostream &out) const
bool	isValid () const
std::string	className () const
ConstRange	constRange () const
Range	range ()
void	setValue (SpanIterator &it, const Value &aValue)
SpanIterator	spanBegin (const Point &aPoint, const Dimension aDimension)
SpanIterator	spanEnd (const Point &aPoint, const Dimension aDimension)
Value	getValue (SpanIterator &it)
Size	linearized (const Point &aPoint) const

Static Public Attributes
static const Domain::Dimension	dimension = Domain::dimension

Private Attributes
Domain	myDomain
Vector	myExtent

Additional Inherited Members
Data Fields inherited from std::vector< T >
T	elements

Detailed Description

template<typename TDomain, typename TValue>
class DGtal::ImageContainerBySTLVector< TDomain, TValue >

Description of class 'ImageContainerBySTLVector'

Aim: Model of CImage implementing the association Point<->Value using a STL vector as container. A linearization of domain points is used to build the STL vector index.

As a model of CImage, this class provides two ways of accessing values:

through the range of points returned by the domain() method combined with the operator() that takes a point and returns its associated value.
through the range of values returned by the range() method, which can be used to directly iterate over the values of the image

This class also provides a setValue() method and an output iterator, which is returned by the outputIterator() method for writing purposes.

Lastly, built-in iterators and a fast span iterator to perform 1D scans are also provided.

Template Parameters:

TDomain	a HyperRectDomain.
TValue	at least a model of CLabel.

See also:: testImage.cpp; testImageContainerBenchmark.cpp

Examples:: geometry/surfaces/greedy-plane-segmentation-ex2.cpp, geometry/surfaces/greedy-plane-segmentation.cpp, io/digitalSetFromVol.cpp, io/display3DToOFF.cpp, topology/3dBorderExtractionImg.cpp, topology/ctopo-2-3d.cpp, topology/ctopo-2.cpp, topology/frontierAndBoundary.cpp, topology/volScanBoundary.cpp, topology/volToOFF.cpp, topology/volTrackBoundary.cpp, and tutorial-examples/freemanChainFromImage.cpp.

Definition at line 126 of file ImageContainerBySTLVector.h.