#include <itkVectorGradientMagnitudeImageFilter.h>

Inheritance diagram for itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >:

Collaboration diagram for itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >:

Detailed Description

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

Computes a scalar, gradient magnitude image from a multiple channel (pixels are vectors) input.

Overview: This filter has two calculation modes. The first (default) mode calculates gradient magnitude as the difference between the largest two eigenvalues in a principle component analysis of the partial derivatives [1]. The gradient is then based on the direction of maximal change, and is a characterization of how "elongated" the point-spread of the analysis is found to be.

The second, more heuristic, calculation mode finds gradient magnitude as the square-root of the sum of the * individual weighted vector component derivative sums squared. That is, * $\mathbf{magnitude} = \left( \sum_{i=0}^n \sum_{j=0}^m \frac{\delta * \phi_j}{\delta \mathbf{x}_{i}}^2 \right)^{\frac{1}{2}}$ , where $\phi_j$ * is the $j^{\mathbf{th}}$ channel of vector image $\phi$ of dimension $n$ . * Weighting terms are applied to each vector component.

The second mode is computationally much faster than the first and has the advantage that it is automatically multi-threaded (some vnl functions used in the first mode are not thread-safe). The first mode, however, tends to give intuitively better results with less (or no) parameter tuning.

Template Parameters (Input and Output): This filter has one required template parameter which defines the input image type. The pixel type of the input image is assumed to be a vector (e.g., itk::Vector, itk::RGBPixel, itk::FixedArray). The scalar type of the vector components must be castable to floating point. Instantiating with an image of RGBPixel<unsigned short>, for example, is allowed, but the filter will convert it to an image of Vector<float,3> for processing.

The second template parameter, TRealType, can be optionally specified to define the scalar numerical type used in calculations. This is the component type of the output image, which will be of itk::Vector<TRealType, N>, where N is the number of channels in the multiple component input image. The default type of TRealType is float. For extra precision, you may safely change this parameter to double.

The third template parameter is the output image type. The third parameter will be automatically constructed from the first and second parameters, so it is not necessary (or advisable) to set this parameter explicitly. Given an M-channel input image with dimensionality N, and a numerical type specified as TRealType, the output image will be of type itk::Image<itk::Vector<TRealType, M>, N>.

Filter Parameters: The methods Set/GetUsePrincipleComponents and SetUsePrincipleComponentsOn/Off determine controls the calculation mode that is used.

The method SetUseImageSpacingOn will cause derivatives in the image to be scaled (inversely) with the pixel size of the input image, effectively taking derivatives in world coordinates (versus isotropic image space). SetUseImageSpacingOff turns this functionality off. Default is UseImageSpacingOn. The parameter UseImageSpacing can be set directly with the method SetUseImageSpacing(bool).

Weights can be applied to the derivatives directly using the SetDerivativeWeights method. Note that if UseImageSpacing is set to TRUE (ON), then these weights will be overridden by weights derived from the image spacing when the filter is updated. The argument to this method is a C array of TRealValue type.

Weights can be applied to each vector component of the image when the component derivative values are summed during computation. Specify these weights using the SetComponentWeights method. The argument to this method is a C array of TRealValue type.

Constraints: The filter requires an image with at least two dimensions and a vector length of at least 2. The theory supports extension to scalar images, but the implementation of the itk vector classes do not

The template parameter TRealType must be floating point (float or double) or a user-defined "real" numerical type with arithmetic operations defined sufficient to compute derivatives.

Performance: This filter will automatically multithread if run with SetUsePrincipleComponents=Off or on 3D data in UsePrincipleComponents=On mode. Unfortunately the ND eigen solver used is not thread safe (a special 3D solver is), so it cannot multithread for data other than 3D in UsePrincipleComponents=On mode.

References

[1] G. Sapiro and D. Ringach, "Anisotropic Diffusion of Multivalued Images with Application to Color Filtering," IEEE Transactions on Image Processing, Vol 5, No. 11 pp. 1582-1586, 1996

See Also: Image; Neighborhood; NeighborhoodOperator; NeighborhoodIterator

Examples:: Examples/IO/VisibleHumanPasteWrite.cxx, and Examples/Segmentation/WatershedSegmentation1.cxx.

Definition at line 139 of file itkVectorGradientMagnitudeImageFilter.h.

Public Types
typedef ConstNeighborhoodIterator < RealVectorImageType >	ConstNeighborhoodIteratorType

