ITK: itk::ImageSource< TOutputImage > Class Template Reference

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


Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector< DataObjectPointer >	DataObjectPointerArray
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef OutputImageType::RegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef SmartPointer< Self >	Pointer
typedef ImageSource	Self
typedef ProcessObject	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 *)
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
std::vector< DataObjectPointer >::size_type	GetNumberOfInputs () const
std::vector< DataObjectPointer >::size_type	GetNumberOfOutputs () const
virtual const int &	GetNumberOfThreads ()
virtual std::vector< DataObjectPointer >::size_type	GetNumberOfValidRequiredInputs () const
OutputImageType *	GetOutput (unsigned int idx)
Get the output data of this process object The output of this function is not valid until an appropriate either explicitly or implicitly Both the filter itself and the data object have and both methods update the data Here are three ways to use	GetOutput () and make sure the data is valid.In these *examples
Return an array with all the outputs of this process object This is useful for tracing forward in the pipeline to contruct graphs etc *DataObjectPointerArray &	GetOutputs ()
virtual const float &	GetProgress ()
virtual int	GetReferenceCount () const
virtual const bool &	GetReleaseDataBeforeUpdateFlag ()
virtual bool	GetReleaseDataFlag () const
virtual void	GraftNthOutput (unsigned int idx, DataObject *output)
virtual void	GraftOutput (DataObject *output)
bool	HasObserver (const EventObject &event) const
Get the output data of this process object The output of this function is not valid until an appropriate either explicitly or implicitly Both the filter itself and the data object have and both methods update the data Here are three ways to use a image is a pointer to some Image and the particular ProcessObjects involved are filters The same examples apply to non	image (e.g.Mesh) data as well.*\code anotherFilter->SetInput(someFilter->GetOutput())
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual DataObjectPointer	MakeOutput (unsigned int idx)
virtual void	Modified () const
virtual void	PrepareOutputs ()
void	Print (std::ostream &os, Indent indent=0) const
virtual void	PropagateRequestedRegion (DataObject *output)
virtual void	Register () const
virtual void	ReleaseDataBeforeUpdateFlagOff ()
virtual void	ReleaseDataBeforeUpdateFlagOn ()
void	ReleaseDataFlagOff ()
void	ReleaseDataFlagOn ()
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	ResetPipeline ()
virtual void	SetAbortGenerateData (bool _arg)
void	SetDebug (bool debugFlag) const
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
Get Set the number of threads to create when executing *virtual void	SetNumberOfThreads (int _arg)
virtual void	SetProgress (float _arg)
virtual void	SetReferenceCount (int)
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 *virtual void	SetReleaseDataFlag (bool flag)
virtual void	UnRegister () const
endcode In the above the two lines of code can be in either order Note that it may be more efficient to use a pipeline than to call	Update () once for each filter in turn.*For an image
endcode In the above 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\b streaming(using a StreamingImageFilter) is activated
endcode code someFilter	Update ()
*image	Update ()
*anotherFilter	Update ()
Get the output data of this process object The output of this function is not valid until an appropriate either explicitly or implicitly Both the filter itself and the data object have	Update () methods
Get the output data of this process object The output of this *function is not valid until an appropriate	Update () method has *been called
virtual void	UpdateLargestPossibleRegion ()
virtual void	UpdateOutputData (DataObject *output)
virtual void	UpdateOutputInformation ()
void	UpdateProgress (float amount)
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning or error messages are displayed static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
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 unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
endcode In the above	example
*	image = someFilter->GetOutput()
endcode In this a someFilter and a anotherFilter are said to constitute a b pipeline *code	image = someFilter->GetOutput()
Get the output data of this process object The output of this function is not valid until an appropriate either explicitly or implicitly Both the filter itself and the data object have and both methods update the data Here are three ways to use a image is a pointer to some Image	object
endcode In the above the two lines of code can be in either order Note that it may be more efficient to use a pipeline than to call the data generated is for the requested *	Region
endcode *In this	situation
Protected Member Functions
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateData ()
virtual void	GenerateInputRequestedRegion ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
const DataObject *	GetInput (unsigned int idx) const
Method used internally for getting an input DataObject	GetInput (unsigned int idx)
virtual const unsigned int &	GetNumberOfRequiredInputs ()
virtual const unsigned int &	GetNumberOfRequiredOutputs ()
const DataObject *	GetOutput (unsigned int idx) const
	ImageSource ()
virtual void	PopBackInput ()
virtual void	PopFrontInput ()
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 ()
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 especially filters with different types of inputs These routines follow the semantics of STL *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 ()
Protected methods for setting inputs Subclasses make use of them for setting input virtual void	SetNthInput (unsigned int num, DataObject *input)
Protected methods for setting outputs Subclasses make use of them for getting output 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)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)
virtual	~ImageSource ()
Static Protected Member Functions
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
Protected Attributes
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
TimeStamp	m_OutputInformationMTime
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
bool	m_Updating
Methods invoked by virtual 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 PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const
Classes
struct	ThreadStruct

itk::ImageSource< TOutputImage > Class Template Reference
[Data Sources]

Detailed Description

template<class TOutputImage>
class itk::ImageSource< TOutputImage >

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Classes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

itk::ImageSource< TOutputImage > Class Template Reference [Data Sources]