OEShapeQueryDisplay

class OEShapeQueryDisplay

This class represents OEShapeQueryDisplay that stores the depiction information of a shape query i.e. shape reference molecule. See example in Figure: Example of depicting a shape query.

See also

• The Theory chapter of the Shape TK manual.

• OERenderShapeQuery function

Example of depicting a shape query

Code Example

• Visualizing Shape and Color Overlap OpenEye Python Cookbook recipe

Constructors

OEShapeQueryDisplay(refmol: Union[OEGraphMol,OEMol,OEQMol],
                    cff: OEColorForceField) -> OEShapeQueryDisplay

Constructs an OEShapeQueryDisplay object with default depiction options.

refmol

The 3D reference molecule of the shape overlap.

cff

The OEColorForceField object that defines various chemical centers and their interactions.

OEShapeQueryDisplay(refmol: Union[OEGraphMol,OEMol,OEQMol],
                    cff: OEColorForceField,
                    opts: OEShapeQueryDisplayOptions) -> OEShapeQueryDisplay

Constructs an OEShapeQueryDisplay object with given depiction options.

refmol

The 3D reference molecule of the shape overlap.

cff

The OEColorForceField object that defines various chemical centers and their interactions.

opts

The OEShapeQueryDisplayOptions object that defines how the shape query i.e. reference molecule is depicted.

OEShapeQueryDisplay(refmol: Union[OEGraphMol,OEMol,OEQMol],
                    cffdisp: OEColorForceFieldDisplay) -> OEShapeQueryDisplay

Constructs an OEShapeQueryDisplay object with default depiction options.

refmol

The 3D reference molecule of the shape overlap.

cffdisp

The OEColorForceFieldDisplay object that stores the depiction information of an OEColorForceField object.

OEShapeQueryDisplay(refmol: Union[OEGraphMol,OEMol,OEQMol],
                    cffdisp: OEColorForceFieldDisplay,
                    opts: OEShapeQueryDisplayOptions) -> OEShapeQueryDisplay

Constructs an OEShapeQueryDisplay object with given depiction options.

refmol

The 3D reference molecule of the shape overlap.

cffdisp

The OEColorForceFieldDisplay object that stores the depiction information of an OEColorForceField object.

opts

The OEShapeQueryDisplayOptions object that defines how the shape query i.e. reference molecule is depicted.

OEShapeQueryDisplay(rhs: OEShapeQueryDisplay) -> OEShapeQueryDisplay

Copy constructor.

GetTitle

GetTitle() -> str

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

IsValid

IsValid() -> bool

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