Data source that reads image data from a single file. More...

#include <itkImageFileReader.h>

Inheritance diagram for itk::ImageFileReader< TOutputImage, ConvertPixelTraits >:

Collaboration diagram for itk::ImageFileReader< TOutputImage, ConvertPixelTraits >:

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType
typedef TOutputImage::RegionType	ImageRegionType
typedef TOutputImage::IndexType	IndexType
typedef TOutputImage::InternalPixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef ImageFileReader	Self
typedef TOutputImage::SizeType	SizeType
typedef ImageSource< TOutputImage >	Superclass

Public Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
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 *output)
virtual void	GenerateOutputInformation (void)
virtual const bool &	GetAbortGenerateData ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual const char *	GetFileName () const
virtual ImageIOBase *	GetImageIO ()
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
OutputImageType *	GetOutput (void)
OutputImageType *	GetOutput (unsigned int idx)
DataObjectPointerArray &	GetOutputs ()
virtual const float &	GetProgress ()
virtual int	GetReferenceCount () const
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual bool	GetReleaseDataFlag () const
virtual const bool &	GetUseStreaming ()
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (DataObject *output)
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
virtual void	SetFileName (const char *_arg)
void	SetImageIO (ImageIOBase *imageIO)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
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	SetUseStreaming (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	UseStreamingOff ()
virtual void	UseStreamingOn ()

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

Static Public Attributes
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Types
typedef int	InternalReferenceCountType

Protected Member Functions
	ImageFileReader ()
	~ImageFileReader ()
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
virtual void	CacheInputReleaseDataFlags ()
void	DoConvertBuffer (void *buffer, vcl_size_t numberOfPixels)
virtual void	GenerateData ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
DataObject *	GetInput (unsigned int idx)
const DataObject *	GetInput (unsigned int idx) const
virtual const unsigned int &	GetNumberOfRequiredInputs ()
virtual const unsigned int &	GetNumberOfRequiredOutputs ()
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)
virtual int	SplitRequestedRegion (int i, int num, OutputImageRegionType &splitRegion)
void	TestFileExistanceAndReadability ()
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)

Static Protected Member Functions
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)

Protected Attributes
std::string	m_FileName
ImageIOBase::Pointer	m_ImageIO
TimeStamp	m_OutputInformationMTime
InternalReferenceCountType	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
bool	m_Updating
bool	m_UserSpecifiedImageIO
bool	m_UseStreaming

Private Member Functions
	ImageFileReader (const Self &)
void	operator= (const Self &)

Private Attributes
ImageIORegion	m_ActualIORegion
std::string	m_ExceptionMessage

Detailed Description

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
class itk::ImageFileReader< TOutputImage, ConvertPixelTraits >

Data source that reads image data from a single file.

This source object is a general filter to read data from a variety of file formats. It works with a ImageIOBase subclass to actually do the reading of the data. Object factory machinery can be used to automatically create the ImageIOBase, or the ImageIOBase can be manually created and set. Note that this class reads data from a single file; if you wish to read data from a series of files use ImageSeriesReader.

TOutputImage is the type expected by the external users of the filter. If data stored in the file is stored in a different format then specified by TOutputImage, than this filter converts data between the file type and the external expected type. The ConvertTraits template argument is used to do the conversion.

A Pluggable factory pattern is used this allows different kinds of readers to be registered (even at run time) without having to modify the code in this class. Normally just setting the FileName with the appropriate suffix is enough to get the reader to instantiate the correct ImageIO and read the file properly. However, some files (like raw binary format) have no accepted suffix, so you will have to manually create the ImageIO instance of the write type.

See also:: ImageSeriesReader; ImageIOBase

Definition at line 93 of file itkImageFileReader.h.

Member Typedef Documentation

template<class TOutputImage>

typedef SmartPointer<const Self> itk::ImageSource< TOutputImage >::ConstPointer

inherited

Reimplemented from itk::ProcessObject.

Definition at line 59 of file itkImageSource.h.

template<class TOutputImage>

typedef DataObject::Pointer itk::ImageSource< TOutputImage >::DataObjectPointer

inherited

Smart Pointer type to a DataObject.

Reimplemented from itk::ProcessObject.

Definition at line 62 of file itkImageSource.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 TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>

typedef TOutputImage::RegionType itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::ImageRegionType

The region of the output image.

Reimplemented in otb::ImageFileReader< TOutputImage >.

Definition at line 114 of file itkImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>

