#include <itkTIFFImageIO.h>

Detailed Description

ImageIO object for reading and writing TIFF images.

The compressors supported include "PackBits" (default), "JPEG", "DEFLATE" and may also include "LZW". Only the "JPEG" compressor supports the compression level for JPEG quality parameter in the range 0-100.

ITK Sphinx Examples:

<a href=
<a href=

Definition at line 48 of file itkTIFFImageIO.h.

Inheritance diagram for itk::TIFFImageIO:

Collaboration diagram for itk::TIFFImageIO:

Public Types
enum	{ NOFORMAT , RGB_ , GRAYSCALE , PALETTE_RGB , PALETTE_GRAYSCALE , OTHER }

enum	{ NoCompression , PackBits , JPEG , Deflate , LZW }

using	PaletteType = std::vector< RGBPixelType >

using	Pointer = SmartPointer< Self >

using	RGBPixelType = RGBPixel< unsigned short >

using	Self = TIFFImageIO

using	Superclass = ImageIOBase

Public Types inherited from itk::ImageIOBase
using	ArrayOfExtensionsType = std::vector< std::string >

using	BufferSizeType = itk::OffsetValueType

using	ConstPointer = SmartPointer< const Self >

using	IndexValueType = itk::IndexValueType

using	IOByteOrderEnum = itk::IOByteOrderEnum

using	IOComponentEnum = itk::IOComponentEnum

using	IOFileEnum = itk::IOFileEnum

using	Pointer = SmartPointer< Self >

using	Self = ImageIOBase

using	SizeType = itk::intmax_t

using	SizeValueType = itk::SizeValueType

using	Superclass = LightProcessObject

Public Types inherited from itk::LightProcessObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightProcessObject

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer< const Self >

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
bool	CanReadFile (const char *) override

bool	CanWriteFile (const char *) override

virtual const PaletteType &	GetColorPalette () const

const char *	GetNameOfClass () const override

void	Read (void *buffer) override

void	ReadImageInformation () override

virtual void	ReadVolume (void *buffer)

void	SetCompressionToDeflate ()

void	SetCompressionToJPEG ()

void	SetCompressionToLZW ()

void	SetCompressionToNoCompression ()

void	SetCompressionToPackBits ()

void	Write (const void *buffer) override

void	WriteImageInformation () override


virtual void	SetJPEGQuality (int _JPEGQuality)

virtual int	GetJPEGQuality () const


void	SetColorPalette (const PaletteType _arg)

Public Member Functions inherited from itk::ImageIOBase
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 (IOByteOrderEnum) const

virtual unsigned int	GetComponentSize () const

virtual IOComponentEnum	GetComponentType () const

virtual const std::type_info &	GetComponentTypeInfo () const

virtual int	GetCompressionLevel () const

virtual const std::string &	GetCompressor () const

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

virtual SizeValueType	GetDimensions (unsigned int i) const

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

std::string	GetFileTypeAsString (IOFileEnum) const

SizeType	GetImageSizeInBytes () const

SizeType	GetImageSizeInComponents () const

SizeType	GetImageSizeInPixels () const

virtual bool	GetIsReadAsScalarPlusPalette () const

const char *	GetNameOfClass () const override

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 IOComponentEnum _arg)

virtual void	SetCompressionLevel (int _arg)

virtual void	SetCompressor (std::string _c)

virtual void	SetDirection (unsigned int i, const std::vector< double > &direction)

virtual void	SetDirection (unsigned int i, const vnl_vector< double > &direction)

void	SetFileTypeToBinary ()

void	SetNumberOfDimensions (unsigned int)

virtual void	SetOrigin (unsigned int i, double origin)

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, SizeValueType dim)

virtual void	SetIORegion (ImageIORegion _arg)

virtual const ImageIORegion &	GetIORegion () const

virtual void	SetPixelType (const itk::CommonEnums::IOPixel _arg)

virtual itk::CommonEnums::IOPixel	GetPixelType () const

virtual void	SetNumberOfComponents (unsigned int _arg)

