Sophie

Sophie

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

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::NthElementPixelAccessor&lt; T, TContainer &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_1NthElementPixelAccessor.html">NthElementPixelAccessor</a>
  </div>
<div class="contents">
<h1>itk::NthElementPixelAccessor&lt; T, TContainer &gt; Class Template Reference<br>
<small>
[<a class="el" href="group__ImageAdaptors.html">Image Adaptors</a>]</small>
</h1><!-- doxytag: class="itk::NthElementPixelAccessor" -->Give access to the N-th of a Container type.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="itkNthElementPixelAccessor_8h_source.html">itkNthElementPixelAccessor.h</a>&gt;</code>
<p>

<p>
<a href="classitk_1_1NthElementPixelAccessor-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 T&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1NthElementPixelAccessor.html#2826be4e370f70229773faec40422b0f">ExternalType</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef TContainer&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1NthElementPixelAccessor.html#f93ecc61bb6742fd936204dd66bc4c75">InternalType</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classitk_1_1NthElementPixelAccessor.html">NthElementPixelAccessor</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1NthElementPixelAccessor.html#ca5424ec717e80ff964ef088a0a1002c">Self</a></td></tr>

<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classitk_1_1NthElementPixelAccessor.html#2826be4e370f70229773faec40422b0f">ExternalType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1NthElementPixelAccessor.html#938536c5f9d857671d60ee1551e384e1">Get</a> (const <a class="el" href="classitk_1_1NthElementPixelAccessor.html#f93ecc61bb6742fd936204dd66bc4c75">InternalType</a> &amp;input) 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_1NthElementPixelAccessor.html#91552fbd874b388e45067536267c33bf">GetElementNumber</a> (void) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1NthElementPixelAccessor.html#0ae2daeed3a3a20c0e7d248d766258e0">NthElementPixelAccessor</a> ()</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_1NthElementPixelAccessor.html#8c371a9acc4536a183be5328921a9606">operator!=</a> (const <a class="el" href="classitk_1_1NthElementPixelAccessor.html">Self</a> &amp;accessor) const </td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classitk_1_1NthElementPixelAccessor.html">NthElementPixelAccessor</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1NthElementPixelAccessor.html#aab0ec9edb127033a44a44d3f49a5da7">operator=</a> (const <a class="el" href="classitk_1_1NthElementPixelAccessor.html">NthElementPixelAccessor</a> &amp;accessor)</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_1NthElementPixelAccessor.html#cc504531d9484646f151e835bebcfb22">Set</a> (<a class="el" href="classitk_1_1NthElementPixelAccessor.html#f93ecc61bb6742fd936204dd66bc4c75">InternalType</a> &amp;output, const <a class="el" href="classitk_1_1NthElementPixelAccessor.html#2826be4e370f70229773faec40422b0f">ExternalType</a> &amp;input) 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_1NthElementPixelAccessor.html#c049a77e95d06800bd2b874499105baa">SetElementNumber</a> (unsigned int nth)</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class T, class TContainer&gt;<br>
 class itk::NthElementPixelAccessor&lt; T, TContainer &gt;</h3>

Give access to the N-th of a Container type. 
<p>
This class is intended to be used as parameter of an <a class="el" href="classitk_1_1ImageAdaptor.html" title="Give access to partial aspects of voxels from an Image.">ImageAdaptor</a> to make a Container appears as being of scalar type T, showing only the N-th component.<p>
This class is templated over the container type. Any container type that provides a method: operator[]( unsigned int ) can be used here, for example: itkPoint, itkVector, itkVectorContainer, and <a class="el" href="classstd_1_1vector.html">std::vector</a>.<p>
For performance, no bound checking is performed during access to the n-th element.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classitk_1_1ImageAdaptor.html" title="Give access to partial aspects of voxels from an Image.">ImageAdaptor</a> <p>
<a class="el" href="classitk_1_1PixelAccessor.html" title="Give access to partial aspects of a type.">PixelAccessor</a> </dd></dl>

