OEPerceiveInteractionOptions

class OEPerceiveInteractionOptions

This class is a container for all the parameters that control interaction perception when invoking the OEPerceiveInteractionHints function.

The current list of interactions include:

Each interaction type has one or more parameters that control its perception. In addition, hydrogen-bonding clashes, intramolecular hydrogen-bonds, unpaired hydrogen-bonds and unpaired salt-bridges are also perceived. Unpaired interactions are those that are near the protein-ligand interface, but do not form an apparent bond.

Get method

Set method

Interaction type(s)

Default value

GetExtendedSaltBridgeDistance

salt bridge

GetMaxAcceptorAngle

SetMaxAcceptorAngle

hbond

30 degrees

GetMaxAtomPairDistance

GetMaxCationPiAngle

SetMaxCationPiAngle

cation-Pi

50 degrees

GetMaxCationPiDistance

SetMaxCationPiDistance

cation-Pi

5.5 Ångströms

GetMaxChargeAidedHBondDistance

SetMaxChargeAidedHBondDistance

hbond

3.5 Ångströms

GetMaxContactFraction

SetMaxContactFraction

contact

1.2

GetMaxCovalentFraction

SetMaxCovalentFraction

covalent

1.1

GetMaxDonorAngle

SetMaxDonorAngle

hbond

35 degrees

GetMaxHBondDistance

SetMaxHBondDistance

hbond

3.2 Ångströms

GetMaxHalogenAngle

SetMaxHalogenAngle

halogen bond

35 degrees

GetMaxHalogenBondDistance

SetMaxHalogenBondDistance

halogen bond

3.2 Ångströms

GetMaxMetalBondDistance

SetMaxMetalBondDistance

chelator

3.5 Ångströms

GetMaxNonIdealAcceptorAngle

SetMaxNonIdealAcceptorAngle

hbond

30 degrees

GetMaxNonIdealDonorAngle

SetMaxNonIdealDonorAngle

hbond

45 degrees

GetMaxNonIdealHBondDistance

SetMaxNonIdealHBondDistance

hbond

3.8 Ångströms

GetMaxPiStackAngle

SetMaxPiStackAngle

Pi-stacking

\(\frac{\pi}{9.0}\)

GetMaxPiStackDistance

SetMaxPiStackDistance

Pi-stacking

5.0 Ångströms

GetMaxProteinIntraDistance

SetMaxProteinIntraDistance

intramolecular (protein)

6.0 Ångströms

GetMaxSaltBridgeDistance

SetMaxSaltBridgeDistance

salt bridge

5.0 Ångströms

GetMaxTStackAngle

SetMaxTStackAngle

T-stacking

\(\frac{\pi}{9.0}\)

GetMaxTStackDistance

SetMaxTStackDistance

T-stacking

5.35 Ångströms

GetMaxUnpairedAngle

SetMaxUnpairedAngle

hbond

\(\frac{\pi}{2}\)

GetMaxUnpairedDistance

SetMaxUnpairedDistance

hbond

5.0 Ångströms

GetMinContactFraction

SetMinContactFraction

contact, clash

0.8

GetMinCovalentFraction

SetMinCovalentFraction

covalent

0.9

GetMinHBondContactFraction

SetMinHBondContactFraction

hbond

0.5

GetMinStackOffset

SetMinStackOffset

Pi-stacking, T-stacking

0.5 Ångströms

Constructors

OEPerceiveInteractionOptions() -> OEPerceiveInteractionOptions
OEPerceiveInteractionOptions(arg2: OEPerceiveInteractionOptions) -> OEPerceiveInteractionOptions

The default constructor for perception of interaction options. It sets all of the interaction parameters to their default value.

GetExtendedSaltBridgeDistance

GetExtendedSaltBridgeDistance() -> float

