<?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.PDB.AbstractPropertyMap.AbstractPropertyMap</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> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </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 Bio</a> :: <a href="Bio.PDB-module.html">Package PDB</a> :: <a href="Bio.PDB.AbstractPropertyMap-module.html">Module AbstractPropertyMap</a> :: Class AbstractPropertyMap </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 private</a>]</span></td></tr> <tr><td align="right"><span class="options" >[<a href="frames.html" target="_top">frames</a >] | <a href="Bio.PDB.AbstractPropertyMap.AbstractPropertyMap-class.html" target="_top">no frames</a>]</span></td></tr> </table> </td> </tr> </table> <!-- ==================== CLASS DESCRIPTION ==================== --> <h1 class="epydoc">Class AbstractPropertyMap</h1><p class="nomargin-top"><span class="codelink"><a href="Bio.PDB.AbstractPropertyMap-pysrc.html#AbstractPropertyMap">source code</a></span></p> <dl><dt>Known Subclasses:</dt> <dd> <ul class="subclass-list"> <li><a href="Bio.PDB.AbstractPropertyMap.AbstractResiduePropertyMap-class.html">AbstractResiduePropertyMap</a></li><li>, <a href="Bio.PDB.AbstractPropertyMap.AbstractAtomPropertyMap-class.html">AbstractAtomPropertyMap</a></li><li>, <a href="Bio.PDB.HSExposure.ExposureCN-class.html">HSExposure.ExposureCN</a></li><li class="private">, <a href="Bio.PDB.HSExposure._AbstractHSExposure-class.html" onclick="show_private();">HSExposure._AbstractHSExposure</a></li><li>, <a href="Bio.PDB.ResidueDepth%27.ResidueDepth-class.html">ResidueDepth'.ResidueDepth</a></li> </ul> </dd></dl> <hr /> <!-- ==================== 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">anything (can be a tuple)</span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="Bio.PDB.AbstractPropertyMap.AbstractPropertyMap-class.html#__getitem__" class="summary-sig-name">__getitem__</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">key</span>)</span><br /> Return property for a residue.</td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.PDB.AbstractPropertyMap-pysrc.html#AbstractPropertyMap.__getitem__">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="__init__"></a><span class="summary-sig-name">__init__</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">property_dict</span>, <span class="summary-sig-arg">property_keys</span>, <span class="summary-sig-arg">property_list</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.PDB.AbstractPropertyMap-pysrc.html#AbstractPropertyMap.__init__">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="Bio.PDB.AbstractPropertyMap.AbstractPropertyMap-class.html#__iter__" class="summary-sig-name">__iter__</a>(<span class="summary-sig-arg">self</span>)</span><br /> Iterate over the (entity, property) list.</td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.PDB.AbstractPropertyMap-pysrc.html#AbstractPropertyMap.__iter__">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">int</span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="Bio.PDB.AbstractPropertyMap.AbstractPropertyMap-class.html#__len__" class="summary-sig-name">__len__</a>(<span class="summary-sig-arg">self</span>)</span><br /> Return number of residues for which the property is available.</td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.PDB.AbstractPropertyMap-pysrc.html#AbstractPropertyMap.__len__">source code</a></span> </td> </tr> </table> </td> </tr> <tr class="private"> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a name="_translate_id"></a><span class="summary-sig-name">_translate_id</span>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">entity_id</span>)</span></td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.PDB.AbstractPropertyMap-pysrc.html#AbstractPropertyMap._translate_id">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type"> </span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="Bio.PDB.AbstractPropertyMap.AbstractPropertyMap-class.html#has_key" class="summary-sig-name">has_key</a>(<span class="summary-sig-arg">self</span>, <span class="summary-sig-arg">id</span>)</span><br /> Return 1 if the map has a property for this residue, 0 otherwise.</td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.PDB.AbstractPropertyMap-pysrc.html#AbstractPropertyMap.has_key">source code</a></span> </td> </tr> </table> </td> </tr> <tr> <td width="15%" align="right" valign="top" class="summary"> <span class="summary-type">[(chain_id, res_id), (chain_id, res_id),...]</span> </td><td class="summary"> <table width="100%" cellpadding="0" cellspacing="0" border="0"> <tr> <td><span class="summary-sig"><a href="Bio.PDB.AbstractPropertyMap.AbstractPropertyMap-class.html#keys" class="summary-sig-name">keys</a>(<span class="summary-sig-arg">self</span>)</span><br /> Return the list of residues.</td> <td align="right" valign="top"> <span class="codelink"><a href="Bio.PDB.AbstractPropertyMap-pysrc.html#AbstractPropertyMap.keys">source 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="__getitem__"></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">__getitem__</span>(<span class="sig-arg">self</span>, <span class="sig-arg">key</span>)</span> <br /><em class="fname">(Indexing operator)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="Bio.PDB.AbstractPropertyMap-pysrc.html#AbstractPropertyMap.__getitem__">source code</a></span> </td> </tr></table> <p>Return property for a residue.</p> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>chain_id</code></strong> (char) - chain id</li> <li><strong class="pname"><code>res_id</code></strong> (int or (char, int, char)) - residue id</li> </ul></dd> <dt>Returns: anything (can be a tuple)</dt> <dd>some residue property</dd> </dl> </td></tr></table> </div> <a name="__iter__"></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">__iter__</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="Bio.PDB.AbstractPropertyMap-pysrc.html#AbstractPropertyMap.__iter__">source code</a></span> </td> </tr></table> <p>Iterate over the (entity, property) list. Handy alternative to the dictionary-like access.</p> <p>Example:</p> <pre class="py-doctest"> <span class="py-prompt">>>> </span><span class="py-keyword">for</span> (res, property) <span class="py-keyword">in</span> iter(map): <span class="py-prompt">>>> </span> <span class="py-keyword">print</span> res, property</pre> <dl class="fields"> <dt>Returns:</dt> <dd>iterator</dd> </dl> </td></tr></table> </div> <a name="__len__"></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">__len__</span>(<span class="sig-arg">self</span>)</span> <br /><em class="fname">(Length operator)</em> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="Bio.PDB.AbstractPropertyMap-pysrc.html#AbstractPropertyMap.__len__">source code</a></span> </td> </tr></table> <p>Return number of residues for which the property is available.</p> <dl class="fields"> <dt>Returns: int</dt> <dd>number of residues</dd> </dl> </td></tr></table> </div> <a name="has_key"></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">has_key</span>(<span class="sig-arg">self</span>, <span class="sig-arg">id</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="Bio.PDB.AbstractPropertyMap-pysrc.html#AbstractPropertyMap.has_key">source code</a></span> </td> </tr></table> <p>Return 1 if the map has a property for this residue, 0 otherwise.</p> <p>Example:</p> <pre class="py-doctest"> <span class="py-prompt">>>> </span><span class="py-keyword">if</span> map.has_key((chain_id, res_id)): <span class="py-prompt">>>> </span> res, property=map[(chain_id, res_id)]</pre> <dl class="fields"> <dt>Parameters:</dt> <dd><ul class="nomargin-top"> <li><strong class="pname"><code>chain_id</code></strong> (char) - chain id</li> <li><strong class="pname"><code>res_id</code></strong> (char) - residue id</li> </ul></dd> </dl> </td></tr></table> </div> <a name="keys"></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">keys</span>(<span class="sig-arg">self</span>)</span> </h3> </td><td align="right" valign="top" ><span class="codelink"><a href="Bio.PDB.AbstractPropertyMap-pysrc.html#AbstractPropertyMap.keys">source code</a></span> </td> </tr></table> <p>Return the list of residues.</p> <dl class="fields"> <dt>Returns: [(chain_id, res_id), (chain_id, res_id),...]</dt> <dd>list of residues for which the property was calculated</dd> </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> <a href="module-tree.html">Trees</a> </th> <!-- Index link --> <th> <a href="identifier-index.html">Indices</a> </th> <!-- Help link --> <th> <a href="help.html">Help</a> </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>