itk::ImageIOBase Class Reference

#include <itkImageIOBase.h>

Inheritance diagram for itk::ImageIOBase:

Collaboration diagram for itk::ImageIOBase:

Detailed Description

Abstract superclass defines image IO interface.

ImageIOBase is a class that reads and/or writes image data of a particular format (such as PNG or raw binary). The ImageIOBase encapsulates both the reading and writing of data. The ImageIOBase is used by the ImageFileReader class (to read data) and the ImageFileWriter (to write data) into a single file. The ImageSeriesReader and ImageSeriesWriter classes are used to read and write data (in conjunction with ImageIOBase) when the data is represented by a series of files. Normally the user does not directly manipulate this class other than to instantiate it, set the FileName, and assign it to a ImageFileReader/ImageFileWriter or ImageSeriesReader/ImageSeriesWriter.

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

ImageSeriesWriter

ImageSeriesReader

Definition at line 68 of file itkImageIOBase.h.

Classes
struct	MapPixelType
class	UnknownType

Public Types
typedef std::vector< std::string >	ArrayOfExtensionsType
typedef ::itk::OffsetValueType	BufferSizeType
enum	ByteOrder {   BigEndian,   LittleEndian,   OrderNotApplicable }
enum	FileType {   ASCII,   Binary,   TypeNotApplicable }
typedef ::itk::IndexValueType	IndexValueType
enum	IOComponentType {   UNKNOWNCOMPONENTTYPE,   UCHAR,   CHAR,   USHORT,   SHORT,   UINT,   INT,   ULONG,   LONG,   FLOAT,   DOUBLE }
enum	IOPixelType {   UNKNOWNPIXELTYPE,   SCALAR,   RGB,   RGBA,   OFFSET,   VECTOR,   POINT,   COVARIANTVECTOR,   SYMMETRICSECONDRANKTENSOR,   DIFFUSIONTENSOR3D,   COMPLEX,   FIXEDARRAY,   MATRIX }
typedef SmartPointer< Self >	Pointer
typedef ImageIOBase	Self
typedef ::itk::intmax_t	SizeType
typedef ::itk::SizeValueType	SizeValueType
typedef LightProcessObject	Superclass
Public Types inherited from itk::LightProcessObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightProcessObject	Self
typedef Object	Superclass
Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef Object	Self
typedef LightObject	Superclass
Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef LightObject	Self