typedef TOutputImage::IndexType itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::IndexType

The size of the output image.

Definition at line 111 of file itkImageFileReader.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 TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>

typedef TOutputImage::InternalPixelType itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::OutputImagePixelType

The pixel type of the output image.

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in otb::ImageFileReader< TOutputImage >.

Definition at line 117 of file itkImageFileReader.h.

template<class TOutputImage>

typedef OutputImageType::Pointer itk::ImageSource< TOutputImage >::OutputImagePointer

inherited

Definition at line 69 of file itkImageSource.h.

template<class TOutputImage>

typedef OutputImageType::RegionType itk::ImageSource< TOutputImage >::OutputImageRegionType

inherited

Definition at line 70 of file itkImageSource.h.

template<class TOutputImage>

typedef TOutputImage itk::ImageSource< TOutputImage >::OutputImageType

inherited

Some convenient typedefs.

Definition at line 65 of file itkImageSource.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>

typedef SmartPointer<Self> itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::Pointer

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in otb::ImageFileReader< TOutputImage >.

Definition at line 99 of file itkImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>

typedef ImageFileReader itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::Self

Standard class typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in otb::ImageFileReader< TOutputImage >.

Definition at line 97 of file itkImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>

typedef TOutputImage::SizeType itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::SizeType

The size of the output image.

Reimplemented in otb::ImageFileReader< TOutputImage >.

Definition at line 105 of file itkImageFileReader.h.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>

typedef ImageSource<TOutputImage> itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::Superclass

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in otb::ImageFileReader< TOutputImage >.

Definition at line 98 of file itkImageFileReader.h.

Constructor & Destructor Documentation

template<class TOutputImage , class ConvertPixelTraits >

itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::ImageFileReader ( )

protected

Reimplemented in otb::ImageFileReader< TOutputImage >.

Definition at line 36 of file itkImageFileReader.txx.

template<class TOutputImage , class ConvertPixelTraits >

itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::~ImageFileReader ( )

protected

Reimplemented in otb::ImageFileReader< TOutputImage >.

Definition at line 46 of file itkImageFileReader.txx.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>

itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::ImageFileReader ( 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.

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

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::AfterThreadedGenerateData ( void )

inlineprotectedvirtualinherited

If an imaging filter needs to perform processing after all processing threads have completed, the filter can can provide an implementation for AfterThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Definition at line 264 of file itkImageSource.h.

template<class TOutputImage >

void itk::ImageSource< TOutputImage >::AllocateOutputs ( )

protectedvirtualinherited

The GenerateData method normally allocates the buffers for all of the outputs of a filter. Some filters may want to override this default behavior. For example, a filter may have multiple outputs with varying resolution. Or a filter may want to process data in place by grafting its input to its output.

Definition at line 197 of file itkImageSource.txx.

References itk::ProcessObject::GetOutput(), and itk::ImageBase< VImageDimension >::SetBufferedRegion().

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::BeforeThreadedGenerateData ( void )

inlineprotectedvirtualinherited

If an imaging filter needs to perform processing after the buffer has been allocated but before threads are spawned, the filter can can provide an implementation for BeforeThreadedGenerateData(). The execution flow in the default GenerateData() method will be: 1) Allocate the output buffer 2) Call BeforeThreadedGenerateData() 3) Spawn threads, calling ThreadedGenerateData() in each thread. 4) Call AfterThreadedGenerateData() Note that this flow of control is only available if a filter provides a ThreadedGenerateData() method and NOT a GenerateData() method.

Definition at line 252 of file itkImageSource.h.

Referenced by otb::RenderingImageFilter< TInputImage, TOutputImage >::BeforeThreadedGenerateData().

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 TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>

virtual::itk::LightObject::Pointer itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::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.

Reimplemented in otb::ImageFileReader< TOutputImage >.

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.

template<class TOutputImage , class ConvertPixelTraits >

void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::DoConvertBuffer	(	void *	buffer,
		vcl_size_t	numberOfPixels
	)

protected

Convert a block of pixels from one type to another.

Definition at line 478 of file itkImageFileReader.txx.

References ITK_CONVERT_BUFFER_IF_BLOCK, ITK_CONVERT_CBUFFER_IF_BLOCK, itk::ExceptionObject::SetDescription(), and itk::ExceptionObject::SetLocation().

template<class TOutputImage , class ConvertPixelTraits >

void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::EnlargeOutputRequestedRegion ( DataObject * output )

