Orfeo Toolbox  4.0
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | Static Private Attributes | List of all members
itk::VectorGradientNDAnisotropicDiffusionFunction< TImage > Class Template Referenceabstract

#include <itkVectorGradientNDAnisotropicDiffusionFunction.h>

+ Inheritance diagram for itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >:
+ Collaboration diagram for itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >:

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef
ZeroFluxNeumannBoundaryCondition
< ImageType
DefaultBoundaryConditionType
 
typedef Superclass::FloatOffsetType FloatOffsetType
 
typedef Superclass::ImageType ImageType
 
typedef Vector< PixelRealType,
itkGetStaticConstMacro(ImageDimension) > 
NeighborhoodScalesType
 
typedef
Superclass::NeighborhoodType 
NeighborhoodType
 
typedef double PixelRealType
 
typedef Superclass::PixelRealType PixelrealType
 
typedef Superclass::PixelType PixelType
 
typedef SmartPointer< SelfPointer
 
typedef Superclass::RadiusType RadiusType
 
typedef PixelType::ValueType ScalarValueType
 
typedef
VectorGradientNDAnisotropicDiffusionFunction 
Self
 
typedef
VectorAnisotropicDiffusionFunction
< TImage > 
Superclass
 
typedef Superclass::TimeStepType TimeStepType
 

Public Member Functions

virtual void CalculateAverageGradientMagnitudeSquared (TImage *)
 
virtual void CalculateAverageGradientMagnitudeSquared (ImageType *)=0
 
virtual TimeStepType ComputeGlobalTimeStep (void *) const
 
const NeighborhoodScalesType ComputeNeighborhoodScales () const
 
virtual PixelType ComputeUpdate (const NeighborhoodType &neighborhood, void *globalData, const FloatOffsetType &offset=FloatOffsetType(0.0))
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual void Delete ()
 
const double & GetAverageGradientMagnitudeSquared () const
 
const double & GetConductanceParameter () const
 
virtual void * GetGlobalDataPointer () const
 
virtual const char * GetNameOfClass () const
 
const RadiusTypeGetRadius () const
 
virtual int GetReferenceCount () const
 
void GetScaleCoefficients (PixelRealType vals[ImageDimension]) const
 
const TimeStepTypeGetTimeStep () const
 
virtual void InitializeIteration ()
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 
virtual void Register () const
 
virtual void ReleaseGlobalDataPointer (void *) const
 
void SetAverageGradientMagnitudeSquared (const double &c)
 
void SetConductanceParameter (const double &c)
 
void SetRadius (const RadiusType &r)
 
virtual void SetReferenceCount (int)
 
void SetScaleCoefficients (PixelRealType vals[ImageDimension])
 
void SetTimeStep (const TimeStepType &t)
 
virtual void UnRegister () const
 

Static Public Member Functions

static void BreakOnError ()
 
static Pointer New ()
 

Static Public Attributes

static const unsigned int ImageDimension = Superclass::ImageDimension
 
static const unsigned int VectorDimension = Superclass::VectorDimension
 

Protected Types

typedef int InternalReferenceCountType
 

Protected Member Functions

 VectorGradientNDAnisotropicDiffusionFunction ()
 
 ~VectorGradientNDAnisotropicDiffusionFunction ()
 
