<!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: itkRegularStepGradientDescentBaseOptimizer.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>itkRegularStepGradientDescentBaseOptimizer.h</h1><a href="itkRegularStepGradientDescentBaseOptimizer_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: itkRegularStepGradientDescentBaseOptimizer.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-08-14 17:08:31 $</span>
<a name="l00007"></a>00007 <span class="comment"> Version: $Revision: 1.22 $</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 __itkRegularStepGradientDescentBaseOptimizer_h</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define __itkRegularStepGradientDescentBaseOptimizer_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="l00030"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html">00030</a> <span class="keyword">class </span><a class="code" href="itkWin32Header_8h.html#7d4384322557205d75f0719c012dded6">ITK_EXPORT</a> <a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html" title="Implement a gradient descent optimizer.">RegularStepGradientDescentBaseOptimizer</a> :
<a name="l00031"></a>00031 <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="l00032"></a>00032 {
<a name="l00033"></a>00033 <span class="keyword">public</span>:
<a name="l00035"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#0f0a78a3823288a61c072bc68f5493c6">00035</a> <span class="keyword">typedef</span> <a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html" title="Implement a gradient descent optimizer.">RegularStepGradientDescentBaseOptimizer</a> <a class="code" href="classitk_1_1LightObject.html" title="Light weight base class for most itk classes.">Self</a>;
<a name="l00036"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#39da727d78fe57e97e15061c0be05fdc">00036</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="l00037"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#5942c29da5d33158da447dde01140258">00037</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="l00038"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#af31b2be83dde53f921d5e452dd1d2d1">00038</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="l00039"></a>00039
<a name="l00041"></a>00041 <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="l00042"></a>00042
<a name="l00044"></a>00044 <a class="code" href="itkMacro_8h.html#574c1f86661d409dd32c742307a0e96a">itkTypeMacro</a>( <a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html" title="Implement a gradient descent optimizer.">RegularStepGradientDescentBaseOptimizer</a>,
<a name="l00045"></a>00045 <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="l00046"></a>00046
<a name="l00047"></a>00047
<a name="l00049"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#1fb01a1f68dfec24f3b7b12bc25fd91f">00049</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {
<a name="l00050"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#1fb01a1f68dfec24f3b7b12bc25fd91f352c10a38d88fa4721412d3c48422e98">00050</a> GradientMagnitudeTolerance = 1,
<a name="l00051"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#1fb01a1f68dfec24f3b7b12bc25fd91fac39e6d47a159165cab67c525605d02f">00051</a> StepTooSmall = 2,
<a name="l00052"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#1fb01a1f68dfec24f3b7b12bc25fd91f4223fdeafc0c2ddda4246f5b128121f7">00052</a> ImageNotAvailable = 3,
<a name="l00053"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#1fb01a1f68dfec24f3b7b12bc25fd91f7772566957627bb20d025fb9703b827c">00053</a> CostFunctionError = 4,
<a name="l00054"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#1fb01a1f68dfec24f3b7b12bc25fd91f03d3fda8221cb7cd32db5cb2fc89d5ba">00054</a> MaximumNumberOfIterations = 5,
<a name="l00055"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#1fb01a1f68dfec24f3b7b12bc25fd91f0f62e13658ef0ce43b6bae218d25866d">00055</a> <a class="code" href="namespaceitk.html#7b4767a0dc591bc3c1e1af6dcab61791f7abba533cb4f3fe9abd761914a8fcad">Unknown</a> = 6
<a name="l00056"></a>00056 } StopConditionType;
<a name="l00057"></a>00057
<a name="l00059"></a>00059 <a class="code" href="itkMacro_8h.html#7ebdd33cc5e7d74720ced9099c034faa">itkSetMacro</a>( Maximize, <span class="keywordtype">bool</span> );
<a name="l00060"></a>00060 <a class="code" href="itkMacro_8h.html#7d989c13a1a213168db99ae0f84185d4">itkGetConstReferenceMacro</a>( Maximize, <span class="keywordtype">bool</span> );
<a name="l00061"></a>00061 <a class="code" href="itkMacro_8h.html#9e7d129ffebb09fd28bc213e02d87248">itkBooleanMacro</a>( Maximize );
<a name="l00062"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#4c17f2cfdf6928bfa20447ab0d82a8f9">00062</a> <span class="keywordtype">bool</span> GetMinimize( )<span class="keyword"> const</span>
<a name="l00063"></a>00063 <span class="keyword"> </span>{ <span class="keywordflow">return</span> !m_Maximize; }
<a name="l00064"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#cac447fd77e84f6104783bf9d2d58597">00064</a> <span class="keywordtype">void</span> SetMinimize(<span class="keywordtype">bool</span> v)
<a name="l00065"></a>00065 { this->SetMaximize(!v); }
<a name="l00066"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#d50d8578c371bec00328165f4084f568">00066</a> <span class="keywordtype">void</span> MinimizeOn(<span class="keywordtype">void</span>)
<a name="l00067"></a>00067 { SetMaximize( <span class="keyword">false</span> ); }
<a name="l00068"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#daef680f7f3de625f9f228df1a1fecb1">00068</a> <span class="keywordtype">void</span> MinimizeOff(<span class="keywordtype">void</span>)
<a name="l00069"></a>00069 { SetMaximize( <span class="keyword">true</span> ); }
<a name="l00071"></a>00071
<a name="l00073"></a>00073 <span class="keywordtype">void</span> StartOptimization( <span class="keywordtype">void</span> );
<a name="l00074"></a>00074
<a name="l00077"></a>00077 <span class="keywordtype">void</span> ResumeOptimization( <span class="keywordtype">void</span> );
<a name="l00078"></a>00078
<a name="l00081"></a>00081 <span class="keywordtype">void</span> StopOptimization( <span class="keywordtype">void</span> );
<a name="l00082"></a>00082
<a name="l00084"></a>00084 <a class="code" href="itkMacro_8h.html#7ebdd33cc5e7d74720ced9099c034faa">itkSetMacro</a>( MaximumStepLength, <span class="keywordtype">double</span> );
<a name="l00085"></a>00085 <a class="code" href="itkMacro_8h.html#7ebdd33cc5e7d74720ced9099c034faa">itkSetMacro</a>( MinimumStepLength, <span class="keywordtype">double</span> );
<a name="l00086"></a>00086 <a class="code" href="itkMacro_8h.html#7ebdd33cc5e7d74720ced9099c034faa">itkSetMacro</a>( RelaxationFactor, <span class="keywordtype">double</span> );
<a name="l00087"></a>00087 <a class="code" href="itkMacro_8h.html#7ebdd33cc5e7d74720ced9099c034faa">itkSetMacro</a>( NumberOfIterations, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> );
<a name="l00088"></a>00088 <a class="code" href="itkMacro_8h.html#7ebdd33cc5e7d74720ced9099c034faa">itkSetMacro</a>( GradientMagnitudeTolerance, <span class="keywordtype">double</span> );
<a name="l00089"></a>00089 <a class="code" href="itkMacro_8h.html#7d989c13a1a213168db99ae0f84185d4">itkGetConstReferenceMacro</a>( CurrentStepLength, <span class="keywordtype">double</span>);
<a name="l00090"></a>00090 <a class="code" href="itkMacro_8h.html#7d989c13a1a213168db99ae0f84185d4">itkGetConstReferenceMacro</a>( MaximumStepLength, <span class="keywordtype">double</span> );
<a name="l00091"></a>00091 <a class="code" href="itkMacro_8h.html#7d989c13a1a213168db99ae0f84185d4">itkGetConstReferenceMacro</a>( MinimumStepLength, <span class="keywordtype">double</span> );
<a name="l00092"></a>00092 <a class="code" href="itkMacro_8h.html#7d989c13a1a213168db99ae0f84185d4">itkGetConstReferenceMacro</a>( RelaxationFactor, <span class="keywordtype">double</span> );
<a name="l00093"></a>00093 <a class="code" href="itkMacro_8h.html#7d989c13a1a213168db99ae0f84185d4">itkGetConstReferenceMacro</a>( NumberOfIterations, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> );
<a name="l00094"></a>00094 <a class="code" href="itkMacro_8h.html#7d989c13a1a213168db99ae0f84185d4">itkGetConstReferenceMacro</a>( GradientMagnitudeTolerance, <span class="keywordtype">double</span> );
<a name="l00095"></a>00095 <a class="code" href="itkMacro_8h.html#89294335d94b115d40e2603f2fff7950">itkGetConstMacro</a>( CurrentIteration, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> );
<a name="l00096"></a>00096 <a class="code" href="itkMacro_8h.html#7d989c13a1a213168db99ae0f84185d4">itkGetConstReferenceMacro</a>( StopCondition, StopConditionType );
<a name="l00097"></a>00097 <a class="code" href="itkMacro_8h.html#7d989c13a1a213168db99ae0f84185d4">itkGetConstReferenceMacro</a>( Value, MeasureType );
<a name="l00098"></a>00098 <a class="code" href="itkMacro_8h.html#7d989c13a1a213168db99ae0f84185d4">itkGetConstReferenceMacro</a>( Gradient, DerivativeType );
<a name="l00100"></a>00100
<a name="l00101"></a>00101
<a name="l00102"></a>00102 <span class="keyword">protected</span>:
<a name="l00103"></a>00103 <a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html" title="Implement a gradient descent optimizer.">RegularStepGradientDescentBaseOptimizer</a>();
<a name="l00104"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#f21f318a95b9948e037a19f76008a78b">00104</a> <span class="keyword">virtual</span> <a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#f21f318a95b9948e037a19f76008a78b">~RegularStepGradientDescentBaseOptimizer</a>() {};
<a name="l00105"></a>00105 <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="l00106"></a>00106
<a name="l00110"></a>00110 <span class="keyword">virtual</span> <span class="keywordtype">void</span> AdvanceOneStep( <span class="keywordtype">void</span> );
<a name="l00111"></a>00111
<a name="l00117"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#81238f1c1b4444d41b49098a0ced83e8">00117</a> <span class="keyword">virtual</span> <span class="keywordtype">void</span> StepAlongGradient(
<a name="l00118"></a>00118 <span class="keywordtype">double</span>,
<a name="l00119"></a>00119 <span class="keyword">const</span> DerivativeType&)
<a name="l00120"></a>00120 {
<a name="l00121"></a>00121 ExceptionObject ex;
<a name="l00122"></a>00122 ex.SetLocation(__FILE__);
<a name="l00123"></a>00123 ex.SetDescription(<span class="stringliteral">"This method MUST be overloaded in derived classes"</span>);
<a name="l00124"></a>00124 <span class="keywordflow">throw</span> ex;
<a name="l00125"></a>00125 }
<a name="l00127"></a>00127
<a name="l00128"></a>00128 <span class="keyword">private</span>:
<a name="l00129"></a>00129 <a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html" title="Implement a gradient descent optimizer.">RegularStepGradientDescentBaseOptimizer</a>(<span class="keyword">const</span> <a class="code" href="namespaceHardConnectedComponentImageFilter.html#ac7d0120fe5292cdcdddb6163b8cb150">Self</a>&); <span class="comment">//purposely not implemented</span>
<a name="l00130"></a>00130 <span class="keywordtype">void</span> operator=(<span class="keyword">const</span> <a class="code" href="namespaceHardConnectedComponentImageFilter.html#ac7d0120fe5292cdcdddb6163b8cb150">Self</a>&);<span class="comment">//purposely not implemented</span>
<a name="l00131"></a>00131
<a name="l00132"></a>00132 <span class="keyword">protected</span>:
<a name="l00133"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#9869ea11e0bf0d33ccad9bbd606c27d5">00133</a> DerivativeType m_Gradient;
<a name="l00134"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#b68c4cb29c41e1c79bca0988da2d65a5">00134</a> DerivativeType m_PreviousGradient;
<a name="l00135"></a>00135
<a name="l00136"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#ff974d45a57eff0d4d2d677939da87b2">00136</a> <span class="keywordtype">bool</span> m_Stop;
<a name="l00137"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#a924da26a85e9dea755eed99f3d4ed20">00137</a> <span class="keywordtype">bool</span> m_Maximize;
<a name="l00138"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#d645c7b02d11ed7c570d695b7c9453e8">00138</a> MeasureType m_Value;
<a name="l00139"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#58006381459d7193fc40314d27fa1939">00139</a> <span class="keywordtype">double</span> m_GradientMagnitudeTolerance;
<a name="l00140"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#81f9ff6e6fdb66f376c3f9622ca57484">00140</a> <span class="keywordtype">double</span> m_MaximumStepLength;
<a name="l00141"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#f816721eb10c1ce7cc12cf5286b557b5">00141</a> <span class="keywordtype">double</span> m_MinimumStepLength;
<a name="l00142"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#dab91791a84f728226099d8d521b4b82">00142</a> <span class="keywordtype">double</span> m_CurrentStepLength;
<a name="l00143"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#d6e1ac89e6cded78c55f84f6ff259330">00143</a> <span class="keywordtype">double</span> m_RelaxationFactor;
<a name="l00144"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#d3a2e02b46ce18e0d844b2dcd4cda539">00144</a> <a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#1fb01a1f68dfec24f3b7b12bc25fd91f">StopConditionType</a> m_StopCondition;
<a name="l00145"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#1e656fb091e405049c009debca92d997">00145</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> m_NumberOfIterations;
<a name="l00146"></a><a class="code" href="classitk_1_1RegularStepGradientDescentBaseOptimizer.html#2f97827cdaae10faa3db1719b3b72790">00146</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> m_CurrentIteration;
<a name="l00147"></a>00147
<a name="l00148"></a>00148
<a name="l00149"></a>00149 };
<a name="l00150"></a>00150
<a name="l00151"></a>00151 } <span class="comment">// end namespace itk</span>
<a name="l00152"></a>00152
<a name="l00153"></a>00153 <span class="preprocessor">#endif</span>
<a name="l00154"></a>00154 <span class="preprocessor"></span>
</pre></div></div>
<hr><address><small>
Generated at Fri May 8 00:04: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
>
17123
