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 ()
virtual LightObject::Pointer	CreateAnother () 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
DataObjectPointerArray &	GetInputs ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
MultiThreader *	GetMultiThreader ()
virtual const char *	GetNameOfClass () const
DataObjectPointerArraySizeType	GetNumberOfInputs () const
virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const
virtual const float &	GetProgress ()
virtual int	GetReferenceCount () const
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
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetProgress (float _arg)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
virtual void	Update ()
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)


virtual void	SetFileName (const char *_arg)
virtual const char *	GetFileName () const


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


virtual void	SetUseStreaming (bool _arg)
virtual const bool &	GetUseStreaming ()
virtual void	UseStreamingOn ()
virtual void	UseStreamingOff ()


OutputImageType *	GetOutput (void)
OutputImageType *	GetOutput (unsigned int idx)


DataObjectPointerArray &	GetOutputs ()
DataObjectPointerArraySizeType	GetNumberOfOutputs () const


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


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


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


unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
Static Public Member Functions
static void	BreakOnError ()
static Pointer	New ()


static void	SetGlobalWarningDisplay (bool flag)
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOn ()
static void	GlobalWarningDisplayOff ()
Static Public Attributes
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension
Protected Types


typedef int	InternalReferenceCountType
Protected Member Functions
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)
	ImageFileReader ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PropagateResetPipeline ()
virtual void	ReleaseInputs ()
virtual void	RestoreInputReleaseDataFlags ()
void	SetNumberOfInputs (unsigned int num)
void	SetNumberOfOutputs (unsigned int num)
virtual int	SplitRequestedRegion (int i, int num, OutputImageRegionType &splitRegion)
void	TestFileExistanceAndReadability ()
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId) ITK_NO_RETURN
	~ImageFileReader ()


const DataObject *	GetOutput (unsigned int idx) const


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


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


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


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


virtual void	PrintHeader (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
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

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

Examples:: DataRepresentation/Image/Image2.cxx, DataRepresentation/Image/RGBImage.cxx, Examples/Iterators/ImageLinearIteratorWithIndex.cxx, Iterators/ImageRegionIterator.cxx, Iterators/ImageRegionIteratorWithIndex.cxx, and Testing/Code/Common/itkVectorImageTest.cxx.

Definition at line 94 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.

Reimplemented in itk::BayesianClassifierImageFilter< TInputVectorImage, TLabelsType, TPosteriorsPrecisionType, TPriorsPrecisionType >, itk::LabelStatisticsImageFilter< TInputImage, TLabelImage >, itk::MinimumMaximumImageFilter< TInputImage >, itk::SignedDanielssonDistanceMapImageFilter< TInputImage, TOutputImage >, itk::StatisticsImageFilter< TInputImage >, itk::StreamingImageFilter< TInputImage, TOutputImage >, itk::LabelGeometryImageFilter< TLabelImage, TIntensityImage >, and itk::MultiScaleHessianBasedMeasureImageFilter< TInputImage, THessianImage, TOutputImage >.

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.

Definition at line 115 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 112 of file itkImageFileReader.h.

typedef int itk::LightObject::InternalReferenceCountType [protected, inherited]

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

Definition at line 139 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 >.

Definition at line 118 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 >.

Definition at line 100 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 >.

Definition at line 98 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.

Definition at line 106 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 >.

Definition at line 99 of file itkImageFileReader.h.

Constructor & Destructor Documentation

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

itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::ImageFileReader ( ) [protected]

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

itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::~ImageFileReader ( ) [protected]

Member Function Documentation

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

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

Turn on and off the AbortGenerateData flag.

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

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

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

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

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

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

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

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

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::AfterThreadedGenerateData ( void ) [inline, protected, virtual, inherited]

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 265 of file itkImageSource.h.

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::AllocateOutputs ( ) [protected, virtual, inherited]

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.

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::BeforeThreadedGenerateData ( void ) [inline, protected, virtual, inherited]

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 253 of file itkImageSource.h.

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

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

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

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

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

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

Reimplemented from itk::LightObject.

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

Turn debugging output off.

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

Turn debugging output on.

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

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

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

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

Convert a block of pixels from one type to another.

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

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

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

virtual void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::GenerateData ( ) [protected, virtual]

Does the real work.

Reimplemented from itk::ImageSource< TOutputImage >.

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

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

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

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

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

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.

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

virtual const bool& itk::ProcessObject::GetAbortGenerateData ( ) [virtual, inherited]

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

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.

bool itk::Object::GetDebug ( ) const [inherited]

Get the value of the debug flag.

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

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

Specify the file to read. This is forwarded to the IO instance.

static bool itk::Object::GetGlobalWarningDisplay ( ) [static, inherited]

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

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

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

Set/Get the ImageIO helper class. Often this is created via the object factory mechanism that determines whether a particular ImageIO can read a certain file. This method provides a way to get the ImageIO instance that is created. Or you can directly specify the ImageIO to use to read a particular file in case the factory mechanism will not work properly (e.g., unknown or unusual extension).

DataObject* itk::ProcessObject::GetInput ( unsigned int idx ) [protected, inherited]

Method used internally for getting an input.

const DataObject* itk::ProcessObject::GetInput ( unsigned int idx ) const [protected, inherited]

Method used internally for getting an input.

Reimplemented in itk::MeshToMeshFilter< TInputMesh, TOutputMesh >, and itk::MeshToMeshFilter< TInput, TOutput >.

DataObjectPointerArray& itk::ProcessObject::GetInputs ( ) [inline, inherited]

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.

MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) [inherited]