Public Member Functions
virtual bool	CanReadFile (const char *)=0
virtual bool	CanStreamRead ()
virtual bool	CanStreamWrite ()
virtual bool	CanWriteFile (const char *)=0
virtual ImageIORegion	GenerateStreamableReadRegionFromRequestedRegion (const ImageIORegion &requested) const
virtual unsigned int	GetActualNumberOfSplitsForWriting (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)
std::string	GetByteOrderAsString (ByteOrder) const
virtual unsigned int	GetComponentSize () const
virtual IOComponentType	GetComponentType () const
virtual const std::type_info &	GetComponentTypeInfo () const
virtual std::vector< double >	GetDefaultDirection (unsigned int i) const
virtual itk::SizeValueType	GetDimensions (unsigned int i) const
virtual std::vector< double >	GetDirection (unsigned int i) const
std::string	GetFileTypeAsString (FileType) const
SizeType	GetImageSizeInBytes () const
SizeType	GetImageSizeInComponents () const
SizeType	GetImageSizeInPixels () const
virtual const char *	GetNameOfClass () const
virtual unsigned int	GetNumberOfDimensions () const
virtual double	GetOrigin (unsigned int i) const
virtual SizeType	GetPixelStride () const
virtual double	GetSpacing (unsigned int i) const
virtual ImageIORegion	GetSplitRegionForWriting (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion, const ImageIORegion &largestPossibleRegion)
const ArrayOfExtensionsType &	GetSupportedReadExtensions () const
const ArrayOfExtensionsType &	GetSupportedWriteExtensions () const
virtual void	Read (void *buffer)=0
virtual void	ReadImageInformation ()=0
void	SetByteOrderToLittleEndian ()
virtual void	SetComponentType (const IOComponentType _arg)
virtual void	SetDirection (unsigned int i, std::vector< double > &direction)
virtual void	SetDirection (unsigned int i, vnl_vector< double > &direction)
void	SetFileTypeToBinary ()
void	SetNumberOfDimensions (unsigned int)
virtual void	SetOrigin (unsigned int i, double origin)
template<class TPixel , unsigned VLength>
void	SetPixelTypeInfo (const SymmetricSecondRankTensor< TPixel, VLength > *)
template<typename TPixel >
void	SetPixelTypeInfo (const DiffusionTensor3D< TPixel > *)
template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const Matrix< TPixel, VLength, VLength > *)
template<typename TPixel >
void	SetPixelTypeInfo (const std::complex< TPixel > *)
template<unsigned VLength>
void	SetPixelTypeInfo (const Offset< VLength > *)
virtual void	SetSpacing (unsigned int i, double spacing)
template<typename TPixel >
void	SetTypeInfo (const TPixel *)
virtual bool	SupportsDimension (unsigned long dim)
virtual void	Write (const void *buffer)=0
virtual void	WriteImageInformation ()=0
virtual void	SetFileName (const char *_arg)
virtual const char *	GetFileName () const
virtual void	SetDimensions (unsigned int i, unsigned int dim)
virtual void	SetIORegion (ImageIORegion _arg)
virtual const ImageIORegion &	GetIORegion ()
virtual void	SetPixelType (const IOPixelType _arg)
virtual IOPixelType	GetPixelType () const
virtual void	SetNumberOfComponents (unsigned int _arg)
virtual const unsigned int &	GetNumberOfComponents ()
virtual void	SetUseCompression (bool _arg)
virtual bool	GetUseCompression () const
virtual void	UseCompressionOn ()
virtual void	UseCompressionOff ()
virtual void	SetUseStreamedReading (bool _arg)
virtual bool	GetUseStreamedReading () const
virtual void	UseStreamedReadingOn ()
virtual void	UseStreamedReadingOff ()
virtual void	SetUseStreamedWriting (bool _arg)
virtual bool	GetUseStreamedWriting () const
virtual void	UseStreamedWritingOn ()
virtual void	UseStreamedWritingOff ()
virtual void	SetFileType (const FileType _arg)
virtual FileType	GetFileType () const
void	SetFileTypeToASCII ()
virtual void	SetByteOrder (const ByteOrder _arg)
virtual ByteOrder	GetByteOrder () const
void	SetByteOrderToBigEndian ()
template<typename TPixel >
void	SetPixelTypeInfo (const TPixel *)
template<typename TPixel >
void	SetPixelTypeInfo (const RGBPixel< TPixel > *)
template<typename TPixel >
void	SetPixelTypeInfo (const RGBAPixel< TPixel > *)
template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const Vector< TPixel, VLength > *)
template<typename TPixel >
void	SetPixelTypeInfo (const VariableLengthVector< TPixel > *)
template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const CovariantVector< TPixel, VLength > *)
template<typename TPixel , unsigned VLength>
void	SetPixelTypeInfo (const FixedArray< TPixel, VLength > *)
Public Member Functions inherited from itk::LightProcessObject
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const bool &	GetAbortGenerateData ()
virtual void	SetAbortGenerateData (bool _arg)
virtual void	UpdateOutputData ()
void	UpdateProgress (float amount)
virtual void	SetProgress (float _arg)
virtual const float &	GetProgress ()
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual void	DebugOff () const
virtual void	DebugOn () const
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
virtual void	Modified () const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
Public Member Functions inherited from itk::LightObject
virtual void	Delete ()
virtual int	GetReferenceCount () const
	itkCloneMacro (Self)
void	Print (std::ostream &os, Indent indent=0) const

Static Public Member Functions
static std::string	GetComponentTypeAsString (IOComponentType)
static IOComponentType	GetComponentTypeFromString (const std::string &typeString)
static std::string	GetPixelTypeAsString (IOPixelType)
static IOPixelType	GetPixelTypeFromString (const std::string &pixelString)
Static Public Member Functions inherited from itk::LightProcessObject
static Pointer	New ()
Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)
Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()
static Pointer	New ()

Protected Member Functions
void	AddSupportedReadExtension (const char *extension)
void	AddSupportedWriteExtension (const char *extension)
void	ComputeStrides ()
virtual unsigned int	GetActualNumberOfSplitsForWritingCanStreamWrite (unsigned int numberOfRequestedSplits, const ImageIORegion &pasteRegion) const
SizeType	GetComponentStride () const
virtual const ImageRegionSplitterBase *	GetImageRegionSplitter (void) const
virtual unsigned int	GetPixelSize () const
SizeType	GetRowStride () const
SizeType	GetSliceStride () const
virtual ImageIORegion	GetSplitRegionForWritingCanStreamWrite (unsigned int ithPiece, unsigned int numberOfActualSplits, const ImageIORegion &pasteRegion) const
	ImageIOBase ()
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	ReadBufferAsASCII (std::istream &os, void *buffer, IOComponentType ctype, SizeType numberOfBytesToBeRead)
bool	ReadBufferAsBinary (std::istream &os, void *buffer, SizeType numberOfBytesToBeRead)
virtual void	Reset (const bool freeDynamic=true)
void	Resize (const unsigned int numDimensions, const unsigned int *dimensions)
virtual void	WriteBufferAsASCII (std::ostream &os, const void *buffer, IOComponentType ctype, SizeType numberOfBytesToWrite)
	~ImageIOBase ()
