Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > d5e74628f0e673bb8680aebce32b2c04 > files > 9850

itk-doc-3.12.0-1mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta name="robots" content="noindex">
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>ITK: itk::SymmetricEigenAnalysis&lt; TMatrix, TVector, TEigenMatrix &gt; Class Template Reference</title>
<link href="DoxygenStyle.css" rel="stylesheet" type="text/css">
</head><body bgcolor="#ffffff">


<!--  Section customized for INSIGHT : Tue Jul 17 01:02:45 2001 -->
<center>
<a href="index.html" class="qindex">Main Page</a>&nbsp;&nbsp; 
<a href="modules.html" class="qindex">Groups</a>&nbsp;&nbsp;
<a href="namespaces.html" class="qindex">Namespace List</a>&nbsp;&nbsp;
<a href="hierarchy.html" class="qindex">Class Hierarchy</a>&nbsp;&nbsp;
<a href="classes.html" class="qindex">Alphabetical List</a>&nbsp;&nbsp;
<a href="annotated.html" class="qindex">Compound List</a>&nbsp;&nbsp; 
<a href="files.html" class="qindex">File
List</a>&nbsp;&nbsp; 
<a href="namespacemembers.html" class="qindex">Namespace Members</a>&nbsp;&nbsp; 
<a href="functions.html" class="qindex">Compound Members</a>&nbsp;&nbsp; 
<a href="globals.html" class="qindex">File Members</a>&nbsp;&nbsp;
<a href="pages.html" class="qindex">Concepts</a></center>


<!-- Generated by Doxygen 1.5.9 -->
  <div class="navpath"><a class="el" href="namespaceitk.html">itk</a>::<a class="el" href="classitk_1_1SymmetricEigenAnalysis.html">SymmetricEigenAnalysis</a>
  </div>
<div class="contents">
<h1>itk::SymmetricEigenAnalysis&lt; TMatrix, TVector, TEigenMatrix &gt; Class Template Reference</h1><!-- doxytag: class="itk::SymmetricEigenAnalysis" -->Find Eigen values of a real 2D symmetric matrix. It serves as a thread safe alternative to the class: vnl_symmetric_eigensystem, which uses netlib routines.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="itkSymmetricEigenAnalysis_8h_source.html">itkSymmetricEigenAnalysis.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for itk::SymmetricEigenAnalysis&lt; TMatrix, TVector, TEigenMatrix &gt;:</div>
<div class="dynsection">
<p><center><img src="classitk_1_1SymmetricEigenAnalysis__inherit__graph.png" border="0" usemap="#itk_1_1SymmetricEigenAnalysis_3_01TMatrix_00_01TVector_00_01TEigenMatrix_01_4__inherit__map" alt="Inheritance graph"></center>
<map name="itk_1_1SymmetricEigenAnalysis_3_01TMatrix_00_01TVector_00_01TEigenMatrix_01_4__inherit__map">
<area shape="rect" id="node3" href="classitk_1_1SymmetricEigenAnalysis.html" title="itk::SymmetricEigenAnalysis\&lt; TInput, TOutput \&gt;" alt="" coords="988,5,1337,35"><area shape="rect" id="node5" href="classitk_1_1SymmetricEigenAnalysis.html" title="itk::SymmetricEigenAnalysis\&lt; TInputImage::PixelType, TOutputImage::PixelType \&gt;" alt="" coords="873,59,1452,88"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classitk_1_1SymmetricEigenAnalysis-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef TEigenMatrix&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#05386095860aa8c85f43552f559a0863">EigenMatrixType</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#2dfed39f005f7a14cb6449d147ca0534">EigenValueOrderType</a> { <br>
&nbsp;&nbsp;<a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#2dfed39f005f7a14cb6449d147ca05345ad7ae0e043886592ca8451e00091939">OrderByValue</a> = 1, 
<br>
&nbsp;&nbsp;<a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#2dfed39f005f7a14cb6449d147ca053480a542e28c5052eeb6e73cc4928176a0">OrderByMagnitude</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#2dfed39f005f7a14cb6449d147ca053453b44a624e018b67889ab68df7bfa49d">DoNotOrder</a>
<br>
 }</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef TMatrix&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#9d96a4320ef48fad3c3ff5ebc8dc9c84">MatrixType</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef TVector&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#2248d7e3e60a18d48c750b5dd4f5d88e">VectorType</a></td></tr>

