itk::ImageIOBase Class Reference

Abstract superclass defines image IO interface. More...

#include <itkImageIOBase.h>

Inheritance diagram for itk::ImageIOBase:

[legend]Collaboration diagram for itk::ImageIOBase:

[legend]List of all members.

Public Types
typedef ImageIOBase	Self
typedef LightProcessObject	Superclass
typedef SmartPointer< Self >	Pointer
enum	IODataType {   UNKNOWN, UCHAR, CHAR, USHORT,   SHORT, UINT, INT, ULONG,   LONG, FLOAT, DOUBLE, RGB,   RGBA }
enum	FileType { ASCII, Binary, TypeNotApplicable }
enum	ByteOrder { BigEndian, LittleEndian, OrderNotApplicable }
Public Methods
virtual const char *	GetClassName () const
virtual bool	SetPixelType (const std::type_info &ptype)
std::string	ReturnTypeAsString (IODataType) const
virtual unsigned int	GetPixelStride () const
unsigned int	GetImageSizeInPixels () const
unsigned int	GetImageSizeInBytes () const
unsigned int	GetImageSizeInComponents () const
virtual bool	CanReadFile (const char *)=0
virtual void	ReadImageInformation ()=0
virtual void	Read (void *buffer)=0
virtual bool	CanWriteFile (const char *)=0
virtual void	WriteImageInformation ()=0
virtual void	Write (const void *buffer)=0
virtual void	SetFileName (const char *_arg)
virtual const char *	GetFileName () const
virtual void	SetFilePrefix (const char *_arg)
virtual const char *	GetFilePrefix () const
void	SetNumberOfDimensions (unsigned int)
virtual unsigned int	GetNumberOfDimensions ()
virtual void	SetDimensions (unsigned int i, unsigned int dim)
virtual unsigned int	GetDimensions (unsigned int i) const
virtual void	SetOrigin (unsigned int i, double origin)
virtual double	GetOrigin (unsigned int i) const
virtual void	SetSpacing (unsigned int i, double spacing)
virtual double	GetSpacing (unsigned int i) const
virtual void	SetIORegion (ImageIORegion _arg)
virtual ImageIORegion	GetIORegion ()
virtual const std::type_info &	GetPixelType () const
virtual void	SetPixelType (const IODataType ctype)
virtual void	SetComponentType (IODataType _arg)
virtual IODataType	GetComponentType ()
virtual void	SetNumberOfComponents (unsigned int _arg)
virtual unsigned int	GetNumberOfComponents ()
virtual void	SetFileType (FileType _arg)
virtual FileType	GetFileType () const
void	SetFileTypeToASCII ()
void	SetFileTypeToBinary ()
virtual void	SetByteOrder (ByteOrder _arg)
virtual ByteOrder	GetByteOrder () const
void	SetByteOrderToBigEndian ()
void	SetByteOrderToLittleEndian ()
Protected Methods
	ImageIOBase ()
	~ImageIOBase ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	Reset (const bool freeDynamic=true)
void	Resize (const unsigned int numDimensions, const unsigned int *dimensions)
void	ComputeStrides ()
virtual unsigned int	GetPixelSize () const
virtual unsigned int	GetComponentSize () const
unsigned int	GetComponentStride () const
unsigned int	GetRowStride () const
unsigned int	GetSliceStride () const
void	WriteBufferAsASCII (std::ostream &os, const void *buffer, IODataType ctype, unsigned int numComp)
void	ReadBufferAsASCII (std::istream &os, void *buffer, IODataType ctype, unsigned int numComp)
const std::type_info &	ConvertToTypeInfo (IODataType) const
unsigned int	GetSizeOfType (IODataType) const
Protected Attributes
IODataType	m_PixelType
IODataType	m_ComponentType
unsigned int	m_NumberOfDimensions
ByteOrder	m_ByteOrder
FileType	m_FileType
bool	m_Initialized
std::string	m_FileName
std::string	m_FilePrefix
unsigned int	m_NumberOfComponents
ImageIORegion	m_IORegion
std::vector< unsigned int >	m_Dimensions
std::vector< double >	m_Spacing
std::vector< double >	m_Origin
std::vector< unsigned int >	m_Strides

---

Detailed Description

Abstract superclass defines image IO interface.

An itk::ImageIOClass is a class that reads and/or writes image data of a particular format. The ImageIOClass encapsulates both the reading and writing of a particular form of data, such as PNG or raw binary. The ImageIOClass is typically used by the ImageFileReader class (to read data) and the ImageFileWriter (to write data).

