ITK: itk::ImageSeriesWriter< TInputImage, TOutputImage

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.

Member Typedef Documentation

template<class TInputImage, class TOutputImage>

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

Reimplemented from itk::ProcessObject.

Definition at line 88 of file itkImageSeriesWriter.h.

typedef DataObject::Pointer itk::ProcessObject::DataObjectPointer [inherited]

Smart Pointer type to a DataObject.

Definition at line 97 of file itkProcessObject.h.

typedef std::vector<DataObjectPointer> itk::ProcessObject::DataObjectPointerArray [inherited]

STL Array of SmartPointers to DataObjects

Definition at line 103 of file itkProcessObject.h.

typedef DataObjectPointerArray::size_type itk::ProcessObject::DataObjectPointerArraySizeType [inherited]

Size type of an std::vector

Definition at line 112 of file itkProcessObject.h.

template<class TInputImage, class TOutputImage>

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

Definition at line 108 of file itkImageSeriesWriter.h.

template<class TInputImage, class TOutputImage>

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

Definition at line 107 of file itkImageSeriesWriter.h.

template<class TInputImage, class TOutputImage>

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

Definition at line 106 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 105 of file itkImageSeriesWriter.h.

template<class TInputImage, class TOutputImage>

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

Definition at line 102 of file itkImageSeriesWriter.h.

template<class TInputImage, class TOutputImage>

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

Definition at line 98 of file itkImageSeriesWriter.h.

template<class TInputImage, class TOutputImage>

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

Some convenient typedefs.

Definition at line 94 of file itkImageSeriesWriter.h.

template<class TInputImage, class TOutputImage>

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

Definition at line 100 of file itkImageSeriesWriter.h.

template<class TInputImage, class TOutputImage>

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

Definition at line 99 of file itkImageSeriesWriter.h.

template<class TInputImage, class TOutputImage>

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

Reimplemented from itk::ProcessObject.

Definition at line 87 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 85 of file itkImageSeriesWriter.h.

template<class TInputImage, class TOutputImage>

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

Reimplemented from itk::ProcessObject.

Definition at line 86 of file itkImageSeriesWriter.h.

template<class TInputImage, class TOutputImage>

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

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

virtual void itk::ProcessObject::AbortGenerateDataOff ( ) [virtual, inherited]

virtual void itk::ProcessObject::AbortGenerateDataOn ( ) [virtual, inherited]

Turn on and off the AbortGenerateData flag.

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

virtual void itk::ProcessObject::AddInput ( DataObject * input ) [protected, virtual, inherited]

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			const `[inherited]`

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *
	)			`[inherited]`

Allow people to add/remove/invoke observers (callbacks) to any ITK object. This is an implementation of the subject/observer design pattern. An observer is added by specifying an event to respond to and an itk::Command to execute. It returns an unsigned long tag which can be used later to remove the event or retrieve the command. The memory for the Command becomes the responsibility of this object, so don't pass the same instance of a command to two different objects

virtual void itk::ProcessObject::AddOutput ( DataObject * output ) [protected, virtual, inherited]