virtual

Give the reader a chance to indicate that it will produce more output than it was requested to produce. ImageFileReader cannot currently read a portion of an image (since the ImageIO objects cannot read a portion of an image), so the ImageFileReader must enlarge the RequestedRegion to the size of the image on disk.

Reimplemented from itk::ProcessObject.

Reimplemented in otb::ImageFileReader< TOutputImage >.

Definition at line 293 of file itkImageFileReader.txx.

References itk::ImageIORegion::GetIndex(), itk::ExceptionObject::SetDescription(), and itk::ExceptionObject::SetLocation().

template<class TOutputImage , class ConvertPixelTraits >

void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::GenerateData ( void )

protectedvirtual

Does the real work.

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in otb::ImageFileReader< TOutputImage >.

Definition at line 360 of file itkImageFileReader.txx.

References itk::ExceptionObject::GetDescription(), and ITK_TYPENAME.

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 TOutputImage , class ConvertPixelTraits >

void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::GenerateOutputInformation ( void )

virtual

Prepare the allocation of the output image during the first back propagation of the pipeline.

Reimplemented from itk::ProcessObject.

Reimplemented in otb::ImageFileReader< TOutputImage >.

Definition at line 90 of file itkImageFileReader.txx.

References itk::ObjectFactoryBase::CreateAllInstance(), itk::ImageIOFactory::CreateImageIO(), itk::ExceptionObject::GetDescription(), itk::ImageIOBase::GetNameOfClass(), and itk::ImageIOFactory::ReadMode.

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 TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>

virtual const char* itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::GetFileName ( ) const

virtual

Reimplemented in otb::ImageFileReader< TOutputImage >.

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 TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>

virtual ImageIOBase* itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::GetImageIO ( )

virtual

Referenced by itk::ImageSeriesReader< TOutputImage >::ComputeMovingDimensionIndex().

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

protectedinherited

Method used internally for getting an input.

Definition at line 470 of file itkProcessObject.cxx.

References NULL.

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 TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>

virtual const char* itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in otb::ImageFileReader< TOutputImage >.

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.

template<class TOutputImage >

ImageSource< TOutputImage >::OutputImageType * itk::ImageSource< TOutputImage >::GetOutput ( void )

inherited

Get the output data of this process object. The output of this function is not valid until an appropriate Update() method has been called, either explicitly or implicitly. Both the filter itself and the data object have Update() methods, and both methods update the data. Here are three ways to use GetOutput() and make sure the data is valid. In these examples, image is a pointer to some Image object, and the particular ProcessObjects involved are filters. The same examples apply to non-image (e.g. Mesh) data as well.

anotherFilter->SetInput( someFilter->GetOutput() );

anotherFilter->Update();

In this situation, someFilter and anotherFilter are said to constitute a pipeline.

image = someFilter->GetOutput();

image->Update();

someFilter->Update();

image = someFilter->GetOutput();

(In the above example, the two lines of code can be in either order.)

Note that Update() is not called automatically except within a pipeline as in the first example. When streaming (using a StreamingImageFilter) is activated, it may be more efficient to use a pipeline than to call Update() once for each filter in turn.

For an image, the data generated is for the requested Region, which can be set using ImageBase::SetRequestedRegion(). By default, the largest possible region is requested.

For Filters which have multiple outputs of different types, the GetOutput() method assumes the output is of OutputImageType. For the GetOutput(unsigned int) method, a dynamic_cast is performed incase the filter has outputs of different types or image types. Derived classes should have names get methods for these outputs.

Reimplemented in otb::ImageToLabelMapWithAttributesFilter< TInputImage, TLabeledImage, TLabel, TLabelObject >, otb::ImageToModulusAndDirectionImageFilter< TInputImage, TOutputImage, TOutputImageDirection >, otb::ImageToModulusAndDirectionImageFilter< TInputImage, TOutputModulus, TOutputDirection >, otb::ImageToModulusAndDirectionImageFilter< TInputImage, TOutputImage, TOutputImageDirection >, otb::ImageToModulusAndDirectionImageFilter< TInputImage, TOutputModulus, TOutputDirection >, and otb::ImageListToSingleImageFilter< TInputImageType >.

Definition at line 66 of file itkImageSource.txx.

References itk::ProcessObject::GetOutput().

