ITK: itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage

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

itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage > Class Template Reference
[Image Gradient Filters]

Detailed Description

template<typename TInputImage, typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension<TInputImage>::ImageDimension >>
class itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation


Public Types
typedef ConstNeighborhoodIterator< RealVectorImageType >	ConstNeighborhoodIteratorType
typedef SmartPointer< const Self >	ConstPointer
typedef DataObject::Pointer	DataObjectPointer
typedef std::vector< DataObjectPointer >	DataObjectPointerArray
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef TInputImage::PixelType	InputPixelType
typedef OutputImageType::PixelType	OutputImagePixelType
typedef OutputImageType::Pointer	OutputImagePointer
typedef Superclass::OutputImageRegionType	OutputImageRegionType
typedef TOutputImage	OutputImageType
typedef TOutputImage::PixelType	OutputPixelType
typedef SmartPointer< Self >	Pointer
typedef ConstNeighborhoodIteratorType::RadiusType	RadiusType
typedef TRealType	RealType
typedef Image< RealVectorType, ::itk::GetImageDimension< TInputImage >::ImageDimension >	RealVectorImageType
typedef Vector< TRealType, ::itk::GetVectorDimension< InputPixelType >::VectorDimension >	RealVectorType
typedef VectorGradientMagnitudeImageFilter	Self
typedef ImageToImageFilter< TInputImage, 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 *)
virtual void	GenerateInputRequestedRegion () throw (InvalidRequestedRegionError)
virtual const bool &	GetAbortGenerateData ()
Command *	GetCommand (unsigned long tag)
virtual const TRealType *	GetComponentWeights () const
bool	GetDebug () const
virtual const TRealType *	GetDerivativeWeights () const
const InputImageType *	GetInput (unsigned int idx)
const InputImageType *	GetInput (void)
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 bool	GetUseImageSpacing ()
virtual bool	GetUsePrincipleComponents ()
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 &)
	itkStaticConstMacro (OutputImageDimension, unsigned int, TOutputImage::ImageDimension)
ImageDimension constants *	itkStaticConstMacro (InputImageDimension, unsigned int, TInputImage::ImageDimension)
	itkStaticConstMacro (VectorDimension, unsigned int, InputPixelType::Dimension)
	itkStaticConstMacro (ImageDimension, unsigned int, TOutputImage::ImageDimension)