Actual salt bridge interaction distance is calculated from the geometric centers of the two interacting charge groups, which may or may not be comprised of a single atom. The distance returned by this function is the maximum distance between two formally charged atoms for subsequent identification of charge groups. This is a simple increment larger than the value associated with OEPerceiveInteractionOptions.GetMaxSaltBridgeDistance and OEPerceiveInteractionOptions.SetMaxSaltBridgeDistance.

GetMaxAcceptorAngle

GetMaxAcceptorAngle() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMaxAcceptorAngle.

GetMaxAtomPairDistance

GetMaxAtomPairDistance() -> float

Returns the maximum value of

GetMaxCationPiAngle

GetMaxCationPiAngle() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMaxCationPiAngle.

GetMaxCationPiDistance

GetMaxCationPiDistance() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMaxCationPiDistance.

GetMaxChargeAidedHBondDistance

GetMaxChargeAidedHBondDistance() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMaxChargeAidedHBondDistance.

GetMaxContactFraction

GetMaxContactFraction() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMaxContactFraction.

GetMaxCovalentFraction

GetMaxCovalentFraction() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMaxCovalentFraction.

GetMaxDonorAngle

GetMaxDonorAngle() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMaxDonorAngle.

GetMaxHBondDistance

GetMaxHBondDistance() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMaxHBondDistance.

GetMaxHalogenAngle

GetMaxHalogenAngle() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMaxHalogenAngle.

GetMaxHalogenBondDistance

GetMaxHalogenBondDistance() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMaxHalogenBondDistance.

GetMaxMetalBondDistance

GetMaxMetalBondDistance() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMaxMetalBondDistance.

GetMaxNonIdealAcceptorAngle

GetMaxNonIdealAcceptorAngle() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMaxNonIdealAcceptorAngle.

GetMaxNonIdealDonorAngle

GetMaxNonIdealDonorAngle() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMaxNonIdealDonorAngle.

GetMaxNonIdealHBondDistance

GetMaxNonIdealHBondDistance() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMaxNonIdealHBondDistance.

GetMaxPiStackAngle

GetMaxPiStackAngle() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMaxPiStackAngle.

GetMaxPiStackDistance

GetMaxPiStackDistance() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMaxPiStackDistance.

GetMaxProteinIntraDistance

GetMaxProteinIntraDistance() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMaxProteinIntraDistance.

GetMaxSaltBridgeDistance

GetMaxSaltBridgeDistance() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMaxSaltBridgeDistance.

GetMaxTStackAngle

GetMaxTStackAngle() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMaxTStackAngle.

GetMaxTStackDistance

GetMaxTStackDistance() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMaxTStackDistance.

GetMaxUnpairedAngle

GetMaxUnpairedAngle() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMaxUnpairedAngle.

GetMaxUnpairedDistance

GetMaxUnpairedDistance() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMaxUnpairedDistance.

GetMinContactFraction

GetMinContactFraction() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMinContactFraction.

GetMinCovalentFraction

GetMinCovalentFraction() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMinCovalentFraction.

GetMinHBondContactFraction

GetMinHBondContactFraction() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMinHBondContactFraction.

GetMinStackOffset

GetMinStackOffset() -> float

Returns the value set by OEPerceiveInteractionOptions.SetMinStackOffset.

SetMaxAcceptorAngle

SetMaxAcceptorAngle(radians: float) -> None

In perception of a hydrogen bond, we define the angle \(X-A...D\), where A and D are the acceptor and donor respectively, and X is one or more points in space that are located so that an idealized hydrogen-bond would give an angle of \(\pi\). The maximum acceptor angle is the maximum allowed deviation (in radians) from the idealized angle (or the minimum deviation from multiple angles when more than one X position is possible).

Default= \((\pi * \frac{6.0}{36.0})\) = 30 degrees

SetMaxCationPiAngle

SetMaxCationPiAngle(radians: float) -> None

