itk::DisplacementFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage > Class Template Reference

#include <itkDisplacementFieldJacobianDeterminantFilter.h>

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

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

Detailed Description

template<typename TInputImage, typename TRealType = float, typename TOutputImage = Image< TRealType, TInputImage::ImageDimension >>
class itk::DisplacementFieldJacobianDeterminantFilter< 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. This calculation is correct in the case where the vector image is a "displacement" from the current location. The computation for the jacobian determinant is: det[ dT/dx ] = det[ I + du/dx ].

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 is 1.0. In order to compute the effective deformation Jacobian determinant 1.0 must be added to the diagonal elements of Jacobian prior to taking the derivative. i.e. det([ (1.0+dx/dx) dx/dy dx/dz ; dy/dx (1.0+dy/dy) dy/dz; dz/dx dz/dy (1.0+dz/dz) ])

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

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 adapted by

Author

Hans J. Johnson, The University of Iowa from code provided by

Tom Vercauteren, INRIA & Mauna Kea Technologies

Torsten Rohlfing, Neuroscience Program, SRI International.

Definition at line 116 of file itkDisplacementFieldJacobianDeterminantFilter.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 DisplacementFieldJacobianDeterminantFilter	Self
typedef ImageToImageFilter < TInputImage, TOutputImage >	Superclass
typedef FixedArray< TRealType, ImageDimension >	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 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	SetDerivativeWeights (const WeightsType &)
virtual const WeightsType &	GetDerivativeWeights () const
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 ()
MultiThreader *	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 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
	DisplacementFieldJacobianDeterminantFilter ()
virtual TRealType	EvaluateAtNeighborhood (const ConstNeighborhoodIteratorType &it) const
virtual const ImageBaseType *	GetRealValuedInputImage () const
void	PrintSelf (std::ostream &os, Indent indent) const override
void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId) override
virtual	~DisplacementFieldJacobianDeterminantFilter ()
virtual const RadiusType &	GetNeighborhoodRadius () const
virtual void	SetNeighborhoodRadius (RadiusType _arg)
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 ()
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 ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
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 ()
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 ()
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_DerivativeWeights
WeightsType	m_HalfDerivativeWeights
Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime
bool	m_Updating
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Private Member Functions
	DisplacementFieldJacobianDeterminantFilter (const Self &) ITK_DELETE_FUNCTION
void	operator= (const Self &) ITK_DELETE_FUNCTION

Private Attributes
RadiusType	m_NeighborhoodRadius
ImageBaseType::ConstPointer	m_RealValuedInputImage
ThreadIdType	m_RequestedNumberOfThreads
bool	m_UseImageSpacing

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::DisplacementFieldJacobianDeterminantFilter< 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 160 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

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

Definition at line 124 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

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

protected

Definition at line 229 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

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

Definition at line 140 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

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

Image typedef support

Definition at line 138 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

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

Definition at line 135 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

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

Definition at line 141 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

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

Superclass typedefs.

Definition at line 164 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

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

Definition at line 139 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

typedef TOutputImage::PixelType itk::DisplacementFieldJacobianDeterminantFilter< 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 130 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

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

Definition at line 123 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

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

Definition at line 161 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

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

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

Definition at line 152 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

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

Definition at line 156 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

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

Definition at line 154 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

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

Standard class typedefs.

Definition at line 121 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

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

Definition at line 122 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

typedef FixedArray< TRealType, ImageDimension > itk::DisplacementFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::WeightsType

Definition at line 193 of file itkDisplacementFieldJacobianDeterminantFilter.h.

Constructor & Destructor Documentation

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

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

protected

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

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

inlineprotectedvirtual

Definition at line 205 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

itk::DisplacementFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::DisplacementFieldJacobianDeterminantFilter ( const Self &  )

private

Member Function Documentation

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

void itk::DisplacementFieldJacobianDeterminantFilter< 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::DisplacementFieldJacobianDeterminantFilter< 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.

Reimplemented in itk::DeformationFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >.

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

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

protectedvirtual

Reimplemented in itk::DeformationFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >.

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

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

overridevirtual

DisplacementFieldJacobianDeterminantFilter needs a larger input requested region than the output requested region (larger by the kernel size to calculate derivatives). As such, DisplacementFieldJacobianDeterminantFilter 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::DisplacementFieldJacobianDeterminantFilter< 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::DisplacementFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods)

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

Reimplemented in itk::DeformationFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >.

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

virtual const RadiusType& itk::DisplacementFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::GetNeighborhoodRadius ( ) const

protectedvirtual

Get/Set the neighborhood radius used for gradient computation

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

virtual const ImageBaseType* itk::DisplacementFieldJacobianDeterminantFilter< 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::DisplacementFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::GetUseImageSpacing ( ) const

virtual

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

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

static

Method for creation through the object factory.

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

void itk::DisplacementFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::operator= ( const Self &  )

private

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

void itk::DisplacementFieldJacobianDeterminantFilter< 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 >.

Reimplemented in itk::DeformationFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >.

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

void itk::DisplacementFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::SetDerivativeWeights

(

const WeightsType &

)

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 void itk::DisplacementFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::SetNeighborhoodRadius ( RadiusType  _arg )

protectedvirtual

Get/Set the neighborhood radius used for gradient computation

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

void itk::DisplacementFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::SetUseImageSpacing

(

bool

)

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

Referenced by itk::DisplacementFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::SetUseImageSpacingOff(), and itk::DisplacementFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::SetUseImageSpacingOn().

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

void itk::DisplacementFieldJacobianDeterminantFilter< 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 ImageSpacingOn.

Definition at line 186 of file itkDisplacementFieldJacobianDeterminantFilter.h.

References itk::DisplacementFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::SetUseImageSpacing().

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

void itk::DisplacementFieldJacobianDeterminantFilter< 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. Default is ImageSpacingOn.

Definition at line 180 of file itkDisplacementFieldJacobianDeterminantFilter.h.

References itk::DisplacementFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::SetUseImageSpacing().

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

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

overrideprotectedvirtual

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

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

static

The dimensionality of the input and output images.

Definition at line 145 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

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

protected

The weights used to scale partial derivatives during processing

Definition at line 242 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

WeightsType itk::DisplacementFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::m_HalfDerivativeWeights

protected

Pre-compute 0.5*m_DerivativeWeights since that is the only thing used in the computations.

Definition at line 246 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

RadiusType itk::DisplacementFieldJacobianDeterminantFilter< TInputImage, TRealType, TOutputImage >::m_NeighborhoodRadius

private

Definition at line 258 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

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

private

Definition at line 253 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

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

private

Definition at line 251 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

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

private

Definition at line 249 of file itkDisplacementFieldJacobianDeterminantFilter.h.

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

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

static

Length of the vector pixel type of the input image.

Definition at line 149 of file itkDisplacementFieldJacobianDeterminantFilter.h.

---

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

• itkDisplacementFieldJacobianDeterminantFilter.h