ITK  4.1.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes
itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage > Class Template Reference

#include <itkVectorGradientMagnitudeImageFilter.h>

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

List of all members.

Public Types

typedef
ConstNeighborhoodIterator
< RealVectorImageType
ConstNeighborhoodIteratorType
typedef SmartPointer< const SelfConstPointer
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< SelfPointer
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
typedef FixedArray< TRealType,
VectorDimension
WeightsType

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
virtual void GenerateInputRequestedRegion () throw ( InvalidRequestedRegionError )
virtual const char * GetNameOfClass () const
virtual bool GetUseImageSpacing () const
void SetUseImageSpacing (bool)
void SetUseImageSpacingOff ()
void SetUseImageSpacingOn ()
void SetUsePrincipleComponentsOff ()
 typedef (Concept::HasNumericTraits< typename InputPixelType::ValueType >) InputHasNumericTraitsCheck
 typedef (Concept::HasNumericTraits< RealType >) RealTypeHasNumericTraitsCheck
virtual void SetDerivativeWeights (WeightsType _arg)
virtual const WeightsTypeGetDerivativeWeights ()
virtual void SetComponentWeights (WeightsType _arg)
virtual const WeightsTypeGetComponentWeights ()
virtual const RadiusTypeGetNeighborhoodRadius ()
virtual void SetNeighborhoodRadius (RadiusType _arg)
virtual void SetUsePrincipleComponents (bool _arg)
virtual bool GetUsePrincipleComponents () const
void SetUsePrincipleComponentsOn ()

Static Public Member Functions

static int CubicSolver (double *, double *)
static Pointer New ()

Static Public Attributes

static const unsigned int ImageDimension = TOutputImage::ImageDimension
static const unsigned int VectorDimension = InputPixelType::Dimension

Protected Types

typedef InputImageType::Superclass ImageBaseType

Protected Member Functions

void BeforeThreadedGenerateData ()
TRealType EvaluateAtNeighborhood (const ConstNeighborhoodIteratorType &it) const
TRealType EvaluateAtNeighborhood3D (const ConstNeighborhoodIteratorType &it) const
virtual const ImageBaseTypeGetRealValuedInputImage ()
TRealType NonPCEvaluateAtNeighborhood (const ConstNeighborhoodIteratorType &it) const
void PrintSelf (std::ostream &os, Indent indent) const
void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 VectorGradientMagnitudeImageFilter ()
virtual ~VectorGradientMagnitudeImageFilter ()

Protected Attributes

WeightsType m_ComponentWeights
WeightsType m_DerivativeWeights
WeightsType m_SqrtComponentWeights

Private Member Functions

void operator= (const Self &)
 VectorGradientMagnitudeImageFilter (const Self &)

Private Attributes

RadiusType m_NeighborhoodRadius
ImageBaseType::ConstPointer m_RealValuedInputImage
ThreadIdType m_RequestedNumberOfThreads
bool m_UseImageSpacing
bool m_UsePrincipleComponents

Detailed Description

template<typename TInputImage, typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< 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

Definition at line 139 of file itkVectorGradientMagnitudeImageFilter.h.


Member Typedef Documentation

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< 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 181 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
typedef SmartPointer< const Self > itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::ConstPointer
template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
typedef InputImageType::Superclass itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::ImageBaseType [protected]

Definition at line 292 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
typedef InputImageType::Pointer itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::InputImagePointer
template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
typedef TInputImage itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::InputImageType

Image typedef support

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

Definition at line 161 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< 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, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
typedef OutputImageType::Pointer itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::OutputImagePointer

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 164 of file itkVectorGradientMagnitudeImageFilter.h.

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

Superclass typedefs.

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

Definition at line 185 of file itkVectorGradientMagnitudeImageFilter.h.

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

Some convenient typedefs.

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 162 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< 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, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
typedef SmartPointer< Self > itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::Pointer
template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
typedef ConstNeighborhoodIteratorType::RadiusType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::RadiusType

Definition at line 182 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< 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, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
typedef Image< RealVectorType, ::itk::GetImageDimension< TInputImage >::ImageDimension > itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::RealVectorImageType

Definition at line 177 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
typedef Vector< TRealType, ::itk::GetVectorDimension< InputPixelType >::VectorDimension > itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::RealVectorType

Definition at line 176 of file itkVectorGradientMagnitudeImageFilter.h.

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

