annotate mayachemtools/docs/modules/html/SLogPAndSMRDescriptors.html @ 9:ab29fa5c8c1f draft default tip

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