Protected Member Functions inherited from itk::LightProcessObject
virtual void	GenerateData ()
	LightProcessObject ()
	~LightProcessObject ()
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const
	LightObject ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual	~LightObject ()

Protected Attributes
ByteOrder	m_ByteOrder
IOComponentType	m_ComponentType
std::vector< SizeValueType >	m_Dimensions
std::vector< std::vector < double > >	m_Direction
std::string	m_FileName
FileType	m_FileType
bool	m_Initialized
ImageIORegion	m_IORegion
unsigned int	m_NumberOfComponents
unsigned int	m_NumberOfDimensions
std::vector< double >	m_Origin
IOPixelType	m_PixelType
std::vector< double >	m_Spacing
std::vector< SizeType >	m_Strides
bool	m_UseCompression
bool	m_UseStreamedReading
bool	m_UseStreamedWriting

Private Member Functions
	ImageIOBase (const Self &)
void	operator= (const Self &)

Private Attributes
ArrayOfExtensionsType	m_SupportedReadExtensions
ArrayOfExtensionsType	m_SupportedWriteExtensions

Additional Inherited Members
Protected Types inherited from itk::LightObject
typedef int	InternalReferenceCountType

Member Typedef Documentation

typedef std::vector< std::string > itk::ImageIOBase::ArrayOfExtensionsType

Type for the list of strings to be used for extensions.

Definition at line 419 of file itkImageIOBase.h.

typedef ::itk::OffsetValueType itk::ImageIOBase::BufferSizeType

Type for representing size of bytes, and or positions along a memory buffer

Definition at line 289 of file itkImageIOBase.h.

typedef ::itk::IndexValueType itk::ImageIOBase::IndexValueType

Types for managing image size and image index components.

Definition at line 81 of file itkImageIOBase.h.

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

Definition at line 74 of file itkImageIOBase.h.

typedef ImageIOBase itk::ImageIOBase::Self

Standard class typedefs.

Definition at line 72 of file itkImageIOBase.h.

typedef ::itk::intmax_t itk::ImageIOBase::SizeType

Type for representing size of bytes, and or positions along a file

Definition at line 285 of file itkImageIOBase.h.

typedef ::itk::SizeValueType itk::ImageIOBase::SizeValueType

Definition at line 86 of file itkImageIOBase.h.

typedef LightProcessObject itk::ImageIOBase::Superclass

Definition at line 73 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.

Enumerator
BigEndian
LittleEndian
OrderNotApplicable

Definition at line 235 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.

Enumerator
ASCII
Binary
TypeNotApplicable

Definition at line 231 of file itkImageIOBase.h.

enum itk::ImageIOBase::IOComponentType

Enums used to manipulate the component type. The component type refers to the actual storage class associated with either a SCALAR pixel type or elements of a compound pixel.

Enumerator
UNKNOWNCOMPONENTTYPE
UCHAR
CHAR
USHORT
SHORT
UINT
INT
ULONG
LONG
FLOAT
DOUBLE

Definition at line 106 of file itkImageIOBase.h.

enum itk::ImageIOBase::IOPixelType

Enums used to manipulate the pixel type. The pixel type provides context for automatic data conversions (for instance, RGB to SCALAR, VECTOR to SCALAR).

Enumerator
UNKNOWNPIXELTYPE
SCALAR
RGB
RGBA
OFFSET
VECTOR
POINT
COVARIANTVECTOR
SYMMETRICSECONDRANKTENSOR
DIFFUSIONTENSOR3D
COMPLEX
FIXEDARRAY
MATRIX

Definition at line 98 of file itkImageIOBase.h.

Constructor & Destructor Documentation

itk::ImageIOBase::ImageIOBase ( )

protected

itk::ImageIOBase::~ImageIOBase ( )

protected

itk::ImageIOBase::ImageIOBase ( const Self &  )

private

Member Function Documentation

void itk::ImageIOBase::AddSupportedReadExtension ( const char *  extension )

protected

Insert an extension to the list of supported extensions for reading.

void itk::ImageIOBase::AddSupportedWriteExtension ( const char *  extension )

protected

Insert an extension to the list of supported extensions for writing.

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::Bruker2DSEQImageIO, itk::HDF5ImageIO, itk::GDCMImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::IPLCommonImageIO, itk::MRCImageIO, itk::StimulateImageIO, itk::VTKImageIO, itk::GE4ImageIO, itk::GE5ImageIO, itk::SiemensVisionImageIO, itk::GEAdwImageIO, itk::FileListVideoIO, itk::VoxBoCUBImageIO, itk::BioRadImageIO, itk::MetaImageIO, itk::JPEG2000ImageIO, itk::NiftiImageIO, itk::OpenCVVideoIO, itk::LSMImageIO, itk::JPEGImageIO, itk::TIFFImageIO, itk::NrrdImageIO, itk::PNGImageIO, itk::BMPImageIO, and itk::GiplImageIO.

