<!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: itkGradientDescentOptimizer.h Source File</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>
<a href="modules.html" class="qindex">Groups</a>
<a href="namespaces.html" class="qindex">Namespace List</a>
<a href="hierarchy.html" class="qindex">Class Hierarchy</a>
<a href="classes.html" class="qindex">Alphabetical List</a>
<a href="annotated.html" class="qindex">Compound List</a>
<a href="files.html" class="qindex">File
List</a>
<a href="namespacemembers.html" class="qindex">Namespace Members</a>
<a href="functions.html" class="qindex">Compound Members</a>
<a href="globals.html" class="qindex">File Members</a>
<a href="pages.html" class="qindex">Concepts</a></center>
<!-- Generated by Doxygen 1.5.9 -->
<div class="navpath"><a class="el" href="dir_02e23d841c198393a6e961e9a0678fff.html">Code</a> » <a class="el" href="dir_2c33022d19e8077162952ea9ed57656d.html">Numerics</a>
</div>
<div class="contents">
<h1>itkGradientDescentOptimizer.h</h1><a href="itkGradientDescentOptimizer_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*=========================================================================</span>
<a name="l00002"></a>00002 <span class="comment"></span>
<a name="l00003"></a>00003 <span class="comment"> Program: Insight Segmentation & Registration Toolkit</span>
<a name="l00004"></a>00004 <span class="comment"> Module: $RCSfile: itkGradientDescentOptimizer.h,v $</span>
<a name="l00005"></a>00005 <span class="comment"> Language: C++</span>
<a name="l00006"></a>00006 <span class="comment"> Date: $Date: 2007-03-22 21:39:37 $</span>
<a name="l00007"></a>00007 <span class="comment"> Version: $Revision: 1.30 $</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> Copyright (c) Insight Software Consortium. All rights reserved.</span>
<a name="l00010"></a>00010 <span class="comment"> See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.</span>
<a name="l00011"></a>00011 <span class="comment"></span>
<a name="l00012"></a>00012 <span class="comment"> This software is distributed WITHOUT ANY WARRANTY; without even </span>
<a name="l00013"></a>00013 <span class="comment"> the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR </span>
<a name="l00014"></a>00014 <span class="comment"> PURPOSE. See the above copyright notices for more information.</span>
<a name="l00015"></a>00015 <span class="comment"></span>
<a name="l00016"></a>00016 <span class="comment">=========================================================================*/</span>
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef __itkGradientDescentOptimizer_h</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define __itkGradientDescentOptimizer_h</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include "<a class="code" href="itkSingleValuedNonLinearOptimizer_8h.html">itkSingleValuedNonLinearOptimizer.h</a>"</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="keyword">namespace </span>itk
<a name="l00023"></a>00023 {
<a name="l00024"></a>00024
<a name="l00048"></a><a class="code" href="classitk_1_1GradientDescentOptimizer.html">00048</a> <span class="keyword">class </span><a class="code" href="itkWin32Header_8h.html#7d4384322557205d75f0719c012dded6">ITK_EXPORT</a> <a class="code" href="classitk_1_1GradientDescentOptimizer.html" title="Implement a gradient descent optimizer.">GradientDescentOptimizer</a> :
<a name="l00049"></a>00049 <span class="keyword">public</span> <a class="code" href="classitk_1_1SingleValuedNonLinearOptimizer.html" title="This class is a base for the Optimization methods that optimize a single valued function...">SingleValuedNonLinearOptimizer</a>
<a name="l00050"></a>00050 {
<a name="l00051"></a>00051 <span class="keyword">public</span>:
<a name="l00053"></a><a class="code" href="classitk_1_1GradientDescentOptimizer.html#c538c9e18d3e2a1932b8d95d682259e1">00053</a> <span class="keyword">typedef</span> <a class="code" href="classitk_1_1GradientDescentOptimizer.html" title="Implement a gradient descent optimizer.">GradientDescentOptimizer</a> <a class="code" href="classitk_1_1LightObject.html" title="Light weight base class for most itk classes.">Self</a>;
<a name="l00054"></a><a class="code" href="classitk_1_1GradientDescentOptimizer.html#0b05b5370946f9bacf5dd561f2d254bd">00054</a> <span class="keyword">typedef</span> <a class="code" href="classitk_1_1SingleValuedNonLinearOptimizer.html" title="This class is a base for the Optimization methods that optimize a single valued function...">SingleValuedNonLinearOptimizer</a> <a class="code" href="classitk_1_1LightObject.html" title="Light weight base class for most itk classes.">Superclass</a>;
<a name="l00055"></a><a class="code" href="classitk_1_1GradientDescentOptimizer.html#df852f67d271783145212acb304f2bea">00055</a> <span class="keyword">typedef</span> <a class="code" href="classitk_1_1SmartPointer.html">SmartPointer<Self></a> <a class="code" href="classitk_1_1SmartPointer.html">Pointer</a>;
<a name="l00056"></a><a class="code" href="classitk_1_1GradientDescentOptimizer.html#b3b8c59f57200dd787dc0ded8e5384ca">00056</a> <span class="keyword">typedef</span> <a class="code" href="classitk_1_1SmartPointer.html">SmartPointer<const Self></a> <a class="code" href="classitk_1_1SmartPointer.html">ConstPointer</a>;
<a name="l00057"></a>00057
<a name="l00059"></a>00059 <a class="code" href="itkMacro_8h.html#0fdc15685afa271857c57e7cd482f30c">itkNewMacro</a>(<a class="code" href="classitk_1_1LightObject.html" title="Light weight base class for most itk classes.">Self</a>);
<a name="l00060"></a>00060
<a name="l00062"></a>00062 <a class="code" href="itkMacro_8h.html#574c1f86661d409dd32c742307a0e96a">itkTypeMacro</a>( <a class="code" href="classitk_1_1GradientDescentOptimizer.html" title="Implement a gradient descent optimizer.">GradientDescentOptimizer</a>, <a class="code" href="classitk_1_1SingleValuedNonLinearOptimizer.html" title="This class is a base for the Optimization methods that optimize a single valued function...">SingleValuedNonLinearOptimizer</a> );
<a name="l00063"></a>00063
<a name="l00064"></a>00064
<a name="l00066"></a><a class="code" href="classitk_1_1GradientDescentOptimizer.html#7b12d930202763aac1fbb3cbb0cfc9f0">00066</a> <span class="keyword">typedef</span> <span class="keyword">enum</span>
<a name="l00067"></a>00067 {
<a name="l00068"></a><a class="code" href="classitk_1_1GradientDescentOptimizer.html#7b12d930202763aac1fbb3cbb0cfc9f0cd53882b963a38bd11bfd255a502bad3">00068</a> MaximumNumberOfIterations,
<a name="l00069"></a><a class="code" href="classitk_1_1GradientDescentOptimizer.html#7b12d930202763aac1fbb3cbb0cfc9f0f7973bafeabc270f1f75708d2fd4ec6e">00069</a> MetricError
<a name="l00070"></a>00070 } StopConditionType;
<a name="l00071"></a>00071
<a name="l00073"></a>00073 <a class="code" href="itkMacro_8h.html#7d989c13a1a213168db99ae0f84185d4">itkGetConstReferenceMacro</a>( Maximize, <span class="keywordtype">bool</span> );
<a name="l00074"></a>00074 <a class="code" href="itkMacro_8h.html#7ebdd33cc5e7d74720ced9099c034faa">itkSetMacro</a>( Maximize, <span class="keywordtype">bool</span> );
<a name="l00075"></a>00075 <a class="code" href="itkMacro_8h.html#9e7d129ffebb09fd28bc213e02d87248">itkBooleanMacro</a>( Maximize );
<a name="l00076"></a><a class="code" href="classitk_1_1GradientDescentOptimizer.html#01bc4487cd3e5bb200b794a9201b640a">00076</a> <span class="keywordtype">bool</span> GetMinimize( )<span class="keyword"> const</span>
<a name="l00077"></a>00077 <span class="keyword"> </span>{ <span class="keywordflow">return</span> !m_Maximize; }
<a name="l00078"></a><a class="code" href="classitk_1_1GradientDescentOptimizer.html#89723b8b5509b28e6867a87ba2fa24b5">00078</a> <span class="keywordtype">void</span> SetMinimize(<span class="keywordtype">bool</span> v)
<a name="l00079"></a>00079 { this->SetMaximize(!v); }
<a name="l00080"></a><a class="code" href="classitk_1_1GradientDescentOptimizer.html#87c683f8ec43f5134daf6daa6d0e0fd6">00080</a> <span class="keywordtype">void</span> MinimizeOn()
<a name="l00081"></a>00081 { this->MaximizeOff(); }
<a name="l00082"></a><a class="code" href="classitk_1_1GradientDescentOptimizer.html#ee36c3e99a1c642ba1befb68629bb9ef">00082</a> <span class="keywordtype">void</span> MinimizeOff()
<a name="l00083"></a>00083 { this->MaximizeOn(); }
<a name="l00085"></a>00085
<a name="l00087"></a>00087 <span class="keyword">virtual</span> <span class="keywordtype">void</span> AdvanceOneStep( <span class="keywordtype">void</span> );
<a name="l00088"></a>00088
<a name="l00090"></a>00090 <span class="keywordtype">void</span> StartOptimization( <span class="keywordtype">void</span> );
<a name="l00091"></a>00091
<a name="l00094"></a>00094 <span class="keywordtype">void</span> ResumeOptimization( <span class="keywordtype">void</span> );
<a name="l00095"></a>00095
<a name="l00098"></a>00098 <span class="keywordtype">void</span> StopOptimization( <span class="keywordtype">void</span> );
<a name="l00099"></a>00099
<a name="l00101"></a>00101 <a class="code" href="itkMacro_8h.html#7ebdd33cc5e7d74720ced9099c034faa">itkSetMacro</a>( LearningRate, <span class="keywordtype">double</span> );
<a name="l00102"></a>00102
<a name="l00104"></a>00104 <a class="code" href="itkMacro_8h.html#7d989c13a1a213168db99ae0f84185d4">itkGetConstReferenceMacro</a>( LearningRate, <span class="keywordtype">double</span>);
<a name="l00105"></a>00105
<a name="l00107"></a>00107 <a class="code" href="itkMacro_8h.html#7ebdd33cc5e7d74720ced9099c034faa">itkSetMacro</a>( NumberOfIterations, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> );
<a name="l00108"></a>00108
<a name="l00110"></a>00110 <a class="code" href="itkMacro_8h.html#7d989c13a1a213168db99ae0f84185d4">itkGetConstReferenceMacro</a>( NumberOfIterations, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> );
<a name="l00111"></a>00111
<a name="l00113"></a>00113 <a class="code" href="itkMacro_8h.html#89294335d94b115d40e2603f2fff7950">itkGetConstMacro</a>( CurrentIteration, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> );
<a name="l00114"></a>00114
<a name="l00116"></a>00116 <a class="code" href="itkMacro_8h.html#7d989c13a1a213168db99ae0f84185d4">itkGetConstReferenceMacro</a>( Value, <span class="keywordtype">double</span> );
<a name="l00117"></a>00117
<a name="l00119"></a>00119 <a class="code" href="itkMacro_8h.html#7d989c13a1a213168db99ae0f84185d4">itkGetConstReferenceMacro</a>( StopCondition, StopConditionType );
<a name="l00120"></a>00120
<a name="l00122"></a>00122 <a class="code" href="itkMacro_8h.html#7d989c13a1a213168db99ae0f84185d4">itkGetConstReferenceMacro</a>( Gradient, DerivativeType );
<a name="l00123"></a>00123
<a name="l00124"></a>00124
<a name="l00125"></a>00125 <span class="keyword">protected</span>:
<a name="l00126"></a>00126 <a class="code" href="classitk_1_1GradientDescentOptimizer.html" title="Implement a gradient descent optimizer.">GradientDescentOptimizer</a>();
<a name="l00127"></a><a class="code" href="classitk_1_1GradientDescentOptimizer.html#351cfa7bc993476b4eca1f4bee122650">00127</a> <span class="keyword">virtual</span> <a class="code" href="classitk_1_1GradientDescentOptimizer.html#351cfa7bc993476b4eca1f4bee122650">~GradientDescentOptimizer</a>() {};
<a name="l00128"></a>00128 <span class="keywordtype">void</span> <a class="code" href="namespaceHardConnectedComponentImageFilter.html#920ae03048a5ad715d803ca2e92b52de">PrintSelf</a>(std::ostream& os, <a class="code" href="classitk_1_1Indent.html" title="Control indentation during Print() invocation.">Indent</a> indent) <span class="keyword">const</span>;
<a name="l00129"></a>00129
<a name="l00130"></a>00130
<a name="l00131"></a>00131 <span class="comment">// made protected so subclass can access</span>
<a name="l00132"></a><a class="code" href="classitk_1_1GradientDescentOptimizer.html#43a890098ce875c1af9d21e61b6213f8">00132</a> DerivativeType m_Gradient;
<a name="l00133"></a><a class="code" href="classitk_1_1GradientDescentOptimizer.html#fb6e723cf7d9a41c4838686a14f0c3e3">00133</a> <span class="keywordtype">bool</span> m_Maximize;
<a name="l00134"></a><a class="code" href="classitk_1_1GradientDescentOptimizer.html#2377df7c63c79894934d17571780ca9d">00134</a> <span class="keywordtype">double</span> m_LearningRate;
<a name="l00135"></a>00135
<a name="l00136"></a>00136 <span class="keyword">private</span>:
<a name="l00137"></a>00137 <a class="code" href="classitk_1_1GradientDescentOptimizer.html" title="Implement a gradient descent optimizer.">GradientDescentOptimizer</a>(<span class="keyword">const</span> <a class="code" href="classitk_1_1LightObject.html" title="Light weight base class for most itk classes.">Self</a>&); <span class="comment">//purposely not implemented</span>
<a name="l00138"></a>00138 <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> <a class="code" href="classitk_1_1LightObject.html" title="Light weight base class for most itk classes.">Self</a>&); <span class="comment">//purposely not implemented</span>
<a name="l00139"></a>00139
<a name="l00140"></a>00140 <span class="keywordtype">bool</span> m_Stop;
<a name="l00141"></a>00141 <span class="keywordtype">double</span> m_Value;
<a name="l00142"></a>00142 <a class="code" href="classitk_1_1GradientDescentOptimizer.html#7b12d930202763aac1fbb3cbb0cfc9f0">StopConditionType</a> m_StopCondition;
<a name="l00143"></a>00143 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> m_NumberOfIterations;
<a name="l00144"></a>00144 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> m_CurrentIteration;
<a name="l00145"></a>00145
<a name="l00146"></a>00146 };
<a name="l00147"></a>00147
<a name="l00148"></a>00148 } <span class="comment">// end namespace itk</span>
<a name="l00149"></a>00149
<a name="l00150"></a>00150
<a name="l00151"></a>00151 <span class="preprocessor">#endif</span>
<a name="l00152"></a>00152 <span class="preprocessor"></span>
</pre></div></div>
<hr><address><small>
Generated at Thu May 7 22:49:39 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>,
© 1997-2000</small></address>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
d5e74628f0e673bb8680aebce32b2c04
>
files
>
15937
