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

#include <itkImageSeriesWriter.h>

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

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

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 ()
void	AddFileName (std::string const &name)
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
virtual ::itk::LightObject::Pointer	CreateAnother (void) 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
const FileNamesContainer &	GetFileNames () const
virtual ImageIOBase *	GetImageIO ()
virtual unsigned long	GetIncrementIndex () const
const InputImageType *	GetInput (void)
const InputImageType *	GetInput (unsigned int idx)
DataObjectPointerArray &	GetInputs ()
MetaDataDictionary &	GetMetaDataDictionary (void)
const MetaDataDictionary &	GetMetaDataDictionary (void) const
virtual unsigned long	GetMTime () const
MultiThreader *	GetMultiThreader ()
virtual const char *	GetNameOfClass () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
DataObjectPointerArraySizeType	GetNumberOfOutputs () const
virtual const int &	GetNumberOfThreads ()
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
DataObjectPointerArray &	GetOutputs ()
virtual const float &	GetProgress ()
virtual int	GetReferenceCount () const
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual bool	GetReleaseDataFlag () const
virtual const char *	GetSeriesFormat () const
virtual unsigned long	GetStartIndex () const
virtual const bool &	GetUseCompression ()
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &)
void	InvokeEvent (const EventObject &) const
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
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
void	ReleaseDataFlagOff ()
void	ReleaseDataFlagOn ()
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
void	SetDebug (bool debugFlag) const
void	SetFileName (std::string const &name)
void	SetFileNames (const FileNamesContainer &name)
virtual void	SetImageIO (ImageIOBase *_arg)
virtual void	SetIncrementIndex (unsigned long _arg)
void	SetInput (const InputImageType *input)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetMetaDataDictionaryArray (DictionaryArrayRawPointer _arg)
virtual void	SetNumberOfThreads (int _arg)
virtual void	SetProgress (float _arg)
virtual void	SetReferenceCount (int)
virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)
virtual void	SetReleaseDataFlag (bool flag)
virtual void	SetSeriesFormat (const char *_arg)
virtual void	SetStartIndex (unsigned long _arg)
virtual void	SetUseCompression (bool _arg)
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
virtual void	UseCompressionOff ()
virtual void	UseCompressionOn ()
virtual void	Write (void)

Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
static void	SetGlobalWarningDisplay (bool flag)

Protected Types
typedef int	InternalReferenceCountType

Protected Member Functions
	ImageSeriesWriter ()
	~ImageSeriesWriter ()
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
virtual void	CacheInputReleaseDataFlags ()
void	GenerateData (void)
virtual void	GenerateInputRequestedRegion ()
void	GenerateNumericFileNamesAndWrite (void)
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
const DataObject *	GetInput (unsigned int idx) const
virtual const unsigned int &	GetNumberOfRequiredInputs ()
virtual const unsigned int &	GetNumberOfRequiredOutputs ()
DataObject *	GetOutput (unsigned int idx)
const DataObject *	GetOutput (unsigned int idx) const
virtual void	PopBackInput ()
virtual void	PopFrontInput ()
virtual void	PrintHeader (std::ostream &os, Indent indent) const
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()
virtual void	PushBackInput (const DataObject *input)
virtual void	PushFrontInput (const DataObject *input)
virtual void	ReleaseInputs ()
virtual void	RemoveInput (DataObject *input)
virtual void	RemoveOutput (DataObject *output)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetNthInput (unsigned int num, DataObject *input)
virtual void	SetNthOutput (unsigned int num, DataObject *output)
void	SetNumberOfInputs (unsigned int num)
void	SetNumberOfOutputs (unsigned int num)
virtual void	SetNumberOfRequiredInputs (unsigned int _arg)
virtual void	SetNumberOfRequiredOutputs (unsigned int _arg)

Protected Attributes
ImageIOBase::Pointer	m_ImageIO
TimeStamp	m_OutputInformationMTime
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
bool	m_Updating
bool	m_UserSpecifiedImageIO

Private Member Functions
	ImageSeriesWriter (const Self &)
void	GenerateNumericFileNames (void)
void	operator= (const Self &)
void	WriteFiles ()

Private Attributes
FileNamesContainer	m_FileNames
unsigned long	m_IncrementIndex
DictionaryArrayRawPointer	m_MetaDataDictionaryArray
std::string	m_SeriesFormat
unsigned long	m_StartIndex
bool	m_UseCompression

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.

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

typedef int itk::LightObject::InternalReferenceCountType

protectedinherited

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 137 of file itkLightObject.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

Definition at line 38 of file itkImageSeriesWriter.txx.

template<class TInputImage , class TOutputImage >

itk::ImageSeriesWriter< TInputImage, TOutputImage >::~ImageSeriesWriter ( )

protected

Definition at line 50 of file itkImageSeriesWriter.txx.

template<class TInputImage, class TOutputImage>

itk::ImageSeriesWriter< TInputImage, TOutputImage >::ImageSeriesWriter ( const Self & )

private

Member Function Documentation

virtual void itk::ProcessObject::AbortGenerateDataOff ( )

virtualinherited

virtual void itk::ProcessObject::AbortGenerateDataOn ( )

virtualinherited

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

void itk::ProcessObject::AddInput ( DataObject * input )

protectedvirtualinherited

Adds an input to the first null position in the input list. Expands the list memory if necessary

Reimplemented in otb::ObjectDetectionClassifier< TInputImage, TOutputVectorData, TLabel, TFunctionPrecision, TCoordRep >, otb::DescriptorsListSampleGenerator< TInputImage, TVectorData, TListSample, TLabelListSample, TOutputPrecision, TCoordRep >, otb::PersistentDescriptorsListSampleGenerator< TInputImage, TVectorData, TFunctionType, TListSample, TLabelListSample >, and otb::PersistentObjectDetectionClassifier< TInputImage, TOutputVectorData, TLabel, TFunctionType >.

Definition at line 144 of file itkProcessObject.cxx.

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)

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

Definition at line 389 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), itk::ProgressAccumulator::RegisterInternalFilter(), otb::ImageFileWriter< TInputImage >::Update(), and otb::WriterWatcherBase::WriterWatcherBase().

unsigned long itk::Object::AddObserver	(	const EventObject &	event,
		Command *	cmd
	)		const

