Mercurial > repos > deepakjadmin > mayatool3_test3
comparison mayachemtools/docs/modules/html/TPSADescriptors.html @ 0:73ae111cf86f draft
Uploaded
| author | deepakjadmin |
|---|---|
| date | Wed, 20 Jan 2016 11:55:01 -0500 |
| parents | |
| children |
comparison
equal
deleted
inserted
replaced
| -1:000000000000 | 0:73ae111cf86f |
|---|---|
| 1 <html> | |
| 2 <head> | |
| 3 <title>MayaChemTools:Documentation:MolecularDescriptors::TPSADescriptors.pm</title> | |
| 4 <meta http-equiv="content-type" content="text/html;charset=utf-8"> | |
| 5 <link rel="stylesheet" type="text/css" href="../../css/MayaChemTools.css"> | |
| 6 </head> | |
| 7 <body leftmargin="20" rightmargin="20" topmargin="10" bottommargin="10"> | |
| 8 <br/> | |
| 9 <center> | |
| 10 <a href="http://www.mayachemtools.org" title="MayaChemTools Home"><img src="../../images/MayaChemToolsLogo.gif" border="0" alt="MayaChemTools"></a> | |
| 11 </center> | |
| 12 <br/> | |
| 13 <div class="DocNav"> | |
| 14 <table width="100%" border=0 cellpadding=0 cellspacing=2> | |
| 15 <tr align="left" valign="top"><td width="33%" align="left"><a href="./SLogPAndSMRDescriptors.html" title="SLogPAndSMRDescriptors.html">Previous</a> <a href="./index.html" title="Table of Contents">TOC</a> <a href="./WeightAndMassDescriptors.html" title="WeightAndMassDescriptors.html">Next</a></td><td width="34%" align="middle"><strong>MolecularDescriptors::TPSADescriptors.pm</strong></td><td width="33%" align="right"><a href="././code/TPSADescriptors.html" title="View source code">Code</a> | <a href="./../pdf/TPSADescriptors.pdf" title="PDF US Letter Size">PDF</a> | <a href="./../pdfgreen/TPSADescriptors.pdf" title="PDF US Letter Size with narrow margins: www.changethemargins.com">PDFGreen</a> | <a href="./../pdfa4/TPSADescriptors.pdf" title="PDF A4 Size">PDFA4</a> | <a href="./../pdfa4green/TPSADescriptors.pdf" title="PDF A4 Size with narrow margins: www.changethemargins.com">PDFA4Green</a></td></tr> | |
| 16 </table> | |
| 17 </div> | |
| 18 <p> | |
| 19 </p> | |
| 20 <h2>NAME</h2> | |
| 21 <p>TPSADescriptors</p> | |
| 22 <p> | |
| 23 </p> | |
| 24 <h2>SYNOPSIS</h2> | |
| 25 <p>use MolecularDescriptors::TPSADescriptors;</p> | |
| 26 <p>use MolecularDescriptors::TPSADescriptors qw(:all);</p> | |
| 27 <p> | |
| 28 </p> | |
| 29 <h2>DESCRIPTION</h2> | |
| 30 <p><strong>TPSADescriptors</strong> class provides the following methods:</p> | |
| 31 <p> <a href="#new">new</a>, <a href="#generatedescriptors">GenerateDescriptors</a>, <a href="#getdescriptornames">GetDescriptorNames</a>, <a href="#stringifytpsadescriptors">StringifyTPSADescriptors</a> | |
| 32 </p><p><strong>TPSADescriptors</strong> is derived from <strong>MolecularDescriptors</strong> class which in turn | |
| 33 is derived from <strong>ObjectProperty</strong> base class that provides methods not explicitly defined | |
| 34 in <strong>TPSADescriptors</strong>, <strong>MolecularDescriptors</strong> or <strong>ObjectProperty</strong> classes using Perl's | |
| 35 AUTOLOAD functionality. These methods are generated on-the-fly for a specified object property:</p> | |
| 36 <div class="OptionsBox"> | |
| 37 Set<PropertyName>(<PropertyValue>); | |
| 38 <br/> $PropertyValue = Get<PropertyName>(); | |
| 39 <br/> Delete<PropertyName>();</div> | |
| 40 <p>After Topological Polar Surface Area (TPSA) atom types [ Ref 90-91 ] has been assigned | |
| 41 to appropriate atoms in a molecule using AtomTypes::TPSAAtomTypes.pm module, TPSA value | |
| 42 is calculated by adding up contributions of each appropriate atom type.</p> | |
| 43 <p>By default, MayaChemTools only uses nitrogen and oxygen atoms during calculation | |
| 44 of TPSA and ignores phosphorous and sulfur atoms. [ Ref 90 - 91 ]</p> | |
| 45 <p> | |
| 46 </p> | |
| 47 <h2>METHODS</h2> | |
| 48 <dl> | |
| 49 <dt><strong><a name="new" class="item"><strong>new</strong></a></strong></dt> | |
| 50 <dd> | |
| 51 <div class="OptionsBox"> | |
| 52 $NewTPSADescriptors = new MolecularDescriptors::TPSADescriptors( | |
| 53 %NamesAndValues);</div> | |
| 54 <p>Using specified <em>TPSADescriptors</em> property names and values hash, <strong>new</strong> | |
| 55 method creates a new object and returns a reference to newly created <strong>TPSADescriptors</strong> | |
| 56 object. By default, the following properties are initialized:</p> | |
| 57 <div class="OptionsBox"> | |
| 58 Molecule = '' | |
| 59 <br/> Type = 'TPSA' | |
| 60 <br/> IgnorePhosphorus = 1 | |
| 61 <br/> IgnoreSulfur = 1 | |
| 62 <br/> @DescriptorNames = ('TPSA') | |
| 63 <br/> @DescriptorValues = ('None')</div> | |
| 64 <p>Examples:</p> | |
| 65 <div class="OptionsBox"> | |
| 66 $TPSADescriptors = new MolecularDescriptors::TPSADescriptors( | |
| 67 'Molecule' => $Molecule);</div> | |
| 68 <div class="OptionsBox"> | |
| 69 $TPSADescriptors = new MolecularDescriptors::TPSADescriptors();</div> | |
| 70 <div class="OptionsBox"> | |
| 71 $TPSADescriptors = new MolecularDescriptors::TPSADescriptors( | |
| 72 'IgnorePhosphorus' => 0, | |
| 73 'IgnoreSulfur' => 0);</div> | |
| 74 <div class="OptionsBox"> | |
| 75 $TPSADescriptors->SetMolecule($Molecule); | |
| 76 <br/> $TPSADescriptors->GenerateDescriptors(); | |
| 77 <br/> print "TPSADescriptors: $TPSADescriptors\n";</div> | |
| 78 </dd> | |
| 79 <dt><strong><a name="generatedescriptors" class="item"><strong>GenerateDescriptors</strong></a></strong></dt> | |
| 80 <dd> | |
| 81 <div class="OptionsBox"> | |
| 82 $TPSADescriptors->GenerateDescriptors();</div> | |
| 83 <p>Calculate TPSA value for a molecule and returns <em>TPSADescriptors</em>.</p> | |
| 84 </dd> | |
| 85 <dt><strong><a name="getdescriptornames" class="item"><strong>GetDescriptorNames</strong></a></strong></dt> | |
| 86 <dd> | |
| 87 <div class="OptionsBox"> | |
| 88 @DescriptorNames = $TPSADescriptors->GetDescriptorNames(); | |
| 89 <br/> @DescriptorNames = MolecularDescriptors::TPSADescriptors:: | |
| 90 GetDescriptorNames();</div> | |
| 91 <p>Returns all available descriptor names as an array.</p> | |
| 92 </dd> | |
| 93 <dt><strong><a name="stringifytpsadescriptors" class="item"><strong>StringifyTPSADescriptors</strong></a></strong></dt> | |
| 94 <dd> | |
| 95 <div class="OptionsBox"> | |
| 96 $String = $TPSADescriptors->StringifyTPSADescriptors();</div> | |
| 97 <p>Returns a string containing information about <em>TPSADescriptors</em> object.</p> | |
| 98 </dd> | |
| 99 </dl> | |
| 100 <p> | |
| 101 </p> | |
| 102 <h2>AUTHOR</h2> | |
| 103 <p><a href="mailto:msud@san.rr.com">Manish Sud</a></p> | |
| 104 <p> | |
| 105 </p> | |
| 106 <h2>SEE ALSO</h2> | |
| 107 <p><a href="./MolecularDescriptors.html">MolecularDescriptors.pm</a>, <a href="./MolecularDescriptorsGenerator.html">MolecularDescriptorsGenerator.pm</a> | |
| 108 </p> | |
| 109 <p> | |
| 110 </p> | |
| 111 <h2>COPYRIGHT</h2> | |
| 112 <p>Copyright (C) 2015 Manish Sud. All rights reserved.</p> | |
| 113 <p>This file is part of MayaChemTools.</p> | |
| 114 <p>MayaChemTools is free software; you can redistribute it and/or modify it under | |
| 115 the terms of the GNU Lesser General Public License as published by the Free | |
| 116 Software Foundation; either version 3 of the License, or (at your option) | |
| 117 any later version.</p> | |
| 118 <p> </p><p> </p><div class="DocNav"> | |
| 119 <table width="100%" border=0 cellpadding=0 cellspacing=2> | |
| 120 <tr align="left" valign="top"><td width="33%" align="left"><a href="./SLogPAndSMRDescriptors.html" title="SLogPAndSMRDescriptors.html">Previous</a> <a href="./index.html" title="Table of Contents">TOC</a> <a href="./WeightAndMassDescriptors.html" title="WeightAndMassDescriptors.html">Next</a></td><td width="34%" align="middle"><strong>March 29, 2015</strong></td><td width="33%" align="right"><strong>MolecularDescriptors::TPSADescriptors.pm</strong></td></tr> | |
| 121 </table> | |
| 122 </div> | |
| 123 <br /> | |
| 124 <center> | |
| 125 <img src="../../images/h2o2.png"> | |
| 126 </center> | |
| 127 </body> | |
| 128 </html> |