#include <DGtal/images/ImageContainerBySTLVector.h>
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
-
- See also
- testImage.cpp
-
testImageContainerBenchmark.cpp
- Examples
- dec/exampleDECSurface.cpp, examples/tutorial-examples/polyhedralizer.cpp, geometry/curves/exampleGridCurve3d-2.cpp, geometry/surfaces/greedy-plane-segmentation-ex2.cpp, geometry/surfaces/greedy-plane-segmentation.cpp, geometry/volumes/distance/distancetransform2D.cpp, geometry/volumes/distance/distancetransform3D.cpp, geometry/volumes/distance/exampleFMM3D.cpp, geometry/volumes/distance/toricdomainvolumetric.cpp, geometry/volumes/fullConvexityLUT2D.cpp, geometry/volumes/fullConvexityThinning3D.cpp, graph/volDistanceTraversal.cpp, images/exampleConstImageAdapter.cpp, images/exampleImageFactoryFromHDF5.cpp, images/exampleTiledImage.cpp, images/extract2DImagesFrom3D.cpp, images/extract2DImagesFrom3DandVisu.cpp, images/extract2DSlicesImagesFrom3D.cpp, images/imageBasicSubsampling.cpp, images/raw2HDF5.cpp, io/digitalSetFromVol.cpp, io/display3DToOFF.cpp, io/viewers/viewer3D-8-2DSliceImages.cpp, io/viewers/viewer3D-8bis-2Dimages.cpp, io/viewers/viewer3D-9-3Dimages.cpp, shapes/viewMarchingCubes.cpp, shapes/viewPolygonalMarchingCubes.cpp, topology/3dBorderExtractionImg.cpp, topology/ctopo-2-3d.cpp, topology/ctopo-2.cpp, topology/digitalSurfaceSlice.cpp, topology/frontierAndBoundary.cpp, topology/volBreadthFirstTraversal.cpp, topology/volMarchingCubes.cpp, topology/volScanBoundary.cpp, topology/volToOFF.cpp, topology/volTrackBoundary.cpp, tutorial-examples/2DSliceImageFromVol.cpp, tutorial-examples/FMMErosion.cpp, tutorial-examples/freemanChainFromImage.cpp, tutorial-examples/polyhedralizer.cpp, and tutorial-examples/volDTGranulo.cpp.
Definition at line 126 of file ImageContainerBySTLVector.h.
◆ ConstIterator
template<typename TDomain , typename TValue >
◆ ConstRange
template<typename TDomain , typename TValue >
◆ ConstReverseIterator
template<typename TDomain , typename TValue >
◆ Container
template<typename TDomain , typename TValue >
◆ Difference
template<typename TDomain , typename TValue >
◆ Dimension
template<typename TDomain , typename TValue >
◆ Domain
template<typename TDomain , typename TValue >
◆ Integer
template<typename TDomain , typename TValue >
◆ Iterator
template<typename TDomain , typename TValue >
◆ OutputIterator
template<typename TDomain , typename TValue >
◆ Parent
template<typename TDomain , typename TValue >
◆ Point
template<typename TDomain , typename TValue >
◆ Range
template<typename TDomain , typename TValue >
◆ ReverseIterator
template<typename TDomain , typename TValue >
◆ ReverseOutputIterator
template<typename TDomain , typename TValue >
◆ Self
template<typename TDomain , typename TValue >
◆ Size
template<typename TDomain , typename TValue >
◆ Value
template<typename TDomain , typename TValue >
◆ Vector
template<typename TDomain , typename TValue >
◆ Vertex
template<typename TDomain , typename TValue >
◆ ImageContainerBySTLVector() [1/2]
template<typename TDomain , typename TValue >
Constructor from a Domain
- Parameters
-
◆ ImageContainerBySTLVector() [2/2]
template<typename TDomain , typename TValue >
Copy constructor
- Parameters
-
◆ ~ImageContainerBySTLVector()
template<typename TDomain , typename TValue >
◆ BOOST_CONCEPT_ASSERT() [1/2]
template<typename TDomain , typename TValue >
◆ BOOST_CONCEPT_ASSERT() [2/2]
template<typename TDomain , typename TValue >
◆ BOOST_STATIC_ASSERT()
template<typename TDomain , typename TValue >
domain should be rectangular
◆ BOOST_STATIC_CONSTANT()
template<typename TDomain , typename TValue >
◆ className()
template<typename TDomain , typename TValue >
- Returns
- the style name used for drawing this object.
◆ constRange()
template<typename TDomain , typename TValue >
- Returns
- the range providing begin and end iterators to scan the values of image.
Referenced by DGtal::Image< TImageContainer >::constRange(), DGtal::PowerMap< TWeightImage, TPSeparableMetric, ImageContainerBySTLVector< HyperRectDomain< typename TWeightImage::Domain::Space >, typename TWeightImage::Domain::Space::Vector > >::constRange(), DGtal::VoronoiMap< TSpace, TPointPredicate, TSeparableMetric, ImageContainerBySTLVector< HyperRectDomain< TSpace >, typename TSpace::Vector > >::constRange(), and DGtal::VoronoiMapComplete< TSpace, TPointPredicate, TSeparableMetric, TImageContainer >::constRange().
◆ container() [1/2]
template<typename TDomain , typename TValue >
Give access to the underlying container.
- Returns
- a (might be const) reference to the container.
Definition at line 298 of file ImageContainerBySTLVector.h.
298 {
return static_cast<Parent>(*this); };
◆ container() [2/2]
template<typename TDomain , typename TValue >
Give access to the underlying container.
- Returns
- a (might be const) reference to the container.
Definition at line 293 of file ImageContainerBySTLVector.h.
293 {
return static_cast<Parent>(*this); };
◆ domain()
template<typename TDomain , typename TValue >
- Returns
- the domain associated to the image.
Referenced by cmpTranslatedFFT(), DGtal::ImageFactoryFromImage< TImageContainer >::domain(), DGtal::Image< TImageContainer >::domain(), DGtal::ImageFactoryFromImage< TImageContainer >::flushImage(), DGtal::ImageFactoryFromHDF5< TImageContainer >::flushImage(), DGtal::Shortcuts< TKSpace >::getKSpace(), DGtal::Shortcuts< TKSpace >::makeBinaryImage(), DGtal::Shortcuts< TKSpace >::makeGrayScaleImage(), DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::operator()(), DGtal::ImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV, TFunctorVm1 >::operator()(), DGtal::ImageFactoryFromImage< TImageContainer >::requestImage(), testFFTScaling(), and testForwardBackwardFFT().
◆ extent()
template<typename TDomain , typename TValue >
◆ getValue()
template<typename TDomain , typename TValue >
◆ isValid()
template<typename TDomain , typename TValue >
- Returns
- the validity of the Image
Referenced by DGtal::ImageFactoryFromImage< TImageContainer >::isValid(), DGtal::ConstImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV >::isValid(), DGtal::Image< TImageContainer >::isValid(), and DGtal::ImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV, TFunctorVm1 >::isValid().
◆ linearized()
template<typename TDomain , typename TValue >
◆ operator()()
template<typename TDomain , typename TValue >
Get the value of an image at a given position given by a Point.
- Precondition
- the point must be in the domain
- Parameters
-
- Returns
- the value at aPoint.
◆ operator=()
template<typename TDomain , typename TValue >
Assignment operator
- Parameters
-
- Returns
- a reference on *this
◆ range()
template<typename TDomain , typename TValue >
◆ selfDisplay()
template<typename TDomain , typename TValue >
Writes/Displays the object on an output stream.
- Parameters
-
out | the output stream where the object is written. |
◆ setValue() [1/2]
template<typename TDomain , typename TValue >
Set a value on an Image at a position specified by a Point.
- Precondition
it
must be a point in the image domain.
- Parameters
-
aPoint | the point. |
aValue | the value. |
- Examples
- geometry/volumes/fullConvexityThinning3D.cpp.
Referenced by brut_force_voronoi_map_complete(), DGtal::ImageFactoryFromImage< TImageContainer >::flushImage(), DGtal::ReducedMedialAxis< TPowerMap, TImageContainer >::getReducedMedialAxisFromPowerMap(), main(), DGtal::ImageFactoryFromImage< TImageContainer >::requestImage(), DGtal::ImageFactoryFromHDF5< TImageContainer >::requestImage(), DGtal::Image< TImageContainer >::setValue(), and DGtal::ImageAdapter< TImageContainer, TNewDomain, TFunctorD, TNewValue, TFunctorV, TFunctorVm1 >::setValue().
◆ setValue() [2/2]
template<typename TDomain , typename TValue >
◆ spanBegin()
template<typename TDomain , typename TValue >
◆ spanEnd()
template<typename TDomain , typename TValue >
Create an end() SpanIterator at a given position in a given direction.
- Parameters
-
aPoint | a point belonging to the current image dimension (not necessarily the point used in the span_begin() method. |
aDimension | the dimension on which the iterator iterates. |
- Returns
- a SpanIterator
Definition at line 504 of file ImageContainerBySTLVector.h.
507 tmp[ aDimension ] =
myDomain.upperBound() [ aDimension ] + 1;
508 return SpanIterator ( tmp, aDimension,
this );
◆ translateDomain()
template<typename TDomain , typename TValue >
Translate the underlying domain by aShift
- Parameters
-
◆ myDomain
template<typename TDomain , typename TValue >
◆ myExtent
template<typename TDomain , typename TValue >
The documentation for this class was generated from the following file: