Sophie

Sophie

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

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::bio::Gene 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="namespaceitk_1_1bio.html">bio</a>::<a class="el" href="classitk_1_1bio_1_1Gene.html">Gene</a>
  </div>
<div class="contents">
<h1>itk::bio::Gene Class Reference</h1><!-- doxytag: class="itk::bio::Gene" -->This class implement the abstraction of a biological gene.  
<a href="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="itkBioGene_8h_source.html">itkBioGene.h</a>&gt;</code>
<p>

<p>
<a href="classitk_1_1bio_1_1Gene-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Classes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structitk_1_1bio_1_1Gene_1_1ControlDomainType.html">ControlDomainType</a></td></tr>

<tr><td colspan="2"><br><h2>Public Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1bio_1_1Gene.html#09fb7cb162fbbaa0aa7d73857048060e">AffinityType</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1bio_1_1Gene.html#639ce31b993d55990731dd4e8d7045c7">DomainType</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::vector<br class="typebreak">
&lt; <a class="el" href="structitk_1_1bio_1_1Gene_1_1ControlDomainType.html">ControlDomainType</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1bio_1_1Gene.html#982eb63aef2bc6938d664a784b18842f">GeneControlDomainsType</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::string&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1bio_1_1Gene.html#90b0e3ade8afc7b66e4c52b53b5bcd25">NameType</a></td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef std::map&lt; <a class="el" href="classitk_1_1bio_1_1Gene.html#639ce31b993d55990731dd4e8d7045c7">DomainType</a>, <br class="typebreak">
<a class="el" href="classitk_1_1bio_1_1Gene.html#09fb7cb162fbbaa0aa7d73857048060e">AffinityType</a> &gt;&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1bio_1_1Gene.html#d8872d8ac731be796678c2820eb9e8f9">ProteinDomainsType</a></td></tr>

<tr><td colspan="2"><br><h2>Public Member Functions</h2></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_1bio_1_1Gene.html#bd130167ff2d28841e1555929053b92a">AddGeneControlDomain</a> (const <a class="el" href="classitk_1_1bio_1_1Gene.html#639ce31b993d55990731dd4e8d7045c7">DomainType</a> &amp;domain, bool type)</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_1bio_1_1Gene.html#2b900e7c51f8330664c87b6aa8926236">AddProteinDomain</a> (const <a class="el" href="classitk_1_1bio_1_1Gene.html#639ce31b993d55990731dd4e8d7045c7">DomainType</a> &amp;domain, <a class="el" href="classitk_1_1bio_1_1Gene.html#09fb7cb162fbbaa0aa7d73857048060e">AffinityType</a> affinity)</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_1bio_1_1Gene.html#6870219b5af8a552d869f8007c330183">Copy</a> (const <a class="el" href="classitk_1_1bio_1_1Gene.html">Gene</a> &amp;genome)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1bio_1_1Gene.html#162c9d2c1a99d6e6933d621a79daa4a2">Gene</a> ()</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_1bio_1_1Gene.html#f4fc9933d925b071a7972d5205bda5a3">~Gene</a> ()</td></tr>

