ITK  5.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | 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 >:

Public Types

using DictionaryArrayRawPointer = const DictionaryArrayType *
 
using DictionaryArrayType = std::vector< DictionaryRawPointer >
 
using DictionaryRawPointer = MetaDataDictionary *
 
using DictionaryType = MetaDataDictionary
 
using FileNamesContainer = std::vector< std::string >
 
using ImageRegionType = typename TOutputImage::RegionType
 
using IndexType = typename TOutputImage::IndexType
 
using OutputImagePixelType = typename TOutputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSeriesReader
 
using SizeType = typename TOutputImage::SizeType
 
using Superclass = ImageSource< TOutputImage >
 
- Public Types inherited from itk::ImageSource< TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSource
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
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 ()
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual const float & GetProgress () const
 
void UpdateProgress (float progress)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputInformation ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void ResetPipeline ()
 
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 SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () const
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void PrepareOutputs ()
 
- 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
 
void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
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 ()
 
using ReaderType = ImageFileReader< TOutputImage >
 
ImageIOBase::Pointer m_ImageIO
 
bool m_ReverseOrder { false }
 
bool m_ForceOrthogonalDirection { true }
 
FileNamesContainer m_FileNames
 
unsigned int m_NumberOfDimensionsInImage { 0 }
 
DictionaryArrayType m_MetaDataDictionaryArray
 
bool m_UseStreaming { true }
 
TimeStamp m_MetaDataDictionaryArrayMTime
 
bool m_MetaDataDictionaryArrayUpdate { true }
 
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 () const
 
virtual void ReverseOrderOn ()
 
virtual void ReverseOrderOff ()
 
virtual void SetForceOrthogonalDirection (bool _arg)
 
virtual bool GetForceOrthogonalDirection () const
 
virtual void ForceOrthogonalDirectionOn ()
 
virtual void ForceOrthogonalDirectionOff ()
 
virtual void SetImageIO (ImageIOBase *_arg)
 
virtual ImageIOBaseGetModifiableImageIO ()
 
virtual const ImageIOBaseGetImageIO () const
 
virtual void SetMetaDataDictionaryArrayUpdate (bool _arg)
 
virtual bool GetMetaDataDictionaryArrayUpdate () const
 
virtual void MetaDataDictionaryArrayUpdateOn ()
 
virtual void MetaDataDictionaryArrayUpdateOff ()
 
void GenerateOutputInformation () override
 
void EnlargeOutputRequestedRegion (DataObject *output) override
 
DictionaryArrayRawPointer GetMetaDataDictionaryArray () const
 
virtual void SetUseStreaming (bool _arg)
 
virtual const bool & GetUseStreaming () const
 
virtual void UseStreamingOn ()
 
virtual void UseStreamingOff ()
 
 ImageSeriesReader ()
 
 ~ImageSeriesReader () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void GenerateData () override
 
int ComputeMovingDimensionIndex (ReaderType *reader)
 

Additional Inherited Members

- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
 ImageSource ()
 
 ~ImageSource () override=default
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
virtual void AfterThreadedGenerateData ()
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
virtual void DynamicMultiThreadingOff ()
 
- Protected Member Functions inherited from itk::ProcessObject
 ProcessObject ()
 
 ~ProcessObject () override
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PopBackInput ()
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void PopFrontInput ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
virtual void VerifyPreconditions () ITKv5_CONST
 
virtual void VerifyInputInformation () ITKv5_CONST
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void RestoreInputReleaseDataFlags ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ()
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool m_DynamicMultiThreading
 
- Protected Attributes inherited from itk::ProcessObject
bool m_Updating
 
TimeStamp m_OutputInformationMTime
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount
 

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/GDCM/ReadDICOMSeriesAndWrite3DImage/Code.cxx, SphinxExamples/src/IO/GDCM/ResampleDICOMSeries/Code.cxx, and SphinxExamples/src/IO/ImageBase/Creade3DFromSeriesOf2D/Code.cxx.

Definition at line 45 of file itkImageSeriesReader.h.

Member Typedef Documentation

◆ DictionaryArrayRawPointer

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

