ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Types | Private Member Functions | Private Attributes
itk::ImageSeriesReader< TOutputImage > Class Template Reference

#include <itkImageSeriesReader.h>

+ Inheritance diagram for itk::ImageSeriesReader< TOutputImage >:
+ Collaboration diagram for itk::ImageSeriesReader< TOutputImage >:

List of all members.

Public Types

typedef const DictionaryArrayTypeDictionaryArrayRawPointer
typedef std::vector
< DictionaryRawPointer
DictionaryArrayType
typedef MetaDataDictionaryDictionaryRawPointer
typedef MetaDataDictionary DictionaryType
typedef std::vector< std::string > FileNamesContainer
typedef TOutputImage::RegionType ImageRegionType
typedef TOutputImage::IndexType IndexType
typedef TOutputImage::PixelType OutputImagePixelType
typedef SmartPointer< SelfPointer
typedef ImageSeriesReader Self
typedef TOutputImage::SizeType SizeType
typedef ImageSource< TOutputImage > Superclass
- Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const SelfConstPointer
typedef
Superclass::DataObjectIdentifierType 
DataObjectIdentifierType
typedef DataObject::Pointer DataObjectPointer
typedef
Superclass::DataObjectPointerArraySizeType 
DataObjectPointerArraySizeType
typedef OutputImageType::Pointer OutputImagePointer
typedef OutputImageType::RegionType OutputImageRegionType
typedef TOutputImage OutputImageType
- Public Types inherited from itk::ProcessObject
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
typedef std::vector
< DataObjectIdentifierType
NameArray
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual void EnlargeOutputRequestedRegion (DataObject *output)
virtual void GenerateOutputInformation (void)
const FileNamesContainerGetFileNames () 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 ImageIOBaseGetImageIO ()
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
virtual void GraftOutput (DataObject *output)
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
OutputImageTypeGetOutput (void)
const OutputImageTypeGetOutput (void) const
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
virtual void AbortGenerateDataOn ()
virtual const bool & GetAbortGenerateData ()
NameArray GetInputNames () const
MultiThreader * GetMultiThreader () const
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
DataObjectPointerArraySizeType GetNumberOfInputs () const
DataObjectPointerArraySizeType GetNumberOfOutputs () const
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
NameArray GetOutputNames () const
virtual const float & GetProgress ()
NameArray GetRequiredInputNames () const
bool HasInput (const DataObjectIdentifierType &key) const
bool HasOutput (const DataObjectIdentifierType &key) const
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
virtual void PrepareOutputs ()
virtual void PropagateRequestedRegion (DataObject *output)
virtual void ResetPipeline ()
virtual void SetAbortGenerateData (bool _arg)
virtual void SetProgress (float _arg)
virtual void Update ()
virtual void UpdateLargestPossibleRegion ()
virtual void UpdateOutputData (DataObject *output)
virtual void UpdateOutputInformation ()
void UpdateProgress (float amount)
DataObjectPointerArray GetInputs ()
DataObjectPointerArray GetOutputs ()
DataObjectPointerArray GetIndexedInputs ()
DataObjectPointerArray GetIndexedOutputs ()
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
virtual void SetReleaseDataFlag (bool flag)
virtual bool GetReleaseDataFlag () const
void ReleaseDataFlagOn ()
void ReleaseDataFlagOff ()
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual const bool & GetReleaseDataBeforeUpdateFlag ()
virtual void ReleaseDataBeforeUpdateFlagOn ()
virtual void ReleaseDataBeforeUpdateFlagOff ()
virtual void SetNumberOfThreads (ThreadIdType _arg)
virtual const ThreadIdTypeGetNumberOfThreads ()
- 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
CommandGetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionaryGetMetaDataDictionary (void)
const MetaDataDictionaryGetMetaDataDictionary (void) const
virtual unsigned long GetMTime () const
virtual const TimeStampGetTimeStamp () 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 ()

Protected Member Functions

virtual void GenerateData ()
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
virtual void AllocateOutputs ()
virtual void BeforeThreadedGenerateData ()
 ImageSource ()
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual ~ImageSource ()
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
virtual void AddOutput (DataObject *output)
bool AddRequiredInputName (const DataObjectIdentifierType &)
virtual void CacheInputReleaseDataFlags ()
virtual void GenerateInputRequestedRegion ()
virtual void GenerateOutputRequestedRegion (DataObject *output)
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs ()
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs ()
bool IsIndexedName (const DataObjectIdentifierType &) const
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType MakeNameFromIndex (DataObjectPointerArraySizeType) const
 ProcessObject ()
virtual void PropagateResetPipeline ()
virtual void ReleaseInputs ()
virtual void RemoveInput (const DataObjectIdentifierType &key)
virtual void RemoveInput (DataObjectPointerArraySizeType)
virtual void RemoveOutput (const DataObjectIdentifierType &key)
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void RestoreInputReleaseDataFlags ()
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void SetPrimaryInput (DataObject *input)
virtual void SetPrimaryOutput (DataObject *output)
void SetRequiredInputNames (const NameArray &)
virtual void VerifyInputInformation ()
virtual void VerifyPreconditions ()
 ~ProcessObject ()
DataObjectGetInput (const DataObjectIdentifierType &key)
const DataObjectGetInput (const DataObjectIdentifierType &key) const
DataObjectGetInput (DataObjectPointerArraySizeType)
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryInput ()
const DataObjectGetPrimaryInput () const
DataObjectGetOutput (const DataObjectIdentifierType &key)
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
DataObjectGetPrimaryOutput ()
const DataObjectGetPrimaryOutput () const
virtual void PushBackInput (const DataObject *input)
virtual void PopBackInput ()
virtual void PushFrontInput (const DataObject *input)
virtual void PopFrontInput ()
- 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

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

Additional Inherited Members

- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static const unsigned int OutputImageDimension = TOutputImage::ImageDimension
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)

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 ( )
inlineprotected

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 ( )
protectedvirtual

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
protectedvirtual

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: