#include <itkIPLCommonImageIO.h>

Inheritance diagram for itk::IPLCommonImageIO:

Collaboration diagram for itk::IPLCommonImageIO:

Detailed Description

Class that defines how to read GE4 file format.

Author: Hans J. Johnson

Definition at line 49 of file itkIPLCommonImageIO.h.

Public Types
typedef float	F32

typedef double	F64

typedef SmartPointer< Self >	Pointer

typedef signed short	S16

typedef signed int	S32

typedef int64_t	S64

typedef signed char	S8

typedef IPLCommonImageIO	Self

typedef ImageIOBase	Superclass

typedef unsigned short	U16

typedef unsigned int	U32

typedef uint64_t	U64

typedef unsigned char	U8

Public Types inherited from itk::ImageIOBase
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 *FileNameToRead)

virtual bool	CanWriteFile (const char *FileNameToWrite)

virtual ::itk::LightObject::Pointer	CreateAnother (void) const

virtual unsigned int	GetComponentSize () const

virtual const char *	GetNameOfClass () const

virtual void	ModifyImageInformation ()

virtual void	Read (void *buffer)

virtual void	ReadImageInformation ()

virtual void	SortImageListByNameAscend ()

virtual void	SortImageListByNameDescend ()

virtual void	Write (const void *buffer)

virtual void	WriteImageInformation ()

Public Member Functions inherited from itk::ImageIOBase
virtual bool	CanStreamRead ()

virtual bool	CanStreamWrite ()

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 IOComponentType	GetComponentType () const

virtual const std::type_info &	GetComponentTypeInfo () const

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

virtual unsigned int	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 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

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	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 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 Pointer	New ()

Static Public Member Functions inherited from itk::ImageIOBase
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
int	AddElementToList (char const *const filename, const float sliceLocation, const int offset, const int XDim, const int YDim, const float XRes, const float YRes, const int Key1, const int Key2)

int	GetDoubleAt (std::ifstream &f, std::streamoff Offset, double *ip, bool throw_exception=true)

int	GetFloatAt (std::ifstream &f, std::streamoff Offset, float *ip, bool throw_exception=true)

int	GetIntAt (std::ifstream &f, std::streamoff Offset, int *ip, bool throw_exception=true)

int	GetShortAt (std::ifstream &f, std::streamoff Offset, short *ip, bool throw_exception=true)

int	GetStringAt (std::ifstream &f, std::streamoff Offset, char *buf, vcl_size_t amount, bool throw_exception=true)

double	hdr2Double (char *hdr)

float	hdr2Float (char *hdr)

int	hdr2Int (char *hdr)

short	hdr2Short (char *hdr)

	IPLCommonImageIO ()

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

virtual GEImageHeader *	ReadHeader (const char *FileNameToRead)

void	sortImageListAscend ()

void	sortImageListDescend ()

int	statTimeToAscii (void clock, char timeString, int len)

	~IPLCommonImageIO ()

Protected Member Functions inherited from itk::ImageIOBase
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 unsigned int	GetPixelSize () const

SizeType	GetRowStride () const

SizeType	GetSliceStride () const

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

	ImageIOBase ()

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
IPLFileNameList *	m_FilenameList

GEImageHeader *	m_ImageHeader

ImageIOBase::ByteOrder	m_SystemByteOrder

Protected Attributes inherited from itk::ImageIOBase
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
	IPLCommonImageIO (const Self &)

void	operator= (const Self &)

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

Member Typedef Documentation

typedef float itk::IPLCommonImageIO::F32

Definition at line 65 of file itkIPLCommonImageIO.h.

typedef double itk::IPLCommonImageIO::F64

Definition at line 66 of file itkIPLCommonImageIO.h.

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

Definition at line 55 of file itkIPLCommonImageIO.h.

typedef signed short itk::IPLCommonImageIO::S16

Definition at line 60 of file itkIPLCommonImageIO.h.

typedef signed int itk::IPLCommonImageIO::S32

Definition at line 62 of file itkIPLCommonImageIO.h.

typedef int64_t itk::IPLCommonImageIO::S64

Definition at line 64 of file itkIPLCommonImageIO.h.

typedef signed char itk::IPLCommonImageIO::S8

Definition at line 58 of file itkIPLCommonImageIO.h.

typedef IPLCommonImageIO itk::IPLCommonImageIO::Self

Standard class typedefs.

Definition at line 53 of file itkIPLCommonImageIO.h.

typedef ImageIOBase itk::IPLCommonImageIO::Superclass

Definition at line 54 of file itkIPLCommonImageIO.h.

typedef unsigned short itk::IPLCommonImageIO::U16

Definition at line 59 of file itkIPLCommonImageIO.h.

typedef unsigned int itk::IPLCommonImageIO::U32

Definition at line 61 of file itkIPLCommonImageIO.h.

typedef uint64_t itk::IPLCommonImageIO::U64

Definition at line 63 of file itkIPLCommonImageIO.h.

typedef unsigned char itk::IPLCommonImageIO::U8

Definition at line 57 of file itkIPLCommonImageIO.h.

Constructor & Destructor Documentation

itk::IPLCommonImageIO::IPLCommonImageIO ( )

protected

itk::IPLCommonImageIO::~IPLCommonImageIO ( )

protected

itk::IPLCommonImageIO::IPLCommonImageIO ( const Self & )

private

Member Function Documentation

int itk::IPLCommonImageIO::AddElementToList	(	char const *const	filename,
		const float	sliceLocation,
		const int	offset,
		const int	XDim,
		const int	YDim,
		const float	XRes,
		const float	YRes,
		const int	Key1,
		const int	Key2
	)