virtual const unsigned int &	GetNumberOfComponents () const

virtual void	SetUseCompression (bool _arg)

virtual bool	GetUseCompression () const

virtual void	UseCompressionOn ()

virtual void	SetUseStreamedReading (bool _arg)

virtual bool	GetUseStreamedReading () const

virtual void	UseStreamedReadingOn ()

virtual void	SetUseStreamedWriting (bool _arg)

virtual bool	GetUseStreamedWriting () const

virtual void	UseStreamedWritingOn ()

virtual void	SetExpandRGBPalette (bool _arg)

virtual bool	GetExpandRGBPalette () const

virtual void	ExpandRGBPaletteOn ()

virtual void	SetWritePalette (bool _arg)

virtual bool	GetWritePalette () const

virtual void	WritePaletteOn ()

virtual void	SetFileType (const IOFileEnum _arg)

virtual IOFileEnum	GetFileType () const

void	SetFileTypeToASCII ()

virtual void	SetByteOrder (const IOByteOrderEnum _arg)

virtual IOByteOrderEnum	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<unsigned int VLength>
void	SetPixelTypeInfo (const Offset< VLength > *)

template<typename TPixel , unsigned int VLength>
void	SetPixelTypeInfo (const Vector< TPixel, VLength > *)

template<typename TCoordRep , unsigned int VPointDimension>
void	SetPixelTypeInfo (const Point< TCoordRep, VPointDimension > *)

template<typename TPixel , unsigned int VLength>
void	SetPixelTypeInfo (const CovariantVector< TPixel, VLength > *)

template<typename TPixel , unsigned int VLength>
void	SetPixelTypeInfo (const SymmetricSecondRankTensor< TPixel, VLength > *)

template<typename TPixel >
void	SetPixelTypeInfo (const DiffusionTensor3D< TPixel > *)

template<typename TPixel >
void	SetPixelTypeInfo (const std::complex< TPixel > *)

template<typename TPixel , unsigned int VLength>
void	SetPixelTypeInfo (const FixedArray< TPixel, VLength > *)

template<typename TPixel >
void	SetPixelTypeInfo (const VariableLengthVector< TPixel > *)

template<typename TValue >
void	SetPixelTypeInfo (const Array< TValue > *)

template<typename TPixel , unsigned int VLength>
void	SetPixelTypeInfo (const Matrix< TPixel, VLength, VLength > *)

template<typename TValue >
void	SetPixelTypeInfo (const VariableSizeMatrix< TValue > *)

Public Member Functions inherited from itk::LightProcessObject
virtual void	AbortGenerateDataOn ()

virtual const bool &	GetAbortGenerateData () const

const char *	GetNameOfClass () const override

virtual void	SetAbortGenerateData (bool _arg)

virtual void	UpdateOutputData ()

void	UpdateProgress (float amount)

virtual void	SetProgress (float _arg)

virtual const float &	GetProgress () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageIOBase
static std::string	GetComponentTypeAsString (IOComponentEnum)

static IOComponentEnum	GetComponentTypeFromString (const std::string &typeString)

static std::string	GetPixelTypeAsString (IOPixelEnum)

static IOPixelEnum	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 val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Protected Member Functions
bool	CanFindTIFFTag (unsigned int t)

void	GetColor (uint64_t index, uint16_t red, uint16_t green, uint16_t *blue)

unsigned int	GetFormat ()

void	InitializeColors ()

void	InternalSetCompressor (const std::string &_compressor) override

void	InternalWrite (const void *buffer)

void	PopulateColorPalette ()

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

void	ReadGenericImage (void *out, unsigned int width, unsigned int height)

void *	ReadRawByteFromTag (unsigned int t, unsigned int &value_count)

void	ReadTIFFTags ()

void	ReadTwoSamplesPerPixelImage (void *out, unsigned int width, unsigned int height)

void	SetCompression (int compression)

	TIFFImageIO ()

	~TIFFImageIO () override

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 const ImageRegionSplitterBase *	GetImageRegionSplitter () 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	InternalSetCompressor (const std::string &_compressor)

