ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
itk::ImageSeriesWriter< TInputImage, TOutputImage > Class Template Reference
Data Processing Objects » Filters » Input and Output FiltersGroup IO » | Module ITKIOImageBase

#include <itkImageSeriesWriter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage>
class itk::ImageSeriesWriter< TInputImage, TOutputImage >

Writes image data to a series of data files.

ImageSeriesWriter writes its input data to a series of output files. The writer is templated over an input image type and an output image type. Usually, the output image type will have fewer dimensions than the input image type. Each file has a name created using the SeriesFormat. This string is used as a snprintf argument to build a filename. The string should contain zero or one "%d" or equivalent. The "%d" is an incremental file number that starts at StartIndex and is incremented by IncrementIndex. Since this writer uses an internal instance of an ImageFileWriter, the type of file is determined by either the file extension or an ImageIO class if specified.

See also
ImageFileWriter
ImageIOBase
ImageSeriesReader
ITK Sphinx Examples:
Examples
Examples/IO/DicomSeriesReadSeriesWrite.cxx, Examples/IO/ImageReadDicomSeriesWrite.cxx, Examples/IO/ImageReadImageSeriesWrite.cxx, Examples/IO/RGBImageSeriesReadWrite.cxx, SphinxExamples/src/IO/GDCM/ResampleDICOMSeries/Code.cxx, and SphinxExamples/src/IO/ImageBase/GenerateSlicesFromVolume/Code.cxx.

Definition at line 85 of file itkImageSeriesWriter.h.

+ Inheritance diagram for itk::ImageSeriesWriter< TInputImage, TOutputImage >:
+ Collaboration diagram for itk::ImageSeriesWriter< TInputImage, TOutputImage >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using DictionaryArrayRawPointer = const DictionaryArrayType *
 
using DictionaryArrayType = std::vector< DictionaryRawPointer >
 
using DictionaryRawPointer = MetaDataDictionary *
 
using DictionaryType = MetaDataDictionary
 
using FileNamesContainer = std::vector< std::string >
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSeriesWriter
 
using Superclass = ProcessObject
 
using WriterType = ImageFileWriter< TOutputImage >
 
- 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

const FileNamesContainer & GetFileNames () const
 
const InputImageType * GetInput ()
 
const InputImageType * GetInput (unsigned int idx)
 
const char * GetNameOfClass () const override
 
void SetInput (const InputImageType *input)
 
virtual void SetMetaDataDictionaryArray (DictionaryArrayRawPointer _arg)
 
void Update () override
 
virtual void Write ()
 
virtual void SetImageIO (ImageIOBase *_arg)
 
virtual ImageIOBase * GetModifiableImageIO ()
 
virtual void SetStartIndex (SizeValueType _arg)
 
virtual SizeValueType GetStartIndex () const
 
virtual void SetIncrementIndex (SizeValueType _arg)
 
virtual SizeValueType GetIncrementIndex () const
 
virtual void SetSeriesFormat (const char *_arg)
 
virtual const char * GetSeriesFormat () const
 
void SetFileNames (const FileNamesContainer &name)
 
void SetFileName (const std::string &name)
 
void AddFileName (const std::string &name)
 
virtual void SetUseCompression (bool _arg)
 
virtual const bool & GetUseCompression () const
 
virtual void UseCompressionOn ()
 
- 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
 
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 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
 
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 void Delete ()
 
virtual int GetReferenceCount () const
 
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 val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

void GenerateData () override
 
void GenerateNumericFileNamesAndWrite ()
 
 ImageSeriesWriter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 ~ImageSeriesWriter () override=default
 
- 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 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 ()
 
 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
 
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 PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

ImageIOBase::Pointer m_ImageIO {}
 
bool m_UserSpecifiedImageIO { false }
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Private Member Functions

void GenerateNumericFileNames ()
 
void WriteFiles ()
 

Private Attributes

FileNamesContainer m_FileNames {}
 
SizeValueType m_IncrementIndex { 1 }
 
DictionaryArrayRawPointer m_MetaDataDictionaryArray { nullptr }
 
std::string m_SeriesFormat {}
 
SizeValueType m_StartIndex { 1 }
 
bool m_UseCompression {}
 

Additional Inherited Members

- 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

◆ ConstPointer

template<typename TInputImage , typename TOutputImage >
using itk::ImageSeriesWriter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 94 of file itkImageSeriesWriter.h.

◆ DictionaryArrayRawPointer

