itk::TIFFImageIO Class Reference

#include <itkTIFFImageIO.h>

Inheritance diagram for itk::TIFFImageIO:

Collaboration diagram for itk::TIFFImageIO:

Detailed Description

ImageIO object for reading and writing TIFF images.

Wiki Examples:

• All Examples

• Write a TIFF image

Definition at line 44 of file itkTIFFImageIO.h.

Public Types
enum	{   NOFORMAT,   RGB_,   GRAYSCALE,   PALETTE_RGB,   PALETTE_GRAYSCALE,   OTHER }
enum	{   NoCompression,   PackBits,   JPEG,   Deflate,   LZW }
typedef SmartPointer< Self >	Pointer
typedef TIFFImageIO	Self
typedef ImageIOBase	Superclass
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 *)
virtual bool	CanWriteFile (const char *)
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
virtual void	Read (void *buffer)
virtual void	ReadImageInformation ()
virtual void	ReadTiles (void *buffer)
virtual void	ReadVolume (void *buffer)
void	SetCompression (int compression)
void	SetCompressionToDeflate ()
void	SetCompressionToJPEG ()
void	SetCompressionToLZW ()
void	SetCompressionToNoCompression ()
void	SetCompressionToPackBits ()
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 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 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
bool	CanFindTIFFTag (unsigned int t)
int	EvaluateImageAt (void *out, void *in)
void	GetColor (int index, unsigned short *red, unsigned short *green, unsigned short *blue)
unsigned int	GetFormat ()
void	InitializeColors ()
void	InternalWrite (const void *buffer)
void	PrintSelf (std::ostream &os, Indent indent) const
void	ReadGenericImage (void *out, unsigned int, unsigned int height)
void *	ReadRawByteFromTag (unsigned int t, short &value_count)
void	ReadTwoSamplesPerPixelImage (void *out, unsigned int, unsigned int height)
	TIFFImageIO ()
	~TIFFImageIO ()
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
int	m_Compression
TIFFReaderInternal *	m_InternalImage
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
void	operator= (const Self &)
	TIFFImageIO (const Self &)

Private Attributes
unsigned short *	m_ColorBlue
unsigned short *	m_ColorGreen
unsigned short *	m_ColorRed
unsigned int	m_ImageFormat
int	m_TotalColors

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

Member Typedef Documentation

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

Definition at line 50 of file itkTIFFImageIO.h.

typedef TIFFImageIO itk::TIFFImageIO::Self

Standard class typedefs.

Definition at line 48 of file itkTIFFImageIO.h.

typedef ImageIOBase itk::TIFFImageIO::Superclass

Definition at line 49 of file itkTIFFImageIO.h.

Member Enumeration Documentation

anonymous enum

Enumerator:

NOFORMAT
RGB_
GRAYSCALE
PALETTE_RGB
PALETTE_GRAYSCALE
OTHER

Definition at line 90 of file itkTIFFImageIO.h.

anonymous enum

Enumerator:

NoCompression
PackBits
JPEG
Deflate
LZW

Definition at line 93 of file itkTIFFImageIO.h.

Constructor & Destructor Documentation

itk::TIFFImageIO::TIFFImageIO ( )

protected

itk::TIFFImageIO::~TIFFImageIO ( )

protected

itk::TIFFImageIO::TIFFImageIO ( const Self &  )

private

Member Function Documentation

bool itk::TIFFImageIO::CanFindTIFFTag ( unsigned int  t )

protected

virtual bool itk::TIFFImageIO::CanReadFile ( const char *  )

virtual

Determine the file type. Returns true if this ImageIO can read the file specified.

Implements itk::ImageIOBase.

Reimplemented in itk::LSMImageIO.

virtual bool itk::TIFFImageIO::CanWriteFile ( const char *  )

virtual

Determine the file type. Returns true if this ImageIO can read the file specified.

Implements itk::ImageIOBase.