This option sets the maximum allowed angle defined by a point on the vector normal from the pi ring system, the geometric center of the ring system and the geometric center of the charged system. For the purposes of Cation Pi interaction hints, only Lysine, N-methyl Lysine and Arginine are recognized cations. For Lysine and N-methyl Lysine, the charge center is the charged Nitrogen atom, while for the Arginine residue, the charge center will be the geometric center of the Carbon and three Nitrogen atoms that share the resonant charge. Each smallest aromatic ring (independent of ring fusions) is considered separately and a cation can interact with more than one pi system simultaneously.

Default= \((\pi * \frac{10.0}{36.0})\) = 50 degrees

SetMaxCationPiDistance

SetMaxCationPiDistance(dist: float) -> None

This is the maximum allowed distance between the center of a cation system and the center of an aromatic pi system. For the purposes of Cation Pi interaction hints, only Lysine, N-methyl Lysine and Arginine are recognized cations. Each smallest aromatic ring (independent of ring fusions) is considered separately and a cation can interact with more than one pi system simultaneously.

Default= 5.5 Ångströms

SetMaxChargeAidedHBondDistance

SetMaxChargeAidedHBondDistance(dist: float) -> None

For the purpose of hydrogen bond perception, charge assisted hydrogen bonds, are identified when one of the two bonding partners is part of a functional group with a net formal charge. These interactions include dipole - charge interactions and are perceived at slightly longer range than simple hydrogen- bonds by default.

Default= 3.5 Ångströms

SetMaxContactFraction

SetMaxContactFraction(frac: float) -> None

Van der Waals interactions are perceived as non-interacting, in attractive contact, or clashing. The three classes are determined by comparing the atom - atom distance Daa to the sum of the van der Waals radii of the two atoms VDWtot. The distance Daa is represented as a fraction of VDWtot which we will call Faa. If the value of Faa is greater than the value stored in OEPerceiveInteractionOptions.SetMaxContactFraction, then the two atoms are non-interacting. If the value of Faa is between the values set by OEPerceiveInteractionOptions.SetMaxContactFraction and OEPerceiveInteractionOptions.SetMinContactFraction then the atoms are in attractive contact. If the value of Faa is less than OEPerceiveInteractionOptions.SetMinContactFraction then the atoms are clashing.

Any two atoms that are forming a hydrogen bond can be in attractive contact at shorter distances than generic atom pairs because of the balance of forces. To handle this, when two atoms are forming a hydrogen bond, the value of Faa is compared to OEPerceiveInteractionOptions.SetMinHBondContactFraction to determine clashing rather than OEPerceiveInteractionOptions.SetMinContactFraction.

Default = 1.2

SetMaxCovalentFraction

SetMaxCovalentFraction(frac: float) -> None

This function sets the maximum ratio of the distance between to atoms to the sum of their covalent radii allowed for perception of a covalent bond.

Covalent interactions are perceived based on comparing the distance between two atoms D to the sum of the covalent radii SumRc. If D is > SumRc times the value set by OEPerceiveInteractionOptions.SetMinCovalentFraction and D is < SumRc times the value set by OEPerceiveInteractionOptions.SetMaxCovalentFraction, then a covalent interaction will be perceived. Currently no angle constraint is used in perceiving covalent interactions.

Hydrogen and Halide atoms as well as water molecules are excluded from covalent interaction hint perception. Metal atom interactions are perceived as OEChelatorInteractionHint rather than as covalent interactions.

When a covalent interaction exists between atom P of the protein and atom L of the ligand, then no other interactions will be perceived for atoms P and L. Further, atoms bonded to atoms L and P will be excluded from perception of clash or contact interactions. Bonded atoms will be able to participate in other interactions such as hydrogen bonding.

Default = 1.1

SetMaxDonorAngle

SetMaxDonorAngle(radians: float) -> None

In the perception of a hydrogen bond with the interaction \(A...H-D\), the angle \(A-D-H\) is ideally zero in most cases. This function determines the maximum allowed value of this angle in a perceived hydrogen-bond.

Default = \((\pi * \frac{7.0}{36.0})\) = 35 degrees

SetMaxHBondDistance

SetMaxHBondDistance(dist: float) -> None