A Pluggable factory pattern is used this allows different kinds of readers to be registered (even at run time) without having to modify the code in this class.

See also:

ImageFileWriter , ImageFileReader

Definition at line 44 of file itkImageIOBase.h.

---

Member Typedef Documentation

typedef SmartPointer<Self> itk::ImageIOBase::Pointer

Reimplemented from itk::LightProcessObject. Reimplemented in itk::DicomImageIO, itk::MetaImageIO, itk::PNGImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::VOLImageIO, and itk::VTKImageIO. Definition at line 50 of file itkImageIOBase.h.

typedef ImageIOBase itk::ImageIOBase::Self

Standard class typedefs. Reimplemented from itk::LightProcessObject. Reimplemented in itk::DicomImageIO, itk::MetaImageIO, itk::PNGImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::VOLImageIO, and itk::VTKImageIO. Definition at line 48 of file itkImageIOBase.h.

typedef LightProcessObject itk::ImageIOBase::Superclass

Reimplemented from itk::LightProcessObject. Reimplemented in itk::DicomImageIO, itk::MetaImageIO, itk::PNGImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::VOLImageIO, and itk::VTKImageIO. Definition at line 49 of file itkImageIOBase.h.

---

Member Enumeration Documentation

enum itk::ImageIOBase::ByteOrder

Enums used to specify byte order; whether Big Endian or Little Endian. Some subclasses use this, some ignore it. Enumeration values: BigEndian  LittleEndian  OrderNotApplicable  Definition at line 147 of file itkImageIOBase.h.

enum itk::ImageIOBase::FileType

Enums used to specify write style: whether binary or ASCII. Some subclasses use this, some ignore it. Enumeration values: ASCII  Binary  TypeNotApplicable  Definition at line 143 of file itkImageIOBase.h.

enum itk::ImageIOBase::IODataType

Enums used to manipulate the pixel and component type. (Typically a pixel is assumed to be made up of one or more components.) Enumeration values: UNKNOWN  UCHAR  CHAR  USHORT  SHORT  UINT  INT  ULONG  LONG  FLOAT  DOUBLE  RGB  RGBA  Definition at line 60 of file itkImageIOBase.h.

---

Constructor & Destructor Documentation

itk::ImageIOBase::ImageIOBase (    )  [protected]

itk::ImageIOBase::~ImageIOBase (    )  [protected]

---

Member Function Documentation

virtual bool itk::ImageIOBase::CanReadFile (  const char *    )  [pure virtual]

Determine the file type. Returns true if this ImageIO can read the file specified. Implemented in itk::DicomImageIO, itk::MetaImageIO, itk::PNGImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::VOLImageIO, and itk::VTKImageIO.

virtual bool itk::ImageIOBase::CanWriteFile (  const char *    )  [pure virtual]

Determine the file type. Returns true if this ImageIO can read the file specified. Implemented in itk::DicomImageIO, itk::MetaImageIO, itk::PNGImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::VOLImageIO, and itk::VTKImageIO.

void itk::ImageIOBase::ComputeStrides (    )  [protected]

Calculates the different strides (distance from one thing to the next). Upon return, strides[0] = bytes to get to the next component of a pixel, strides[1] = bytes to get to the next pixel in x direction, strides[2] = bytes to get to the next row in y direction, strides[3] = bytes to get to the next slice in z direction, etc.

const std::type_info& itk::ImageIOBase::ConvertToTypeInfo (  IODataType    )  const [protected]

Utility methods for working with IODataType.

virtual ByteOrder itk::ImageIOBase::GetByteOrder (    )  const [virtual]

These methods indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. Note: most UNIX machines are BigEndian while PC's and VAX's are LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetByteOrderToLittleEndian() otherwise SetByteOrderToBigEndian(). Some ImageIOBase subclasses ignore these methods.

virtual const char* itk::ImageIOBase::GetClassName (    )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::LightProcessObject. Reimplemented in itk::DicomImageIO, itk::MetaImageIO, itk::PNGImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::VOLImageIO, and itk::VTKImageIO.

virtual unsigned int itk::ImageIOBase::GetComponentSize (    )  const [protected, virtual]

Compute the size (in bytes) of the components of a pixel. For example, and RGB pixel of unsigned char would have a component size of 1 byte. This method can be invoked only after the component type is set. Reimplemented in itk::DicomImageIO, itk::PNGImageIO, itk::RawImageIO< TPixel, VImageDimension >, and itk::VOLImageIO.

