Adds label to an image or molecule display.

Note

When adding label associated with atoms it is recommended to use the OEAddLabel along with the OEAddHighlighting function for visual clarity.

void OEAddLabel(OEImageBase& image, const OE2DPoint& center,
const OEHighlightLabel& label)

image
The image in which the label is drawn.
center
The center of the label on the image.
label
The OEHighlightLabel object that stores properties that determine the styles of the label along with the text of the label itself.

Example:

def OEAddLabel_OEImage(image):

label = oedepict.OEHighlightLabel("Hello!")

label.SetBoundingBoxPen(oedepict.OETransparentPen)

label.SetBoundingBoxPen(oedepict.OELightGreyPen)


Example of adding labels to an image

void OEAddLabel(OE2DMolDisplay &disp,
const OEHighlightLabel &label,
const OEChem::OEMatchBase &match)


Adds label to atoms of an OEMatchBase object that can be initialized by substructure search or maximum common substructure search.

disp
The OE2DMolDisplay object on which the label is going to be positioned.
label
The OEHighlightLabel object that stores properties that determine the styles of the label along with the text of the label itself.
match
The label is positioned based on the target atoms of the OEMatchBase object.

Example:

def OEAddLabel_OEMatch(disp):
subs = oechem.OESubSearch("a1aaaaa1")
unique = True
highlightstyle = oedepict.OEHighlightByBallAndStick(oechem.OELightGreen)
for match in subs.Match(disp.GetMolecule(), unique):
label = oedepict.OEHighlightLabel("aromatic", oechem.OELightGreen)


Example of adding label to 6-membered aromatic ring

void OEAddLabel(OE2DMolDisplay &disp,
const OEHighlightLabel &label,
const OEChem::OEAtomBondSet &abset)


Adds label to atoms stored in the OEAtomBondSet object.

disp
The OE2DMolDisplay object on which the label is going to be positioned.
label
The OEHighlightLabel object that stores properties that determine the styles of the label along with the text of the label itself.
abset
The label is positioned based on the atoms stored in the OEAtomBondSet object.

Example:

def OEAddLabel_OEAtomBondSet(disp):
mol = disp.GetMolecule()

ringset = oechem.OEAtomBondSet(mol.GetAtoms(oechem.OEAtomIsInRing()), mol.GetBonds(oechem.OEBondIsInRing()))
ringhighlight = oedepict.OEHighlightByBallAndStick(oechem.OELightGreen)
ringlabel = oedepict.OEHighlightLabel("ring", oechem.OELightGreen)

chainset = oechem.OEAtomBondSet(mol.GetAtoms(oechem.OEAtomIsInChain()), mol.GetBonds(oechem.OEBondIsInChain()))
chainhighlight = oedepict.OEHighlightByBallAndStick(oechem.OEBlueTint)
chainlabel = oedepict.OEHighlightLabel("chain", oechem.OEBlueTint)


Example of adding label to ring and chain components of a molecule

void OEAddLabel(OE2DMolDisplay &disp,
const OEHighlightLabel &label,
const OESystem::OEUnaryPredicate<OEChem::OEAtomBase> &atompred)


Adds label to atoms for which the given atom predicate returns true.

disp
The OE2DMolDisplay object on which the label is going to be positioned.
label
The OEHighlightLabel object that stores properties that determine the styles of the label along with the text of the label itself.
atompred
The label is positioned based on the atoms for which the given atom predicate returns true.

Example:

def OEAddLabel_Predicate(disp):
ringhighlight = oedepict.OEHighlightByBallAndStick(oechem.OELightGreen)