typedef SmartPointer< const Self >	ConstPointer

typedef InputImageType::Pointer	InputImagePointer

typedef TInputImage	InputImageType

typedef TInputImage::PixelType	InputPixelType

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, TInputImage::ImageDimension >	RealVectorImageType

typedef Vector< TRealType, InputPixelType::Dimension >	RealVectorType

typedef VectorGradientMagnitudeImageFilter	Self

typedef ImageToImageFilter < TInputImage, TOutputImage >	Superclass

typedef FixedArray< TRealType, VectorDimension >	WeightsType

Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const Self >	ConstPointer

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TInputImage	InputImageType

typedef Superclass::OutputImagePixelType	OutputImagePixelType

typedef Superclass::OutputImageRegionType	OutputImageRegionType

typedef SmartPointer< Self >	Pointer

typedef ImageToImageFilter	Self

typedef ImageSource< TOutputImage >	Superclass

Public Types inherited from itk::ImageSource< TOutputImage >
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType

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 Types inherited from itk::ProcessObject
typedef SmartPointer< const Self >	ConstPointer

typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef std::vector < DataObjectPointer >	DataObjectPointerArray

typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType

typedef MultiThreader	MultiThreaderType

typedef std::vector < DataObjectIdentifierType >	NameArray

typedef SmartPointer< Self >	Pointer

typedef ProcessObject	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const

virtual void	GenerateInputRequestedRegion () override

virtual const char *	GetNameOfClass () const

virtual bool	GetUseImageSpacing () const

void	SetUseImageSpacing (bool)

void	SetUseImageSpacingOff ()

void	SetUseImageSpacingOn ()

void	SetUsePrincipleComponentsOff ()


virtual void	SetDerivativeWeights (WeightsType _arg)

virtual const WeightsType &	GetDerivativeWeights () const


virtual void	SetComponentWeights (WeightsType _arg)

virtual const WeightsType &	GetComponentWeights () const


virtual void	SetUsePrincipleComponents (bool _arg)

virtual bool	GetUsePrincipleComponents () const

void	SetUsePrincipleComponentsOn ()

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

virtual void	PopBackInput () override

virtual void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *image)

virtual void	PushFrontInput (const InputImageType *image)

virtual void	SetInput (const InputImageType *image)

virtual void	SetInput (unsigned int, const TInputImage *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)

virtual void	GraftNthOutput (unsigned int idx, DataObject *output)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *output)

virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override

virtual ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual const float &	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

void	SetProgress (float progress)

virtual void	SetReleaseDataFlag (bool flag)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfThreads (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfThreads () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) const

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

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

Static Public Member Functions
static int	CubicSolver (double , double )

static Pointer	New ()

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool flag)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

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

static const unsigned int	VectorDimension = InputPixelType::Dimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static const unsigned int	InputImageDimension = TInputImage::ImageDimension

static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Protected Types
typedef InputImageType::Superclass	ImageBaseType

Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType

typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	OutputToInputRegionCopierType

Protected Member Functions
void	BeforeThreadedGenerateData () override

TRealType	EvaluateAtNeighborhood (const ConstNeighborhoodIteratorType &it) const

TRealType	EvaluateAtNeighborhood3D (const ConstNeighborhoodIteratorType &it) const

virtual const ImageBaseType *	GetRealValuedInputImage () const

TRealType	NonPCEvaluateAtNeighborhood (const ConstNeighborhoodIteratorType &it) const

void	PrintSelf (std::ostream &os, Indent indent) const override

void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId) override

	VectorGradientMagnitudeImageFilter ()

virtual	~VectorGradientMagnitudeImageFilter () override

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

	ImageToImageFilter ()

virtual void	VerifyInputInformation () override

	~ImageToImageFilter () override

void	PushBackInput (const DataObject *input) override

void	PushFrontInput (const DataObject *input) override

Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

virtual	~ImageSource () override

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))

	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))

	itkLegacyMacro (virtual void RemoveInput(DataObject *input))

	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)

virtual void	SetPrimaryInput (DataObject *input)

virtual void	SetPrimaryOutput (DataObject *output)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyPreconditions ()

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName (void) const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName (void) const

DataObject *	GetOutput (DataObjectPointerArraySizeType idx)

const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

Protected Member Functions inherited from itk::Object
	Object ()

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

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

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

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

virtual	~LightObject ()

