annotate docs/modules/txt/MolecularVolumeDescriptors.txt @ 3:90ea638ce878 draft default tip

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 09:11:59 -0500
parents 2abf0d43254d
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
1 NAME
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
2 MolecularVolumeDescriptors
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
3
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
5 use MolecularDescriptors::MolecularVolumeDescriptors;
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
6
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
7 use MolecularDescriptors::MolecularVolumeDescriptors qw(:all);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
8
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
9 DESCRIPTION
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
10 MolecularVolumeDescriptors class provides the following methods:
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
11
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
12 new, GenerateDescriptors, GetDescriptorNames,
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
13 GetVDWAtomRadiiAndVolumesData, StringifyMolecularVolumeDescriptors
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
14
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
15 MolecularVolumeDescriptors is derived from MolecularDescriptors class
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
16 which in turn is derived from ObjectProperty base class that provides
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
17 methods not explicitly defined in MolecularVolumeDescriptors,
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
18 MolecularDescriptors or ObjectProperty classes using Perl's AUTOLOAD
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
19 functionality. These methods are generated on-the-fly for a specified
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
20 object property:
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
21
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
22 Set<PropertyName>(<PropertyValue>);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
23 $PropertyValue = Get<PropertyName>();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
24 Delete<PropertyName>();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
25
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
26 van der Waals molecular volume [ Ref 93 ] (A**3/molecule) of a molecule
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
27 is calculated using atomic and bonds contributions along with
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
28 adjustments for aromatic and non-aromatic rings using the following
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
29 equation:
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
30
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
31 vdwMolecularVolume = SumOfAtomicVDWVolumeContributions
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
32 - 5.92 * NumOfBonds
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
33 - 14.7 * NumOfAromaticRings
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
34 - 3.8 * NumOfNonAromaticRings
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
35
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
36 van der Waals atomic volume for atoms is taken from data file
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
37 VDWAtomRadiiAndVolumes.csv distributed with MayaChemTools. It contains
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
38 van der Waals atom radii and atom and volumes data for 38 elements;
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
39 Table 2 [ Ref 93 ] contains data for only 15 elements. After converting
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
40 valid van der Waals atom radius data from pm (picometer) to A (Angstrom)
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
41 available under column name VanderWaalsRadius in
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
42 PeriodicTableElementsData.csv data file, van der Waals atom volume is
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
43 calculated using: 4/3 * PI * (Radius ** 3). For elements specified in
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
44 Table 2 [ Ref 93 ] - H, B, C, N, O, F, Si, P, S, Cl, As, Se, Br, Te, I -
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
45 the van der Waals atom radii and calculated atom volumes match the
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
46 values in the table.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
47
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
48 METHODS
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
49 new
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
50 $NewMolecularVolumeDescriptors = new MolecularDescriptors::
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
51 MolecularVolumeDescriptors(
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
52 %NamesAndValues);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
53
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
54 Using specified *MolecularVolumeDescriptors* property names and
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
55 values hash, new method creates a new object and returns a reference
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
56 to newly created MolecularVolumeDescriptors object. By default, the
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
57 following properties are initialized:
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
58
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
59 Molecule = ''
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
60 Type = 'MolecularVolume'
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
61 @DescriptorNames = ('MolecularVolume')
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
62 @DescriptorValues = ('None')
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
63
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
64 Examples:
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
65
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
66 $MolecularVolumeDescriptors = new MolecularDescriptors::
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
67 MolecularVolumeDescriptors();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
68
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
69 $MolecularVolumeDescriptors->SetMolecule($Molecule);
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
70 $MolecularVolumeDescriptors->GenerateDescriptors();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
71 print "MolecularVolumeDescriptors: $MolecularVolumeDescriptors\n";
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
72
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
73 GenerateDescriptors
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
74 $MolecularVolumeDescriptors->GenerateDescriptors();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
75
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
76 Calculate van der Waals molecular volume descriptor for a molecule
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
77 and returns *MolecularVolumeDescriptors*.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
78
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
79 GetDescriptorNames
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
80 @DescriptorNames = $MolecularVolumeDescriptors->GetDescriptorNames();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
81 @DescriptorNames = MolecularDescriptors::MolecularVolumeDescriptors::
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
82 GetDescriptorNames();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
83
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
84 Returns all available descriptor names as an array.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
85
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
86 GetVDWAtomRadiiAndVolumesData
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
87 $VDWVolumeDataMapRef = $MolecularVolumeDescriptors->
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
88 GetVDWAtomRadiiAndVolumesData();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
89 $VDWVolumeDataMapRef = MolecularDescriptors::MolecularVolumeDescriptors::
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
90 GetVDWAtomRadiiAndVolumesData();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
91
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
92 Returns a hash reference to van der Waals atom symbols corresponding
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
93 to atom types and associated data loaded from
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
94 VDWAtomRadiiAndVolumes.csv data file as a reference to hash with the
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
95 following hash data format:
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
96
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
97 @{$VDWVolumeDataMap{AtomTypes}} - Array of all possible atom
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
98 types for all atom symbols
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
99 @{$VDWVolumeDataMap->{ColLabels}} - Array of column labels
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
100 %{$VDWVolumeDataMap->{DataCol<Num>}} - Hash keys pair:
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
101 DataCol<Num>, AtomType
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
102
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
103 StringifyMolecularVolumeDescriptors
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
104 $String = $MolecularVolumeDescriptors->
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
105 StringifyMolecularVolumeDescriptors();
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
106
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
107 Returns a string containing information about
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
108 *MolecularVolumeDescriptors* object.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
109
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
110 AUTHOR
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
111 Manish Sud <msud@san.rr.com>
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
112
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
113 SEE ALSO
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
114 MolecularDescriptors.pm, MolecularDescriptorsGenerator.pm
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
115
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
116 COPYRIGHT
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
117 Copyright (C) 2015 Manish Sud. All rights reserved.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
118
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
119 This file is part of MayaChemTools.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
120
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
121 MayaChemTools is free software; you can redistribute it and/or modify it
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
122 under the terms of the GNU Lesser General Public License as published by
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
123 the Free Software Foundation; either version 3 of the License, or (at
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
124 your option) any later version.
2abf0d43254d Uploaded
deepakjadmin
parents:
diff changeset
125