inherited

Definition at line 401 of file itkObject.cxx.

References itk::SubjectImplementation::AddObserver().

void itk::ProcessObject::AddOutput ( DataObject * output )

protectedvirtualinherited

Adds an output to the first null position in the output list. Expands the list memory if necessary

Definition at line 390 of file itkProcessObject.cxx.

References itk::DataObject::ConnectSource().

void itk::LightObject::BreakOnError ( )

staticinherited

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

Definition at line 149 of file itkLightObject.cxx.

void itk::ProcessObject::CacheInputReleaseDataFlags ( )

protectedvirtualinherited

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

Definition at line 1050 of file itkProcessObject.cxx.

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

void itk::Object::DebugOff ( ) const

virtualinherited

Turn debugging output off.

Definition at line 253 of file itkObject.cxx.

void itk::Object::DebugOn ( ) const

virtualinherited

Turn debugging output on.

Definition at line 242 of file itkObject.cxx.

void itk::LightObject::Delete ( )

virtualinherited

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.

Delete a 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.

Definition at line 88 of file itkLightObject.cxx.

virtual void itk::ProcessObject::EnlargeOutputRequestedRegion ( DataObject * )

inlinevirtualinherited

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 224 of file itkProcessObject.h.

template<class TInputImage , class TOutputImage >

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

protectedvirtual

Does the real work.

Reimplemented from itk::ProcessObject.

Definition at line 179 of file itkImageSeriesWriter.txx.

void itk::ProcessObject::GenerateInputRequestedRegion ( void )

protectedvirtualinherited

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

By default we require all the input to produce the output. This is overridden in the subclasses since we can often produce the output with just a portion of the input data.

Definition at line 828 of file itkProcessObject.cxx.

template<class TInputImage , class TOutputImage >

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

private

Definition at line 143 of file itkImageSeriesWriter.txx.

References itk::ImageRegion< VImageDimension >::GetSize(), and itk::IOCommon::ITK_MAXPATHLEN.

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

Definition at line 132 of file itkImageSeriesWriter.txx.

void itk::ProcessObject::GenerateOutputInformation ( void )

protectedvirtualinherited

Generate the information decribing the output data. The default implementation of this method will copy information from the input to the output. A filter may override this method if its output will have different information than its input. For instance, a filter that shrinks an image will need to provide an implementation for this method that changes the spacing of the pixels. Such filters should call their superclass' implementation of this method prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

Default implementation - copy information from first input to all outputs

Examples:: Fusion/BayesianFusionImageFilter.cxx.

Definition at line 1095 of file itkProcessObject.cxx.

Referenced by main().

void itk::ProcessObject::GenerateOutputRequestedRegion ( DataObject * output )

protectedvirtualinherited

Given one output whose requested region has been set, how should the requested regions for the remaining outputs of the process object be set? By default, all the outputs are set to the same requested region. If a filter needs to produce different requested regions for each output, for instance an image processing filter producing several outputs at different resolutions, then that filter may override this method and set the requested regions appropriatedly.

Note that a filter producing multiple outputs of different types is required to override this method. The default implementation can only correctly handle multiple outputs of the same type.

By default we set all the output requested regions to be the same.

Reimplemented in itk::watershed::Segmenter< TInputImage >, itk::watershed::Segmenter< InputImageType >, itk::watershed::SegmentTreeGenerator< TScalarType >, itk::watershed::SegmentTreeGenerator< ScalarType >, itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >, itk::watershed::Relabeler< TScalarType, TImageDimension >, itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>, itk::watershed::BoundaryResolver< TPixelType, TDimension >, itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >, and itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >.

Definition at line 846 of file itkProcessObject.cxx.

virtual const bool& itk::ProcessObject::GetAbortGenerateData ( )

virtualinherited

Get the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

Referenced by itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback().

Command * itk::Object::GetCommand ( unsigned long tag )

inherited

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

Definition at line 414 of file itkObject.cxx.

References itk::Object::GetCommand(), and NULL.

Referenced by itk::Object::GetCommand().

bool itk::Object::GetDebug ( ) const

inherited

Get the value of the debug flag.

Definition at line 264 of file itkObject.cxx.

Referenced by otb::ogr::ImageReference< double >::GetDebug().

template<class TInputImage, class TOutputImage>

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

inline

Definition at line 163 of file itkImageSeriesWriter.h.

bool itk::Object::GetGlobalWarningDisplay ( )

staticinherited

Get the value of the global debug output control flag.

Definition at line 381 of file itkObject.cxx.

template<class TInputImage, class TOutputImage>

virtual ImageIOBase* itk::ImageSeriesWriter< TInputImage, TOutputImage >::GetImageIO ( )

virtual

template<class TInputImage, class TOutputImage>

virtual unsigned long itk::ImageSeriesWriter< TInputImage, TOutputImage >::GetIncrementIndex ( ) const

virtual

template<class TInputImage , class TOutputImage >

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

Definition at line 70 of file itkImageSeriesWriter.txx.

References itk::ProcessObject::GetInput().

template<class TInputImage , class TOutputImage >

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

Method used internally for getting an input.

Reimplemented from itk::ProcessObject.

Definition at line 85 of file itkImageSeriesWriter.txx.

References itk::ProcessObject::GetInput().

const DataObject * itk::ProcessObject::GetInput ( unsigned int idx ) const

protectedinherited

Reimplemented in otb::AngularProjectionSetImageFilter< TInputImage, TOutputImage, TAngleList, TPrecision >, otb::SparseUnmixingImageFilter< TInputImage, TOutputImage, VNbInputImage, TPrecision, TMotherWaveletOperator >, otb::AngularProjectionImageFilter< TInputImage, TOutputImage, TAngleArray, TPrecision >, otb::LabeledSampleLocalizationGenerator< TVectorData >, otb::ConcatenateVectorDataFilter< TVectorData >, itk::MeshToMeshFilter< TInputMesh, TOutputMesh >, and itk::MeshToMeshFilter< TInput, TOutput >.

Definition at line 482 of file itkProcessObject.cxx.

References NULL.

DataObjectPointerArray& itk::ProcessObject::GetInputs ( )

inlineinherited

Return an array with all the inputs of this process object. This is useful for tracing back in the pipeline to construct graphs etc.