Protected Attributes
WeightsType	m_ComponentWeights

WeightsType	m_DerivativeWeights

WeightsType	m_SqrtComponentWeights

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime

bool	m_Updating

Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Private Attributes
ImageBaseType::ConstPointer	m_RealValuedInputImage

ThreadIdType	m_RequestedNumberOfThreads

bool	m_UseImageSpacing

bool	m_UsePrincipleComponents

Additional Inherited Members
Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)

Member Typedef Documentation

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

typedef ConstNeighborhoodIterator< RealVectorImageType > itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::ConstNeighborhoodIteratorType

Type of the iterator that will be used to move through the image. Also the type which will be passed to the evaluate function

Definition at line 183 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

typedef SmartPointer< const Self > itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::ConstPointer

Definition at line 147 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

typedef InputImageType::Superclass itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::ImageBaseType

protected

Definition at line 302 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

typedef InputImageType::Pointer itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::InputImagePointer

Definition at line 163 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

typedef TInputImage itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::InputImageType

Image typedef support

Definition at line 161 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

typedef TInputImage::PixelType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::InputPixelType

Definition at line 158 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

typedef OutputImageType::Pointer itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::OutputImagePointer

Definition at line 164 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

typedef Superclass::OutputImageRegionType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::OutputImageRegionType

Superclass typedefs.

Definition at line 187 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

typedef TOutputImage itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::OutputImageType

Definition at line 162 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

typedef TOutputImage::PixelType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::OutputPixelType

Extract some information from the image types. Dimensionality of the two images is assumed to be the same.

Definition at line 153 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

typedef SmartPointer< Self > itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::Pointer

Definition at line 146 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

typedef ConstNeighborhoodIteratorType::RadiusType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::RadiusType

Definition at line 184 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

typedef TRealType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::RealType

Define the data type and the vector of data type used in calculations.

Definition at line 175 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

typedef Image< RealVectorType, TInputImage::ImageDimension > itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::RealVectorImageType

Definition at line 179 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

typedef Vector< TRealType, InputPixelType::Dimension > itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::RealVectorType

Definition at line 177 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

typedef VectorGradientMagnitudeImageFilter itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::Self

Standard class typedefs.

Definition at line 144 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

typedef ImageToImageFilter< TInputImage, TOutputImage > itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::Superclass

Definition at line 145 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

typedef FixedArray< TRealType, VectorDimension > itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::WeightsType

Definition at line 216 of file itkVectorGradientMagnitudeImageFilter.h.

Constructor & Destructor Documentation

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::VectorGradientMagnitudeImageFilter ( )

protected

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

virtual itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::~VectorGradientMagnitudeImageFilter ( )

inlineoverrideprotectedvirtual

Definition at line 279 of file itkVectorGradientMagnitudeImageFilter.h.

Member Function Documentation

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::BeforeThreadedGenerateData ( )

overrideprotectedvirtual

Do any necessary casting/copying of the input data. Input pixel types whose value types are not real number types must be cast to real number types.

Reimplemented from itk::ImageSource< TOutputImage >.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

virtual::itk::LightObject::Pointer itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::CreateAnother ( ) const

virtual

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

Reimplemented from itk::Object.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

static int itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::CubicSolver	(	double *	,
		double *
	)

static

A specialized solver for finding the roots of a cubic polynomial. Necessary to multi-thread the 3D case

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

TRealType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::EvaluateAtNeighborhood ( const ConstNeighborhoodIteratorType & it ) const

inlineprotected

Definition at line 442 of file itkVectorGradientMagnitudeImageFilter.h.

References itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetNext(), and itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPrevious().

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

TRealType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::EvaluateAtNeighborhood3D ( const ConstNeighborhoodIteratorType & it ) const

inlineprotected

Definition at line 327 of file itkVectorGradientMagnitudeImageFilter.h.

References itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetNext(), and itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetPrevious().

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

virtual void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::GenerateInputRequestedRegion ( )

overridevirtual

VectorGradientMagnitudeImageFilter needs a larger input requested region than the output requested region (larger by the kernel size to calculate derivatives). As such, VectorGradientMagnitudeImageFilter needs to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

See Also: ImageToImageFilter::GenerateInputRequestedRegion()

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

virtual const WeightsType& itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::GetComponentWeights ( ) const

virtual

Set/Get the array of weightings for the different components of the vector. Default values are 1.0.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

virtual const WeightsType& itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::GetDerivativeWeights ( ) const

virtual

Directly Set/Get the array of weights used in the gradient calculations. Note that calling UseImageSpacingOn will clobber these values.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

virtual const char* itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods)

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

virtual const ImageBaseType* itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::GetRealValuedInputImage ( ) const

protectedvirtual

Get access to the input image casted as real pixel values

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

virtual bool itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::GetUseImageSpacing ( ) const

virtual

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

virtual bool itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::GetUsePrincipleComponents ( ) const

virtual

Set/Get principle components calculation mode. When this is set to TRUE/ON, 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, the calculation is done as a square root of weighted sum of the derivatives squared. Default is UsePrincipleComponents = true.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

static Pointer itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::New ( )

static

Method for creation through the object factory.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

TRealType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::NonPCEvaluateAtNeighborhood ( const ConstNeighborhoodIteratorType & it ) const

inlineprotected

Definition at line 307 of file itkVectorGradientMagnitudeImageFilter.h.

References itk::NumericTraits< T >::ZeroValue().

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

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::ImageToImageFilter< TInputImage, TOutputImage >.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

virtual void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::SetComponentWeights ( WeightsType _arg )

virtual

Set/Get the array of weightings for the different components of the vector. Default values are 1.0.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

virtual void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::SetDerivativeWeights ( WeightsType _arg )

virtual

Directly Set/Get the array of weights used in the gradient calculations. Note that calling UseImageSpacingOn will clobber these values.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::SetUseImageSpacing ( bool )

Set/Get whether or not the filter will use the spacing of the input image in its calculations

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::SetUseImageSpacingOff ( )

inline

Reset the derivative weights to ignore image spacing. Use this option if you want to calculate the gradient in the image space. Default is ImageSpacingOn.

Definition at line 209 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::SetUseImageSpacingOn ( )

inline

Set the derivative weights according to the spacing of the input image (1/spacing). Use this option if you want to calculate the gradient in the space in which the data was acquired. Default is ImageSpacingOn.

Definition at line 203 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

virtual void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::SetUsePrincipleComponents ( bool _arg )

virtual

Set/Get principle components calculation mode. When this is set to TRUE/ON, 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, the calculation is done as a square root of weighted sum of the derivatives squared. Default is UsePrincipleComponents = true.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::SetUsePrincipleComponentsOff ( )

inline

Definition at line 259 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::SetUsePrincipleComponentsOn ( )

inline

Set/Get principle components calculation mode. When this is set to TRUE/ON, 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, the calculation is done as a square root of weighted sum of the derivatives squared. Default is UsePrincipleComponents = true.

Definition at line 253 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::ThreadedGenerateData	(	const OutputImageRegionType &	outputRegionForThread,
		ThreadIdType	threadId
	)

overrideprotectedvirtual

VectorGradientMagnitudeImageFilter can be implemented as a multithreaded filter. Therefore, this implementation provides a ThreadedGenerateData() routine which is called for each processing thread. The output image data is allocated automatically by the superclass prior to calling ThreadedGenerateData(). ThreadedGenerateData can only write to the portion of the output image specified by the parameter "outputRegionForThread"

See Also: ImageToImageFilter::ThreadedGenerateData(), ImageToImageFilter::GenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

Member Data Documentation

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

const unsigned int itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::ImageDimension = TOutputImage::ImageDimension

static

The dimensionality of the input and output images.

Definition at line 168 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

WeightsType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::m_ComponentWeights

protected

These weights are used to scale vector component values when they are combined to produce a scalar. The square root

Definition at line 484 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

WeightsType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::m_DerivativeWeights

protected

The weights used to scale derivatives during processing

Definition at line 479 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

ImageBaseType::ConstPointer itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::m_RealValuedInputImage

private

Definition at line 493 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

ThreadIdType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::m_RequestedNumberOfThreads

private

Definition at line 491 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

WeightsType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::m_SqrtComponentWeights

protected

Definition at line 485 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

bool itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::m_UseImageSpacing

private

Definition at line 488 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

bool itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::m_UsePrincipleComponents

private

Definition at line 489 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>

const unsigned int itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::VectorDimension = InputPixelType::Dimension

static

Length of the vector pixel type of the input image.

Definition at line 172 of file itkVectorGradientMagnitudeImageFilter.h.

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

itkVectorGradientMagnitudeImageFilter.h

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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