virtual bool itk::ImageIOBase::CanStreamRead ( void  )

inlinevirtual

Determine if the ImageIO can stream reading from the current settings. Default is false. If this is queried after the header of the file has been read then it will indicate if that file can be streamed

Reimplemented in itk::MetaImageIO, itk::VTKImageIO, and itk::StreamingImageIOBase.

Definition at line 325 of file itkImageIOBase.h.

virtual bool itk::ImageIOBase::CanStreamWrite ( void  )

inlinevirtual

Determine if the ImageIO can stream write from the current settings.

There are two types of non exclusive streaming: pasteing subregions, and iterative

Reimplemented in itk::MetaImageIO, itk::JPEG2000ImageIO, itk::VTKImageIO, and itk::StreamingImageIOBase.

Definition at line 349 of file itkImageIOBase.h.

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::Bruker2DSEQImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::HDF5ImageIO, itk::GDCMImageIO, itk::FileListVideoIO, itk::OpenCVVideoIO, itk::IPLCommonImageIO, itk::MRCImageIO, itk::StimulateImageIO, itk::VTKImageIO, itk::NiftiImageIO, itk::MetaImageIO, itk::VoxBoCUBImageIO, itk::BioRadImageIO, itk::JPEG2000ImageIO, itk::TIFFImageIO, itk::JPEGImageIO, itk::LSMImageIO, itk::PNGImageIO, itk::NrrdImageIO, itk::BMPImageIO, and itk::GiplImageIO.

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.

virtual ImageIORegion itk::ImageIOBase::GenerateStreamableReadRegionFromRequestedRegion ( const ImageIORegion &  requested ) const

virtual

Method for supporting streaming. Given a requested region, determine what could be the region that we can read from the file. This is called the streamable region, which will be equal or smaller than the LargestPossibleRegion (unless it was dimensionaly clipped) and greater or equal to the RequestedRegion

the resulting IORegion may be a greater dimensions the the requested IORegion, if the the derived class is unable to read the requested region. For example if the file has a size of [ 10, 10, 10] but the requested region is [10, 10] the return may be 3 dimensions.

Reimplemented in itk::MetaImageIO, itk::NiftiImageIO, itk::JPEG2000ImageIO, and itk::StreamingImageIOBase.

virtual unsigned int itk::ImageIOBase::GetActualNumberOfSplitsForWriting ( unsigned int  numberOfRequestedSplits, const ImageIORegion &  pasteRegion, const ImageIORegion &  largestPossibleRegion  )

virtual

Before this method is called all the configuration will be done, that is Streaming/PasteRegion/Compression/Filename etc If pasting is being used the number of requested splits is for that region not the largest. The derived ImageIO class should verify that the file is capable of being written with this configuration. If pasted is enabled and is not support or does not work with the file, then an excepetion should be thrown.

The default implementation depends on CanStreamWrite. If false then 1 is returned (unless pasting is indicated), so that the whole file will be updated in one region. If true then its assumed that any arbitrary region can be written to any file. So the users request will be respected. If a derived class has more restictive conditions then they should be checked

Reimplemented in itk::MetaImageIO, and itk::StreamingImageIOBase.

virtual unsigned int itk::ImageIOBase::GetActualNumberOfSplitsForWritingCanStreamWrite ( unsigned int  numberOfRequestedSplits, const ImageIORegion &  pasteRegion  ) const

protectedvirtual

an implementation of ImageRegionSplitter:GetNumberOfSplits

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.

std::string itk::ImageIOBase::GetByteOrderAsString

(

ByteOrder

)

const

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

virtual unsigned int itk::ImageIOBase::GetComponentSize ( ) const

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::IPLCommonImageIO.

SizeType itk::ImageIOBase::GetComponentStride ( ) const

protected

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

virtual IOComponentType itk::ImageIOBase::GetComponentType ( ) const

virtual

static std::string itk::ImageIOBase::GetComponentTypeAsString ( IOComponentType  )

static

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

static IOComponentType itk::ImageIOBase::GetComponentTypeFromString ( const std::string &  typeString )

static

Convenience method returns the IOComponentType corresponding to a string.

virtual const std::type_info& itk::ImageIOBase::GetComponentTypeInfo ( ) const

virtual

