OEIridiumData

Attention

This API is currently available in C++ and Python.

class OEIridiumData

This class contains the Iridium category [Warren-2012], metrics required for categorization, and a methods to determine the Iridium category itself.

See also

hover cursor over graph

Example of visualizing OEIridiumData

Constructors

OEIridiumData() -> OEIridiumData
OEIridiumData(rhs: OEIridiumData) -> OEIridiumData

Default and copy constructor.

operator bool

IsValid() -> bool

Returns whether the OEIridiumData object is valid.

Clear

Clear() -> None

Resets the OEIridiumData object to its initial state.

DetermineCategory

DetermineCategory() -> None

This function uses the internally stored metrics to determine the Iridium category.

See also

GetAltConfs

GetAltConfs() -> bool

Returns whether or not alternative conformations exist for this structure.

GetAsDensity

GetAsDensity() -> float

Returns the active site density coverage (0 to 1).

GetCategory

GetCategory() -> int

Returns the Iridium category from the OEIridiumCategory namespace.

GetDPI

GetDPI() -> float

Returns the diffraction-component precision index (DPI) value.

GetExcipients

GetExcipients() -> bool

Returns whether or not excipients have interactions with the ligand.

GetHasMTZ

GetHasMTZ() -> bool

Returns whether or not an MTZ file exists for this structure.

GetIrrationalRfree

GetIrrationalRfree() -> bool

Returns the irrational Rfree value.

GetLigandDensity

GetLigandDensity() -> float

Returns the ligand density coverage (0 to 1).

GetPackingResidues

GetPackingResidues() -> bool

Returns whether or not packing residues make interactions with the ligand.

GetPartOccupancyLigand

GetPartOccupancyLigand() -> bool

Returns whether or not the ligand has partial occupancy.

GetPartOccupancyProtein

GetPartOccupancyProtein() -> bool

Returns whether or not the protein has partial occupancy.

GetPossibleCovalent

GetPossibleCovalent() -> bool

Returns whether or not potential but unperceived covalent interaction can be found in the active site.

GetRFree

GetRFree() -> float

Returns the Rfree value.

GetResolution

GetResolution() -> float

Returns the resolution of the crystal structure.

SetAltConfs

SetAltConfs(altConfs: bool) -> bool

Sets whether or not alternative conformations exist for this structure.

SetAsDensity

SetAsDensity(asDensity: float) -> bool

Sets the active site density coverage.

SetCategory

SetCategory(category: int) -> bool

Sets the Iridium category from a value in the OEIridiumCategory namespace.

SetDPI

SetDPI(dpi: float) -> bool

Sets the diffraction-component precision index (DPI) value.

SetExcipients

SetExcipients(excipients: bool) -> bool

Sets whether or not excipients have interactions with the ligand.

SetHasMTZ

SetHasMTZ(hasMTZ: bool) -> bool

Sets whether or not an MTZ file exists for this structure.

SetIrrationalRfree

SetIrrationalRfree(irrationalRfree: bool) -> bool

Sets the irrational Rfree value.

SetLigandDensity

SetLigandDensity(ligandDensity: float) -> bool

Sets the ligand density coverage (0 to 1).

SetPackingResidues

SetPackingResidues(packingResidues: bool) -> bool

Sets whether or not packing residues make interactions with the ligand.

SetPartOccupancyLigand

SetPartOccupancyLigand(partOccupancyLigand: bool) -> bool

Sets whether or not the ligand has partial occupancy.

SetPartOccupancyProtein

SetPartOccupancyProtein(partOccupancyProtein: bool) -> bool

Sets whether or not the protein has partial occupancy.

SetPossibleCovalent

SetPossibleCovalent(possibleCovalent: bool) -> bool

Sets whether or not potential but unperceived covalent interaction can be found in the active site.

SetRFree

SetRFree(rFree: float) -> bool

Sets the Rfree value.

SetResolution

SetResolution(resolution: float) -> bool

Sets the resolution of the crystal structure.