Sophie

Sophie

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

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::ImageToImageFilterDetail::ImageRegionCopier&lt; D1, D2 &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="namespaceitk_1_1ImageToImageFilterDetail.html">ImageToImageFilterDetail</a>::<a class="el" href="classitk_1_1ImageToImageFilterDetail_1_1ImageRegionCopier.html">ImageRegionCopier</a>
  </div>
<div class="contents">
<h1>itk::ImageToImageFilterDetail::ImageRegionCopier&lt; D1, D2 &gt; Class Template Reference</h1><!-- doxytag: class="itk::ImageToImageFilterDetail::ImageRegionCopier" --><a class="el" href="namespaceitk_1_1Function.html">Function</a> object used to dispatching to a routine to copy a region (start index and size).  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="itkImageToImageFilterDetail_8h_source.html">itkImageToImageFilterDetail.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for itk::ImageToImageFilterDetail::ImageRegionCopier&lt; D1, D2 &gt;:</div>
<div class="dynsection">
<p><center><img src="classitk_1_1ImageToImageFilterDetail_1_1ImageRegionCopier__inherit__graph.png" border="0" usemap="#itk_1_1ImageToImageFilterDetail_1_1ImageRegionCopier_3_01D1_00_01D2_01_4__inherit__map" alt="Inheritance graph"></center>
<map name="itk_1_1ImageToImageFilterDetail_1_1ImageRegionCopier_3_01D1_00_01D2_01_4__inherit__map">
<area shape="rect" id="node3" href="classitk_1_1ImageToImageFilterDetail_1_1ImageRegionCopier.html" title="itk::ImageToImageFilterDetail::ImageRegionCopier\&lt; T1, T2 \&gt;" alt="" coords="48,101,480,131"><area shape="rect" id="node5" href="classitk_1_1ImageToImageFilterDetail_1_1ExtractImageFilterRegionCopier.html" title="itk::ImageToImageFilterDetail::ExtractImageFilterRegionCopier\&lt; T1, T2 \&gt;" alt="" coords="5,181,523,211"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>

<p>
<a href="classitk_1_1ImageToImageFilterDetail_1_1ImageRegionCopier-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 Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ImageToImageFilterDetail_1_1ImageRegionCopier.html#3f9cb920019baa97aa1b6ab3727afe38">operator()</a> (<a class="el" href="classitk_1_1ImageRegion.html">ImageRegion</a>&lt; D1 &gt; &amp;destRegion, const <a class="el" href="classitk_1_1ImageRegion.html">ImageRegion</a>&lt; D2 &gt; &amp;srcRegion) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ImageToImageFilterDetail_1_1ImageRegionCopier.html#9fcdf2e2885426a45aa922a0656d7c2d">~ImageRegionCopier</a> ()</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;unsigned int D1, unsigned int D2&gt;<br>
 class itk::ImageToImageFilterDetail::ImageRegionCopier&lt; D1, D2 &gt;</h3>

<a class="el" href="namespaceitk_1_1Function.html">Function</a> object used to dispatching to a routine to copy a region (start index and size). 
<p>
<a class="el" href="namespaceitk_1_1Function.html">Function</a> object used for dispatching to various routines to copy a region (start index and size). Most filters use this function object as trivial copy because they require the input image dimension to match the output image dimension. However, some filters like <a class="el" href="classitk_1_1ExtractImageFilter.html" title="Decrease the image size by cropping the image to the selected region bounds.">itk::ExtractImageFilter</a> can support output images of a lower dimension that the input.<p>
This function object is used by the default implementation of <a class="el" href="classitk_1_1ImageToImageFilter.html#a47855988c32d1a292472e3d1ae83af7">ImageToImageFilter::GenerateInputRequestedRegion()</a>. It can also be used in routines like <a class="el" href="classitk_1_1ImageSource.html#22b6fe52a1bcf2b21b4cb089a9563846">ImageSource::ThreadedGenerateData()</a> where a filter may need to map the the output region for a particular thread to an input region.<p>
This copier uses a "dispatch pattern" to call one of three overloaded functions depending on whether the source and destination dimensions are the same, the source is of a higher dimension than the destination, or the source is of a lower dimension than the destination. The use of an overloaded function is required for proper compilation of the various cases.<p>
For the latter two cases, trivial implementations are used. If the source dimension is a lower dimension than the destination, the output region information is copied into the first portion of the destination region and the rest of the input region is set to zero. If the source region is a higher dimension than the destination, the first portion of the source region is copied to the destination region.<p>
If a filter needs a different behavior is will need to override the CallCopyOutputRegionToInputRegion() method or the CallCopyInputRegionToOutputRegion() method and delegate to the appropriate RegionCopier class. 
<p>Definition at line <a class="el" href="itkImageToImageFilterDetail_8h_source.html#l00316">316</a> of file <a class="el" href="itkImageToImageFilterDetail_8h_source.html">itkImageToImageFilterDetail.h</a>.</p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="9fcdf2e2885426a45aa922a0656d7c2d"></a><!-- doxytag: member="itk::ImageToImageFilterDetail::ImageRegionCopier::~ImageRegionCopier" ref="9fcdf2e2885426a45aa922a0656d7c2d" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;unsigned int D1, unsigned int D2&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">virtual <a class="el" href="classitk_1_1ImageToImageFilterDetail_1_1ImageRegionCopier.html">itk::ImageToImageFilterDetail::ImageRegionCopier</a>&lt; D1, D2 &gt;::~<a class="el" href="classitk_1_1ImageToImageFilterDetail_1_1ImageRegionCopier.html">ImageRegionCopier</a>           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="itkImageToImageFilterDetail_8h_source.html#l00327">327</a> of file <a class="el" href="itkImageToImageFilterDetail_8h_source.html">itkImageToImageFilterDetail.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="3f9cb920019baa97aa1b6ab3727afe38"></a><!-- doxytag: member="itk::ImageToImageFilterDetail::ImageRegionCopier::operator()" ref="3f9cb920019baa97aa1b6ab3727afe38" args="(ImageRegion&lt; D1 &gt; &amp;destRegion, const ImageRegion&lt; D2 &gt; &amp;srcRegion) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;unsigned int D1, unsigned int D2&gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">virtual void <a class="el" href="classitk_1_1ImageToImageFilterDetail_1_1ImageRegionCopier.html">itk::ImageToImageFilterDetail::ImageRegionCopier</a>&lt; D1, D2 &gt;::operator()           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classitk_1_1ImageRegion.html">ImageRegion</a>&lt; D1 &gt; &amp;&nbsp;</td>
          <td class="paramname"> <em>destRegion</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classitk_1_1ImageRegion.html">ImageRegion</a>&lt; D2 &gt; &amp;&nbsp;</td>
          <td class="paramname"> <em>srcRegion</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const<code> [inline, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="itkImageToImageFilterDetail_8h_source.html#l00319">319</a> of file <a class="el" href="itkImageToImageFilterDetail_8h_source.html">itkImageToImageFilterDetail.h</a>.</p>

</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="itkImageToImageFilterDetail_8h_source.html">itkImageToImageFilterDetail.h</a></ul>
</div>
<hr><address><small>
Generated at Fri May 8 08:53:44 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>