get the type_info for the current pixel component type. This function is DEPRECATED and only provided for backwards compatibility. There is no use for this method that can't be satisfied by calling GetComponentType.

virtual std::vector< double > itk::ImageIOBase::GetDefaultDirection ( unsigned int  i ) const

virtual

Return the directions to be assigned by default to recipient images whose dimension is smaller than the image dimension in file.

virtual itk::SizeValueType itk::ImageIOBase::GetDimensions ( unsigned int  i ) const

inlinevirtual

Definition at line 122 of file itkImageIOBase.h.

virtual std::vector< double > itk::ImageIOBase::GetDirection ( unsigned int  i ) const

inlinevirtual

Reimplemented in itk::FileListVideoIO, and itk::OpenCVVideoIO.

Definition at line 149 of file itkImageIOBase.h.

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

virtual

Set/Get the name of the file to be read.

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.

std::string itk::ImageIOBase::GetFileTypeAsString

(

FileType

)

const

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

virtual const ImageRegionSplitterBase* itk::ImageIOBase::GetImageRegionSplitter ( void  ) const

protectedvirtual

SizeType itk::ImageIOBase::GetImageSizeInBytes

(

)

const

Return the number of bytes in the image.

SizeType itk::ImageIOBase::GetImageSizeInComponents

(

)

const

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

SizeType itk::ImageIOBase::GetImageSizeInPixels

(

)

const

Return the number of pixels in the image.

virtual const 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 const char* itk::ImageIOBase::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::LightProcessObject.

Reimplemented in itk::Bruker2DSEQImageIO, itk::GDCMImageIO, itk::HDF5ImageIO, itk::StimulateImageIO, itk::IPLCommonImageIO, itk::MRCImageIO, itk::GE4ImageIO, itk::VideoIOBase, itk::VTKImageIO, itk::GE5ImageIO, itk::VoxBoCUBImageIO, itk::BioRadImageIO, itk::SiemensVisionImageIO, itk::JPEG2000ImageIO, itk::StreamingImageIOBase, itk::GEAdwImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::LSMImageIO, itk::NiftiImageIO, itk::TIFFImageIO, itk::MetaImageIO, itk::OpenCVVideoIO, itk::BMPImageIO, itk::GiplImageIO, itk::FileListVideoIO, itk::NrrdImageIO, itk::JPEGImageIO, and itk::PNGImageIO.

virtual const 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. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

virtual unsigned int itk::ImageIOBase::GetNumberOfDimensions ( ) const

virtual

virtual double itk::ImageIOBase::GetOrigin ( unsigned int  i ) const

inlinevirtual

Reimplemented in itk::FileListVideoIO, and itk::OpenCVVideoIO.

Definition at line 129 of file itkImageIOBase.h.

virtual unsigned int itk::ImageIOBase::GetPixelSize ( ) const

protectedvirtual

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

virtual SizeType itk::ImageIOBase::GetPixelStride ( ) const

virtual

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

Please note that this methods depends the private methods ComputeStrides being called, otherwise this is the incorrect value.

virtual IOPixelType itk::ImageIOBase::GetPixelType ( ) const

virtual

Set/Get the type of the pixel. The PixelTypes provides context to the IO mechanisms for data conversions. PixelTypes can be SCALAR, RGB, RGBA, VECTOR, COVARIANTVECTOR, POINT, INDEX. If the PIXELTYPE is SCALAR, then the NumberOfComponents should be 1. Any other of PIXELTYPE will have more than one component.

static std::string itk::ImageIOBase::GetPixelTypeAsString ( IOPixelType  )

static

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

static IOPixelType itk::ImageIOBase::GetPixelTypeFromString ( const std::string &  pixelString )

static

Convenience method returns the IOPixelType corresponding to a string.

SizeType itk::ImageIOBase::GetRowStride ( ) const

protected

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

SizeType 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

inlinevirtual

Reimplemented in itk::FileListVideoIO, and itk::OpenCVVideoIO.

Definition at line 138 of file itkImageIOBase.h.

virtual ImageIORegion itk::ImageIOBase::GetSplitRegionForWriting ( unsigned int  ithPiece, unsigned int  numberOfActualSplits, const ImageIORegion &  pasteRegion, const ImageIORegion &  largestPossibleRegion  )

virtual

returns the ith IORegion

numberOfActualSplits should be the value returned from GetActualNumberOfSplitsForWriting with the same parameters

Derieved classes should overload this method to return a compatible region

Reimplemented in itk::MetaImageIO.

virtual ImageIORegion itk::ImageIOBase::GetSplitRegionForWritingCanStreamWrite ( unsigned int  ithPiece, unsigned int  numberOfActualSplits, const ImageIORegion &  pasteRegion  ) const

protectedvirtual

an implementation of ImageRegionSplitter:GetSplit