Definition at line 108 of file itkProcessObject.h.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void )

inherited

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 532 of file itkObject.cxx.

References NULL.

const MetaDataDictionary & itk::Object::GetMetaDataDictionary ( void ) const

inherited

Returns:: A constant reference to this objects MetaDataDictionary.

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 543 of file itkObject.cxx.

References NULL.

unsigned long itk::Object::GetMTime ( void ) const

virtualinherited

Return this objects modified time.

Return the modification for this object.

Definition at line 286 of file itkObject.cxx.

Referenced by itk::DeformationFieldSource< TOutputImage >::GetMTime(), itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >::GetMTime(), itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >::GetMTime(), itk::TransformToDeformationFieldSource< TOutputImage, TTransformPrecisionType >::GetMTime(), itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< TDimension >::GetMTime(), itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >::GetMTime(), itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime(), otb::Function::NoStretchRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), otb::Function::StandardRenderingFunction< TPixel, TRGBPixel, TPixelRepresentationFunction, TTransferFunction >::Initialize(), itk::VTKImageExportBase::PipelineModifiedCallback(), and itk::ProcessObject::UpdateOutputInformation().

MultiThreader* itk::ProcessObject::GetMultiThreader ( )

inlineinherited

Return the multithreader used by this class.

Definition at line 280 of file itkProcessObject.h.

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.

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfInputs ( ) const

inlineinherited

Get the size of the input vector. This is merely the size of the input vector, not the number of inputs that have valid DataObject's assigned. Use GetNumberOfValidRequiredInputs() to determine how many inputs are non-null.

Definition at line 118 of file itkProcessObject.h.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfOutputs ( ) const

inlineinherited

Reimplemented in otb::ImageSeriesFileReaderBase< TImage, TInternalImage >, otb::ImageSeriesFileReaderBase< VectorImage< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >, otb::ImageSeriesFileReaderBase< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >, and otb::ImageSeriesFileReaderBase< Image< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >.

Definition at line 135 of file itkProcessObject.h.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredInputs ( )

protectedvirtualinherited

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredOutputs ( )

protectedvirtualinherited

virtual const int& itk::ProcessObject::GetNumberOfThreads ( )

virtualinherited

Referenced by itk::BSplineScatteredDataPointSetToImageFilter< TInputPointSet, TOutputImage >::SplitRequestedRegion().

ProcessObject::DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfValidRequiredInputs ( ) const

virtualinherited

Get the number of valid inputs. This is the number of non-null entries in the input vector in the first NumberOfRequiredInputs slots. This method is used to determine whether the necessary required inputs have been set. Subclasses of ProcessObject may override this implementation if the required inputs are not the first slots in input vector.

Get the number of specified inputs

Reimplemented in itk::MultiResolutionPDEDeformableRegistration< TFixedImage, TMovingImage, TDeformationField, TRealType >, and itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDeformationField >.

Definition at line 112 of file itkProcessObject.cxx.

DataObject * itk::ProcessObject::GetOutput ( unsigned int idx )

protectedinherited

Method used internally for getting an output.

Definition at line 442 of file itkProcessObject.cxx.

References NULL.

const DataObject * itk::ProcessObject::GetOutput ( unsigned int idx ) const

protectedinherited

Definition at line 454 of file itkProcessObject.cxx.

References NULL.

DataObjectPointerArray& itk::ProcessObject::GetOutputs ( )

inlineinherited

Return an array with all the outputs of this process object. This is useful for tracing forward in the pipeline to contruct graphs etc.

Definition at line 133 of file itkProcessObject.h.

Referenced by otb::PipelineMemoryPrintCalculator::EvaluateProcessObjectPrintRecursive().

virtual const float& itk::ProcessObject::GetProgress ( )

virtualinherited

Get the execution progress of a process object. The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution.

Referenced by itk::WatershedMiniPipelineProgressCommand::Execute(), otb::StreamingImageVirtualWriter< TInputImage >::ObserveSourceFilterProgress(), otb::ImageFileWriter< TInputImage >::ObserveSourceFilterProgress(), itk::LaplacianRecursiveGaussianImageFilter< TInputImage, TOutputImage >::ReportProgress(), and itk::XMLFilterWatcher::ShowProgress().

virtual int itk::LightObject::GetReferenceCount ( ) const

inlinevirtualinherited

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

virtual const bool& itk::ProcessObject::GetReleaseDataBeforeUpdateFlag ( )

virtualinherited

bool itk::ProcessObject::GetReleaseDataFlag ( ) const

virtualinherited

Definition at line 512 of file itkProcessObject.cxx.

template<class TInputImage, class TOutputImage>

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

virtual

template<class TInputImage, class TOutputImage>

virtual unsigned long itk::ImageSeriesWriter< TInputImage, TOutputImage >::GetStartIndex ( ) const

virtual

template<class TInputImage, class TOutputImage>

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

virtual

static void itk::Object::GlobalWarningDisplayOff ( )

inlinestaticinherited

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

Referenced by itk::OutputWindow::DisplayText(), itk::Win32OutputWindow::PromptText(), and itk::Win32OutputWindow::WndProc().

static void itk::Object::GlobalWarningDisplayOn ( )

inlinestaticinherited

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver ( const EventObject & event ) const

inherited

Return true if an observer is registered for this event.

Definition at line 467 of file itkObject.cxx.

void itk::Object::InvokeEvent ( const EventObject & event )

inherited

Call Execute on all the Commands observing this event id.

Definition at line 446 of file itkObject.cxx.

Referenced by otb::Wrapper::Application::AddProcess(), itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback(), and itk::VTKImageExportBase::UpdateDataCallback().

void itk::Object::InvokeEvent ( const EventObject & event ) const

inherited

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

Definition at line 457 of file itkObject.cxx.

DataObject::Pointer itk::ProcessObject::MakeOutput ( unsigned int idx )

virtualinherited

