Data source that reads image data from a series of disk files. More...

#include <itkImageSeriesReader.h>

Inheritance diagram for itk::ImageSeriesReader< TOutputImage >:

Collaboration diagram for itk::ImageSeriesReader< TOutputImage >:

Public Types
typedef const DictionaryArrayType *	DictionaryArrayRawPointer
typedef std::vector < DictionaryRawPointer >	DictionaryArrayType
typedef MetaDataDictionary *	DictionaryRawPointer
typedef MetaDataDictionary	DictionaryType
typedef std::vector< std::string >	FileNamesContainer
typedef TOutputImage::RegionType	ImageRegionType
typedef TOutputImage::IndexType	IndexType
typedef TOutputImage::PixelType	OutputImagePixelType
typedef SmartPointer< Self >	Pointer
typedef ImageSeriesReader	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)
const FileNamesContainer &	GetFileNames () const
DictionaryArrayRawPointer	GetMetaDataDictionaryArray () const
virtual bool	GetMetaDataDictionaryArrayUpdate () const
virtual const char *	GetNameOfClass () const
virtual void	MetaDataDictionaryArrayUpdateOff ()
virtual void	MetaDataDictionaryArrayUpdateOn ()
virtual void	SetMetaDataDictionaryArrayUpdate (bool _arg)

void	SetFileNames (const FileNamesContainer &name)

void	SetFileName (std::string const &name)

void	AddFileName (std::string const &name)

virtual void	SetReverseOrder (bool _arg)
virtual bool	GetReverseOrder () const
virtual void	ReverseOrderOn ()
virtual void	ReverseOrderOff ()

virtual void	SetImageIO (ImageIOBase *_arg)
virtual ImageIOBase *	GetImageIO ()
Static Public Member Functions
static Pointer	New ()
Protected Member Functions
virtual void	GenerateData ()
Protected Attributes
FileNamesContainer	m_FileNames
ImageIOBase::Pointer	m_ImageIO
DictionaryArrayType	m_MetaDataDictionaryArray
unsigned int	m_NumberOfDimensionsInImage
bool	m_ReverseOrder
bool	m_UseStreaming
Private Types
typedef ImageFileReader < TOutputImage >	ReaderType
Private Member Functions
int	ComputeMovingDimensionIndex (ReaderType *reader)
	ImageSeriesReader (const Self &)
void	operator= (const Self &)
Private Attributes
TimeStamp	m_MetaDataDictionaryArrayMTime
bool	m_MetaDataDictionaryArrayUpdate
virtual void	SetUseStreaming (bool _arg)
virtual const bool &	GetUseStreaming ()
virtual void	UseStreamingOn ()
virtual void	UseStreamingOff ()
	ImageSeriesReader ()
	~ImageSeriesReader ()
void	PrintSelf (std::ostream &os, Indent indent) const

Detailed Description

template<class TOutputImage>
class itk::ImageSeriesReader< TOutputImage >

Data source that reads image data from a series of disk files.

This class builds an n-dimension image from multiple n-1 dimension image files. The files stored in a vector of strings are read using the ImageFileReader. File format may vary between the files, but the image data must have the same Size for all dimensions.

See also:: GDCMSeriesFileNames; NumericSeriesFileNames

Definition at line 44 of file itkImageSeriesReader.h.

Member Typedef Documentation

template<class TOutputImage >

typedef const DictionaryArrayType* itk::ImageSeriesReader< TOutputImage >::DictionaryArrayRawPointer

Definition at line 74 of file itkImageSeriesReader.h.

template<class TOutputImage >

typedef std::vector< DictionaryRawPointer > itk::ImageSeriesReader< TOutputImage >::DictionaryArrayType

Definition at line 73 of file itkImageSeriesReader.h.

template<class TOutputImage >

typedef MetaDataDictionary* itk::ImageSeriesReader< TOutputImage >::DictionaryRawPointer

Definition at line 72 of file itkImageSeriesReader.h.

template<class TOutputImage >

typedef MetaDataDictionary itk::ImageSeriesReader< TOutputImage >::DictionaryType

The pixel type of the output image.

Definition at line 71 of file itkImageSeriesReader.h.

template<class TOutputImage >

typedef std::vector< std::string > itk::ImageSeriesReader< TOutputImage >::FileNamesContainer

Definition at line 76 of file itkImageSeriesReader.h.

template<class TOutputImage >

typedef TOutputImage::RegionType itk::ImageSeriesReader< TOutputImage >::ImageRegionType

The region of the output image.

Definition at line 65 of file itkImageSeriesReader.h.

template<class TOutputImage >

typedef TOutputImage::IndexType itk::ImageSeriesReader< TOutputImage >::IndexType

The index of the output image.

Definition at line 62 of file itkImageSeriesReader.h.

template<class TOutputImage >

typedef TOutputImage::PixelType itk::ImageSeriesReader< TOutputImage >::OutputImagePixelType

The pixel type of the output image.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 68 of file itkImageSeriesReader.h.