const ArrayOfExtensionsType& itk::ImageIOBase::GetSupportedReadExtensions

(

)

const

This method returns an array with the list of filename extensions supported for reading by this ImageIO class. This is intended to facilitate GUI and application level integration.

const ArrayOfExtensionsType& itk::ImageIOBase::GetSupportedWriteExtensions

(

)

const

This method returns an array with the list of filename extensions supported for writing by this ImageIO class. This is intended to facilitate GUI and application level integration.

virtual bool itk::ImageIOBase::GetUseCompression ( ) const

virtual

Set/Get a boolean to use the compression or not.

virtual bool itk::ImageIOBase::GetUseStreamedReading ( ) const

virtual

Set/Get a boolean to use streaming while reading or not.

virtual bool itk::ImageIOBase::GetUseStreamedWriting ( ) const

virtual

Set/Get a boolean to use streaming while writing or not.

void itk::ImageIOBase::operator= ( const Self &  )

private

void itk::ImageIOBase::PrintSelf ( std::ostream &  os, Indent  indent  ) const

protectedvirtual

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::GDCMImageIO, itk::Bruker2DSEQImageIO, itk::MetaImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::HDF5ImageIO, itk::FileListVideoIO, itk::OpenCVVideoIO, itk::TIFFImageIO, itk::IPLCommonImageIO, itk::StimulateImageIO, itk::VideoIOBase, itk::JPEG2000ImageIO, itk::MRCImageIO, itk::NiftiImageIO, itk::VTKImageIO, itk::BioRadImageIO, itk::VoxBoCUBImageIO, itk::JPEGImageIO, itk::StreamingImageIOBase, itk::LSMImageIO, itk::PNGImageIO, itk::NrrdImageIO, itk::BMPImageIO, and itk::GiplImageIO.

virtual void itk::ImageIOBase::Read ( void *  buffer )

pure virtual

Reads the data from disk into the memory buffer provided.

Implemented in itk::Bruker2DSEQImageIO, itk::HDF5ImageIO, itk::GDCMImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::IPLCommonImageIO, itk::MRCImageIO, itk::StimulateImageIO, itk::VTKImageIO, itk::FileListVideoIO, itk::OpenCVVideoIO, itk::VoxBoCUBImageIO, itk::BioRadImageIO, itk::MetaImageIO, itk::JPEG2000ImageIO, itk::NiftiImageIO, itk::LSMImageIO, itk::JPEGImageIO, itk::TIFFImageIO, itk::NrrdImageIO, itk::PNGImageIO, itk::BMPImageIO, and itk::GiplImageIO.

virtual void itk::ImageIOBase::ReadBufferAsASCII ( std::istream &  os, void *  buffer, IOComponentType  ctype, SizeType  numberOfBytesToBeRead  )

protectedvirtual

Convenient method to read a buffer as ASCII text.

Reimplemented in itk::VTKImageIO.

bool itk::ImageIOBase::ReadBufferAsBinary ( std::istream &  os, void *  buffer, SizeType  numberOfBytesToBeRead  )

protected

Convenient method to read a buffer as binary. Return true on success.

virtual void itk::ImageIOBase::ReadImageInformation ( )

pure virtual

Read the spacing and dimensions of the image. Assumes SetFileName has been called with a valid file name.

Implemented in itk::Bruker2DSEQImageIO, itk::HDF5ImageIO, itk::GDCMImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::IPLCommonImageIO, itk::MRCImageIO, itk::StimulateImageIO, itk::VTKImageIO, itk::FileListVideoIO, itk::OpenCVVideoIO, itk::VoxBoCUBImageIO, itk::BioRadImageIO, itk::MetaImageIO, itk::JPEG2000ImageIO, itk::NiftiImageIO, itk::LSMImageIO, itk::JPEGImageIO, itk::TIFFImageIO, itk::NrrdImageIO, itk::PNGImageIO, itk::BMPImageIO, and itk::GiplImageIO.

virtual void itk::ImageIOBase::Reset ( const bool  freeDynamic = true )

protectedvirtual

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.

