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

Computes a scalar image from a vector image (e.g., deformation field) input, where each output scalar at each pixel is the Jacobian determinant of the vector field at that location. More...

#include <itkDeformationFieldJacobianDeterminantFilter.h>

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

[legend]Collaboration diagram for itk::DeformationFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >:

[legend]List of all members.

Public Types
typedef DeformationFieldJacobianDeterminantFilter	Self
typedef ImageToImageFilter< TInputImage, TOutputImage >	Superclass
typedef SmartPointer< Self >	Pointer
typedef SmartPointer< const Self >	ConstPointer
typedef TOutputImage::PixelType	OutputPixelType
typedef TInputImage::PixelType	InputPixelType
typedef TInputImage	InputImageType
typedef TOutputImage	OutputImageType
typedef InputImageType::Pointer	InputImagePointer
typedef OutputImageType::Pointer	OutputImagePointer
typedef TRealType	RealType
typedef Vector< TRealType, ::itk::GetVectorDimension< InputPixelType >::VectorDimension >	RealVectorType
typedef Image< RealVectorType, ::itk::GetImageDimension< TInputImage >::ImageDimension >	RealVectorImageType
typedef ConstNeighborhoodIterator< RealVectorImageType >	ConstNeighborhoodIteratorType
typedef ConstNeighborhoodIteratorType::RadiusType	RadiusType
typedef Superclass::OutputImageRegionType	OutputImageRegionType
Public Member Functions
virtual const char *	GetNameOfClass () const
	itkStaticConstMacro (ImageDimension, unsigned int, TOutputImage::ImageDimension)
	itkStaticConstMacro (VectorDimension, unsigned int, InputPixelType::Dimension)
virtual void	GenerateInputRequestedRegion () throw (InvalidRequestedRegionError)
void	SetUseImageSpacingOn ()
void	SetUseImageSpacingOff ()
void	SetUseImageSpacing (bool)
virtual bool	GetUseImageSpacing ()
void	SetDerivativeWeights (TRealType data[])
virtual const TRealType *	GetDerivativeWeights () const
Static Public Member Functions
Pointer	New ()
Protected Types
typedef InputImageType::Superclass	ImageBaseType
Protected Member Functions
	DeformationFieldJacobianDeterminantFilter ()
virtual	~DeformationFieldJacobianDeterminantFilter ()
void	BeforeThreadedGenerateData ()
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, int threadId)
void	PrintSelf (std::ostream &os, Indent indent) const
virtual const ImageBaseType *	GetRealValuedInputImage ()
TRealType	EvaluateAtNeighborhood (const ConstNeighborhoodIteratorType &it) const
virtual const RadiusType &	GetNeighborhoodRadius ()
virtual void	SetNeighborhoodRadius (RadiusType _arg)
Protected Attributes
TRealType	m_DerivativeWeights [itk::GetImageDimension< TInputImage >::ImageDimension]

---

Detailed Description

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

Computes a scalar image from a vector image (e.g., deformation field) input, where each output scalar at each pixel is the Jacobian determinant of the vector field at that location.

Overview

This filter is based on itkVectorGradientMagnitudeImageFilter and supports the m_DerivativeWeights weights for partial derivatives.

Note that the determinant of a zero vector field is also zero, whereas the Jacobian determinant of the corresponding identity warp transformation should be 1.0. In general, in order to obtain the effective deformation Jacobian determinant, 1.0 must be added to each Jacobian value in the output.

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<TRealType, N>.

Filter Parameters

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 UseImageSpacingOff (all weights are 1.0). 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.

Constraints

We use vnl_det for determinent computation, which only supports square matrices. So the vector dimension of the input image values must be equal to the image dimensions, which is trivially true for a deformation field that maps an n-dimensional space onto itself.

Currently, dimensions up to and including 4 are supported. This limitation comes from the presence of vnl_det() functions for matrices of dimension up to 4x4.

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.

See also:

Image

Neighborhood

NeighborhoodOperator

NeighborhoodIterator

Note:

This class was developed with funding from:

"CNS Deficits: Interaction of Age and Alcoholism" NIAAA AA05965, PI: A. Pfefferbaum

"INIA: Imaging Core" NIAAA AA13521, PI: A. Pfefferbaum

Author:

Torsten Rohlfing, Neuroscience Program, SRI International.

Definition at line 120 of file itkDeformationFieldJacobianDeterminantFilter.h.

---

Member Typedef Documentation

template<typename TInputImage, typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension<TInputImage>::ImageDimension >> typedef ConstNeighborhoodIterator<RealVectorImageType> itk::DeformationFieldJacobianDeterminantFilter< 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 163 of file itkDeformationFieldJacobianDeterminantFilter.h.

template<typename TInputImage, typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension<TInputImage>::ImageDimension >> typedef SmartPointer<const Self> itk::DeformationFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::ConstPointer

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 128 of file itkDeformationFieldJacobianDeterminantFilter.h.

template<typename TInputImage, typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension<TInputImage>::ImageDimension >> typedef InputImageType::Superclass itk::DeformationFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::ImageBaseType [protected]

Definition at line 229 of file itkDeformationFieldJacobianDeterminantFilter.h.

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 144 of file itkDeformationFieldJacobianDeterminantFilter.h.

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