<p>Definition at line <a class="el" href="itkNthElementPixelAccessor_8h_source.html#l00048">48</a> of file <a class="el" href="itkNthElementPixelAccessor_8h_source.html">itkNthElementPixelAccessor.h</a>.</p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="2826be4e370f70229773faec40422b0f"></a><!-- doxytag: member="itk::NthElementPixelAccessor::ExternalType" ref="2826be4e370f70229773faec40422b0f" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class TContainer &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef T <a class="el" href="classitk_1_1NthElementPixelAccessor.html">itk::NthElementPixelAccessor</a>&lt; T, TContainer &gt;::<a class="el" href="classitk_1_1NthElementPixelAccessor.html#2826be4e370f70229773faec40422b0f">ExternalType</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
that this class will exhibit 
<p>Definition at line <a class="el" href="itkNthElementPixelAccessor_8h_source.html#l00055">55</a> of file <a class="el" href="itkNthElementPixelAccessor_8h_source.html">itkNthElementPixelAccessor.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="f93ecc61bb6742fd936204dd66bc4c75"></a><!-- doxytag: member="itk::NthElementPixelAccessor::InternalType" ref="f93ecc61bb6742fd936204dd66bc4c75" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class TContainer &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef TContainer <a class="el" href="classitk_1_1NthElementPixelAccessor.html">itk::NthElementPixelAccessor</a>&lt; T, TContainer &gt;::<a class="el" href="classitk_1_1NthElementPixelAccessor.html#f93ecc61bb6742fd936204dd66bc4c75">InternalType</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Internal typedef. It defines the internal real representation of data 
<p>Definition at line <a class="el" href="itkNthElementPixelAccessor_8h_source.html#l00059">59</a> of file <a class="el" href="itkNthElementPixelAccessor_8h_source.html">itkNthElementPixelAccessor.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="ca5424ec717e80ff964ef088a0a1002c"></a><!-- doxytag: member="itk::NthElementPixelAccessor::Self" ref="ca5424ec717e80ff964ef088a0a1002c" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class TContainer &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">typedef <a class="el" href="classitk_1_1NthElementPixelAccessor.html">NthElementPixelAccessor</a> <a class="el" href="classitk_1_1NthElementPixelAccessor.html">itk::NthElementPixelAccessor</a>&lt; T, TContainer &gt;::<a class="el" href="classitk_1_1NthElementPixelAccessor.html">Self</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Standard class typedefs. 
<p>Definition at line <a class="el" href="itkNthElementPixelAccessor_8h_source.html#l00052">52</a> of file <a class="el" href="itkNthElementPixelAccessor_8h_source.html">itkNthElementPixelAccessor.h</a>.</p>

</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="0ae2daeed3a3a20c0e7d248d766258e0"></a><!-- doxytag: member="itk::NthElementPixelAccessor::NthElementPixelAccessor" ref="0ae2daeed3a3a20c0e7d248d766258e0" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class TContainer &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classitk_1_1NthElementPixelAccessor.html">itk::NthElementPixelAccessor</a>&lt; T, TContainer &gt;::<a class="el" href="classitk_1_1NthElementPixelAccessor.html">NthElementPixelAccessor</a>           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Constructor 
<p>Definition at line <a class="el" href="itkNthElementPixelAccessor_8h_source.html#l00092">92</a> of file <a class="el" href="itkNthElementPixelAccessor_8h_source.html">itkNthElementPixelAccessor.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="938536c5f9d857671d60ee1551e384e1"></a><!-- doxytag: member="itk::NthElementPixelAccessor::Get" ref="938536c5f9d857671d60ee1551e384e1" args="(const InternalType &amp;input) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class TContainer &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classitk_1_1NthElementPixelAccessor.html#2826be4e370f70229773faec40422b0f">ExternalType</a> <a class="el" href="classitk_1_1NthElementPixelAccessor.html">itk::NthElementPixelAccessor</a>&lt; T, TContainer &gt;::Get           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classitk_1_1NthElementPixelAccessor.html#f93ecc61bb6742fd936204dd66bc4c75">InternalType</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>input</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Read access to the NthElement component 
<p>Definition at line <a class="el" href="itkNthElementPixelAccessor_8h_source.html#l00066">66</a> of file <a class="el" href="itkNthElementPixelAccessor_8h_source.html">itkNthElementPixelAccessor.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="91552fbd874b388e45067536267c33bf"></a><!-- doxytag: member="itk::NthElementPixelAccessor::GetElementNumber" ref="91552fbd874b388e45067536267c33bf" args="(void) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class TContainer &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">unsigned int <a class="el" href="classitk_1_1NthElementPixelAccessor.html">itk::NthElementPixelAccessor</a>&lt; T, TContainer &gt;::GetElementNumber           </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 the element number to access in the container 
<p>Definition at line <a class="el" href="itkNthElementPixelAccessor_8h_source.html#l00070">70</a> of file <a class="el" href="itkNthElementPixelAccessor_8h_source.html">itkNthElementPixelAccessor.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="8c371a9acc4536a183be5328921a9606"></a><!-- doxytag: member="itk::NthElementPixelAccessor::operator!=" ref="8c371a9acc4536a183be5328921a9606" args="(const Self &amp;accessor) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class TContainer &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classitk_1_1NthElementPixelAccessor.html">itk::NthElementPixelAccessor</a>&lt; T, TContainer &gt;::operator!=           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classitk_1_1NthElementPixelAccessor.html">Self</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>accessor</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
operator!=. This is needed to convert a pixel accessor to a functor. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classitk_1_1AdaptImageFilter.html" title="Convert an image to another pixel type using the specified data accessor.">AdaptImageFilter</a> </dd></dl>

