itk::RawImageIO< TPixel, VImageDimension > Class Template Reference
[Input and Output Filters]

Read and write raw binary images. More...

#include <itkRawImageIO.h>

Inheritance diagram for itk::RawImageIO< TPixel, VImageDimension >:

[legend]Collaboration diagram for itk::RawImageIO< TPixel, VImageDimension >:

[legend]List of all members.

Public Types
typedef RawImageIO	Self
typedef ImageIOBase	Superclass
typedef SmartPointer< Self >	Pointer
typedef TPixel	PixelType
typedef PixelTraits< PixelType >::ValueType	ComponentType
typedef ByteSwapper< ComponentType >	ByteSwapperType
Public Member Functions
virtual const char *	GetClassName () const
virtual const std::type_info &	GetPixelType () const
virtual unsigned int	GetComponentSize () const
virtual bool	SupportsDimension (unsigned long dim)
virtual bool	CanReadFile (const char *)
virtual void	ReadImageInformation ()
virtual void	Read (void *buffer)
virtual void	ReadHeader (const std::string=std::string())
virtual bool	CanWriteFile (const char *)
virtual void	WriteImageInformation (void)
virtual void	Write (const void *buffer)
virtual bool	SetPixelType (const std::type_info &)
virtual void	SetPixelType (const IODataType)
void	SetHeaderSize (unsigned long size)
unsigned long	GetHeaderSize ()
virtual void	SetFileDimensionality (unsigned long _arg)
virtual unsigned long	GetFileDimensionality ()
virtual unsigned short	GetImageMask () const
void	SetImageMask (unsigned long val)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	RawImageIO ()
	~RawImageIO ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	OpenFileForReading (std::ifstream &is)
void	OpenFileForWriting (std::ofstream &os)

---

Detailed Description

template<class TPixel, unsigned int VImageDimension = 2>
class itk::RawImageIO< TPixel, VImageDimension >

Read and write raw binary images.

This class reads and writes 2D or 3D images. Because raw data has little useful information built into the format, so the user is responsible for specifying pixel type, dimensions, spacing, origin, header type, and so on. (Note: the pixel type and image dimension is defined via the template parameter.)

See also:

ImageFileReader

Definition at line 48 of file itkRawImageIO.h.

---

Member Typedef Documentation

template<class TPixel, unsigned int VImageDimension = 2> typedef ByteSwapper<ComponentType> itk::RawImageIO< TPixel, VImageDimension >::ByteSwapperType

Helper class to swap bytes when necessary Definition at line 70 of file itkRawImageIO.h.

template<class TPixel, unsigned int VImageDimension = 2> typedef PixelTraits<PixelType>::ValueType itk::RawImageIO< TPixel, VImageDimension >::ComponentType

this type is used in case the pixel has several components Definition at line 67 of file itkRawImageIO.h.

template<class TPixel, unsigned int VImageDimension = 2> typedef TPixel itk::RawImageIO< TPixel, VImageDimension >::PixelType

Pixel typedef support. Used to declare pixel type in filters or other operations. Definition at line 64 of file itkRawImageIO.h.

template<class TPixel, unsigned int VImageDimension = 2> typedef SmartPointer<Self> itk::RawImageIO< TPixel, VImageDimension >::Pointer

Reimplemented from itk::ImageIOBase. Definition at line 54 of file itkRawImageIO.h.

template<class TPixel, unsigned int VImageDimension = 2> typedef RawImageIO itk::RawImageIO< TPixel, VImageDimension >::Self

Standard class typedefs. Reimplemented from itk::ImageIOBase. Definition at line 52 of file itkRawImageIO.h. Referenced by itk::RawImageIO< TPixel, VImageDimension >::SetPixelType().

template<class TPixel, unsigned int VImageDimension = 2> typedef ImageIOBase itk::RawImageIO< TPixel, VImageDimension >::Superclass

Reimplemented from itk::ImageIOBase. Definition at line 53 of file itkRawImageIO.h.

---

Constructor & Destructor Documentation

template<class TPixel, unsigned int VImageDimension = 2> itk::RawImageIO< TPixel, VImageDimension >::RawImageIO (   )  [protected]

template<class TPixel, unsigned int VImageDimension = 2> itk::RawImageIO< TPixel, VImageDimension >::~RawImageIO (   )  [protected]

---

Member Function Documentation

template<class TPixel, unsigned int VImageDimension = 2> virtual bool itk::RawImageIO< TPixel, VImageDimension >::CanReadFile (  const char *   )  [inline, virtual]

Determine the file type. Returns true if this ImageIOBase can read the file specified. Always returns false because we don't want to use this reader unless absolutely sure (i.e., manual ImageIO creation). Implements itk::ImageIOBase. Definition at line 109 of file itkRawImageIO.h.

template<class TPixel, unsigned int VImageDimension = 2> virtual bool itk::RawImageIO< TPixel, VImageDimension >::CanWriteFile (  const char *   )  [virtual]

Returns true if this ImageIO can write the specified file. False is only returned when the file name is not specified. Otherwise true is always returned. Implements itk::ImageIOBase.