Definition at line 77 of file itkImageSeriesReader.h.

◆ DictionaryArrayType

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

Definition at line 76 of file itkImageSeriesReader.h.

◆ DictionaryRawPointer

template<typename TOutputImage >
using itk::ImageSeriesReader< TOutputImage >::DictionaryRawPointer = MetaDataDictionary *

Definition at line 75 of file itkImageSeriesReader.h.

◆ DictionaryType

template<typename TOutputImage >
using itk::ImageSeriesReader< TOutputImage >::DictionaryType = MetaDataDictionary

The pixel type of the output image.

Definition at line 74 of file itkImageSeriesReader.h.

◆ FileNamesContainer

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

Definition at line 79 of file itkImageSeriesReader.h.

◆ ImageRegionType

template<typename TOutputImage >
using itk::ImageSeriesReader< TOutputImage >::ImageRegionType = typename TOutputImage::RegionType

The region of the output image.

Definition at line 68 of file itkImageSeriesReader.h.

◆ IndexType

template<typename TOutputImage >
using itk::ImageSeriesReader< TOutputImage >::IndexType = typename TOutputImage::IndexType

The index of the output image.

Definition at line 65 of file itkImageSeriesReader.h.

◆ OutputImagePixelType

template<typename TOutputImage >
using itk::ImageSeriesReader< TOutputImage >::OutputImagePixelType = typename TOutputImage::PixelType

The pixel type of the output image.

Definition at line 71 of file itkImageSeriesReader.h.

◆ Pointer

template<typename TOutputImage >
using itk::ImageSeriesReader< TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 53 of file itkImageSeriesReader.h.

◆ ReaderType

template<typename TOutputImage >
using itk::ImageSeriesReader< TOutputImage >::ReaderType = ImageFileReader<TOutputImage>
private

The image format, 0 will use the factory mechnism.

Definition at line 218 of file itkImageSeriesReader.h.

◆ Self

template<typename TOutputImage >
using itk::ImageSeriesReader< TOutputImage >::Self = ImageSeriesReader

Standard class type aliases.

Definition at line 51 of file itkImageSeriesReader.h.

◆ SizeType

template<typename TOutputImage >
using itk::ImageSeriesReader< TOutputImage >::SizeType = typename TOutputImage::SizeType

The size of the output image.

Definition at line 62 of file itkImageSeriesReader.h.

◆ Superclass

template<typename TOutputImage >
using itk::ImageSeriesReader< TOutputImage >::Superclass = ImageSource<TOutputImage>

Definition at line 52 of file itkImageSeriesReader.h.

Constructor & Destructor Documentation

◆ ImageSeriesReader()

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

The image format, 0 will use the factory mechnism.

Definition at line 180 of file itkImageSeriesReader.h.

◆ ~ImageSeriesReader()

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

The image format, 0 will use the factory mechnism.

Member Function Documentation

◆ AddFileName()

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

◆ ComputeMovingDimensionIndex()

template<typename TOutputImage >
int itk::ImageSeriesReader< TOutputImage >::ComputeMovingDimensionIndex ( ReaderType reader)
private

The image format, 0 will use the factory mechnism.

◆ CreateAnother()

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.

◆ EnlargeOutputRequestedRegion()

template<typename TOutputImage >
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.

◆ ForceOrthogonalDirectionOff()

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

The image format, 0 will use the factory mechnism.

◆ ForceOrthogonalDirectionOn()

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

The image format, 0 will use the factory mechnism.

◆ GenerateData()

template<typename TOutputImage >
void itk::ImageSeriesReader< TOutputImage >::GenerateData ( )
overrideprotectedvirtual

Does the real work.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GenerateOutputInformation()

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

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

Reimplemented from itk::ProcessObject.

◆ GetFileNames()

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

The image format, 0 will use the factory mechnism.

Definition at line 95 of file itkImageSeriesReader.h.

◆ GetForceOrthogonalDirection()

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

The image format, 0 will use the factory mechnism.

◆ GetImageIO()

template<typename TOutputImage >
virtual const ImageIOBase* itk::ImageSeriesReader< TOutputImage >::GetImageIO ( ) const
virtual

