Sophie

Sophie

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

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::IOCommon Class 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_1IOCommon.html">IOCommon</a>
  </div>
<div class="contents">
<h1>itk::IOCommon Class Reference<br>
<small>
[<a class="el" href="group__IOFilters.html">Input and Output Filters</a>]</small>
</h1><!-- doxytag: class="itk::IOCommon" -->Centralized funtionality for IO classes.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="itkIOCommon_8h_source.html">itkIOCommon.h</a>&gt;</code>
<p>

<p>
<a href="classitk_1_1IOCommon-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">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1IOCommon.html#f2f9277bc31cf1d88c36e4e03d0aadb1">AtomicPixelType</a> { <br>
&nbsp;&nbsp;<a class="el" href="classitk_1_1IOCommon.html#f2f9277bc31cf1d88c36e4e03d0aadb1d3c5b944a928b95afa7fbca904afbd7b">ITK_UCHAR</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classitk_1_1IOCommon.html#f2f9277bc31cf1d88c36e4e03d0aadb1917cc2726095fe46453f3c2596f8ae68">ITK_CHAR</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classitk_1_1IOCommon.html#f2f9277bc31cf1d88c36e4e03d0aadb133a957ca946e13c60c0aaa2d6a877362">ITK_USHORT</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classitk_1_1IOCommon.html#f2f9277bc31cf1d88c36e4e03d0aadb1790aa68b60796faf7e17a167e425ec36">ITK_SHORT</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classitk_1_1IOCommon.html#f2f9277bc31cf1d88c36e4e03d0aadb14fac47716669a272e6e62a8e124bdefc">ITK_UINT</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classitk_1_1IOCommon.html#f2f9277bc31cf1d88c36e4e03d0aadb1789147136bd91f8e1b3954feac8690fb">ITK_INT</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classitk_1_1IOCommon.html#f2f9277bc31cf1d88c36e4e03d0aadb134d198208149a24d52e484341af66a65">ITK_ULONG</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classitk_1_1IOCommon.html#f2f9277bc31cf1d88c36e4e03d0aadb187a61133aa916a9fdfc54fc8110055e6">ITK_LONG</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classitk_1_1IOCommon.html#f2f9277bc31cf1d88c36e4e03d0aadb186cbb8c2467c4300b2bfa628d6d2f0e5">ITK_FLOAT</a>, 
<br>
&nbsp;&nbsp;<a class="el" href="classitk_1_1IOCommon.html#f2f9277bc31cf1d88c36e4e03d0aadb1468e7c49c70f73392a83b80b7d51e284">ITK_DOUBLE</a>
<br>
 }</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">enum &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1IOCommon.html#bc1f603b7d29e54b89fdb4b73a8294ce">SysConstants</a> { <a class="el" href="classitk_1_1IOCommon.html#bc1f603b7d29e54b89fdb4b73a8294ceb322215d01efe901bdbb0bbf53af3b4d">MAX_FILENAMELIST_SIZE</a> =  512
 }</td></tr>