<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#d095004a67066b24eb2e8fc5a9cdd4e2">ComputeEigenValues</a> (const TMatrix &amp;<a class="el" href="classA.html">A</a>, TVector &amp;EigenValues) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#0aa8cac66965c6a1c340ca3413629ebe">ComputeEigenValuesAndVectors</a> (const TMatrix &amp;<a class="el" href="classA.html">A</a>, TVector &amp;EigenValues, TEigenMatrix &amp;EigenVectors) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#9dccc25397f2663133fadcc35cbddcfd">GetDimension</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#cbed216ff01d6bef49d77a1c4ae80b9a">GetOrder</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#77109a372c5b88cc76264415df6ab23a">SetOrder</a> (const unsigned int n)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#66972d1a76f2d8eb42447ec2aa57d48d">SymmetricEigenAnalysis</a> (const unsigned int dimension)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#396d5b80364d766f7cc792d626dae215">SymmetricEigenAnalysis</a> ()</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#e070ef9a677aa3c19385b5b8fd302ecf">~SymmetricEigenAnalysis</a> ()</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#b83a93af0c3fbc39cbcfe586e4e22fd8">GetOrderEigenMagnitudes</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#01cf8d66b94ed4992154de9ec297e6ee">SetOrderEigenMagnitudes</a> (const bool b)</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#999e7151b1299764d2be95a8987c5f30">GetOrderEigenValues</a> () const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#7940261268fb1ec182b94a5e4eebb345">SetOrderEigenValues</a> (const bool b)</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#0e491bba952259d5f0f06fd1f5965959">SetDimension</a> (const unsigned int n)</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix&gt;<br>
 class itk::SymmetricEigenAnalysis&lt; TMatrix, TVector, TEigenMatrix &gt;</h3>

Find Eigen values of a real 2D symmetric matrix. It serves as a thread safe alternative to the class: vnl_symmetric_eigensystem, which uses netlib routines. 
<p>
The class is templated over the input matrix, (which is expected to provide access to its elements with the [][] operator), matrix to store eigen values, (must provide write operations on its elements with the [] operator), EigenMatrix to store eigen vectors (must provide write access to its elements with the [][] operator).<p>
The <a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#7940261268fb1ec182b94a5e4eebb345">SetOrderEigenValues()</a> method can be used to order eigen values (and their corresponding eigen vectors if computed) in ascending order. This is the default ordering scheme. Eigen vectors and values can be obtained without ordering by calling SetOrderEigenValues(false)<p>
The <a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#01cf8d66b94ed4992154de9ec297e6ee">SetOrderEigenMagnitudes()</a> method can be used to order eigen values (and their corresponding eigen vectors if computed) by magnitude in ascending order.<p>
The user of this class is explicitly supposed to set the dimension of the 2D matrix using the <a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#0e491bba952259d5f0f06fd1f5965959">SetDimension()</a> method.<p>
The class contains routines taken from netlib sources. (www.netlib.org). netlib/tql1.c netlib/tql2.c netlib/tred1.c netlib/tred2.c<p>
Reference: num. math. 11, 293-306(1968) by bowdler, martin, reinsch, and wilkinson. handbook for auto. comp., vol.ii-linear algebra, 227-240(1971). 
<p>Definition at line <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html#l00060">60</a> of file <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html">itkSymmetricEigenAnalysis.h</a>.</p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="05386095860aa8c85f43552f559a0863"></a><!-- doxytag: member="itk::SymmetricEigenAnalysis::EigenMatrixType" ref="05386095860aa8c85f43552f559a0863" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef TEigenMatrix <a class="el" href="classitk_1_1SymmetricEigenAnalysis.html">itk::SymmetricEigenAnalysis</a>&lt; TMatrix, TVector, TEigenMatrix &gt;::<a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#05386095860aa8c85f43552f559a0863">EigenMatrixType</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html#l00084">84</a> of file <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html">itkSymmetricEigenAnalysis.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="9d96a4320ef48fad3c3ff5ebc8dc9c84"></a><!-- doxytag: member="itk::SymmetricEigenAnalysis::MatrixType" ref="9d96a4320ef48fad3c3ff5ebc8dc9c84" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef TMatrix <a class="el" href="classitk_1_1SymmetricEigenAnalysis.html">itk::SymmetricEigenAnalysis</a>&lt; TMatrix, TVector, TEigenMatrix &gt;::<a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#9d96a4320ef48fad3c3ff5ebc8dc9c84">MatrixType</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html#l00081">81</a> of file <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html">itkSymmetricEigenAnalysis.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="2248d7e3e60a18d48c750b5dd4f5d88e"></a><!-- doxytag: member="itk::SymmetricEigenAnalysis::VectorType" ref="2248d7e3e60a18d48c750b5dd4f5d88e" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef TVector <a class="el" href="classitk_1_1SymmetricEigenAnalysis.html">itk::SymmetricEigenAnalysis</a>&lt; TMatrix, TVector, TEigenMatrix &gt;::<a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#2248d7e3e60a18d48c750b5dd4f5d88e">VectorType</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html#l00085">85</a> of file <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html">itkSymmetricEigenAnalysis.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="2dfed39f005f7a14cb6449d147ca0534"></a><!-- doxytag: member="itk::SymmetricEigenAnalysis::EigenValueOrderType" ref="2dfed39f005f7a14cb6449d147ca0534" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classitk_1_1SymmetricEigenAnalysis.html#2dfed39f005f7a14cb6449d147ca0534">itk::SymmetricEigenAnalysis::EigenValueOrderType</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="2dfed39f005f7a14cb6449d147ca05345ad7ae0e043886592ca8451e00091939"></a><!-- doxytag: member="OrderByValue" ref="2dfed39f005f7a14cb6449d147ca05345ad7ae0e043886592ca8451e00091939" args="" -->OrderByValue</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="2dfed39f005f7a14cb6449d147ca053480a542e28c5052eeb6e73cc4928176a0"></a><!-- doxytag: member="OrderByMagnitude" ref="2dfed39f005f7a14cb6449d147ca053480a542e28c5052eeb6e73cc4928176a0" args="" -->OrderByMagnitude</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="2dfed39f005f7a14cb6449d147ca053453b44a624e018b67889ab68df7bfa49d"></a><!-- doxytag: member="DoNotOrder" ref="2dfed39f005f7a14cb6449d147ca053453b44a624e018b67889ab68df7bfa49d" args="" -->DoNotOrder</em>&nbsp;</td><td>
</td></tr>
</table>
</dl>