<tr><td colspan="2"><div class="groupHeader"></div></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const char *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classitk_1_1bio_1_1Gene.html#c8f88cfdf1243abcbd7c7a5d04558bc8">GetName</a> () 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_1bio_1_1Gene.html#d2dafc525ee1b46b1b333df81f3898e1">SetName</a> (const char *name)</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_1bio_1_1Gene.html#f3d5f8e7b6c3257d18e6fae8e468b7d2">SetName</a> (const <a class="el" href="classitk_1_1bio_1_1Gene.html#90b0e3ade8afc7b66e4c52b53b5bcd25">NameType</a> &amp;name)</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This class implement the abstraction of a biological gene. 
<p>
The gene has a name and a specification of promoters and represor binding sites. Promoter and represors encode a boolean expression that allows to control the expression of the gene. These boolean expression will result in a polynome in a finite different equation determining the rate at which protein is syntethizied by this gene. 
<p>Definition at line <a class="el" href="itkBioGene_8h_source.html#l00041">41</a> of file <a class="el" href="itkBioGene_8h_source.html">itkBioGene.h</a>.</p>
<hr><h2>Member Typedef Documentation</h2>
<a class="anchor" name="09fb7cb162fbbaa0aa7d73857048060e"></a><!-- doxytag: member="itk::bio::Gene::AffinityType" ref="09fb7cb162fbbaa0aa7d73857048060e" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef double <a class="el" href="classitk_1_1bio_1_1Gene.html#09fb7cb162fbbaa0aa7d73857048060e">itk::bio::Gene::AffinityType</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="itkBioGene_8h_source.html#l00046">46</a> of file <a class="el" href="itkBioGene_8h_source.html">itkBioGene.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="639ce31b993d55990731dd4e8d7045c7"></a><!-- doxytag: member="itk::bio::Gene::DomainType" ref="639ce31b993d55990731dd4e8d7045c7" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef std::string <a class="el" href="classitk_1_1bio_1_1Gene.html#639ce31b993d55990731dd4e8d7045c7">itk::bio::Gene::DomainType</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="itkBioGene_8h_source.html#l00045">45</a> of file <a class="el" href="itkBioGene_8h_source.html">itkBioGene.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="982eb63aef2bc6938d664a784b18842f"></a><!-- doxytag: member="itk::bio::Gene::GeneControlDomainsType" ref="982eb63aef2bc6938d664a784b18842f" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef std::vector&lt; <a class="el" href="structitk_1_1bio_1_1Gene_1_1ControlDomainType.html">ControlDomainType</a> &gt; <a class="el" href="classitk_1_1bio_1_1Gene.html#982eb63aef2bc6938d664a784b18842f">itk::bio::Gene::GeneControlDomainsType</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="itkBioGene_8h_source.html#l00050">50</a> of file <a class="el" href="itkBioGene_8h_source.html">itkBioGene.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="90b0e3ade8afc7b66e4c52b53b5bcd25"></a><!-- doxytag: member="itk::bio::Gene::NameType" ref="90b0e3ade8afc7b66e4c52b53b5bcd25" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef std::string <a class="el" href="classitk_1_1bio_1_1Gene.html#90b0e3ade8afc7b66e4c52b53b5bcd25">itk::bio::Gene::NameType</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="itkBioGene_8h_source.html#l00044">44</a> of file <a class="el" href="itkBioGene_8h_source.html">itkBioGene.h</a>.</p>

</div>
</div><p>
<a class="anchor" name="d8872d8ac731be796678c2820eb9e8f9"></a><!-- doxytag: member="itk::bio::Gene::ProteinDomainsType" ref="d8872d8ac731be796678c2820eb9e8f9" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">typedef std::map&lt; <a class="el" href="classitk_1_1bio_1_1Gene.html#639ce31b993d55990731dd4e8d7045c7">DomainType</a>, <a class="el" href="classitk_1_1bio_1_1Gene.html#09fb7cb162fbbaa0aa7d73857048060e">AffinityType</a> &gt; <a class="el" href="classitk_1_1bio_1_1Gene.html#d8872d8ac731be796678c2820eb9e8f9">itk::bio::Gene::ProteinDomainsType</a>          </td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

<p>Definition at line <a class="el" href="itkBioGene_8h_source.html#l00047">47</a> of file <a class="el" href="itkBioGene_8h_source.html">itkBioGene.h</a>.</p>