unsigned int itk::ImageIOBase::GetComponentStride (    )  const [protected]

Convenient method for accessing number of bytes to get to the next pixel component. Returns m_Strides[0].

virtual IODataType itk::ImageIOBase::GetComponentType (    )  [virtual]

Set/Get the component type of the image. The readering and writing process typically only supports the native types, with special case support like RGBPixel.

virtual unsigned int itk::ImageIOBase::GetDimensions (  unsigned int    i )  const [inline, virtual]

Set/Get the image dimensions in the x, y, z, etc. directions. GetDimensions() is typically used after reading the data; the SetDimensions() is used prior to writing the data. Definition at line 83 of file itkImageIOBase.h.

virtual const char* itk::ImageIOBase::GetFileName (    )  const [virtual]

Set/Get the file name. Subclasses may ignore this and use FilePrefix.

virtual const char* itk::ImageIOBase::GetFilePrefix (    )  const [virtual]

Set/Get the file prefix. Subclasses may ignore this and use FileName.

virtual FileType itk::ImageIOBase::GetFileType (    )  const [virtual]

These methods control whether the file is written binary or ASCII. Many file formats (i.e., subclasses) ignore this flag.

unsigned int itk::ImageIOBase::GetImageSizeInBytes (    )  const

Return the number of bytes in the image.

unsigned int itk::ImageIOBase::GetImageSizeInComponents (    )  const

Return the number of pixels times the number of components in the image.

unsigned int itk::ImageIOBase::GetImageSizeInPixels (    )  const

Return the number of pixels in the image.

virtual ImageIORegion itk::ImageIOBase::GetIORegion (    )  [virtual]

Specify the region of the image data to either read or write. The IORegion specifies the part of the image to read or write. Regions are defined with an index and a size vector. These vectors define the start (lower-left corner) and length of the region within the image. Make sure that the IORegion lies within the image.

virtual unsigned int itk::ImageIOBase::GetNumberOfComponents (    )  [virtual]

Set/Get the number of components per pixel in the image. This may be set by the reading process.

virtual unsigned int itk::ImageIOBase::GetNumberOfDimensions (    )  [virtual]

Set/Get the number of independent variables (dimensions) in the image being read.

virtual double itk::ImageIOBase::GetOrigin (  unsigned int    i )  const [inline, virtual]

Set/Get the image origin on a axis-by-axis basis. The SetOrigin() method is required when writing the image. Definition at line 90 of file itkImageIOBase.h.

virtual unsigned int itk::ImageIOBase::GetPixelSize (    )  const [protected, virtual]

Compute the size (in bytes) of the pixel. For example, and RGB pixel of unsigned char would have size 3 bytes.

virtual unsigned int itk::ImageIOBase::GetPixelStride (    )  const [virtual]

Convenient method for accessing the number of bytes to get to the next pixel. Returns m_Strides[1];

virtual const std::type_info& itk::ImageIOBase::GetPixelType (    )  const [virtual]