virtual DataObjectPointer	MakeOutput (unsigned int idx)
virtual void	Modified () const
virtual void	PopBackInput ()
virtual void	PopFrontInput ()
virtual void	PrepareOutputs ()
void	Print (std::ostream &os, Indent indent=0) const
virtual void	PropagateRequestedRegion (DataObject *output)
Push Pop the 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 *The routines are useful for applications that need to process rolling sets of images For if an application has images and they need to run a filter on then run the filter on then run the filter on the application can accomplish this by popping an input off the front of the input list and push a new image onto the back of input list this only makes sense for filters that single type of input Other uses are also possible For a single input pushing and popping inputs allow the application to temporarily replace an input to a filter *virtual void	PushBackInput (const InputImageType *image)
virtual void	PushFrontInput (const InputImageType *image)
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)
Set Get the array of weightings for the different components of the vector Default values are *virtual void	SetComponentWeights (TRealType data[])
void	SetDebug (bool debugFlag) const
Directly Set Get the array of weights used in the gradient calculations Note that calling UseImageSpacingOn will clobber these values *void	SetDerivativeWeights (TRealType data[])
virtual void	SetInput (unsigned int, const TInputImage *image)
Set Get the image input of this process object *virtual void	SetInput (const InputImageType *image)
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)
Set Get whether or not the filter will use the spacing of the input image in its calculations *void	SetUseImageSpacing (bool)
void	SetUseImageSpacingOff ()
void	SetUseImageSpacingOn ()
void	SetUsePrincipleComponentsOff ()
void	SetUsePrincipleComponentsOn ()
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 int	CubicSolver (double , double )
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
Push Pop the 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 *The routines are useful for applications that need to process rolling sets of images For if an application has images and they need to run a filter on then run the filter on then run the filter on the application can accomplish this by popping an input off the front of the input list and push a new image onto the back of input list	Again
This is a global flag that controls whether any	debug
endcode In the above	example
Push Pop the 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 *The routines are useful for applications that need to process rolling sets of images For if an application has images and they need to run a filter on then run the filter on then run the filter on the application can accomplish this by popping an input off the front of the input list and push a new image onto the back of input list this only makes sense for filters that single type of input *Other uses are also possible For a single input	filter
Push Pop the 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
*	image = someFilter->GetOutput()
endcode In this a someFilter and a anotherFilter are said to constitute a b pipeline *code	image = someFilter->GetOutput()
Push Pop the 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 *The routines are useful for applications that need to process rolling sets of images For if an application has images and they need to run a filter on then run the filter on then run the filter on *	images
Push Pop the 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 *The routines are useful for applications that need to process rolling sets of images For if an application has images and they need to run a filter on then run the filter on	images
Push Pop the 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 *The routines are useful for applications that need to process rolling sets of images For if an application has *images and they need to run a filter on	images
Push Pop the 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 *The routines are useful for applications that need to process rolling sets of images For	instance
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
Set Get principle components calculation mode When this is set to TRUE the gradient calculation will involve a priniciple component analysis of the partial derivatives of the color components When this value is set to FALSE	OFF
Set Get principle components calculation mode When this is set to TRUE	ON
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
Set Get principle components calculation mode When this is set to TRUE the gradient calculation will involve a priniciple component analysis of the partial derivatives of the color components When this value is set to FALSE the calculation is done as a square root of weighted sum of the derivatives squared Default is	UsePrincipleComponents
Protected Types
typedef InputImageType::Superclass	ImageBaseType
typedef ImageToImageFilterDetail::ImageRegionCopier< itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension)	InputToOutputRegionCopierType )
typedef ImageToImageFilterDetail::ImageRegionCopier< itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension)	OutputToInputRegionCopierType )
Protected Member Functions
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
virtual void	AfterThreadedGenerateData ()
virtual void	AllocateOutputs ()
void	BeforeThreadedGenerateData ()
virtual void	CacheInputReleaseDataFlags ()
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
TRealType	EvaluateAtNeighborhood (const ConstNeighborhoodIteratorType &it) const
TRealType	EvaluateAtNeighborhood3D (const ConstNeighborhoodIteratorType &it) const
virtual void	GenerateData ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
const DataObject *	GetInput (unsigned int idx) const
Get Set the neighborhood radius used for gradient computation *virtual const RadiusType &	GetNeighborhoodRadius ()
virtual const unsigned int &	GetNumberOfRequiredInputs ()
virtual const unsigned int &	GetNumberOfRequiredOutputs ()
const DataObject *	GetOutput (unsigned int idx) const
virtual const ImageBaseType *	GetRealValuedInputImage ()
	ImageToImageFilter ()
TRealType	NonPCEvaluateAtNeighborhood (const ConstNeighborhoodIteratorType &it) 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 ()
*these methods end of hiding the versions from the superclass ProcessObject whose arguments are DataObjects we re expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass *void	PushBackInput (const DataObject *input)
*	PushBackInput ()
*	PushFronInput () in the public section force the *input to be the type expected by an ImageToImageFilter.However
void	PushFrontInput (const DataObject *input)
virtual void	ReleaseInputs ()
virtual void	RemoveInput (DataObject *input)
virtual void	RemoveOutput (DataObject *output)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetNeighborhoodRadius (RadiusType _arg)
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)
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)
	VectorGradientMagnitudeImageFilter ()
virtual	~VectorGradientMagnitudeImageFilter ()
Static Protected Member Functions
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)
Protected Attributes
*these methods end of hiding the versions from the superclass ProcessObject whose arguments are DataObjects	Here
TRealType	m_ComponentWeights [itk::GetVectorDimension< InputPixelType >::VectorDimension]
TRealType	m_DerivativeWeights [itk::GetImageDimension< TInputImage >::ImageDimension]
TimeStamp	m_OutputInformationMTime
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
TRealType	m_SqrtComponentWeights [itk::GetVectorDimension< InputPixelType >::VectorDimension]
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

itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage > Class Template Reference [Image Gradient Filters]