Orfeo Toolbox  3.16
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
itk::VectorGradientNDAnisotropicDiffusionFunction< TImage > Class Template Reference

#include <itkVectorGradientNDAnisotropicDiffusionFunction.h>

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

List of all members.

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 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
const TimeStepTypeGetTimeStep () const
virtual void InitializeIteration ()
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 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
unsigned long int m_Center
VectorNeighborhoodInnerProduct
< ImageType
m_InnerProduct
ScalarValueType m_K
unsigned long int 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<class 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 42 of file itkVectorGradientNDAnisotropicDiffusionFunction.h.


Member Typedef Documentation

template<class 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 91 of file itkFiniteDifferenceFunction.h.

A floating point offset from an image grid location. Used for interpolation among grid values in a neighborhood.

Reimplemented from itk::AnisotropicDiffusionFunction< TImage >.

Definition at line 65 of file itkVectorGradientNDAnisotropicDiffusionFunction.h.

Inherit some parameters from the superclass type.

Reimplemented from itk::VectorAnisotropicDiffusionFunction< TImage >.

Definition at line 57 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 137 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.

Reimplemented in itk::CurvatureFlowFunction< TImage >.

Definition at line 102 of file itkFiniteDifferenceFunction.h.

The type of data structure that is passed to this function object to evaluate at a pixel that does not lie on a data set boundary.

Reimplemented from itk::VectorAnisotropicDiffusionFunction< TImage >.

Definition at line 64 of file itkVectorGradientNDAnisotropicDiffusionFunction.h.

typedef double itk::FiniteDifferenceFunction< TImage >::PixelRealType
inherited
template<class TImage>
typedef Superclass::PixelRealType itk::AnisotropicDiffusionFunction< TImage >::PixelrealType
inherited

Definition at line 151 of file itkAnisotropicDiffusionFunction.h.

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

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

Definition at line 74 of file itkVectorGradientNDAnisotropicDiffusionFunction.h.

Standard class typedefs.

Reimplemented from itk::VectorAnisotropicDiffusionFunction< TImage >.

Definition at line 47 of file itkVectorGradientNDAnisotropicDiffusionFunction.h.

Define the TimeStepType to always be double.

Reimplemented from itk::VectorAnisotropicDiffusionFunction< TImage >.

Definition at line 62 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 149 of file itkLightObject.cxx.

template<class TImage >
void itk::VectorAnisotropicDiffusionFunction< TImage >::CalculateAverageGradientMagnitudeSquared ( TImage *  ip)
virtualinherited
template<class 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 201 of file itkAnisotropicDiffusionFunction.h.

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<class TImage >
VectorGradientNDAnisotropicDiffusionFunction< TImage >::PixelType itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::ComputeUpdate ( const NeighborhoodType neighborhood,
void *  globalData,
const FloatOffsetType offset = FloatOffsetType(0.0) 
)
virtual
template<class 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 88 of file itkLightObject.cxx.

template<class TImage>
const double& itk::AnisotropicDiffusionFunction< TImage >::GetAverageGradientMagnitudeSquared ( ) const
inlineinherited

Set/Get the average gradient magnitude squared.

Definition at line 190 of file itkAnisotropicDiffusionFunction.h.

template<class TImage>
const double& itk::AnisotropicDiffusionFunction< TImage >::GetConductanceParameter ( ) const
inlineinherited

Definition at line 184 of file itkAnisotropicDiffusionFunction.h.

template<class 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 208 of file itkAnisotropicDiffusionFunction.h.

template<class 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
inlineinherited

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

Definition at line 145 of file itkFiniteDifferenceFunction.h.

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

Gets the reference count on this object.

Definition at line 105 of file itkLightObject.h.

template<class TImage>
const TimeStepType& itk::AnisotropicDiffusionFunction< TImage >::GetTimeStep ( ) const
inlineinherited

Definition at line 174 of file itkAnisotropicDiffusionFunction.h.

template<class TImage>
virtual void itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::InitializeIteration ( )
inlinevirtual

This method is called prior to each iteration of the solver.

Reimplemented from itk::FiniteDifferenceFunction< TImage >.

Definition at line 83 of file itkVectorGradientNDAnisotropicDiffusionFunction.h.

template<class TImage>
static Pointer itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::New ( )
static

Method for creation through the object factory.

Reimplemented from itk::LightObject.

template<class 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 135 of file itkLightObject.cxx.

References itk::Indent::GetNextIndent().

Referenced by itk::operator<<().

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

Define a default print header for all objects.

Definition at line 320 of file itkLightObject.cxx.

template<class 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 82 of file itkVectorAnisotropicDiffusionFunction.h.

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

Define a default print trailer for all objects.

Definition at line 331 of file itkLightObject.cxx.

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

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

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

Definition at line 160 of file itkLightObject.cxx.

template<class 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 214 of file itkAnisotropicDiffusionFunction.h.

template<class TImage>
void itk::AnisotropicDiffusionFunction< TImage >::SetAverageGradientMagnitudeSquared ( const double &  c)
inlineinherited
template<class TImage>
void itk::AnisotropicDiffusionFunction< TImage >::SetConductanceParameter ( const double &  c)
inlineinherited

Set/Get the conductance parameter. The conductance parameter.

Definition at line 180 of file itkAnisotropicDiffusionFunction.h.

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

void itk::FiniteDifferenceFunction< TImage >::SetRadius ( const RadiusType r)
inlineinherited

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

Definition at line 140 of file itkFiniteDifferenceFunction.h.

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 244 of file itkLightObject.cxx.

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

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

Definition at line 151 of file itkFiniteDifferenceFunction.h.

template<class 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 170 of file itkAnisotropicDiffusionFunction.h.

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

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

Decrease the reference count (release by another object).

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

Definition at line 192 of file itkLightObject.cxx.

Referenced by itk::LightObject::New().


Member Data Documentation

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

Derivative operators.

Definition at line 107 of file itkVectorGradientNDAnisotropicDiffusionFunction.h.

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

Extract vector and image dimension from superclass.

Reimplemented from itk::VectorAnisotropicDiffusionFunction< TImage >.

Definition at line 69 of file itkVectorGradientNDAnisotropicDiffusionFunction.h.

template<class TImage>
unsigned long int itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::m_Center
private
template<class TImage>
VectorNeighborhoodInnerProduct<ImageType> itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::m_InnerProduct
private

Inner product function.

Definition at line 98 of file itkVectorGradientNDAnisotropicDiffusionFunction.h.

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

Modified global average gradient magnitude term.

Definition at line 110 of file itkVectorGradientNDAnisotropicDiffusionFunction.h.

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

Definition at line 201 of file itkFiniteDifferenceFunction.h.

InternalReferenceCountType itk::LightObject::m_ReferenceCount
mutableprotectedinherited

Number of uses of this object by other objects.

Definition at line 141 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock
mutableprotectedinherited

Mutex lock to protect modification to the reference count

Definition at line 144 of file itkLightObject.h.

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

Definition at line 202 of file itkFiniteDifferenceFunction.h.

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

Slices for the ND neighborhood.

Definition at line 101 of file itkVectorGradientNDAnisotropicDiffusionFunction.h.

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

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

Generated at Sun Feb 3 2013 02:48:24 for Orfeo Toolbox with doxygen 1.8.1.1