OEBroodOverlay

Attention

This is a preliminary API and may be improved based on user feedback. It is currently available in C++ and Python.

class OEBroodOverlay: public OEBroodOverlayBase

This class defines an interface for fragment overlay optimization against a Brood query.

The OEBroodOverlay class defines the following public methods:

Overlay
SetupRef
Transform

Constructors

OEBroodOverlay(genOpts: OEBroodGeneralOptions = OEBroodGeneralOptions(),
               scoreOpts: OEBroodScoreOptions = OEBroodScoreOptions()) -> OEBroodOverlay

Default constructor.

Overlay

Overlay(packet: OEBroodDBPacket) -> OEBroodScoreVector
Overlay(vecScores: OEBroodScoreVector, packet: OEBroodDBPacket) -> int
Overlay(fragment: OEMol, match: OEBroodScore) -> int

Performs overlay optimization against the specified fragments. The first two overloads optimize against all fragments in the provided OEBroodDBPacket, and return a vector of OEBroodScore values. The third overload performs optimization against the specified fragment and populates the specified OEBroodScore with optimization results. Both the second and third overloads return an optimization status from OEBroodStatusCode.

SetupRef

SetupRef(query: OEBroodQuery) -> int

Sets up the overlay optimization with the desired OEBroodQuery. Method returns OEBroodStatusCode_Success if the initialization is successful, otherwise returns an error code from the OEBroodStatusCode namespace.

Transform

Transform(mol: Union[OEGraphMol,OEMol,OEQMol]) -> bool

Transforms the specified molecule to the optimized overlay position determined by a prior call to Overlay.