protected

virtual bool itk::IPLCommonImageIO::CanReadFile ( const char * FileNameToRead )

virtual

Determine if the file can be read with this ImageIO implementation.

Author: Hans J Johnson

Parameters

FileNameToRead The name of the file to test for reading.

Postcondition: Sets classes ImageIOBase::m_FileName variable to be FileNameToWrite

Returns: Returns true if this ImageIO can read the file specified.

Implements itk::ImageIOBase.

Reimplemented in itk::GE4ImageIO, itk::GE5ImageIO, itk::SiemensVisionImageIO, and itk::GEAdwImageIO.

virtual bool itk::IPLCommonImageIO::CanWriteFile ( const char * FileNameToWrite )

virtual

Determine if the file can be written with this ImageIO implementation.

Parameters

FileNameToWrite The name of the file to test for writing.

Author: Hans J. Johnson

Postcondition: Sets classes ImageIOBase::m_FileName variable to be FileNameToWrite

Returns: Returns true if this ImageIO can write the file specified.

Implements itk::ImageIOBase.

virtual::itk::LightObject::Pointer itk::IPLCommonImageIO::CreateAnother ( void ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightProcessObject.

Reimplemented in itk::GE4ImageIO, itk::GE5ImageIO, itk::SiemensVisionImageIO, and itk::GEAdwImageIO.

virtual unsigned int itk::IPLCommonImageIO::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.

Reimplemented from itk::ImageIOBase.

int itk::IPLCommonImageIO::GetDoubleAt	(	std::ifstream &	f,
		std::streamoff	Offset,
		double *	ip,
		bool	throw_exception = `true`
	)

protected

int itk::IPLCommonImageIO::GetFloatAt	(	std::ifstream &	f,
		std::streamoff	Offset,
		float *	ip,
		bool	throw_exception = `true`
	)

protected

int itk::IPLCommonImageIO::GetIntAt	(	std::ifstream &	f,
		std::streamoff	Offset,
		int *	ip,
		bool	throw_exception = `true`
	)

protected

virtual const char* itk::IPLCommonImageIO::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageIOBase.

Reimplemented in itk::GE4ImageIO, itk::GE5ImageIO, itk::SiemensVisionImageIO, and itk::GEAdwImageIO.

int itk::IPLCommonImageIO::GetShortAt	(	std::ifstream &	f,
		std::streamoff	Offset,
		short *	ip,
		bool	throw_exception = `true`
	)

protected

int itk::IPLCommonImageIO::GetStringAt	(	std::ifstream &	f,
		std::streamoff	Offset,
		char *	buf,
		vcl_size_t	amount,
		bool	throw_exception = `true`
	)

protected

double itk::IPLCommonImageIO::hdr2Double ( char * hdr )

protected

float itk::IPLCommonImageIO::hdr2Float ( char * hdr )

protected

int itk::IPLCommonImageIO::hdr2Int ( char * hdr )

protected

short itk::IPLCommonImageIO::hdr2Short ( char * hdr )

protected

virtual void itk::IPLCommonImageIO::ModifyImageInformation ( )

inlinevirtual

Optionally, modify spacing, origin and direction

Reimplemented in itk::GE5ImageIO.

Definition at line 88 of file itkIPLCommonImageIO.h.

static Pointer itk::IPLCommonImageIO::New ( )

static

Method for creation through the object factory.

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

private

void itk::IPLCommonImageIO::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::ImageIOBase.

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

virtual

Reads the data from disk into the memory buffer provided.

Implements itk::ImageIOBase.

virtual GEImageHeader* itk::IPLCommonImageIO::ReadHeader ( const char * FileNameToRead )

protectedvirtual

Reimplemented in itk::GE4ImageIO, itk::GE5ImageIO, itk::SiemensVisionImageIO, and itk::GEAdwImageIO.

virtual void itk::IPLCommonImageIO::ReadImageInformation ( )

virtual

Set the spacing and dimension information for the set filename.

Implements itk::ImageIOBase.

void itk::IPLCommonImageIO::sortImageListAscend ( )

protected

virtual void itk::IPLCommonImageIO::SortImageListByNameAscend ( )

virtual

Set sorting method by name ascending.

virtual void itk::IPLCommonImageIO::SortImageListByNameDescend ( )

virtual

Set sorting method by name descending.

void itk::IPLCommonImageIO::sortImageListDescend ( )

protected

int itk::IPLCommonImageIO::statTimeToAscii	(	void *	clock,
		char *	timeString,
		int	len
	)

protected

virtual void itk::IPLCommonImageIO::Write ( const void * buffer )

virtual

Writes the data to disk from the memory buffer provided. Make sure that the IORegions has been set properly.

Implements itk::ImageIOBase.

virtual void itk::IPLCommonImageIO::WriteImageInformation ( )

virtual

Set the spacing and dimension information for the set filename.

Implements itk::ImageIOBase.

Member Data Documentation

IPLFileNameList* itk::IPLCommonImageIO::m_FilenameList

protected

Definition at line 148 of file itkIPLCommonImageIO.h.

GEImageHeader* itk::IPLCommonImageIO::m_ImageHeader

protected

Definition at line 146 of file itkIPLCommonImageIO.h.

ImageIOBase::ByteOrder itk::IPLCommonImageIO::m_SystemByteOrder

protected

Definition at line 147 of file itkIPLCommonImageIO.h.

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

itkIPLCommonImageIO.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation