annotate mayachemtools/docs/modules/html/MolecularVolumeDescriptors.html @ 0:73ae111cf86f draft

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 11:55:01 -0500
parents
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::MolecularVolumeDescriptors.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="./MolecularDescriptorsGenerator.html" title="MolecularDescriptorsGenerator.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./RingsCountDescriptors.html" title="RingsCountDescriptors.html">Next</a></td><td width="34%" align="middle"><strong>MolecularDescriptors::MolecularVolumeDescriptors.pm</strong></td><td width="33%" align="right"><a href="././code/MolecularVolumeDescriptors.html" title="View source code">Code</a>&nbsp;|&nbsp;<a href="./../pdf/MolecularVolumeDescriptors.pdf" title="PDF US Letter Size">PDF</a>&nbsp;|&nbsp;<a href="./../pdfgreen/MolecularVolumeDescriptors.pdf" title="PDF US Letter Size with narrow margins: www.changethemargins.com">PDFGreen</a>&nbsp;|&nbsp;<a href="./../pdfa4/MolecularVolumeDescriptors.pdf" title="PDF A4 Size">PDFA4</a>&nbsp;|&nbsp;<a href="./../pdfa4green/MolecularVolumeDescriptors.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>MolecularVolumeDescriptors</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::MolecularVolumeDescriptors;</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26 <p>use MolecularDescriptors::MolecularVolumeDescriptors 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>MolecularVolumeDescriptors</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="#getvdwatomradiiandvolumesdata">GetVDWAtomRadiiAndVolumesData</a>, <a href="#stringifymolecularvolumedescriptors">StringifyMolecularVolumeDescriptors</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33 </p><p><strong>MolecularVolumeDescriptors</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>MolecularVolumeDescriptors</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>van der Waals molecular volume [ Ref 93 ] (A**3/molecule) of a molecule is
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42 calculated using atomic and bonds contributions along with adjustments for
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43 aromatic and non-aromatic rings using the following equation:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45 vdwMolecularVolume = SumOfAtomicVDWVolumeContributions
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46 - 5.92 * NumOfBonds
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47 - 14.7 * NumOfAromaticRings
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 - 3.8 * NumOfNonAromaticRings</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 <p>van der Waals atomic volume for atoms is taken from data file VDWAtomRadiiAndVolumes.csv
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50 distributed with MayaChemTools. It contains van der Waals atom radii and atom and volumes
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51 data for 38 elements; Table 2 [ Ref 93 ] contains data for only 15 elements. After converting
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52 valid van der Waals atom radius data from pm (picometer) to A (Angstrom) available under column
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 name VanderWaalsRadius in PeriodicTableElementsData.csv data file, van der Waals atom volume
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54 is calculated using: 4/3 * PI * (Radius ** 3). For elements specified in Table 2 [ Ref 93 ] -
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55 H, B, C, N, O, F, Si, P, S, Cl, As, Se, Br, Te, I - the van der Waals atom radii and calculated
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56 atom volumes match the values in the table.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 <h2>METHODS</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60 <dl>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61 <dt><strong><a name="new" class="item"><strong>new</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 $NewMolecularVolumeDescriptors = new MolecularDescriptors::
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65 MolecularVolumeDescriptors(
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66 %NamesAndValues);</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67 <p>Using specified <em>MolecularVolumeDescriptors</em> property names and values hash, <strong>new</strong>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
68 method creates a new object and returns a reference to newly created <strong>MolecularVolumeDescriptors</strong>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
69 object. By default, the following properties are initialized:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
70 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
71 Molecule = ''
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
72 <br/> Type = 'MolecularVolume'
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
73 <br/> @DescriptorNames = ('MolecularVolume')
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
74 <br/> @DescriptorValues = ('None')</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
75 <p>Examples:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
76 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
77 $MolecularVolumeDescriptors = new MolecularDescriptors::
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
78 MolecularVolumeDescriptors();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
79 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
80 $MolecularVolumeDescriptors-&gt;SetMolecule($Molecule);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
81 <br/> $MolecularVolumeDescriptors-&gt;GenerateDescriptors();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
82 <br/> print &quot;MolecularVolumeDescriptors: $MolecularVolumeDescriptors\n&quot;;</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
83 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
84 <dt><strong><a name="generatedescriptors" class="item"><strong>GenerateDescriptors</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
85 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
86 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
87 $MolecularVolumeDescriptors-&gt;GenerateDescriptors();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
88 <p>Calculate van der Waals molecular volume descriptor for a molecule and returns
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
89 <em>MolecularVolumeDescriptors</em>.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
90 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
91 <dt><strong><a name="getdescriptornames" class="item"><strong>GetDescriptorNames</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
92 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
93 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
94 @DescriptorNames = $MolecularVolumeDescriptors-&gt;GetDescriptorNames();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
95 <br/> @DescriptorNames = MolecularDescriptors::MolecularVolumeDescriptors::
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
96 GetDescriptorNames();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
97 <p>Returns all available descriptor names as an array.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
98 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
99 <dt><strong><a name="getvdwatomradiiandvolumesdata" class="item"><strong>GetVDWAtomRadiiAndVolumesData</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
100 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
101 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
102 $VDWVolumeDataMapRef = $MolecularVolumeDescriptors-&gt;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
103 GetVDWAtomRadiiAndVolumesData();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
104 <br/> $VDWVolumeDataMapRef = MolecularDescriptors::MolecularVolumeDescriptors::
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
105 GetVDWAtomRadiiAndVolumesData();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
106 <p>Returns a hash reference to van der Waals atom symbols corresponding to atom types
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
107 and associated data loaded from VDWAtomRadiiAndVolumes.csv data file as a reference
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
108 to hash with the following hash data format:</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
109 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
110 @{$VDWVolumeDataMap{AtomTypes}} - Array of all possible atom
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
111 types for all atom symbols
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
112 <br/> @{$VDWVolumeDataMap-&gt;{ColLabels}} - Array of column labels
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
113 <br/> %{$VDWVolumeDataMap-&gt;{DataCol&lt;Num&gt;}} - Hash keys pair:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
114 DataCol&lt;Num&gt;, AtomType</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
115 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
116 <dt><strong><a name="stringifymolecularvolumedescriptors" class="item"><strong>StringifyMolecularVolumeDescriptors</strong></a></strong></dt>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
117 <dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
118 <div class="OptionsBox">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
119 $String = $MolecularVolumeDescriptors-&gt;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
120 StringifyMolecularVolumeDescriptors();</div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
121 <p>Returns a string containing information about <em>MolecularVolumeDescriptors</em> object.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
122 </dd>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
123 </dl>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
124 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
125 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
126 <h2>AUTHOR</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
127 <p><a href="mailto:msud@san.rr.com">Manish Sud</a></p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
128 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
129 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
130 <h2>SEE ALSO</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
131 <p><a href="./MolecularDescriptors.html">MolecularDescriptors.pm</a>,&nbsp<a href="./MolecularDescriptorsGenerator.html">MolecularDescriptorsGenerator.pm</a>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
132 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
133 <p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
134 </p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
135 <h2>COPYRIGHT</h2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
136 <p>Copyright (C) 2015 Manish Sud. All rights reserved.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
137 <p>This file is part of MayaChemTools.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
138 <p>MayaChemTools is free software; you can redistribute it and/or modify it under
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
139 the terms of the GNU Lesser General Public License as published by the Free
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
140 Software Foundation; either version 3 of the License, or (at your option)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
141 any later version.</p>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
142 <p>&nbsp</p><p>&nbsp</p><div class="DocNav">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
143 <table width="100%" border=0 cellpadding=0 cellspacing=2>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
144 <tr align="left" valign="top"><td width="33%" align="left"><a href="./MolecularDescriptorsGenerator.html" title="MolecularDescriptorsGenerator.html">Previous</a>&nbsp;&nbsp;<a href="./index.html" title="Table of Contents">TOC</a>&nbsp;&nbsp;<a href="./RingsCountDescriptors.html" title="RingsCountDescriptors.html">Next</a></td><td width="34%" align="middle"><strong>March 29, 2015</strong></td><td width="33%" align="right"><strong>MolecularDescriptors::MolecularVolumeDescriptors.pm</strong></td></tr>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
145 </table>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
146 </div>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
147 <br />
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
148 <center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
149 <img src="../../images/h2o2.png">
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
150 </center>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
151 </body>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
152 </html>