annotate docs/modules/txt/EStateIndiciesFingerprints.txt @ 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 NAME
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
2 EStateIndiciesFingerprints
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
3
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
4 SYNOPSIS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
5 use Fingerprints::EStateIndiciesFingerprints;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
6
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
7 use Fingerprints::EStateIndiciesFingerprints qw(:all);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
8
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
9 DESCRIPTION
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
10 EStateIndiciesFingerprints [ Ref 75-78 ] class provides the following
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
11 methods:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
12
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
13 new, GenerateFingerprints, GetDescription, SetEStateAtomTypesSetToUse,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
14 SetValuesPrecision, StringifyEStateIndiciesFingerprints
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
15
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
16 EStateIndiciesFingerprints is derived from Fingerprints class which in
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
17 turn is derived from ObjectProperty base class that provides methods not
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
18 explicitly defined in AtomNeighborhoodsFingerprints, Fingerprints or
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
19 ObjectProperty classes using Perl's AUTOLOAD functionality. These
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
20 methods are generated on-the-fly for a specified object property:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
21
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
22 Set<PropertyName>(<PropertyValue>);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
23 $PropertyValue = Get<PropertyName>();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
24 Delete<PropertyName>();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
25
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
26 E-state atom types are assigned to all non-hydrogen atoms in a molecule
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
27 using module AtomTypes::EStateAtomTypes.pm and E-state values are
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
28 calculated using module AtomicDescriptors::EStateValues.pm. Using
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
29 E-state atom types and E-state values, EStateIndiciesFingerprints
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
30 constituting sum of E-state values for E-sate atom types are generated.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
31
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
32 Two types of E-state atom types set size are allowed:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
33
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
34 ArbitrarySize - Corresponds to only E-state atom types detected
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
35 in molecule
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
36 FixedSize - Corresponds to fixed number of E-state atom types previously
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
37 defined
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
38
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
39 Module AtomTypes::EStateAtomTypes.pm, used to assign E-state atom types
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
40 to non-hydrogen atoms in the molecule, is able to assign atom types to
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
41 any valid atom group. However, for *FixedSize* value of
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
42 EStateAtomTypesSetToUse, only a fixed set of E-state atom types
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
43 corresponding to specific atom groups [ Appendix III in Ref 77 ] are
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
44 used for fingerprints.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
45
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
46 The fixed size E-state atom type set size used during generation of
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
47 fingerprints contains 87 E-state non-hydrogen atom types in
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
48 EStateAtomTypes.csv data file distributed with MayaChemTools.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
49
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
50 Combination of Type and EStateAtomTypesSetToUse allow generation of 2
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
51 different types of E-state indicies fingerprints:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
52
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
53 Type EStateAtomTypesSetToUse
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
54
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
55 EStateIndicies ArbitrarySize [ default fingerprints ]
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
56 EStateIndicies FixedSize
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
57
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
58 The current release of MayaChemTools generates the following types of
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
59 E-state fingerprints vector strings:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
60
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
61 FingerprintsVector;EStateIndicies:ArbitrarySize;11;NumericalValues;IDs
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
62 AndValuesString;SaaCH SaasC SaasN SdO SdssC SsCH3 SsF SsOH SssCH2 SssN
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
63 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
64 .024 -2.270
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
65
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
66 FingerprintsVector;EStateIndicies:FixedSize;87;OrderedNumericalValues;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
67 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
68 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
69 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
70 0 0 0 0 0 0 0 0 0 0 0 0 0 0
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
71
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
72 FingerprintsVector;EStateIndicies:FixedSize;87;OrderedNumericalValues;
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
73 IDsAndValuesString;SsLi SssBe SssssBem SsBH2 SssBH SsssB SssssBm SsCH3
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
74 SdCH2 SssCH2 StCH SdsCH SaaCH SsssCH SddC StsC SdssC SaasC SaaaC Sssss
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
75 C SsNH3p SsNH2 SssNH2p SdNH SssNH SaaNH StN SsssNHp SdsN SaaN SsssN Sd
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
76 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
77 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
78 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
79
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
80 METHODS
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
81 new
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
82 $EStateIndiciesFingerprints = new EStateIndiciesFingerprints(%NamesAndValues);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
83
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
84 Using specified *EStateIndiciesFingerprints* property names and
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
85 values hash, new method creates a new object and returns a reference
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
86 to newly created PathLengthFingerprints object. By default, the
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
87 following properties are initialized:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
88
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
89 Molecule = '';
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
90 Type = 'EStateIndicies'
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
91 EStateAtomTypesSetToUse = 'ArbitrarySize'
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
92 ValuesPrecision = 3
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
93
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
94 Examples:
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
95
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
96 $EStateIndiciesFingerprints = new AtomTypesFingerprints(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
97 'Molecule' => $Molecule,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
98 'EStateAtomTypesSetToUse' =>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
99 'ArbitrarySize');
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
100
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
101 $EStateIndiciesFingerprints = new AtomTypesFingerprints(
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
102 'Molecule' => $Molecule,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
103 'EStateAtomTypesSetToUse' =>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
104 'FixedSize');
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
105
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
106 $EStateIndiciesFingerprints->GenerateFingerprints();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
107 print "$EStateIndiciesFingerprints\n";
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
108
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
109 GenerateFingerprints
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
110 $EStateIndiciesFingerprints = $EStateIndiciesFingerprints->
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
111 GenerateEStateIndiciesFingerprints();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
112
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
113 Generates EState keys fingerprints and returns
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
114 *EStateIndiciesFingerprints*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
115
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
116 GetDescription
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
117 $Description = $EStateIndiciesFingerprints->GetDescription();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
118
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
119 Returns a string containing description of EState keys fingerprints.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
120
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
121 SetEStateAtomTypesSetToUse
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
122 $EStateIndiciesFingerprints->SetEStateAtomTypesSetToUse($Value);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
123
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
124 Sets *Value* of *EStateAtomTypesSetToUse* and returns
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
125 *EStateIndiciesFingerprints*. Possible values: *ArbitrarySize or
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
126 FixedSize*. Default value: *ArbitrarySize*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
127
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
128 SetValuesPrecision
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
129 $EStateIndiciesFingerprints->SetValuesPrecision($Precision);
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
130
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
131 Sets precesion of E-state values to use during generation of E-state
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
132 indices fingerprints and returns *EStateIndiciesFingerprints*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
133 Possible values: *Positive integers*. Default value: *3*.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
134
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
135 StringifyEStateIndiciesFingerprints
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
136 $String = $EStateIndiciesFingerprints->StringifyEStateIndiciesFingerprints();
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
137
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
138 Returns a string containing information about
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
139 *EStateIndiciesFingerprints* object.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
140
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
141 AUTHOR
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
142 Manish Sud <msud@san.rr.com>
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
143
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
144 SEE ALSO
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
145 Fingerprints.pm, FingerprintsStringUtil.pm,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
146 AtomNeighborhoodsFingerprints.pm, AtomTypesFingerprints.pm,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
147 ExtendedConnectivityFingerprints.pm, MACCSKeys.pm,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
148 PathLengthFingerprints.pm, TopologicalAtomPairsFingerprints.pm,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
149 TopologicalAtomTripletsFingerprints.pm,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
150 TopologicalAtomTorsionsFingerprints.pm,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
151 TopologicalPharmacophoreAtomPairsFingerprints.pm,
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
152 TopologicalPharmacophoreAtomTripletsFingerprints.pm
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
153
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
154 COPYRIGHT
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
155 Copyright (C) 2015 Manish Sud. All rights reserved.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
156
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
157 This file is part of MayaChemTools.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
158
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
159 MayaChemTools is free software; you can redistribute it and/or modify it
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
160 under the terms of the GNU Lesser General Public License as published by
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
161 the Free Software Foundation; either version 3 of the License, or (at
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
162 your option) any later version.
4816e4a8ae95 Uploaded
deepakjadmin
parents:
diff changeset
163