Returns:: A reference to this objects MetaDataDictionary.

Warning:: This reference may be changed.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary ( void ) const [inherited]

Returns:: A constant reference to this objects MetaDataDictionary.

virtual unsigned long itk::Object::GetMTime ( ) const [virtual, inherited]

Return this objects modified time.

Referenced by itk::SpatialObject< ::itk::GetMeshDimension< TMesh >::PointDimension >::GetObjectMTime().

MultiThreader* itk::ProcessObject::GetMultiThreader ( ) [inline, inherited]

Return the multithreader used by this class.

Definition at line 284 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 >.

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfInputs ( ) const [inline, inherited]

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.

DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfOutputs ( ) const [inline, inherited]

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

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredInputs ( ) [protected, virtual, inherited]

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

virtual const unsigned int& itk::ProcessObject::GetNumberOfRequiredOutputs ( ) [protected, virtual, inherited]

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

virtual const int& itk::ProcessObject::GetNumberOfThreads ( ) [virtual, inherited]

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

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

virtual DataObjectPointerArraySizeType itk::ProcessObject::GetNumberOfValidRequiredInputs ( ) const [virtual, inherited]

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.

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

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

template<class TOutputImage>

OutputImageType* itk::ImageSource< TOutputImage >::GetOutput ( unsigned int idx ) [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 from itk::ProcessObject.

const DataObject* itk::ProcessObject::GetOutput ( unsigned int idx ) const [protected, inherited]

Method used internally for getting an output.

DataObjectPointerArray& itk::ProcessObject::GetOutputs ( ) [inline, inherited]

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.

virtual const float& itk::ProcessObject::GetProgress ( ) [virtual, inherited]

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::XMLFilterWatcher::ShowProgress().

virtual int itk::LightObject::GetReferenceCount ( ) const [inline, virtual, inherited]

Gets the reference count on this object.

Definition at line 106 of file itkLightObject.h.

virtual const bool& itk::ProcessObject::GetReleaseDataBeforeUpdateFlag ( ) [virtual, inherited]

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.

virtual bool itk::ProcessObject::GetReleaseDataFlag ( ) const [virtual, inherited]

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.

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

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

Set the stream On or Off

static void itk::Object::GlobalWarningDisplayOff ( ) [inline, static, inherited]

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

Definition at line 100 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn ( ) [inline, static, inherited]

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

Definition at line 98 of file itkObject.h.

References itk::Object::SetGlobalWarningDisplay().

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::GraftNthOutput	(	unsigned int	idx,
		DataObject *	output
	)			`[virtual, inherited]`

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.

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::GraftOutput ( DataObject * output ) [virtual, inherited]

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

bool itk::Object::HasObserver ( const EventObject & event ) const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent ( const EventObject & ) [inherited]

Call Execute on all the Commands observing this event id.

void itk::Object::InvokeEvent ( const EventObject & ) const [inherited]

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

template<class TOutputImage>

virtual DataObjectPointer itk::ImageSource< TOutputImage >::MakeOutput ( unsigned int idx ) [virtual, inherited]

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.

Reimplemented in itk::BayesianClassifierImageFilter< TInputVectorImage, TLabelsType, TPosteriorsPrecisionType, TPriorsPrecisionType >, itk::EigenAnalysis2DImageFilter< TInputImage, TEigenValueImage, TEigenVectorImage >, itk::MinimumMaximumImageFilter< TInputImage >, itk::SignedDanielssonDistanceMapImageFilter< TInputImage, TOutputImage >, itk::StatisticsImageFilter< TInputImage >, itk::MaskedMovingHistogramImageFilter< TInputImage, TMaskImage, TOutputImage, TKernel, THistogram >, itk::MultiScaleHessianBasedMeasureImageFilter< TInputImage, THessianImage, TOutputImage >, and itk::MaskedMovingHistogramImageFilter< TInputImage, TMaskImage, TOutputImage, TKernel, MaskedRankHistogram< TInputImage::PixelType > >.

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

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

Referenced by itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::InsertNarrowBandNode(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBand(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandInnerRadius(), itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetNarrowBandTotalRadius(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< TInputHistogram >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

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.

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

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.

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

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.

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

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

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

Cause the object to print itself out.

Referenced by itk::WeakPointer< ProcessObject >::Print().

virtual void itk::LightObject::PrintHeader	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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.

bool itk::Object::PrintObservers	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, inherited]`

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

void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual]`

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ProcessObject.

virtual void itk::LightObject::PrintTrailer	(	std::ostream &	os,
		Indent	indent
	)			const `[protected, virtual, inherited]`

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.

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

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

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

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

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

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

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.

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

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.

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

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

Reimplemented from itk::LightObject.

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

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.

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

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::ReleaseDataFlagOff ( ) [inline, inherited]

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

void itk::ProcessObject::ReleaseDataFlagOn ( ) [inline, inherited]

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

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

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

void itk::Object::RemoveAllObservers ( ) [inherited]

Remove all observers .

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

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

void itk::Object::RemoveObserver ( unsigned long tag ) [inherited]

Remove the observer with this tag value.

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

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

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

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.

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

Restore the cached input ReleaseDataFlags.

virtual void itk::ProcessObject::SetAbortGenerateData ( bool _arg ) [virtual, inherited]

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.

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

virtual void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::SetFileName ( const char * _arg ) [virtual]

Specify the file to read. This is forwarded to the IO instance.

static void itk::Object::SetGlobalWarningDisplay ( bool flag ) [static, inherited]

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

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

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

void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::SetImageIO ( ImageIOBase * imageIO )

Set/Get the ImageIO helper class. Often this is created via the object factory mechanism that determines whether a particular ImageIO can read a certain file. This method provides a way to get the ImageIO instance that is created. Or you can directly specify the ImageIO to use to read a particular file in case the factory mechanism will not work properly (e.g., unknown or unusual extension).

void itk::Object::SetMetaDataDictionary ( const MetaDataDictionary & rhs ) [inherited]

Returns:: Set the MetaDataDictionary

virtual void itk::ProcessObject::SetNthInput	(	unsigned int	num,
		DataObject *	input
	)			`[protected, virtual, inherited]`

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

Reimplemented in itk::ImageToVectorImageFilter< TInputImage >.

Referenced by itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetBoundaryA(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetBoundaryB(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetEquivalencyTable(), itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >::SetFeatureImage(), itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType,::itk::GetImageDimension< TInputImage >::ImageDimension > >::SetFeatureImage(), itk::WatershedImageFilter< TInputImage >::SetInput(), itk::watershed::SegmentTreeGenerator< ScalarType >::SetInputEquivalencyTable(), itk::watershed::Segmenter< InputImageType >::SetInputImage(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetInputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetInputImage(), itk::watershed::SegmentTreeGenerator< ScalarType >::SetInputSegmentTable(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetInputSegmentTree(), itk::DiffusionTensor3DReconstructionImageFilter< TReferenceImagePixelType, TGradientImagePixelType, TTensorPixelType >::SetReferenceImage(), and itk::ChangeInformationImageFilter< TInputImage >::SetReferenceImage().

virtual void itk::ProcessObject::SetNthOutput	(	unsigned int	num,
		DataObject *	output
	)			`[protected, virtual, inherited]`

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

Referenced by itk::watershed::BoundaryResolver< TPixelType, TDimension >::BoundaryResolver(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::EquivalenceRelabeler(), itk::watershed::Segmenter< InputImageType >::SetBoundary(), itk::watershed::BoundaryResolver< TPixelType, TDimension >::SetEquivalencyTable(), itk::watershed::Segmenter< InputImageType >::SetOutputImage(), itk::watershed::Relabeler< ScalarType, itkGetStaticConstMacro(ImageDimension)>::SetOutputImage(), itk::watershed::EquivalenceRelabeler< TScalarType, TImageDimension >::SetOutputImage(), and itk::watershed::Segmenter< InputImageType >::SetSegmentTable().

void itk::ProcessObject::SetNumberOfInputs ( unsigned int num ) [protected, inherited]

Called to allocate the input array. Copies old inputs.

void itk::ProcessObject::SetNumberOfOutputs ( unsigned int num ) [protected, inherited]

Called to allocate the output array. Copies old outputs.

virtual void itk::ProcessObject::SetNumberOfRequiredInputs ( unsigned int _arg ) [protected, virtual, inherited]

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

virtual void itk::ProcessObject::SetNumberOfRequiredOutputs ( unsigned int _arg ) [protected, virtual, inherited]

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

virtual void itk::ProcessObject::SetNumberOfThreads ( int _arg ) [virtual, inherited]

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

virtual void itk::ProcessObject::SetProgress ( float _arg ) [virtual, inherited]

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.

virtual void itk::Object::SetReferenceCount ( int ) [virtual, inherited]

Sets the reference count (use with care)

Reimplemented from itk::LightObject.

virtual void itk::ProcessObject::SetReleaseDataBeforeUpdateFlag ( bool _arg ) [virtual, inherited]

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.

virtual void itk::ProcessObject::SetReleaseDataFlag ( bool flag ) [virtual, inherited]

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.

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

virtual void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::SetUseStreaming ( bool _arg ) [virtual]

Set the stream On or Off

template<class TOutputImage>

virtual int itk::ImageSource< TOutputImage >::SplitRequestedRegion	(	int	i,
		int	num,
		OutputImageRegionType &	splitRegion
	)			`[protected, virtual, inherited]`

Split the output's RequestedRegion into "num" pieces, returning region "i" as "splitRegion". This method is called "num" times. The regions must not overlap. The method returns the number of pieces that the routine is capable of splitting the output RequestedRegion, i.e. return value is less than or equal to "num".

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

void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::TestFileExistanceAndReadability ( ) [protected]

Test whether the given filename exist and it is readable, this is intended to be called before attempting to use ImageIO classes for actually reading the file. If the file doesn't exist or it is not readable, and exception with an approriate message will be thrown.

template<class TOutputImage>

virtual void itk::ImageSource< TOutputImage >::ThreadedGenerateData	(	const OutputImageRegionType &	outputRegionForThread,
		int	threadId
	)			`[protected, virtual, inherited]`

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

See also:: GenerateData(), SplitRequestedRegion()

template<class TOutputImage>

static ITK_THREAD_RETURN_TYPE itk::ImageSource< TOutputImage >::ThreaderCallback ( void * arg ) [static, protected, inherited]

Static function used as a "callback" by the MultiThreader. The threading library will call this routine for each thread, which will delegate the control to ThreadedGenerateData().

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

Decrease the reference count (release by another object).

Reimplemented from itk::LightObject.

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

Bring this filter up-to-date. Update() checks modified times against last execution times, and re-executes objects if necessary. A side effect of this method is that the whole pipeline may execute in order to bring this filter up-to-date. This method updates the currently prescribed requested region. If no requested region has been set on the output, then the requested region will be set to the largest possible region. Once the requested region is set, Update() will make sure the specified requested region is up-to-date. This is a confusing side effect to users who are just calling Update() on a filter. A first call to Update() will cause the largest possible region to be updated. A second call to Update() will update that same region. If a modification to the upstream pipeline cause a filter to have a different largest possible region, this second call to Update() will not cause the output requested region to be reset to the new largest possible region. Instead, the output requested region will be the same as the last time Update() was called. To have a filter always to produce its largest possible region, users should call UpdateLargestPossibleRegion() instead.

Reimplemented in itk::CoreAtomImageToUnaryCorrespondenceMatrixProcess< TSourceImage >, itk::MedialNodePairCorrespondenceProcess< TSourceImage >, itk::MedialNodeTripletCorrespondenceProcess< TSourceImage >, itk::CoreAtomImageToDistanceMatrixProcess< TSourceImage >, itk::ImageFileWriter< TInputImage >, and itk::ImageSeriesWriter< TInputImage, TOutputImage >.

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

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

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

Actually generate new output

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

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

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.

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

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.

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

virtual void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::UseStreamingOff ( ) [virtual]

Set the stream On or Off

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

virtual void itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::UseStreamingOn ( ) [virtual]

Set the stream On or Off

Member Data Documentation

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

std::string itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::m_FileName [protected]

Definition at line 174 of file itkImageFileReader.h.

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

ImageIOBase::Pointer itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::m_ImageIO [protected]

Definition at line 170 of file itkImageFileReader.h.

TimeStamp itk::ProcessObject::m_OutputInformationMTime [protected, inherited]

Time when GenerateOutputInformation was last called.

Definition at line 431 of file itkProcessObject.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects.

Definition at line 144 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count

Definition at line 147 of file itkLightObject.h.

bool itk::ProcessObject::m_Updating [protected, inherited]

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.

Definition at line 428 of file itkProcessObject.h.

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

bool itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::m_UserSpecifiedImageIO [protected]

Definition at line 171 of file itkImageFileReader.h.

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

bool itk::ImageFileReader< TOutputImage, ConvertPixelTraits >::m_UseStreaming [protected]

Definition at line 176 of file itkImageFileReader.h.

template<class TOutputImage>

const unsigned int itk::ImageSource< TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension [static, inherited]

ImageDimension constant

Definition at line 75 of file itkImageSource.h.

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

itkImageFileReader.h

itk::ImageFileReader< TOutputImage, ConvertPixelTraits > Class Template Reference [Input and Output Filters]

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected 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

Member Data Documentation

itk::ImageFileReader< TOutputImage, ConvertPixelTraits > Class Template Reference
[Input and Output Filters]

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