itk::ImageSeriesWriter< TInputImage, TOutputImage > Class Template Reference
[Input and Output Filters]

Writes image data to a series of data files. More...

#include <itkImageSeriesWriter.h>

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

[legend]Collaboration diagram for itk::ImageSeriesWriter< TInputImage, TOutputImage >:

[legend]List of all members.

Public Types
typedef ImageSeriesWriter	Self
typedef ProcessObject	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TInputImage	InputImageType
typedef InputImageType::RegionType	InputImageRegionType
typedef TOutputImage	OutputImageType
typedef OutputImageType::RegionType	OutputImageRegionType
typedef ImageFileWriter< TOutputImage >	WriterType
typedef std::vector< std::string >	FileNamesContainer
typedef MetaDataDictionary	DictionaryType
typedef MetaDataDictionary *	DictionaryRawPointer
typedef std::vector< DictionaryRawPointer >	DictionaryArrayType
typedef const DictionaryArrayType *	DictionaryArrayRawPointer
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual void	Write (void)
virtual void	Update ()
virtual void	SetMetaDataDictionaryArray (DictionaryArrayRawPointer _arg)
void	SetInput (const InputImageType *input)
const InputImageType *	GetInput (void)
const InputImageType *	GetInput (unsigned int idx)
virtual void	SetImageIO (ImageIOBase *_arg)
virtual ImageIOBase *	GetImageIO ()
virtual void	SetStartIndex (unsigned long _arg)
virtual unsigned long	GetStartIndex ()
virtual void	SetIncrementIndex (unsigned long _arg)
virtual unsigned long	GetIncrementIndex ()
virtual void	SetSeriesFormat (const char *_arg)
virtual const char *	GetSeriesFormat () const
void	SetFileNames (const FileNamesContainer &name)
const FileNamesContainer &	GetFileNames () const
void	SetFileName (std::string const &name)
void	AddFileName (std::string const &name)
Static Public Member Functions
Pointer	New ()
Protected Member Functions
	ImageSeriesWriter ()
	~ImageSeriesWriter ()
void	PrintSelf (std::ostream &os, Indent indent) const
void	GenerateData (void)
void	GenerateNumericFileNamesAndWrite (void)
Protected Attributes
ImageIOBase::Pointer	m_ImageIO
bool	m_UserSpecifiedImageIO

---

Detailed Description

template<class TInputImage, class 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

Definition at line 80 of file itkImageSeriesWriter.h.

---

Member Typedef Documentation

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

Reimplemented from itk::ProcessObject. Definition at line 87 of file itkImageSeriesWriter.h.

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

Definition at line 107 of file itkImageSeriesWriter.h.

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

Definition at line 106 of file itkImageSeriesWriter.h.

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

Definition at line 105 of file itkImageSeriesWriter.h.

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

The pixel type of the output image. Definition at line 104 of file itkImageSeriesWriter.h.

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

Definition at line 101 of file itkImageSeriesWriter.h.

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

Definition at line 97 of file itkImageSeriesWriter.h.

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

Some convenient typedefs. Definition at line 96 of file itkImageSeriesWriter.h.

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

Definition at line 99 of file itkImageSeriesWriter.h.

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

Definition at line 98 of file itkImageSeriesWriter.h.

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

Reimplemented from itk::ProcessObject. Definition at line 86 of file itkImageSeriesWriter.h.

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

Standard class typedefs. Reimplemented from itk::ProcessObject. Definition at line 84 of file itkImageSeriesWriter.h.

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

Reimplemented from itk::ProcessObject. Definition at line 85 of file itkImageSeriesWriter.h.

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

Definition at line 100 of file itkImageSeriesWriter.h.

---

Constructor & Destructor Documentation

template<class TInputImage, class TOutputImage> itk::ImageSeriesWriter< TInputImage, TOutputImage >::ImageSeriesWriter (   )  [protected]

template<class TInputImage, class TOutputImage> itk::ImageSeriesWriter< TInputImage, TOutputImage >::~ImageSeriesWriter (   )  [protected]

---

Member Function Documentation

template<class TInputImage, class 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 186 of file itkImageSeriesWriter.h.

template<class TInputImage, class TOutputImage> void itk::ImageSeriesWriter< TInputImage, TOutputImage >::GenerateData (  void   )  [protected, virtual]

Does the real work. Reimplemented from itk::ProcessObject.

template<class TInputImage, class 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<class TInputImage, class TOutputImage> const FileNamesContainer& itk::ImageSeriesWriter< TInputImage, TOutputImage >::GetFileNames (   )  const [inline]

Set/Get the vector of strings that contains the file names. Files are processed in sequential order. Definition at line 168 of file itkImageSeriesWriter.h.

template<class TInputImage, class TOutputImage> virtual ImageIOBase* itk::ImageSeriesWriter< TInputImage, TOutputImage >::GetImageIO (   )  [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<class TInputImage, class TOutputImage> virtual unsigned long itk::ImageSeriesWriter< TInputImage, TOutputImage >::GetIncrementIndex (   )  [virtual]

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

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

Set/Get the image input of this writer. Reimplemented from itk::ProcessObject.

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

Set/Get the image input of this writer.

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

Run-time type information (and related methods). Reimplemented from itk::ProcessObject.

template<class TInputImage, class 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<class TInputImage, class TOutputImage> virtual unsigned long itk::ImageSeriesWriter< TInputImage, TOutputImage >::GetStartIndex (   )  [virtual]

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

template<class TInputImage, class TOutputImage> Pointer itk::ImageSeriesWriter< TInputImage, TOutputImage >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

template<class TInputImage, class TOutputImage> void itk::ImageSeriesWriter< TInputImage, TOutputImage >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

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<class TInputImage, class 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 176 of file itkImageSeriesWriter.h.

template<class TInputImage, class 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 160 of file itkImageSeriesWriter.h.

template<class TInputImage, class 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<class TInputImage, class TOutputImage> virtual void itk::ImageSeriesWriter< TInputImage, TOutputImage >::SetIncrementIndex (  unsigned long  _arg  )  [virtual]

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

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

Set/Get the image input of this writer.

template<class TInputImage, class 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<class TInputImage, class 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<class TInputImage, class TOutputImage> virtual void itk::ImageSeriesWriter< TInputImage, TOutputImage >::SetStartIndex (  unsigned long  _arg  )  [virtual]

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

template<class TInputImage, class TOutputImage> virtual void itk::ImageSeriesWriter< TInputImage, TOutputImage >::Update (  void   )  [inline, virtual]

Aliased to the Write() method to be consistent with the rest of the pipeline. Reimplemented from itk::ProcessObject. Definition at line 133 of file itkImageSeriesWriter.h.

template<class TInputImage, class 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.

---

Member Data Documentation

template<class TInputImage, class TOutputImage> ImageIOBase::Pointer itk::ImageSeriesWriter< TInputImage, TOutputImage >::m_ImageIO [protected]

Definition at line 210 of file itkImageSeriesWriter.h.

template<class TInputImage, class TOutputImage> bool itk::ImageSeriesWriter< TInputImage, TOutputImage >::m_UserSpecifiedImageIO [protected]

Definition at line 211 of file itkImageSeriesWriter.h.

---

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

• itkImageSeriesWriter.h

---