Make a DataObject of the correct type to used as the specified output. Every ProcessObject subclass must be able to create a DataObject that can be used as a specified output. This method is automatically called when DataObject::DisconnectPipeline() is called. DataObject::DisconnectPipeline, disconnects a data object from being an output of its current source. When the data object is disconnected, the ProcessObject needs to construct a replacement output data object so that the ProcessObject is in a valid state. So DataObject::DisconnectPipeline eventually calls ProcessObject::MakeOutput. Note that MakeOutput always returns a itkSmartPointer to a DataObject. ImageSource and MeshSource override this method to create the correct type of image and mesh respectively. If a filter has multiple outputs of different types, then that filter must provide an implementation of MakeOutput().

This is a default implementation to make sure we have something. Once all the subclasses of ProcessObject provide an appopriate MakeOutput(), then ProcessObject::MakeOutput() can be made pure virtual.

Definition at line 59 of file itkProcessObject.cxx.

References itk::SmartPointer< TObjectType >::GetPointer(), and itk::Object::New().

void itk::Object::Modified ( void ) const

virtualinherited

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data.

Make sure this object's modified time is greater than all others.

Definition at line 297 of file itkObject.cxx.

template<class TInputImage, class TOutputImage>

static 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 >::operator= ( const Self & )

private

Reimplemented from itk::ProcessObject.

void itk::ProcessObject::PopBackInput ( )

protectedvirtualinherited

Model a stack on the input list by providing a pop back

Definition at line 245 of file itkProcessObject.cxx.

Referenced by otb::JointMassOfBeliefFilter< TMassFunction >::PopBackInput(), and itk::ImageToImageFilter< TInputImage, TOutputImage >::PopBackInput().

void itk::ProcessObject::PopFrontInput ( )

protectedvirtualinherited

Definition at line 280 of file itkProcessObject.cxx.

Referenced by otb::JointMassOfBeliefFilter< TMassFunction >::PopFrontInput(), and itk::ImageToImageFilter< TInputImage, TOutputImage >::PopFrontInput().

void itk::ProcessObject::PrepareOutputs ( )

virtualinherited

An opportunity to deallocate a ProcessObject's bulk data storage. Some filters may wish to reuse existing bulk data storage to avoid unnecessary deallocation/allocation sequences. The default implementation calls Initialize() on each output. DataObject::Initialize() frees its bulk data by default.

Reimplemented in itk::WatershedImageFilter< TInputImage >, and otb::GeometriesSource.

Definition at line 864 of file itkProcessObject.cxx.

void itk::LightObject::Print	(	std::ostream &	os,
		Indent	indent = `0`
	)		const

inherited

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().

void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)		const

protectedinherited

Definition at line 478 of file itkObject.cxx.

template<class TInputImage , class TOutputImage >

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.

Chaining method to print an object's instance variables, as well as its superclasses.

Reimplemented from itk::ProcessObject.

Definition at line 382 of file itkImageSeriesWriter.txx.

void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)		const

protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

void itk::ProcessObject::PropagateRequestedRegion ( DataObject * output )

virtualinherited

Send the requested region information back up the pipeline (to the filters that preceed this one).

 check flag to avoid executing forever if there is a loop

 Give the subclass a chance to indicate that it will provide
 more data then required for the output. This can happen, for
 example, when a source can only produce the whole output.
 Although this is being called for a specific output, the source
 may need to enlarge all outputs.

 Give the subclass a chance to define how to set the requested
 regions for each of its outputs, given this output's requested
 region.  The default implementation is to make all the output
 requested regions the same.  A subclass may need to override this
 method if each output is a different resolution.

 Give the subclass a chance to request a larger requested region on 
 the inputs. This is necessary when, for example, a filter
 requires more data at the "internal" boundaries to 
 produce the boundary values - such as an image filter that
 derives a new pixel value by applying some operation to a 
 neighborhood of surrounding original values.

 Now that we know the input requested region, propagate this
 through all the inputs.

Reimplemented in itk::VTKImageImport< TOutputImage >, and itk::StreamingImageFilter< TInputImage, TOutputImage >.

Definition at line 766 of file itkProcessObject.cxx.

void itk::ProcessObject::PropagateResetPipeline ( )

protectedvirtualinherited

Called to allocate the input array. Copies old inputs. Propagate a call to ResetPipeline() up the pipeline. Called only from DataObject.

Propagate the ResetPipeline call

Definition at line 631 of file itkProcessObject.cxx.

void itk::ProcessObject::PushBackInput ( const DataObject * input )

protectedvirtualinherited

Push/Pop an input of this process object. These methods allow a filter to model its input vector as a queue or stack. These routines may not be appropriate for all filters, especially filters with different types of inputs. These routines follow the semantics of STL.

Model a queue on the input list by providing a push back

Definition at line 234 of file itkProcessObject.cxx.

Referenced by otb::OGRDataSourceToLabelImageFilter< TOutputImage >::AddOGRDataSource(), otb::VectorDataToLabelImageFilter< TVectorData, TOutputImage >::AddVectorData(), otb::RasterizeVectorDataFilter< TVectorData, TInputImage, TOutputImage >::AddVectorData(), otb::JointMassOfBeliefFilter< TMassFunction >::PushBackInput(), and itk::ImageToImageFilter< TInputImage, TOutputImage >::PushBackInput().

void itk::ProcessObject::PushFrontInput ( const DataObject * input )

protectedvirtualinherited

Definition at line 259 of file itkProcessObject.cxx.

Referenced by otb::JointMassOfBeliefFilter< TMassFunction >::PushFrontInput(), and itk::ImageToImageFilter< TInputImage, TOutputImage >::PushFrontInput().

void itk::Object::Register ( ) const

virtualinherited

Increase the reference count (mark as used by another object).

Reimplemented from itk::LightObject.

Definition at line 309 of file itkObject.cxx.

Referenced by itk::ObjectFactoryBase::RegisterFactory().

virtual void itk::ProcessObject::ReleaseDataBeforeUpdateFlagOff ( )

virtualinherited

virtual void itk::ProcessObject::ReleaseDataBeforeUpdateFlagOn ( )

virtualinherited

void itk::ProcessObject::ReleaseDataFlagOff ( )

inlineinherited

Definition at line 256 of file itkProcessObject.h.

void itk::ProcessObject::ReleaseDataFlagOn ( )

inlineinherited

Definition at line 255 of file itkProcessObject.h.

void itk::ProcessObject::ReleaseInputs ( )

protectedvirtualinherited

