Mercurial > repos > deepakjadmin > mayatool3_test3
comparison mayachemtools/docs/modules/man3/MolecularComplexityDescriptors.3 @ 0:73ae111cf86f draft
Uploaded
author | deepakjadmin |
---|---|
date | Wed, 20 Jan 2016 11:55:01 -0500 |
parents | |
children |
comparison
equal
deleted
inserted
replaced
-1:000000000000 | 0:73ae111cf86f |
---|---|
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.22) | |
2 .\" | |
3 .\" Standard preamble: | |
4 .\" ======================================================================== | |
5 .de Sp \" Vertical space (when we can't use .PP) | |
6 .if t .sp .5v | |
7 .if n .sp | |
8 .. | |
9 .de Vb \" Begin verbatim text | |
10 .ft CW | |
11 .nf | |
12 .ne \\$1 | |
13 .. | |
14 .de Ve \" End verbatim text | |
15 .ft R | |
16 .fi | |
17 .. | |
18 .\" Set up some character translations and predefined strings. \*(-- will | |
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left | |
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will | |
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and | |
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, | |
23 .\" nothing in troff, for use with C<>. | |
24 .tr \(*W- | |
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' | |
26 .ie n \{\ | |
27 . ds -- \(*W- | |
28 . ds PI pi | |
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch | |
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch | |
31 . ds L" "" | |
32 . ds R" "" | |
33 . ds C` "" | |
34 . ds C' "" | |
35 'br\} | |
36 .el\{\ | |
37 . ds -- \|\(em\| | |
38 . ds PI \(*p | |
39 . ds L" `` | |
40 . ds R" '' | |
41 'br\} | |
42 .\" | |
43 .\" Escape single quotes in literal strings from groff's Unicode transform. | |
44 .ie \n(.g .ds Aq \(aq | |
45 .el .ds Aq ' | |
46 .\" | |
47 .\" If the F register is turned on, we'll generate index entries on stderr for | |
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index | |
49 .\" entries marked with X<> in POD. Of course, you'll have to process the | |
50 .\" output yourself in some meaningful fashion. | |
51 .ie \nF \{\ | |
52 . de IX | |
53 . tm Index:\\$1\t\\n%\t"\\$2" | |
54 .. | |
55 . nr % 0 | |
56 . rr F | |
57 .\} | |
58 .el \{\ | |
59 . de IX | |
60 .. | |
61 .\} | |
62 .\" | |
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). | |
64 .\" Fear. Run. Save yourself. No user-serviceable parts. | |
65 . \" fudge factors for nroff and troff | |
66 .if n \{\ | |
67 . ds #H 0 | |
68 . ds #V .8m | |
69 . ds #F .3m | |
70 . ds #[ \f1 | |
71 . ds #] \fP | |
72 .\} | |
73 .if t \{\ | |
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m) | |
75 . ds #V .6m | |
76 . ds #F 0 | |
77 . ds #[ \& | |
78 . ds #] \& | |
79 .\} | |
80 . \" simple accents for nroff and troff | |
81 .if n \{\ | |
82 . ds ' \& | |
83 . ds ` \& | |
84 . ds ^ \& | |
85 . ds , \& | |
86 . ds ~ ~ | |
87 . ds / | |
88 .\} | |
89 .if t \{\ | |
90 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" | |
91 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' | |
92 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' | |
93 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' | |
94 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' | |
95 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' | |
96 .\} | |
97 . \" troff and (daisy-wheel) nroff accents | |
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' | |
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H' | |
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] | |
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' | |
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' | |
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] | |
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] | |
105 .ds ae a\h'-(\w'a'u*4/10)'e | |
106 .ds Ae A\h'-(\w'A'u*4/10)'E | |
107 . \" corrections for vroff | |
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' | |
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' | |
110 . \" for low resolution devices (crt and lpr) | |
111 .if \n(.H>23 .if \n(.V>19 \ | |
112 \{\ | |
113 . ds : e | |
114 . ds 8 ss | |
115 . ds o a | |
116 . ds d- d\h'-1'\(ga | |
117 . ds D- D\h'-1'\(hy | |
118 . ds th \o'bp' | |
119 . ds Th \o'LP' | |
120 . ds ae ae | |
121 . ds Ae AE | |
122 .\} | |
123 .rm #[ #] #H #V #F C | |
124 .\" ======================================================================== | |
125 .\" | |
126 .IX Title "MOLECULARCOMPLEXITYDESCRIPTORS 1" | |
127 .TH MOLECULARCOMPLEXITYDESCRIPTORS 1 "2015-03-29" "perl v5.14.2" "MayaChemTools" | |
128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes | |
129 .\" way too many mistakes in technical documents. | |
130 .if n .ad l | |
131 .nh | |
132 .SH "NAME" | |
133 MolecularComplexityDescriptors | |
134 .SH "SYNOPSIS" | |
135 .IX Header "SYNOPSIS" | |
136 use MolecularDescriptors::MolecularComplexityDescriptors; | |
137 .PP | |
138 use MolecularDescriptors::MolecularComplexityDescriptors qw(:all); | |
139 .SH "DESCRIPTION" | |
140 .IX Header "DESCRIPTION" | |
141 \&\fBMolecularComplexityDescriptors\fR class provides the following methods: | |
142 .PP | |
143 new, GenerateDescriptors, GetDescriptorNames, | |
144 GetMolecularComplexityTypeAbbreviation, MACCSKeysSize, SetAtomIdentifierType, | |
145 SetAtomicInvariantsToUse, SetDistanceBinSize, SetFunctionalClassesToUse, | |
146 SetMaxDistance, SetMaxPathLength, SetMinDistance, SetMinPathLength, | |
147 SetMolecularComplexityType, SetNeighborhoodRadius, SetNormalizationMethodology, | |
148 StringifyMolecularComplexityDescriptors | |
149 .PP | |
150 \&\fBMolecularComplexityDescriptors\fR is derived from \fBMolecularDescriptors\fR class which in turn | |
151 is derived from \fBObjectProperty\fR base class that provides methods not explicitly defined | |
152 in \fBMolecularComplexityDescriptors\fR, \fBMolecularDescriptors\fR or \fBObjectProperty\fR classes using Perl's | |
153 \&\s-1AUTOLOAD\s0 functionality. These methods are generated on-the-fly for a specified object property: | |
154 .PP | |
155 .Vb 3 | |
156 \& Set<PropertyName>(<PropertyValue>); | |
157 \& $PropertyValue = Get<PropertyName>(); | |
158 \& Delete<PropertyName>(); | |
159 .Ve | |
160 .PP | |
161 The current release of MayaChemTools supports calculation of molecular complexity using | |
162 \&\fIMolecularComplexityType\fR parameter corresponding to number of bits-set or unique | |
163 keys [ Ref 117\-119 ] in molecular fingerprints. The valid values for \fIMolecularComplexityType\fR | |
164 are: | |
165 .PP | |
166 .Vb 9 | |
167 \& AtomTypesFingerprints | |
168 \& ExtendedConnectivityFingerprints | |
169 \& MACCSKeys | |
170 \& PathLengthFingerprints | |
171 \& TopologicalAtomPairsFingerprints | |
172 \& TopologicalAtomTripletsFingerprints | |
173 \& TopologicalAtomTorsionsFingerprints | |
174 \& TopologicalPharmacophoreAtomPairsFingerprints | |
175 \& TopologicalPharmacophoreAtomTripletsFingerprints | |
176 .Ve | |
177 .PP | |
178 Default value for \fIMolecularComplexityType\fR: \fIMACCSKeys\fR. | |
179 .PP | |
180 \&\fIAtomIdentifierType\fR parameter name corresponds to atom types used during generation of | |
181 fingerprints. The valid values for \fIAtomIdentifierType\fR are: \fIAtomicInvariantsAtomTypes, | |
182 DREIDINGAtomTypes, EStateAtomTypes, FunctionalClassAtomTypes, MMFF94AtomTypes, | |
183 SLogPAtomTypes, SYBYLAtomTypes, TPSAAtomTypes, UFFAtomTypes\fR. \fIAtomicInvariantsAtomTypes\fR | |
184 is not supported for following values of \fIMolecularComplexityType\fR: \fIMACCSKeys, | |
185 TopologicalPharmacophoreAtomPairsFingerprints, TopologicalPharmacophoreAtomTripletsFingerprints\fR. | |
186 \&\fIFunctionalClassAtomTypes\fR is the only valid value of \fIAtomIdentifierType\fR for topological | |
187 pharmacophore fingerprints. | |
188 .PP | |
189 Default value for \fIAtomIdentifierType\fR: \fIAtomicInvariantsAtomTypes\fR for all fingerprints; | |
190 \&\fIFunctionalClassAtomTypes\fR for topological pharmacophore fingerprints. | |
191 .PP | |
192 \&\fIAtomicInvariantsToUse\fR parameter name and values are used during \fIAtomicInvariantsAtomTypes\fR | |
193 value of parameter \fIAtomIdentifierType\fR. It's a list of space separated valid atomic invariant atom types. | |
194 .PP | |
195 Possible values for atomic invariants are: \fI\s-1AS\s0, X, \s-1BO\s0, \s-1LBO\s0, \s-1SB\s0, \s-1DB\s0, \s-1TB\s0, H, Ar, \s-1RA\s0, \s-1FC\s0, \s-1MN\s0, \s-1SM\s0\fR. | |
196 Default value for \fIAtomicInvariantsToUse\fR parameter are set differently for different fingerprints | |
197 using \fIMolecularComplexityType\fR parameter as shown below: | |
198 .PP | |
199 .Vb 1 | |
200 \& MolecularComplexityType AtomicInvariantsToUse | |
201 \& | |
202 \& AtomTypesFingerprints AS X BO H FC | |
203 \& TopologicalAtomPairsFingerprints AS X BO H FC | |
204 \& TopologicalAtomTripletsFingerprints AS X BO H FC | |
205 \& TopologicalAtomTorsionsFingerprints AS X BO H FC | |
206 \& | |
207 \& ExtendedConnectivityFingerprints AS X BO H FC MN | |
208 \& PathLengthFingerprints AS | |
209 .Ve | |
210 .PP | |
211 \&\fIFunctionalClassesToUse\fR parameter name and values are used during \fIFunctionalClassAtomTypes\fR | |
212 value of parameter \fIAtomIdentifierType\fR. It's a list of space separated valid atomic invariant atom types. | |
213 .PP | |
214 Possible values for atom functional classes are: \fIAr, \s-1CA\s0, H, \s-1HBA\s0, \s-1HBD\s0, Hal, \s-1NI\s0, \s-1PI\s0, \s-1RA\s0\fR. | |
215 .PP | |
216 Default value for \fIFunctionalClassesToUse\fR parameter is set to: | |
217 .PP | |
218 .Vb 1 | |
219 \& HBD HBA PI NI Ar Hal | |
220 .Ve | |
221 .PP | |
222 for all fingerprints except for the following two \fIMolecularComplexityType\fR fingerints: | |
223 .PP | |
224 .Vb 1 | |
225 \& MolecularComplexityType FunctionalClassesToUse | |
226 \& | |
227 \& TopologicalPharmacophoreAtomPairsFingerprints HBD HBA P, NI H | |
228 \& TopologicalPharmacophoreAtomTripletsFingerprints HBD HBA PI NI H Ar | |
229 .Ve | |
230 .PP | |
231 \&\fIMACCSKeysSize\fR parameter name is only used during \fIMACCSKeys\fR value of | |
232 \&\fIMolecularComplexityType\fR and corresponds to size of \s-1MACCS\s0 key set. Possible | |
233 values: \fI166 or 322\fR. Default value: \fI166\fR. | |
234 .PP | |
235 \&\fINeighborhoodRadius\fR parameter name is only used during \fIExtendedConnectivityFingerprints\fR | |
236 value of \fIMolecularComplexityType\fR and corresponds to atomic neighborhoods radius for | |
237 generating extended connectivity fingerprints. Possible values: positive integer. Default value: | |
238 \&\fI2\fR. | |
239 .PP | |
240 \&\fIMinPathLength\fR and \fIMaxPathLength\fR parameters are only used during \fIPathLengthFingerprints\fR | |
241 value of \fIMolecularComplexityType\fR and correspond to minimum and maximum path lengths to use | |
242 for generating path length fingerprints. Possible values: positive integers. Default value: \fIMinPathLength \- 1\fR; | |
243 \&\fIMaxPathLength \- 8\fR. | |
244 .PP | |
245 \&\fIUseBondSymbols\fR parameter is only used during \fIPathLengthFingerprints\fR value of | |
246 \&\fIMolecularComplexityType\fR and indicates whether bond symbols are included in atom path | |
247 strings used to generate path length fingerprints. Possible value: \fIYes or No\fR. Default value: | |
248 \&\fIYes\fR. | |
249 .PP | |
250 \&\fIMinDistance\fR and \fIMaxDistance\fR parameters are only used during \fITopologicalAtomPairsFingerprints\fR | |
251 and \fITopologicalAtomTripletsFingerprints\fR values of \fIMolecularComplexityType\fR and correspond to | |
252 minimum and maximum bond distance between atom pairs during topological pharmacophore fingerprints. | |
253 Possible values: positive integers. Default value: \fIMinDistance \- 1\fR; \fIMaxDistance \- 10\fR. | |
254 .PP | |
255 \&\fIUseTriangleInequality\fR parameter is used during these values for \fIMolecularComplexityType\fR: | |
256 \&\fITopologicalAtomTripletsFingerprints\fR and \fITopologicalPharmacophoreAtomTripletsFingerprints\fR. | |
257 Possible values: \fIYes or No\fR. It determines wheter to apply triangle inequality to distance triplets. | |
258 Default value: \fITopologicalAtomTripletsFingerprints \- No\fR; | |
259 \&\fITopologicalPharmacophoreAtomTripletsFingerprints \- Yes\fR. | |
260 .PP | |
261 \&\fIDistanceBinSize\fR parameter is used during \fITopologicalPharmacophoreAtomTripletsFingerprints\fR | |
262 value of \fIMolecularComplexityType\fR and corresponds to distance bin size used for binning | |
263 distances during generation of topological pharmacophore atom triplets fingerprints. Possible | |
264 value: positive integer. Default value: \fI2\fR. | |
265 .PP | |
266 \&\fINormalizationMethodology\fR is only used for these values for \fIMolecularComplexityType\fR: | |
267 \&\fIExtendedConnectivityFingerprints\fR, \fITopologicalPharmacophoreAtomPairsFingerprints\fR | |
268 and \fITopologicalPharmacophoreAtomTripletsFingerprints\fR. It corresponds to normalization | |
269 methodology to use for scaling the number of bits-set or unique keys during generation of | |
270 fingerprints. Possible values during \fIExtendedConnectivityFingerprints\fR: \fINone or | |
271 ByHeavyAtomsCount\fR; Default value: \fINone\fR. Possible values during topological | |
272 pharmacophore atom pairs and triplets fingerprints: \fINone or ByPossibleKeysCount\fR; | |
273 Default value: \fINone\fR. \fIByPossibleKeysCount\fR corresponds to total number of | |
274 possible topological pharmacophore atom pairs or triplets in a molecule. | |
275 .SS "\s-1METHODS\s0" | |
276 .IX Subsection "METHODS" | |
277 .IP "\fBnew\fR" 4 | |
278 .IX Item "new" | |
279 .Vb 3 | |
280 \& $NewMolecularComplexityDescriptors = new MolecularDescriptors:: | |
281 \& MolecularComplexityDescriptors( | |
282 \& %NamesAndValues); | |
283 .Ve | |
284 .Sp | |
285 Using specified \fIMolecularComplexityDescriptors\fR property names and values hash, \fBnew\fR | |
286 method creates a new object and returns a reference to newly created \fBMolecularComplexityDescriptors\fR | |
287 object. By default, the following properties are initialized: | |
288 .Sp | |
289 .Vb 10 | |
290 \& Molecule = \*(Aq\*(Aq | |
291 \& Type = \*(AqMolecularComplexity\*(Aq | |
292 \& MolecularComplexityType = \*(AqMACCSKeys\*(Aq | |
293 \& AtomIdentifierType = \*(Aq\*(Aq | |
294 \& MACCSKeysSize = 166 | |
295 \& NeighborhoodRadius = 2 | |
296 \& MinPathLength = 1 | |
297 \& MaxPathLength = 8 | |
298 \& UseBondSymbols = 1 | |
299 \& MinDistance = 1 | |
300 \& MaxDistance = 10 | |
301 \& UseTriangleInequality = \*(Aq\*(Aq | |
302 \& DistanceBinSize = 2 | |
303 \& NormalizationMethodology = \*(AqNone\*(Aq | |
304 \& @DescriptorNames = (\*(AqMolecularComplexity\*(Aq) | |
305 \& @DescriptorValues = (\*(AqNone\*(Aq) | |
306 .Ve | |
307 .Sp | |
308 Examples: | |
309 .Sp | |
310 .Vb 3 | |
311 \& $MolecularComplexityDescriptors = new MolecularDescriptors:: | |
312 \& MolecularComplexityDescriptors( | |
313 \& \*(AqMolecule\*(Aq => $Molecule); | |
314 \& | |
315 \& $MolecularComplexityDescriptors = new MolecularDescriptors:: | |
316 \& MolecularComplexityDescriptors(); | |
317 \& | |
318 \& $MolecularComplexityDescriptors\->SetMolecule($Molecule); | |
319 \& $MolecularComplexityDescriptors\->GenerateDescriptors(); | |
320 \& print "MolecularComplexityDescriptors: $MolecularComplexityDescriptors\en"; | |
321 .Ve | |
322 .IP "\fBGenerateDescriptors\fR" 4 | |
323 .IX Item "GenerateDescriptors" | |
324 .Vb 1 | |
325 \& $MolecularComplexityDescriptors\->GenerateDescriptors(); | |
326 .Ve | |
327 .Sp | |
328 Calculates MolecularComplexity value for a molecule and returns \fIMolecularComplexityDescriptors\fR. | |
329 .IP "\fBGetDescriptorNames\fR" 4 | |
330 .IX Item "GetDescriptorNames" | |
331 .Vb 3 | |
332 \& @DescriptorNames = $MolecularComplexityDescriptors\->GetDescriptorNames(); | |
333 \& @DescriptorNames = MolecularDescriptors::MolecularComplexityDescriptors:: | |
334 \& GetDescriptorNames(); | |
335 .Ve | |
336 .Sp | |
337 Returns all available descriptor names as an array. | |
338 .IP "\fBGetMolecularComplexityTypeAbbreviation\fR" 4 | |
339 .IX Item "GetMolecularComplexityTypeAbbreviation" | |
340 .Vb 4 | |
341 \& $Abbrev = $MolecularComplexityDescriptors\-> | |
342 \& GetMolecularComplexityTypeAbbreviation(); | |
343 \& $Abbrev = MolecularDescriptors::MolecularComplexityDescriptors:: | |
344 \& GetMolecularComplexityTypeAbbreviation($ComplexityType); | |
345 .Ve | |
346 .Sp | |
347 Returns abbreviation for a specified molecular complexity type or corresponding to | |
348 \&\fIMolecularComplexityDescriptors\fR object. | |
349 .IP "\fBSetMACCSKeysSize\fR" 4 | |
350 .IX Item "SetMACCSKeysSize" | |
351 .Vb 1 | |
352 \& $MolecularComplexityDescriptors\->MACCSKeysSize($Size); | |
353 .Ve | |
354 .Sp | |
355 Sets \s-1MACCS\s0 keys size and returns \fIMolecularComplexityDescriptors\fR. | |
356 .IP "\fBSetAtomIdentifierType\fR" 4 | |
357 .IX Item "SetAtomIdentifierType" | |
358 .Vb 1 | |
359 \& $MolecularComplexityDescriptors\->SetAtomIdentifierType($IdentifierType); | |
360 .Ve | |
361 .Sp | |
362 Sets atom \fIIdentifierType\fR to use during fingerprints generation corresponding to | |
363 \&\fIMolecularComplexityType\fR and returns \fIMolecularComplexityDescriptors\fR. | |
364 .Sp | |
365 Possible values: \fIAtomicInvariantsAtomTypes, DREIDINGAtomTypes, EStateAtomTypes, | |
366 FunctionalClassAtomTypes, MMFF94AtomTypes, SLogPAtomTypes, SYBYLAtomTypes, | |
367 TPSAAtomTypes, UFFAtomTypes\fR. | |
368 .IP "\fBSetAtomicInvariantsToUse\fR" 4 | |
369 .IX Item "SetAtomicInvariantsToUse" | |
370 .Vb 2 | |
371 \& $MolecularComplexityDescriptors\->SetAtomicInvariantsToUse($ValuesRef); | |
372 \& $MolecularComplexityDescriptors\->SetAtomicInvariantsToUse(@Values); | |
373 .Ve | |
374 .Sp | |
375 Sets atomic invariants to use during \fIAtomicInvariantsAtomTypes\fR value of \fIAtomIdentifierType\fR | |
376 for fingerprints generation and returns \fIMolecularComplexityDescriptors\fR. | |
377 .Sp | |
378 Possible values for atomic invariants are: \fI\s-1AS\s0, X, \s-1BO\s0, \s-1LBO\s0, \s-1SB\s0, \s-1DB\s0, \s-1TB\s0, | |
379 H, Ar, \s-1RA\s0, \s-1FC\s0, \s-1MN\s0, \s-1SM\s0\fR. Default value [ Ref 24 ]: \fI\s-1AS\s0,X,BO,H,FC,MN\fR. | |
380 .Sp | |
381 The atomic invariants abbreviations correspond to: | |
382 .Sp | |
383 .Vb 1 | |
384 \& AS = Atom symbol corresponding to element symbol | |
385 \& | |
386 \& X<n> = Number of non\-hydrogen atom neighbors or heavy atoms | |
387 \& BO<n> = Sum of bond orders to non\-hydrogen atom neighbors or heavy atoms | |
388 \& LBO<n> = Largest bond order of non\-hydrogen atom neighbors or heavy atoms | |
389 \& SB<n> = Number of single bonds to non\-hydrogen atom neighbors or heavy atoms | |
390 \& DB<n> = Number of double bonds to non\-hydrogen atom neighbors or heavy atoms | |
391 \& TB<n> = Number of triple bonds to non\-hydrogen atom neighbors or heavy atoms | |
392 \& H<n> = Number of implicit and explicit hydrogens for atom | |
393 \& Ar = Aromatic annotation indicating whether atom is aromatic | |
394 \& RA = Ring atom annotation indicating whether atom is a ring | |
395 \& FC<+n/\-n> = Formal charge assigned to atom | |
396 \& MN<n> = Mass number indicating isotope other than most abundant isotope | |
397 \& SM<n> = Spin multiplicity of atom. Possible values: 1 (singlet), 2 (doublet) or | |
398 \& 3 (triplet) | |
399 .Ve | |
400 .Sp | |
401 Atom type generated by AtomTypes::AtomicInvariantsAtomTypes class corresponds to: | |
402 .Sp | |
403 .Vb 1 | |
404 \& AS.X<n>.BO<n>.LBO<n>.<SB><n>.<DB><n>.<TB><n>.H<n>.Ar.RA.FC<+n/\-n>.MN<n>.SM<n> | |
405 .Ve | |
406 .Sp | |
407 Except for \s-1AS\s0 which is a required atomic invariant in atom types, all other atomic invariants are | |
408 optional. Atom type specification doesn't include atomic invariants with zero or undefined values. | |
409 .Sp | |
410 In addition to usage of abbreviations for specifying atomic invariants, the following descriptive words | |
411 are also allowed: | |
412 .Sp | |
413 .Vb 12 | |
414 \& X : NumOfNonHydrogenAtomNeighbors or NumOfHeavyAtomNeighbors | |
415 \& BO : SumOfBondOrdersToNonHydrogenAtoms or SumOfBondOrdersToHeavyAtoms | |
416 \& LBO : LargestBondOrderToNonHydrogenAtoms or LargestBondOrderToHeavyAtoms | |
417 \& SB : NumOfSingleBondsToNonHydrogenAtoms or NumOfSingleBondsToHeavyAtoms | |
418 \& DB : NumOfDoubleBondsToNonHydrogenAtoms or NumOfDoubleBondsToHeavyAtoms | |
419 \& TB : NumOfTripleBondsToNonHydrogenAtoms or NumOfTripleBondsToHeavyAtoms | |
420 \& H : NumOfImplicitAndExplicitHydrogens | |
421 \& Ar : Aromatic | |
422 \& RA : RingAtom | |
423 \& FC : FormalCharge | |
424 \& MN : MassNumber | |
425 \& SM : SpinMultiplicity | |
426 .Ve | |
427 .Sp | |
428 \&\fIAtomTypes::AtomicInvariantsAtomTypes\fR module is used to assign atomic invariant | |
429 atom types. | |
430 .IP "\fBSetDistanceBinSize\fR" 4 | |
431 .IX Item "SetDistanceBinSize" | |
432 .Vb 1 | |
433 \& $MolecularComplexityDescriptors\->SetDistanceBinSize($BinSize); | |
434 .Ve | |
435 .Sp | |
436 Sets distance bin size used to bin distances between atom pairs in atom triplets for | |
437 topological pharmacophore atom triplets fingerprints generation and returns | |
438 \&\fIMolecularComplexityDescriptors\fR. | |
439 .IP "\fBSetFunctionalClassesToUse\fR" 4 | |
440 .IX Item "SetFunctionalClassesToUse" | |
441 .Vb 2 | |
442 \& $MolecularComplexityDescriptors\->SetFunctionalClassesToUse($ValuesRef); | |
443 \& $MolecularComplexityDescriptors\->SetFunctionalClassesToUse(@Values); | |
444 .Ve | |
445 .Sp | |
446 Sets functional classes invariants to use during \fIFunctionalClassAtomTypes\fR value of \fIAtomIdentifierType\fR | |
447 for fingerprints generation and returns \fIMolecularComplexityDescriptors\fR. | |
448 .Sp | |
449 Possible values for atom functional classes are: \fIAr, \s-1CA\s0, H, \s-1HBA\s0, \s-1HBD\s0, Hal, \s-1NI\s0, \s-1PI\s0, \s-1RA\s0\fR. | |
450 Default value [ Ref 24 ]: \fI\s-1HBD\s0,HBA,PI,NI,Ar,Hal\fR. | |
451 .Sp | |
452 The functional class abbreviations correspond to: | |
453 .Sp | |
454 .Vb 9 | |
455 \& HBD: HydrogenBondDonor | |
456 \& HBA: HydrogenBondAcceptor | |
457 \& PI : PositivelyIonizable | |
458 \& NI : NegativelyIonizable | |
459 \& Ar : Aromatic | |
460 \& Hal : Halogen | |
461 \& H : Hydrophobic | |
462 \& RA : RingAtom | |
463 \& CA : ChainAtom | |
464 \& | |
465 \& Functional class atom type specification for an atom corresponds to: | |
466 \& | |
467 \& Ar.CA.H.HBA.HBD.Hal.NI.PI.RA or None | |
468 .Ve | |
469 .Sp | |
470 \&\fIAtomTypes::FunctionalClassAtomTypes\fR module is used to assign functional class atom | |
471 types. It uses following definitions [ Ref 60\-61, Ref 65\-66 ]: | |
472 .Sp | |
473 .Vb 4 | |
474 \& HydrogenBondDonor: NH, NH2, OH | |
475 \& HydrogenBondAcceptor: N[!H], O | |
476 \& PositivelyIonizable: +, NH2 | |
477 \& NegativelyIonizable: \-, C(=O)OH, S(=O)OH, P(=O)OH | |
478 .Ve | |
479 .IP "\fBSetMaxDistance\fR" 4 | |
480 .IX Item "SetMaxDistance" | |
481 .Vb 1 | |
482 \& $MolecularComplexityDescriptors\->SetMaxDistance($MaxDistance); | |
483 .Ve | |
484 .Sp | |
485 Sets maximum distance to use during topological atom pairs and triplets fingerprints | |
486 generation and returns \fIMolecularComplexityDescriptors\fR. | |
487 .IP "\fBSetMaxPathLength\fR" 4 | |
488 .IX Item "SetMaxPathLength" | |
489 .Vb 1 | |
490 \& $MolecularComplexityDescriptors\->SetMaxPathLength($Length); | |
491 .Ve | |
492 .Sp | |
493 Sets maximum path length to use during path length fingerprints generation and returns | |
494 \&\fIMolecularComplexityDescriptors\fR. | |
495 .IP "\fBSetMinDistance\fR" 4 | |
496 .IX Item "SetMinDistance" | |
497 .Vb 1 | |
498 \& $MolecularComplexityDescriptors\->SetMinDistance($MinDistance); | |
499 .Ve | |
500 .Sp | |
501 Sets minimum distance to use during topological atom pairs and triplets fingerprints | |
502 generation and returns \fIMolecularComplexityDescriptors\fR. | |
503 .IP "\fBSetMinPathLength\fR" 4 | |
504 .IX Item "SetMinPathLength" | |
505 .Vb 1 | |
506 \& $MolecularComplexityDescriptors\->SetMinPathLength($MinPathLength); | |
507 .Ve | |
508 .Sp | |
509 Sets minimum path length to use during path length fingerprints generation and returns | |
510 \&\fIMolecularComplexityDescriptors\fR. | |
511 .IP "\fBSetMolecularComplexityType\fR" 4 | |
512 .IX Item "SetMolecularComplexityType" | |
513 .Vb 1 | |
514 \& $MolecularComplexityDescriptors\->SetMolecularComplexityType($ComplexityType); | |
515 .Ve | |
516 .Sp | |
517 Sets molecular complexity type to use for calculating its value and returns | |
518 \&\fIMolecularComplexityDescriptors\fR. | |
519 .IP "\fBSetNeighborhoodRadius\fR" 4 | |
520 .IX Item "SetNeighborhoodRadius" | |
521 .Vb 1 | |
522 \& $MolecularComplexityDescriptors\->SetNeighborhoodRadius($Radius); | |
523 .Ve | |
524 .Sp | |
525 Sets neighborhood radius to use during extended connectivity fingerprints generation and | |
526 returns \fIMolecularComplexityDescriptors\fR. | |
527 .IP "\fBSetNormalizationMethodology\fR" 4 | |
528 .IX Item "SetNormalizationMethodology" | |
529 .Vb 1 | |
530 \& $MolecularComplexityDescriptors\->SetNormalizationMethodology($Methodology); | |
531 .Ve | |
532 .Sp | |
533 Sets normalization methodology to use during calculation of molecular complexity | |
534 corresponding to extended connectivity, topological pharmacophore atom pairs and | |
535 tripletes fingerprints returns \fIMolecularComplexityDescriptors\fR. | |
536 .IP "\fBStringifyMolecularComplexityDescriptors\fR" 4 | |
537 .IX Item "StringifyMolecularComplexityDescriptors" | |
538 .Vb 2 | |
539 \& $String = $MolecularComplexityDescriptors\-> | |
540 \& StringifyMolecularComplexityDescriptors(); | |
541 .Ve | |
542 .Sp | |
543 Returns a string containing information about \fIMolecularComplexityDescriptors\fR object. | |
544 .SH "AUTHOR" | |
545 .IX Header "AUTHOR" | |
546 Manish Sud <msud@san.rr.com> | |
547 .SH "SEE ALSO" | |
548 .IX Header "SEE ALSO" | |
549 MolecularDescriptors.pm, MolecularDescriptorsGenerator.pm | |
550 .SH "COPYRIGHT" | |
551 .IX Header "COPYRIGHT" | |
552 Copyright (C) 2015 Manish Sud. All rights reserved. | |
553 .PP | |
554 This file is part of MayaChemTools. | |
555 .PP | |
556 MayaChemTools is free software; you can redistribute it and/or modify it under | |
557 the terms of the \s-1GNU\s0 Lesser General Public License as published by the Free | |
558 Software Foundation; either version 3 of the License, or (at your option) | |
559 any later version. |