template<typename TInputImage , typename TOutputImage >
using itk::ImageSeriesWriter< TInputImage, TOutputImage >::DictionaryArrayRawPointer = const DictionaryArrayType *

Definition at line 114 of file itkImageSeriesWriter.h.

◆ DictionaryArrayType

template<typename TInputImage , typename TOutputImage >
using itk::ImageSeriesWriter< TInputImage, TOutputImage >::DictionaryArrayType = std::vector<DictionaryRawPointer>

Definition at line 113 of file itkImageSeriesWriter.h.

◆ DictionaryRawPointer

template<typename TInputImage , typename TOutputImage >
using itk::ImageSeriesWriter< TInputImage, TOutputImage >::DictionaryRawPointer = MetaDataDictionary *

Definition at line 112 of file itkImageSeriesWriter.h.

◆ DictionaryType

template<typename TInputImage , typename TOutputImage >
using itk::ImageSeriesWriter< TInputImage, TOutputImage >::DictionaryType = MetaDataDictionary

The pixel type of the output image.

Definition at line 111 of file itkImageSeriesWriter.h.

◆ FileNamesContainer

template<typename TInputImage , typename TOutputImage >
using itk::ImageSeriesWriter< TInputImage, TOutputImage >::FileNamesContainer = std::vector<std::string>

Definition at line 108 of file itkImageSeriesWriter.h.

◆ InputImageRegionType

template<typename TInputImage , typename TOutputImage >
using itk::ImageSeriesWriter< TInputImage, TOutputImage >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 104 of file itkImageSeriesWriter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage >
using itk::ImageSeriesWriter< TInputImage, TOutputImage >::InputImageType = TInputImage

Some convenient type alias.

Definition at line 103 of file itkImageSeriesWriter.h.

◆ OutputImageRegionType

template<typename TInputImage , typename TOutputImage >
using itk::ImageSeriesWriter< TInputImage, TOutputImage >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 106 of file itkImageSeriesWriter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage >
using itk::ImageSeriesWriter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 105 of file itkImageSeriesWriter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage >
using itk::ImageSeriesWriter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 93 of file itkImageSeriesWriter.h.

◆ Self

template<typename TInputImage , typename TOutputImage >
using itk::ImageSeriesWriter< TInputImage, TOutputImage >::Self = ImageSeriesWriter

Standard class type aliases.

Definition at line 91 of file itkImageSeriesWriter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage >
using itk::ImageSeriesWriter< TInputImage, TOutputImage >::Superclass = ProcessObject

Definition at line 92 of file itkImageSeriesWriter.h.

◆ WriterType

template<typename TInputImage , typename TOutputImage >
using itk::ImageSeriesWriter< TInputImage, TOutputImage >::WriterType = ImageFileWriter<TOutputImage>

Definition at line 107 of file itkImageSeriesWriter.h.

Constructor & Destructor Documentation

◆ ImageSeriesWriter()

template<typename TInputImage , typename TOutputImage >
itk::ImageSeriesWriter< TInputImage, TOutputImage >::ImageSeriesWriter ( )
protected

◆ ~ImageSeriesWriter()

template<typename TInputImage , typename TOutputImage >
itk::ImageSeriesWriter< TInputImage, TOutputImage >::~ImageSeriesWriter ( )
overrideprotecteddefault

Member Function Documentation

◆ AddFileName()

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

Add a single filename to the list of files. To add a vector of filenames, use the AddFileNames method.

Definition at line 205 of file itkImageSeriesWriter.h.

◆ GenerateData()

template<typename TInputImage , typename TOutputImage >
void itk::ImageSeriesWriter< TInputImage, TOutputImage >::GenerateData ( )
overrideprotectedvirtual

Does the real work.

Reimplemented from itk::ProcessObject.

◆ GenerateNumericFileNames()

template<typename TInputImage , typename TOutputImage >
void itk::ImageSeriesWriter< TInputImage, TOutputImage >::GenerateNumericFileNames ( )
private

◆ GenerateNumericFileNamesAndWrite()

template<typename TInputImage , typename TOutputImage >
void itk::ImageSeriesWriter< TInputImage, TOutputImage >::GenerateNumericFileNamesAndWrite ( )
protected

Transition method used for DEPRECATING old functionality. This method should be removed after release ITK 1.8

◆ GetFileNames()

template<typename TInputImage , typename TOutputImage >
const FileNamesContainer& itk::ImageSeriesWriter< TInputImage, TOutputImage >::GetFileNames ( ) const
inline

