#include <itkImageFileReader.h>

Inheritance diagram for itk::ImageFileReader< TOutputImage, ConvertPixelTraits >:

Collaboration diagram for itk::ImageFileReader< TOutputImage, ConvertPixelTraits >:

Public Types
typedef TOutputImage::RegionType	ImageRegionType
typedef TOutputImage::IndexType	IndexType
typedef TOutputImage::InternalPixelType	OutputImagePixelType
typedef SmartPointer< Self >	Pointer
typedef ImageFileReader	Self
typedef TOutputImage::SizeType	SizeType
typedef ImageSource< TOutputImage >	Superclass
Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual void	EnlargeOutputRequestedRegion (DataObject *output)
virtual void	GenerateOutputInformation (void)
virtual ImageIOBase *	GetImageIO ()
virtual const char *	GetNameOfClass () const
	itkSetGetDecoratedInputMacro (FileName, std::string)
void	SetImageIO (ImageIOBase *imageIO)
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
void	DoConvertBuffer (void *buffer, vcl_size_t numberOfPixels)
virtual void	GenerateData ()
void	TestFileExistanceAndReadability ()
Protected Attributes
ImageIOBase::Pointer	m_ImageIO
bool	m_UserSpecifiedImageIO
bool	m_UseStreaming
Private Member Functions
	ImageFileReader (const Self &)
void	operator= (const Self &)
Private Attributes
ImageIORegion	m_ActualIORegion
std::string	m_ExceptionMessage
virtual void	SetUseStreaming (bool _arg)
virtual const bool &	GetUseStreaming ()
virtual void	UseStreamingOn ()
virtual void	UseStreamingOff ()
	ImageFileReader ()
	~ImageFileReader ()
void	PrintSelf (std::ostream &os, Indent indent) const

Detailed Description

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
class itk::ImageFileReader< TOutputImage, ConvertPixelTraits >

Data source that reads image data from a single file.

This source object is a general filter to read data from a variety of file formats. It works with a ImageIOBase subclass to actually do the reading of the data. Object factory machinery can be used to automatically create the ImageIOBase, or the ImageIOBase can be manually created and set. Note that this class reads data from a single file; if you wish to read data from a series of files use ImageSeriesReader.

TOutputImage is the type expected by the external users of the filter. If data stored in the file is stored in a different format then specified by TOutputImage, than this filter converts data between the file type and the external expected type. The ConvertTraits template argument is used to do the conversion.

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. Normally just setting the FileName with the appropriate suffix is enough to get the reader to instantiate the correct ImageIO and read the file properly. However, some files (like raw binary format) have no accepted suffix, so you will have to manually create the ImageIO instance of the write type.

See also:: ImageSeriesReader; ImageIOBase

Wiki Examples:

All Examples

Read an image file with an unknown number of components

Read an image file without knowing its type before hand

Read an image

Examples:: Image2.cxx, ImageLinearIteratorWithIndex.cxx, ImageRegionIterator.cxx, ImageRegionIteratorWithIndex.cxx, itkVectorImageTest.cxx, and RGBImage.cxx.

Definition at line 99 of file itkImageFileReader.h.