virtual void itk::ImageIOBase::SetByteOrder ( const 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 265 of file itkImageIOBase.h.

void itk::ImageIOBase::SetByteOrderToLittleEndian ( )

inline

Definition at line 271 of file itkImageIOBase.h.

virtual void itk::ImageIOBase::SetComponentType ( const IOComponentType  _arg )

virtual

Set/Get the component type of the image. This is always a native type.

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::SetDirection ( unsigned int  i, std::vector< double > &  direction  )

virtual

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

virtual void itk::ImageIOBase::SetDirection ( unsigned int  i, vnl_vector< double > &  direction  )

virtual

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

virtual

Set/Get the name of the file to be read.

Reimplemented in itk::FileListVideoIO.

virtual void itk::ImageIOBase::SetFileType ( const 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 241 of file itkImageIOBase.h.

void itk::ImageIOBase::SetFileTypeToBinary ( )

inline

Definition at line 247 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. For SCALAR pixel types, NumberOfComponents will be 1. For other pixel types, NumberOfComponents will be greater than or equal to one.

void itk::ImageIOBase::SetNumberOfDimensions

(

unsigned

int

)

Set/Get the number of independent variables (dimensions) in the image being read or written. Note this is not necessarily what is written, rather the IORegion controls that.

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 void itk::ImageIOBase::SetPixelType ( const IOPixelType  _arg )

virtual

Set/Get the type of the pixel. The PixelTypes provides context to the IO mechanisms for data conversions. PixelTypes can be SCALAR, RGB, RGBA, VECTOR, COVARIANTVECTOR, POINT, INDEX. If the PIXELTYPE is SCALAR, then the NumberOfComponents should be 1. Any other of PIXELTYPE will have more than one component.

template<typename TPixel >

void itk::ImageIOBase::SetPixelTypeInfo ( const TPixel *  )

inline

Definition at line 444 of file itkImageIOBase.h.

template<typename TPixel >

void itk::ImageIOBase::SetPixelTypeInfo ( const RGBPixel< TPixel > *  )

inline

Definition at line 451 of file itkImageIOBase.h.

template<typename TPixel >

void itk::ImageIOBase::SetPixelTypeInfo ( const RGBAPixel< TPixel > *  )

inline

Definition at line 458 of file itkImageIOBase.h.

template<typename TPixel , unsigned VLength>

void itk::ImageIOBase::SetPixelTypeInfo ( const Vector< TPixel, VLength > *  )

inline

Definition at line 465 of file itkImageIOBase.h.

template<typename TPixel >

void itk::ImageIOBase::SetPixelTypeInfo ( const VariableLengthVector< TPixel > *  )

inline

Definition at line 472 of file itkImageIOBase.h.

template<typename TPixel , unsigned VLength>

void itk::ImageIOBase::SetPixelTypeInfo ( const CovariantVector< TPixel, VLength > *  )

inline

Definition at line 479 of file itkImageIOBase.h.

template<typename TPixel , unsigned VLength>

void itk::ImageIOBase::SetPixelTypeInfo ( const FixedArray< TPixel, VLength > *  )

inline

Definition at line 486 of file itkImageIOBase.h.

template<class TPixel , unsigned VLength>

void itk::ImageIOBase::SetPixelTypeInfo ( const SymmetricSecondRankTensor< TPixel, VLength > *  )

inline

Definition at line 495 of file itkImageIOBase.h.

template<typename TPixel >

void itk::ImageIOBase::SetPixelTypeInfo ( const DiffusionTensor3D< TPixel > *  )

inline

Definition at line 503 of file itkImageIOBase.h.

template<typename TPixel , unsigned VLength>

void itk::ImageIOBase::SetPixelTypeInfo ( const Matrix< TPixel, VLength, VLength > *  )

inline

Definition at line 511 of file itkImageIOBase.h.

template<typename TPixel >

void itk::ImageIOBase::SetPixelTypeInfo ( const std::complex< TPixel > *  )

inline

Definition at line 519 of file itkImageIOBase.h.

template<unsigned VLength>

void itk::ImageIOBase::SetPixelTypeInfo ( const Offset< VLength > *  )

inline

Definition at line 527 of file itkImageIOBase.h.

References LONG, and OFFSET.

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.

template<typename TPixel >

void itk::ImageIOBase::SetTypeInfo

(

const TPixel *

)

virtual void itk::ImageIOBase::SetUseCompression ( bool  _arg )

virtual

Set/Get a boolean to use the compression or not.

virtual void itk::ImageIOBase::SetUseStreamedReading ( bool  _arg )

virtual

Set/Get a boolean to use streaming while reading or not.

virtual void itk::ImageIOBase::SetUseStreamedWriting ( bool  _arg )

virtual

Set/Get a boolean to use streaming while writing or not.

virtual bool itk::ImageIOBase::SupportsDimension ( unsigned long  dim )

inlinevirtual

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 in itk::RawImageIO< TPixel, VImageDimension >, itk::MetaImageIO, and itk::NrrdImageIO.

Definition at line 370 of file itkImageIOBase.h.

virtual void itk::ImageIOBase::UseCompressionOff ( )

virtual

Set/Get a boolean to use the compression or not.

virtual void itk::ImageIOBase::UseCompressionOn ( )

virtual

Set/Get a boolean to use the compression or not.

virtual void itk::ImageIOBase::UseStreamedReadingOff ( )

virtual

Set/Get a boolean to use streaming while reading or not.

virtual void itk::ImageIOBase::UseStreamedReadingOn ( )

virtual

Set/Get a boolean to use streaming while reading or not.

virtual void itk::ImageIOBase::UseStreamedWritingOff ( )

virtual

Set/Get a boolean to use streaming while writing or not.

virtual void itk::ImageIOBase::UseStreamedWritingOn ( )

virtual

Set/Get a boolean to use streaming while writing or not.

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. The buffer is cast to a pointer to the beginning of the image data.

Implemented in itk::Bruker2DSEQImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::HDF5ImageIO, itk::GDCMImageIO, itk::FileListVideoIO, itk::OpenCVVideoIO, itk::IPLCommonImageIO, itk::StimulateImageIO, itk::VTKImageIO, itk::MRCImageIO, itk::NiftiImageIO, itk::MetaImageIO, itk::BioRadImageIO, itk::VoxBoCUBImageIO, itk::TIFFImageIO, itk::JPEG2000ImageIO, itk::JPEGImageIO, itk::LSMImageIO, itk::PNGImageIO, itk::NrrdImageIO, itk::BMPImageIO, and itk::GiplImageIO.

virtual void itk::ImageIOBase::WriteBufferAsASCII ( std::ostream &  os, const void *  buffer, IOComponentType  ctype, SizeType  numberOfBytesToWrite  )

protectedvirtual

Convenient method to write a buffer as ASCII text.

Reimplemented in itk::VTKImageIO.

virtual void itk::ImageIOBase::WriteImageInformation ( )

pure virtual

Writes the spacing and dimensions of the image. Assumes SetFileName has been called with a valid file name.

Implemented in itk::Bruker2DSEQImageIO, itk::RawImageIO< TPixel, VImageDimension >, itk::HDF5ImageIO, itk::GDCMImageIO, itk::FileListVideoIO, itk::OpenCVVideoIO, itk::IPLCommonImageIO, itk::StimulateImageIO, itk::VTKImageIO, itk::NiftiImageIO, itk::MetaImageIO, itk::BioRadImageIO, itk::VoxBoCUBImageIO, itk::TIFFImageIO, itk::JPEG2000ImageIO, itk::JPEGImageIO, itk::LSMImageIO, itk::PNGImageIO, itk::MRCImageIO, itk::NrrdImageIO, itk::BMPImageIO, and itk::GiplImageIO.

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 549 of file itkImageIOBase.h.

IOComponentType 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 546 of file itkImageIOBase.h.

std::vector< SizeValueType > itk::ImageIOBase::m_Dimensions

protected

The array which stores the number of pixels in the x, y, z directions.

Definition at line 580 of file itkImageIOBase.h.

std::vector< std::vector< double > > itk::ImageIOBase::m_Direction

protected

The arrays which store the direction cosines of the image.

Definition at line 590 of file itkImageIOBase.h.

std::string itk::ImageIOBase::m_FileName

protected

Filename to read

Definition at line 557 of file itkImageIOBase.h.

FileType itk::ImageIOBase::m_FileType

protected

Definition at line 551 of file itkImageIOBase.h.

bool itk::ImageIOBase::m_Initialized

protected

Does the ImageIOBase object have enough info to be of use?

Definition at line 554 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 577 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 561 of file itkImageIOBase.h.

unsigned int itk::ImageIOBase::m_NumberOfDimensions

protected

The number of independent dimensions in the image.

Definition at line 564 of file itkImageIOBase.h.

std::vector< double > itk::ImageIOBase::m_Origin

protected

The array which stores the origin of the image.

Definition at line 587 of file itkImageIOBase.h.

IOPixelType itk::ImageIOBase::m_PixelType

protected

Used internally to keep track of the type of the pixel.

Definition at line 542 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 584 of file itkImageIOBase.h.

std::vector< SizeType > 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 594 of file itkImageIOBase.h.

ArrayOfExtensionsType itk::ImageIOBase::m_SupportedReadExtensions

private

Definition at line 661 of file itkImageIOBase.h.

ArrayOfExtensionsType itk::ImageIOBase::m_SupportedWriteExtensions

private

Definition at line 662 of file itkImageIOBase.h.

bool itk::ImageIOBase::m_UseCompression

protected

Should we compress the data?

Definition at line 567 of file itkImageIOBase.h.

bool itk::ImageIOBase::m_UseStreamedReading

protected

Should we use streaming for reading

Definition at line 570 of file itkImageIOBase.h.

bool itk::ImageIOBase::m_UseStreamedWriting

protected

Should we use streaming for writing

Definition at line 573 of file itkImageIOBase.h.

---

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

• itkImageIOBase.h