Standard class typedefs.

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

Definition at line 144 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
typedef ImageToImageFilter< TInputImage, TOutputImage > itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::Superclass
template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
typedef FixedArray< TRealType, VectorDimension > itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::WeightsType

Definition at line 215 of file itkVectorGradientMagnitudeImageFilter.h.


Constructor & Destructor Documentation

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::VectorGradientMagnitudeImageFilter ( ) [protected]

End concept checking

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
virtual itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::~VectorGradientMagnitudeImageFilter ( ) [inline, protected, virtual]

Definition at line 269 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::VectorGradientMagnitudeImageFilter ( const Self ) [private]

Member Function Documentation

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::BeforeThreadedGenerateData ( ) [protected, virtual]

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, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
virtual::itk::LightObject::Pointer itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::CreateAnother ( void  ) const [virtual]

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

Reimplemented from itk::Object.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< 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, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
TRealType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::EvaluateAtNeighborhood ( const ConstNeighborhoodIteratorType it) const [inline, protected]
template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
TRealType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::EvaluateAtNeighborhood3D ( const ConstNeighborhoodIteratorType it) const [inline, protected]
template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
virtual void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::GenerateInputRequestedRegion ( ) throw ( InvalidRequestedRegionError ) [virtual]

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, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
virtual const WeightsType& itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::GetComponentWeights ( ) [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, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
virtual const WeightsType& itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::GetDerivativeWeights ( ) [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, ::itk::GetImageDimension< 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, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
virtual const RadiusType& itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::GetNeighborhoodRadius ( ) [virtual]

Get/Set the neighborhood radius used for gradient computation

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
virtual const ImageBaseType* itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::GetRealValuedInputImage ( ) [protected, virtual]

Get access to the input image casted as real pixel values

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
virtual bool itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::GetUseImageSpacing ( ) const [virtual]
template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< 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, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
static Pointer itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::New ( ) [static]

Method for creation through the object factory.

Reimplemented from itk::Object.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
TRealType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::NonPCEvaluateAtNeighborhood ( const ConstNeighborhoodIteratorType it) const [inline, protected]
template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::operator= ( const Self ) [private]

PushBackInput(), PushFronInput() in the public section force the input to be the type expected by an ImageToImageFilter. However, these methods end of "hiding" the versions from the superclass (ProcessObject) whose arguments are DataObjects. Here, we re-expose the versions from ProcessObject to avoid warnings about hiding methods from the superclass.

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

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::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::ImageToImageFilter< TInputImage, TOutputImage >.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< 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, ::itk::GetImageDimension< 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, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
virtual void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::SetNeighborhoodRadius ( RadiusType  _arg) [virtual]

Get/Set the neighborhood radius used for gradient computation

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< 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, ::itk::GetImageDimension< 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 208 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< 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 202 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< 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, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::SetUsePrincipleComponentsOff ( ) [inline]

Definition at line 249 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< 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 243 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
void itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType outputRegionForThread,
ThreadIdType  threadId 
) [protected, virtual]

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

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::typedef ( Concept::HasNumericTraits< typename InputPixelType::ValueType >  )

Begin concept checking This class requires InputHasNumericTraitsCheck in the form of ( Concept::HasNumericTraits< typename InputPixelType::ValueType > )

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::typedef ( Concept::HasNumericTraits< RealType )

This class requires RealTypeHasNumericTraitsCheck in the form of ( Concept::HasNumericTraits< RealType > )


Member Data Documentation

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< 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, ::itk::GetImageDimension< 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 474 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
WeightsType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::m_DerivativeWeights [protected]

The weights used to scale derivatives during processing

Definition at line 469 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
RadiusType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::m_NeighborhoodRadius [private]

Definition at line 487 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
ImageBaseType::ConstPointer itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::m_RealValuedInputImage [private]

Definition at line 482 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
ThreadIdType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::m_RequestedNumberOfThreads [private]

Definition at line 480 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
WeightsType itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::m_SqrtComponentWeights [protected]

Definition at line 475 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
bool itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::m_UseImageSpacing [private]

Definition at line 477 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< TInputImage >::ImageDimension >>
bool itk::VectorGradientMagnitudeImageFilter< TInputImage, TRealType, TOutputImage >::m_UsePrincipleComponents [private]

Definition at line 478 of file itkVectorGradientMagnitudeImageFilter.h.

template<typename TInputImage , typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension< 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: