Home Documentation Download About

NAME

TopologicalAtomPairsFingerprints

SYNOPSIS

use Fingerprints::TopologicalAtomPairsFingerprints;

use Fingerprints::TopologicalAtomPairsFingerprints qw(:all);

DESCRIPTION

TopologicalAtomPairsFingerprints [ Ref 57, Ref 59, Ref 72 ] class provides the following methods:

new, GenerateFingerprints, GetAtomPairIDs, GetDescription, SetAtomIdentifierType, SetAtomicInvariantsToUse, SetFunctionalClassesToUse, SetMaxDistance, SetMinDistance, StringifyTopologicalAtomPairsFingerprints

TopologicalAtomPairsFingerprints is derived from Fingerprints class which in turn is derived from ObjectProperty base class that provides methods not explicitly defined in TopologicalAtomPairsFingerprints, Fingerprints or ObjectProperty classes using Perl's AUTOLOAD functionality. These methods are generated on-the-fly for a specified object property:

The current release of MayaChemTools supports generation of AtomTypesFingerpritns corresponding to following AtomtomIdentifierTypes:

Based on the values specified for AtomIdentifierType along with other specified parameters such as AtomicInvariantsToUse and FunctionalClassesToUse, initial atom types are assigned to all non-hydrogen atoms in a molecule. Using the distance matrix for the molecule and initial atom types assigned to non-hydrogen atoms, all unique atom pairs within MinDistance and MaxDistance are identified and counted. An atom pair identifier is generated for each unique atom pair; the format of atom pair identifier is:

The atom pair identifiers for all unique atom pairs corresponding to non-hydrogen atoms constitute topological atom pairs fingerprints of the molecule.

The current release of MayaChemTools generates the following types of topological atom pairs fingerprints vector strings:

METHODS

new

$NewTopologicalAtomPairsFingerprints = new TopologicalAtomPairsFingerprints( %NamesAndValues);

Using specified TopologicalAtomPairsFingerprints property names and values hash, new method creates a new object and returns a reference to newly created TopologicalAtomPairsFingerprints object. By default, the following properties are initialized:

Molecule = ''
Type = 'TopologicalAtomPairs'
MinDistance = 1
MaxDistance = 10
AtomIdentifierType = ''
AtomicInvariantsToUse = ['AS', 'X', 'BO', 'H', 'FC']
FunctionalClassesToUse = ['HBD', 'HBA', 'PI', 'NI', 'Ar', 'Hal']

Examples:

$TopologicalAtomPairsFingerprints = new TopologicalAtomPairsFingerprints( 'Molecule' => $Molecule, 'AtomIdentifierType' => 'AtomicInvariantsAtomTypes');

$TopologicalAtomPairsFingerprints = new TopologicalAtomPairsFingerprints( 'Molecule' => $Molecule, 'MinDistance' => 1, 'MaxDistance' => 10, 'AtomIdentifierType' => 'AtomicInvariantsAtomTypes', 'AtomicInvariantsToUse' => ['AS', 'X', 'BO', 'H', 'FC'] );

$TopologicalAtomPairsFingerprints = new TopologicalAtomPairsFingerprints( 'Molecule' => $Molecule, 'AtomIdentifierType' => 'EStateAtomTypes');

$TopologicalAtomPairsFingerprints = new TopologicalAtomPairsFingerprints( 'Molecule' => $Molecule, 'AtomIdentifierType' => 'SLogPAtomTypes');

$TopologicalAtomPairsFingerprints = new TopologicalAtomPairsFingerprints( 'Molecule' => $Molecule, 'MinDistance' => 1, 'MaxDistance' => 10, 'AtomIdentifierType' => 'FunctionalClassAtomTypes', 'FunctionalClassesToUse' => ['HBD', 'HBA', 'PI', 'NI', 'Ar', 'Hal']);


$TopologicalAtomPairsFingerprints->GenerateFingerprints();
print "$TopologicalAtomPairsFingerprints\n";

GetDescription

$Description = $TopologicalAtomPairsFingerprints->GetDescription();

Returns a string containing description of topological atom pairs fingerprints fingerprints.

GenerateFingerprints

$TopologicalAtomPairsFingerprints->GenerateFingerprints();

Generates topological atom pairs fingerprints and returns TopologicalAtomPairsFingerprints.

GetAtomPairIDs

$AtomPairIDsRef = $TopologicalAtomPairsFingerprints->GetAtomPairIDs();
@AtomPairIDs = $TopologicalAtomPairsFingerprints->GetAtomPairIDs();

Returns atom pair IDs corresponding to atom pairs count values in topological atom pairs fingerprints vector as an array or reference to an array.

SetAtomIdentifierType

$TopologicalAtomPairsFingerprints->SetAtomIdentifierType($IdentifierType);

Sets atom IdentifierType to use during atom pairs fingerprints generation and returns TopologicalAtomPairsFingerprints.

Possible values: AtomicInvariantsAtomTypes, DREIDINGAtomTypes, EStateAtomTypes, FunctionalClassAtomTypes, MMFF94AtomTypes, SLogPAtomTypes, SYBYLAtomTypes, TPSAAtomTypes, UFFAtomTypes.

SetAtomicInvariantsToUse

$TopologicalAtomPairsFingerprints->SetAtomicInvariantsToUse($ValuesRef);
$TopologicalAtomPairsFingerprints->SetAtomicInvariantsToUse(@Values);

Sets atomic invariants to use during AtomicInvariantsAtomTypes value of AtomIdentifierType for topological atom pairs fingerprints generation and returns TopologicalAtomPairsFingerprints.

