Main Page   Groups   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Concepts

itk::ImageSeriesReader< TOutputImage > Class Template Reference
[Input and Output Filters]

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

#include <itkImageSeriesReader.h>

Inheritance diagram for itk::ImageSeriesReader< TOutputImage >:

Inheritance graph
[legend]
Collaboration diagram for itk::ImageSeriesReader< TOutputImage >:

Collaboration graph
[legend]
List of all members.

Public Types

typedef ImageSeriesReader Self
typedef ImageSource< TOutputImage > Superclass
typedef SmartPointer< SelfPointer
typedef TOutputImage::SizeType SizeType
typedef TOutputImage::RegionType ImageRegionType
typedef TOutputImage::PixelType OutputImagePixelType
typedef MetaDataDictionary DictionaryType
typedef MetaDataDictionaryDictionaryRawPointer
typedef std::vector< DictionaryRawPointerDictionaryArrayType
typedef const DictionaryArrayTypeDictionaryArrayRawPointer
typedef std::vector< std::string > FileNamesContainer

Public Member Functions

virtual const char * GetNameOfClass () const
virtual void GenerateOutputInformation (void)
virtual void EnlargeOutputRequestedRegion (DataObject *output)
DictionaryArrayRawPointer GetMetaDataDictionaryArray () const
void SetFileNames (const FileNamesContainer &name)
const FileNamesContainerGetFileNames () const
void SetFileName (std::string const &name)
void AddFileName (std::string const &name)
virtual void SetReverseOrder (bool _arg)
virtual bool GetReverseOrder ()
virtual void ReverseOrderOn ()
virtual void ReverseOrderOff ()
virtual void SetImageIO (ImageIOBase *_arg)
virtual ImageIOBaseGetImageIO ()

Static Public Member Functions

Pointer New ()

Protected Member Functions

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

Protected Attributes

ImageIOBase::Pointer m_ImageIO
bool m_ReverseOrder
FileNamesContainer m_FileNames
int m_NumberOfDimensionsInImage
DictionaryArrayType m_MetaDataDictionaryArray

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:
DICOMSeriesFileNames

NumericSeriesFileNames

Definition at line 47 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.

Referenced by itk::ImageSeriesReader< TOutputImage >::GetFileNames(), itk::ImageSeriesReader< TOutputImage >::ImageSeriesReader(), and itk::ImageSeriesReader< TOutputImage >::SetFileNames().

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::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 53 of file itkImageSeriesReader.h.

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

Standard class typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 51 of file itkImageSeriesReader.h.

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

The size of the output image.

Definition at line 62 of file itkImageSeriesReader.h.

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

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 52 of file itkImageSeriesReader.h.


Constructor & Destructor Documentation

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

Definition at line 143 of file itkImageSeriesReader.h.

References itk::ImageSeriesReader< TOutputImage >::FileNamesContainer, and itk::ImageIOBase::Pointer.

template<class TOutputImage>
itk::ImageSeriesReader< TOutputImage >::~ImageSeriesReader  )  [protected]
 


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 106 of file itkImageSeriesReader.h.

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]
 

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

Definition at line 88 of file itkImageSeriesReader.h.

References itk::ImageSeriesReader< TOutputImage >::FileNamesContainer.

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

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  )  [virtual]
 

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

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

Method for creation through the object factory.

Reimplemented from itk::Object.

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

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::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 96 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.

References itk::ImageSeriesReader< TOutputImage >::FileNamesContainer.

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 >::SetReverseOrder bool  _arg  )  [virtual]
 

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


Member Data Documentation

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

A list of filenames to be processed.

Definition at line 157 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 151 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 165 of file itkImageSeriesReader.h.

template<class TOutputImage>
int itk::ImageSeriesReader< TOutputImage >::m_NumberOfDimensionsInImage [protected]
 

The number of independent variables in the images that comprise the series.

Definition at line 161 of file itkImageSeriesReader.h.

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

Select the traversal order.

Definition at line 154 of file itkImageSeriesReader.h.


The documentation for this class was generated from the following file:
Generated at Thu May 25 01:23:33 2006 for ITK by doxygen 1.3.5 written by Dimitri van Heesch, © 1997-2000