Reimplemented in itk::LSMImageIO.

virtual::itk::LightObject::Pointer itk::TIFFImageIO::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::LSMImageIO.

int itk::TIFFImageIO::EvaluateImageAt ( void *  out, void *  in  )

protected

void itk::TIFFImageIO::GetColor ( int  index, unsigned short *  red, unsigned short *  green, unsigned short *  blue  )

protected

unsigned int itk::TIFFImageIO::GetFormat ( )

protected

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageIOBase.

Reimplemented in itk::LSMImageIO.

void itk::TIFFImageIO::InitializeColors ( )

protected

void itk::TIFFImageIO::InternalWrite ( const void *  buffer )

protected

static Pointer itk::TIFFImageIO::New ( )

static

Method for creation through the object factory.

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

private

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

Reimplemented in itk::LSMImageIO.

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

virtual

Reads the data from disk into the memory buffer provided.

Implements itk::ImageIOBase.

Reimplemented in itk::LSMImageIO.

void itk::TIFFImageIO::ReadGenericImage ( void *  out, unsigned  int, unsigned int  height  )

protected

virtual void itk::TIFFImageIO::ReadImageInformation ( )

virtual

Set the spacing and diemention information for the set filename.

Implements itk::ImageIOBase.

Reimplemented in itk::LSMImageIO.

void* itk::TIFFImageIO::ReadRawByteFromTag ( unsigned int  t, short &  value_count  )

protected

virtual void itk::TIFFImageIO::ReadTiles ( void *  buffer )

virtual

Reads 3D data from tiled tiff.

void itk::TIFFImageIO::ReadTwoSamplesPerPixelImage ( void *  out, unsigned  int, unsigned int  height  )

protected

virtual void itk::TIFFImageIO::ReadVolume ( void *  buffer )

virtual

Reads 3D data from multi-pages tiff.

void itk::TIFFImageIO::SetCompression ( int  compression )

inline

Definition at line 111 of file itkTIFFImageIO.h.

void itk::TIFFImageIO::SetCompressionToDeflate ( )

inline

Definition at line 108 of file itkTIFFImageIO.h.

void itk::TIFFImageIO::SetCompressionToJPEG ( )

inline

Definition at line 107 of file itkTIFFImageIO.h.

void itk::TIFFImageIO::SetCompressionToLZW ( )

inline

Definition at line 109 of file itkTIFFImageIO.h.

void itk::TIFFImageIO::SetCompressionToNoCompression ( )

inline

Definition at line 105 of file itkTIFFImageIO.h.

void itk::TIFFImageIO::SetCompressionToPackBits ( )

inline

Definition at line 106 of file itkTIFFImageIO.h.

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

virtual

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

Implements itk::ImageIOBase.

Reimplemented in itk::LSMImageIO.

virtual void itk::TIFFImageIO::WriteImageInformation ( )

virtual

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

Implements itk::ImageIOBase.

Reimplemented in itk::LSMImageIO.

Member Data Documentation

unsigned short* itk::TIFFImageIO::m_ColorBlue

private

Definition at line 175 of file itkTIFFImageIO.h.

unsigned short* itk::TIFFImageIO::m_ColorGreen

private

Definition at line 174 of file itkTIFFImageIO.h.

unsigned short* itk::TIFFImageIO::m_ColorRed

private

Definition at line 173 of file itkTIFFImageIO.h.

int itk::TIFFImageIO::m_Compression

protected

Definition at line 167 of file itkTIFFImageIO.h.

unsigned int itk::TIFFImageIO::m_ImageFormat

private

Definition at line 177 of file itkTIFFImageIO.h.

TIFFReaderInternal* itk::TIFFImageIO::m_InternalImage

protected

Definition at line 165 of file itkTIFFImageIO.h.

int itk::TIFFImageIO::m_TotalColors

private

Definition at line 176 of file itkTIFFImageIO.h.

---

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

• itkTIFFImageIO.h