irtkBaseImage Class Reference

#include <irtkBaseImage.h>

Inheritance diagram for irtkBaseImage:

Inheritance graph
[legend]
Collaboration diagram for irtkBaseImage:

Collaboration graph
[legend]

List of all members.


Detailed Description

Abstract generic class for 2D or 3D images.

This abstract base class provides generic support for 2D and 3D image classes. It provides functions for accessing image dimension and origin as well as voxel dimensions. It also provides functions for conversion between image and world coordinates.

Definition at line 28 of file irtkBaseImage.h.


Public Member Functions

virtual ~irtkBaseImage ()
 Destructor.
virtual int GetX () const
 Returns the number of voxels in the x-direction.
virtual int GetY () const
 Returns the number of voxels in the y-direction.
virtual int GetZ () const
 Returns the number of voxels in the z-direction.
virtual int GetT () const
 Returns the number of voxels in the t-direction.
virtual int GetNumberOfVoxels () const
 Returns the total number of voxels.
virtual irtkImageAttributes GetImageAttributes () const
 Gets the image attributes.
virtual void PutImageAttributes (const irtkImageAttributes &)
 Sets the image attributes.
virtual double GetXSize () const
 Returns the number of voxels in the x-direction.
virtual double GetYSize () const
 Returns the number of voxels in the y-direction.
virtual double GetZSize () const
 Returns the number of voxels in the z-direction.
virtual double GetTSize () const
 Returns the number of voxels in the t-direction.
virtual void GetPixelSize (double *, double *, double *) const
 Voxel dimensions get access.
virtual void GetPixelSize (double *, double *, double *, double *) const
 Voxel dimensions get access.
virtual void PutPixelSize (double, double, double)
 Voxel dimensions put access.
virtual void PutPixelSize (double, double, double, double)
 Voxel dimensions put access.
virtual irtkPoint GetOrigin () const
 Image origin get access.
virtual void GetOrigin (double &, double &, double &) const
 Image origin get access.
virtual void GetOrigin (double &, double &, double &, double &) const
 Image origin get access.
virtual void PutOrigin (const irtkPoint &)
 Image origin put access.
virtual void PutOrigin (double, double, double)
 Image origin put access.
virtual void PutOrigin (double, double, double, double)
 Image origin put access.
virtual void PutOrientation (double *, double *, double *)
 Put image x- and y-axis and z-axis.
virtual void GetOrientation (double *, double *, double *) const
 Get image x- and y-axis and z-axis.
virtual void Orientation (int &, int &, int &) const
 Get orientation of axis relative to patient.
virtual void ImageToWorld (irtkPoint &) const
 Image to world coordinate conversion with a given point.
virtual void WorldToImage (irtkPoint &) const
 World to image coordinate conversion with a given point.
virtual void ImageToWorld (double &, double &, double &) const
 Image to world coordinate conversion with three doubles.
virtual void WorldToImage (double &, double &, double &) const
 World to image coordinate conversion with three doubles.
virtual irtkMatrix GetImageToWorldMatrix () const
 Return transformation matrix for image to world coordinates.
virtual irtkMatrix GetWorldToImageMatrix () const
 Return transformation matrix for world to image coordinates.
virtual double ImageToTime (double) const
 Image to time coordinate conversion.
virtual double TimeToImage (double) const
 Time to image coordinate conversion.
virtual int IsInFOV (double, double, double)
 Returns true if point is within the field of view of image.
virtual Bool IsEmpty () const
 Boolean operation for empty.
virtual void GetMinMaxAsDouble (double *, double *) const
 Minimum and maximum pixel values get accessor.
virtual void PutMinMaxAsDouble (double, double)
 Minimum and maximum pixel values put accessor.
virtual double GetAsDouble (int, int, int, int=0) const =0
 Function for pixel get access as double.
virtual void PutAsDouble (int, int, int, double)=0
 Function for pixel put access.
virtual void PutAsDouble (int, int, int, int, double)=0
 Function for pixel put access.
virtual const char * NameOfClass ()=0
 Returns the name of the image class.
virtual void * GetScalarPointer (int=0, int=0, int=0, int=0) const =0
 Function for pixel access via pointers.
virtual int GetScalarType () const =0
 Function which returns pixel scalar type.
virtual double GetScalarTypeMin () const =0
 Function which returns the minimum value the pixel can hold without overflowing.
virtual double GetScalarTypeMax () const =0
 Function which returns the minimum value the pixel can hold without overflowing.
virtual void ReflectX ()=0
 Reflect image around x.
virtual void ReflectY ()=0
 Reflect image around y.
virtual void ReflectZ ()=0
 Reflect image around z.
virtual void FlipXY ()=0
 Flip x and y axis.
virtual void FlipXZ ()=0
 Flip x and z axis.
virtual void FlipYZ ()=0
 Flip y and z axis.
virtual void FlipXT ()=0
 Flip x and t axis.
virtual void FlipYT ()=0
 Flip y and t axis.
virtual void FlipZT ()=0
 Flip z and t axis.
virtual void Write (const char *)=0
 Write file.
virtual void Print ()
 Print function.

Static Public Member Functions

static irtkBaseImageNew (const char *)
 Read file and construct image.

Protected Member Functions

 irtkBaseImage ()
 Constructor for empty image.
 irtkBaseImage (const irtkImageAttributes &)
 Constructor for image with certain image attributes.
 irtkBaseImage (const irtkBaseImage &)
 Copy constructor.
void Initialize (const irtkImageAttributes &)
 Initialize baseimage.
void UpdateMatrix ()
 Update transformation matrix.

Protected Attributes

irtkImageAttributes _attr
 Attributes of the imaging geometry;.
irtkMatrix _matI2W
 Transformation matrix from image coordinates to world coordinates.
irtkMatrix _matW2I
 Transformation matrix from world coordinates to image coordinates.

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