<p>Definition at line <a class="el" href="itkNthElementPixelAccessor_8h_source.html#l00079">79</a> of file <a class="el" href="itkNthElementPixelAccessor_8h_source.html">itkNthElementPixelAccessor.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="aab0ec9edb127033a44a44d3f49a5da7"></a><!-- doxytag: member="itk::NthElementPixelAccessor::operator=" ref="aab0ec9edb127033a44a44d3f49a5da7" args="(const NthElementPixelAccessor &amp;accessor)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class TContainer &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classitk_1_1NthElementPixelAccessor.html">NthElementPixelAccessor</a>&amp; <a class="el" href="classitk_1_1NthElementPixelAccessor.html">itk::NthElementPixelAccessor</a>&lt; T, TContainer &gt;::operator=           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classitk_1_1NthElementPixelAccessor.html">NthElementPixelAccessor</a>&lt; T, TContainer &gt; &amp;&nbsp;</td>
          <td class="paramname"> <em>accessor</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Assignment operator 
<p>Definition at line <a class="el" href="itkNthElementPixelAccessor_8h_source.html#l00085">85</a> of file <a class="el" href="itkNthElementPixelAccessor_8h_source.html">itkNthElementPixelAccessor.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="cc504531d9484646f151e835bebcfb22"></a><!-- doxytag: member="itk::NthElementPixelAccessor::Set" ref="cc504531d9484646f151e835bebcfb22" args="(InternalType &amp;output, const ExternalType &amp;input) const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class TContainer &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classitk_1_1NthElementPixelAccessor.html">itk::NthElementPixelAccessor</a>&lt; T, TContainer &gt;::Set           </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classitk_1_1NthElementPixelAccessor.html#f93ecc61bb6742fd936204dd66bc4c75">InternalType</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>output</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="classitk_1_1NthElementPixelAccessor.html#2826be4e370f70229773faec40422b0f">ExternalType</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>input</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Write access to the NthElement component 
<p>Definition at line <a class="el" href="itkNthElementPixelAccessor_8h_source.html#l00062">62</a> of file <a class="el" href="itkNthElementPixelAccessor_8h_source.html">itkNthElementPixelAccessor.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="c049a77e95d06800bd2b874499105baa"></a><!-- doxytag: member="itk::NthElementPixelAccessor::SetElementNumber" ref="c049a77e95d06800bd2b874499105baa" args="(unsigned int nth)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class T , class TContainer &gt; </div>
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classitk_1_1NthElementPixelAccessor.html">itk::NthElementPixelAccessor</a>&lt; T, TContainer &gt;::SetElementNumber           </td>
          <td>(</td>
          <td class="paramtype">unsigned int&nbsp;</td>
          <td class="paramname"> <em>nth</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set the element number to access in the container 
<p>Definition at line <a class="el" href="itkNthElementPixelAccessor_8h_source.html#l00074">74</a> of file <a class="el" href="itkNthElementPixelAccessor_8h_source.html">itkNthElementPixelAccessor.h</a>.</p>

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