irtkGenericImage< VoxelType > Class Template Reference

#include <irtkGenericImage.h>

Inheritance diagram for irtkGenericImage< VoxelType >:

Inheritance graph
[legend]
Collaboration diagram for irtkGenericImage< VoxelType >:

Collaboration graph
[legend]

List of all members.


Detailed Description

template<class VoxelType>
class irtkGenericImage< VoxelType >

Generic class for 2D or 3D images.

This class implements generic 2D and 3D images. It provides functions for accessing, reading, writing and manipulating images. This class can be used for images with arbitrary voxel types using templates.

Definition at line 31 of file irtkGenericImage.h.


Public Member Functions

 irtkGenericImage ()
 Default constructor.
 irtkGenericImage (char *)
 Constructor from image file.
 irtkGenericImage (int, int, int, int=1)
 Constructor for given image size.
 irtkGenericImage (const irtkGenericImage &)
 Copy constructor for image.
 irtkGenericImage (const irtkImageAttributes &)
 Constructor for given image attributes.
template<class T>
 irtkGenericImage (const irtkGenericImage< T > &)
 Copy constructor for image of different type.
 ~irtkGenericImage (void)
 Destructor.
void Initialize (const irtkImageAttributes &)
 Initialize an image.
void Read (const char *)
 Read image from file.
void Write (const char *)
 Write image to file.
void GetMinMax (VoxelType *, VoxelType *) const
 Minimum and maximum pixel values get accessor.
void GetMinMaxPad (VoxelType *, VoxelType *, VoxelType) const
 Minimum and maximum pixel values get accessor with padding.
void PutMinMax (VoxelType, VoxelType)
 Minimum and maximum pixel values put accessor.
VoxelType * GetPointerToVoxels (int=0, int=0, int=0, int=0) const
 Function for pixel access via pointers.
int VoxelToIndex (int, int, int, int=0) const
 Funnction to convert pixel to index.
VoxelType Get (int, int, int, int=0) const
 Function for pixel get access.
void Put (int, int, int, VoxelType)
 Function for pixel put access.
void Put (int, int, int, int, VoxelType)
 Function for pixel put access.
VoxelType & operator() (int, int, int, int=0)
 Function for pixel access from via operators.
irtkGenericImage GetRegion (int z, int t) const
 Function for image slice get access.
irtkGenericImage GetRegion (int x1, int y1, int z1, int x2, int y2, int z2) const
 Function for image slice get access in certain region.
irtkGenericImage GetRegion (int x1, int y1, int z1, int t1, int x2, int y2, int z2, int t2) const
 Function for image slice get access in certain region.
irtkGenericImage GetFrame (int t) const
 Function for image frame get access.
irtkGenericImage< VoxelType > & operator= (const irtkGenericImage &)
 Copy operator for image.
template<class T>
irtkGenericImage< VoxelType > & operator= (const irtkGenericImage< T > &)
 Copy operator for image.
irtkGenericImage operator+ (const irtkGenericImage &)
 Addition operator.
irtkGenericImageoperator+= (const irtkGenericImage &)
 Addition operator (stores result).
irtkGenericImage operator- (const irtkGenericImage &)
 Subtraction operator.
irtkGenericImageoperator-= (const irtkGenericImage &)
 Subtraction operator (stores result).
irtkGenericImage operator * (const irtkGenericImage &)
 Multiplication operator.
irtkGenericImageoperator *= (const irtkGenericImage &)
 Multiplication operator (stores result).
irtkGenericImage operator/ (const irtkGenericImage &)
 Division operator.
irtkGenericImageoperator/= (const irtkGenericImage &)
 Division operator (stores result).
irtkGenericImage operator+ (VoxelType)
 Addition operator for type.
irtkGenericImageoperator+= (VoxelType)
 Addition operator for type (stores result).
irtkGenericImage operator- (VoxelType)
 Subtraction operator for type.
irtkGenericImageoperator-= (VoxelType)
 Subtraction operator for type (stores result).
irtkGenericImage operator * (VoxelType)
 Multiplication operator for type.
irtkGenericImageoperator *= (VoxelType)
 Multiplication operator for type (stores result).
irtkGenericImage operator/ (VoxelType)
 Division operator for type.
irtkGenericImageoperator/= (VoxelType)
 Division operator for type (stores result).
irtkGenericImage operator> (VoxelType)
 Threshold operator > (sets all values > given value to that value).
irtkGenericImageoperator>= (VoxelType)
 Threshold operator >= (sets all values >= given value to that value).
irtkGenericImage operator< (VoxelType)
 Threshold operator < (sets all values < given value to that value).
irtkGenericImageoperator<= (VoxelType)
 Threshold operator <= (sets all values <= given value to that value).
Bool operator== (const irtkGenericImage &)
 Comparison operators == (explicit negation yields != operator).
void ReflectX ()
 Comparison operator != (if _HAS_STL is defined, negate == operator) Bool operator!=(const irtkGenericImage &);.
void ReflectY ()
 Reflect image around y.
void ReflectZ ()
 Reflect image around z.
void FlipXY ()
 Flip x and y axis.
void FlipXZ ()
 Flip x and z axis.
void FlipYZ ()
 Flip y and z axis.
void FlipXT ()
 Flip x and t axis.
void FlipYT ()
 Flip y and t axis.
void FlipZT ()
 Flip z and t axis.
int ImageToVTKScalarType ()
 Return the VTK scalar image type of an IRTK image.
void ImageToVTK (vtkStructuredPoints *)
 Conversion to VTK structured points.
void VTKToImage (vtkStructuredPoints *)
 Conversion from VTK structured points.
double GetAsDouble (int, int, int, int=0) const
 Function for pixel get access as double.
void PutAsDouble (int, int, int, double)
 Function for pixel put access.
void PutAsDouble (int, int, int, int, double)
 Function for pixel put access.
const char * NameOfClass ()
 Returns the name of the image class.
void * GetScalarPointer (int=0, int=0, int=0, int=0) const
 Function for pixel access via pointers.
virtual int GetScalarType () const
 Function which returns pixel scalar type.
virtual double GetScalarTypeMin () const
 Function which returns the minimum value the pixel can hold without overflowing.
virtual double GetScalarTypeMax () const
 Function which returns the minimum value the pixel can hold without overflowing.
template<>
int GetScalarType () const
 Function which returns pixel scalar type.
template<>
int GetScalarType () const
 Function which returns pixel scalar type.
template<>
int GetScalarType () const
 Function which returns pixel scalar type.
template<>
int GetScalarType () const
 Function which returns pixel scalar type.
template<>
int GetScalarType () const
 Function which returns pixel scalar type.

Protected Attributes

VoxelType **** _matrix
 Pointer to image data.

Member Function Documentation

template<class VoxelType>
void irtkGenericImage< VoxelType >::ReflectX (  )  [virtual]

Comparison operator != (if _HAS_STL is defined, negate == operator) Bool operator!=(const irtkGenericImage &);.

Reflect image around x

Implements irtkBaseImage.


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