A filter may need to release its input's bulk data after it has finished calculating a new output. The filter may need to release the inputs because the user has turned on the ReleaseDataFlag or it may need to release the inputs because the filter is an "in place" filter and it has overwritten its input with its output data. The implementation here simply checks the ReleaseDataFlag of the inputs. InPlaceImageFilter overrides this method so release the input it has overwritten.

See also:: InPlaceImageFilter::ReleaseInputs()

Definition at line 886 of file itkProcessObject.cxx.

Referenced by itk::InPlaceImageFilter< TInputImage, TOutputImage >::ReleaseInputs(), and itk::InPlaceLabelMapFilter< TInputImage >::ReleaseInputs().

void itk::Object::RemoveAllObservers ( )

inherited

Remove all observers .

Definition at line 435 of file itkObject.cxx.

void itk::ProcessObject::RemoveInput ( DataObject * input )

protectedvirtualinherited

Remove an input.

Removes the first occurence of the given OutputObject from the inputs to this ProcessObject. If it's the last object on the list, shortens the list.

Definition at line 173 of file itkProcessObject.cxx.

void itk::Object::RemoveObserver ( unsigned long tag )

inherited

Remove the observer with this tag value.

Definition at line 425 of file itkObject.cxx.

Referenced by otb::StreamingImageVirtualWriter< TInputImage >::GenerateData(), and otb::ImageFileWriter< TInputImage >::Update().

void itk::ProcessObject::RemoveOutput ( DataObject * output )

protectedvirtualinherited

Definition at line 294 of file itkProcessObject.cxx.

void itk::ProcessObject::ResetPipeline ( )

virtualinherited

Reset the pipeline. If an exception is thrown during an Update(), the pipeline may be in an inconsistent state. This method clears the internal state of the pipeline so Update() can be called.

Definition at line 621 of file itkProcessObject.cxx.

Referenced by itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback().

void itk::ProcessObject::RestoreInputReleaseDataFlags ( )

protectedvirtualinherited

Restore the cached input ReleaseDataFlags.

Definition at line 1075 of file itkProcessObject.cxx.

virtual void itk::ProcessObject::SetAbortGenerateData ( bool _arg )

virtualinherited

Set the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

void itk::Object::SetDebug ( bool debugFlag ) const

inherited

Set the value of the debug flag. A non-zero value turns debugging on.

Definition at line 275 of file itkObject.cxx.

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

void itk::Object::SetGlobalWarningDisplay ( bool val )

staticinherited

This is a global flag that controls whether any debug, warning or error messages are displayed.

Set the value of the global debug output control flag.

Definition at line 370 of file itkObject.cxx.

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

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.

Definition at line 58 of file itkImageSeriesWriter.txx.

References itk::ProcessObject::SetNthInput().

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs )

inherited

Returns:: Set the MetaDataDictionary

Reimplemented in otb::ImageMetadataInterfaceBase.

Definition at line 554 of file itkObject.cxx.

References NULL.

Referenced by otb::VectorImage< TPixel, VImageDimension >::CopyInformation(), and otb::Image< TPixel, VImageDimension >::CopyInformation().

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.

void itk::ProcessObject::SetNthInput	(	unsigned int	idx,
		DataObject *	input
	)

protectedvirtualinherited

Protected methods for setting inputs. Subclasses make use of them for setting input.

Set an Input of this filter. This method does Register()/UnRegister() manually to deal with the fact that smart pointers aren't around to do the reference counting.

Reimplemented in itk::ImageToVectorImageFilter< TInputImage >.

Definition at line 210 of file itkProcessObject.cxx.

void itk::ProcessObject::SetNthOutput	(	unsigned int	idx,
		DataObject *	output
	)

protectedvirtualinherited

Protected methods for setting outputs. Subclasses make use of them for getting output.

Set an output of this filter. This method specifically does not do a Register()/UnRegister() because of the desire to break the reference counting loop.

Definition at line 333 of file itkProcessObject.cxx.

References itk::DataObject::ConnectSource().

