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

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

Aim: More...

#include <ImageContainerByVTKImageData.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

Public Member Functions

 BOOST_CONCEPT_ASSERT ((CValueType< TValueType >))
 BOOST_CONCEPT_ASSERT ((CDomain< TDomain >))
 BOOST_STATIC_ASSERT (staticDimension==3)
 ImageContainerByVTKImageData (const Point &aPointA, const Point &aPointB)
 ~ImageContainerByVTKImageData ()
ValueType operator() (const Point &aPoint) const
void setValue (const Point &aPoint, const ValueType &aValue)
void selfDisplay (std::ostream &out) const
bool isValid () const

Static Public Attributes

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

Protected Member Functions

 ImageContainerByVTKImageData ()

Private Member Functions

 ImageContainerByVTKImageData (const ImageContainerByVTKImageData &other)
ImageContainerByVTKImageDataoperator= (const ImageContainerByVTKImageData &other)

Private Attributes

Point myLowerBound
Point myUpperBound
vtkImageData * myVTKImage

Detailed Description

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

Aim:

Description of template class 'ImageContainerByVTKImageData'


Member Typedef Documentation

template<typename TDomain , typename TValueType >
typedef Domain::Dimension DGtal::experimental::ImageContainerByVTKImageData< TDomain, TValueType >::Dimension
template<typename TDomain , typename TValueType >
typedef TDomain DGtal::experimental::ImageContainerByVTKImageData< TDomain, TValueType >::Domain
template<typename TDomain , typename TValueType >
typedef Domain::Integer DGtal::experimental::ImageContainerByVTKImageData< TDomain, TValueType >::Integer
template<typename TDomain , typename TValueType >
typedef Domain::Point DGtal::experimental::ImageContainerByVTKImageData< TDomain, TValueType >::Point
Todo:
IMPORTANT : Size must be int-compatible (see operator()(Point))
template<typename TDomain , typename TValueType >
typedef Domain::Size DGtal::experimental::ImageContainerByVTKImageData< TDomain, TValueType >::Size
template<typename TDomain , typename TValueType >
typedef TValueType DGtal::experimental::ImageContainerByVTKImageData< TDomain, TValueType >::ValueType
template<typename TDomain , typename TValueType >
typedef Domain::Vector DGtal::experimental::ImageContainerByVTKImageData< TDomain, TValueType >::Vector

Constructor & Destructor Documentation

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

Constructor.

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

Destructor.

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

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

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

Copy constructor.

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

Member Function Documentation

template<typename TDomain , typename TValueType >
DGtal::experimental::ImageContainerByVTKImageData< TDomain, TValueType >::BOOST_CONCEPT_ASSERT ( (CValueType< TValueType >)   ) 
template<typename TDomain , typename TValueType >
DGtal::experimental::ImageContainerByVTKImageData< TDomain, TValueType >::BOOST_CONCEPT_ASSERT ( (CDomain< TDomain >)   ) 
template<typename TDomain , typename TValueType >
DGtal::experimental::ImageContainerByVTKImageData< TDomain, TValueType >::BOOST_STATIC_ASSERT ( staticDimension  = =3  ) 

Only defined for 3D images.

template<typename TDomain , typename TValueType >
bool DGtal::experimental::ImageContainerByVTKImageData< 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::ImageContainerByVTKImageData< 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 >
ImageContainerByVTKImageData& DGtal::experimental::ImageContainerByVTKImageData< TDomain, TValueType >::operator= ( const ImageContainerByVTKImageData< 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::ImageContainerByVTKImageData< 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::ImageContainerByVTKImageData< 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 >
Point DGtal::experimental::ImageContainerByVTKImageData< TDomain, TValueType >::myLowerBound [private]
template<typename TDomain , typename TValueType >
Point DGtal::experimental::ImageContainerByVTKImageData< TDomain, TValueType >::myUpperBound [private]
template<typename TDomain , typename TValueType >
vtkImageData* DGtal::experimental::ImageContainerByVTKImageData< TDomain, TValueType >::myVTKImage [private]
template<typename TDomain , typename TValueType >
const Domain::Dimension DGtal::experimental::ImageContainerByVTKImageData< TDomain, TValueType >::staticDimension = Domain::staticDimension [static]

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