OEShapeOverlapDisplay

class OEShapeOverlapDisplay

This class represents OEShapeOverlapDisplay that stores the depiction information of depicting the for molecule of shape overlap. See example in Table: Example of depicting the shape and the color overlap.

Constructors

OEShapeOverlapDisplay(refdisp: OEShapeQueryDisplay,
                      fitmol: Union[OEGraphMol,OEMol,OEQMol]) -> OEShapeOverlapDisplay

Constructs an OEShapeOverlapDisplay object with default depiction options.

refdisp: The OEShapeQueryDisplay object that stores the reference molecule of the shape overlap.
fitmol: The 3D molecule that is overlaid to the reference molecule.

Warning

No overlay is performed to maximize the shape and color overlap between the reference and the fit molecule i.e. the fitmol has to be pre-aligned to the reference molecule stored in the OEShapeQueryDisplay object.

OEShapeOverlapDisplay(refdisp: OEShapeQueryDisplay,
                      fitmol: Union[OEGraphMol,OEMol,OEQMol],
                      sopts: OEShapeOverlapDisplayOptions) -> OEShapeOverlapDisplay
OEShapeOverlapDisplay(refdisp: OEShapeQueryDisplay,
                      fitmol: Union[OEGraphMol,OEMol,OEQMol],
                      copts: OEColorOverlapDisplayOptions) -> OEShapeOverlapDisplay
OEShapeOverlapDisplay(refdisp: OEShapeQueryDisplay,
                      fitmol: Union[OEGraphMol,OEMol,OEQMol],
                      sopts: OEShapeOverlapDisplayOptions,
                      copts: OEColorOverlapDisplayOptions) -> OEShapeOverlapDisplay

Constructs an OEShapeOverlapDisplay object with given depiction options.

refdisp: The OEShapeQueryDisplay object that stores the reference molecule of the shape overlap.
fitmol: The 3D molecule that is overlaid to the reference molecule.
copts: The OEColorOverlapDisplayOptions object that defines how the color atom overlap between the reference and the fit molecule is depicted.
sopts: The OEShapeOverlapDisplayOptions object that defines how the shape overlap between the reference and the fit molecule is depicted.

Warning

No overlay is performed to maximize the shape and color overlap between the reference and the fit molecule i.e. the fitmol has to be pre-aligned to the reference molecule stored in the OEShapeQueryDisplay object.

OEShapeOverlapDisplay(rhs: OEShapeOverlapDisplay) -> OEShapeOverlapDisplay

Copy constructor.

GetTitle

GetTitle() -> str

Returns the title of the molecule the OEShapeOverlapDisplay object was initialized.

IsValid

IsValid() -> bool

Returns whether the OEShapeOverlapDisplay object was initialized successfully. If initialization was attempted either with an invalid OEShapeOverlapDisplay object, an empty fit molecule or a fit molecule without 3D coordinates, then this method returns false.