Referenced by itk::LaplacianSegmentationLevelSetFunction< TImageType, TFeatureImageType >::CalculateSpeedImage(), itk::ImageSeriesReader< TOutputImage >::ComputeMovingDimensionIndex(), otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::GenerateData(), otb::ImageSeriesFileReader< Image< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >::GenerateData(), otb::ImageSeriesFileReader< VectorImage< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >::GenerateData(), and main().

template<class TOutputImage >

ImageSource< TOutputImage >::OutputImageType * itk::ImageSource< TOutputImage >::GetOutput ( unsigned int idx )

inherited

Method used internally for getting an output.

Reimplemented from itk::ProcessObject.

Definition at line 85 of file itkImageSource.txx.

References itk::ProcessObject::GetOutput(), and 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 TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>

virtual const bool& itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::GetUseStreaming ( )

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

template<class TOutputImage >

void itk::ImageSource< TOutputImage >::GraftNthOutput	(	unsigned int	idx,
		DataObject *	output
	)

virtualinherited

Graft the specified data object onto this ProcessObject's idx'th output. This is similar to the GraftOutput method except it allows you to specify which output is affected. The specified index must be a valid output number (less than ProcessObject::GetNumberOfOutputs()). See the GraftOutput for general usage information.

Definition at line 113 of file itkImageSource.txx.

References itk::ProcessObject::GetOutput(), and itk::DataObject::Graft().

template<class TOutputImage >

void itk::ImageSource< TOutputImage >::GraftOutput ( DataObject * output )

virtualinherited

Graft the specified DataObject onto this ProcessObject's output. This method grabs a handle to the specified DataObject's bulk data to used as its output's own bulk data. It also copies the region ivars (RequestedRegion, BufferedRegion, LargestPossibleRegion) and meta-data (Spacing, Origin) from the specified data object into this filter's output data object. Most importantly, however, it leaves the Source ivar untouched so the original pipeline routing is intact. This method is used when a process object is implemented using a mini-pipeline which is defined in its GenerateData() method. The usage is:

        // setup the mini-pipeline to process the input to this filter
        firstFilterInMiniPipeline->SetInput( this->GetInput() );
   
        // setup the mini-pipeline to calculate the correct regions
        // and write to the appropriate bulk data block
        lastFilterInMiniPipeline->GraftOutput( this->GetOutput() );
    
        // execute the mini-pipeline
        lastFilterInMiniPipeline->Update();
    
        // graft the mini-pipeline output back onto this filter's output.
        // this is needed to get the appropriate regions passed back.
        this->GraftOutput( lastFilterInMiniPipeline->GetOutput() );

For proper pipeline execution, a filter using a mini-pipeline must implement the GenerateInputRequestedRegion(), GenerateOutputRequestedRegion(), GenerateOutputInformation() and EnlargeOutputRequestedRegion() methods as necessary to reflect how the mini-pipeline will execute (in other words, the outer filter's pipeline mechanism must be consistent with what the mini-pipeline will do).

Definition at line 101 of file itkImageSource.txx.

Referenced by otb::ImageSeriesFileReader< Image< TPixel, 2 >, Image< TInternalPixel, 2 > >::GenerateData(), otb::ImageSeriesFileReader< Image< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >::GenerateData(), otb::ImageSeriesFileReader< VectorImage< TPixel, 2 >, VectorImage< TInternalPixel, 2 > >::GenerateData(), and itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IterateThreaderCallback().

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.

template<class TOutputImage >

ImageSource< TOutputImage >::DataObjectPointer itk::ImageSource< TOutputImage >::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 SmartPointer to a DataObject. If a subclass of ImageSource has multiple outputs of different types, then that class must provide an implementation of MakeOutput().

Reimplemented from itk::ProcessObject.

Definition at line 55 of file itkImageSource.txx.

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 TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>

static Pointer itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::New ( )

static

Method for creation through the object factory.

Reimplemented from itk::Object.

Reimplemented in otb::ImageFileReader< TOutputImage >.

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>

void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::operator= ( const Self & )

private

Reimplemented from itk::ImageSource< TOutputImage >.

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 TOutputImage , class ConvertPixelTraits >

void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::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.

Reimplemented in otb::ImageFileReader< TOutputImage >.

Definition at line 52 of file itkImageFileReader.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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >> class itk::ImageFileReader< TOutputImage, ConvertPixelTraits >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

template<class TOutputImage, class ConvertPixelTraits = DefaultConvertPixelTraits< typename TOutputImage::IOPixelType >>
class itk::ImageFileReader< TOutputImage, ConvertPixelTraits >