virtual void	OpenFileForReading (std::ifstream &inputStream, const std::string &filename, bool ascii=false)

virtual void	OpenFileForWriting (std::ofstream &outputStream, const std::string &filename, bool truncate=true, bool ascii=false)

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

virtual void	ReadBufferAsASCII (std::istream &is, void *buffer, IOComponentEnum ctype, SizeType numComp)

bool	ReadBufferAsBinary (std::istream &is, void *buffer, SizeType num)

virtual void	Reset (const bool freeDynamic=true)

void	Resize (const unsigned int numDimensions, const unsigned int *dimensions)

void	SetSupportedReadExtensions (const ArrayOfExtensionsType &)

void	SetSupportedWriteExtensions (const ArrayOfExtensionsType &)

virtual void	WriteBufferAsASCII (std::ostream &os, const void *buffer, IOComponentEnum ctype, SizeType numComp)

	~ImageIOBase () override

virtual bool	HasSupportedReadExtension (const char *fileName, bool ignoreCase=true)

virtual bool	HasSupportedWriteExtension (const char *fileName, bool ignoreCase=true)

virtual void	SetMaximumCompressionLevel (int)

virtual int	GetMaximumCompressionLevel () const

Protected Member Functions inherited from itk::LightProcessObject
virtual void	GenerateData ()

	LightProcessObject ()

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

	~LightProcessObject () override

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

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

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

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

virtual	~LightObject ()

Protected Attributes
PaletteType	m_ColorPalette {}

int	m_Compression {}

TIFFReaderInternal *	m_InternalImage {}

Protected Attributes inherited from itk::ImageIOBase
IOByteOrderEnum	m_ByteOrder { IOByteOrderEnum::OrderNotApplicable }

IOComponentEnum	m_ComponentType { IOComponentEnum::UNKNOWNCOMPONENTTYPE }

int	m_CompressionLevel { 30 }

std::string	m_Compressor { "uninitialized" }

std::vector< SizeValueType >	m_Dimensions {}

std::vector< std::vector< double > >	m_Direction {}

bool	m_ExpandRGBPalette {}

std::string	m_FileName {}

IOFileEnum	m_FileType { IOFileEnum::TypeNotApplicable }

bool	m_Initialized {}

ImageIORegion	m_IORegion {}

bool	m_IsReadAsScalarPlusPalette {}

int	m_MaximumCompressionLevel { 100 }

unsigned int	m_NumberOfComponents {}

unsigned int	m_NumberOfDimensions { 0 }

std::vector< double >	m_Origin {}

IOPixelEnum	m_PixelType { IOPixelEnum::SCALAR }

std::vector< double >	m_Spacing {}

std::vector< SizeType >	m_Strides {}

bool	m_UseCompression { false }

bool	m_UseStreamedReading {}

bool	m_UseStreamedWriting {}

