itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows > Class Template Reference
[Numerics]

#include <itkSymmetricEigenSystem.h>

Inheritance diagram for itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >:

[legend]Collaboration diagram for itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >:

[legend]List of all members.

---

Detailed Description

template<class TMatrixElement, int VNumberOfRows>
class itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >

wrapper of the vnl_symmetric_eigensystem algorithm

This class is not thread-safe. If you are interested in thread-safety please use the class SymmetricEigenAnalysis in Insight/Code/Common.

Warning:

THIS CLASS IS DEPRECATED AND IT IS SCHEDULED FOR BEING REMOVED FROM THE TOOLKIT IN RELEASE 2.4

See also:

SymmetricEigenAnalysis

Deprecated

Definition at line 46 of file itkSymmetricEigenSystem.h.

Public Types
typedef FixedArray< ArrayType, VNumberOfRows >	Array2DType
typedef FixedArray< TMatrixElement, VNumberOfRows >	ArrayType
typedef SmartPointer< const Self >	ConstPointer
typedef ArrayType	EigenValueArrayType
typedef Array2DType	EigenVectorArrayType
typedef vnl_symmetric_eigensystem< TMatrixElement >	InternalEigenSystemType
typedef Matrix< TMatrixElement, VNumberOfRows, VNumberOfRows >	MatrixType
typedef SmartPointer< Self >	Pointer
typedef SymmetricEigenSystem	Self
typedef Object	Superclass
Public Member Functions
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
EigenValueArrayType *	GetEigenValues ()
EigenVectorArrayType *	GetEigenVectors ()
MatrixType *	GetMatrix ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
virtual int	GetReferenceCount () const
virtual bool	GetUseAbsoluteOrder ()
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
void	SetDebug (bool debugFlag) const
Set Get the target matrix for the eigen analysis *virtual void	SetMatrix (MatrixType *_arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void	SetReferenceCount (int)
Set Get the absolute order flag *By setting this flag after the calculation of eigen vectors *and if the absolute eigen value of eigen vector[j > i] is *greater that of eigen reorder the eigen vectors so that *every absolute eigen values of eigen vector[j< i] is always greater than or *equal to that of the eigen vectors *[i] virtual void	SetUseAbsoluteOrder (bool _arg)
virtual void	UnRegister () const
void	Update ()
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning *or error messages are displayed *static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
Allow people to add remove invoke observers(callbacks) to any ITK *object.This is an implementation of the subject/observer design *pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Set Get the absolute order flag *By setting this flag	true
Set Get the absolute order flag *By setting this flag after the calculation of eigen vectors *and	values
Set Get the absolute order flag *By setting this flag after the calculation of eigen vectors *and if the absolute eigen value of eigen vector[j > i] is *greater that of eigen	vector [i]
Protected Member Functions
void	GenerateData ()
bool	PrintObservers (std::ostream &os, Indent indent) const
void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
	SymmetricEigenSystem ()
virtual	~SymmetricEigenSystem ()
Protected Attributes
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
Methods invoked by virtual 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.*/virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

---

Member Typedef Documentation

template<class TMatrixElement, int VNumberOfRows> typedef FixedArray< ArrayType, VNumberOfRows > itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::Array2DType

2D array typedef Definition at line 65 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement, int VNumberOfRows> typedef FixedArray< TMatrixElement, VNumberOfRows > itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::ArrayType

1D array typedef Definition at line 59 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement, int VNumberOfRows> typedef SmartPointer<const Self> itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::ConstPointer

Reimplemented from itk::Object. Definition at line 53 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement, int VNumberOfRows> typedef ArrayType itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::EigenValueArrayType

Array type for eigen values Definition at line 71 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement, int VNumberOfRows> typedef Array2DType itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::EigenVectorArrayType

Array for eigen vectors Definition at line 68 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement, int VNumberOfRows> typedef vnl_symmetric_eigensystem< TMatrixElement > itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::InternalEigenSystemType

Internal eigen sytem type. Definition at line 77 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement, int VNumberOfRows> typedef Matrix< TMatrixElement, VNumberOfRows, VNumberOfRows > itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::MatrixType

Matrix Type Definition at line 74 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement, int VNumberOfRows> typedef SmartPointer<Self> itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::Pointer

Reimplemented from itk::Object. Definition at line 52 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement, int VNumberOfRows> typedef SymmetricEigenSystem itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::Self

Standard "Self" typedef. Reimplemented from itk::Object. Definition at line 50 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement, int VNumberOfRows> typedef Object itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::Superclass

Reimplemented from itk::Object. Definition at line 51 of file itkSymmetricEigenSystem.h.

---

Constructor & Destructor Documentation

template<class TMatrixElement, int VNumberOfRows> itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::SymmetricEigenSystem (   )  [protected]

template<class TMatrixElement, int VNumberOfRows> virtual itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::~SymmetricEigenSystem (   )  [protected, virtual]

---

Member Function Documentation

static void itk::LightObject::BreakOnError (   )  [static, inherited]

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

virtual LightObject::Pointer itk::Object::CreateAnother (   )  const [virtual, inherited]

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.

virtual void itk::Object::DebugOff (   )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (   )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (   )  [virtual, inherited]

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.

template<class TMatrixElement, int VNumberOfRows> void itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::GenerateData (   )  [protected]

Produces the eigen vectors and values.

Command* itk::Object::GetCommand (  unsigned long  tag  )  [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug (   )  const [inherited]

Get the value of the debug flag.

template<class TMatrixElement, int VNumberOfRows> EigenValueArrayType* itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::GetEigenValues (   )  [inline]

returns the eigen values in an 1D array Definition at line 100 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement, int VNumberOfRows> EigenVectorArrayType* itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::GetEigenVectors (   )  [inline]

returns the eigen vectors in a 2D array Definition at line 96 of file itkSymmetricEigenSystem.h.

static bool itk::Object::GetGlobalWarningDisplay (   )  [static, inherited]

template<class TMatrixElement, int VNumberOfRows> MatrixType* itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::GetMatrix (  void   )  [inline]

Definition at line 81 of file itkSymmetricEigenSystem.h.

const MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  const [inherited]

Returns: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  [inherited]

Returns: A reference to this objects MetaDataDictionary. Warning: This reference may be changed.

virtual unsigned long itk::Object::GetMTime (   )  const [virtual, inherited]

Return this objects modified time. Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

template<class TMatrixElement, int VNumberOfRows> virtual const char* itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::GetNameOfClass (   )  const [virtual]

Run-time type information (and related methods). Reimplemented from itk::Object.

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

template<class TMatrixElement, int VNumberOfRows> virtual bool itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::GetUseAbsoluteOrder (   )  [virtual]

static void itk::Object::GlobalWarningDisplayOff (   )  [inline, static, inherited]

Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (   )  [inline, static, inherited]

Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver (  const EventObject &  event  )  const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent (  const EventObject &   )  const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent (  const EventObject &   )  [inherited]

Call Execute on all the Commands observing this event id.

virtual void itk::Object::Modified (   )  const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class TMatrixElement, int VNumberOfRows> static Pointer itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::Object.

void itk::LightObject::Print (  std::ostream &  os, Indent  indent = 0 )  const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers (  std::ostream &  os, Indent  indent )  const [protected, inherited]

template<class TMatrixElement, int VNumberOfRows> void itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::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::Object.

virtual void itk::LightObject::PrintTrailer (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

virtual void itk::Object::Register (   )  const [virtual, inherited]

Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (   )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver (  unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

void itk::Object::SetDebug (  bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

template<class TMatrixElement, int VNumberOfRows> Set Get the target matrix for the eigen analysis* virtual void itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::SetMatrix (  MatrixType *  _arg  )  [virtual]

void itk::Object::SetMetaDataDictionary (  const MetaDataDictionary &  rhs  )  [inherited]

Returns: Set the MetaDataDictionary

virtual void itk::Object::SetReferenceCount (  int   )  [virtual, inherited]

Sets the reference count (use with care) Reimplemented from itk::LightObject.

template<class TMatrixElement, int VNumberOfRows> Set Get the absolute order flag* By setting this flag after the calculation of eigen vectors* and if the absolute eigen value of eigen vector [j > i] is* greater that of eigen reorder the eigen vectors so that* every absolute eigen values of eigen vector [j < i] is always greater than or* equal to that of the eigen vectors* [i] virtual void itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::SetUseAbsoluteOrder (  bool  _arg  )  [virtual]

virtual void itk::Object::UnRegister (   )  const [virtual, inherited]

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

template<class TMatrixElement, int VNumberOfRows> void itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::Update (  void   )  [inline]

dummy method that calls the GenerateData method to produce the eigen vectors and values. Definition at line 105 of file itkSymmetricEigenSystem.h. References HardConnectedComponentImageFilter::GenerateData().

---

Member Data Documentation

Allow people to add remove invoke observers (callbacks) to any ITK * object. This is an implementation of the subject/observer design * pattern. An observer is added by specifying an event to respond to * and an itk unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

Methods invoked by virtual 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. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

template<class TMatrixElement, int VNumberOfRows> Set Get the absolute order flag* By setting this flag itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::true

Definition at line 86 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement, int VNumberOfRows> Set Get the absolute order flag* By setting this flag after the calculation of eigen vectors* and itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::values

Definition at line 86 of file itkSymmetricEigenSystem.h.

template<class TMatrixElement, int VNumberOfRows> Set Get the absolute order flag* By setting this flag after the calculation of eigen vectors* and if the absolute eigen value of eigen vector [j > i] is* greater that of eigen itk::SymmetricEigenSystem< TMatrixElement, VNumberOfRows >::vector[i]

Definition at line 86 of file itkSymmetricEigenSystem.h.

---

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

• itkSymmetricEigenSystem.h

---