Image typedef support Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 142 of file itkDeformationFieldJacobianDeterminantFilter.h.

template<typename TInputImage, typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension<TInputImage>::ImageDimension >> typedef TInputImage::PixelType itk::DeformationFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::InputPixelType

Definition at line 139 of file itkDeformationFieldJacobianDeterminantFilter.h.

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

Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 145 of file itkDeformationFieldJacobianDeterminantFilter.h.

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

Superclass typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 167 of file itkDeformationFieldJacobianDeterminantFilter.h.

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

Some convenient typedefs. Reimplemented from itk::ImageSource< TOutputImage >. Definition at line 143 of file itkDeformationFieldJacobianDeterminantFilter.h.

template<typename TInputImage, typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension<TInputImage>::ImageDimension >> typedef TOutputImage::PixelType itk::DeformationFieldJacobianDeterminantFilter< 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 138 of file itkDeformationFieldJacobianDeterminantFilter.h.

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 127 of file itkDeformationFieldJacobianDeterminantFilter.h.

template<typename TInputImage, typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension<TInputImage>::ImageDimension >> typedef ConstNeighborhoodIteratorType::RadiusType itk::DeformationFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::RadiusType

Definition at line 164 of file itkDeformationFieldJacobianDeterminantFilter.h.

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

Define the data type and the vector of data type used in calculations. Definition at line 156 of file itkDeformationFieldJacobianDeterminantFilter.h.

template<typename TInputImage, typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension<TInputImage>::ImageDimension >> typedef Image<RealVectorType, ::itk::GetImageDimension<TInputImage>::ImageDimension> itk::DeformationFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::RealVectorImageType

Definition at line 158 of file itkDeformationFieldJacobianDeterminantFilter.h.

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

Definition at line 157 of file itkDeformationFieldJacobianDeterminantFilter.h.

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

Standard class typedefs. Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 125 of file itkDeformationFieldJacobianDeterminantFilter.h.

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

Reimplemented from itk::ImageToImageFilter< TInputImage, TOutputImage >. Definition at line 126 of file itkDeformationFieldJacobianDeterminantFilter.h.

---

Constructor & Destructor Documentation

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

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

Definition at line 205 of file itkDeformationFieldJacobianDeterminantFilter.h.

---

Member Function Documentation

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

Definition at line 241 of file itkDeformationFieldJacobianDeterminantFilter.h.

template<typename TInputImage, typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension<TInputImage>::ImageDimension >> virtual void itk::DeformationFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::GenerateInputRequestedRegion (   )  throw (InvalidRequestedRegionError) [virtual]

DeformationFieldJacobianDeterminantFilter needs a larger input requested region than the output requested region (larger by the kernel size to calculate derivatives). As such, DeformationFieldJacobianDeterminantFilter 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 TRealType* itk::DeformationFieldJacobianDeterminantFilter< 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, ::itk::GetImageDimension<TInputImage>::ImageDimension >> virtual const char* itk::DeformationFieldJacobianDeterminantFilter< 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::DeformationFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::GetNeighborhoodRadius (   )  [protected, 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::DeformationFieldJacobianDeterminantFilter< 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::DeformationFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::GetUseImageSpacing (   )  [virtual]

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 >> itk::DeformationFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::itkStaticConstMacro (  VectorDimension  , unsigned  int, InputPixelType::Dimension  )

Length of the vector pixel type of the input image.

template<typename TInputImage, typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension<TInputImage>::ImageDimension >> itk::DeformationFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::itkStaticConstMacro (  ImageDimension  , unsigned  int, TOutputImage::ImageDimension  )

The dimensionality of the input and output images.

template<typename TInputImage, typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension<TInputImage>::ImageDimension >> Pointer itk::DeformationFieldJacobianDeterminantFilter< 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 >> void itk::DeformationFieldJacobianDeterminantFilter< 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 >> void itk::DeformationFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::SetDerivativeWeights (  TRealType  data[]  )

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::DeformationFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::SetNeighborhoodRadius (  RadiusType  _arg  )  [protected, 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::DeformationFieldJacobianDeterminantFilter< 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::DeformationFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::SetUseImageSpacingOff (   )  [inline]

Reset the derivative weights to ignore image spacing. Use this option if you want to calculate the Jacobian determinant in the image space. Default is ImageSpacingOff. Definition at line 188 of file itkDeformationFieldJacobianDeterminantFilter.h.

template<typename TInputImage, typename TRealType = float, typename TOutputImage = Image< TRealType, ::itk::GetImageDimension<TInputImage>::ImageDimension >> void itk::DeformationFieldJacobianDeterminantFilter< 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 Jacobian determinant in the space in which the data was acquired. Definition at line 182 of file itkDeformationFieldJacobianDeterminantFilter.h.

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

DeformationFieldJacobianDeterminantFilter can be implemented as a multithreaded filter (we're only using vnl_det(), which is trivially thread safe). 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, ::itk::GetImageDimension<TInputImage>::ImageDimension >> TRealType itk::DeformationFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::m_DerivativeWeights[itk::GetImageDimension<TInputImage>::ImageDimension] [protected]

The weights used to scale partial derivatives during processing Definition at line 259 of file itkDeformationFieldJacobianDeterminantFilter.h.

---

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

• itkDeformationFieldJacobianDeterminantFilter.h

---