virtual LightObject::Pointer InternalClone () const
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
void PrintSelf (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 

Protected Attributes

RadiusType m_Radius
 
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 
PixelRealType m_ScaleCoefficients [ImageDimension]
 

Private Member Functions

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

Private Attributes

DerivativeOperator
< ScalarValueType,
itkGetStaticConstMacro(ImageDimension) > 
dx_op
 
SizeValueType m_Center
 
VectorNeighborhoodInnerProduct
< ImageType
m_InnerProduct
 
ScalarValueType m_K
 
SizeValueType m_Stride [ImageDimension]
 
std::slice x_slice [ImageDimension]
 
std::slice xa_slice [ImageDimension][ImageDimension]
 
std::slice xd_slice [ImageDimension][ImageDimension]
 

Static Private Attributes

static double m_MIN_NORM = 1.0e-10
 

Detailed Description

template<typename TImage>
class itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >

This class is a simple extension of the GradientNDAnisotropicDiffusionFunction to pixel types of multiple components. Vector components are diffused separately, but diffusion of each component is limited by a conductance term which depends on all components.

For more information, please see GradientNDAnisotropicDiffusionFunction.

See Also
GradientNDAnisotropicDiffusionFunction
VectorCurvatureNDAnisotropicDiffusionFunction
AnisotropicDiffusionFunction

Definition at line 44 of file itkVectorGradientNDAnisotropicDiffusionFunction.h.

Member Typedef Documentation

template<typename TImage>
typedef SmartPointer< const Self > itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::ConstPointer

The default boundary condition for finite difference functions that is used unless overridden in the Evaluate() method.

Definition at line 92 of file itkFiniteDifferenceFunction.h.

Inherit some parameters from the superclass type.

Definition at line 59 of file itkVectorGradientNDAnisotropicDiffusionFunction.h.

typedef int itk::LightObject::InternalReferenceCountType
protectedinherited

Define the type of the reference count according to the target. This allows the use of atomic operations

Definition at line 152 of file itkLightObject.h.

typedef Vector< PixelRealType, itkGetStaticConstMacro(ImageDimension) > itk::FiniteDifferenceFunction< TImage >::NeighborhoodScalesType
inherited

The type of data structure that holds the scales with which the neighborhood is weighted to properly account for spacing and neighborhood radius.

Definition at line 103 of file itkFiniteDifferenceFunction.h.

typedef double itk::FiniteDifferenceFunction< TImage >::PixelRealType
inherited

Definition at line 81 of file itkFiniteDifferenceFunction.h.

template<typename TImage>
typedef Superclass::PixelRealType itk::AnisotropicDiffusionFunction< TImage >::PixelrealType
inherited

Definition at line 155 of file itkAnisotropicDiffusionFunction.h.

template<typename TImage>
typedef SmartPointer< Self > itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::Pointer
template<typename TImage>
typedef PixelType::ValueType itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::ScalarValueType

Type of a value in a vector (double, float, etc.)

Definition at line 76 of file itkVectorGradientNDAnisotropicDiffusionFunction.h.

Standard class typedefs.

Definition at line 49 of file itkVectorGradientNDAnisotropicDiffusionFunction.h.

Constructor & Destructor Documentation

Member Function Documentation

void itk::LightObject::BreakOnError ( )
staticinherited

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

Definition at line 150 of file itkLightObject.cxx.

template<typename TImage >
void itk::VectorAnisotropicDiffusionFunction< TImage >::CalculateAverageGradientMagnitudeSquared ( TImage *  ip)
virtualinherited
template<typename TImage>
virtual void itk::AnisotropicDiffusionFunction< TImage >::CalculateAverageGradientMagnitudeSquared ( ImageType )
pure virtualinherited

This method is called before each iteration. It calculates a scalar value that is the average of the gradient magnitude squared at each pixel in the output image (intermediate solution). The average gradient magnitude value is typically used in the anisotropic diffusion equations to calibrate the conductance term.

Referenced by itk::AnisotropicDiffusionImageFilter< TInputImage, TOutputImage >::InitializeIteration().

template<typename TImage>
virtual TimeStepType itk::AnisotropicDiffusionFunction< TImage >::ComputeGlobalTimeStep ( void *  ) const
inlinevirtualinherited

Returns the time step supplied by the user. We don't need to use the global data supplied since we are returning a fixed value.

Implements itk::FiniteDifferenceFunction< TImage >.

Definition at line 208 of file itkAnisotropicDiffusionFunction.h.

References itk::AnisotropicDiffusionFunction< TImage >::GetTimeStep().

const NeighborhoodScalesType itk::FiniteDifferenceFunction< TImage >::ComputeNeighborhoodScales ( ) const
inherited

Compute the scales that weight the neighborhood during difference operations to properly account for spacing and neighborhood radius

template<typename TImage >
VectorGradientNDAnisotropicDiffusionFunction< TImage >::PixelType itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::ComputeUpdate ( const NeighborhoodType neighborhood,
void *  globalData,
const FloatOffsetType offset = FloatOffsetType(0.0) 
)
virtual
template<typename TImage>
virtual::itk::LightObject::Pointer itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::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::LightObject.

void itk::LightObject::Delete ( )
virtualinherited

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

Delete a itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C++ delete method will not work with reference counting.

Definition at line 91 of file itkLightObject.cxx.

template<typename TImage>
const double& itk::AnisotropicDiffusionFunction< TImage >::GetAverageGradientMagnitudeSquared ( ) const
inlineinherited
template<typename TImage>
const double& itk::AnisotropicDiffusionFunction< TImage >::GetConductanceParameter ( ) const
inlineinherited
template<typename TImage>
virtual void* itk::AnisotropicDiffusionFunction< TImage >::GetGlobalDataPointer ( ) const
inlinevirtualinherited

The anisotropic diffusion classes don't use this particular parameter so it's safe to return a null value.

Implements itk::FiniteDifferenceFunction< TImage >.

Definition at line 215 of file itkAnisotropicDiffusionFunction.h.

template<typename TImage>
virtual const char* itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods)