template<class TOutputImage >

typedef SmartPointer< Self > itk::ImageSeriesReader< TOutputImage >::Pointer

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 50 of file itkImageSeriesReader.h.

template<class TOutputImage >

typedef ImageFileReader< TOutputImage > itk::ImageSeriesReader< TOutputImage >::ReaderType [private]

Definition at line 196 of file itkImageSeriesReader.h.

template<class TOutputImage >

typedef ImageSeriesReader itk::ImageSeriesReader< TOutputImage >::Self

Standard class typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 48 of file itkImageSeriesReader.h.

template<class TOutputImage >

typedef TOutputImage::SizeType itk::ImageSeriesReader< TOutputImage >::SizeType

The size of the output image.

Definition at line 56 of file itkImageSeriesReader.h.

template<class TOutputImage >

typedef ImageSource< TOutputImage > itk::ImageSeriesReader< TOutputImage >::Superclass

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 49 of file itkImageSeriesReader.h.

Constructor & Destructor Documentation

template<class TOutputImage >

itk::ImageSeriesReader< TOutputImage >::ImageSeriesReader ( ) [inline, protected]

Set the stream On or Off

Definition at line 162 of file itkImageSeriesReader.h.

template<class TOutputImage >

itk::ImageSeriesReader< TOutputImage >::~ImageSeriesReader ( ) [protected]

Set the stream On or Off

template<class TOutputImage >

itk::ImageSeriesReader< TOutputImage >::ImageSeriesReader ( const Self & ) [private]

Member Function Documentation

template<class TOutputImage >

void itk::ImageSeriesReader< TOutputImage >::AddFileName ( std::string const & name ) [inline]

Add a single filename to the list of files. To add a vector of filenames, use the AddFileNames method.

Definition at line 107 of file itkImageSeriesReader.h.

template<class TOutputImage >

int itk::ImageSeriesReader< TOutputImage >::ComputeMovingDimensionIndex ( ReaderType * reader ) [private]

template<class TOutputImage >

virtual::itk::LightObject::Pointer itk::ImageSeriesReader< TOutputImage >::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::Object.

template<class TOutputImage >

virtual void itk::ImageSeriesReader< TOutputImage >::EnlargeOutputRequestedRegion ( DataObject * output ) [virtual]

Give the reader a chance to indicate that it will produce more output than it was requested to produce. ImageSeriesReader cannot currently read a portion of an image (since the ImageIO objects cannot read a portion of an image), so the ImageSeriesReader must enlarge the RequestedRegion to the size of the image on disk.

Reimplemented from itk::ProcessObject.

template<class TOutputImage >

virtual void itk::ImageSeriesReader< TOutputImage >::GenerateData ( ) [protected, virtual]

Does the real work.

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TOutputImage >

virtual void itk::ImageSeriesReader< TOutputImage >::GenerateOutputInformation ( void ) [virtual]

Prepare the allocation of the output image during the first back propagation of the pipeline.

Reimplemented from itk::ProcessObject.

template<class TOutputImage >

const FileNamesContainer& itk::ImageSeriesReader< TOutputImage >::GetFileNames ( ) const [inline]

Definition at line 90 of file itkImageSeriesReader.h.

template<class TOutputImage >

virtual ImageIOBase* itk::ImageSeriesReader< TOutputImage >::GetImageIO ( ) [virtual]

Set/Get the ImageIO helper class. By default, the ImageSeriesReader uses the factory mechanism of the ImageFileReader to determine the file type. This method can be used to specify which IO to use.

template<class TOutputImage >

DictionaryArrayRawPointer itk::ImageSeriesReader< TOutputImage >::GetMetaDataDictionaryArray ( ) const

Get access to the Array of MetaDataDictionaries which are updated in the GenerateData methods

template<class TOutputImage >

virtual bool itk::ImageSeriesReader< TOutputImage >::GetMetaDataDictionaryArrayUpdate ( ) const [virtual]

template<class TOutputImage >

virtual const char* itk::ImageSeriesReader< TOutputImage >::GetNameOfClass ( ) const [virtual]

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TOutputImage >

virtual bool itk::ImageSeriesReader< TOutputImage >::GetReverseOrder ( ) const [virtual]

ReverseOrderOn changes the order of travesal of the file names from last to first

template<class TOutputImage >

virtual const bool& itk::ImageSeriesReader< TOutputImage >::GetUseStreaming ( ) [virtual]

Set the stream On or Off

template<class TOutputImage >

virtual void itk::ImageSeriesReader< TOutputImage >::MetaDataDictionaryArrayUpdateOff ( ) [virtual]

template<class TOutputImage >

virtual void itk::ImageSeriesReader< TOutputImage >::MetaDataDictionaryArrayUpdateOn ( ) [virtual]

template<class TOutputImage >

static Pointer itk::ImageSeriesReader< TOutputImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<class TOutputImage >

void itk::ImageSeriesReader< TOutputImage >::operator= ( const Self & ) [private]

