annotate lib/Fingerprints/EStateIndiciesFingerprints.pm @ 0:4816e4a8ae95 draft default tip

Uploaded
author deepakjadmin
date Wed, 20 Jan 2016 09:23:18 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
1 package Fingerprints::EStateIndiciesFingerprints;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
2 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
3 # $RCSfile: EStateIndiciesFingerprints.pm,v $
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
4 # $Date: 2015/02/28 20:48:54 $
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
5 # $Revision: 1.19 $
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
6 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
7 # Author: Manish Sud <msud@san.rr.com>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
8 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
9 # Copyright (C) 2015 Manish Sud. All rights reserved.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
10 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
11 # This file is part of MayaChemTools.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
12 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
13 # MayaChemTools is free software; you can redistribute it and/or modify it under
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
14 # the terms of the GNU Lesser General Public License as published by the Free
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
15 # Software Foundation; either version 3 of the License, or (at your option) any
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
16 # later version.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
17 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
18 # MayaChemTools is distributed in the hope that it will be useful, but without
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
19 # any warranty; without even the implied warranty of merchantability of fitness
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
20 # for a particular purpose. See the GNU Lesser General Public License for more
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
21 # details.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
22 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
23 # You should have received a copy of the GNU Lesser General Public License
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
24 # along with MayaChemTools; if not, see <http://www.gnu.org/licenses/> or
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
25 # write to the Free Software Foundation Inc., 59 Temple Place, Suite 330,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
26 # Boston, MA, 02111-1307, USA.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
27 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
28
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
29 use strict;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
30 use Carp;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
31 use Exporter;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
32 use Text::ParseWords;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
33 use TextUtil ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
34 use FileUtil ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
35 use MathUtil ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
36 use Fingerprints::Fingerprints;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
37 use Molecule;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
38 use AtomTypes::EStateAtomTypes;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
39 use AtomicDescriptors::EStateValuesDescriptors;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
40
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
41 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
42
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
43 @ISA = qw(Fingerprints::Fingerprints Exporter);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
44 @EXPORT = qw();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
45 @EXPORT_OK = qw();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
46
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
47 %EXPORT_TAGS = (all => [@EXPORT, @EXPORT_OK]);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
48
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
49 # Setup class variables...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
50 my($ClassName);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
51 _InitializeClass();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
52
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
53 # Overload Perl functions...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
54 use overload '""' => 'StringifyEStateIndiciesFingerprints';
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
55
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
56 # Class constructor...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
57 sub new {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
58 my($Class, %NamesAndValues) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
59
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
60 # Initialize object...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
61 my $This = $Class->SUPER::new();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
62 bless $This, ref($Class) || $Class;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
63 $This->_InitializeEStateIndiciesFingerprints();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
64
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
65 $This->_InitializeEStateIndiciesFingerprintsProperties(%NamesAndValues);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
66
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
67 return $This;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
68 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
69
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
70 # Initialize object data...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
71 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
72 sub _InitializeEStateIndiciesFingerprints {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
73 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
74
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
75 # EStateIndicies is a vector containing sum of E-state values for E-state atom types
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
76 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
77 $This->{Type} = 'EStateIndicies';
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
78
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
79 # EStateAtomTypesSetToUse for EStateIndicies:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
80 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
81 # ArbitrarySize - Corrresponds to only E-state atom types detected in molecule
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
82 # FixedSize - Corresponds to fixed number of E-state atom types previously defined [ Ref 77 ]
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
83 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
84 # The default EStateAtomTypesSetToUse value for EStateIndicies fingerprints type: ArbitrarySize.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
85 # Possible values: ArbitrarySize or FixedSize.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
86 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
87 $This->{EStateAtomTypesSetToUse} = '';
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
88
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
89 # Assigned E-state atom types...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
90 %{$This->{EStateAtomTypes}} = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
91
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
92 # Vector values precision for real values during E-state indicies...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
93 $This->{ValuesPrecision} = 3;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
94
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
95 # Calculated E-state values and indicies for generating E-state indicies fingerprints...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
96 %{$This->{EStateValues}} = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
97 %{$This->{EStateIndicies}} = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
98 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
99
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
100 # Initialize class ...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
101 sub _InitializeClass {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
102 #Class name...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
103 $ClassName = __PACKAGE__;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
104
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
105 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
106
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
107 # Initialize object properties....
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
108 sub _InitializeEStateIndiciesFingerprintsProperties {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
109 my($This, %NamesAndValues) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
110
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
111 my($Name, $Value, $MethodName);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
112 while (($Name, $Value) = each %NamesAndValues) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
113 $MethodName = "Set${Name}";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
114 $This->$MethodName($Value);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
115 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
116
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
117 # Make sure molecule object was specified...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
118 if (!exists $NamesAndValues{Molecule}) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
119 croak "Error: ${ClassName}->New: Object can't be instantiated without specifying molecule...";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
120 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
121
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
122 $This->_InitializeEstateIndicies();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
123
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
124 return $This;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
125 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
126
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
127 # Initialize E-state indicies...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
128 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
129 sub _InitializeEstateIndicies {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
130 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
131
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
132 # Set default EStateAtomTypesSetToUse...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
133 if (!$This->{EStateAtomTypesSetToUse}) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
134 $This->{EStateAtomTypesSetToUse} = 'ArbitrarySize';
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
135 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
136
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
137 # Vector type...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
138 $This->{VectorType} = 'FingerprintsVector';
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
139
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
140 if ($This->{EStateAtomTypesSetToUse} =~ /^FixedSize$/i) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
141 $This->{FingerprintsVectorType} = 'OrderedNumericalValues';
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
142 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
143 else {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
144 $This->{FingerprintsVectorType} = 'NumericalValues';
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
145 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
146
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
147 $This->_InitializeFingerprintsVector();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
148
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
149 return $This;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
150 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
151
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
152 # Disable set size method...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
153 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
154 sub SetSize {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
155 my($This, $Type) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
156
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
157 croak "Error: ${ClassName}->SetSize: Can't change size: It's not allowed...";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
158 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
159
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
160 # Set E-state atom types set to use...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
161 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
162 sub SetEStateAtomTypesSetToUse {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
163 my($This, $Value) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
164
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
165 if ($This->{EStateAtomTypesSetToUse}) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
166 croak "Error: ${ClassName}->SetEStateAtomTypesSetToUse: Can't change size: It's already set...";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
167 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
168
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
169 if ($Value !~ /^(ArbitrarySize|FixedSize)/i) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
170 croak "Error: ${ClassName}->SetEStateAtomTypesSetToUse: Unknown EStateAtomTypesSetToUse value: $Value; Supported values: ArbitrarySize or FixedSize";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
171 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
172
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
173 $This->{EStateAtomTypesSetToUse} = $Value;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
174
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
175 return $This;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
176 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
177
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
178 # Set vector values precision for real values for E-state indicies...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
179 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
180 sub SetValuesPrecision {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
181 my($This, $Value) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
182
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
183 if (!TextUtil::IsPositiveInteger($Value)) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
184 croak "Error: ${ClassName}->SetValuesPrecision: ValuesPrecision value, $Value, is not valid: It must be a positive integer...";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
185 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
186 $This->{ValuesPrecision} = $Value;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
187
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
188 return $This;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
189 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
190
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
191 # Generate fingerprints description...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
192 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
193 sub GetDescription {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
194 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
195
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
196 # Is description explicity set?
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
197 if (exists $This->{Description}) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
198 return $This->{Description};
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
199 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
200
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
201 # Generate fingerprints description...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
202
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
203 return "$This->{Type}:$This->{EStateAtomTypesSetToUse}";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
204 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
205
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
206 # Generate electrotopological state indicies (E-state) [ Ref 75-78 ] fingerprints for
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
207 # non-hydrogen atoms in a molecule...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
208 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
209 # EStateIndicies fingerprints constitute a vector containing sum of E-state values
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
210 # for E-state atom types. Two types of E-state atom types set size are allowed:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
211 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
212 # ArbitrarySize - Corrresponds to only E-state atom types detected in molecule
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
213 # FixedSize - Corresponds to fixed number of E-state atom types previously defined
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
214 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
215 # Module AtomTypes::EStateAtomTypes.pm is used to assign E-state atom types to
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
216 # non-hydrogen atoms in the molecule which is able to assign atom types to any valid
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
217 # atom group. However, for FixedSize value of EStateAtomTypesSetToUse, only a fixed
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
218 # set of E-state atom types corresponding to specific atom groups [ Appendix III in
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
219 # Ref 77 ] are used for fingerprints.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
220 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
221 # The fixed size E-state atom type set size used during generation of fingerprints corresponding
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
222 # FixedSize value of EStateAtomTypesSetToUse contains 87 E-state non-hydrogen atom types
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
223 # in EStateAtomTypes.csv data file distributed with MayaChemTools.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
224 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
225 # Combination of Type and EStateAtomTypesSetToUse allow generation of 2 different types of
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
226 # E-state indicies fingerprints:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
227 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
228 # Type EStateAtomTypesSetToUse
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
229 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
230 # EStateIndicies ArbitrarySize [ default fingerprints ]
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
231 # EStateIndicies FixedSize
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
232 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
233 # The default is generate EStateIndicies type fingeprints corresponding to ArbitrarySize as
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
234 # EStateAtomTypesSetToUse value.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
235 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
236 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
237 sub GenerateFingerprints {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
238 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
239
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
240 # Cache appropriate molecule data...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
241 $This->_SetupMoleculeDataCache();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
242
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
243 # Assign E-state atom types...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
244 if (!$This->_AssignEStateAtomTypes()) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
245 carp "Warning: ${ClassName}->GenerateFingerprints: $This->{Type} fingerprints generation didn't succeed: Couldn't assign valid E-state atom types to all atoms...";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
246 return $This;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
247 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
248
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
249 # Calculate E-state indicies...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
250 if (!$This->_CalculateEStateIndicies()) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
251 carp "Warning: ${ClassName}->GenerateFingerprints: $This->{Type} fingerprints generation didn't succeed: Couldn't calculate E-state values for all atoms...";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
252 return $This;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
253 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
254
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
255 # Set final fingerprints...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
256 $This->_SetFinalFingerprints();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
257
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
258 # Clear cached molecule data...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
259 $This->_ClearMoleculeDataCache();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
260
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
261 return $This;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
262 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
263
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
264 # Assign E-state atom types...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
265 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
266 sub _AssignEStateAtomTypes {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
267 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
268 my($EStateAtomTypes, $Atom, $AtomID, $AtomType);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
269
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
270 %{$This->{EStateAtomTypes}} = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
271
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
272 # Assign E-state atom types...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
273 $EStateAtomTypes = new AtomTypes::EStateAtomTypes('Molecule' => $This->{Molecule}, 'IgnoreHydrogens' => 1);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
274 $EStateAtomTypes->AssignAtomTypes();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
275
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
276 # Make sure atom types assignment is successful...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
277 if (!$EStateAtomTypes->IsAtomTypesAssignmentSuccessful()) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
278 return undef;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
279 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
280
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
281 # Collect assigned atom types...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
282 for $Atom (@{$This->{Atoms}}) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
283 $AtomID = $Atom->GetID();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
284
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
285 $AtomType = $EStateAtomTypes->GetAtomType($Atom);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
286 $This->{EStateAtomTypes}{$AtomID} = $AtomType;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
287 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
288 return $This;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
289 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
290
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
291 # Calculate E-state indicies by summing up E-state values for specific
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
292 # E-state atom types...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
293 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
294 sub _CalculateEStateIndicies {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
295 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
296 my($Atom, $AtomID, $AtomType, $EStateValue);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
297
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
298 # Calculate E-state values to generate E-state indicies...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
299 if (!$This->_CalculateEStateValuesDescriptors()) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
300 return undef;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
301 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
302
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
303 # Calculate E-state indicies...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
304 for $Atom (@{$This->{Atoms}}) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
305 $AtomID = $Atom->GetID();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
306
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
307 $AtomType = $This->{EStateAtomTypes}{$AtomID};
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
308 $EStateValue = $This->{EStateValues}{$AtomID};
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
309
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
310 if (!exists $This->{EStateIndicies}{$AtomType}) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
311 $This->{EStateIndicies}{$AtomType} = 0;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
312 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
313
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
314 $This->{EStateIndicies}{$AtomType} += $EStateValue;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
315 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
316 return $This;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
317 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
318
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
319 # Calculate E-state values for E-state indicies...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
320 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
321 sub _CalculateEStateValuesDescriptors {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
322 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
323 my($EStateValuesDescriptors, $Atom, $AtomID, $EStateValue);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
324
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
325 %{$This->{EStateValues}} = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
326
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
327 # Calculate and assign E-state values...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
328 $EStateValuesDescriptors = new AtomicDescriptors::EStateValuesDescriptors('Molecule' => $This->{Molecule});
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
329 $EStateValuesDescriptors->GenerateDescriptors();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
330
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
331 # Make sure E-state values calculation is successful...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
332 if (!$EStateValuesDescriptors->IsDescriptorsGenerationSuccessful()) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
333 return undef;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
334 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
335
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
336 # Collect assigned E-state values...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
337 for $Atom (@{$This->{Atoms}}) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
338 $AtomID = $Atom->GetID();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
339 $EStateValue = $EStateValuesDescriptors->GetDescriptorValue($Atom);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
340 $This->{EStateValues}{$AtomID} = $EStateValue;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
341 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
342 return $This;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
343 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
344
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
345 # Set final final fingerpritns for E-state indicies...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
346 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
347 sub _SetFinalFingerprints {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
348 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
349 my($AtomType, $ValuesPrecision, $EStateAtomTypesDataRef, @Values, @IDs);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
350
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
351 # Mark successful generation of fingerprints...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
352 $This->{FingerprintsGenerated} = 1;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
353
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
354 @Values = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
355 @IDs = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
356
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
357 $ValuesPrecision = $This->{ValuesPrecision};
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
358
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
359 if ($This->{EStateAtomTypesSetToUse} =~ /^FixedSize$/i) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
360 # Use fixed size E-state atom types set for non-hydrogen atoms...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
361 for $AtomType (@{AtomTypes::EStateAtomTypes::GetAllPossibleEStateNonHydrogenAtomTypes()}) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
362 push @IDs, "S${AtomType}";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
363 push @Values, exists($This->{EStateIndicies}{$AtomType}) ? MathUtil::round($This->{EStateIndicies}{$AtomType}, $ValuesPrecision) : 0;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
364 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
365 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
366 else {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
367 for $AtomType (sort keys %{$This->{EStateIndicies}}) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
368 push @IDs, "S${AtomType}";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
369 push @Values, MathUtil::round($This->{EStateIndicies}{$AtomType}, $ValuesPrecision);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
370 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
371 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
372
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
373 # Add IDs and values to fingerprint vector...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
374 if (@IDs) {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
375 $This->{FingerprintsVector}->AddValueIDs(\@IDs);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
376 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
377 $This->{FingerprintsVector}->AddValues(\@Values);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
378
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
379 return $This;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
380 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
381
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
382 # Cache appropriate molecule data...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
383 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
384 sub _SetupMoleculeDataCache {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
385 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
386
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
387 # Get all non-hydrogen atoms...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
388 my($NegateAtomCheckMethod);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
389 $NegateAtomCheckMethod = 1;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
390 @{$This->{Atoms}} = $This->GetMolecule()->GetAtoms("IsHydrogen", $NegateAtomCheckMethod);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
391
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
392 return $This;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
393 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
394
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
395 # Clear cached molecule data...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
396 #
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
397 sub _ClearMoleculeDataCache {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
398 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
399
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
400 @{$This->{Atoms}} = ();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
401
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
402 return $This;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
403 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
404
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
405 # Return a string containg data for EStateIndiciesFingerprints object...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
406 sub StringifyEStateIndiciesFingerprints {
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
407 my($This) = @_;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
408 my($EStateIndiciesFingerprintsString);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
409
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
410 # Type of Keys...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
411 $EStateIndiciesFingerprintsString = "Type: $This->{Type}; EStateAtomTypesSetToUse: $This->{EStateAtomTypesSetToUse}";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
412
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
413 # Fingerprint vector...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
414 $EStateIndiciesFingerprintsString .= "; FingerprintsVector: < $This->{FingerprintsVector} >";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
415
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
416 return $EStateIndiciesFingerprintsString;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
417 }
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
418
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
419 1;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
420
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
421 __END__
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
422
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
423 =head1 NAME
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
424
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
425 EStateIndiciesFingerprints
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
426
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
427 =head1 SYNOPSIS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
428
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
429 use Fingerprints::EStateIndiciesFingerprints;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
430
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
431 use Fingerprints::EStateIndiciesFingerprints qw(:all);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
432
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
433 =head1 DESCRIPTION
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
434
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
435 B<EStateIndiciesFingerprints> [ Ref 75-78 ] class provides the following methods:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
436
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
437 new, GenerateFingerprints, GetDescription, SetEStateAtomTypesSetToUse,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
438 SetValuesPrecision, StringifyEStateIndiciesFingerprints
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
439
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
440 B<EStateIndiciesFingerprints> is derived from B<Fingerprints> class which in turn
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
441 is derived from B<ObjectProperty> base class that provides methods not explicitly defined
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
442 in B<AtomNeighborhoodsFingerprints>, B<Fingerprints> or B<ObjectProperty> classes using Perl's
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
443 AUTOLOAD functionality. These methods are generated on-the-fly for a specified object property:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
444
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
445 Set<PropertyName>(<PropertyValue>);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
446 $PropertyValue = Get<PropertyName>();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
447 Delete<PropertyName>();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
448
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
449 E-state atom types are assigned to all non-hydrogen atoms in a molecule using module
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
450 AtomTypes::EStateAtomTypes.pm and E-state values are calculated using module
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
451 AtomicDescriptors::EStateValues.pm. Using E-state atom types and E-state values,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
452 B<EStateIndiciesFingerprints> constituting sum of E-state values for E-sate atom types
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
453 are generated.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
454
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
455 Two types of E-state atom types set size are allowed:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
456
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
457 ArbitrarySize - Corresponds to only E-state atom types detected
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
458 in molecule
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
459 FixedSize - Corresponds to fixed number of E-state atom types previously
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
460 defined
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
461
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
462 Module AtomTypes::EStateAtomTypes.pm, used to assign E-state atom types to
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
463 non-hydrogen atoms in the molecule, is able to assign atom types to any valid
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
464 atom group. However, for I<FixedSize> value of B<EStateAtomTypesSetToUse>, only a
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
465 fixed set of E-state atom types corresponding to specific atom groups [ Appendix III in
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
466 Ref 77 ] are used for fingerprints.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
467
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
468 The fixed size E-state atom type set size used during generation of fingerprints contains
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
469 87 E-state non-hydrogen atom types in EStateAtomTypes.csv data file distributed with
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
470 MayaChemTools.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
471
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
472 Combination of Type and EStateAtomTypesSetToUse allow generation of 2 different types of
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
473 E-state indicies fingerprints:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
474
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
475 Type EStateAtomTypesSetToUse
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
476
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
477 EStateIndicies ArbitrarySize [ default fingerprints ]
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
478 EStateIndicies FixedSize
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
479
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
480 The current release of MayaChemTools generates the following types of E-state
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
481 fingerprints vector strings:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
482
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
483 FingerprintsVector;EStateIndicies:ArbitrarySize;11;NumericalValues;IDs
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
484 AndValuesString;SaaCH SaasC SaasN SdO SdssC SsCH3 SsF SsOH SssCH2 SssN
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
485 H SsssCH;24.778 4.387 1.993 25.023 -1.435 3.975 14.006 29.759 -0.073 3
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
486 .024 -2.270
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
487
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
488 FingerprintsVector;EStateIndicies:FixedSize;87;OrderedNumericalValues;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
489 ValuesString;0 0 0 0 0 0 0 3.975 0 -0.073 0 0 24.778 -2.270 0 0 -1.435
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
490 4.387 0 0 0 0 0 0 3.024 0 0 0 0 0 0 0 1.993 0 29.759 25.023 0 0 0 0 1
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
491 4.006 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
492 0 0 0 0 0 0 0 0 0 0 0 0 0 0
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
493
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
494 FingerprintsVector;EStateIndicies:FixedSize;87;OrderedNumericalValues;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
495 IDsAndValuesString;SsLi SssBe SssssBem SsBH2 SssBH SsssB SssssBm SsCH3
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
496 SdCH2 SssCH2 StCH SdsCH SaaCH SsssCH SddC StsC SdssC SaasC SaaaC Sssss
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
497 C SsNH3p SsNH2 SssNH2p SdNH SssNH SaaNH StN SsssNHp SdsN SaaN SsssN Sd
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
498 0 0 0 0 0 0 0 3.975 0 -0.073 0 0 24.778 -2.270 0 0 -1.435 4.387 0 0 0
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
499 0 0 0 3.024 0 0 0 0 0 0 0 1.993 0 29.759 25.023 0 0 0 0 14.006 0 0 0 0
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
500 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0...
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
501
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
502 =head2 METHODS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
503
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
504 =over 4
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
505
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
506 =item B<new>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
507
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
508 $EStateIndiciesFingerprints = new EStateIndiciesFingerprints(%NamesAndValues);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
509
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
510 Using specified I<EStateIndiciesFingerprints> property names and values hash, B<new> method creates a new object
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
511 and returns a reference to newly created B<PathLengthFingerprints> object. By default, the
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
512 following properties are initialized:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
513
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
514 Molecule = '';
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
515 Type = 'EStateIndicies'
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
516 EStateAtomTypesSetToUse = 'ArbitrarySize'
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
517 ValuesPrecision = 3
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
518
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
519 Examples:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
520
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
521 $EStateIndiciesFingerprints = new AtomTypesFingerprints(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
522 'Molecule' => $Molecule,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
523 'EStateAtomTypesSetToUse' =>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
524 'ArbitrarySize');
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
525
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
526 $EStateIndiciesFingerprints = new AtomTypesFingerprints(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
527 'Molecule' => $Molecule,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
528 'EStateAtomTypesSetToUse' =>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
529 'FixedSize');
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
530
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
531 $EStateIndiciesFingerprints->GenerateFingerprints();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
532 print "$EStateIndiciesFingerprints\n";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
533
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
534 =item B<GenerateFingerprints>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
535
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
536 $EStateIndiciesFingerprints = $EStateIndiciesFingerprints->
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
537 GenerateEStateIndiciesFingerprints();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
538
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
539 Generates EState keys fingerprints and returns I<EStateIndiciesFingerprints>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
540
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
541 =item B<GetDescription>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
542
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
543 $Description = $EStateIndiciesFingerprints->GetDescription();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
544
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
545 Returns a string containing description of EState keys fingerprints.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
546
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
547 =item B<SetEStateAtomTypesSetToUse>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
548
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
549 $EStateIndiciesFingerprints->SetEStateAtomTypesSetToUse($Value);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
550
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
551 Sets I<Value> of I<EStateAtomTypesSetToUse> and returns I<EStateIndiciesFingerprints>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
552 Possible values: I<ArbitrarySize or FixedSize>. Default value: I<ArbitrarySize>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
553
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
554 =item B<SetValuesPrecision>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
555
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
556 $EStateIndiciesFingerprints->SetValuesPrecision($Precision);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
557
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
558 Sets precesion of E-state values to use during generation of E-state indices fingerprints
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
559 and returns I<EStateIndiciesFingerprints>. Possible values: I<Positive integers>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
560 Default value: I<3>.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
561
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
562 =item B<StringifyEStateIndiciesFingerprints>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
563
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
564 $String = $EStateIndiciesFingerprints->StringifyEStateIndiciesFingerprints();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
565
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
566 Returns a string containing information about I<EStateIndiciesFingerprints> object.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
567
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
568 =back
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
569
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
570 =head1 AUTHOR
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
571
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
572 Manish Sud <msud@san.rr.com>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
573
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
574 =head1 SEE ALSO
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
575
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
576 Fingerprints.pm, FingerprintsStringUtil.pm, AtomNeighborhoodsFingerprints.pm, AtomTypesFingerprints.pm,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
577 ExtendedConnectivityFingerprints.pm, MACCSKeys.pm, PathLengthFingerprints.pm,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
578 TopologicalAtomPairsFingerprints.pm, TopologicalAtomTripletsFingerprints.pm,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
579 TopologicalAtomTorsionsFingerprints.pm, TopologicalPharmacophoreAtomPairsFingerprints.pm,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
580 TopologicalPharmacophoreAtomTripletsFingerprints.pm
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
581
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
582 =head1 COPYRIGHT
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
583
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
584 Copyright (C) 2015 Manish Sud. All rights reserved.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
585
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
586 This file is part of MayaChemTools.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
587
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
588 MayaChemTools is free software; you can redistribute it and/or modify it under
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
589 the terms of the GNU Lesser General Public License as published by the Free
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
590 Software Foundation; either version 3 of the License, or (at your option)
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
591 any later version.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
592
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
593 =cut