Referenced by itk::AutomaticTopologyMeshSource< TOutputMesh >::AutomaticTopologyMeshSource(), itk::BalloonForceFilter< TInputMesh, TOutputMesh >::BalloonForceFilter(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::BoundaryResolver(), itk::CoreAtomImageToDistanceMatrixProcess< TSourceImage >::CoreAtomImageToDistanceMatrixProcess(), itk::CoreAtomImageToUnaryCorrespondenceMatrixProcess< TSourceImage >::CoreAtomImageToUnaryCorrespondenceMatrixProcess(), itk::SimplexMeshToTriangleMeshFilter< TInputMesh, TOutputMesh >::CreateTriangles(), itk::DeformableMesh3DFilter< TInputMesh, TOutputMesh >::DeformableMesh3DFilter(), itk::DeformableSimplexMesh3DFilter< TInputMesh, TOutputMesh >::DeformableSimplexMesh3DFilter(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::EquivalenceRelabeler(), itk::ExtensionVelocitiesImageFilter< TLevelSet, TAuxValue, VAuxDimension >::ExtensionVelocitiesImageFilter(), itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >::FastMarchingExtensionImageFilter(), otb::FillGapsFilter::FillGapsFilter(), itk::ImageRegistrationMethod< TFixedImage, TMovingImage >::ImageRegistrationMethod(), itk::ImageSource< TOutputImage >::ImageSource(), itk::Statistics::ImageToListGenerator< TImage, TMaskImage >::ImageToListGenerator(), itk::ImageToMeshFilter< TInputImage, TOutputMesh >::ImageToMeshFilter(), itk::ImageToSpatialObjectRegistrationMethod< TFixedImage, TMovingSpatialObject >::ImageToSpatialObjectRegistrationMethod(), itk::SimplexMeshAdaptTopologyFilter< TInputMesh, TOutputMesh >::InsertNewCells(), otb::Statistics::ListSampleToBalancedListSampleFilter< TInputSampleList, TLabelSampleList, TOutputSampleList >::ListSampleToBalancedListSampleFilter(), otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::MeanShiftSmoothingImageFilter(), itk::MedialNodePairCorrespondenceProcess< TSourceImage >::MedialNodePairCorrespondenceProcess(), itk::MedialNodeTripletCorrespondenceProcess< TSourceImage >::MedialNodeTripletCorrespondenceProcess(), itk::MeshSource< TOutputMesh >::MeshSource(), itk::MinimumMaximumImageFilter< TInputImage >::MinimumMaximumImageFilter(), otb::MinMaxAttributesLabelMapFilter< TInputImage >::MinMaxAttributesLabelMapFilter(), itk::MultiResolutionImageRegistrationMethod< TFixedImage, TMovingImage >::MultiResolutionImageRegistrationMethod(), itk::MultiScaleHessianBasedMeasureImageFilter< TInputImage, THessianImage, TOutputImage >::MultiScaleHessianBasedMeasureImageFilter(), itk::PathSource< TOutputPath >::PathSource(), otb::PersistentCompareImageFilter< TInputImage >::PersistentCompareImageFilter(), otb::PersistentDescriptorsListSampleGenerator< TInputImage, TVectorData, TFunctionType, TListSample, TLabelListSample >::PersistentDescriptorsListSampleGenerator(), otb::PersistentHistogramVectorImageFilter< TInputImage >::PersistentHistogramVectorImageFilter(), otb::PersistentInnerProductVectorImageFilter< TInputImage >::PersistentInnerProductVectorImageFilter(), otb::PersistentMatrixTransposeMatrixImageFilter< TInputImage, TInputImage2 >::PersistentMatrixTransposeMatrixImageFilter(), otb::PersistentMinMaxImageFilter< TInputImage >::PersistentMinMaxImageFilter(), otb::PersistentMinMaxVectorImageFilter< TInputImage >::PersistentMinMaxVectorImageFilter(), otb::PersistentObjectDetectionClassifier< TInputImage, TOutputVectorData, TLabel, TFunctionType >::PersistentObjectDetectionClassifier(), otb::PersistentStatisticsImageFilter< TInputImage >::PersistentStatisticsImageFilter(), otb::PersistentStreamingStatisticsMapFromLabelImageFilter< TInputVectorImage, TLabelImage >::PersistentStreamingStatisticsMapFromLabelImageFilter(), otb::PersistentStreamingStatisticsVectorImageFilter< TInputImage, TPrecision >::PersistentStreamingStatisticsVectorImageFilter(), otb::PersistentVectorImageToMatrixFilter< TInputImage >::PersistentVectorImageToMatrixFilter(), itk::PointSetToImageRegistrationMethod< TFixedPointSet, TMovingImage >::PointSetToImageRegistrationMethod(), itk::PointSetToPointSetRegistrationMethod< TFixedPointSet, TMovingPointSet >::PointSetToPointSetRegistrationMethod(), otb::ProspectModel::ProspectModel(), itk::RegularSphereMeshSource< TOutputMesh >::RegularSphereMeshSource(), itk::watershed::Relabeler< TScalarType, TImageDimension >::Relabeler(), otb::SailModel::SailModel(), itk::watershed::Segmenter< TInputImage >::Segmenter(), itk::watershed::SegmentTreeGenerator< TScalarType >::SegmentTreeGenerator(), itk::watershed::Segmenter< InputImageType >::SetBoundary(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetEquivalencyTable(), itk::MeshSource< TOutputMesh >::SetOutput(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetOutputImage(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetOutputImage(), itk::watershed::Segmenter< InputImageType >::SetOutputImage(), itk::watershed::Segmenter< InputImageType >::SetSegmentTable(), itk::SimplexMeshAdaptTopologyFilter< TInputMesh, TOutputMesh >::SimplexMeshAdaptTopologyFilter(), itk::SphereMeshSource< TOutputMesh >::SphereMeshSource(), itk::StatisticsImageFilter< TInputImage >::StatisticsImageFilter(), itk::TriangleMeshToSimplexMeshFilter< TInputMesh, TOutputMesh >::TriangleMeshToSimplexMeshFilter(), itk::TwoOutputExampleImageFilter< TImage >::TwoOutputExampleImageFilter(), itk::VTKPolyDataReader< TOutputMesh >::VTKPolyDataReader(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::WaveletPacketTransform(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE, FullyDecomposedWaveletPacketCost< TInputImage > >::WaveletPacketTransform(), otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::WaveletTransform(), and otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE >::WaveletTransform().

void itk::ProcessObject::SetNumberOfInputs ( unsigned int num )

protectedinherited

Called to allocate the input array. Copies old inputs.

Called by constructor to set up input array.

Definition at line 96 of file itkProcessObject.cxx.

Referenced by otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::WaveletPacketTransform(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE, FullyDecomposedWaveletPacketCost< TInputImage > >::WaveletPacketTransform(), otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::WaveletTransform(), and otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE >::WaveletTransform().

void itk::ProcessObject::SetNumberOfOutputs ( unsigned int num )

protectedinherited

Called to allocate the output array. Copies old outputs.

Called by constructor to set up output array.

Definition at line 424 of file itkProcessObject.cxx.

Referenced by otb::MeanShiftSmoothingImageFilter< TInputImage, TOutputImage, TKernel, TOutputIterationImage >::MeanShiftSmoothingImageFilter(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::WaveletPacketTransform(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE, FullyDecomposedWaveletPacketCost< TInputImage > >::WaveletPacketTransform(), otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::WaveletTransform(), and otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE >::WaveletTransform().

virtual void itk::ProcessObject::SetNumberOfRequiredInputs ( unsigned int _arg )

protectedvirtualinherited

Referenced by itk::DeformableSimplexMesh3DFilter< TInputMesh, TOutputMesh >::DeformableSimplexMesh3DFilter(), itk::ExtensionVelocitiesImageFilter< TLevelSet, TAuxValue, VAuxDimension >::ExtensionVelocitiesImageFilter(), itk::FastMarchingImageFilter< TLevelSet, TSpeedImage >::FastMarchingImageFilter(), otb::FillGapsFilter::FillGapsFilter(), otb::ImageToLabelMapWithAttributesFilter< TInputImage, TLabeledImage, TLabel, TLabelObject >::ImageToLabelMapWithAttributesFilter(), itk::ImageToMeshFilter< TInputImage, TOutputMesh >::ImageToMeshFilter(), itk::PasteImageFilter< TInputImage, TSourceImage, TOutputImage >::PasteImageFilter(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::WaveletPacketTransform(), otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE, FullyDecomposedWaveletPacketCost< TInputImage > >::WaveletPacketTransform(), otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::WaveletTransform(), and otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::INVERSE >::WaveletTransform().

virtual void itk::ProcessObject::SetNumberOfRequiredOutputs ( unsigned int _arg )

protectedvirtualinherited

Referenced by itk::AutomaticTopologyMeshSource< TOutputMesh >::AutomaticTopologyMeshSource(), itk::BalloonForceFilter< TInputMesh, TOutputMesh >::BalloonForceFilter(), itk::CoreAtomImageToDistanceMatrixProcess< TSourceImage >::CoreAtomImageToDistanceMatrixProcess(), itk::CoreAtomImageToUnaryCorrespondenceMatrixProcess< TSourceImage >::CoreAtomImageToUnaryCorrespondenceMatrixProcess(), itk::DeformableMesh3DFilter< TInputMesh, TOutputMesh >::DeformableMesh3DFilter(), itk::DeformableSimplexMesh3DFilter< TInputMesh, TOutputMesh >::DeformableSimplexMesh3DFilter(), itk::ExtensionVelocitiesImageFilter< TLevelSet, TAuxValue, VAuxDimension >::ExtensionVelocitiesImageFilter(), itk::FastMarchingExtensionImageFilter< TLevelSet, TAuxValue, VAuxDimension, TSpeedImage >::FastMarchingExtensionImageFilter(), otb::FillGapsFilter::FillGapsFilter(), otb::GeometriesSource::GeometriesSource(), itk::ImageSource< TOutputImage >::ImageSource(), itk::ImageToMeshFilter< TInputImage, TOutputMesh >::ImageToMeshFilter(), itk::MedialNodePairCorrespondenceProcess< TSourceImage >::MedialNodePairCorrespondenceProcess(), itk::MedialNodeTripletCorrespondenceProcess< TSourceImage >::MedialNodeTripletCorrespondenceProcess(), itk::MeshSource< TOutputMesh >::MeshSource(), itk::MultiScaleHessianBasedMeasureImageFilter< TInputImage, THessianImage, TOutputImage >::MultiScaleHessianBasedMeasureImageFilter(), otb::OSMDataToVectorDataGenerator::OSMDataToVectorDataGenerator(), itk::PathSource< TOutputPath >::PathSource(), itk::RegularSphereMeshSource< TOutputMesh >::RegularSphereMeshSource(), itk::watershed::Relabeler< TScalarType, TImageDimension >::Relabeler(), itk::SimplexMeshAdaptTopologyFilter< TInputMesh, TOutputMesh >::SimplexMeshAdaptTopologyFilter(), itk::SphereMeshSource< TOutputMesh >::SphereMeshSource(), itk::TriangleMeshToSimplexMeshFilter< TInputMesh, TOutputMesh >::TriangleMeshToSimplexMeshFilter(), itk::TwoOutputExampleImageFilter< TImage >::TwoOutputExampleImageFilter(), and itk::VTKPolyDataReader< TOutputMesh >::VTKPolyDataReader().

virtual void itk::ProcessObject::SetNumberOfThreads ( int _arg )

virtualinherited

Get/Set the number of threads to create when executing.

Referenced by itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::Compute2ndDerivative(), itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::Compute2ndDerivativePos(), and itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >::PrecalculateChange().

virtual void itk::ProcessObject::SetProgress ( float _arg )

virtualinherited

Set the execution progress of a process object. The progress is a floating number in [0,1] with 0 meaning no progress and 1 meaning the filter has completed execution. The ProgressEvent is NOT invoked.

void itk::Object::SetReferenceCount ( int ref )

virtualinherited

Sets the reference count (use with care)

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 347 of file itkObject.cxx.

virtual void itk::ProcessObject::SetReleaseDataBeforeUpdateFlag ( bool _arg )

virtualinherited

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released/reallocated during an Update(). In limited memory scenarios, a user may want to force the elements of a pipeline to release any bulk data that is going to be regenerated anyway during an Update() in order to control peak memory allocation. Note that this flag is different from the ReleaseDataFlag. ReleaseDataFlag manages the deallocation of a ProcessObject's bulk output data once that data has been consumed by a downstream ProcessObject. The ReleaseDataBeforeUpdateFlag manages the deallocation/reallocation of bulk data during a pipeline update to control peak memory utilization. Default value is on.

void itk::ProcessObject::SetReleaseDataFlag ( bool flag )

virtualinherited

Turn on/off the flags to control whether the bulk data belonging to the outputs of this ProcessObject are released after being used by a downstream ProcessObject. Default value is off. Another options for controlling memory utilization is the ReleaseDataBeforeUpdateFlag.

Definition at line 528 of file itkProcessObject.cxx.

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 >::SetUseCompression ( bool _arg )

virtual

Set the compression On or Off

void itk::Object::UnRegister ( ) const

virtualinherited

Decrease the reference count (release by another object).

If there is a delete method, invoke it.

Reimplemented from itk::LightObject.

Definition at line 324 of file itkObject.cxx.

Referenced by itk::Object::New(), and itk::ObjectFactoryBase::UnRegisterFactory().

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

void itk::ProcessObject::UpdateLargestPossibleRegion ( )

virtualinherited

Like Update(), but sets the output requested region to the largest possible region for the output. This is the method users should call if they want the entire dataset to be processed. If a user wants to update the same output region as a previous call to Update() or a previous call to UpdateLargestPossibleRegion(), then they should call the method Update().

Definition at line 1120 of file itkProcessObject.cxx.

void itk::ProcessObject::UpdateOutputData ( DataObject * output )

virtualinherited

Actually generate new output

 prevent chasing our tail

 Prepare all the outputs. This may deallocate previous bulk data.

 Propagate the update call - make sure everything we
 might rely on is up-to-date
 Must call PropagateRequestedRegion before UpdateOutputData if multiple 
 inputs since they may lead back to the same data object.

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

 Tell all Observers that the filter is starting

 GenerateData this object - we have not aborted yet, and our progress
 before we start to execute is 0.0.

 Count the number of required inputs which have been assigned

 If we ended due to aborting, push the progress up to 1.0 (since
 it probably didn't end there)

 Notify end event observers

 Now we have to mark the data as up to date.

 Restore the state of any input ReleaseDataFlags

 Release any inputs if marked for release

Reimplemented in itk::StreamingImageFilter< TInputImage, TOutputImage >.

Definition at line 908 of file itkProcessObject.cxx.

void itk::ProcessObject::UpdateOutputInformation ( void )

virtualinherited

Update the information decribing the output data. This method transverses up the pipeline gathering modified time information. On the way back down the pipeline, this method calls GenerateOutputInformation() to set any necessary information about the output data objects. For instance, a filter that shrinks an image will need to provide an implementation for GenerateOutputInformation() that changes the spacing of the pixels. Such filters should call their superclass' implementation of GenerateOutputInformation prior to changing the information values they need (i.e. GenerateOutputInformation() should call Superclass::GenerateOutputInformation() prior to changing the information.

 Watch out for loops in the pipeline

   Since we are in a loop, we will want to update. But if
   we don't modify this filter, then we will not execute
   because our OutputInformationMTime will be more recent than
   the MTime of our output.

 We now wish to set the PipelineMTime of each output DataObject to
 the largest of this ProcessObject's MTime, all input DataObject's
 PipelineMTime, and all input's MTime.  We begin with the MTime of
 this ProcessObject.

 Loop through the inputs

     Propagate the UpdateOutputInformation call

     What is the PipelineMTime of this input? Compare this against
     our current computation to find the largest one.

     Pipeline MTime of the input does not include the MTime of the 
     data object itself. Factor these mtimes into the next PipelineMTime

 Call GenerateOutputInformation for subclass specific information.
 Since UpdateOutputInformation propagates all the way up the pipeline,
 we need to be careful here to call GenerateOutputInformation only if
 necessary. Otherwise, we may cause this source to be modified which
 will cause it to execute again on the next update.

   Keep track of the last time GenerateOutputInformation() was called

Reimplemented in itk::watershed::Segmenter< TInputImage >, itk::watershed::Segmenter< InputImageType >, and itk::VTKImageImport< TOutputImage >.

Definition at line 664 of file itkProcessObject.cxx.

References itk::Object::GetMTime(), itk::DataObject::GetPipelineMTime(), itk::DataObject::SetPipelineMTime(), and itk::DataObject::UpdateOutputInformation().

Referenced by itk::VTKImageExportBase::UpdateInformationCallback().

void itk::ProcessObject::UpdateProgress ( float amount )

inherited

Update the progress of the process object.

Sets the Progress ivar to amount and invokes any observers for the ProgressEvent. The parameter amount should be in [0,1] and is the cumulative (not incremental) progress.

Update the progress of the process object. If a ProgressMethod exists, execute it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).

Definition at line 500 of file itkProcessObject.cxx.

Referenced by itk::WatershedMiniPipelineProgressCommand::Execute(), itk::ProgressReporter::ProgressReporter(), and itk::ProgressReporter::~ProgressReporter().

template<class TInputImage, class TOutputImage>

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

virtual

template<class TInputImage, class TOutputImage>

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

virtual

template<class TInputImage , class TOutputImage >

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.

Definition at line 94 of file itkImageSeriesWriter.txx.

template<class TInputImage , class TOutputImage >

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

private

Definition at line 197 of file itkImageSeriesWriter.txx.

References itk::Size< VDimension >::Fill(), itk::ImageConstIterator< TImage >::Get(), itk::ImageRegion< VImageDimension >::GetSize(), itk::ImageRegionConstIterator< TImage >::GoToBegin(), itk::ImageConstIterator< TImage >::IsAtEnd(), itk::ITK_NumberOfDimensions, itk::ITK_Origin, itk::ITK_Spacing, itk::ImageRegionIterator< TImage >::Set(), itk::ImageRegion< VImageDimension >::SetIndex(), and itk::ImageRegion< VImageDimension >::SetSize().

Member Data Documentation

template<class TInputImage, class TOutputImage>

FileNamesContainer itk::ImageSeriesWriter< TInputImage, TOutputImage >::m_FileNames

private

A list of filenames to be processed.

Definition at line 215 of file itkImageSeriesWriter.h.

template<class TInputImage, class TOutputImage>

ImageIOBase::Pointer itk::ImageSeriesWriter< TInputImage, TOutputImage >::m_ImageIO

protected

Definition at line 206 of file itkImageSeriesWriter.h.

template<class TInputImage, class TOutputImage>

unsigned long itk::ImageSeriesWriter< TInputImage, TOutputImage >::m_IncrementIndex

private

Definition at line 224 of file itkImageSeriesWriter.h.

template<class TInputImage, class TOutputImage>

DictionaryArrayRawPointer itk::ImageSeriesWriter< TInputImage, TOutputImage >::m_MetaDataDictionaryArray

private

Array of MetaDataDictionary used for passing information to each slice

Definition at line 229 of file itkImageSeriesWriter.h.

TimeStamp itk::ProcessObject::m_OutputInformationMTime

protectedinherited

Time when GenerateOutputInformation was last called.

Definition at line 421 of file itkProcessObject.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount

mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock

mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 144 of file itkLightObject.h.

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

template<class TInputImage, class TOutputImage>

unsigned long itk::ImageSeriesWriter< TInputImage, TOutputImage >::m_StartIndex

private

Definition at line 223 of file itkImageSeriesWriter.h.

bool itk::ProcessObject::m_Updating

protectedinherited

These ivars are made protected so filters like itkStreamingImageFilter can access them directly. This flag indicates when the pipeline is executing. It prevents infinite recursion when pipelines have loops.

Reimplemented in otb::ImageViewerBase< TPixel, TLabel >, and otb::HistogramAndTransferFunctionWidget< THistogram, TPixel >.

Definition at line 418 of file itkProcessObject.h.

template<class TInputImage, class TOutputImage>

bool itk::ImageSeriesWriter< TInputImage, TOutputImage >::m_UseCompression

private

Definition at line 226 of file itkImageSeriesWriter.h.

template<class TInputImage, class TOutputImage>

bool itk::ImageSeriesWriter< TInputImage, TOutputImage >::m_UserSpecifiedImageIO

protected

Definition at line 207 of file itkImageSeriesWriter.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

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

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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