<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1IOCommon.html#cc14dd8af39ff34959ec0f5ef155f93f">itkLegacyMacro</a> (static bool FileExists(const char *filename))</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1IOCommon.html#292b4db987967ac0e7c13534454a52b5">itkLegacyMacro</a> (static char *ExtractFileName(const char *fileName))</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1IOCommon.html#928ad763054552184e3c7605ef26fb49">itkLegacyMacro</a> (static char *ExtractFileExtension(const char *fileName))</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1IOCommon.html#6cf95f6badd104cbc8a2472c982a256f">itkLegacyMacro</a> (static char *ExtractFilePath(const char *fileName))</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 std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1IOCommon.html#4db588cf59763aa434ae3a8b5b2e97c4">AtomicPixelTypeToString</a> (const <a class="el" href="classitk_1_1IOCommon.html#f2f9277bc31cf1d88c36e4e03d0aadb1">AtomicPixelType</a> pixelType)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">static unsigned int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1IOCommon.html#36fdf0a37999c88c8ef304676c39bf15">ComputeSizeOfAtomicPixelType</a> (const <a class="el" href="classitk_1_1IOCommon.html#f2f9277bc31cf1d88c36e4e03d0aadb1">AtomicPixelType</a> pixelType)</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Centralized funtionality for IO classes. 
<p>
This class provides encapsulated functionality to support the IO classes. 
<p>Definition at line <a class="el" href="itkIOCommon_8h_source.html#l00040">40</a> of file <a class="el" href="itkIOCommon_8h_source.html">itkIOCommon.h</a>.</p>
<hr><h2>Member Enumeration Documentation</h2>
<a class="anchor" name="f2f9277bc31cf1d88c36e4e03d0aadb1"></a><!-- doxytag: member="itk::IOCommon::AtomicPixelType" ref="f2f9277bc31cf1d88c36e4e03d0aadb1" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classitk_1_1IOCommon.html#f2f9277bc31cf1d88c36e4e03d0aadb1">itk::IOCommon::AtomicPixelType</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="f2f9277bc31cf1d88c36e4e03d0aadb1d3c5b944a928b95afa7fbca904afbd7b"></a><!-- doxytag: member="ITK_UCHAR" ref="f2f9277bc31cf1d88c36e4e03d0aadb1d3c5b944a928b95afa7fbca904afbd7b" args="" -->ITK_UCHAR</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f2f9277bc31cf1d88c36e4e03d0aadb1917cc2726095fe46453f3c2596f8ae68"></a><!-- doxytag: member="ITK_CHAR" ref="f2f9277bc31cf1d88c36e4e03d0aadb1917cc2726095fe46453f3c2596f8ae68" args="" -->ITK_CHAR</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f2f9277bc31cf1d88c36e4e03d0aadb133a957ca946e13c60c0aaa2d6a877362"></a><!-- doxytag: member="ITK_USHORT" ref="f2f9277bc31cf1d88c36e4e03d0aadb133a957ca946e13c60c0aaa2d6a877362" args="" -->ITK_USHORT</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f2f9277bc31cf1d88c36e4e03d0aadb1790aa68b60796faf7e17a167e425ec36"></a><!-- doxytag: member="ITK_SHORT" ref="f2f9277bc31cf1d88c36e4e03d0aadb1790aa68b60796faf7e17a167e425ec36" args="" -->ITK_SHORT</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f2f9277bc31cf1d88c36e4e03d0aadb14fac47716669a272e6e62a8e124bdefc"></a><!-- doxytag: member="ITK_UINT" ref="f2f9277bc31cf1d88c36e4e03d0aadb14fac47716669a272e6e62a8e124bdefc" args="" -->ITK_UINT</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f2f9277bc31cf1d88c36e4e03d0aadb1789147136bd91f8e1b3954feac8690fb"></a><!-- doxytag: member="ITK_INT" ref="f2f9277bc31cf1d88c36e4e03d0aadb1789147136bd91f8e1b3954feac8690fb" args="" -->ITK_INT</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f2f9277bc31cf1d88c36e4e03d0aadb134d198208149a24d52e484341af66a65"></a><!-- doxytag: member="ITK_ULONG" ref="f2f9277bc31cf1d88c36e4e03d0aadb134d198208149a24d52e484341af66a65" args="" -->ITK_ULONG</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f2f9277bc31cf1d88c36e4e03d0aadb187a61133aa916a9fdfc54fc8110055e6"></a><!-- doxytag: member="ITK_LONG" ref="f2f9277bc31cf1d88c36e4e03d0aadb187a61133aa916a9fdfc54fc8110055e6" args="" -->ITK_LONG</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f2f9277bc31cf1d88c36e4e03d0aadb186cbb8c2467c4300b2bfa628d6d2f0e5"></a><!-- doxytag: member="ITK_FLOAT" ref="f2f9277bc31cf1d88c36e4e03d0aadb186cbb8c2467c4300b2bfa628d6d2f0e5" args="" -->ITK_FLOAT</em>&nbsp;</td><td>
</td></tr>
<tr><td valign="top"><em><a class="anchor" name="f2f9277bc31cf1d88c36e4e03d0aadb1468e7c49c70f73392a83b80b7d51e284"></a><!-- doxytag: member="ITK_DOUBLE" ref="f2f9277bc31cf1d88c36e4e03d0aadb1468e7c49c70f73392a83b80b7d51e284" args="" -->ITK_DOUBLE</em>&nbsp;</td><td>
</td></tr>
</table>
</dl>

<p>Definition at line <a class="el" href="itkIOCommon_8h_source.html#l00048">48</a> of file <a class="el" href="itkIOCommon_8h_source.html">itkIOCommon.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="bc1f603b7d29e54b89fdb4b73a8294ce"></a><!-- doxytag: member="itk::IOCommon::SysConstants" ref="bc1f603b7d29e54b89fdb4b73a8294ce" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classitk_1_1IOCommon.html#bc1f603b7d29e54b89fdb4b73a8294ce">itk::IOCommon::SysConstants</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
<dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"><em><a class="anchor" name="bc1f603b7d29e54b89fdb4b73a8294ceb322215d01efe901bdbb0bbf53af3b4d"></a><!-- doxytag: member="MAX_FILENAMELIST_SIZE" ref="bc1f603b7d29e54b89fdb4b73a8294ceb322215d01efe901bdbb0bbf53af3b4d" args="" -->MAX_FILENAMELIST_SIZE</em>&nbsp;</td><td>
Maximum length of a filename </td></tr>
</table>
</dl>