bool	m_WritePalette {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Private Member Functions
void	AllocateTiffPalette (uint16_t bps)

template<typename TType >
void	PutGrayscale (TType to, TType from, unsigned int xsize, unsigned int ysize, unsigned int toskew, unsigned int fromskew)

template<typename TType , typename TFromType >
void	PutPaletteGrayscale (TType to, TFromType from, unsigned int xsize, unsigned int ysize, unsigned int toskew, unsigned int fromskew)

template<typename TType , typename TFromType >
void	PutPaletteRGB (TType to, TFromType from, unsigned int xsize, unsigned int ysize, unsigned int toskew, unsigned int fromskew)

template<typename TType , typename TFromType >
void	PutPaletteScalar (TType to, TFromType from, unsigned int xsize, unsigned int ysize, unsigned int toskew, unsigned int fromskew)

template<typename TType >
void	PutRGB_ (TType to, TType from, unsigned int xsize, unsigned int ysize, unsigned int toskew, unsigned int fromskew)

void	ReadCurrentPage (void *buffer, vcl_size_t pixelOffset)

template<typename TComponent >
void	ReadGenericImage (void *_out, unsigned int width, unsigned int height)

template<typename TComponent >
void	RGBAImageToBuffer (void out, const uint32_t tempImage)

Private Attributes
uint16_t *	m_ColorBlue {}

uint16_t *	m_ColorGreen {}

uint16_t *	m_ColorRed {}

unsigned int	m_ImageFormat { TIFFImageIO::NOFORMAT }

uint64_t	m_TotalColors { 0 }

Member Typedef Documentation

◆ PaletteType

using itk::TIFFImageIO::PaletteType = std::vector<RGBPixelType>

Definition at line 59 of file itkTIFFImageIO.h.

◆ Pointer

using itk::TIFFImageIO::Pointer = SmartPointer<Self>

Definition at line 56 of file itkTIFFImageIO.h.

◆ RGBPixelType

using itk::TIFFImageIO::RGBPixelType = RGBPixel<unsigned short>

Definition at line 58 of file itkTIFFImageIO.h.

◆ Self

using itk::TIFFImageIO::Self = TIFFImageIO

Standard class type aliases.

Definition at line 54 of file itkTIFFImageIO.h.

◆ Superclass

using itk::TIFFImageIO::Superclass = ImageIOBase

Definition at line 55 of file itkTIFFImageIO.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
NOFORMAT
RGB_
GRAYSCALE
PALETTE_RGB
PALETTE_GRAYSCALE
OTHER

Definition at line 103 of file itkTIFFImageIO.h.

◆ anonymous enum

anonymous enum

Enumerator
NoCompression
PackBits
JPEG
Deflate
LZW

Definition at line 114 of file itkTIFFImageIO.h.

Constructor & Destructor Documentation

◆ TIFFImageIO()

itk::TIFFImageIO::TIFFImageIO ( )

protected

◆ ~TIFFImageIO()

itk::TIFFImageIO::~TIFFImageIO ( )

overrideprotected

Member Function Documentation

◆ AllocateTiffPalette()

void itk::TIFFImageIO::AllocateTiffPalette ( uint16_t bps )

private

◆ CanFindTIFFTag()

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

protected

◆ CanReadFile()

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

overridevirtual

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

Implements itk::ImageIOBase.

Reimplemented in itk::LSMImageIO.

◆ CanWriteFile()

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

overridevirtual

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

Implements itk::ImageIOBase.

Reimplemented in itk::LSMImageIO.

◆ GetColor()

void itk::TIFFImageIO::GetColor	(	uint64_t	index,
		uint16_t *	red,
		uint16_t *	green,
		uint16_t *	blue
	)

protected

◆ GetColorPalette()

virtual const PaletteType & itk::TIFFImageIO::GetColorPalette ( ) const

virtual

Get a const ref to the palette of the image. In the case of non palette image or ExpandRGBPalette set to true, a vector of size 0 is returned. For multipage Images, only the palette of the first page is read

◆ GetFormat()

unsigned int itk::TIFFImageIO::GetFormat ( )

protected

◆ GetJPEGQuality()

virtual int itk::TIFFImageIO::GetJPEGQuality ( ) const

inlinevirtual

Set/Get the level of quality for the output images if Compression is JPEG. Settings vary from 1 to 100. 100 is the highest quality. Default is 75

Definition at line 169 of file itkTIFFImageIO.h.

◆ GetNameOfClass()

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ImageIOBase.

Reimplemented in itk::LSMImageIO.

◆ InitializeColors()

void itk::TIFFImageIO::InitializeColors ( )

protected

◆ InternalSetCompressor()

void itk::TIFFImageIO::InternalSetCompressor ( const std::string & _compressor )

overrideprotectedvirtual

Called when the compressor changes value. The compressor string is converted to uppercase for case insensitive comparisons.

Reimplemented from itk::ImageIOBase.

◆ InternalWrite()

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

protected

◆ New()

static Pointer itk::TIFFImageIO::New ( )

static

Method for creation through the object factory.

◆ PopulateColorPalette()

void itk::TIFFImageIO::PopulateColorPalette ( )

protected

◆ PrintSelf()

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

overrideprotectedvirtual

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.

◆ PutGrayscale()

template<typename TType >

void itk::TIFFImageIO::PutGrayscale	(	TType *	to,
		TType *	from,
		unsigned int	xsize,
		unsigned int	ysize,
		unsigned int	toskew,
		unsigned int	fromskew
	)

private

◆ PutPaletteGrayscale()

template<typename TType , typename TFromType >

void itk::TIFFImageIO::PutPaletteGrayscale	(	TType *	to,
		TFromType *	from,
		unsigned int	xsize,
		unsigned int	ysize,
		unsigned int	toskew,
		unsigned int	fromskew
	)

private

◆ PutPaletteRGB()

template<typename TType , typename TFromType >

void itk::TIFFImageIO::PutPaletteRGB	(	TType *	to,
		TFromType *	from,
		unsigned int	xsize,
		unsigned int	ysize,
		unsigned int	toskew,
		unsigned int	fromskew
	)

private

◆ PutPaletteScalar()

template<typename TType , typename TFromType >

void itk::TIFFImageIO::PutPaletteScalar	(	TType *	to,
		TFromType *	from,
		unsigned int	xsize,
		unsigned int	ysize,
		unsigned int	toskew,
		unsigned int	fromskew
	)

private

◆ PutRGB_()

template<typename TType >

void itk::TIFFImageIO::PutRGB_	(	TType *	to,
		TType *	from,
		unsigned int	xsize,
		unsigned int	ysize,
		unsigned int	toskew,
		unsigned int	fromskew
	)

private

◆ Read()

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

overridevirtual

Reads the data from disk into the memory buffer provided.

Implements itk::ImageIOBase.

Reimplemented in itk::LSMImageIO.

◆ ReadCurrentPage()

void itk::TIFFImageIO::ReadCurrentPage	(	void *	buffer,
		vcl_size_t	pixelOffset
	)

private

◆ ReadGenericImage() [1/2]

template<typename TComponent >

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

private

◆ ReadGenericImage() [2/2]

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

protected

◆ ReadImageInformation()

void itk::TIFFImageIO::ReadImageInformation ( )

overridevirtual

Set the spacing and dimension information for the set filename.

Implements itk::ImageIOBase.

Reimplemented in itk::LSMImageIO.

◆ ReadRawByteFromTag()

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

protected

◆ ReadTIFFTags()

void itk::TIFFImageIO::ReadTIFFTags ( )

protected

◆ ReadTwoSamplesPerPixelImage()

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

protected

◆ ReadVolume()

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

virtual

Reads 3D data from multi-pages tiff.

◆ RGBAImageToBuffer()

template<typename TComponent >

void itk::TIFFImageIO::RGBAImageToBuffer	(	void *	out,
		const uint32_t *	tempImage
	)

private

◆ SetColorPalette()

void itk::TIFFImageIO::SetColorPalette ( const PaletteType _arg )

inline

Set the palette of the image. For multipage images, the same palette is going to be used for all pages

Definition at line 185 of file itkTIFFImageIO.h.

◆ SetCompression()

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

inlineprotected

Definition at line 207 of file itkTIFFImageIO.h.

◆ SetCompressionToDeflate()

void itk::TIFFImageIO::SetCompressionToDeflate ( )

inline

Definition at line 147 of file itkTIFFImageIO.h.

◆ SetCompressionToJPEG()

void itk::TIFFImageIO::SetCompressionToJPEG ( )

inline

Definition at line 141 of file itkTIFFImageIO.h.

◆ SetCompressionToLZW()

void itk::TIFFImageIO::SetCompressionToLZW ( )

inline

Definition at line 153 of file itkTIFFImageIO.h.

◆ SetCompressionToNoCompression()

void itk::TIFFImageIO::SetCompressionToNoCompression ( )

inline

Set type and automatically enable/disable compression.

Since LZW compression is patented outside US, the additional work steps have to be taken in order to use that compression.

Definition at line 129 of file itkTIFFImageIO.h.

◆ SetCompressionToPackBits()

void itk::TIFFImageIO::SetCompressionToPackBits ( )

inline

Definition at line 135 of file itkTIFFImageIO.h.

◆ SetJPEGQuality()

virtual void itk::TIFFImageIO::SetJPEGQuality ( int _JPEGQuality )

inlinevirtual

Set/Get the level of quality for the output images if Compression is JPEG. Settings vary from 1 to 100. 100 is the highest quality. Default is 75

Definition at line 164 of file itkTIFFImageIO.h.

◆ Write()

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

overridevirtual

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.

◆ WriteImageInformation()

void itk::TIFFImageIO::WriteImageInformation ( )

overridevirtual

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

◆ m_ColorBlue

uint16_t* itk::TIFFImageIO::m_ColorBlue {}

private

Definition at line 311 of file itkTIFFImageIO.h.

◆ m_ColorGreen

uint16_t* itk::TIFFImageIO::m_ColorGreen {}

private

Definition at line 310 of file itkTIFFImageIO.h.

◆ m_ColorPalette

PaletteType itk::TIFFImageIO::m_ColorPalette {}

protected

Definition at line 251 of file itkTIFFImageIO.h.

◆ m_ColorRed

uint16_t* itk::TIFFImageIO::m_ColorRed {}

private

Definition at line 309 of file itkTIFFImageIO.h.

◆ m_Compression

int itk::TIFFImageIO::m_Compression {}

protected

Definition at line 249 of file itkTIFFImageIO.h.

◆ m_ImageFormat

unsigned int itk::TIFFImageIO::m_ImageFormat { TIFFImageIO::NOFORMAT }

private

Definition at line 313 of file itkTIFFImageIO.h.

◆ m_InternalImage

TIFFReaderInternal* itk::TIFFImageIO::m_InternalImage {}

protected

Definition at line 244 of file itkTIFFImageIO.h.

◆ m_TotalColors

uint64_t itk::TIFFImageIO::m_TotalColors { 0 }

private

Definition at line 312 of file itkTIFFImageIO.h.

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

itkTIFFImageIO.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Member Typedef Documentation

◆ PaletteType

◆ Pointer

◆ RGBPixelType

◆ Self

◆ Superclass

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

Constructor & Destructor Documentation

◆ TIFFImageIO()

◆ ~TIFFImageIO()

Member Function Documentation

◆ AllocateTiffPalette()

◆ CanFindTIFFTag()

◆ CanReadFile()

◆ CanWriteFile()

◆ GetColor()

◆ GetColorPalette()

◆ GetFormat()

◆ GetJPEGQuality()

◆ GetNameOfClass()

◆ InitializeColors()

◆ InternalSetCompressor()

◆ InternalWrite()

◆ New()

◆ PopulateColorPalette()

◆ PrintSelf()

◆ PutGrayscale()

◆ PutPaletteGrayscale()

◆ PutPaletteRGB()

◆ PutPaletteScalar()

◆ PutRGB_()

◆ Read()

◆ ReadCurrentPage()

◆ ReadGenericImage() [1/2]

◆ ReadGenericImage() [2/2]

◆ ReadImageInformation()

◆ ReadRawByteFromTag()

◆ ReadTIFFTags()

◆ ReadTwoSamplesPerPixelImage()

◆ ReadVolume()

◆ RGBAImageToBuffer()

◆ SetColorPalette()

◆ SetCompression()

◆ SetCompressionToDeflate()

◆ SetCompressionToJPEG()

◆ SetCompressionToLZW()

◆ SetCompressionToNoCompression()

◆ SetCompressionToPackBits()

◆ SetJPEGQuality()

◆ Write()

◆ WriteImageInformation()

Member Data Documentation

◆ m_ColorBlue

◆ m_ColorGreen

◆ m_ColorPalette

◆ m_ColorRed

◆ m_Compression

◆ m_ImageFormat

◆ m_InternalImage

◆ m_TotalColors