annotate mayachemtools/lib/MolecularDescriptors/MolecularDescriptors.pm @ 2:dfff2614510e draft

Deleted selected files
author deepakjadmin
date Wed, 20 Jan 2016 12:15:15 -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 package MolecularDescriptors::MolecularDescriptors;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
2 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
3 # $RCSfile: MolecularDescriptors.pm,v $
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
4 # $Date: 2015/02/28 20:49:20 $
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
5 # $Revision: 1.14 $
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
6 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
7 # Author: Manish Sud <msud@san.rr.com>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
8 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
9 # Copyright (C) 2015 Manish Sud. All rights reserved.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
10 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
11 # This file is part of MayaChemTools.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
12 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
13 # MayaChemTools is free software; you can redistribute it and/or modify it under
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
14 # the terms of the GNU Lesser General Public License as published by the Free
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
15 # Software Foundation; either version 3 of the License, or (at your option) any
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
16 # later version.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
17 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
18 # MayaChemTools is distributed in the hope that it will be useful, but without
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
19 # any warranty; without even the implied warranty of merchantability of fitness
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
20 # for a particular purpose. See the GNU Lesser General Public License for more
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
21 # details.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
22 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
23 # You should have received a copy of the GNU Lesser General Public License
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
24 # along with MayaChemTools; if not, see <http://www.gnu.org/licenses/> or
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
25 # write to the Free Software Foundation Inc., 59 Temple Place, Suite 330,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
26 # Boston, MA, 02111-1307, USA.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
27 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
28
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
29 use strict;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
30 use Carp;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
31 use Exporter;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
32 use Scalar::Util ();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
33 use ObjectProperty;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
34 use TextUtil ();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
35
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
36 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
37
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
38 @ISA = qw(ObjectProperty Exporter);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
39 @EXPORT = qw();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
40 @EXPORT_OK = qw();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
41
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
42 %EXPORT_TAGS = (all => [@EXPORT, @EXPORT_OK]);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
43
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
44 # Setup class variables...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
45 my($ClassName);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
46 _InitializeClass();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
47
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
48 # Class constructor...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
49 sub new {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
50 my($Class, %NamesAndValues) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
51
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
52 # Initialize object...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
53 my $This = {};
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
54 bless $This, ref($Class) || $Class;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
55 $This->_InitializeMolecularDescriptors();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
56
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
57 $This->_InitializeMolecularDescriptorsProperties(%NamesAndValues);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
58
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
59 return $This;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
60 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
61
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
62 # Initialize object data...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
63 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
64 sub _InitializeMolecularDescriptors {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
65 my($This) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
66
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
67 # Molecule object...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
68 $This->{Molecule} = '';
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
69
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
70 # Type of molecular descriptors...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
71 $This->{Type} = '';
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
72
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
73 # Names and calculated value of molecular descriptors...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
74 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
75 # The specific descriptor class, derived from this base class, populate descriptor names and values
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
76 # arrays...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
77 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
78 @{$This->{DescriptorNames}} = ();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
79 @{$This->{DescriptorValues}} = ();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
80
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
81 # Marks successful generation of descriptors...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
82 $This->{DescriptorsGenerated} = 0;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
83
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
84 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
85
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
86 # Initialize class ...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
87 sub _InitializeClass {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
88 #Class name...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
89 $ClassName = __PACKAGE__;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
90 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
91
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
92
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
93 # Initialize object properties....
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
94 sub _InitializeMolecularDescriptorsProperties {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
95 my($This, %NamesAndValues) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
96
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
97 my($Name, $Value, $MethodName);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
98 while (($Name, $Value) = each %NamesAndValues) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
99 $MethodName = "Set${Name}";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
100 $This->$MethodName($Value);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
101 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
102
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
103 return $This;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
104 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
105
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
106 # Initialize descriptor names and values...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
107 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
108 sub _InitializeDescriptorNamesAndValues {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
109 my($This, @Names) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
110
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
111 @{$This->{DescriptorNames}} = @Names;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
112
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
113 $This->_InitializeDescriptorValues();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
114
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
115 return $This;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
116 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
117
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
118 # Initialize descriptor values...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
119 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
120 sub _InitializeDescriptorValues {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
121 my($This) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
122
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
123 $This->{DescriptorsGenerated} = 0;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
124
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
125 @{$This->{DescriptorValues}} = ();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
126
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
127 return $This;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
128 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
129
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
130 # Set molecule object...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
131 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
132 sub SetMolecule {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
133 my($This, $Molecule) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
134
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
135 $This->{Molecule} = $Molecule;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
136
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
137 # Weaken the reference to disable increment of reference count...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
138 Scalar::Util::weaken($This->{Molecule});
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
139
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
140 return $This;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
141 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
142
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
143 # Set type and make sure it's not already set...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
144 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
145 sub SetType {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
146 my($This, $Type) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
147
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
148 if ($This->{Type}) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
149 croak "Error: ${ClassName}->SetType: Can't change MolecularDescriptors type: It's already set...";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
150 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
151 $This->{Type} = $Type;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
152
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
153 return $This;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
154 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
155
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
156 # Get molecular descriptor names as an array...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
157 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
158 sub GetDescriptorNames {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
159 my($This) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
160
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
161 return @{$This->{DescriptorNames}};
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
162 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
163
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
164 # Set descriptor names...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
165 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
166 sub SetDescriptorNames {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
167 my($This, @Names) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
168
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
169 @{$This->{DescriptorNames}} = @Names;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
170
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
171 return $This;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
172 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
173
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
174 # Add descriptor names...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
175 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
176 sub AddDescriptorNames {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
177 my($This, @Names) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
178
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
179 push @{$This->{DescriptorNames}}, @Names;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
180
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
181 return $This;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
182 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
183
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
184 # Set descriptor values...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
185 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
186 sub SetDescriptorValues {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
187 my($This, @Values) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
188
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
189 @{$This->{DescriptorValues}} = @Values;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
190
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
191 return $This;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
192 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
193
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
194 # Add descriptor values...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
195 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
196 sub AddDescriptorValues {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
197 my($This, @Values) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
198
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
199 push @{$This->{DescriptorValues}}, @Values;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
200
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
201 return $This;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
202 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
203
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
204 # Is descriptors generation successful?
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
205 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
206 # Notes:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
207 # . The specific molecular descriptor class generation class sets the value of
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
208 # DescriptorsCalculated to 1 after the successful generation of descriptors;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
209 # otherwise, it's set to 0.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
210 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
211 sub IsDescriptorsGenerationSuccessful {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
212 my($This) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
213
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
214 return $This->{DescriptorsGenerated} ? 1 : 0;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
215 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
216
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
217 # Get all descriptor values as an array...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
218 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
219 sub GetDescriptorValues {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
220 my($This) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
221
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
222 if ($This->{DescriptorsGenerated}) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
223 return wantarray ? @{$This->{DescriptorValues}} : scalar @{$This->{DescriptorValues}};
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
224 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
225 else {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
226 my(@DescriptorValues);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
227
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
228 @DescriptorValues = ('None') x scalar @{$This->{DescriptorNames}};
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
229
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
230 return wantarray ? @DescriptorValues : scalar @DescriptorValues;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
231 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
232 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
233
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
234 # Get descriptor value for a specified descriptor name...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
235 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
236 sub GetDescriptorValueByName {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
237 my($This, $Name) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
238 my(%NamesAndValues);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
239
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
240 %NamesAndValues = $This->GetDescriptorNamesAndValues();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
241
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
242 return exists $NamesAndValues{$Name} ? $NamesAndValues{$Name} : 'None';
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
243
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
244 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
245
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
246 # Get calculated molecular descriptor names sand values as a to a hash with names
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
247 # and values as key/value pairs...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
248 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
249 sub GetDescriptorNamesAndValues {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
250 my($This) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
251 my(%NamesAndValues);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
252
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
253 %NamesAndValues = ();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
254 @NamesAndValues{ @{$This->{DescriptorNames}} } = $This->GetDescriptorValues();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
255
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
256 return %NamesAndValues;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
257 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
258
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
259 # Return a string containing descriptor names and values...
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
260 #
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
261 sub _StringifyDescriptorNamesAndValues {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
262 my($This) = @_;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
263 my($NamesAndValuesString, $Name, $Value, @NamesAndValuesInfo, %NamesAndValues);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
264
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
265 @NamesAndValuesInfo = ();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
266 %NamesAndValues = $This->GetDescriptorNamesAndValues();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
267
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
268 for $Name (@{$This->{DescriptorNames}}) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
269 $Value = $NamesAndValues{$Name};
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
270 $Value = (TextUtil::IsEmpty($Value) || $Value =~ /^None$/i) ? 'None' : $Value;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
271 push @NamesAndValuesInfo, "$Name - $Value";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
272 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
273 if (@NamesAndValuesInfo) {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
274 $NamesAndValuesString = "Names - Values: <" . TextUtil::JoinWords(\@NamesAndValuesInfo, ", ", 0) . ">";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
275 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
276 else {
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
277 $NamesAndValuesString = "Names - Values: < None>";
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
278 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
279 return $NamesAndValuesString;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
280 }
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
281
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
282 1;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
283
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
284 __END__
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
285
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
286 =head1 NAME
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
287
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
288 MolecularDescriptors - MolecularDescriptors class
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
289
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
290 =head1 SYNOPSIS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
291
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
292 use MolecularDescriptors::MolecularDescriptors;
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
293
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
294 use MolecularDescriptors::MolecularDescriptors qw(:all);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
295
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
296 =head1 DESCRIPTION
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
297
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
298 B<MolecularDescriptors> base class used to derive all other molecular descriptors classes provides the following methods:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
299
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
300 new, AddDescriptorNames, AddDescriptorValues, GetDescriptorNames,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
301 GetDescriptorNamesAndValues, GetDescriptorValueByName, GetDescriptorValues,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
302 IsDescriptorsGenerationSuccessful, SetDescriptorNames, SetDescriptorValues,
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
303 SetMolecule, SetType
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
304
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
305 B<MolecularDescriptors> class is derived from B<ObjectProperty> base class which provides methods not
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
306 explicitly defined in B<Fingerprints> or B<ObjectProperty> classes using Perl's AUTOLOAD functionality.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
307 These methods are generated on-the-fly for a specified object property:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
308
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
309 Set<PropertyName>(<PropertyValue>);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
310 $PropertyValue = Get<PropertyName>();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
311 Delete<PropertyName>();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
312
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
313 =head2 METHODS
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
314
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
315 =over 4
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
316
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
317 =item B<new>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
318
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
319 $NewMolecularDescriptors = new MolecularDescriptors::
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
320 MolecularDescriptors(%NamesAndValues);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
321
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
322 Using specified I<MolecularDescriptors> property names and values hash, B<new> method creates a new object
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
323 and returns a reference to newly created B<MolecularDescriptors> object. By default, following properties are
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
324 initialized:
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
325
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
326 Molecule = '';
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
327 Type = '';
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
328
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
329 =item B<AddDescriptorNames>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
330
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
331 $MolecularDescriptors->AddDescriptorNames(@Name);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
332
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
333 Adds specified descriptor I<Names> to the list of available descriptor names and returns
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
334 I<MolecularDescriptors>.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
335
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
336 =item B<AddDescriptorValues>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
337
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
338 $MolecularDescriptors->AddDescriptorValues(@Values);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
339
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
340 Adds specified descriptor I<Values> to the list of calculated descriptor values and returns
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
341 I<MolecularDescriptors>.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
342
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
343 =item B<GetDescriptorNames>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
344
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
345 @Names = $MolecularDescriptors->GetDescriptorNames();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
346
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
347 Returns an array containing all available descriptor names.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
348
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
349 =item B<GetDescriptorNamesAndValues>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
350
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
351 %NamesAndValuesReturn = $MolecularDescriptors->
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
352 GetDescriptorNamesAndValues();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
353
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
354 Returns a hash containing all available descriptor names and calculated values.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
355
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
356 =item B<GetDescriptorValueByName>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
357
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
358 $Value = $MolecularDescriptors->
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
359 GetDescriptorValueByName($Name);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
360
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
361 Returns calculated value for a specified descriptor name. A string B<None> is returned for
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
362 unknown descriptor names or for those descriptors whose values haven't been calculated.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
363
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
364 =item B<GetDescriptorValues>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
365
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
366 @Values = $MolecularDescriptors->GetDescriptorValues();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
367
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
368 Returns an array containing calculated descriptor values for all available descriptors.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
369 Unless B<CalculateDescriptorsValues> method has been successfully invoked on a
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
370 I<MolecularDescriptors> object, value of each descriptor corresponds to string B<None>.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
371
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
372 =item B<IsDescriptorsGenerationSuccessful>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
373
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
374 $Status = $MolecularDescriptors->
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
375 IsDescriptorsGenerationSuccessful();
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
376
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
377 Returns 1 or 0 based on whether molecular descriptors generation was successful.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
378 For a successful molecular descriptors calculation, all available descriptors must have
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
379 a values other than a string I<None> which are set by B<CalculateDescriptorsValues>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
380 method after successful completion of descriptors calculation.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
381
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
382 =item B<SetDescriptorNames>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
383
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
384 $MolecularDescriptors->SetDescriptorNames(@Names);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
385
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
386 Sets names of available descriptors to specified names and returns I<MolecularDescriptors>.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
387
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
388 =item B<SetDescriptorValues>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
389
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
390 $MolecularDescriptors->SetDescriptorValues(@Values);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
391
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
392 Sets values of available descriptors to specified values and returns I<MolecularDescriptors>.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
393
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
394 =item B<SetMolecule>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
395
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
396 $MolecularDescriptors->SetMolecule($Molecule);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
397
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
398 Sets molecule to use during calculation of molecular descriptors and returns I<MolecularDescriptors>.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
399
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
400 =item B<SetType>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
401
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
402 $MolecularDescriptors->SetType($Type);
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
403
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
404 Sets I<Type> for I<MolecularDescriptors> object and returns I<MolecularDescriptors>.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
405
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
406 =back
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
407
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
408 =head1 AUTHOR
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
409
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
410 Manish Sud <msud@san.rr.com>
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
411
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
412 =head1 SEE ALSO
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
413
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
414 MolecularDescriptorsGenerator.pm
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
415
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
416 =head1 COPYRIGHT
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
417
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
418 Copyright (C) 2015 Manish Sud. All rights reserved.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
419
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
420 This file is part of MayaChemTools.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
421
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
422 MayaChemTools is free software; you can redistribute it and/or modify it under
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
423 the terms of the GNU Lesser General Public License as published by the Free
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
424 Software Foundation; either version 3 of the License, or (at your option)
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
425 any later version.
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
426
73ae111cf86f Uploaded
deepakjadmin
parents:
diff changeset
427 =cut