template<class TPixel, unsigned int VImageDimension = 2> virtual const char* itk::RawImageIO< TPixel, VImageDimension >::GetClassName (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::ImageIOBase.

template<class TPixel, unsigned int VImageDimension = 2> virtual unsigned int itk::RawImageIO< TPixel, VImageDimension >::GetComponentSize (   )  const [inline, 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. Reimplemented from itk::ImageIOBase. Definition at line 93 of file itkRawImageIO.h.

template<class TPixel, unsigned int VImageDimension = 2> virtual unsigned long itk::RawImageIO< TPixel, VImageDimension >::GetFileDimensionality (   )  [virtual]

The number of dimensions stored in a file. Defaults to two. If two, each file contains one "slice". If three, each file will contain one "volume".

template<class TPixel, unsigned int VImageDimension = 2> unsigned long itk::RawImageIO< TPixel, VImageDimension >::GetHeaderSize (   )

If the data is in the tail end of the file, you want to explicitly set the header size.

template<class TPixel, unsigned int VImageDimension = 2> virtual unsigned short itk::RawImageIO< TPixel, VImageDimension >::GetImageMask (   )  const [virtual]

Set/Get the Data mask.

template<class TPixel, unsigned int VImageDimension = 2> virtual const std::type_info& itk::RawImageIO< TPixel, VImageDimension >::GetPixelType (   )  const [inline, virtual]

Get the type of the pixel. Reimplemented from itk::ImageIOBase. Definition at line 87 of file itkRawImageIO.h.

template<class TPixel, unsigned int VImageDimension = 2> Pointer itk::RawImageIO< TPixel, VImageDimension >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::LightProcessObject.

template<class TPixel, unsigned int VImageDimension = 2> void itk::RawImageIO< TPixel, VImageDimension >::OpenFileForReading (  std::ifstream &  is  )  [protected]

template<class TPixel, unsigned int VImageDimension = 2> void itk::RawImageIO< TPixel, VImageDimension >::OpenFileForWriting (  std::ofstream &  os  )  [protected]

template<class TPixel, unsigned int VImageDimension = 2> void itk::RawImageIO< TPixel, VImageDimension >::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::ImageIOBase.

template<class TPixel, unsigned int VImageDimension = 2> virtual void itk::RawImageIO< TPixel, VImageDimension >::Read (  void *  buffer  )  [virtual]

Reads the data from disk into the memory buffer provided. Implements itk::ImageIOBase.

template<class TPixel, unsigned int VImageDimension = 2> virtual void itk::RawImageIO< TPixel, VImageDimension >::ReadHeader (  const std::string  = std::string()  )  [inline, virtual]

Read a file's header to determine image dimensions, etc. Definition at line 131 of file itkRawImageIO.h.

template<class TPixel, unsigned int VImageDimension = 2> virtual void itk::RawImageIO< TPixel, VImageDimension >::ReadImageInformation (   )  [inline, virtual]

Binary files have no image information to read. This must be set by the user of the class. Implements itk::ImageIOBase. Definition at line 114 of file itkRawImageIO.h.

template<class TPixel, unsigned int VImageDimension = 2> virtual void itk::RawImageIO< TPixel, VImageDimension >::SetFileDimensionality (  unsigned long  _arg  )  [virtual]

The number of dimensions stored in a file. Defaults to two. If two, each file contains one "slice". If three, each file will contain one "volume".

template<class TPixel, unsigned int VImageDimension = 2> void itk::RawImageIO< TPixel, VImageDimension >::SetHeaderSize (  unsigned long  size  )

If the data is in the tail end of the file, you want to explicitly set the header size.

template<class TPixel, unsigned int VImageDimension = 2> void itk::RawImageIO< TPixel, VImageDimension >::SetImageMask (  unsigned long  val  )  [inline]

Set/Get the Data mask. Definition at line 122 of file itkRawImageIO.h.

template<class TPixel, unsigned int VImageDimension = 2> virtual void itk::RawImageIO< TPixel, VImageDimension >::SetPixelType (  const  IODataType  )  [inline, 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 from itk::ImageIOBase. Definition at line 152 of file itkRawImageIO.h. References itk::RawImageIO< TPixel, VImageDimension >::Self.

template<class TPixel, unsigned int VImageDimension = 2> virtual bool itk::RawImageIO< TPixel, VImageDimension >::SetPixelType (  const std::type_info &   )  [inline, 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. Reimplemented from itk::ImageIOBase. Definition at line 149 of file itkRawImageIO.h.

template<class TPixel, unsigned int VImageDimension = 2> virtual bool itk::RawImageIO< TPixel, VImageDimension >::SupportsDimension (  unsigned long  dim  )  [inline, virtual]

The different types of ImageIO's can support data of varying dimensionality. For example, some file formats are strictly 2D while others can support 2D, 3D, or even n-D. This method returns true/false as to whether the ImageIO can support the dimension indicated. Reimplemented from itk::ImageIOBase. Definition at line 101 of file itkRawImageIO.h.

template<class TPixel, unsigned int VImageDimension = 2> virtual void itk::RawImageIO< TPixel, VImageDimension >::Write (  const void *  buffer  )  [virtual]

Writes the data to disk from the memory buffer provided. Implements itk::ImageIOBase.

template<class TPixel, unsigned int VImageDimension = 2> virtual void itk::RawImageIO< TPixel, VImageDimension >::WriteImageInformation (  void   )  [inline, virtual]

Binary files have no image information to read. Implements itk::ImageIOBase. Definition at line 141 of file itkRawImageIO.h.

---

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

• itkRawImageIO.h

---