ITK  4.13.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 | List of all members
itk::ImageSeriesReader< TOutputImage > Class Template Reference

#include <itkImageSeriesReader.h>

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

Detailed Description

template<typename 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
Examples:
Examples/IO/DicomSeriesReadGaussianImageWrite.cxx, Examples/IO/DicomSeriesReadImageWrite.cxx, Examples/IO/DicomSeriesReadImageWrite2.cxx, Examples/IO/DicomSeriesReadPrintTags.cxx, Examples/IO/DicomSeriesReadSeriesWrite.cxx, Examples/IO/ImageSeriesReadWrite.cxx, Examples/IO/ImageSeriesReadWrite2.cxx, Examples/IO/RGBImageSeriesReadWrite.cxx, Examples/IO/VisibleHumanStreamReadWrite.cxx, SphinxExamples/src/Core/Common/ReRunPipelineWithChangingLargestPossibleRegion/Code.cxx, SphinxExamples/src/IO/DICOM/DicomSeriesReadImageWrite3/Code.cxx, WikiExamples/DICOM/ResampleDICOM.cxx, and WikiExamples/IO/VolumeFromSlices.cxx.

Definition at line 45 of file itkImageSeriesReader.h.

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::PixelType OutputImagePixelType
 
typedef OutputImageType::Pointer OutputImagePointer
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageSource Self
 
typedef ProcessObject Superclass
 
- Public Types inherited from itk::ProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef
DataObject::DataObjectIdentifierType 
DataObjectIdentifierType
 
typedef DataObject::Pointer DataObjectPointer
 
typedef std::vector
< DataObjectPointer
DataObjectPointerArray
 
typedef
DataObjectPointerArray::size_type 
DataObjectPointerArraySizeType
 
typedef std::vector
< DataObjectIdentifierType
NameArray
 
typedef SmartPointer< SelfPointer
 
typedef ProcessObject Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual void EnlargeOutputRequestedRegion (DataObject *output) override
 
virtual void GenerateOutputInformation (void) override
 
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 ImageIOBaseGetModifiableImageIO ()
 
virtual const ImageIOBaseGetImageIO () const
 
virtual void SetUseStreaming (bool _arg)
 
virtual const bool & GetUseStreaming () const
 
virtual void UseStreamingOn ()
 
virtual void UseStreamingOff ()
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *output)
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
virtual
ProcessObject::DataObjectPointer 
MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
void SetProgress (float progress)
 
virtual void SetReleaseDataFlag (bool flag)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void ReleaseDataBeforeUpdateFlagOff ()
 