static void itk::LightObject::BreakOnError ( ) [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual void itk::ProcessObject::CacheInputReleaseDataFlags ( ) [protected, virtual, inherited]

Cache the state of any ReleaseDataFlag's on the inputs. While the filter is executing, we need to set the ReleaseDataFlag's on the inputs to false in case the current filter is implemented using a mini-pipeline (which will try to release the inputs). After the filter finishes, we restore the state of the ReleaseDataFlag's before the call to ReleaseInputs().

virtual LightObject::Pointer itk::Object::CreateAnother ( ) const [virtual, inherited]

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::LightObject.

virtual void itk::Object::DebugOff ( ) const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn ( ) const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete ( ) [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

virtual void itk::ProcessObject::EnlargeOutputRequestedRegion ( DataObject * ) [inline, virtual, inherited]

Give the process object a chance to indictate that it will produce more output than it was requested to produce. For example, many imaging filters must compute the entire output at once or can only produce output in complete slices. Such filters cannot handle smaller requested regions. These filters must provide an implementation of this method, setting the output requested region to the size they will produce. By default, a process object does not modify the size of the output requested region.

Definition at line 225 of file itkProcessObject.h.

template<class TInputImage, class TOutputImage>

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

Does the real work.

Reimplemented from itk::ProcessObject.

virtual void itk::ProcessObject::GenerateInputRequestedRegion ( ) [protected, virtual, inherited]

What is the input requested region that is required to produce the output requested region? By default, the largest possible region is always required but this is overridden in many subclasses. For instance, for an image processing filter where an output pixel is a simple function of an input pixel, the input requested region will be set to the output requested region. For an image processing filter where an output pixel is a function of the pixels in a neighborhood of an input pixel, then the input requested region will need to be larger than the output requested region (to avoid introducing artificial boundary conditions). This function should never request an input region that is outside the the input largest possible region (i.e. implementations of this method should crop the input requested region at the boundaries of the input largest possible region).


Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector< DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef const DictionaryArrayType *	DictionaryArrayRawPointer
typedef std::vector< DictionaryRawPointer >	DictionaryArrayType
typedef MetaDataDictionary *	DictionaryRawPointer
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< Self >	Pointer
typedef ImageSeriesWriter	Self
typedef ProcessObject	Superclass
typedef ImageFileWriter< TOutputImage >	WriterType
Public Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual void	EnlargeOutputRequestedRegion (DataObject *)
virtual const bool &	GetAbortGenerateData ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
DataObjectPointerArray &	GetInputs ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
MultiThreader *	GetMultiThreader ()
virtual const char *	GetNameOfClass () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
virtual const float &	GetProgress ()
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual DataObjectPointer	MakeOutput (unsigned int idx)
virtual void	Modified () const
virtual void	PrepareOutputs ()
void	Print (std::ostream &os, Indent indent=0) const
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetMetaDataDictionaryArray (DictionaryArrayRawPointer _arg)
virtual void	SetProgress (float _arg)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
virtual void	Write (void)

void	AddFileName (std::string const &name)

unsigned long	AddObserver (const EventObject &event, Command *) const
unsigned long	AddObserver (const EventObject &event, Command *)

const FileNamesContainer &	GetFileNames () const
void	SetFileNames (const FileNamesContainer &name)

virtual ImageIOBase *	GetImageIO ()
virtual void	SetImageIO (ImageIOBase *_arg)

virtual unsigned long	GetIncrementIndex ()
virtual void	SetIncrementIndex (unsigned long _arg)

const InputImageType *	GetInput (unsigned int idx)
const InputImageType *	GetInput (void)
void	SetInput (const InputImageType *input)

DataObjectPointerArraySizeType	GetNumberOfOutputs () const
DataObjectPointerArray &	GetOutputs ()

virtual const int &	GetNumberOfThreads ()
virtual void	SetNumberOfThreads (int _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual bool	GetReleaseDataFlag () const
void	ReleaseDataFlagOff ()
void	ReleaseDataFlagOn ()
virtual void	SetReleaseDataFlag (bool flag)

virtual const char *	GetSeriesFormat () const
virtual void	SetSeriesFormat (const char *_arg)

virtual unsigned long	GetStartIndex ()
virtual void	SetStartIndex (unsigned long _arg)

virtual const bool &	GetUseCompression ()
virtual void	SetUseCompression (bool _arg)
virtual void	UseCompressionOff ()
virtual void	UseCompressionOn ()

void	SetFileName (std::string const &name)
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()

static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static void	SetGlobalWarningDisplay (bool flag)
Protected Member Functions
virtual void	CacheInputReleaseDataFlags ()
void	GenerateData (void)
virtual void	GenerateInputRequestedRegion ()
void	GenerateNumericFileNamesAndWrite (void)
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
	ImageSeriesWriter ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RestoreInputReleaseDataFlags ()
void	SetNumberOfInputs (unsigned int num)
void	SetNumberOfOutputs (unsigned int num)
	~ImageSeriesWriter ()

virtual void	AddInput (DataObject *input)
virtual const unsigned int &	GetNumberOfRequiredInputs ()
virtual void	RemoveInput (DataObject *input)
virtual void	SetNthInput (unsigned int num, DataObject *input)
virtual void	SetNumberOfRequiredInputs (unsigned int _arg)

virtual void	AddOutput (DataObject *output)
virtual const unsigned int &	GetNumberOfRequiredOutputs ()
virtual void	RemoveOutput (DataObject *output)
virtual void	SetNthOutput (unsigned int num, DataObject *output)
virtual void	SetNumberOfRequiredOutputs (unsigned int _arg)

const DataObject *	GetInput (unsigned int idx) const

const DataObject *	GetOutput (unsigned int idx) const
DataObject *	GetOutput (unsigned int idx)

virtual void	PopBackInput ()
virtual void	PopFrontInput ()
virtual void	PushBackInput (const DataObject *input)
virtual void	PushFrontInput (const DataObject *input)

virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
Protected Attributes
ImageIOBase::Pointer	m_ImageIO
TimeStamp	m_OutputInformationMTime
volatile int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
bool	m_Updating
bool	m_UserSpecifiedImageIO

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

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

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

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

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

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