The image format, 0 will use the factory mechnism.

◆ GetMetaDataDictionaryArray()

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

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

◆ GetMetaDataDictionaryArrayUpdate()

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

The image format, 0 will use the factory mechnism.

◆ GetModifiableImageIO()

template<typename TOutputImage >
virtual ImageIOBase* itk::ImageSeriesReader< TOutputImage >::GetModifiableImageIO ( )
virtual

The image format, 0 will use the factory mechnism.

◆ GetNameOfClass()

template<typename TOutputImage >
virtual const char* itk::ImageSeriesReader< TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GetReverseOrder()

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

The image format, 0 will use the factory mechnism.

◆ GetUseStreaming()

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

The image format, 0 will use the factory mechnism.

◆ MetaDataDictionaryArrayUpdateOff()

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

The image format, 0 will use the factory mechnism.

◆ MetaDataDictionaryArrayUpdateOn()

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

The image format, 0 will use the factory mechnism.

◆ New()

template<typename TOutputImage >
static Pointer itk::ImageSeriesReader< TOutputImage >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TOutputImage >
void itk::ImageSeriesReader< TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

The image format, 0 will use the factory mechnism.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ ReverseOrderOff()

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

The image format, 0 will use the factory mechnism.

◆ ReverseOrderOn()

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

The image format, 0 will use the factory mechnism.

◆ SetFileName()

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

◆ SetFileNames()

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

◆ SetForceOrthogonalDirection()

template<typename TOutputImage >
virtual void itk::ImageSeriesReader< TOutputImage >::SetForceOrthogonalDirection ( bool  _arg)
virtual

Do we want to force orthogonal direction cosines? On by default. Turning it off enables proper reading of DICOM series with gantry tilt.

◆ SetImageIO()

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.

◆ SetMetaDataDictionaryArrayUpdate()

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

◆ SetReverseOrder()

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

◆ SetUseStreaming()

template<typename TOutputImage >
virtual void itk::ImageSeriesReader< TOutputImage >::SetUseStreaming ( bool  _arg)
virtual

Set the stream On or Off

◆ UseStreamingOff()

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

The image format, 0 will use the factory mechnism.

◆ UseStreamingOn()

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

The image format, 0 will use the factory mechnism.

Member Data Documentation

◆ m_FileNames

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

A list of filenames to be processed.

Definition at line 202 of file itkImageSeriesReader.h.

◆ m_ForceOrthogonalDirection

template<typename TOutputImage >
bool itk::ImageSeriesReader< TOutputImage >::m_ForceOrthogonalDirection { true }
protected

Do we want to force orthogonal direction cosines?

Definition at line 199 of file itkImageSeriesReader.h.

◆ m_ImageIO

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

The image format, 0 will use the factory mechnism.

Definition at line 193 of file itkImageSeriesReader.h.

◆ m_MetaDataDictionaryArray

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

◆ m_MetaDataDictionaryArrayMTime

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

Modified time of the MetaDataDictionaryArray

Definition at line 224 of file itkImageSeriesReader.h.

◆ m_MetaDataDictionaryArrayUpdate

template<typename TOutputImage >
bool itk::ImageSeriesReader< TOutputImage >::m_MetaDataDictionaryArrayUpdate { true }
private

Indicated if the MMDA should be updated

Definition at line 227 of file itkImageSeriesReader.h.

◆ m_NumberOfDimensionsInImage

template<typename TOutputImage >
unsigned int itk::ImageSeriesReader< TOutputImage >::m_NumberOfDimensionsInImage { 0 }
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 209 of file itkImageSeriesReader.h.

◆ m_ReverseOrder

template<typename TOutputImage >
bool itk::ImageSeriesReader< TOutputImage >::m_ReverseOrder { false }
protected

Select the traversal order.

Definition at line 196 of file itkImageSeriesReader.h.

◆ m_UseStreaming

template<typename TOutputImage >
bool itk::ImageSeriesReader< TOutputImage >::m_UseStreaming { true }
protected

The image format, 0 will use the factory mechnism.

Definition at line 215 of file itkImageSeriesReader.h.


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