ITK  4.6.0
Insight Segmentation and Registration 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

#include <itkImageSeriesWriter.h>

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

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 sprintf 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
Examples:
IO/DicomSeriesReadSeriesWrite.cxx, IO/ImageReadDicomSeriesWrite.cxx, IO/ImageReadImageSeriesWrite.cxx, and IO/RGBImageSeriesReadWrite.cxx.

Definition at line 83 of file itkImageSeriesWriter.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef const DictionaryArrayTypeDictionaryArrayRawPointer
 
typedef std::vector
< DictionaryRawPointer
DictionaryArrayType
 
typedef MetaDataDictionaryDictionaryRawPointer
 
typedef MetaDataDictionary DictionaryType
 
typedef std::vector< std::string > FileNamesContainer
 
typedef InputImageType::RegionType InputImageRegionType
 
typedef TInputImage InputImageType
 
typedef OutputImageType::RegionType OutputImageRegionType
 
typedef TOutputImage OutputImageType
 
typedef SmartPointer< SelfPointer
 
typedef ImageSeriesWriter Self
 
typedef ProcessObject Superclass
 
typedef ImageFileWriter
< TOutputImage > 
WriterType
 
- 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 (void) const
 
const FileNamesContainerGetFileNames () const
 
const InputImageTypeGetInput (void)
 
const InputImageTypeGetInput (unsigned int idx)
 
virtual const char * GetNameOfClass () const
 
void SetInput (const InputImageType *input)
 
virtual void SetMetaDataDictionaryArray (DictionaryArrayRawPointer _arg)
 
virtual void Update () ITK_OVERRIDE
 
virtual void Write (void)
 
virtual void SetImageIO (ImageIOBase *_arg)
 
virtual ImageIOBaseGetModifiableImageIO ()
 
virtual const ImageIOBaseGetImageIO () const
 
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 (std::string const &name)
 
void AddFileName (std::string const &name)
 
virtual void SetUseCompression (bool _arg)
 
virtual const bool & GetUseCompression () const
 
virtual void UseCompressionOn ()
 
virtual void UseCompressionOff ()
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
NameArray GetInputNames () const
 
MultiThreader * GetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual
DataObjectPointerArraySizeType 
GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
virtual const float & GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual DataObjectPointer MakeOutput (DataObjectPointerArraySizeType idx)
 
virtual DataObjectPointer MakeOutput (const DataObjectIdentifierType &)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
DataObjectPointerArray GetInputs ()
 
DataObjectPointerArray GetOutputs ()
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
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 (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) 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 ITK_OVERRIDE
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
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 (void) ITK_OVERRIDE
 
void GenerateNumericFileNamesAndWrite (void)
 
 ImageSeriesWriter ()
 
virtual void PrintSelf (std::ostream &os, Indent indent) const ITK_OVERRIDE
 
 ~ImageSeriesWriter ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
virtual void AddOutput (DataObject *output)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateInputRequestedRegion ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (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
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
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 SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *input)
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void VerifyInputInformation ()
 
virtual void VerifyPreconditions ()
 
 ~ProcessObject ()
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PopBackInput ()
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void PopFrontInput ()
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName (void) const
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const
DataObjectPointerArraySizeType
GetNumberOfRequiredInputs () const
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
void SetRequiredInputNames (const NameArray &)
 
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

ImageIOBase::Pointer m_ImageIO
 
bool m_UserSpecifiedImageIO
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime
 
bool m_Updating
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Private Member Functions

void GenerateNumericFileNames (void)
 
 ImageSeriesWriter (const Self &)
 
void operator= (const Self &)
 
void WriteFiles ()
 

Private Attributes

FileNamesContainer m_FileNames
 
SizeValueType m_IncrementIndex
 
DictionaryArrayRawPointer m_MetaDataDictionaryArray
 
std::string m_SeriesFormat
 
SizeValueType m_StartIndex
 
bool m_UseCompression
 

Additional Inherited Members

- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 

Member Typedef Documentation

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

Definition at line 90 of file itkImageSeriesWriter.h.

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

Definition at line 110 of file itkImageSeriesWriter.h.

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

Definition at line 109 of file itkImageSeriesWriter.h.

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

Definition at line 108 of file itkImageSeriesWriter.h.

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

The pixel type of the output image.

Definition at line 107 of file itkImageSeriesWriter.h.

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

