ITK  6.0.0
Insight 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
Data Processing Objects » Filters » Input and Output Filters

#include <itkImageSeriesReader.h>

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

Definition at line 45 of file 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

void EnlargeOutputRequestedRegion (DataObject *output) override
 
void GenerateOutputInformation () override
 
const FileNamesContainer & GetFileNames () const
 
DictionaryArrayRawPointer GetMetaDataDictionaryArray () const
 
virtual bool GetMetaDataDictionaryArrayUpdate () const
 
const char * GetNameOfClass () const override
 
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 SetForceOrthogonalDirection (bool _arg)
 
virtual bool GetForceOrthogonalDirection () const
 
virtual void ForceOrthogonalDirectionOn ()
 
virtual void SetImageIO (ImageIOBase *_arg)
 
virtual ImageIOBase * GetModifiableImageIO ()
 
virtual void SetUseStreaming (bool _arg)
 
virtual const bool & GetUseStreaming () const
 
virtual void UseStreamingOn ()
 
virtual void SetSpacingWarningRelThreshold (double _arg)
 
virtual double GetSpacingWarningRelThreshold () const
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
const char * GetNameOfClass () const override
 
OutputImageType * GetOutput (unsigned int idx)
 
OutputImageType * GetOutput ()
 
const OutputImageType * GetOutput () const
 
virtual void GraftOutput (DataObject *graft)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *graft)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderType * GetMultiThreader () const
 
const char * GetNameOfClass () const override
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdType & GetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *cmd) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
const char * GetNameOfClass () const override
 
virtual const TimeStamp & GetTimeStamp () 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) const
 
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
Pointer Clone () const
 
virtual Pointer CreateAnother () const
 
virtual void Delete ()
 
virtual const char * GetNameOfClass () const
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void SetReferenceCount (int)
 
virtual void UnRegister () const noexcept
 

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 val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

void GenerateData () override
 
 ImageSeriesReader ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageSeriesReader () override
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
void GenerateData () override
 
virtual const ImageRegionSplitterBase * GetImageRegionSplitter () const
 
 ImageSource ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
 ~ImageSource () override=default
 
virtual void ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateData ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObject * GetInput (const DataObjectIdentifierType &key)
 
const DataObject * GetInput (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
 
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 ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 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 idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyInputInformation () const
 
virtual void VerifyPreconditions () const
 
 ~ProcessObject () override
 
DataObject * GetInput (DataObjectPointerArraySizeType idx)
 
const DataObject * GetInput (DataObjectPointerArraySizeType idx) const
 
DataObject * GetPrimaryInput ()
 
const DataObject * GetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObject * GetOutput (const DataObjectIdentifierType &key)
 
const DataObject * GetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObject * GetOutput (DataObjectPointerArraySizeType i)
 
const DataObject * GetOutput (DataObjectPointerArraySizeType i) const
 
DataObject * GetPrimaryOutput ()
 
const DataObject * GetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

FileNamesContainer m_FileNames {}
 
bool m_ForceOrthogonalDirection { true }
 
ImageIOBase::Pointer m_ImageIO {}
 
DictionaryArrayType m_MetaDataDictionaryArray {}
 
unsigned int m_NumberOfDimensionsInImage { 0 }
 
bool m_ReverseOrder { false }
 
bool m_SpacingDefined { false }
 
double m_SpacingWarningRelThreshold { 1e-4 }
 
bool m_UseStreaming { true }
 
- Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool m_DynamicMultiThreading { true }
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Private Types

using ReaderType = ImageFileReader< TOutputImage >
 

Private Member Functions

int ComputeMovingDimensionIndex (ReaderType *reader)
 

Private Attributes

TimeStamp m_MetaDataDictionaryArrayMTime {}
 
bool m_MetaDataDictionaryArrayUpdate { true }
 

Additional Inherited Members

- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase * GetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)
 
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 

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

Definition at line 227 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

Definition at line 185 of file itkImageSeriesReader.h.

◆ ~ImageSeriesReader()

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

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

◆ 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.

◆ ForceOrthogonalDirectionOn()

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

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

◆ 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

Definition at line 95 of file itkImageSeriesReader.h.

◆ GetForceOrthogonalDirection()

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

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

◆ 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

◆ GetModifiableImageIO()

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.

◆ GetNameOfClass()

template<typename TOutputImage >
const char * itk::ImageSeriesReader< TOutputImage >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GetReverseOrder()

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

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

◆ GetSpacingWarningRelThreshold()

template<typename TOutputImage >
virtual double itk::ImageSeriesReader< TOutputImage >::GetSpacingWarningRelThreshold ( ) const
virtual

Set the relative threshold for issuing warnings about non-uniform sampling

◆ GetUseStreaming()

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

Set the stream On or Off

◆ MetaDataDictionaryArrayUpdateOn()

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

◆ 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

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::ImageSource< TOutputImage >.

◆ ReverseOrderOn()

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

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

◆ 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 reduce 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 traversal of the file names from last to first

◆ SetSpacingWarningRelThreshold()

template<typename TOutputImage >
virtual void itk::ImageSeriesReader< TOutputImage >::SetSpacingWarningRelThreshold ( double  _arg)
virtual

Set the relative threshold for issuing warnings about non-uniform sampling

◆ SetUseStreaming()

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

Set the stream On or Off

◆ UseStreamingOn()

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

Set the stream On or Off

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 207 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 204 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 mechanism.

Definition at line 198 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 218 of file itkImageSeriesReader.h.

◆ m_MetaDataDictionaryArrayMTime

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

Modified time of the MetaDataDictionaryArray

Definition at line 233 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 236 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 214 of file itkImageSeriesReader.h.

◆ m_ReverseOrder

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

Select the traversal order.

Definition at line 201 of file itkImageSeriesReader.h.

◆ m_SpacingDefined

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

Definition at line 222 of file itkImageSeriesReader.h.

◆ m_SpacingWarningRelThreshold

template<typename TOutputImage >
double itk::ImageSeriesReader< TOutputImage >::m_SpacingWarningRelThreshold { 1e-4 }
protected

Definition at line 224 of file itkImageSeriesReader.h.

◆ m_UseStreaming

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

Definition at line 220 of file itkImageSeriesReader.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.9.3