This function sets the maximum distance between the donor and acceptor heavy atoms for a hydrogen-bond to be perceived.

Default = 3.2 Ångströms

SetMaxHalogenAngle

SetMaxHalogenAngle(radians: float) -> None

In the perception of halogen bonds, there is an angle formed between \(R-X...E/N\) where X is a univalent halogen, E/N are the electrophile or nucleophile, and R is the attachment of the halogen. For nucleophiles, the ideal interaction angle is \(\pi\), for electrophiles, the ideal interaction angle \(\frac{\pi}{2}\). This function determines the maximum allowed deviation (in radian) from these ideal angles, respectively, for perception of a halogen bond.

Default = \((\pi * \frac{7.0}{36.0})\) = 35 degrees

SetMaxHalogenBondDistance

SetMaxHalogenBondDistance(dist: float) -> None

This is the maximum distance between the halogen atom and the electrophile or nucleophile atom for perception of a halogen bond.

Default = 3.2 Ångströms

SetMaxMetalBondDistance

SetMaxMetalBondDistance(dist: float) -> None

This is the maximum distance allowed for an interaction to be perceived between a metal atom and a chelating non-metal atom.

Default = 3.5 Ångströms

SetMaxNonIdealAcceptorAngle

SetMaxNonIdealAcceptorAngle(radians: float) -> None

Sets the maximum angle deviation (in radian) from the non-ideal angle.

Default= \((\pi * \frac{6.0}{36.0})\) = 30 degrees

SetMaxNonIdealDonorAngle

SetMaxNonIdealDonorAngle(radians: float) -> None

Sets the maximum allowed value of this angle in a perceived non-ideal hydrogen bond.

Default= \((\pi * \frac{9.0}{36.0})\) = 45 degrees

SetMaxNonIdealHBondDistance

SetMaxNonIdealHBondDistance(dist: float) -> None

This function sets the maximum distance between the donor and acceptor heavy atoms for a non-ideal hydrogen bond to be perceived.

Default = 3.8 Ångströms

SetMaxPiStackAngle

SetMaxPiStackAngle(radians: float) -> None

Sets the maximum angle deviation (in radian) from the ideal angle calculated between the two aromatic ring normals to be considered for Pi-stacking interaction.

Default = \(\frac{\pi}{9.0}\)

SetMaxPiStackDistance

SetMaxPiStackDistance(dist: float) -> None

Sets the maximum distance (in Ångström) allowed between the geometric center of two aromatic rings in order to being considered for Pi-stacking interaction.

Default = 5.0 Ångströms

SetMaxProteinIntraDistance

SetMaxProteinIntraDistance(dist: float) -> None

Sets the maximum distance (in Ångströms) used to identify protein atoms that are neighbours of the ligand when perceiving intramolecular protein hydrogen bonds and chelator interactions.

Default = 6.0 Ångströms

SetMaxSaltBridgeDistance

SetMaxSaltBridgeDistance(dist: float) -> None

Sets the maximum distance (in Ångströms) allowed between the geometric centers of the two formally charged groups in a perceived salt bridge interaction.

Default = 5.0 Ångströms

SetMaxTStackAngle

SetMaxTStackAngle(radians: float) -> None

Sets the maximum angle deviation (in radian) from the ideal angle (\(\frac{\pi}{2}\)) calculated between the two aromatic ring normals to be considered for T-stacking interaction.

Default = \(\frac{\pi}{9.0}\)

SetMaxTStackDistance

SetMaxTStackDistance(dist: float) -> None

Sets the maximum distance (in Ångström) allowed between the geometric center of two aromatic rings in order to being considered for T-stacking interaction.

Default = 5.35 Ångströms

SetMaxUnpairedAngle

SetMaxUnpairedAngle(radians: float) -> None

In perception of unpaired interactions, the unpaired potential interaction group should be oriented toward the ligand or protein where it could make an interaction. This is the maximum deviation (in radian) allowed between the potential interaction group and the nearest potential partner atom.

Default = \(\frac{\pi}{2}\)