</div>
</div><p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="162c9d2c1a99d6e6933d621a79daa4a2"></a><!-- doxytag: member="itk::bio::Gene::Gene" ref="162c9d2c1a99d6e6933d621a79daa4a2" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">itk::bio::Gene::Gene           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="f4fc9933d925b071a7972d5205bda5a3"></a><!-- doxytag: member="itk::bio::Gene::~Gene" ref="f4fc9933d925b071a7972d5205bda5a3" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual itk::bio::Gene::~Gene           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="bd130167ff2d28841e1555929053b92a"></a><!-- doxytag: member="itk::bio::Gene::AddGeneControlDomain" ref="bd130167ff2d28841e1555929053b92a" args="(const DomainType &amp;domain, bool type)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void itk::bio::Gene::AddGeneControlDomain           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classitk_1_1bio_1_1Gene.html#639ce31b993d55990731dd4e8d7045c7">DomainType</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>domain</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&nbsp;</td>
          <td class="paramname"> <em>type</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Add a control domain to the gene. <a class="el" href="classA.html">A</a> control domain is an enhancer or silencer. <a class="el" href="classA.html">A</a> gene can have any number of them. The type will indicate if they are enhancers or silencers. 
</div>
</div><p>
<a class="anchor" name="2b900e7c51f8330664c87b6aa8926236"></a><!-- doxytag: member="itk::bio::Gene::AddProteinDomain" ref="2b900e7c51f8330664c87b6aa8926236" args="(const DomainType &amp;domain, AffinityType affinity)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void itk::bio::Gene::AddProteinDomain           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classitk_1_1bio_1_1Gene.html#639ce31b993d55990731dd4e8d7045c7">DomainType</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>domain</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classitk_1_1bio_1_1Gene.html#09fb7cb162fbbaa0aa7d73857048060e">AffinityType</a>&nbsp;</td>
          <td class="paramname"> <em>affinity</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Add a protein domain along with an affinity. The name of the domain here actually refers to the one for which this protein will have binding affinity. For example, adding "SH2" with affinity 0.05 will means that this gene will synthetize a proteing with a domain that has 0.05 affinity for a standard SH2 domain. 
</div>
</div><p>
<a class="anchor" name="6870219b5af8a552d869f8007c330183"></a><!-- doxytag: member="itk::bio::Gene::Copy" ref="6870219b5af8a552d869f8007c330183" args="(const Gene &amp;genome)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void itk::bio::Gene::Copy           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classitk_1_1bio_1_1Gene.html">Gene</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>genome</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>

</div>
</div><p>
<a class="anchor" name="c8f88cfdf1243abcbd7c7a5d04558bc8"></a><!-- doxytag: member="itk::bio::Gene::GetName" ref="c8f88cfdf1243abcbd7c7a5d04558bc8" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const char* itk::bio::Gene::GetName           </td>
          <td>(</td>
          <td class="paramname">          </td>
          <td>&nbsp;)&nbsp;</td>
          <td> const</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set/Get the name of the gene. This uses a std::string type. 
</div>
</div><p>
<a class="anchor" name="d2dafc525ee1b46b1b333df81f3898e1"></a><!-- doxytag: member="itk::bio::Gene::SetName" ref="d2dafc525ee1b46b1b333df81f3898e1" args="(const char *name)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void itk::bio::Gene::SetName           </td>
          <td>(</td>
          <td class="paramtype">const char *&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set/Get the name of the gene. This uses a std::string type. 
</div>
</div><p>
<a class="anchor" name="f3d5f8e7b6c3257d18e6fae8e468b7d2"></a><!-- doxytag: member="itk::bio::Gene::SetName" ref="f3d5f8e7b6c3257d18e6fae8e468b7d2" args="(const NameType &amp;name)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void itk::bio::Gene::SetName           </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="classitk_1_1bio_1_1Gene.html#90b0e3ade8afc7b66e4c52b53b5bcd25">NameType</a> &amp;&nbsp;</td>
          <td class="paramname"> <em>name</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Set/Get the name of the gene. This uses a std::string type. 
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="itkBioGene_8h_source.html">itkBioGene.h</a></ul>
</div>
<hr><address><small>
Generated at Fri May 8 08:20:42 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>