Sophie

Sophie

distrib > Mandriva > 2008.1 > x86_64 > by-pkgid > 763d6289e1351f2d34257ce697a3ccb7 > files > 1001

biopython-doc-1.47-2mdv2008.1.x86_64.rpm

<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>Bio.NeuralNetwork.Gene.Schema.Schema</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="Bio-module.html">Package&nbsp;Bio</a> ::
        <a href="Bio.NeuralNetwork-module.html">Package&nbsp;NeuralNetwork</a> ::
        <a href="Bio.NeuralNetwork.Gene-module.html">Package&nbsp;Gene</a> ::
        <a href="Bio.NeuralNetwork.Gene.Schema-module.html">Module&nbsp;Schema</a> ::
        Class&nbsp;Schema
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="Bio.NeuralNetwork.Gene.Schema.Schema-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Schema</h1><p class="nomargin-top"><span class="codelink"><a href="Bio.NeuralNetwork.Gene.Schema-pysrc.html#Schema">source&nbsp;code</a></span></p>
<p>Deal with motifs that have ambiguity characters in it.</p>
  <p>This motif class allows specific ambiguity characters and tries to 
  speed up finding motifs using regular expressions.</p>
  <p>This is likely to be a replacement for the Schema representation, 
  since it allows multiple ambiguity characters to be used.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="Bio.NeuralNetwork.Gene.Schema.Schema-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">ambiguity_info</span>)</span><br />
      Initialize with ambiguity information.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Bio.NeuralNetwork.Gene.Schema-pysrc.html#Schema.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="Bio.NeuralNetwork.Gene.Schema.Schema-class.html#encode_motif" class="summary-sig-name">encode_motif</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">motif</span>)</span><br />
      Encode the passed motif as a regular expression pattern object.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Bio.NeuralNetwork.Gene.Schema-pysrc.html#Schema.encode_motif">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="Bio.NeuralNetwork.Gene.Schema.Schema-class.html#find_ambiguous" class="summary-sig-name">find_ambiguous</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">motif</span>)</span><br />
      Return the location of ambiguous items in the motif.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Bio.NeuralNetwork.Gene.Schema-pysrc.html#Schema.find_ambiguous">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="num_ambiguous"></a><span class="summary-sig-name">num_ambiguous</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">motif</span>)</span><br />
      Return the number of ambiguous letters in a given motif.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Bio.NeuralNetwork.Gene.Schema-pysrc.html#Schema.num_ambiguous">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="Bio.NeuralNetwork.Gene.Schema.Schema-class.html#find_matches" class="summary-sig-name">find_matches</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">motif</span>,
        <span class="summary-sig-arg">query</span>)</span><br />
      Return all non-overlapping motif matches in the query string.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Bio.NeuralNetwork.Gene.Schema-pysrc.html#Schema.find_matches">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="num_matches"></a><span class="summary-sig-name">num_matches</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">motif</span>,
        <span class="summary-sig-arg">query</span>)</span><br />
      Find the number of non-overlapping times motif occurs in query.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Bio.NeuralNetwork.Gene.Schema-pysrc.html#Schema.num_matches">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="all_unambiguous"></a><span class="summary-sig-name">all_unambiguous</span>(<span class="summary-sig-arg">self</span>)</span><br />
      Return a listing of all unambiguous letters allowed in motifs.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="Bio.NeuralNetwork.Gene.Schema-pysrc.html#Schema.all_unambiguous">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">ambiguity_info</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Bio.NeuralNetwork.Gene.Schema-pysrc.html#Schema.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Initialize with ambiguity information.</p>
  <p>Arguments:</p>
  <p>o ambiguity_info - A dictionary which maps letters in the motifs to 
  the ambiguous characters which they might represent. For example, {'R' : 
  'AG'} specifies that Rs in the motif can match a A or a G. All letters in
  the motif must be represented in the ambiguity_info dictionary.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="encode_motif"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">encode_motif</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">motif</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Bio.NeuralNetwork.Gene.Schema-pysrc.html#Schema.encode_motif">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Encode the passed motif as a regular expression pattern object.</p>
  <p>Arguments:</p>
  <p>o motif - The motif we want to encode. This should be a string.</p>
  <p>Returns: A compiled regular expression pattern object that can be used
  for searching strings.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="find_ambiguous"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">find_ambiguous</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">motif</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Bio.NeuralNetwork.Gene.Schema-pysrc.html#Schema.find_ambiguous">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Return the location of ambiguous items in the motif.</p>
  <p>This just checks through the motif and compares each letter against 
  the ambiguity information. If a letter stands for multiple items, it is 
  ambiguous.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="find_matches"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">find_matches</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">motif</span>,
        <span class="sig-arg">query</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="Bio.NeuralNetwork.Gene.Schema-pysrc.html#Schema.find_matches">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Return all non-overlapping motif matches in the query string.</p>
  <p>This utilizes the regular expression findall function, and will return
  a list of all non-overlapping occurances in query that match the 
  ambiguous motif.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Mon Sep 15 09:26:36 2008
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>