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