<!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::ScalarVector< TScalar, TVector, TVectorDimension > 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>
<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="namespaceitk.html">itk</a>::<a class="el" href="classitk_1_1ScalarVector.html">ScalarVector</a>
</div>
<div class="contents">
<h1>itk::ScalarVector< TScalar, TVector, TVectorDimension > Class Template Reference<br>
<small>
[<a class="el" href="group__DataRepresentation.html">Data Representation Objects</a>]</small>
</h1><!-- doxytag: class="itk::ScalarVector" --><a class="el" href="classA.html">A</a> templated class holding bot scalar and vector values and responding to the <a class="el" href="classitk_1_1ScalarVector.html#5246fd2da91b279be55d7ee5d87a86ef">GetScalar()</a> and <a class="el" href="classitk_1_1ScalarVector.html#2ba34ca44c1883fef70420ff2b5b2ac1">GetVector()</a> methods.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="itkScalarVector_8h_source.html">itkScalarVector.h</a>></code>
<p>
<p>
<a href="classitk_1_1ScalarVector-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 TScalar </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ScalarVector.html#3b8eee117e01d3e1f5914d22fcbc6abf">ScalarValueType</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="classitk_1_1ScalarVector.html">ScalarVector</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ScalarVector.html#27d60f18bf0d6ef851ea8513c324acda">Self</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef TScalar </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ScalarVector.html#da91c1999a359742e8686baf528b6566">ValueType</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef vnl_vector_fixed<br class="typebreak">
< TVector, TVectorDimension > </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ScalarVector.html#bf95cf6bf936f42cc0a9be6271a15ce3">VectorType</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef TVector </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ScalarVector.html#4aa7b9fdfbc48260554feb588c706bec">VectorValueType</a></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">TScalar </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ScalarVector.html#5246fd2da91b279be55d7ee5d87a86ef">GetScalar</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classitk_1_1ScalarVector.html#bf95cf6bf936f42cc0a9be6271a15ce3">VectorType</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ScalarVector.html#2ba34ca44c1883fef70420ff2b5b2ac1">GetVector</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const <a class="el" href="classitk_1_1ScalarVector.html#bf95cf6bf936f42cc0a9be6271a15ce3">VectorType</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ScalarVector.html#baeed87193527824e83b73f7299a3c1a">GetVector</a> () const </td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ScalarVector.html#927eb9b07d2c3482b587f50b0ecdab56">SetScalar</a> (const TScalar &val)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ScalarVector.html#d9030c900c60fb9bbd19b030e283d974">SetVector</a> (const <a class="el" href="classitk_1_1ScalarVector.html#bf95cf6bf936f42cc0a9be6271a15ce3">VectorType</a> &vec)</td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1ScalarVector.html#9ddb8feac117e0f585670c1f682760fa">GetVectorDimension</a> ()</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template<class TScalar, class TVector, unsigned int TVectorDimension = 3><br>
class itk::ScalarVector< TScalar, TVector, TVectorDimension ></h3>
<a class="el" href="classA.html">A</a> templated class holding bot scalar and vector values and responding to the <a class="el" href="classitk_1_1ScalarVector.html#5246fd2da91b279be55d7ee5d87a86ef">GetScalar()</a> and <a class="el" href="classitk_1_1ScalarVector.html#2ba34ca44c1883fef70420ff2b5b2ac1">GetVector()</a> methods.
<p>
<a class="el" href="classitk_1_1ScalarVector.html" title="A templated class holding bot scalar and vector values and responding to the GetScalar()...">ScalarVector</a> is a templated class that holds a scalar value plus an array of values (a vector). <a class="el" href="classitk_1_1ScalarVector.html" title="A templated class holding bot scalar and vector values and responding to the GetScalar()...">ScalarVector</a> can be used as the data type held at each pixel in an <a class="el" href="classitk_1_1Image.html" title="Templated n-dimensional image class.">Image</a> or at each vertex of an <a class="el" href="classitk_1_1Mesh.html" title="Implements the N-dimensional mesh structure.">Mesh</a>. There are three template parameters: the type of scalar, the type of vector, and the number of components of the vector. The types can be any data type that behaves like a primitive (or atomic) data type (int, short, float, complex). <a class="el" href="namespaceitk.html" title="Hashtable class, used to implement the hashed associative containers itk_hash_set...">itk</a> filters that rely on scalar data assume the data type held at each pixel or each vertex responds to <a class="el" href="classitk_1_1ScalarVector.html#5246fd2da91b279be55d7ee5d87a86ef">GetScalar()</a>/SetScalar() methods. <a class="el" href="namespaceitk.html" title="Hashtable class, used to implement the hashed associative containers itk_hash_set...">itk</a> filters that rely on vector data assume the data type held at each pixel or each vertex responds to <a class="el" href="classitk_1_1ScalarVector.html#2ba34ca44c1883fef70420ff2b5b2ac1">GetVector()</a>/SetVector() methods. If not, a compile time error will occur.<p>
<a class="el" href="classitk_1_1ScalarVector.html" title="A templated class holding bot scalar and vector values and responding to the GetScalar()...">ScalarVector</a> is not a dynamically extendible array like <a class="el" href="classstd_1_1vector.html">std::vector</a>. It is intended to be used like a mathematical vector.<p>
If you wish a simpler pixel types, you can use Scalar, which represents a single data value at a pixel. YOu can also use <a class="el" href="classitk_1_1Vector.html" title="A templated class holding a n-Dimensional vector.">Vector</a>, which supports (for a given pixel) an array of vector values.<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classitk_1_1Image.html" title="Templated n-dimensional image class.">Image</a> <p>
<a class="el" href="classitk_1_1Mesh.html" title="Implements the N-dimensional mesh structure.">Mesh</a> <p>
Scalar <p>
<a class="el" href="classitk_1_1Vector.html" title="A templated class holding a n-Dimensional vector.">Vector</a> </dd></dl>
<p>Definition at line <a class="el" href="itkScalarVector_8h_source.html#l00058">58</a> of file <a class="el" href="itkScalarVector_8h_source.html">itkScalarVector.h</a>.</p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="3b8eee117e01d3e1f5914d22fcbc6abf"></a><!-- doxytag: member="itk::ScalarVector::ScalarValueType" ref="3b8eee117e01d3e1f5914d22fcbc6abf" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class TScalar , class TVector , unsigned int TVectorDimension = 3> </div>
<table class="memname">
<tr>
<td class="memname">typedef TScalar <a class="el" href="classitk_1_1ScalarVector.html">itk::ScalarVector</a>< TScalar, TVector, TVectorDimension >::<a class="el" href="classitk_1_1ScalarVector.html#3b8eee117e01d3e1f5914d22fcbc6abf">ScalarValueType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
ValueType can be used to declare a variable that is the same type as the data held in the scalar portion of the <a class="el" href="classitk_1_1ScalarVector.html" title="A templated class holding bot scalar and vector values and responding to the GetScalar()...">ScalarVector</a>.
<p>Definition at line <a class="el" href="itkScalarVector_8h_source.html#l00070">70</a> of file <a class="el" href="itkScalarVector_8h_source.html">itkScalarVector.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="27d60f18bf0d6ef851ea8513c324acda"></a><!-- doxytag: member="itk::ScalarVector::Self" ref="27d60f18bf0d6ef851ea8513c324acda" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class TScalar , class TVector , unsigned int TVectorDimension = 3> </div>
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classitk_1_1ScalarVector.html">ScalarVector</a> <a class="el" href="classitk_1_1ScalarVector.html">itk::ScalarVector</a>< TScalar, TVector, TVectorDimension >::<a class="el" href="classitk_1_1ScalarVector.html">Self</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Standard class typedefs.
<p>Definition at line <a class="el" href="itkScalarVector_8h_source.html#l00062">62</a> of file <a class="el" href="itkScalarVector_8h_source.html">itkScalarVector.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="da91c1999a359742e8686baf528b6566"></a><!-- doxytag: member="itk::ScalarVector::ValueType" ref="da91c1999a359742e8686baf528b6566" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class TScalar , class TVector , unsigned int TVectorDimension = 3> </div>
<table class="memname">
<tr>
<td class="memname">typedef TScalar <a class="el" href="classitk_1_1ScalarVector.html">itk::ScalarVector</a>< TScalar, TVector, TVectorDimension >::<a class="el" href="classitk_1_1ScalarVector.html#da91c1999a359742e8686baf528b6566">ValueType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
ValueType can be used to declare a variable that is the same type as the data held in the scalar portion of the <a class="el" href="classitk_1_1ScalarVector.html" title="A templated class holding bot scalar and vector values and responding to the GetScalar()...">ScalarVector</a>.
<p>Definition at line <a class="el" href="itkScalarVector_8h_source.html#l00066">66</a> of file <a class="el" href="itkScalarVector_8h_source.html">itkScalarVector.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="bf95cf6bf936f42cc0a9be6271a15ce3"></a><!-- doxytag: member="itk::ScalarVector::VectorType" ref="bf95cf6bf936f42cc0a9be6271a15ce3" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class TScalar , class TVector , unsigned int TVectorDimension = 3> </div>
<table class="memname">
<tr>
<td class="memname">typedef vnl_vector_fixed<TVector, TVectorDimension> <a class="el" href="classitk_1_1ScalarVector.html">itk::ScalarVector</a>< TScalar, TVector, TVectorDimension >::<a class="el" href="classitk_1_1ScalarVector.html#bf95cf6bf936f42cc0a9be6271a15ce3">VectorType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
VectorType can be used to declare a variable that is the same type as the internal vector.
<p>Definition at line <a class="el" href="itkScalarVector_8h_source.html#l00078">78</a> of file <a class="el" href="itkScalarVector_8h_source.html">itkScalarVector.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="4aa7b9fdfbc48260554feb588c706bec"></a><!-- doxytag: member="itk::ScalarVector::VectorValueType" ref="4aa7b9fdfbc48260554feb588c706bec" args="" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class TScalar , class TVector , unsigned int TVectorDimension = 3> </div>
<table class="memname">
<tr>
<td class="memname">typedef TVector <a class="el" href="classitk_1_1ScalarVector.html">itk::ScalarVector</a>< TScalar, TVector, TVectorDimension >::<a class="el" href="classitk_1_1ScalarVector.html#4aa7b9fdfbc48260554feb588c706bec">VectorValueType</a> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
ValueType can be used to declare a variable that is the same type as the data held in the scalar portion of the <a class="el" href="classitk_1_1ScalarVector.html" title="A templated class holding bot scalar and vector values and responding to the GetScalar()...">ScalarVector</a>.
<p>Definition at line <a class="el" href="itkScalarVector_8h_source.html#l00074">74</a> of file <a class="el" href="itkScalarVector_8h_source.html">itkScalarVector.h</a>.</p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="5246fd2da91b279be55d7ee5d87a86ef"></a><!-- doxytag: member="itk::ScalarVector::GetScalar" ref="5246fd2da91b279be55d7ee5d87a86ef" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class TScalar , class TVector , unsigned int TVectorDimension = 3> </div>
<table class="memname">
<tr>
<td class="memname">TScalar <a class="el" href="classitk_1_1ScalarVector.html">itk::ScalarVector</a>< TScalar, TVector, TVectorDimension >::GetScalar </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the scalar value. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classitk_1_1ScalarVector.html#927eb9b07d2c3482b587f50b0ecdab56">SetScalar()</a> </dd></dl>
<p>Definition at line <a class="el" href="itkScalarVector_8h_source.html#l00081">81</a> of file <a class="el" href="itkScalarVector_8h_source.html">itkScalarVector.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="2ba34ca44c1883fef70420ff2b5b2ac1"></a><!-- doxytag: member="itk::ScalarVector::GetVector" ref="2ba34ca44c1883fef70420ff2b5b2ac1" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class TScalar , class TVector , unsigned int TVectorDimension = 3> </div>
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classitk_1_1ScalarVector.html#bf95cf6bf936f42cc0a9be6271a15ce3">VectorType</a>& <a class="el" href="classitk_1_1ScalarVector.html">itk::ScalarVector</a>< TScalar, TVector, TVectorDimension >::GetVector </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the vector. This provides a read/write reference to the vector. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classitk_1_1ScalarVector.html#d9030c900c60fb9bbd19b030e283d974">SetVector</a> </dd></dl>
<p>Definition at line <a class="el" href="itkScalarVector_8h_source.html#l00099">99</a> of file <a class="el" href="itkScalarVector_8h_source.html">itkScalarVector.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="baeed87193527824e83b73f7299a3c1a"></a><!-- doxytag: member="itk::ScalarVector::GetVector" ref="baeed87193527824e83b73f7299a3c1a" args="() const " -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class TScalar , class TVector , unsigned int TVectorDimension = 3> </div>
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classitk_1_1ScalarVector.html#bf95cf6bf936f42cc0a9be6271a15ce3">VectorType</a>& <a class="el" href="classitk_1_1ScalarVector.html">itk::ScalarVector</a>< TScalar, TVector, TVectorDimension >::GetVector </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the vector. This provides a read only reference to the vector. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classitk_1_1ScalarVector.html#d9030c900c60fb9bbd19b030e283d974">SetVector()</a>. </dd></dl>
<p>Definition at line <a class="el" href="itkScalarVector_8h_source.html#l00094">94</a> of file <a class="el" href="itkScalarVector_8h_source.html">itkScalarVector.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="9ddb8feac117e0f585670c1f682760fa"></a><!-- doxytag: member="itk::ScalarVector::GetVectorDimension" ref="9ddb8feac117e0f585670c1f682760fa" args="()" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class TScalar , class TVector , unsigned int TVectorDimension = 3> </div>
<table class="memname">
<tr>
<td class="memname">static unsigned int <a class="el" href="classitk_1_1ScalarVector.html">itk::ScalarVector</a>< TScalar, TVector, TVectorDimension >::<a class="el" href="structitk_1_1GetVectorDimension.html">GetVectorDimension</a> </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline, static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the dimension (size) of the vector.
<p>Definition at line <a class="el" href="itkScalarVector_8h_source.html#l00089">89</a> of file <a class="el" href="itkScalarVector_8h_source.html">itkScalarVector.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="927eb9b07d2c3482b587f50b0ecdab56"></a><!-- doxytag: member="itk::ScalarVector::SetScalar" ref="927eb9b07d2c3482b587f50b0ecdab56" args="(const TScalar &val)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class TScalar , class TVector , unsigned int TVectorDimension = 3> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classitk_1_1ScalarVector.html">itk::ScalarVector</a>< TScalar, TVector, TVectorDimension >::SetScalar </td>
<td>(</td>
<td class="paramtype">const TScalar & </td>
<td class="paramname"> <em>val</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the scalar value. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classitk_1_1ScalarVector.html#5246fd2da91b279be55d7ee5d87a86ef">GetScalar()</a> </dd></dl>
<p>Definition at line <a class="el" href="itkScalarVector_8h_source.html#l00085">85</a> of file <a class="el" href="itkScalarVector_8h_source.html">itkScalarVector.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="d9030c900c60fb9bbd19b030e283d974"></a><!-- doxytag: member="itk::ScalarVector::SetVector" ref="d9030c900c60fb9bbd19b030e283d974" args="(const VectorType &vec)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class TScalar , class TVector , unsigned int TVectorDimension = 3> </div>
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classitk_1_1ScalarVector.html">itk::ScalarVector</a>< TScalar, TVector, TVectorDimension >::SetVector </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classitk_1_1ScalarVector.html#bf95cf6bf936f42cc0a9be6271a15ce3">VectorType</a> & </td>
<td class="paramname"> <em>vec</em> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the vector. <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="classitk_1_1ScalarVector.html#baeed87193527824e83b73f7299a3c1a">GetVector</a> </dd></dl>
<p>Definition at line <a class="el" href="itkScalarVector_8h_source.html#l00103">103</a> of file <a class="el" href="itkScalarVector_8h_source.html">itkScalarVector.h</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="itkScalarVector_8h_source.html">itkScalarVector.h</a></ul>
</div>
<hr><address><small>
Generated at Fri May 8 06:40:52 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
>
8113