<p>Definition at line <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html#l00063">63</a> of file <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html">itkSymmetricEigenAnalysis.h</a>.</p>

</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="396d5b80364d766f7cc792d626dae215"></a><!-- doxytag: member="itk::SymmetricEigenAnalysis::SymmetricEigenAnalysis" ref="396d5b80364d766f7cc792d626dae215" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classitk_1_1SymmetricEigenAnalysis.html">itk::SymmetricEigenAnalysis</a>&lt; TMatrix, TVector, TEigenMatrix &gt;::<a class="el" href="classitk_1_1SymmetricEigenAnalysis.html">SymmetricEigenAnalysis</a>           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html#l00069">69</a> of file <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html">itkSymmetricEigenAnalysis.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="66972d1a76f2d8eb42447ec2aa57d48d"></a><!-- doxytag: member="itk::SymmetricEigenAnalysis::SymmetricEigenAnalysis" ref="66972d1a76f2d8eb42447ec2aa57d48d" args="(const unsigned int dimension)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classitk_1_1SymmetricEigenAnalysis.html">itk::SymmetricEigenAnalysis</a>&lt; TMatrix, TVector, TEigenMatrix &gt;::<a class="el" href="classitk_1_1SymmetricEigenAnalysis.html">SymmetricEigenAnalysis</a>           </td>
          <td>(</td>
          <td class="paramtype">const unsigned int&nbsp;</td>
          <td class="paramname"> <em>dimension</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html#l00075">75</a> of file <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html">itkSymmetricEigenAnalysis.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="e070ef9a677aa3c19385b5b8fd302ecf"></a><!-- doxytag: member="itk::SymmetricEigenAnalysis::~SymmetricEigenAnalysis" ref="e070ef9a677aa3c19385b5b8fd302ecf" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classitk_1_1SymmetricEigenAnalysis.html">itk::SymmetricEigenAnalysis</a>&lt; TMatrix, TVector, TEigenMatrix &gt;::~<a class="el" href="classitk_1_1SymmetricEigenAnalysis.html">SymmetricEigenAnalysis</a>           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html#l00081">81</a> of file <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html">itkSymmetricEigenAnalysis.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="d095004a67066b24eb2e8fc5a9cdd4e2"></a><!-- doxytag: member="itk::SymmetricEigenAnalysis::ComputeEigenValues" ref="d095004a67066b24eb2e8fc5a9cdd4e2" args="(const TMatrix &amp;A, TVector &amp;EigenValues) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">unsigned int <a class="el" href="classitk_1_1SymmetricEigenAnalysis.html">itk::SymmetricEigenAnalysis</a>&lt; TMatrix, TVector, TEigenMatrix &gt;::ComputeEigenValues           </td>
          <td>(</td>
          <td class="paramtype">const TMatrix &amp;&nbsp;</td>
          <td class="paramname"> <em>A</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TVector &amp;&nbsp;</td>
          <td class="paramname"> <em>EigenValues</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Compute Eigen values of <a class="el" href="classA.html">A</a> <a class="el" href="classA.html">A</a> is any type that overloads the [][] operator and contains the symmetric matrix. In practice only the upper triangle of the matrix will be accessed. (Both <a class="el" href="classitk_1_1Matrix.html" title="A templated class holding a M x N size Matrix This class contains a vnl_matrix_fixed...">itk::Matrix</a> and <a class="el" href="classvnl__matrix.html">vnl_matrix</a> overload [][] operator.)<p>
'EigenValues' is any type that overloads the [] operator and will contain the eigen values.<p>
No size checking is performed. <a class="el" href="classA.html">A</a> is expected to be a square matrix of size m_Dimension. 'EigenValues' is expected to be of length m_Dimension. The matrix is not checked to see if it is symmetric. 
<p>Referenced by <a class="el" href="itkSymmetricEigenAnalysisImageFilter_8h_source.html#l00054">itk::Functor::SymmetricEigenAnalysisFunction&lt; TInputImage::PixelType, TOutputImage::PixelType &gt;::operator()()</a>.</p>

</div>
</div><p>
<a class="anchor" name="0aa8cac66965c6a1c340ca3413629ebe"></a><!-- doxytag: member="itk::SymmetricEigenAnalysis::ComputeEigenValuesAndVectors" ref="0aa8cac66965c6a1c340ca3413629ebe" args="(const TMatrix &amp;A, TVector &amp;EigenValues, TEigenMatrix &amp;EigenVectors) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">unsigned int <a class="el" href="classitk_1_1SymmetricEigenAnalysis.html">itk::SymmetricEigenAnalysis</a>&lt; TMatrix, TVector, TEigenMatrix &gt;::ComputeEigenValuesAndVectors           </td>
          <td>(</td>
          <td class="paramtype">const TMatrix &amp;&nbsp;</td>
          <td class="paramname"> <em>A</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TVector &amp;&nbsp;</td>
          <td class="paramname"> <em>EigenValues</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">TEigenMatrix &amp;&nbsp;</td>
          <td class="paramname"> <em>EigenVectors</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Compute Eigen values and vectors of <a class="el" href="classA.html">A</a> <a class="el" href="classA.html">A</a> is any type that overloads the [][] operator and contains the symmetric matrix. In practice only the upper triangle of the matrix will be accessed. (Both <a class="el" href="classitk_1_1Matrix.html" title="A templated class holding a M x N size Matrix This class contains a vnl_matrix_fixed...">itk::Matrix</a> and <a class="el" href="classvnl__matrix.html">vnl_matrix</a> overload [][] operator.)<p>
'EigenValues' is any type that overloads the [] operator and will contain the eigen values.<p>
'EigenVectors' is any type that provides access to its elements with the [][] operator. It is expected be of size m_Dimension * m_Dimension.<p>
No size checking is performed. <a class="el" href="classA.html">A</a> is expected to be a square matrix of size m_Dimension. 'EigenValues' is expected to be of length m_Dimension. The matrix is not checked to see if it is symmetric.<p>
Each row of the matrix 'EigenVectors' represents an eigen vector. (unlike MATLAB where the columns of the [EigenVectors, EigenValues] = eig(A) contains the eigenvectors). 
</div>
</div><p>
<a class="anchor" name="9dccc25397f2663133fadcc35cbddcfd"></a><!-- doxytag: member="itk::SymmetricEigenAnalysis::GetDimension" ref="9dccc25397f2663133fadcc35cbddcfd" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">unsigned int <a class="el" href="classitk_1_1SymmetricEigenAnalysis.html">itk::SymmetricEigenAnalysis</a>&lt; TMatrix, TVector, TEigenMatrix &gt;::<a class="el" href="structitk_1_1GetDimension.html">GetDimension</a>           </td>
          <td>(</td>
          <td class="paramtype">void&nbsp;</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get <a class="el" href="classitk_1_1Matrix.html" title="A templated class holding a M x N size Matrix This class contains a vnl_matrix_fixed...">Matrix</a> dimension, Will be 0 unless explicitly set by a call to SetDimension. 
<p>Definition at line <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html#l00179">179</a> of file <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html">itkSymmetricEigenAnalysis.h</a>.</p>

<p>Referenced by <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html#l00315">itk::operator&lt;&lt;()</a>.</p>

</div>
</div><p>
<a class="anchor" name="cbed216ff01d6bef49d77a1c4ae80b9a"></a><!-- doxytag: member="itk::SymmetricEigenAnalysis::GetOrder" ref="cbed216ff01d6bef49d77a1c4ae80b9a" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">unsigned int <a class="el" href="classitk_1_1SymmetricEigenAnalysis.html">itk::SymmetricEigenAnalysis</a>&lt; TMatrix, TVector, TEigenMatrix &gt;::GetOrder           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Get the <a class="el" href="classitk_1_1Matrix.html" title="A templated class holding a M x N size Matrix This class contains a vnl_matrix_fixed...">Matrix</a> order. Will be 0 unless explicitly set, or unless a call to SetDimension has been made in which case it will be the matrix dimension. 
<p>Definition at line <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html#l00141">141</a> of file <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html">itkSymmetricEigenAnalysis.h</a>.</p>

<p>Referenced by <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html#l00315">itk::operator&lt;&lt;()</a>.</p>

</div>
</div><p>
<a class="anchor" name="b83a93af0c3fbc39cbcfe586e4e22fd8"></a><!-- doxytag: member="itk::SymmetricEigenAnalysis::GetOrderEigenMagnitudes" ref="b83a93af0c3fbc39cbcfe586e4e22fd8" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classitk_1_1SymmetricEigenAnalysis.html">itk::SymmetricEigenAnalysis</a>&lt; TMatrix, TVector, TEigenMatrix &gt;::GetOrderEigenMagnitudes           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set/Get methods to order the eigen value magnitudes in ascending order. In other words, |lambda_1| &lt; |lambda_2| &lt; ..... 
<p>Definition at line <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html#l00162">162</a> of file <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html">itkSymmetricEigenAnalysis.h</a>.</p>

<p>Referenced by <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html#l00315">itk::operator&lt;&lt;()</a>.</p>

</div>
</div><p>
<a class="anchor" name="999e7151b1299764d2be95a8987c5f30"></a><!-- doxytag: member="itk::SymmetricEigenAnalysis::GetOrderEigenValues" ref="999e7151b1299764d2be95a8987c5f30" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classitk_1_1SymmetricEigenAnalysis.html">itk::SymmetricEigenAnalysis</a>&lt; TMatrix, TVector, TEigenMatrix &gt;::GetOrderEigenValues           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set/Get methods to order the eigen values in ascending order. This is the default. ie lambda_1 &lt; lambda_2 &lt; .... 
<p>Definition at line <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html#l00151">151</a> of file <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html">itkSymmetricEigenAnalysis.h</a>.</p>

<p>Referenced by <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html#l00315">itk::operator&lt;&lt;()</a>.</p>

</div>
</div><p>
<a class="anchor" name="0e491bba952259d5f0f06fd1f5965959"></a><!-- doxytag: member="itk::SymmetricEigenAnalysis::SetDimension" ref="0e491bba952259d5f0f06fd1f5965959" args="(const unsigned int n)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classitk_1_1SymmetricEigenAnalysis.html">itk::SymmetricEigenAnalysis</a>&lt; TMatrix, TVector, TEigenMatrix &gt;::SetDimension           </td>
          <td>(</td>
          <td class="paramtype">const unsigned int&nbsp;</td>
          <td class="paramname"> <em>n</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the dimension of the input matrix <a class="el" href="classA.html">A</a>. <a class="el" href="classA.html">A</a> is a square matrix of size m_Dimension. 
<p>Definition at line <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html#l00167">167</a> of file <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html">itkSymmetricEigenAnalysis.h</a>.</p>

<p>Referenced by <a class="el" href="itkSymmetricEigenAnalysisImageFilter_8h_source.html#l00062">itk::Functor::SymmetricEigenAnalysisFunction&lt; TInputImage::PixelType, TOutputImage::PixelType &gt;::SetDimension()</a>.</p>

</div>
</div><p>
<a class="anchor" name="77109a372c5b88cc76264415df6ab23a"></a><!-- doxytag: member="itk::SymmetricEigenAnalysis::SetOrder" ref="77109a372c5b88cc76264415df6ab23a" args="(const unsigned int n)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classitk_1_1SymmetricEigenAnalysis.html">itk::SymmetricEigenAnalysis</a>&lt; TMatrix, TVector, TEigenMatrix &gt;::SetOrder           </td>
          <td>(</td>
          <td class="paramtype">const unsigned int&nbsp;</td>
          <td class="paramname"> <em>n</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<a class="el" href="classitk_1_1Matrix.html" title="A templated class holding a M x N size Matrix This class contains a vnl_matrix_fixed...">Matrix</a> order. Defaults to matrix dimension if not set 
<p>Definition at line <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html#l00133">133</a> of file <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html">itkSymmetricEigenAnalysis.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="01cf8d66b94ed4992154de9ec297e6ee"></a><!-- doxytag: member="itk::SymmetricEigenAnalysis::SetOrderEigenMagnitudes" ref="01cf8d66b94ed4992154de9ec297e6ee" args="(const bool b)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classitk_1_1SymmetricEigenAnalysis.html">itk::SymmetricEigenAnalysis</a>&lt; TMatrix, TVector, TEigenMatrix &gt;::SetOrderEigenMagnitudes           </td>
          <td>(</td>
          <td class="paramtype">const bool&nbsp;</td>
          <td class="paramname"> <em>b</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set/Get methods to order the eigen value magnitudes in ascending order. In other words, |lambda_1| &lt; |lambda_2| &lt; ..... 
<p>Definition at line <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html#l00157">157</a> of file <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html">itkSymmetricEigenAnalysis.h</a>.</p>

<p>Referenced by <a class="el" href="itkSymmetricEigenAnalysisImageFilter_8h_source.html#l00080">itk::Functor::SymmetricEigenAnalysisFunction&lt; TInputImage::PixelType, TOutputImage::PixelType &gt;::OrderEigenValuesBy()</a>.</p>

</div>
</div><p>
<a class="anchor" name="7940261268fb1ec182b94a5e4eebb345"></a><!-- doxytag: member="itk::SymmetricEigenAnalysis::SetOrderEigenValues" ref="7940261268fb1ec182b94a5e4eebb345" args="(const bool b)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename TMatrix, typename TVector, typename TEigenMatrix = TMatrix&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classitk_1_1SymmetricEigenAnalysis.html">itk::SymmetricEigenAnalysis</a>&lt; TMatrix, TVector, TEigenMatrix &gt;::SetOrderEigenValues           </td>
          <td>(</td>
          <td class="paramtype">const bool&nbsp;</td>
          <td class="paramname"> <em>b</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set/Get methods to order the eigen values in ascending order. This is the default. ie lambda_1 &lt; lambda_2 &lt; .... 
<p>Definition at line <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html#l00146">146</a> of file <a class="el" href="itkSymmetricEigenAnalysis_8h_source.html">itkSymmetricEigenAnalysis.h</a>.</p>

<p>Referenced by <a class="el" href="itkSymmetricEigenAnalysisImageFilter_8h_source.html#l00080">itk::Functor::SymmetricEigenAnalysisFunction&lt; TInputImage::PixelType, TOutputImage::PixelType &gt;::OrderEigenValuesBy()</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="itkSymmetricEigenAnalysis_8h_source.html">itkSymmetricEigenAnalysis.h</a></ul>
</div>
<hr><address><small>
Generated at Fri May 8 07:21:12 2009 for ITK  by <a href="http://www.stack.nl/~dimitri/doxygen/index.html"> <img 
src="http://www.stack.nl/~dimitri/doxygen/doxygen.png" alt="doxygen"
align="middle" border=0 width=110 height=53>
</a> 1.5.9 written by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch</a>,
 &copy;&nbsp;1997-2000</small></address>
</body>
</html>