Definition at line 186 of file itkImageSeriesWriter.h.

◆ GetIncrementIndex()

template<typename TInputImage , typename TOutputImage >
virtual SizeValueType itk::ImageSeriesWriter< TInputImage, TOutputImage >::GetIncrementIndex ( ) const
virtual

Set the increment of the index of the series. The default value is 1.

◆ GetInput() [1/2]

template<typename TInputImage , typename TOutputImage >
const InputImageType* itk::ImageSeriesWriter< TInputImage, TOutputImage >::GetInput ( )

◆ GetInput() [2/2]

template<typename TInputImage , typename TOutputImage >
const InputImageType* itk::ImageSeriesWriter< TInputImage, TOutputImage >::GetInput ( unsigned int  idx)

◆ GetModifiableImageIO()

template<typename TInputImage , typename TOutputImage >
virtual ImageIOBase* itk::ImageSeriesWriter< TInputImage, TOutputImage >::GetModifiableImageIO ( )
virtual

Set/Get the ImageIO helper class. Usually this is created via the object factory mechanism that determines whether a particular ImageIO can write a certain file. This method provides a way to get the ImageIO instance that is created, or to manually set one when the factory mechanism may not work (e.g., for raw files or for non-standard file suffix).

◆ GetNameOfClass()

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

Reimplemented from itk::ProcessObject.

◆ GetSeriesFormat()

template<typename TInputImage , typename TOutputImage >
virtual const char* itk::ImageSeriesWriter< TInputImage, TOutputImage >::GetSeriesFormat ( ) const
virtual

The format string used to generate each filename in the series. The filename is built with snprintf(filename, length, SeriesFormat, number) where number starts at StartIndex and is incremented by IncrementIndex.

◆ GetStartIndex()

template<typename TInputImage , typename TOutputImage >
virtual SizeValueType itk::ImageSeriesWriter< TInputImage, TOutputImage >::GetStartIndex ( ) const
virtual

Use this method to set the starting index of the series. The default value is 1.

◆ GetUseCompression()

template<typename TInputImage , typename TOutputImage >
virtual const bool& itk::ImageSeriesWriter< TInputImage, TOutputImage >::GetUseCompression ( ) const
virtual

Set the compression On or Off

◆ New()

template<typename TInputImage , typename TOutputImage >
static Pointer itk::ImageSeriesWriter< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage >
void itk::ImageSeriesWriter< TInputImage, 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.

◆ SetFileName()

template<typename TInputImage , typename TOutputImage >
void itk::ImageSeriesWriter< TInputImage, TOutputImage >::SetFileName ( const std::string &  name)
inline

Set the first file name to be processed. This deletes previous filenames.

Definition at line 194 of file itkImageSeriesWriter.h.

◆ SetFileNames()

template<typename TInputImage , typename TOutputImage >
void itk::ImageSeriesWriter< TInputImage, TOutputImage >::SetFileNames ( const FileNamesContainer &  name)
inline

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

Definition at line 175 of file itkImageSeriesWriter.h.

◆ SetImageIO()

template<typename TInputImage , typename TOutputImage >
virtual void itk::ImageSeriesWriter< TInputImage, TOutputImage >::SetImageIO ( ImageIOBase *  _arg)
virtual

Set/Get the ImageIO helper class. Usually this is created via the object factory mechanism that determines whether a particular ImageIO can write a certain file. This method provides a way to get the ImageIO instance that is created, or to manually set one when the factory mechanism may not work (e.g., for raw files or for non-standard file suffix).

◆ SetIncrementIndex()

template<typename TInputImage , typename TOutputImage >
virtual void itk::ImageSeriesWriter< TInputImage, TOutputImage >::SetIncrementIndex ( SizeValueType  _arg)
virtual

Set the increment of the index of the series. The default value is 1.

◆ SetInput()

template<typename TInputImage , typename TOutputImage >
void itk::ImageSeriesWriter< TInputImage, TOutputImage >::SetInput ( const InputImageType *  input)

◆ SetMetaDataDictionaryArray()

template<typename TInputImage , typename TOutputImage >
virtual void itk::ImageSeriesWriter< TInputImage, TOutputImage >::SetMetaDataDictionaryArray ( DictionaryArrayRawPointer  _arg)
virtual

Set the array of MetaDataDictionaries this is an optional entry, mostly intended to be used when writing DICOM slices.

◆ SetSeriesFormat()