virtual void SetNumberOfThreads (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfThreads () const
 
- 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 ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType 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 override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () 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 ()
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

virtual void GenerateData () override
 
 ImageSeriesReader ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageSeriesReader ()
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual const
ImageRegionSplitterBase
GetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, 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 &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
 itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
 
 itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
 
 itkLegacyMacro (virtual void RemoveInput(DataObject *input))
 
 itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
virtual void PopBackInput ()
 
virtual void PopFrontInput ()
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
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 (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName (void) const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
- 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
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Private Types

typedef ImageFileReader
< TOutputImage > 
ReaderType
 

Private Member Functions

int ComputeMovingDimensionIndex (ReaderType *reader)
 

Private Attributes

TimeStamp m_MetaDataDictionaryArrayMTime
 
bool m_MetaDataDictionaryArrayUpdate
 

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 const
ImageRegionSplitterBase
GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_TYPE ThreaderCallback (void *arg)
 

Member Typedef Documentation

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

Definition at line 75 of file itkImageSeriesReader.h.

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

Definition at line 74 of file itkImageSeriesReader.h.

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

Definition at line 73 of file itkImageSeriesReader.h.

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

The pixel type of the output image.

Definition at line 72 of file itkImageSeriesReader.h.

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

Definition at line 77 of file itkImageSeriesReader.h.

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

The region of the output image.

Definition at line 66 of file itkImageSeriesReader.h.

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

The index of the output image.

Definition at line 63 of file itkImageSeriesReader.h.

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

The pixel type of the output image.

Definition at line 69 of file itkImageSeriesReader.h.

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

Definition at line 51 of file itkImageSeriesReader.h.

template<typename TOutputImage >
typedef ImageFileReader< TOutputImage > itk::ImageSeriesReader< TOutputImage >::ReaderType
private

Definition at line 200 of file itkImageSeriesReader.h.

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

Standard class typedefs.

Definition at line 49 of file itkImageSeriesReader.h.

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

The size of the output image.

Definition at line 57 of file itkImageSeriesReader.h.

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

Definition at line 50 of file itkImageSeriesReader.h.

Constructor & Destructor Documentation

template<typename TOutputImage >
itk::ImageSeriesReader< TOutputImage >::ImageSeriesReader ( )
inlineprotected

Definition at line 164 of file itkImageSeriesReader.h.

template<typename TOutputImage >
itk::ImageSeriesReader< TOutputImage >::~ImageSeriesReader ( )
protected

Member Function Documentation

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

Add a single filename to the list of files.

Definition at line 107 of file itkImageSeriesReader.h.

template<typename TOutputImage >
int itk::ImageSeriesReader< TOutputImage >::ComputeMovingDimensionIndex ( ReaderType reader)
private
template<typename TOutputImage >
virtual::itk::LightObject::Pointer itk::ImageSeriesReader< TOutputImage >::CreateAnother ( ) 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<typename TOutputImage >
virtual void itk::ImageSeriesReader< TOutputImage >::EnlargeOutputRequestedRegion ( DataObject output)
overridevirtual

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<typename TOutputImage >
virtual void itk::ImageSeriesReader< TOutputImage >::GenerateData ( )
overrideprotectedvirtual

Does the real work.

Reimplemented from itk::ImageSource< TOutputImage >.

template<typename TOutputImage >
virtual void itk::ImageSeriesReader< TOutputImage >::GenerateOutputInformation ( void  )
overridevirtual

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

Reimplemented from itk::ProcessObject.

template<typename TOutputImage >
const FileNamesContainer& itk::ImageSeriesReader< TOutputImage >::GetFileNames ( ) const
inline

Definition at line 91 of file itkImageSeriesReader.h.

template<typename TOutputImage >
virtual const ImageIOBase* itk::ImageSeriesReader< TOutputImage >::GetImageIO ( ) const
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<typename TOutputImage >
DictionaryArrayRawPointer itk::ImageSeriesReader< TOutputImage >::GetMetaDataDictionaryArray ( ) const

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

template<typename TOutputImage >
virtual bool itk::ImageSeriesReader< TOutputImage >::GetMetaDataDictionaryArrayUpdate ( ) const
virtual
template<typename TOutputImage >
virtual ImageIOBase* itk::ImageSeriesReader< TOutputImage >::GetModifiableImageIO ( )
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<typename TOutputImage >
virtual const char* itk::ImageSeriesReader< TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

template<typename TOutputImage >
virtual bool itk::ImageSeriesReader< TOutputImage >::GetReverseOrder ( ) const
virtual

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

template<typename TOutputImage >
virtual const bool& itk::ImageSeriesReader< TOutputImage >::GetUseStreaming ( ) const
virtual

Set the stream On or Off

template<typename TOutputImage >
virtual void itk::ImageSeriesReader< TOutputImage >::MetaDataDictionaryArrayUpdateOff ( )
virtual
template<typename TOutputImage >
virtual void itk::ImageSeriesReader< TOutputImage >::MetaDataDictionaryArrayUpdateOn ( )
virtual
template<typename TOutputImage >
static Pointer itk::ImageSeriesReader< TOutputImage >::New ( )
static

Method for creation through the object factory.

template<typename TOutputImage >
void itk::ImageSeriesReader< TOutputImage >::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::ProcessObject.

template<typename TOutputImage >
virtual void itk::ImageSeriesReader< TOutputImage >::ReverseOrderOff ( )
virtual

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

template<typename TOutputImage >
virtual void itk::ImageSeriesReader< TOutputImage >::ReverseOrderOn ( )
virtual

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

template<typename 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 98 of file itkImageSeriesReader.h.

template<typename 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 81 of file itkImageSeriesReader.h.

template<typename 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<typename 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<typename 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<typename TOutputImage >
virtual void itk::ImageSeriesReader< TOutputImage >::SetUseStreaming ( bool  _arg)
virtual

Set the stream On or Off

template<typename TOutputImage >
virtual void itk::ImageSeriesReader< TOutputImage >::UseStreamingOff ( )
virtual

Set the stream On or Off

template<typename TOutputImage >
virtual void itk::ImageSeriesReader< TOutputImage >::UseStreamingOn ( )
virtual

Set the stream On or Off

Member Data Documentation

template<typename TOutputImage >
FileNamesContainer itk::ImageSeriesReader< TOutputImage >::m_FileNames
protected

A list of filenames to be processed.

Definition at line 184 of file itkImageSeriesReader.h.

template<typename TOutputImage >
ImageIOBase::Pointer itk::ImageSeriesReader< TOutputImage >::m_ImageIO
protected

The image format, 0 will use the factory mechnism.

Definition at line 178 of file itkImageSeriesReader.h.

template<typename 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 195 of file itkImageSeriesReader.h.

template<typename TOutputImage >
TimeStamp itk::ImageSeriesReader< TOutputImage >::m_MetaDataDictionaryArrayMTime
private

Modified time of the MetaDataDictionaryArray

Definition at line 207 of file itkImageSeriesReader.h.

template<typename TOutputImage >
bool itk::ImageSeriesReader< TOutputImage >::m_MetaDataDictionaryArrayUpdate
private

Indicated if the MMDA should be updated

Definition at line 210 of file itkImageSeriesReader.h.

template<typename 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 191 of file itkImageSeriesReader.h.

template<typename TOutputImage >
bool itk::ImageSeriesReader< TOutputImage >::m_ReverseOrder
protected

Select the traversal order.

Definition at line 181 of file itkImageSeriesReader.h.

template<typename TOutputImage >
bool itk::ImageSeriesReader< TOutputImage >::m_UseStreaming
protected

Definition at line 197 of file itkImageSeriesReader.h.


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