Possible values for atomic invariants are: AS, X, BO, LBO, SB, DB, TB, H, Ar, RA, FC, MN, SM. Default value: AS,X,BO,H,FC.

The atomic invariants abbreviations correspond to:

AS = Atom symbol corresponding to element symbol

X<n> = Number of non-hydrogen atom neighbors or heavy atoms
BO<n> = Sum of bond orders to non-hydrogen atom neighbors or heavy atoms
LBO<n> = Largest bond order of non-hydrogen atom neighbors or heavy atoms
SB<n> = Number of single bonds to non-hydrogen atom neighbors or heavy atoms
DB<n> = Number of double bonds to non-hydrogen atom neighbors or heavy atoms
TB<n> = Number of triple bonds to non-hydrogen atom neighbors or heavy atoms
H<n> = Number of implicit and explicit hydrogens for atom
Ar = Aromatic annotation indicating whether atom is aromatic
RA = Ring atom annotation indicating whether atom is a ring
FC<+n/-n> = Formal charge assigned to atom
MN<n> = Mass number indicating isotope other than most abundant isotope
SM<n> = Spin multiplicity of atom. Possible values: 1 (singlet), 2 (doublet) or
         3 (triplet)

Atom type generated by AtomTypes::AtomicInvariantsAtomTypes class corresponds to:

AS.X<n>.BO<n>.LBO<n>.<SB><n>.<DB><n>.<TB><n>.H<n>.Ar.RA.FC<+n/-n>.MN<n>.SM<n>

Except for AS which is a required atomic invariant in atom types, all other atomic invariants are optional. Atom type specification doesn't include atomic invariants with zero or undefined values.

In addition to usage of abbreviations for specifying atomic invariants, the following descriptive words are also allowed:

X : NumOfNonHydrogenAtomNeighbors or NumOfHeavyAtomNeighbors
BO : SumOfBondOrdersToNonHydrogenAtoms or SumOfBondOrdersToHeavyAtoms
LBO : LargestBondOrderToNonHydrogenAtoms or LargestBondOrderToHeavyAtoms
SB : NumOfSingleBondsToNonHydrogenAtoms or NumOfSingleBondsToHeavyAtoms
DB : NumOfDoubleBondsToNonHydrogenAtoms or NumOfDoubleBondsToHeavyAtoms
TB : NumOfTripleBondsToNonHydrogenAtoms or NumOfTripleBondsToHeavyAtoms
H : NumOfImplicitAndExplicitHydrogens
Ar : Aromatic
RA : RingAtom
FC : FormalCharge
MN : MassNumber
SM : SpinMultiplicity

AtomTypes::AtomicInvariantsAtomTypes module is used to assign atomic invariant atom types.

SetFunctionalClassesToUse

$TopologicalAtomPairsFingerprints->SetFunctionalClassesToUse($ValuesRef);
$TopologicalAtomPairsFingerprints->SetFunctionalClassesToUse(@Values);

Sets functional classes invariants to use during FunctionalClassAtomTypes value of AtomIdentifierType for topological atom pairs fingerprints generation and returns TopologicalAtomPairsFingerprints.

Possible values for atom functional classes are: Ar, CA, H, HBA, HBD, Hal, NI, PI, RA. Default value [ Ref 24 ]: HBD,HBA,PI,NI,Ar,Hal.

The functional class abbreviations correspond to:

HBD: HydrogenBondDonor
HBA: HydrogenBondAcceptor
PI : PositivelyIonizable
NI : NegativelyIonizable
Ar : Aromatic
Hal : Halogen
H : Hydrophobic
RA : RingAtom
CA : ChainAtom
Functional class atom type specification for an atom corresponds to:

Ar.CA.H.HBA.HBD.Hal.NI.PI.RA or None

AtomTypes::FunctionalClassAtomTypes module is used to assign functional class atom types. It uses following definitions [ Ref 60-61, Ref 65-66 ]:

HydrogenBondDonor: NH, NH2, OH
HydrogenBondAcceptor: N[!H], O
PositivelyIonizable: +, NH2
NegativelyIonizable: -, C(=O)OH, S(=O)OH, P(=O)OH

SetMaxDistance

$TopologicalAtomPairsFingerprints->SetMaxDistance($Distance);

Sets maximum distance to use during topological atom pairs fingerprints generation and returns TopologicalAtomPairsFingerprints.

SetMinDistance

$TopologicalAtomPairsFingerprints->SetMinDistance($Distance);

Sets minimum distance to use during topological atom pairs fingerprints generation and returns TopologicalAtomPairsFingerprints.

StringifyTopologicalAtomPairsFingerprints

$String = $TopologicalAtomPairsFingerprints-> StringifyTopologicalAtomPairsFingerprints();

Returns a string containing information about TopologicalAtomPairsFingerprints object.

AUTHOR

Manish Sud

SEE ALSO

Fingerprints.pm, FingerprintsStringUtil.pm, AtomNeighborhoodsFingerprints.pm, AtomTypesFingerprints.pm, EStateIndiciesFingerprints.pm, ExtendedConnectivityFingerprints.pm, MACCSKeys.pm, PathLengthFingerprints.pm, TopologicalAtomTripletsFingerprints.pm, TopologicalAtomTorsionsFingerprints.pm, TopologicalPharmacophoreAtomPairsFingerprints.pm, TopologicalPharmacophoreAtomTripletsFingerprints.pm

COPYRIGHT

Copyright (C) 2024 Manish Sud. All rights reserved.

This file is part of MayaChemTools.

MayaChemTools is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.