<p>Definition at line <a class="el" href="itkIOCommon_8h_source.html#l00043">43</a> of file <a class="el" href="itkIOCommon_8h_source.html">itkIOCommon.h</a>.</p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="4db588cf59763aa434ae3a8b5b2e97c4"></a><!-- doxytag: member="itk::IOCommon::AtomicPixelTypeToString" ref="4db588cf59763aa434ae3a8b5b2e97c4" args="(const AtomicPixelType pixelType)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static std::string itk::IOCommon::AtomicPixelTypeToString           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classitk_1_1IOCommon.html#f2f9277bc31cf1d88c36e4e03d0aadb1">AtomicPixelType</a>&nbsp;</td>
          <td class="paramname"> <em>pixelType</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Convert the enumerated type to a string representation. 
</div>
</div><p>
<a class="anchor" name="36fdf0a37999c88c8ef304676c39bf15"></a><!-- doxytag: member="itk::IOCommon::ComputeSizeOfAtomicPixelType" ref="36fdf0a37999c88c8ef304676c39bf15" args="(const AtomicPixelType pixelType)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">static unsigned int itk::IOCommon::ComputeSizeOfAtomicPixelType           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classitk_1_1IOCommon.html#f2f9277bc31cf1d88c36e4e03d0aadb1">AtomicPixelType</a>&nbsp;</td>
          <td class="paramname"> <em>pixelType</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [static]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Calculate the size, in bytes, that the atomic pixel type occupies. 
</div>
</div><p>
<a class="anchor" name="cc14dd8af39ff34959ec0f5ef155f93f"></a><!-- doxytag: member="itk::IOCommon::itkLegacyMacro" ref="cc14dd8af39ff34959ec0f5ef155f93f" args="(static bool FileExists(const char *filename))" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">itk::IOCommon::itkLegacyMacro           </td>
          <td>(</td>
          <td class="paramtype">static bool &nbsp;</td>
          <td class="paramname"> <em>FileExists</em>const char *filename          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Given a filename determine whether it exists and return true if it does.<p>
<dl class="deprecated" compact><dt><b><a class="el" href="deprecated.html#_deprecated000058">Deprecated:</a></b></dt><dd>in ITK 3.8, please use itksys::SystemTools::FileExists(fileName) instead. </dd></dl>

</div>
</div><p>
<a class="anchor" name="292b4db987967ac0e7c13534454a52b5"></a><!-- doxytag: member="itk::IOCommon::itkLegacyMacro" ref="292b4db987967ac0e7c13534454a52b5" args="(static char *ExtractFileName(const char *fileName))" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">itk::IOCommon::itkLegacyMacro           </td>
          <td>(</td>
          <td class="paramtype">static char *&nbsp;</td>
          <td class="paramname"> <em>ExtractFileName</em>const char *fileName          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Given a full filename, extracts just the filename.<p>
<dl class="deprecated" compact><dt><b><a class="el" href="deprecated.html#_deprecated000057">Deprecated:</a></b></dt><dd>in ITK 3.8, please use itksys::SystemTools::GetFilenameName(fileName) instead. </dd></dl>

</div>
</div><p>
<a class="anchor" name="928ad763054552184e3c7605ef26fb49"></a><!-- doxytag: member="itk::IOCommon::itkLegacyMacro" ref="928ad763054552184e3c7605ef26fb49" args="(static char *ExtractFileExtension(const char *fileName))" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">itk::IOCommon::itkLegacyMacro           </td>
          <td>(</td>
          <td class="paramtype">static char *&nbsp;</td>
          <td class="paramname"> <em>ExtractFileExtension</em>const char *fileName          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Given a full filename, extracts just the file extension.<p>
<dl class="deprecated" compact><dt><b><a class="el" href="deprecated.html#_deprecated000056">Deprecated:</a></b></dt><dd>in ITK 3.8, please use itksys::SystemTools::GetFilenameExtension(fileName) or itksys::SystemTools::GetFilenameLastExtension(fileName) instead. </dd></dl>

</div>
</div><p>
<a class="anchor" name="6cf95f6badd104cbc8a2472c982a256f"></a><!-- doxytag: member="itk::IOCommon::itkLegacyMacro" ref="6cf95f6badd104cbc8a2472c982a256f" args="(static char *ExtractFilePath(const char *fileName))" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">itk::IOCommon::itkLegacyMacro           </td>
          <td>(</td>
          <td class="paramtype">static char *&nbsp;</td>
          <td class="paramname"> <em>ExtractFilePath</em>const char *fileName          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Given a full filename, extracts just the pathname.<p>
<dl class="deprecated" compact><dt><b><a class="el" href="deprecated.html#_deprecated000055">Deprecated:</a></b></dt><dd>in ITK 3.8, please use itksys::SystemTools::GetFilenamePath(fileName) instead. </dd></dl>

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