SetMaxUnpairedDistance

SetMaxUnpairedDistance(dist: float) -> None

In perception of unpaired interactions, the unpaired potential interaction group should be within a minimum distance of the nearest potential paired atom. This function sets the maximum distance (in Ångströms) for perception of an unpaired potential.

Default = 5.0 Ångströms

SetMinContactFraction

SetMinContactFraction(frac: float) -> None

der Waals interactions are perceived as non-interacting, in attractive contact, or clashing. The three classes are determined by comparing the atom - atom distance Daa to the sum of the van der Waals radii of the two atoms VDWtot. The distance Daa is represented as a fraction of VDWtot which we will call Faa. If the value of Faa is greater than the value stored in OEPerceiveInteractionOptions.SetMaxContactFraction, then the two atoms are non-interacting. If the value of Faa is between the values set by OEPerceiveInteractionOptions.SetMaxContactFraction and OEPerceiveInteractionOptions.SetMinContactFraction then the atoms are in attractive contact. If the value of Faa is less than OEPerceiveInteractionOptions.SetMinContactFraction then the atoms are clashing.

Any two atoms that are forming a hydrogen bond can be in attractive contact at shorter distances than generic atom pairs because of the balance of forces. To handle this, when two atoms are forming a hydrogen bond, the value of Faa is compared to OEPerceiveInteractionOptions.SetMinHBondContactFraction to determine clashing rather than OEPerceiveInteractionOptions.SetMinContactFraction.

Default = 0.8

SetMinCovalentFraction

SetMinCovalentFraction(frac: float) -> None

This function sets the minimum ratio of the distance between to atoms to the sum of their covalent radii allowed for perception of a covalent bond.

Covalent interactions are perceived based on comparing the distance between two atoms D to the sum of the covalent radii SumRc. If D is > SumRc times the value set by OEPerceiveInteractionOptions.SetMinCovalentFraction and D is < SumRc times the value set by OEPerceiveInteractionOptions.SetMaxCovalentFraction, then a covalent interaction will be perceived. Currently no angle constraint is used in perceiving covalent interactions.

Hydrogen and Halide atoms as well as water molecules are excluded from covalent interaction hint perception. Metal atom interactions are perceived as OEChelatorInteractionHint rather than as covalent interactions.

When a covalent interaction exists between atom P of the protein and atom L of the ligand, then no other interactions will be perceived for atoms P and L. Further, atoms bonded to atoms L and P will be excluded from perception of clash or contact interactions. Bonded atoms will be able to participate in other interactions such as hydrogen bonding.

Default = 0.9

SetMinHBondContactFraction

SetMinHBondContactFraction(frac: float) -> None

der Waals interactions are perceived as non-interacting, in attractive contact, or clashing. The three classes are determined by comparing the atom - atom distance Daa to the sum of the van der Waals radii of the two atoms VDWtot. The distance Daa is represented as a fraction of VDWtot which we will call Faa. If the value of Faa is greater than the value stored in OEPerceiveInteractionOptions.SetMaxContactFraction, then the two atoms are non-interacting. If the value of Faa is between the values set by OEPerceiveInteractionOptions.SetMaxContactFraction and OEPerceiveInteractionOptions.SetMinContactFraction then the atoms are in attractive contact. If the value of Faa is less than OEPerceiveInteractionOptions.SetMinContactFraction then the atoms are clashing.

Any two atoms that are forming a hydrogen bond can be in attractive contact at shorter distances than generic atom pairs because of the balance of forces. To handle this, when two atoms are forming a hydrogen bond, the value of Faa is compared to OEPerceiveInteractionOptions.SetMinHBondContactFraction to determine clashing rather than OEPerceiveInteractionOptions.SetMinContactFraction.

Default = 0.5

SetMinStackOffset

SetMinStackOffset(minOffset: float) -> None

Sets the minimum allowed lateral offset (in Ångströms) used to filter Pi-stacking and T-stacking interaction candidates.

Default = 0.5 Ångströms