Reimplemented from itk::ImageSource< TOutputImage >.

template<class TOutputImage >

void itk::ImageSeriesReader< TOutputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const `[protected, virtual]`

Set the stream On or Off

Reimplemented from itk::ProcessObject.

template<class TOutputImage >

virtual void itk::ImageSeriesReader< TOutputImage >::ReverseOrderOff ( ) [virtual]

ReverseOrderOn changes the order of travesal of the file names from last to first

template<class TOutputImage >

virtual void itk::ImageSeriesReader< TOutputImage >::ReverseOrderOn ( ) [virtual]

ReverseOrderOn changes the order of travesal of the file names from last to first

template<class TOutputImage >

void itk::ImageSeriesReader< TOutputImage >::SetFileName ( std::string const & name ) [inline]

Set the first file name to be processed. This deletes previous filenames.

Definition at line 97 of file itkImageSeriesReader.h.

template<class TOutputImage >

void itk::ImageSeriesReader< TOutputImage >::SetFileNames ( const FileNamesContainer & name ) [inline]

Set the vector of strings that contains the file names. Files are processed in sequential order.

Definition at line 80 of file itkImageSeriesReader.h.

template<class TOutputImage >

virtual void itk::ImageSeriesReader< TOutputImage >::SetImageIO ( ImageIOBase * _arg ) [virtual]

Set/Get the ImageIO helper class. By default, the ImageSeriesReader uses the factory mechanism of the ImageFileReader to determine the file type. This method can be used to specify which IO to use.

template<class TOutputImage >

virtual void itk::ImageSeriesReader< TOutputImage >::SetMetaDataDictionaryArrayUpdate ( bool _arg ) [virtual]

Set/Get MetaDataDictionaryArrayUpdate enables the updating of the MetaDataDictionaryArray.

By default this is enabled. It may be advantageous to disable this feature when streaming, if this array is not need, as it may redure the number of times each file is read.

/sa GetMetaDataDictionaryArray()

template<class TOutputImage >

virtual void itk::ImageSeriesReader< TOutputImage >::SetReverseOrder ( bool _arg ) [virtual]

ReverseOrderOn changes the order of travesal of the file names from last to first

template<class TOutputImage >

virtual void itk::ImageSeriesReader< TOutputImage >::SetUseStreaming ( bool _arg ) [virtual]

Set the stream On or Off

template<class TOutputImage >

virtual void itk::ImageSeriesReader< TOutputImage >::UseStreamingOff ( ) [virtual]

Set the stream On or Off

template<class TOutputImage >

virtual void itk::ImageSeriesReader< TOutputImage >::UseStreamingOn ( ) [virtual]

Set the stream On or Off

Member Data Documentation

template<class TOutputImage >

FileNamesContainer itk::ImageSeriesReader< TOutputImage >::m_FileNames [protected]

A list of filenames to be processed.

Definition at line 178 of file itkImageSeriesReader.h.

template<class TOutputImage >

ImageIOBase::Pointer itk::ImageSeriesReader< TOutputImage >::m_ImageIO [protected]

The image format, 0 will use the factory mechnism.

Definition at line 172 of file itkImageSeriesReader.h.

template<class TOutputImage >

DictionaryArrayType itk::ImageSeriesReader< TOutputImage >::m_MetaDataDictionaryArray [protected]

Array of MetaDataDictionaries. This allows to hold information from the ImageIO objects after reading every sub image in the series

Definition at line 189 of file itkImageSeriesReader.h.

template<class TOutputImage >

TimeStamp itk::ImageSeriesReader< TOutputImage >::m_MetaDataDictionaryArrayMTime [private]

Modified time of the MetaDataDictionaryArray

Definition at line 201 of file itkImageSeriesReader.h.

template<class TOutputImage >

bool itk::ImageSeriesReader< TOutputImage >::m_MetaDataDictionaryArrayUpdate [private]

Indicated if the MMDA should be updated

Definition at line 204 of file itkImageSeriesReader.h.

template<class TOutputImage >

unsigned int itk::ImageSeriesReader< TOutputImage >::m_NumberOfDimensionsInImage [protected]

The number of independent variables in the images that comprise the series. This is also used as the slice moving dimension index for the output image. That is for reading a series of 2D images into a 3D image, the moving dimension index is 2.

Definition at line 185 of file itkImageSeriesReader.h.

template<class TOutputImage >

bool itk::ImageSeriesReader< TOutputImage >::m_ReverseOrder [protected]

Select the traversal order.

Definition at line 175 of file itkImageSeriesReader.h.

template<class TOutputImage >

bool itk::ImageSeriesReader< TOutputImage >::m_UseStreaming [protected]

Definition at line 191 of file itkImageSeriesReader.h.

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

itkImageSeriesReader.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

template<class TOutputImage> class itk::ImageSeriesReader< TOutputImage >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TOutputImage>
class itk::ImageSeriesReader< TOutputImage >