Set/Get the type of the pixel. The pixel type and component type may be different. By default, they are assumed to be the same. The pixel type may be determined by the reader (from the file) or from the writer (the writer's input type). Reimplemented in itk::DicomImageIO, itk::PNGImageIO, itk::RawImageIO< TPixel, VImageDimension >, and itk::VOLImageIO.

unsigned int itk::ImageIOBase::GetRowStride (    )  const [protected]

Convenient method for accessing the number of bytes to get to the next row. Returns m_Strides[2].

unsigned int itk::ImageIOBase::GetSizeOfType (  IODataType    )  const [protected]

Utility methods for working with IODataType.

unsigned int itk::ImageIOBase::GetSliceStride (    )  const [protected]

Convenient method for accessing the number of bytes to get to the next slice. Returns m_Strides[3].

virtual double itk::ImageIOBase::GetSpacing (  unsigned int    i )  const [inline, virtual]

Set/Get the image spacing on an axis-by-axis basis. The SetSpacing() method is required when writing the image. Definition at line 97 of file itkImageIOBase.h.

void itk::ImageIOBase::PrintSelf (  std::ostream &    os, Indent    indent )  const [protected, virtual]

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes. Reimplemented from itk::LightProcessObject. Reimplemented in itk::DicomImageIO, itk::MetaImageIO, itk::PNGImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::VOLImageIO, and itk::VTKImageIO.

virtual void itk::ImageIOBase::Read (  void *    buffer )  [pure virtual]

Reads the data from disk into the memory buffer provided. Implemented in itk::DicomImageIO, itk::MetaImageIO, itk::PNGImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::VOLImageIO, and itk::VTKImageIO.

void itk::ImageIOBase::ReadBufferAsASCII (  std::istream &    os, void *    buffer, IODataType    ctype, unsigned int    numComp )  [protected]

Convenient method to read a buffer as ASCII text.

virtual void itk::ImageIOBase::ReadImageInformation (    )  [pure virtual]

Read the spacing and dimentions of the image. Assumes SetFileName has been called with a valid file name. Implemented in itk::DicomImageIO, itk::MetaImageIO, itk::PNGImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::VOLImageIO, and itk::VTKImageIO.

virtual void itk::ImageIOBase::Reset (  const bool    freeDynamic = true )  [protected, virtual]

Return the object to an initialized state, ready to be used

void itk::ImageIOBase::Resize (  const unsigned int    numDimensions, const unsigned int *    dimensions )  [protected]

Resize the ImageIOBase object to new dimensions.

std::string itk::ImageIOBase::ReturnTypeAsString (  IODataType    )  const

Convenience method returns the IODataType as a string. This can be used for writing output files.

virtual void itk::ImageIOBase::SetByteOrder (  ByteOrder    _arg )  [virtual]

These methods indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. Note: most UNIX machines are BigEndian while PC's and VAX's are LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetByteOrderToLittleEndian() otherwise SetByteOrderToBigEndian(). Some ImageIOBase subclasses ignore these methods.

void itk::ImageIOBase::SetByteOrderToBigEndian (    )  [inline]

These methods indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. Note: most UNIX machines are BigEndian while PC's and VAX's are LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetByteOrderToLittleEndian() otherwise SetByteOrderToBigEndian(). Some ImageIOBase subclasses ignore these methods. Definition at line 172 of file itkImageIOBase.h.

void itk::ImageIOBase::SetByteOrderToLittleEndian (    )  [inline]

These methods indicate the byte ordering of the file you are trying to read in. These methods will then either swap or not swap the bytes depending on the byte ordering of the machine it is being run on. For example, reading in a BigEndian file on a BigEndian machine will result in no swapping. Trying to read the same file on a LittleEndian machine will result in swapping. Note: most UNIX machines are BigEndian while PC's and VAX's are LittleEndian. So if the file you are reading in was generated on a VAX or PC, SetByteOrderToLittleEndian() otherwise SetByteOrderToBigEndian(). Some ImageIOBase subclasses ignore these methods. Definition at line 174 of file itkImageIOBase.h. References HardConnectedComponentImageFilter::PrintSelf().

virtual void itk::ImageIOBase::SetComponentType (  IODataType    _arg )  [virtual]

Set/Get the component type of the image. The readering and writing process typically only supports the native types, with special case support like RGBPixel.

virtual void itk::ImageIOBase::SetDimensions (  unsigned int    i, unsigned int    dim )  [virtual]

Set/Get the image dimensions in the x, y, z, etc. directions. GetDimensions() is typically used after reading the data; the SetDimensions() is used prior to writing the data.

virtual void itk::ImageIOBase::SetFileName (  const char *    _arg )  [virtual]

Set/Get the file name. Subclasses may ignore this and use FilePrefix.

virtual void itk::ImageIOBase::SetFilePrefix (  const char *    _arg )  [virtual]

Set/Get the file prefix. Subclasses may ignore this and use FileName.

virtual void itk::ImageIOBase::SetFileType (  FileType    _arg )  [virtual]

These methods control whether the file is written binary or ASCII. Many file formats (i.e., subclasses) ignore this flag.

void itk::ImageIOBase::SetFileTypeToASCII (    )  [inline]

These methods control whether the file is written binary or ASCII. Many file formats (i.e., subclasses) ignore this flag. Definition at line 153 of file itkImageIOBase.h.

void itk::ImageIOBase::SetFileTypeToBinary (    )  [inline]

These methods control whether the file is written binary or ASCII. Many file formats (i.e., subclasses) ignore this flag. Definition at line 155 of file itkImageIOBase.h.

virtual void itk::ImageIOBase::SetIORegion (  ImageIORegion    _arg )  [virtual]

Specify the region of the image data to either read or write. The IORegion specifies the part of the image to read or write. Regions are defined with an index and a size vector. These vectors define the start (lower-left corner) and length of the region within the image. Make sure that the IORegion lies within the image.

virtual void itk::ImageIOBase::SetNumberOfComponents (  unsigned int    _arg )  [virtual]

Set/Get the number of components per pixel in the image. This may be set by the reading process.

void itk::ImageIOBase::SetNumberOfDimensions (  unsigned    int )

Set/Get the number of independent variables (dimensions) in the image being read.

virtual void itk::ImageIOBase::SetOrigin (  unsigned int    i, double    origin )  [virtual]

Set/Get the image origin on a axis-by-axis basis. The SetOrigin() method is required when writing the image.

virtual bool itk::ImageIOBase::SetPixelType (  const std::type_info &    ptype )  [virtual]

This special, convenience version of SetPixelType() also sets the number of components and the component type. The function returns false if the pixel type is unsupported.

virtual void itk::ImageIOBase::SetPixelType (  const IODataType    ctype )  [virtual]

Set/Get the type of the pixel. The pixel type and component type may be different. By default, they are assumed to be the same. The pixel type may be determined by the reader (from the file) or from the writer (the writer's input type).

virtual void itk::ImageIOBase::SetSpacing (  unsigned int    i, double    spacing )  [virtual]

Set/Get the image spacing on an axis-by-axis basis. The SetSpacing() method is required when writing the image.

virtual void itk::ImageIOBase::Write (  const void *    buffer )  [pure virtual]

Writes the data to disk from the memory buffer provided. Make sure that the IORegions has been set properly. Implemented in itk::DicomImageIO, itk::MetaImageIO, itk::PNGImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::VOLImageIO, and itk::VTKImageIO.

void itk::ImageIOBase::WriteBufferAsASCII (  std::ostream &    os, const void *    buffer, IODataType    ctype, unsigned int    numComp )  [protected]

Convenient method to write a buffer as ASCII text.

virtual void itk::ImageIOBase::WriteImageInformation (    )  [pure virtual]

Writes the spacing and dimentions of the image. Assumes SetFileName has been called with a valid file name. Implemented in itk::DicomImageIO, itk::MetaImageIO, itk::PNGImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::VOLImageIO, and itk::VTKImageIO.

---

Member Data Documentation

ByteOrder itk::ImageIOBase::m_ByteOrder [protected]

Big or Little Endian, and the type of the file. (May be ignored.) Definition at line 241 of file itkImageIOBase.h.

IODataType itk::ImageIOBase::m_ComponentType [protected]

Used internally to keep track of the type of the component. It is set when ComputeStrides() is invoked. Definition at line 235 of file itkImageIOBase.h.

std::vector<unsigned int> itk::ImageIOBase::m_Dimensions [protected]

The array which stores the number of pixels in the x, y, z directions. Definition at line 262 of file itkImageIOBase.h.

std::string itk::ImageIOBase::m_FileName [protected]

Filename: pathname + filename + file extension. Definition at line 248 of file itkImageIOBase.h.

std::string itk::ImageIOBase::m_FilePrefix [protected]

File prefix: pathname + filename + some pattern Definition at line 251 of file itkImageIOBase.h.

FileType itk::ImageIOBase::m_FileType [protected]

Definition at line 242 of file itkImageIOBase.h.

bool itk::ImageIOBase::m_Initialized [protected]

Does the ImageIOBase object have enough info to be of use? Definition at line 245 of file itkImageIOBase.h.

ImageIORegion itk::ImageIOBase::m_IORegion [protected]

The region to read or write. The region contains information about the data within the region to read or write. Definition at line 259 of file itkImageIOBase.h.

unsigned int itk::ImageIOBase::m_NumberOfComponents [protected]

Stores the number of components per pixel. This will be 1 for grayscale images, 3 for RGBPixel images, and 4 for RGBPixelA images. Definition at line 255 of file itkImageIOBase.h.

unsigned int itk::ImageIOBase::m_NumberOfDimensions [protected]

The number of dimensions in the image. Definition at line 238 of file itkImageIOBase.h.

std::vector<double> itk::ImageIOBase::m_Origin [protected]

The array which stores the origin of the image. Definition at line 269 of file itkImageIOBase.h.

IODataType itk::ImageIOBase::m_PixelType [protected]

Used internally to keep track of the type of the pixel. Definition at line 231 of file itkImageIOBase.h.

std::vector<double> itk::ImageIOBase::m_Spacing [protected]

The array which stores the spacing of pixels in the x, y, z directions. Definition at line 266 of file itkImageIOBase.h.

std::vector<unsigned int> itk::ImageIOBase::m_Strides [protected]

Stores the number of bytes it takes to get to the next 'thing' e.g. component, pixel, row, slice, etc. Definition at line 273 of file itkImageIOBase.h.

---

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

• itkImageIOBase.h

---