Definition at line 104 of file itkImageSeriesWriter.h.

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

Definition at line 100 of file itkImageSeriesWriter.h.

template<typename TInputImage , typename TOutputImage >
typedef TInputImage itk::ImageSeriesWriter< TInputImage, TOutputImage >::InputImageType

Some convenient typedefs.

Definition at line 96 of file itkImageSeriesWriter.h.

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

Definition at line 102 of file itkImageSeriesWriter.h.

template<typename TInputImage , typename TOutputImage >
typedef TOutputImage itk::ImageSeriesWriter< TInputImage, TOutputImage >::OutputImageType

Definition at line 101 of file itkImageSeriesWriter.h.

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

Definition at line 89 of file itkImageSeriesWriter.h.

template<typename TInputImage , typename TOutputImage >
typedef ImageSeriesWriter itk::ImageSeriesWriter< TInputImage, TOutputImage >::Self

Standard class typedefs.

Definition at line 87 of file itkImageSeriesWriter.h.

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

Definition at line 88 of file itkImageSeriesWriter.h.

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

Definition at line 103 of file itkImageSeriesWriter.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TOutputImage >
itk::ImageSeriesWriter< TInputImage, TOutputImage >::ImageSeriesWriter ( )
protected
template<typename TInputImage , typename TOutputImage >
itk::ImageSeriesWriter< TInputImage, TOutputImage >::~ImageSeriesWriter ( )
protected
template<typename TInputImage , typename TOutputImage >
itk::ImageSeriesWriter< TInputImage, TOutputImage >::ImageSeriesWriter ( const Self )
private

Member Function Documentation

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

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

Definition at line 192 of file itkImageSeriesWriter.h.

template<typename TInputImage , typename TOutputImage >
virtual::itk::LightObject::Pointer itk::ImageSeriesWriter< TInputImage, TOutputImage >::CreateAnother ( void  ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

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

Does the real work.

Reimplemented from itk::ProcessObject.

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

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

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

Definition at line 175 of file itkImageSeriesWriter.h.

template<typename TInputImage , typename TOutputImage >
virtual const ImageIOBase* itk::ImageSeriesWriter< TInputImage, TOutputImage >::GetImageIO ( ) const
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).

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.

template<typename TInputImage , typename TOutputImage >
const InputImageType* itk::ImageSeriesWriter< TInputImage, TOutputImage >::GetInput ( void  )
template<typename TInputImage , typename TOutputImage >
const InputImageType* itk::ImageSeriesWriter< TInputImage, TOutputImage >::GetInput ( unsigned int  idx)
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).

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

Run-time type information (and related methods).

Reimplemented from itk::ProcessObject.

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 sprintf(filename, SeriesFormat, number) where number starts at StartIndex and is incremented by IncrementIndex.

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.

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

Set the compression On or Off

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

Method for creation through the object factory.

template<typename TInputImage , typename TOutputImage >
void itk::ImageSeriesWriter< TInputImage, TOutputImage >::operator= ( const Self )
private
template<typename TInputImage , typename TOutputImage >
virtual void itk::ImageSeriesWriter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
protectedvirtual

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 TInputImage , typename TOutputImage >
void itk::ImageSeriesWriter< TInputImage, TOutputImage >::SetFileName ( std::string const &  name)
inline

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

Definition at line 182 of file itkImageSeriesWriter.h.

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 165 of file itkImageSeriesWriter.h.

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

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.

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

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

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 sprintf(filename, SeriesFormat, number) where number starts at StartIndex and is incremented by IncrementIndex.

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.

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

Set the compression On or Off

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

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

Reimplemented from itk::ProcessObject.

Definition at line 138 of file itkImageSeriesWriter.h.

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

Set the compression On or Off

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

Set the compression On or Off

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

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

Member Data Documentation

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

A list of filenames to be processed.

Definition at line 231 of file itkImageSeriesWriter.h.

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

Definition at line 221 of file itkImageSeriesWriter.h.

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

Definition at line 240 of file itkImageSeriesWriter.h.

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

Array of MetaDataDictionary used for passing information to each slice

Definition at line 245 of file itkImageSeriesWriter.h.

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 238 of file itkImageSeriesWriter.h.

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

Definition at line 239 of file itkImageSeriesWriter.h.

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

Definition at line 242 of file itkImageSeriesWriter.h.

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

Definition at line 224 of file itkImageSeriesWriter.h.


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