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

DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType > Class Template Reference

Aim: More...

#include <ImageContainerByITKImage.h>

Public Types

typedef TValueType ValueType
typedef TDomain Domain
typedef Domain::Point Point
typedef Domain::Vector Vector
typedef Domain::Dimension Dimension
typedef Domain::Integer Integer
typedef Domain::Size Size
typedef itk::Image< TValueType,
staticDimension
ImageType
typedef ImageType::Pointer ImagePointer
typedef
itk::ImageRegionConstIterator
< ImageType
ConstIterator
typedef
itk::ImageRegionIterator
< ImageType
Iterator

Public Member Functions

 BOOST_CONCEPT_ASSERT ((CValueType< TValueType >))
 BOOST_CONCEPT_ASSERT ((CDomain< TDomain >))
 ImageContainerByITKImage (const Point &aPointA, const Point &aPointB)
 ~ImageContainerByITKImage ()
ValueType operator() (const Point &aPoint) const
ValueType operator() (const ConstIterator &it) const
void setValue (const Point &aPoint, const ValueType &aValue)
void selfDisplay (std::ostream &out) const
bool isValid () const
ConstIterator begin () const
ConstIterator begin (const Point &aPoint) const
const ConstIterator end () const
ConstIterator end (const Point &aPoint) const

Static Public Attributes

static const Domain::Dimension staticDimension = Domain::staticDimension

Protected Member Functions

 ImageContainerByITKImage ()

Private Member Functions

 ImageContainerByITKImage (const ImageContainerByITKImage &other)
ImageContainerByITKImageoperator= (const ImageContainerByITKImage &other)

Private Attributes

Point myLowerBound
Point myUpperBound
ImagePointer myITKImagePointer
ImageType::RegionType myRegion
ConstIterator myConstItBegin
Iterator myItBegin
ConstIterator myConstItEnd
Iterator myItEnd

Detailed Description

template<typename TDomain, typename TValueType>
class DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >

Aim:

Description of template class 'ImageContainerByITKImage'


Member Typedef Documentation

template<typename TDomain , typename TValueType >
typedef itk::ImageRegionConstIterator< ImageType > DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::ConstIterator
template<typename TDomain , typename TValueType >
typedef Domain::Dimension DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::Dimension
template<typename TDomain , typename TValueType >
typedef TDomain DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::Domain
template<typename TDomain , typename TValueType >
typedef ImageType::Pointer DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::ImagePointer
template<typename TDomain , typename TValueType >
typedef itk::Image< TValueType, staticDimension> DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::ImageType
template<typename TDomain , typename TValueType >
typedef Domain::Integer DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::Integer
template<typename TDomain , typename TValueType >
typedef itk::ImageRegionIterator< ImageType > DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::Iterator
template<typename TDomain , typename TValueType >
typedef Domain::Point DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::Point
Todo:
IMPORTANT : Size must be int-compatible (see operator()(Point))
template<typename TDomain , typename TValueType >
typedef Domain::Size DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::Size
template<typename TDomain , typename TValueType >
typedef TValueType DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::ValueType
template<typename TDomain , typename TValueType >
typedef Domain::Vector DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::Vector

Constructor & Destructor Documentation

template<typename TDomain , typename TValueType >
DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::ImageContainerByITKImage ( const Point aPointA,
const Point aPointB 
)

Constructor.

template<typename TDomain , typename TValueType >
DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::~ImageContainerByITKImage (  ) 

Destructor.

template<typename TDomain , typename TValueType >
DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::ImageContainerByITKImage (  )  [protected]

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

template<typename TDomain , typename TValueType >
DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::ImageContainerByITKImage ( const ImageContainerByITKImage< TDomain, TValueType > &  other  )  [private]

Copy constructor.

Parameters:
other the object to clone. Forbidden by default.

Member Function Documentation

template<typename TDomain , typename TValueType >
ConstIterator DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::begin (  )  const [inline]
template<typename TDomain , typename TValueType >
ConstIterator DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::begin ( const Point aPoint  )  const

begin(aPoint) iterator. Returns an iterator starting at

Parameters:
aPoint 
template<typename TDomain , typename TValueType >
DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::BOOST_CONCEPT_ASSERT ( (CValueType< TValueType >)   ) 
template<typename TDomain , typename TValueType >
DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::BOOST_CONCEPT_ASSERT ( (CDomain< TDomain >)   ) 
template<typename TDomain , typename TValueType >
ConstIterator DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::end ( const Point aPoint  )  const

end() iterator.

Returns:
a ConstIterator at the endpoint
Parameters:
aPoint 
template<typename TDomain , typename TValueType >
const ConstIterator DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::end (  )  const [inline]
template<typename TDomain , typename TValueType >
bool DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::isValid (  )  const

Checks the validity/consistency of the object.

Returns:
'true' if the object is valid, 'false' otherwise.
template<typename TDomain , typename TValueType >
ValueType DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::operator() ( const ConstIterator it  )  const

Get the value of an image at a given position.

Parameters:
aPoint position in the image.
Returns:
the value at aPoint.
template<typename TDomain , typename TValueType >
ValueType DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::operator() ( const Point aPoint  )  const

Get the value of an image at a given position.

Parameters:
aPoint position in the image.
Returns:
the value at aPoint.
template<typename TDomain , typename TValueType >
ImageContainerByITKImage& DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::operator= ( const ImageContainerByITKImage< TDomain, TValueType > &  other  )  [private]

Assignment.

Parameters:
other the object to copy.
Returns:
a reference on 'this'. Forbidden by default.
template<typename TDomain , typename TValueType >
void DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::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 TDomain , typename TValueType >
void DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::setValue ( const Point aPoint,
const ValueType aValue 
)

Set a value on an Image at aPoint.

Parameters:
aPoint location of the point to associate with aValue.
aValue the value.

Field Documentation

template<typename TDomain , typename TValueType >
ConstIterator DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::myConstItBegin [private]
template<typename TDomain , typename TValueType >
ConstIterator DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::myConstItEnd [private]
template<typename TDomain , typename TValueType >
Iterator DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::myItBegin [private]
template<typename TDomain , typename TValueType >
Iterator DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::myItEnd [private]
template<typename TDomain , typename TValueType >
ImagePointer DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::myITKImagePointer [private]
template<typename TDomain , typename TValueType >
Point DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::myLowerBound [private]
template<typename TDomain , typename TValueType >
ImageType::RegionType DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::myRegion [private]
template<typename TDomain , typename TValueType >
Point DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::myUpperBound [private]
template<typename TDomain , typename TValueType >
const Domain::Dimension DGtal::experimental::ImageContainerByITKImage< TDomain, TValueType >::staticDimension = Domain::staticDimension [static]

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