Sophie

Sophie

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

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: itkFiniteDifferenceFunction.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>&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="dir_02e23d841c198393a6e961e9a0678fff.html">Code</a>&nbsp;&raquo&nbsp;<a class="el" href="dir_ea7fc529ede9a38b0438cf13831ae873.html">Common</a>
  </div>
<div class="contents">
<h1>itkFiniteDifferenceFunction.h</h1><a href="itkFiniteDifferenceFunction_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 &amp; Registration Toolkit</span>
<a name="l00004"></a>00004 <span class="comment">  Module:    $RCSfile: itkFiniteDifferenceFunction.h,v $</span>
<a name="l00005"></a>00005 <span class="comment">  Language:  C++</span>
<a name="l00006"></a>00006 <span class="comment">  Date:      $Date: 2008-10-16 23:25:41 $</span>
<a name="l00007"></a>00007 <span class="comment">  Version:   $Revision: 1.21 $</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 __itkFiniteDifferenceFunction_h</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define __itkFiniteDifferenceFunction_h</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include "<a class="code" href="itkLightObject_8h.html">itkLightObject.h</a>"</span>
<a name="l00021"></a>00021 <span class="preprocessor">#include "<a class="code" href="itkConstNeighborhoodIterator_8h.html">itkConstNeighborhoodIterator.h</a>"</span>
<a name="l00022"></a>00022 <span class="preprocessor">#include "<a class="code" href="itkZeroFluxNeumannBoundaryCondition_8h.html">itkZeroFluxNeumannBoundaryCondition.h</a>"</span>
<a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="itkVector_8h.html">itkVector.h</a>"</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include "<a class="code" href="itkFixedArray_8h.html">itkFixedArray.h</a>"</span>
<a name="l00025"></a>00025 
<a name="l00026"></a>00026 <span class="keyword">namespace </span>itk {
<a name="l00027"></a>00027 
<a name="l00064"></a>00064 <span class="keyword">template</span>&lt;<span class="keyword">class</span> TImageType&gt;
<a name="l00065"></a><a class="code" href="classitk_1_1FiniteDifferenceFunction.html">00065</a> <span class="keyword">class </span><a class="code" href="itkWin32Header_8h.html#7d4384322557205d75f0719c012dded6">ITK_EXPORT</a> <a class="code" href="classitk_1_1FiniteDifferenceFunction.html">FiniteDifferenceFunction</a> : <span class="keyword">public</span> <a class="code" href="classitk_1_1LightObject.html" title="Light weight base class for most itk classes.">LightObject</a>
<a name="l00066"></a>00066 {
<a name="l00067"></a>00067 <span class="keyword">public</span>:
<a name="l00068"></a>00068 
<a name="l00070"></a><a class="code" href="classitk_1_1FiniteDifferenceFunction.html#2c2d493f03dff441d7de7396dfed64a5">00070</a>   <span class="keyword">typedef</span> <a class="code" href="classitk_1_1FiniteDifferenceFunction.html">FiniteDifferenceFunction</a>      <a class="code" href="classitk_1_1LightObject.html" title="Light weight base class for most itk classes.">Self</a>;
<a name="l00071"></a><a class="code" href="classitk_1_1FiniteDifferenceFunction.html#7f4fa33872c0c52ebefd8628f80777d8">00071</a>   <span class="keyword">typedef</span> <a class="code" href="classitk_1_1LightObject.html" title="Light weight base class for most itk classes.">LightObject</a>                   <a class="code" href="classitk_1_1LightObject.html" title="Light weight base class for most itk classes.">Superclass</a>;
<a name="l00072"></a><a class="code" href="classitk_1_1FiniteDifferenceFunction.html#91875644ba8522b58858cf8d46af16c5">00072</a>   <span class="keyword">typedef</span> <a class="code" href="classitk_1_1SmartPointer.html">SmartPointer&lt;Self&gt;</a>            <a class="code" href="classitk_1_1SmartPointer.html">Pointer</a>;
<a name="l00073"></a><a class="code" href="classitk_1_1FiniteDifferenceFunction.html#dca95e891d4ad395e463614496eca802">00073</a>   <span class="keyword">typedef</span> <a class="code" href="classitk_1_1SmartPointer.html">SmartPointer&lt;const Self&gt;</a>      <a class="code" href="classitk_1_1SmartPointer.html">ConstPointer</a>;
<a name="l00074"></a>00074 
<a name="l00076"></a><a class="code" href="classitk_1_1FiniteDifferenceFunction.html#a33e177ed78b168d285528f156c71390">00076</a>   <a class="code" href="itkMacro_8h.html#574c1f86661d409dd32c742307a0e96a">itkTypeMacro</a>( <a class="code" href="classitk_1_1FiniteDifferenceFunction.html">FiniteDifferenceFunction</a>, <a class="code" href="classitk_1_1LightObject.html" title="Light weight base class for most itk classes.">LightObject</a> );
<a name="l00077"></a>00077 
<a name="l00079"></a>00079   <span class="keyword">typedef</span> TImageType                        ImageType;
<a name="l00080"></a><a class="code" href="classitk_1_1FiniteDifferenceFunction.html#23137c03a3133c0bdd1f0b7f355ec44e">00080</a>   <span class="keyword">typedef</span> <span class="keyword">typename</span> ImageType::PixelType     PixelType;
<a name="l00081"></a><a class="code" href="classitk_1_1FiniteDifferenceFunction.html#92cc9eec22ef4274ed733797cea05d23">00081</a>   <span class="keyword">typedef</span> <span class="keywordtype">double</span>                            PixelRealType;  
<a name="l00082"></a>00082 
<a name="l00084"></a>00084   <a class="code" href="itkMacro_8h.html#1905cf6b2e88235996fa7ff73b2fb0eb">itkStaticConstMacro</a>(ImageDimension, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>, ImageType::ImageDimension);
<a name="l00085"></a>00085 
<a name="l00087"></a><a class="code" href="classitk_1_1FiniteDifferenceFunction.html#c1478c53f70caab08cbe2a77be31e9f4">00087</a>   <span class="keyword">typedef</span> <span class="keywordtype">double</span>  TimeStepType;
<a name="l00088"></a>00088 
<a name="l00091"></a>00091   <span class="keyword">typedef</span> <a class="code" href="classitk_1_1ZeroFluxNeumannBoundaryCondition.html">ZeroFluxNeumannBoundaryCondition&lt;ImageType&gt;</a>
<a name="l00092"></a><a class="code" href="classitk_1_1FiniteDifferenceFunction.html#3ece1df11a1ceb6c8aa494a49688f3b1">00092</a>     <a class="code" href="classitk_1_1ZeroFluxNeumannBoundaryCondition.html">DefaultBoundaryConditionType</a>;
<a name="l00093"></a>00093 
<a name="l00095"></a><a class="code" href="classitk_1_1FiniteDifferenceFunction.html#856791a253185b8e83e418fbd01d5bc5">00095</a>   <span class="keyword">typedef</span> <span class="keyword">typename</span> <a class="code" href="classitk_1_1ConstNeighborhoodIterator.html" title="Const version of NeighborhoodIterator, defining iteration of a local N-dimensional...">ConstNeighborhoodIterator&lt;TImageType&gt;::RadiusType</a> RadiusType;
<a name="l00096"></a>00096 
<a name="l00099"></a><a class="code" href="classitk_1_1FiniteDifferenceFunction.html#3b35562a5f7a10c15ed3941cc1c99d7d">00099</a>   <span class="keyword">typedef</span> <a class="code" href="classitk_1_1ConstNeighborhoodIterator.html" title="Const version of NeighborhoodIterator, defining iteration of a local N-dimensional...">ConstNeighborhoodIterator&lt;TImageType, DefaultBoundaryConditionType&gt;</a> <a class="code" href="classitk_1_1ConstNeighborhoodIterator.html" title="Const version of NeighborhoodIterator, defining iteration of a local N-dimensional...">NeighborhoodType</a>;
<a name="l00100"></a>00100 
<a name="l00103"></a><a class="code" href="classitk_1_1FiniteDifferenceFunction.html#2f997fb5612e8dfc316b943c74ff1a9b">00103</a>   <span class="keyword">typedef</span> <a class="code" href="classitk_1_1Vector.html" title="A templated class holding a n-Dimensional vector.">Vector&lt;PixelRealType,itkGetStaticConstMacro(ImageDimension)&gt;</a> <a class="code" href="classitk_1_1Vector.html" title="A templated class holding a n-Dimensional vector.">NeighborhoodScalesType</a>;
<a name="l00104"></a>00104 
<a name="l00107"></a><a class="code" href="classitk_1_1FiniteDifferenceFunction.html#afae46d293b083461df49756541a8c5d">00107</a>   <span class="keyword">typedef</span> <a class="code" href="classitk_1_1Vector.html" title="A templated class holding a n-Dimensional vector.">Vector&lt;float,itkGetStaticConstMacro(ImageDimension)&gt;</a> <a class="code" href="classitk_1_1Vector.html" title="A templated class holding a n-Dimensional vector.">FloatOffsetType</a>;
<a name="l00108"></a>00108 
<a name="l00118"></a><a class="code" href="classitk_1_1FiniteDifferenceFunction.html#39d115258aa25c48eb94755278cc102d">00118</a>   <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classitk_1_1FiniteDifferenceFunction.html#39d115258aa25c48eb94755278cc102d">InitializeIteration</a>() {};
<a name="l00119"></a>00119 
<a name="l00133"></a>00133 <span class="preprocessor">#if !defined(CABLE_CONFIGURATION)</span>
<a name="l00134"></a>00134 <span class="preprocessor"></span>  <span class="keyword">virtual</span> PixelType  ComputeUpdate(<span class="keyword">const</span> NeighborhoodType &amp;neighborhood,
<a name="l00135"></a>00135                                    <span class="keywordtype">void</span> *globalData,
<a name="l00136"></a>00136                                    <span class="keyword">const</span> FloatOffsetType &amp;offset = FloatOffsetType(0.0)) = 0;
<a name="l00137"></a>00137 <span class="preprocessor">#endif</span>
<a name="l00138"></a>00138 <span class="preprocessor"></span>
<a name="l00141"></a><a class="code" href="classitk_1_1FiniteDifferenceFunction.html#c6270abe35801abdbc7356b907341694">00141</a>   <span class="keywordtype">void</span> SetRadius(<span class="keyword">const</span> RadiusType &amp;r)
<a name="l00142"></a>00142     { m_Radius = r; }
<a name="l00143"></a>00143 
<a name="l00146"></a><a class="code" href="classitk_1_1FiniteDifferenceFunction.html#fab4141e79e793063359ae1524c3c61f">00146</a>   <span class="keyword">const</span> RadiusType &amp;GetRadius()<span class="keyword"> const</span>
<a name="l00147"></a>00147 <span class="keyword">    </span>{ <span class="keywordflow">return</span> m_Radius; }
<a name="l00148"></a>00148 
<a name="l00152"></a><a class="code" href="classitk_1_1FiniteDifferenceFunction.html#b2a7dba8fecb640abec80ded52e64309">00152</a>   <span class="keywordtype">void</span> SetScaleCoefficients (PixelRealType vals[ImageDimension])
<a name="l00153"></a>00153     {
<a name="l00154"></a>00154     <span class="keywordflow">for</span>( <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i &lt; ImageDimension; i++ )
<a name="l00155"></a>00155       {
<a name="l00156"></a>00156       m_ScaleCoefficients[i] = vals[i];
<a name="l00157"></a>00157       }
<a name="l00158"></a>00158     }
<a name="l00160"></a>00160 
<a name="l00164"></a>00164   <span class="keyword">const</span> NeighborhoodScalesType ComputeNeighborhoodScales() <span class="keyword">const</span>;
<a name="l00165"></a>00165 
<a name="l00172"></a>00172   <span class="keyword">virtual</span> TimeStepType ComputeGlobalTimeStep(<span class="keywordtype">void</span> *GlobalData) <span class="keyword">const</span> =0;
<a name="l00173"></a>00173 
<a name="l00181"></a>00181   <span class="keyword">virtual</span> <span class="keywordtype">void</span> *GetGlobalDataPointer() <span class="keyword">const</span> =0;
<a name="l00182"></a>00182 
<a name="l00188"></a>00188   <span class="keyword">virtual</span> <span class="keywordtype">void</span> ReleaseGlobalDataPointer(<span class="keywordtype">void</span> *GlobalData) <span class="keyword">const</span> =0;
<a name="l00189"></a>00189 
<a name="l00190"></a>00190 <span class="keyword">protected</span>:
<a name="l00191"></a><a class="code" href="classitk_1_1FiniteDifferenceFunction.html#ea8160d3e392f98f853dd49c7398c737">00191</a>   <a class="code" href="classitk_1_1FiniteDifferenceFunction.html">FiniteDifferenceFunction</a>() 
<a name="l00192"></a>00192   {
<a name="l00193"></a>00193     <span class="comment">// initialize variables</span>
<a name="l00194"></a>00194     m_Radius.Fill( 0 );
<a name="l00195"></a>00195     <span class="keywordflow">for</span> (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i = 0; i &lt; ImageDimension; i++)
<a name="l00196"></a>00196       {
<a name="l00197"></a>00197       m_ScaleCoefficients[i] = 1.0;
<a name="l00198"></a>00198       }
<a name="l00199"></a>00199   }
<a name="l00200"></a><a class="code" href="classitk_1_1FiniteDifferenceFunction.html#777df6a24d3b102bad3b324cb576b4f2">00200</a>   <a class="code" href="classitk_1_1FiniteDifferenceFunction.html#777df6a24d3b102bad3b324cb576b4f2">~FiniteDifferenceFunction</a>() {}
<a name="l00201"></a>00201   <span class="keywordtype">void</span> <a class="code" href="namespaceHardConnectedComponentImageFilter.html#920ae03048a5ad715d803ca2e92b52de">PrintSelf</a>(std::ostream&amp; 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="l00202"></a>00202 
<a name="l00203"></a><a class="code" href="classitk_1_1FiniteDifferenceFunction.html#8fecdf00868fdac603d78887d1b0aed8">00203</a>   RadiusType m_Radius;
<a name="l00204"></a><a class="code" href="classitk_1_1FiniteDifferenceFunction.html#4a0beed7be3a8cf3dfb165b6dbc4d808">00204</a>   PixelRealType m_ScaleCoefficients[ImageDimension];
<a name="l00205"></a>00205 
<a name="l00206"></a>00206 <span class="keyword">private</span>:
<a name="l00207"></a>00207   <a class="code" href="classitk_1_1FiniteDifferenceFunction.html">FiniteDifferenceFunction</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>&amp;); <span class="comment">//purposely not implemented</span>
<a name="l00208"></a>00208   <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>&amp;); <span class="comment">//purposely not implemented</span>
<a name="l00209"></a>00209 };
<a name="l00210"></a>00210   
<a name="l00211"></a>00211 } <span class="comment">// end namespace itk</span>
<a name="l00212"></a>00212 
<a name="l00213"></a>00213 <span class="comment">// Define instantiation macro for this template.</span>
<a name="l00214"></a><a class="code" href="itkFiniteDifferenceFunction_8h.html#d750c8b02ad9f191600fa38c704237ed">00214</a> <span class="preprocessor">#define ITK_TEMPLATE_FiniteDifferenceFunction(_, EXPORT, x, y) namespace itk { \</span>
<a name="l00215"></a>00215 <span class="preprocessor">  _(1(class EXPORT FiniteDifferenceFunction&lt; ITK_TEMPLATE_1 x &gt;)) \</span>
<a name="l00216"></a>00216 <span class="preprocessor">  namespace Templates { typedef FiniteDifferenceFunction&lt; ITK_TEMPLATE_1 x &gt; FiniteDifferenceFunction##y; } \</span>
<a name="l00217"></a>00217 <span class="preprocessor">  }</span>
<a name="l00218"></a>00218 <span class="preprocessor"></span>
<a name="l00219"></a>00219 <span class="preprocessor">#if ITK_TEMPLATE_EXPLICIT</span>
<a name="l00220"></a>00220 <span class="preprocessor"></span><span class="preprocessor"># include "Templates/itkFiniteDifferenceFunction+-.h"</span>
<a name="l00221"></a>00221 <span class="preprocessor">#endif</span>
<a name="l00222"></a>00222 <span class="preprocessor"></span>
<a name="l00223"></a>00223 <span class="preprocessor">#if ITK_TEMPLATE_TXX</span>
<a name="l00224"></a>00224 <span class="preprocessor"></span><span class="preprocessor"># include "itkFiniteDifferenceFunction.txx"</span>
<a name="l00225"></a>00225 <span class="preprocessor">#endif</span>
<a name="l00226"></a>00226 <span class="preprocessor"></span>
<a name="l00227"></a>00227 <span class="preprocessor">#endif</span>
<a name="l00228"></a>00228 <span class="preprocessor"></span>
</pre></div></div>
<hr><address><small>
Generated at Thu May 7 22:43:26 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>