template<typename TInputImage , typename TOutputImage >
virtual void itk::ImageSeriesWriter< TInputImage, TOutputImage >::SetSeriesFormat ( const char *  _arg)
virtual

The format string used to generate each filename in the series. The filename is built with snprintf(filename, length, SeriesFormat, number) where number starts at StartIndex and is incremented by IncrementIndex.

◆ SetStartIndex()

template<typename TInputImage , typename TOutputImage >
virtual void itk::ImageSeriesWriter< TInputImage, TOutputImage >::SetStartIndex ( SizeValueType  _arg)
virtual

Use this method to set the starting index of the series. The default value is 1.

◆ SetUseCompression()

template<typename TInputImage , typename TOutputImage >
virtual void itk::ImageSeriesWriter< TInputImage, TOutputImage >::SetUseCompression ( bool  _arg)
virtual

Set the compression On or Off

◆ Update()

template<typename TInputImage , typename TOutputImage >
void itk::ImageSeriesWriter< TInputImage, TOutputImage >::Update ( )
inlineoverridevirtual

Aliased to the Write() method to be consistent with the rest of the pipeline.

Reimplemented from itk::ProcessObject.

Definition at line 147 of file itkImageSeriesWriter.h.

◆ UseCompressionOn()

template<typename TInputImage , typename TOutputImage >
virtual void itk::ImageSeriesWriter< TInputImage, TOutputImage >::UseCompressionOn ( )
virtual

Set the compression On or Off

◆ Write()

template<typename TInputImage , typename TOutputImage >
virtual void itk::ImageSeriesWriter< TInputImage, TOutputImage >::Write ( )
virtual

A special version of the Update() method for writers. It invokes start and end events and handles releasing data. It eventually calls GenerateData() which does the actual writing. The whole image is written.

◆ WriteFiles()

template<typename TInputImage , typename TOutputImage >
void itk::ImageSeriesWriter< TInputImage, TOutputImage >::WriteFiles ( )
private

Member Data Documentation

◆ m_FileNames

template<typename TInputImage , typename TOutputImage >
FileNamesContainer itk::ImageSeriesWriter< TInputImage, TOutputImage >::m_FileNames {}
private

A list of filenames to be processed.

Definition at line 244 of file itkImageSeriesWriter.h.

◆ m_ImageIO

template<typename TInputImage , typename TOutputImage >
ImageIOBase::Pointer itk::ImageSeriesWriter< TInputImage, TOutputImage >::m_ImageIO {}
protected

Definition at line 237 of file itkImageSeriesWriter.h.

◆ m_IncrementIndex

template<typename TInputImage , typename TOutputImage >
SizeValueType itk::ImageSeriesWriter< TInputImage, TOutputImage >::m_IncrementIndex { 1 }
private

Definition at line 253 of file itkImageSeriesWriter.h.

◆ m_MetaDataDictionaryArray

template<typename TInputImage , typename TOutputImage >
DictionaryArrayRawPointer itk::ImageSeriesWriter< TInputImage, TOutputImage >::m_MetaDataDictionaryArray { nullptr }
private

Array of MetaDataDictionary used for passing information to each slice

Definition at line 258 of file itkImageSeriesWriter.h.

◆ m_SeriesFormat

template<typename TInputImage , typename TOutputImage >
std::string itk::ImageSeriesWriter< TInputImage, TOutputImage >::m_SeriesFormat {}
private

These variables are used for generating filenames using a numeric approach This functionality is being DEPRECATED since it belongs to a NumericSeriesFileNames class. Removing this functionality from here allows to use additional SeriesFileNames such as the DICOM filenames generators.

Definition at line 251 of file itkImageSeriesWriter.h.

◆ m_StartIndex

template<typename TInputImage , typename TOutputImage >
SizeValueType itk::ImageSeriesWriter< TInputImage, TOutputImage >::m_StartIndex { 1 }
private

Definition at line 252 of file itkImageSeriesWriter.h.

◆ m_UseCompression

template<typename TInputImage , typename TOutputImage >
bool itk::ImageSeriesWriter< TInputImage, TOutputImage >::m_UseCompression {}
private

Definition at line 255 of file itkImageSeriesWriter.h.

◆ m_UserSpecifiedImageIO

template<typename TInputImage , typename TOutputImage >
bool itk::ImageSeriesWriter< TInputImage, TOutputImage >::m_UserSpecifiedImageIO { false }
protected

Definition at line 240 of file itkImageSeriesWriter.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.8.16