Reimplemented from itk::VectorAnisotropicDiffusionFunction< TImage >.

const RadiusType& itk::FiniteDifferenceFunction< TImage >::GetRadius ( void  ) const
inherited

Returns the radius of the neighborhood this FiniteDifferenceFunction needs to perform its calculations.

virtual int itk::LightObject::GetReferenceCount ( ) const
inlinevirtualinherited

Gets the reference count on this object.

Definition at line 112 of file itkLightObject.h.

void itk::FiniteDifferenceFunction< TImage >::GetScaleCoefficients ( PixelRealType  vals[ImageDimension]) const
inherited

Returns the current scale coefficients.

template<typename TImage>
const TimeStepType& itk::AnisotropicDiffusionFunction< TImage >::GetTimeStep ( ) const
inlineinherited
template<typename TImage>
virtual void itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::InitializeIteration ( )
inlinevirtual
LightObject::Pointer itk::LightObject::InternalClone ( ) const
protectedvirtualinherited
itk::LightObject::itkCloneMacro ( Self  )
inherited
template<typename TImage>
static Pointer itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::New ( )
static
template<typename TImage>
void itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::operator= ( const Self )
private
void itk::LightObject::Print ( std::ostream &  os,
Indent  indent = 0 
) const
inherited

Cause the object to print itself out.

Avoid DLL boundary problems. This function will be common to all itk objects. It just calls the header/self/trailer virtual print methods, which can be overriden by subclasses (any itk object).

Definition at line 137 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<(), and itk::VideoStream< TFrameType >::PrintSelf().

void itk::LightObject::PrintHeader ( std::ostream &  os,
Indent  indent 
) const
protectedvirtualinherited

Define a default print header for all objects.

Definition at line 315 of file itkLightObject.cxx.

template<typename TImage >
void itk::VectorAnisotropicDiffusionFunction< TImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
inlineprotectedvirtualinherited

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.

Chaining method to print an object's instance variables, as well as its superclasses.

Reimplemented from itk::AnisotropicDiffusionFunction< TImage >.

Reimplemented in itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >.

Definition at line 85 of file itkVectorAnisotropicDiffusionFunction.h.

References itk::AnisotropicDiffusionFunction< TImage >::PrintSelf().

Referenced by itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::PrintSelf().

void itk::LightObject::PrintTrailer ( std::ostream &  os,
Indent  indent 
) const
protectedvirtualinherited

Define a default print trailer for all objects.

Definition at line 325 of file itkLightObject.cxx.

void itk::LightObject::Register ( ) const
virtualinherited

Increase the reference count (mark as used by another object).

Reimplemented in itk::Object, and itk::ExceptionObject::ReferenceCountedExceptionData.

Definition at line 158 of file itkLightObject.cxx.

Referenced by itk::ExceptionObject::ReferenceCountedExceptionData::Register().

template<typename TImage>
virtual void itk::AnisotropicDiffusionFunction< TImage >::ReleaseGlobalDataPointer ( void *  ) const
inlinevirtualinherited

Does nothing. No global data is used in this class of equations.

Implements itk::FiniteDifferenceFunction< TImage >.

Definition at line 221 of file itkAnisotropicDiffusionFunction.h.

template<typename TImage>
void itk::AnisotropicDiffusionFunction< TImage >::SetAverageGradientMagnitudeSquared ( const double &  c)
inlineinherited
template<typename TImage>
void itk::AnisotropicDiffusionFunction< TImage >::SetConductanceParameter ( const double &  c)
inlineinherited
void itk::FiniteDifferenceFunction< TImage >::SetRadius ( const RadiusType r)
inherited

Sets the radius of the neighborhood this FiniteDifferenceFunction needs to perform its calculations.

void itk::LightObject::SetReferenceCount ( int  ref)
virtualinherited

Sets the reference count on this object. This is a dangerous method, use it with care.

Sets the reference count (use with care)

Reimplemented in itk::Object.

Definition at line 240 of file itkLightObject.cxx.

void itk::FiniteDifferenceFunction< TImage >::SetScaleCoefficients ( PixelRealType  vals[ImageDimension])
inherited

Set the ScaleCoefficients for the difference operators. The defaults a 1.0. These can be set to take the image spacing into account.

template<typename TImage>
void itk::AnisotropicDiffusionFunction< TImage >::SetTimeStep ( const TimeStepType t)
inlineinherited

Set/Get the time step. For this class of anisotropic diffusion filters, the time-step is supplied by the user and remains fixed for all updates.

Definition at line 174 of file itkAnisotropicDiffusionFunction.h.

References itk::AnisotropicDiffusionFunction< TImage >::m_TimeStep.

Referenced by itk::AnisotropicDiffusionImageFilter< TInputImage, TOutputImage >::InitializeIteration().

void itk::LightObject::UnRegister ( ) const
virtualinherited

Decrease the reference count (release by another object).

Reimplemented in itk::Object, and itk::ExceptionObject::ReferenceCountedExceptionData.

Definition at line 189 of file itkLightObject.cxx.

Referenced by itk::LightObject::New(), and itk::ExceptionObject::ReferenceCountedExceptionData::UnRegister().

Member Data Documentation

template<typename TImage>
DerivativeOperator< ScalarValueType, itkGetStaticConstMacro(ImageDimension) > itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::dx_op
private

Derivative operators.

Definition at line 112 of file itkVectorGradientNDAnisotropicDiffusionFunction.h.

template<typename TImage>
const unsigned int itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::ImageDimension = Superclass::ImageDimension
static

Extract vector and image dimension from superclass.

Definition at line 71 of file itkVectorGradientNDAnisotropicDiffusionFunction.h.

template<typename TImage>
SizeValueType itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::m_Center
private
template<typename TImage>
VectorNeighborhoodInnerProduct< ImageType > itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::m_InnerProduct
private

Inner product function.

Definition at line 103 of file itkVectorGradientNDAnisotropicDiffusionFunction.h.

template<typename TImage>
ScalarValueType itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::m_K
private

Modified global average gradient magnitude term.

Definition at line 115 of file itkVectorGradientNDAnisotropicDiffusionFunction.h.

Referenced by itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::InitializeIteration().

template<typename TImage>
double itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::m_MIN_NORM = 1.0e-10
staticprivate
RadiusType itk::FiniteDifferenceFunction< TImage >::m_Radius
protectedinherited

Definition at line 191 of file itkFiniteDifferenceFunction.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount
mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 156 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock
mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 159 of file itkLightObject.h.

PixelRealType itk::FiniteDifferenceFunction< TImage >::m_ScaleCoefficients[ImageDimension]
protectedinherited

Definition at line 192 of file itkFiniteDifferenceFunction.h.

template<typename TImage>
SizeValueType itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::m_Stride[ImageDimension]
private
template<typename TImage>
const unsigned int itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::VectorDimension = Superclass::VectorDimension
static
template<typename TImage>
std::slice itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::x_slice[ImageDimension]
private

Slices for the ND neighborhood.

Definition at line 106 of file itkVectorGradientNDAnisotropicDiffusionFunction.h.

template<typename TImage>
std::slice itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::xa_slice[ImageDimension][ImageDimension]
private
template<typename TImage>
std::slice itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::xd_slice[ImageDimension][ImageDimension]
private

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

Generated at Sat Mar 8 2014 17:57:12 for Orfeo Toolbox with doxygen 1.8.3.1