Files
rdkit/Code/GraphMol/MolDraw2D/Wrap/rdMolDraw2D.cpp
2026-05-29 05:53:20 +02:00

1610 lines
74 KiB
C++

//
// Copyright (C) 2015-2023 Greg Landrum and other RDKit Contributors
//
// @@ All Rights Reserved @@
// This file is part of the RDKit.
// The contents are covered by the terms of the BSD license
// which is included in the file license.txt, found at the root
// of the RDKit source tree.
//
#ifndef USE_BETTER_ENUMS
#define USE_BETTER_ENUMS
#endif
#define PY_ARRAY_UNIQUE_SYMBOL rdmoldraw2d_array_API
#include <RDBoost/python.h>
#include <RDBoost/boost_numpy.h>
#include <numpy/arrayobject.h>
#include <RDBoost/Wrap.h>
#include <RDBoost/import_array.h>
#include <GraphMol/ROMol.h>
#include <GraphMol/MolDraw2D/MolDraw2D.h>
#include <GraphMol/MolDraw2D/MolDraw2DHelpers.h>
#include <GraphMol/MolDraw2D/MolDraw2DUtils.h>
#include <GraphMol/MolDraw2D/MolDraw2DSVG.h>
#include <Geometry/point.h>
#include <boost/python/suite/indexing/map_indexing_suite.hpp>
#ifdef RDK_BUILD_CAIRO_SUPPORT
#include <cairo.h>
#include <GraphMol/MolDraw2D/MolDraw2DCairo.h>
#endif
namespace python = boost::python;
namespace RDKit {
namespace {
void tagAtomHelper(MolDraw2DSVG &self, const ROMol &mol, double radius,
python::object pyo) {
std::map<std::string, std::string> events;
if (pyo) {
python::dict tDict = python::extract<python::dict>(pyo);
const auto items = tDict.items();
for (unsigned int i = 0; i < python::len(items); ++i) {
const auto item = items[i];
events[python::extract<std::string>(item[0])] =
python::extract<std::string>(item[1]);
}
}
self.tagAtoms(mol, radius, events);
}
void pyDictToColourMap(python::object pyo, ColourPalette &res) {
python::dict tDict = python::extract<python::dict>(pyo);
const auto items = tDict.items();
for (unsigned int i = 0; i < python::len(items); ++i) {
const auto item = items[i];
python::tuple tpl = python::extract<python::tuple>(item[1]);
float r = python::extract<float>(tpl[0]);
float g = python::extract<float>(tpl[1]);
float b = python::extract<float>(tpl[2]);
float a = 1.0;
if (python::len(tpl) > 3) {
a = python::extract<float>(tpl[3]);
}
DrawColour clr(r, g, b, a);
res[python::extract<int>(item[0])] = clr;
}
}
ColourPalette *pyDictToColourMap(python::object pyo) {
ColourPalette *res = nullptr;
if (pyo) {
res = new ColourPalette;
pyDictToColourMap(pyo, *res);
}
return res;
}
void pyDictToDoubleMap(python::object pyo, std::map<int, double> &res) {
python::dict tDict = python::extract<python::dict>(pyo);
const auto items = tDict.items();
for (unsigned int i = 0; i < python::len(items); ++i) {
const auto item = items[i];
double r = python::extract<double>(item[1]);
res[python::extract<int>(item[0])] = r;
}
}
std::map<int, double> *pyDictToDoubleMap(python::object pyo) {
std::map<int, double> *res = nullptr;
if (pyo) {
res = new std::map<int, double>;
pyDictToDoubleMap(pyo, *res);
}
return res;
}
void pyDictToIntMap(python::object pyo, std::map<int, int> &res) {
python::dict tDict = python::extract<python::dict>(pyo);
const auto items = tDict.items();
for (unsigned int i = 0; i < python::len(items); ++i) {
const auto item = items[i];
int r = python::extract<int>(item[1]);
res[python::extract<int>(item[0])] = r;
}
}
std::map<int, int> *pyDictToIntMap(python::object pyo) {
std::map<int, int> *res = nullptr;
if (pyo) {
res = new std::map<int, int>;
pyDictToIntMap(pyo, *res);
}
return res;
}
DrawColour pyTupleToDrawColour(const python::tuple tpl) {
float r = python::extract<float>(tpl[0]);
if (r > 1 || r < 0) {
throw ValueErrorException("RGBA color value needs to be between 0 and 1.");
}
float g = python::extract<float>(tpl[1]);
if (g > 1 || g < 0) {
throw ValueErrorException("RGBA color value needs to be between 0 and 1.");
}
float b = python::extract<float>(tpl[2]);
if (b > 1 || b < 0) {
throw ValueErrorException("RGBA color value needs to be between 0 and 1.");
}
float a = 1;
if (python::len(tpl) > 3) {
a = python::extract<float>(tpl[3]);
if (a > 1 || a < 0) {
throw ValueErrorException(
"RGBA color value needs to be between 0 and 1.");
}
}
DrawColour clr(r, g, b, a);
return clr;
}
void pyListToColourVec(python::object pyo, std::vector<DrawColour> &res) {
res.clear();
python::list tList = python::extract<python::list>(pyo);
for (unsigned int i = 0; i < python::len(tList); ++i) {
python::tuple tpl = python::extract<python::tuple>(tList[i]);
res.push_back(pyTupleToDrawColour(tpl));
}
}
} // namespace
void pyDictToMapColourVec(python::object pyo,
std::map<int, std::vector<DrawColour>> &res) {
python::dict tDict = python::extract<python::dict>(pyo);
const auto items = tDict.items();
for (unsigned int i = 0; i < python::len(items); ++i) {
const auto item = items[i];
python::list pl = python::extract<python::list>(item[1]);
std::vector<DrawColour> v;
pyListToColourVec(pl, v);
res[python::extract<int>(item[0])] = v;
}
}
std::map<int, std::vector<DrawColour>> *pyDictToMapColourVec(
python::object pyo) {
std::map<int, std::vector<DrawColour>> *res = nullptr;
if (pyo) {
res = new std::map<int, std::vector<DrawColour>>;
pyDictToMapColourVec(pyo, *res);
}
return res;
}
void drawMoleculeHelper1(MolDraw2D &self, const ROMol &mol,
python::object highlight_atoms,
python::object highlight_atom_map,
python::object highlight_atom_radii, int confId,
std::string legend) {
std::unique_ptr<std::vector<int>> highlightAtoms =
pythonObjectToVect(highlight_atoms, static_cast<int>(mol.getNumAtoms()));
ColourPalette *ham = pyDictToColourMap(highlight_atom_map);
std::map<int, double> *har = pyDictToDoubleMap(highlight_atom_radii);
self.drawMolecule(mol, legend, highlightAtoms.get(), ham, har, confId);
delete ham;
delete har;
}
void drawMoleculeHelper2(MolDraw2D &self, const ROMol &mol,
python::object highlight_atoms,
python::object highlight_bonds,
python::object highlight_atom_map,
python::object highlight_bond_map,
python::object highlight_atom_radii, int confId,
std::string legend) {
std::unique_ptr<std::vector<int>> highlightAtoms =
pythonObjectToVect(highlight_atoms, static_cast<int>(mol.getNumAtoms()));
std::unique_ptr<std::vector<int>> highlightBonds =
pythonObjectToVect(highlight_bonds, static_cast<int>(mol.getNumBonds()));
// FIX: support these
ColourPalette *ham = pyDictToColourMap(highlight_atom_map);
ColourPalette *hbm = pyDictToColourMap(highlight_bond_map);
std::map<int, double> *har = pyDictToDoubleMap(highlight_atom_radii);
self.drawMolecule(mol, legend, highlightAtoms.get(), highlightBonds.get(),
ham, hbm, har, confId);
delete ham;
delete hbm;
delete har;
}
python::tuple getMolSizeHelper(MolDraw2D &self, const ROMol &mol,
python::object highlight_atoms,
python::object highlight_bonds,
python::object highlight_atom_map,
python::object highlight_bond_map,
python::object highlight_atom_radii, int confId,
std::string legend) {
std::unique_ptr<std::vector<int>> highlightAtoms =
pythonObjectToVect(highlight_atoms, static_cast<int>(mol.getNumAtoms()));
std::unique_ptr<std::vector<int>> highlightBonds =
pythonObjectToVect(highlight_bonds, static_cast<int>(mol.getNumBonds()));
// FIX: support these
ColourPalette *ham = pyDictToColourMap(highlight_atom_map);
ColourPalette *hbm = pyDictToColourMap(highlight_bond_map);
std::map<int, double> *har = pyDictToDoubleMap(highlight_atom_radii);
auto sz = self.getMolSize(mol, legend, highlightAtoms.get(),
highlightBonds.get(), ham, hbm, har, confId);
delete ham;
delete hbm;
delete har;
python::list res;
res.append(sz.first);
res.append(sz.second);
return python::tuple(res);
}
void drawMoleculeWithHighlightsHelper(
MolDraw2D &self, const ROMol &mol, std::string legend,
python::object highlight_atom_map, python::object highlight_bond_map,
python::object highlight_atom_radii,
python::object highlight_linewidth_multipliers, int confId) {
// highlight_atom_map and highlight_bond_map come in as a dict of
// lists of tuples of floats (the R, G, B values for the colours),
// and need to be changed to a map of vectors of DrawColour.
// All of the dict to map converters return nullptr if the dict
// was empty. We need real objects in all cases for
// drawMoleculeWithHighlights.
std::map<int, std::vector<DrawColour>> *ham =
pyDictToMapColourVec(highlight_atom_map);
if (!ham) {
ham = new std::map<int, std::vector<DrawColour>>();
}
std::map<int, std::vector<DrawColour>> *hbm =
pyDictToMapColourVec(highlight_bond_map);
if (!hbm) {
hbm = new std::map<int, std::vector<DrawColour>>();
}
std::map<int, double> *har = pyDictToDoubleMap(highlight_atom_radii);
if (!har) {
har = new std::map<int, double>();
}
std::map<int, int> *hlm = pyDictToIntMap(highlight_linewidth_multipliers);
if (!hlm) {
hlm = new std::map<int, int>();
}
self.drawMoleculeWithHighlights(mol, legend, *ham, *hbm, *har, *hlm, confId);
delete ham;
delete hbm;
delete har;
delete hlm;
}
void prepareAndDrawMoleculeHelper(
MolDraw2D &drawer, const ROMol &mol, std::string legend,
python::object highlight_atoms, python::object highlight_bonds,
python::object highlight_atom_map, python::object highlight_bond_map,
python::object highlight_atom_radii, int confId, bool kekulize) {
std::unique_ptr<std::vector<int>> highlightAtoms =
pythonObjectToVect(highlight_atoms, static_cast<int>(mol.getNumAtoms()));
std::unique_ptr<std::vector<int>> highlightBonds =
pythonObjectToVect(highlight_bonds, static_cast<int>(mol.getNumBonds()));
// FIX: support these
ColourPalette *ham = pyDictToColourMap(highlight_atom_map);
ColourPalette *hbm = pyDictToColourMap(highlight_bond_map);
std::map<int, double> *har = pyDictToDoubleMap(highlight_atom_radii);
MolDraw2DUtils::prepareAndDrawMolecule(
drawer, mol, legend, highlightAtoms.get(), highlightBonds.get(), ham, hbm,
har, confId, kekulize);
delete ham;
delete hbm;
delete har;
}
void drawMoleculeACS1996Helper(
MolDraw2D &drawer, const ROMol &mol, std::string legend,
python::object highlight_atoms, python::object highlight_bonds,
python::object highlight_atom_map, python::object highlight_bond_map,
python::object highlight_atom_radii, int confId) {
std::unique_ptr<std::vector<int>> highlightAtoms =
pythonObjectToVect(highlight_atoms, static_cast<int>(mol.getNumAtoms()));
std::unique_ptr<std::vector<int>> highlightBonds =
pythonObjectToVect(highlight_bonds, static_cast<int>(mol.getNumBonds()));
std::unique_ptr<ColourPalette> ham{pyDictToColourMap(highlight_atom_map)};
std::unique_ptr<ColourPalette> hbm{pyDictToColourMap(highlight_bond_map)};
std::unique_ptr<std::map<int, double>> har{
pyDictToDoubleMap(highlight_atom_radii)};
MolDraw2DUtils::drawMolACS1996(drawer, mol, legend, highlightAtoms.get(),
highlightBonds.get(), ham.get(), hbm.get(),
har.get(), confId);
}
void drawMoleculesHelper2(MolDraw2D &self, python::object pmols,
python::object highlight_atoms,
python::object highlight_bonds,
python::object highlight_atom_map,
python::object highlight_bond_map,
python::object highlight_atom_radii,
python::object pconfIds, python::object plegends) {
std::unique_ptr<std::vector<ROMol *>> mols =
pythonObjectToVect<ROMol *>(pmols);
if (mols == nullptr || !mols->size()) {
return;
}
unsigned int nThere = mols->size();
std::unique_ptr<std::vector<std::vector<int>>> highlightAtoms;
if (highlight_atoms) {
if (python::len(highlight_atoms) != nThere) {
throw ValueErrorException(
"If highlightAtoms is provided it must be the same length as the "
"molecule list.");
}
highlightAtoms.reset(new std::vector<std::vector<int>>(nThere));
for (unsigned int i = 0; i < nThere; ++i) {
pythonObjectToVect(highlight_atoms[i], (*highlightAtoms)[i]);
}
}
std::unique_ptr<std::vector<std::vector<int>>> highlightBonds;
if (highlight_bonds) {
if (python::len(highlight_bonds) != nThere) {
throw ValueErrorException(
"If highlightBonds is provided it must be the same length as the "
"molecule list.");
}
highlightBonds.reset(new std::vector<std::vector<int>>(nThere));
for (unsigned int i = 0; i < nThere; ++i) {
pythonObjectToVect(highlight_bonds[i], (*highlightBonds)[i]);
}
}
std::unique_ptr<std::vector<ColourPalette>> highlightAtomMap;
if (highlight_atom_map) {
if (python::len(highlight_atom_map) != nThere) {
throw ValueErrorException(
"If highlightAtomMap is provided it must be the same length as the "
"molecule list.");
}
highlightAtomMap.reset(new std::vector<ColourPalette>(nThere));
for (unsigned int i = 0; i < nThere; ++i) {
pyDictToColourMap(highlight_atom_map[i], (*highlightAtomMap)[i]);
}
}
std::unique_ptr<std::vector<ColourPalette>> highlightBondMap;
if (highlight_bond_map) {
if (python::len(highlight_bond_map) != nThere) {
throw ValueErrorException(
"If highlightBondMap is provided it must be the same length as the "
"molecule list.");
}
highlightBondMap.reset(new std::vector<ColourPalette>(nThere));
for (unsigned int i = 0; i < nThere; ++i) {
pyDictToColourMap(highlight_bond_map[i], (*highlightBondMap)[i]);
}
}
std::unique_ptr<std::vector<std::map<int, double>>> highlightRadii;
if (highlight_atom_radii) {
if (python::len(highlight_atom_radii) != nThere) {
throw ValueErrorException(
"If highlightAtomRadii is provided it must be the same length as the "
"molecule list.");
}
highlightRadii.reset(new std::vector<std::map<int, double>>(nThere));
for (unsigned int i = 0; i < nThere; ++i) {
pyDictToDoubleMap(highlight_atom_radii[i], (*highlightRadii)[i]);
}
}
// std::unique_ptr<std::vector<int> > highlightAtoms =
// pythonObjectToVect(highlight_atoms,
// static_cast<int>(mol.getNumAtoms()));
// std::unique_ptr<std::vector<int> > highlightBonds =
// pythonObjectToVect(highlight_bonds,
// static_cast<int>(mol.getNumBonds()));
// FIX: support these
// std::map<int, DrawColour> *ham = pyDictToColourMap(highlight_atom_map);
// std::map<int, DrawColour> *hbm = pyDictToColourMap(highlight_bond_map);
// std::map<int, double> *har = pyDictToDoubleMap(highlight_atom_radii);
//
std::unique_ptr<std::vector<int>> confIds = pythonObjectToVect<int>(pconfIds);
std::unique_ptr<std::vector<std::string>> legends =
pythonObjectToVect<std::string>(plegends);
self.drawMolecules(*mols, legends.get(), highlightAtoms.get(),
highlightBonds.get(), highlightAtomMap.get(),
highlightBondMap.get(), highlightRadii.get(),
confIds.get());
}
void drawReactionHelper(MolDraw2D &self, const ChemicalReaction &rxn,
bool highlightByReactant,
python::object phighlightColorsReactants,
python::object pconfIds) {
std::unique_ptr<std::vector<DrawColour>> highlightColorsReactants;
if (phighlightColorsReactants) {
highlightColorsReactants.reset(new std::vector<DrawColour>);
pyListToColourVec(phighlightColorsReactants, *highlightColorsReactants);
}
std::unique_ptr<std::vector<int>> confIds = pythonObjectToVect<int>(pconfIds);
self.drawReaction(rxn, highlightByReactant, highlightColorsReactants.get(),
confIds.get());
}
#ifdef RDK_BUILD_CAIRO_SUPPORT
python::object getCairoDrawingText(const RDKit::MolDraw2DCairo &self) {
std::string res = self.getDrawingText();
python::object retval = python::object(
python::handle<>(PyBytes_FromStringAndSize(res.c_str(), res.length())));
return retval;
}
#endif
ROMol *prepMolForDrawing(const ROMol *m, bool kekulize, bool addChiralHs,
bool wedgeBonds, bool forceCoords, bool wavyBonds) {
PRECONDITION(m, "molecule must not be None");
auto *res = new RWMol(*m);
MolDraw2DUtils::prepareMolForDrawing(*res, kekulize, addChiralHs, wedgeBonds,
forceCoords, wavyBonds);
return static_cast<ROMol *>(res);
}
python::tuple colourToPyTuple(const DrawColour &clr) {
python::list res;
res.append(clr.r);
res.append(clr.g);
res.append(clr.b);
res.append(clr.a);
return python::tuple(res);
}
python::object getBgColour(const RDKit::MolDrawOptions &self) {
return colourToPyTuple(self.backgroundColour);
}
python::object getQyColour(const RDKit::MolDrawOptions &self) {
return colourToPyTuple(self.queryColour);
}
python::object getHighlightColour(const RDKit::MolDrawOptions &self) {
return colourToPyTuple(self.highlightColour);
}
void setBgColour(RDKit::MolDrawOptions &self, python::tuple tpl) {
self.backgroundColour = pyTupleToDrawColour(tpl);
}
void setQyColour(RDKit::MolDrawOptions &self, python::tuple tpl) {
self.queryColour = pyTupleToDrawColour(tpl);
}
void setHighlightColour(RDKit::MolDrawOptions &self, python::tuple tpl) {
self.highlightColour = pyTupleToDrawColour(tpl);
}
python::object getSymbolColour(const RDKit::MolDrawOptions &self) {
return colourToPyTuple(self.symbolColour);
}
void setSymbolColour(RDKit::MolDrawOptions &self, python::tuple tpl) {
self.symbolColour = pyTupleToDrawColour(tpl);
}
python::object getLegendColour(const RDKit::MolDrawOptions &self) {
return colourToPyTuple(self.legendColour);
}
void setLegendColour(RDKit::MolDrawOptions &self, python::tuple tpl) {
self.legendColour = pyTupleToDrawColour(tpl);
}
python::object getAnnotationColour(const RDKit::MolDrawOptions &self) {
return colourToPyTuple(self.annotationColour);
}
void setAnnotationColour(RDKit::MolDrawOptions &self, python::tuple tpl) {
self.annotationColour = pyTupleToDrawColour(tpl);
}
void setAtomNoteColour(RDKit::MolDrawOptions &self, python::tuple tpl) {
self.atomNoteColour = pyTupleToDrawColour(tpl);
}
python::object getAtomNoteColour(const RDKit::MolDrawOptions &self) {
return colourToPyTuple(self.atomNoteColour);
}
void setBondNoteColour(RDKit::MolDrawOptions &self, python::tuple tpl) {
self.bondNoteColour = pyTupleToDrawColour(tpl);
}
python::object getBondNoteColour(const RDKit::MolDrawOptions &self) {
return colourToPyTuple(self.bondNoteColour);
}
python::object getVariableAttachmentColour(const RDKit::MolDrawOptions &self) {
return colourToPyTuple(self.variableAttachmentColour);
}
void setVariableAttachmentColour(RDKit::MolDrawOptions &self,
python::tuple tpl) {
self.variableAttachmentColour = pyTupleToDrawColour(tpl);
}
void useDefaultAtomPalette(RDKit::MolDrawOptions &self) {
assignDefaultPalette(self.atomColourPalette);
}
void useBWAtomPalette(RDKit::MolDrawOptions &self) {
assignBWPalette(self.atomColourPalette);
}
void useAvalonAtomPalette(RDKit::MolDrawOptions &self) {
assignAvalonPalette(self.atomColourPalette);
}
void useCDKAtomPalette(RDKit::MolDrawOptions &self) {
assignCDKPalette(self.atomColourPalette);
}
void updateAtomPalette(RDKit::MolDrawOptions &self, python::object cmap) {
pyDictToColourMap(cmap, self.atomColourPalette);
}
void setAtomPalette(RDKit::MolDrawOptions &self, python::object cmap) {
self.atomColourPalette.clear();
updateAtomPalette(self, cmap);
}
python::dict getAtomPalette(const RDKit::MolDrawOptions &self) {
python::dict res;
for (const auto &pair : self.atomColourPalette) {
res[pair.first] = colourToPyTuple(pair.second);
}
return res;
}
void setMonochromeMode_helper1(RDKit::MolDrawOptions &options, python::tuple fg,
python::tuple bg) {
auto fgc = pyTupleToDrawColour(fg);
auto bgc = pyTupleToDrawColour(bg);
RDKit::setMonochromeMode(options, fgc, bgc);
}
void setMonochromeMode_helper2(RDKit::MolDraw2D &d2d, python::tuple fg,
python::tuple bg) {
auto fgc = pyTupleToDrawColour(fg);
auto bgc = pyTupleToDrawColour(bg);
RDKit::setMonochromeMode(d2d, fgc, bgc);
}
void contourAndDrawGaussiansHelper(
RDKit::MolDraw2D &drawer, python::object pylocs, python::object pyheights,
python::object pywidths, unsigned int nContours, python::object pylevels,
const MolDraw2DUtils::ContourParams &params, python::object mol) {
std::unique_ptr<std::vector<RDGeom::Point2D>> locs =
pythonObjectToVect<RDGeom::Point2D>(pylocs);
if (!locs) {
throw_value_error("locs argument must be non-empty");
}
std::unique_ptr<std::vector<double>> heights =
pythonObjectToVect<double>(pyheights);
if (!heights) {
throw_value_error("heights argument must be non-empty");
}
std::unique_ptr<std::vector<double>> widths =
pythonObjectToVect<double>(pywidths);
if (!widths) {
throw_value_error("widths argument must be non-empty");
}
std::unique_ptr<std::vector<double>> levels;
if (pylevels) {
levels = pythonObjectToVect<double>(pylevels);
} else {
levels = std::unique_ptr<std::vector<double>>(new std::vector<double>);
}
ROMol *mol_p = nullptr;
if (mol) {
mol_p = python::extract<ROMol *>(mol);
}
MolDraw2DUtils::contourAndDrawGaussians(drawer, *locs, *heights, *widths,
nContours, *levels, params, mol_p);
}
void contourAndDrawGridHelper(RDKit::MolDraw2D &drawer, python::object &data,
python::object &pyxcoords,
python::object &pyycoords, unsigned int nContours,
python::object &pylevels,
const MolDraw2DUtils::ContourParams &params,
python::object mol) {
if (!PyArray_Check(data.ptr())) {
throw_value_error("data argument must be a numpy array");
}
auto *dataArr = reinterpret_cast<PyArrayObject *>(
PyArray_ContiguousFromObject(data.ptr(), NPY_DOUBLE, 2, 2));
if (!dataArr) {
throw_value_error("could not convert data argument");
}
std::unique_ptr<std::vector<double>> xcoords =
pythonObjectToVect<double>(pyxcoords);
if (!xcoords) {
throw_value_error("xcoords argument must be non-empty");
}
std::unique_ptr<std::vector<double>> ycoords =
pythonObjectToVect<double>(pyycoords);
if (!ycoords) {
throw_value_error("ycoords argument must be non-empty");
}
std::unique_ptr<std::vector<double>> levels;
if (pylevels) {
levels = pythonObjectToVect<double>(pylevels);
} else {
levels = std::unique_ptr<std::vector<double>>(new std::vector<double>);
}
if (PyArray_DIM(dataArr, 0) != static_cast<int>(xcoords->size())) {
throw_value_error(
"data array and xcoords sizes do not match.\n"
"Did you forget to call np.transpose() on the array?");
}
if (PyArray_DIM(dataArr, 1) != static_cast<int>(ycoords->size())) {
throw_value_error("data array and ycoords sizes do not match");
}
ROMol *mol_p = nullptr;
if (mol) {
mol_p = python::extract<RDKit::ROMol *>(mol);
}
MolDraw2DUtils::contourAndDrawGrid(drawer, (double *)PyArray_DATA(dataArr),
*xcoords, *ycoords, nContours, *levels,
params, mol_p);
Py_DECREF(dataArr);
}
void setColoursHelper(RDKit::MolDraw2DUtils::ContourParams &params,
python::object pycolors) {
std::vector<RDKit::DrawColour> cs;
for (unsigned int i = 0; i < python::len(pycolors); ++i) {
cs.push_back(
pyTupleToDrawColour(python::extract<python::tuple>(pycolors[i])));
}
params.colourMap = cs;
}
python::tuple getColoursHelper(
const RDKit::MolDraw2DUtils::ContourParams &params) {
python::list res;
for (const auto &clr : params.colourMap) {
res.append(colourToPyTuple(clr));
}
return python::tuple(res);
}
void setContourColour(RDKit::MolDraw2DUtils::ContourParams &params,
python::tuple tpl) {
params.contourColour = pyTupleToDrawColour(tpl);
}
python::object getContourColour(
const RDKit::MolDraw2DUtils::ContourParams &params) {
return colourToPyTuple(params.contourColour);
}
void drawPolygonHelper(RDKit::MolDraw2D &self, python::object py_cds,
bool rawCoords) {
std::unique_ptr<std::vector<RDGeom::Point2D>> cds =
pythonObjectToVect<RDGeom::Point2D>(py_cds);
if (!cds) {
throw_value_error("cds argument must be non-empty");
}
self.drawPolygon(*cds, rawCoords);
}
void drawAttachmentLineHelper(RDKit::MolDraw2D &self, const Point2D &cds1,
const Point2D &cds2, python::tuple &pycol,
double len, unsigned int nSegments,
bool rawCoords) {
auto col = pyTupleToDrawColour(pycol);
self.drawAttachmentLine(cds1, cds2, col, len, nSegments, rawCoords);
}
void drawWavyLineHelper(RDKit::MolDraw2D &self, const Point2D &cds1,
const Point2D &cds2, python::tuple &pycol1,
python::tuple &pycol2, unsigned int nSegments,
double vertOffset, bool rawCoords) {
auto col1 = pyTupleToDrawColour(pycol1);
auto col2 = pyTupleToDrawColour(pycol2);
self.drawWavyLine(cds1, cds2, col1, col2, nSegments, vertOffset, rawCoords);
}
void drawArrowHelper(RDKit::MolDraw2D &self, const Point2D &cds1,
const Point2D &cds2, bool asPolygon, double frac,
double angle, python::object pycol, bool rawCoords) {
DrawColour col{0.0, 0.0, 0.0};
if (pycol) {
python::tuple pytup = python::extract<python::tuple>(pycol);
col = pyTupleToDrawColour(pytup);
}
self.drawArrow(cds1, cds2, asPolygon, frac, angle, col, rawCoords);
}
void setDrawOptions(RDKit::MolDraw2D &self, const MolDrawOptions &opts) {
self.drawOptions() = opts;
}
void setDrawerColour(RDKit::MolDraw2D &self, python::tuple tpl) {
self.setColour(pyTupleToDrawColour(tpl));
}
void updateMolDrawOptionsHelper(RDKit::MolDrawOptions &obj, std::string json) {
MolDraw2DUtils::updateMolDrawOptionsFromJSON(obj, json);
}
void updateDrawerParamsHelper(RDKit::MolDraw2D &obj, std::string json) {
MolDraw2DUtils::updateDrawerParamsFromJSON(obj, json);
}
std::string molToSVG(const ROMol &mol, unsigned int width, unsigned int height,
python::object pyHighlightAtoms, bool kekulize,
unsigned int lineWidthMult, bool includeAtomCircles,
int confId) {
// FIX: we really should be using kekulize here
RDUNUSED_PARAM(kekulize);
std::unique_ptr<std::vector<int>> highlightAtoms =
pythonObjectToVect(pyHighlightAtoms, static_cast<int>(mol.getNumAtoms()));
std::stringstream outs;
MolDraw2DSVG drawer(width, height, outs);
drawer.setLineWidth(drawer.lineWidth() * lineWidthMult);
drawer.drawOptions().circleAtoms = includeAtomCircles;
drawer.drawOptions().prepareMolsBeforeDrawing = false;
drawer.drawMolecule(mol, highlightAtoms.get(), nullptr, nullptr, confId);
drawer.finishDrawing();
return outs.str();
}
std::string molToACS1996SVG(const ROMol &mol, std::string legend,
python::object highlight_atoms,
python::object highlight_bonds,
python::object highlight_atom_map,
python::object highlight_bond_map,
python::object highlight_atom_radii, int confId) {
std::stringstream outs;
MolDraw2DSVG drawer(-1, -1, outs);
drawMoleculeACS1996Helper(drawer, mol, legend, highlight_atoms,
highlight_bonds, highlight_atom_map,
highlight_bond_map, highlight_atom_radii, confId);
drawer.finishDrawing();
return outs.str();
}
void setACS1996ModeHelper(MolDrawOptions &drawOptions, double meanBondLen) {
MolDraw2DUtils::setACS1996Options(drawOptions, meanBondLen);
}
void drawStringHelper(MolDraw2D &self, std::string text, const Point2D &loc,
int align, bool rawCoords) {
MolDraw2D_detail::TextAlignType talign =
MolDraw2D_detail::TextAlignType::MIDDLE;
switch (align) {
case 0:
talign = MolDraw2D_detail::TextAlignType::MIDDLE;
break;
case 1:
talign = MolDraw2D_detail::TextAlignType::START;
break;
case 2:
talign = MolDraw2D_detail::TextAlignType::END;
break;
default:
throw_value_error("align must be 0, 1, or 2");
}
self.drawString(text, loc, talign, rawCoords);
}
void setScaleHelper(MolDraw2D &self, int width, int height, const Point2D &minv,
const Point2D &maxv, python::object mol) {
ROMol *mol_p = nullptr;
if (mol) {
mol_p = python::extract<RDKit::ROMol *>(mol);
}
self.setScale(width, height, minv, maxv, mol_p);
}
} // namespace RDKit
BOOST_PYTHON_MODULE(rdMolDraw2D) {
python::scope().attr("__doc__") =
"Module containing a C++ implementation of 2D molecule drawing";
rdkit_import_array();
if (!is_python_converter_registered<std::map<int, std::string>>()) {
python::class_<std::map<int, std::string>>("IntStringMap")
.def(python::map_indexing_suite<std::map<int, std::string>, true>());
}
python::enum_<RDKit::MultiColourHighlightStyle>("MultiColourHighlightStyle")
.value("CircleAndLine", RDKit::MultiColourHighlightStyle::CIRCLEANDLINE)
.value("Lasso", RDKit::MultiColourHighlightStyle::LASSO)
.export_values();
python::enum_<RDKit::MolDrawOptions::LegendPosition>("LegendPosition")
.value("Bottom", RDKit::MolDrawOptions::LegendPosition::Bottom)
.value("Top", RDKit::MolDrawOptions::LegendPosition::Top)
.value("Left", RDKit::MolDrawOptions::LegendPosition::Left)
.value("Right", RDKit::MolDrawOptions::LegendPosition::Right)
.export_values();
{
python::enum_<RDKit::DrawElement::_enumerated> drawElementEnum(
"DrawElement");
for (const auto *key : RDKit::DrawElement::_names()) {
drawElementEnum.value(key, RDKit::DrawElement::_from_string(key));
}
drawElementEnum.export_values();
}
std::string docString = "Drawing options";
python::class_<RDKit::MolDrawOptions, boost::noncopyable>("MolDrawOptions",
docString.c_str())
.def_readwrite("dummiesAreAttachments",
&RDKit::MolDrawOptions::dummiesAreAttachments)
.def_readwrite("circleAtoms", &RDKit::MolDrawOptions::circleAtoms)
.def_readwrite("splitBonds", &RDKit::MolDrawOptions::splitBonds)
.add_property(
"backgroundColour", &RDKit::getBgColour, &RDKit::setBgColour,
"the background colour as an (R,G,B,A) tuple, values should be between 0 and 1")
.add_property(
"queryColour", &RDKit::getQyColour, &RDKit::setQyColour,
"the query colour as an (R,G,B,A) tuple, values should be between 0 and 1")
.add_property(
"highlightColour", &RDKit::getHighlightColour,
&RDKit::setHighlightColour,
"the highlight colour as an (R,G,B,A) tuple, values should be between 0 and 1")
.add_property(
"symbolColour", &RDKit::getSymbolColour, &RDKit::setSymbolColour,
"the symbol colour as an (R,G,B,A) tuple, values should be between 0 and 1")
.add_property(
"annotationColour", &RDKit::getAnnotationColour,
&RDKit::setAnnotationColour,
"the annotation colour as an (R,G,B,A) tuple, values should be between 0 and 1")
.add_property(
"atomNoteColour", &RDKit::getAtomNoteColour,
&RDKit::setAtomNoteColour,
"the atom note colour as an (R,G,B,A) tuple, values should be between 0 and 1")
.add_property(
"bondNoteColour", &RDKit::getBondNoteColour,
&RDKit::setBondNoteColour,
"the bond note colour as an (R,G,B,A) tuple, values should be between 0 and 1")
.add_property(
"legendColour", &RDKit::getLegendColour, &RDKit::setLegendColour,
"the legend colour as an (R,G,B,A) tuple, values should be between 0 and 1")
.add_property(
"variableAttachmentColour", &RDKit::getVariableAttachmentColour,
&RDKit::setVariableAttachmentColour,
"the variable attachment colour as an (R,G,B,A) tuple, values should be between 0 and 1")
.def("getBackgroundColour", &RDKit::getBgColour, python::args("self"),
"method returning the background colour")
.def("getQueryColour", &RDKit::getQyColour, python::args("self"),
"method returning the query colour")
.def("getHighlightColour", &RDKit::getHighlightColour,
python::args("self"), "method returning the highlight colour")
.def("setBackgroundColour", &RDKit::setBgColour,
python::args("self", "tpl"),
"method for setting the background colour")
.def("setQueryColour", &RDKit::setQyColour, python::args("self", "tpl"),
"method for setting the query colour")
.def("setHighlightColour", &RDKit::setHighlightColour,
python::args("self", "tpl"),
"method for setting the highlight colour")
.def("getSymbolColour", &RDKit::getSymbolColour, python::args("self"),
"method returning the symbol colour")
.def("setSymbolColour", &RDKit::setSymbolColour,
python::args("self", "tpl"), "method for setting the symbol colour")
.def("getAnnotationColour", &RDKit::getAnnotationColour,
python::args("self"), "method returning the annotation colour")
.def("setAnnotationColour", &RDKit::setAnnotationColour,
python::args("self", "tpl"),
"method for setting the annotation colour")
.def("setAtomNoteColour", &RDKit::setAtomNoteColour,
python::args("self", "tpl"),
"method for setting the atom note colour")
.def("getAtomNoteColour", &RDKit::getAtomNoteColour, python::args("self"),
"method returning the atom note colour")
.def("setBondNoteColour", &RDKit::setBondNoteColour,
python::args("self", "tpl"),
"method for setting the bond note colour")
.def("getBondNoteColour", &RDKit::getBondNoteColour, python::args("self"),
"method returning the bond note colour")
.def("getLegendColour", &RDKit::getLegendColour, python::args("self"),
"method returning the legend colour")
.def("setLegendColour", &RDKit::setLegendColour,
python::args("self", "tpl"), "method for setting the legend colour")
.def("useDefaultAtomPalette", &RDKit::useDefaultAtomPalette,
python::args("self"),
"use the default colour palette for atoms and bonds")
.def("useBWAtomPalette", &RDKit::useBWAtomPalette, python::args("self"),
"use a black and white palette for atoms and bonds")
.def("useAvalonAtomPalette", &RDKit::useAvalonAtomPalette,
python::args("self"),
"use the Avalon renderer palette for atoms and bonds")
.def("useCDKAtomPalette", &RDKit::useCDKAtomPalette, python::args("self"),
"use the CDK palette for atoms and bonds")
.def("updateAtomPalette", &RDKit::updateAtomPalette,
python::args("self", "cmap"),
"updates the palette for atoms and bonds from a dictionary mapping "
"ints to 3-tuples")
.def(
"setAtomPalette", &RDKit::setAtomPalette,
python::args("self", "cmap"),
"sets the palette for atoms and bonds from a dictionary mapping ints "
"to 3-tuples")
.def("getAtomPalette", &RDKit::getAtomPalette, python::args("self"),
"returns the current atom palette as a dictionary mapping ints "
"to 4-tuples")
.def_readwrite("atomLabels", &RDKit::MolDrawOptions::atomLabels,
"maps indices to atom labels")
.def_readwrite("atomLabelDeuteriumTritium",
&RDKit::MolDrawOptions::atomLabelDeuteriumTritium,
"labels deuterium as D and tritium as T")
.def_readwrite("continuousHighlight",
&RDKit::MolDrawOptions::continuousHighlight)
.def_readwrite("fillHighlights", &RDKit::MolDrawOptions::fillHighlights)
.def_readwrite("highlightRadius", &RDKit::MolDrawOptions::highlightRadius,
"Default radius for highlight circles.")
.def_readwrite("flagCloseContactsDist",
&RDKit::MolDrawOptions::flagCloseContactsDist)
.def_readwrite("atomRegions", &RDKit::MolDrawOptions::atomRegions,
"regions to outline")
.def_readwrite("includeAtomTags", &RDKit::MolDrawOptions::includeAtomTags,
"include atom tags in output")
.def_readwrite("clearBackground", &RDKit::MolDrawOptions::clearBackground,
"clear the background before drawing a molecule")
.def_readwrite("legendFontSize", &RDKit::MolDrawOptions::legendFontSize,
"font size in pixels of the legend (if drawn)")
.def_readwrite(
"legendFraction", &RDKit::MolDrawOptions::legendFraction,
"fraction of the draw panel to be used for the legend if present")
.def_readwrite("legendPosition", &RDKit::MolDrawOptions::legendPosition,
"legend position enum. Default=Bottom. "
"Values: LegendPosition.Bottom, LegendPosition.Top, "
"LegendPosition.Left, LegendPosition.Right.")
.def_readwrite(
"legendVerticalText", &RDKit::MolDrawOptions::legendVerticalText,
"when legend is Left or Right, draw text vertically (one char per line)")
.def_readwrite("maxFontSize", &RDKit::MolDrawOptions::maxFontSize,
"maximum font size in pixels. default=40, -1 means no"
" maximum.")
.def_readwrite("minFontSize", &RDKit::MolDrawOptions::minFontSize,
"minimum font size in pixels. default=6, -1 means no"
" minimum.")
.def_readwrite(
"fixedFontSize", &RDKit::MolDrawOptions::fixedFontSize,
"font size in pixels. default=-1 means not fixed. If set,"
" always used irrespective of scale, minFontSize and maxFontSize.")
.def_readwrite(
"baseFontSize", &RDKit::MolDrawOptions::baseFontSize,
"relative size of font. Defaults to 0.6. -1 means use default.")
.def_readwrite(
"annotationFontScale", &RDKit::MolDrawOptions::annotationFontScale,
"Scale of font for atom and bond annotation relative to atom"
"label font. Default=0.75.")
.def_readwrite(
"fontFile", &RDKit::MolDrawOptions::fontFile,
"Font file for use with FreeType text drawer. Can also be"
" BuiltinTelexRegular (the default) or BuiltinRobotoRegular.")
.def_readwrite(
"multipleBondOffset", &RDKit::MolDrawOptions::multipleBondOffset,
"offset for the extra lines in a multiple bond as a fraction of mean"
" bond length")
.def_readwrite(
"padding", &RDKit::MolDrawOptions::padding,
"Fraction of empty space to leave around molecule. Default=0.05.")
.def_readwrite("reagentPadding", &RDKit::MolDrawOptions::componentPadding,
"Fraction of empty space to leave around each component"
" of a reaction drawing. Default=0.0.")
.def_readwrite(
"bondLineWidth", &RDKit::MolDrawOptions::bondLineWidth,
"if positive, this overrides the default line width for bonds")
.def_readwrite("scaleBondWidth", &RDKit::MolDrawOptions::scaleBondWidth,
"Scales the width of drawn bonds using image scaling.")
.def_readwrite("scaleHighlightBondWidth",
&RDKit::MolDrawOptions::scaleHighlightBondWidth,
"Scales the width of drawn highlighted bonds using"
" image scaling.")
.def_readwrite("highlightBondWidthMultiplier",
&RDKit::MolDrawOptions::highlightBondWidthMultiplier,
"What to multiply default bond width by for highlighting "
"bonds. Default-8.")
.def_readwrite("prepareMolsBeforeDrawing",
&RDKit::MolDrawOptions::prepareMolsBeforeDrawing,
"call prepareMolForDrawing() on each molecule passed to "
"DrawMolecules()")
.def_readwrite("fixedScale", &RDKit::MolDrawOptions::fixedScale,
"If > 0.0, fixes scale to that fraction of width of"
"draw window unless that would make it too big."
" Default -1.0 means adjust scale to fit.")
.def_readwrite("fixedBondLength", &RDKit::MolDrawOptions::fixedBondLength,
"If > 0.0, fixes bond length to this number of pixels"
"unless that would make it too big. Default -1.0 means"
"no fix. If both set, fixedScale takes precedence.")
.def_readwrite("fixedScale", &RDKit::MolDrawOptions::fixedScale,
"If > 0.0, fixes scale to that fraction of width of"
"draw window. Default -1.0 means adjust scale to fit.")
.def_readwrite("rotate", &RDKit::MolDrawOptions::rotate,
"Rotates molecule about centre by this number of degrees,")
.def_readwrite("addStereoAnnotation",
&RDKit::MolDrawOptions::addStereoAnnotation,
"adds R/S and E/Z to drawings. Default False.")
.def_readwrite("showAllCIPCodes", &RDKit::MolDrawOptions::showAllCIPCodes,
"show all defined CIP codes (no hiding!). Default False.")
.def_readwrite("addAtomIndices", &RDKit::MolDrawOptions::addAtomIndices,
"adds atom indices to drawings. Default False.")
.def_readwrite("addBondIndices", &RDKit::MolDrawOptions::addBondIndices,
"adds bond indices to drawings. Default False.")
.def_readwrite("isotopeLabels", &RDKit::MolDrawOptions::isotopeLabels,
"adds isotope labels on non-dummy atoms. Default True.")
.def_readwrite("dummyIsotopeLabels",
&RDKit::MolDrawOptions::dummyIsotopeLabels,
"adds isotope labels on dummy atoms. Default True.")
.def_readwrite("atomHighlightsAreCircles",
&RDKit::MolDrawOptions::atomHighlightsAreCircles,
"forces atom highlights always to be circles."
"Default (false) is to put ellipses round"
"longer labels.")
.def_readwrite(
"multiColourHighlightStyle",
&RDKit::MolDrawOptions::multiColourHighlightStyle,
"Either 'CircleAndLine' or 'Lasso', to control style of"
"multi-coloured highlighting in DrawMoleculeWithHighlights."
"Default is CircleAndLine.")
.def_readwrite("centreMoleculesBeforeDrawing",
&RDKit::MolDrawOptions::centreMoleculesBeforeDrawing,
"Moves the centre of the drawn molecule to (0,0)."
"Default False.")
.def_readwrite("additionalAtomLabelPadding",
&RDKit::MolDrawOptions::additionalAtomLabelPadding,
"additional padding to leave around atom labels. "
"Expressed as a fraction of the font size.")
.def_readwrite("noAtomLabels", &RDKit::MolDrawOptions::noAtomLabels,
"disables inclusion of atom labels in the rendering")
.def_readwrite("explicitMethyl", &RDKit::MolDrawOptions::explicitMethyl,
"Draw terminal methyls explictly. Default is false.")
.def_readwrite(
"includeMetadata", &RDKit::MolDrawOptions::includeMetadata,
"When possible, include metadata about molecules and reactions to "
"allow them to be reconstructed. Default is true.")
.def_readwrite(
"includeRadicals", &RDKit::MolDrawOptions::includeRadicals,
"include radicals in the drawing (it can be useful to turn this off "
"for reactions and queries). Default is true.")
.def_readwrite("comicMode", &RDKit::MolDrawOptions::comicMode,
"simulate hand-drawn lines for bonds. When combined with "
"a font like Comic-Sans or Comic-Neue, this gives "
"xkcd-like drawings. Default is false.")
.def_readwrite("variableBondWidthMultiplier",
&RDKit::MolDrawOptions::variableBondWidthMultiplier,
"what to multiply standard bond width by for variable "
"attachment points.")
.def_readwrite("variableAtomRadius",
&RDKit::MolDrawOptions::variableAtomRadius,
"radius value to use for atoms involved in variable "
"attachment points.")
.def_readwrite("includeChiralFlagLabel",
&RDKit::MolDrawOptions::includeChiralFlagLabel,
"add a molecule annotation with \"ABS\" if the chiral "
"flag is set. Default is false.")
.def_readwrite("simplifiedStereoGroupLabel",
&RDKit::MolDrawOptions::simplifiedStereoGroupLabel,
"if all specified stereocenters are in a single "
"StereoGroup, show a molecule-level annotation instead of "
"the individual labels. Default is false.")
.def_readwrite("unspecifiedStereoIsUnknown",
&RDKit::MolDrawOptions::unspecifiedStereoIsUnknown,
"if true, double bonds with unspecified stereo are drawn"
" crossed, potential stereocenters with unspecified stereo"
" are drawn with a wavy bond. Default is false.")
.def_readwrite(
"singleColourWedgeBonds",
&RDKit::MolDrawOptions::singleColourWedgeBonds,
"if true wedged and dashed bonds are drawn using symbolColour "
"rather than inheriting their colour from the atoms. "
"Default is false.")
.def_readwrite("singleColourBonds",
&RDKit::MolDrawOptions::singleColourBonds,
"if true all bonds are drawn using symbolColour "
"rather than inheriting their colour from the atoms. "
"Default is false.")
.def_readwrite("useMolBlockWedging",
&RDKit::MolDrawOptions::useMolBlockWedging,
"If the molecule came from a MolBlock, prefer the wedging"
" information that provides. If false, use RDKit rules."
" Default false")
.def_readwrite("scalingFactor", &RDKit::MolDrawOptions::scalingFactor,
"scaling factor for pixels->angstrom when auto scaling"
"being used. Default is 20.")
.def_readwrite("drawMolsSameScale",
&RDKit::MolDrawOptions::drawMolsSameScale,
"when drawing multiple molecules with DrawMolecules,"
" forces them to use the same scale. Default is true.")
.def_readwrite(
"useComplexQueryAtomSymbols",
&RDKit::MolDrawOptions::useComplexQueryAtomSymbols,
"replace any atom, any hetero, any halo queries "
"with complex query symbols A, Q, X, M, optionally followed "
"by H if hydrogen is included (except for AH, which stays *). "
"Default is true")
.def_readwrite("bracketsAroundAtomLists",
&RDKit::MolDrawOptions::bracketsAroundAtomLists,
"Whether to put brackets round atom lists in query atoms."
" Default is true.")
.def_readwrite(
"standardColoursForHighlightedAtoms",
&RDKit::MolDrawOptions::standardColoursForHighlightedAtoms,
"If true, highlighted hetero atoms are drawn in standard colours"
" rather than black. Default=False")
.def_readwrite(
"drawingExtentsInclude",
&RDKit::MolDrawOptions::drawingExtentsInclude,
"Drawing extents are computed taking into account only selected"
" DrawElement items. Default=DrawElement.ALL")
.def("getVariableAttachmentColour", &RDKit::getVariableAttachmentColour,
python::args("self"),
"method for getting the colour of variable attachment points")
.def("setVariableAttachmentColour", &RDKit::setVariableAttachmentColour,
python::args("self", "tpl"),
"method for setting the colour of variable attachment points")
.def("__setattr__", &safeSetattr);
docString = "Drawer abstract base class";
python::class_<RDKit::MolDraw2D, boost::noncopyable>(
"MolDraw2D", docString.c_str(), python::no_init)
.def("SetFontSize", &RDKit::MolDraw2D::setFontSize,
python::args("self", "new_size"),
"change the default font size. The units are, roughly, pixels.")
.def("FontSize", &RDKit::MolDraw2D::fontSize, python::args("self"),
"get the default font size. The units are, roughly, pixels.")
.def(
"DrawMolecule", RDKit::drawMoleculeHelper1,
(python::arg("self"), python::arg("mol"),
python::arg("highlightAtoms") = python::object(),
python::arg("highlightAtomColors") = python::object(),
python::arg("highlightAtomRadii") = python::object(),
python::arg("confId") = -1, python::arg("legend") = std::string("")),
"renders a molecule\n")
.def(
"DrawMolecule", RDKit::drawMoleculeHelper2,
(python::arg("self"), python::arg("mol"),
python::arg("highlightAtoms"), python::arg("highlightBonds"),
python::arg("highlightAtomColors") = python::object(),
python::arg("highlightBondColors") = python::object(),
python::arg("highlightAtomRadii") = python::object(),
python::arg("confId") = -1, python::arg("legend") = std::string("")),
"renders a molecule\n")
.def(
"GetMolSize", RDKit::getMolSizeHelper,
(python::arg("self"), python::arg("mol"),
python::arg("highlightAtoms") = python::object(),
python::arg("highlightBonds") = python::object(),
python::arg("highlightAtomColors") = python::object(),
python::arg("highlightBondColors") = python::object(),
python::arg("highlightAtomRadii") = python::object(),
python::arg("confId") = -1, python::arg("legend") = std::string("")),
"returns the width and height required to draw a molecule at the current size")
.def("DrawMoleculeWithHighlights",
RDKit::drawMoleculeWithHighlightsHelper,
(python::arg("self"), python::arg("mol"), python::arg("legend"),
python::arg("highlight_atom_map"),
python::arg("highlight_bond_map"), python::arg("highlight_radii"),
python::arg("highlight_linewidth_multipliers"),
python::arg("confId") = -1),
"renders a molecule with multiple highlight colours\n")
.def("DrawMolecules", RDKit::drawMoleculesHelper2,
(python::arg("self"), python::arg("mols"),
python::arg("highlightAtoms") = python::object(),
python::arg("highlightBonds") = python::object(),
python::arg("highlightAtomColors") = python::object(),
python::arg("highlightBondColors") = python::object(),
python::arg("highlightAtomRadii") = python::object(),
python::arg("confIds") = python::object(),
python::arg("legends") = python::object()),
"renders multiple molecules\n")
.def("DrawReaction", RDKit::drawReactionHelper,
(python::arg("self"), python::arg("rxn"),
python::arg("highlightByReactant") = false,
python::arg("highlightColorsReactants") = python::object(),
python::arg("confIds") = python::object()),
"renders a reaction\n")
.def("Width", &RDKit::MolDraw2D::width, python::args("self"),
"get the width of the drawing canvas")
.def("Height", &RDKit::MolDraw2D::height, python::args("self"),
"get the height of the drawing canvas")
.def("SetOffset", &RDKit::MolDraw2D::setOffset,
python::args("self", "x", "y"),
"set the offset (in drawing coordinates) for the drawing")
.def("Offset", &RDKit::MolDraw2D::offset, python::args("self"),
"returns the offset (in drawing coordinates) for the drawing")
.def("SetScale", &RDKit::setScaleHelper,
(python::arg("self"), python::arg("width"), python::arg("height"),
python::arg("minv"), python::arg("maxv"),
python::arg("mol") = python::object()),
"uses the values provided to set the drawing scaling")
.def("FlexiMode", &RDKit::MolDraw2D::flexiMode, python::args("self"),
"returns whether or not FlexiMode is being used")
.def(
"SetFlexiMode", &RDKit::MolDraw2D::setFlexiMode,
python::args("self", "mode"),
"when FlexiMode is set, molecules will always been drawn with the default values for bond length, font size, etc.")
.def("SetLineWidth", &RDKit::MolDraw2D::setLineWidth,
python::args("self", "width"), "set the line width being used")
.def("SetColour", &RDKit::setDrawerColour, python::args("self", "tpl"),
"set the color being used fr drawing and filling")
.def("LineWidth", &RDKit::MolDraw2D::lineWidth, python::args("self"),
"returns the line width being used")
.def("SetFillPolys", &RDKit::MolDraw2D::setFillPolys,
python::args("self", "val"),
"sets whether or not polygons are filled")
.def("FillPolys", &RDKit::MolDraw2D::fillPolys, python::args("self"),
"returns whether or not polygons are being filled")
.def("DrawLine",
(void (RDKit::MolDraw2D::*)(const Point2D &, const Point2D &,
bool))&RDKit::MolDraw2D::drawLine,
(python::arg("self"), python::arg("cds1"), python::arg("cds2"),
python::arg("rawCoords") = false),
"draws a line with the current drawing style. The coordinates "
"are in the molecule frame unless rawCoords is true, "
"in which case the coordinates are in pixels.")
.def(
"DrawArrow", RDKit::drawArrowHelper,
(python::arg("self"), python::arg("cds1"), python::arg("cds2"),
python::arg("asPolygon") = false, python::arg("frac") = 0.05,
python::arg("angle") = M_PI / 6,
python::arg("color") = python::object(),
python::arg("rawCoords") = false),
"draws an arrow with the current drawing style. The coordinates "
"are in the molecule frame unless rawCoords is true, "
"in which case the coordinates are in pixels. "
"If asPolygon is true the head of the "
"arrow will be drawn as a triangle, otherwise two lines are used. "
"The fraction of the arrow length to use for the head is given by "
"frac. The angle of the arrowhead "
"(the angle between the main line and each arrowhead line) is given by angle. "
"The color is a tuple of 3 floats (0-1) in red, green, blue (RGB) order.")
.def("DrawTriangle", &RDKit::MolDraw2D::drawTriangle,
(python::arg("self"), python::arg("cds1"), python::arg("cds2"),
python::arg("cds3"), python::arg("rawCoords") = false),
"draws a triangle with the current drawing style. The coordinates "
"are in the molecule frame unless rawCoords is true, "
"in which case the coordinates are in pixels.")
.def("DrawPolygon", RDKit::drawPolygonHelper,
(python::arg("self"), python::arg("cds"),
python::arg("rawCoords") = false),
"draws a polygon with the current drawing style. The coordinates "
"are in the molecule frame unless rawCoords is true, "
"in which case the coordinates are in pixels.")
.def("DrawEllipse", &RDKit::MolDraw2D::drawEllipse,
(python::arg("self"), python::arg("cds1"), python::arg("cds2"),
python::arg("rawCoords") = false),
"draws a triangle with the current drawing style in the rectangle "
"defined by the two points. The coordinates "
"are in the molecule frame unless rawCoords is true, "
"in which case the coordinates are in pixels.")
.def("DrawRect", &RDKit::MolDraw2D::drawRect,
(python::arg("self"), python::arg("cds1"), python::arg("cds2"),
python::arg("rawCoords") = false),
"draws a rectangle with the current drawing style in the rectangle "
"defined by the two points. The coordinates "
"are in the molecule frame unless rawCoords is true, "
"in which case the coordinates are in pixels.")
.def("DrawArc",
(void (RDKit::MolDraw2D::*)(const Point2D &, double, double, double,
bool))&RDKit::MolDraw2D::drawArc,
(python::arg("self"), python::arg("center"), python::arg("radius"),
python::arg("angle1"), python::arg("angle2"),
python::arg("rawCoords") = false),
"draws an arc with the current drawing style. The coordinates "
"are in the molecule frame unless rawCoords is true, "
"in which case the coordinates are in pixels."
"The angles are in "
"degrees; angle2 should be > angle1.")
.def("DrawAttachmentLine", &RDKit::drawAttachmentLineHelper,
(python::arg("self"), python::arg("cds1"), python::arg("cds2"),
python::arg("color"), python::arg("len") = 1.0,
python::arg("nSegments") = 16, python::arg("rawCoords") = false),
"draw a line indicating the presence of an attachment point "
"(normally a squiggle line perpendicular to a bond). "
"The coordinates "
"are in the molecule frame unless rawCoords is true, "
"in which case the coordinates are in pixels.")
.def("DrawWavyLine", &RDKit::drawWavyLineHelper,
(python::arg("self"), python::arg("cds1"), python::arg("cds2"),
python::arg("color1"), python::arg("color2"),
python::arg("nSegments") = 16, python::arg("vertOffset") = 0.05,
python::arg("rawCoords") = false),
"draw a line indicating the presence of an attachment point "
"(normally a squiggle line perpendicular to a bond). "
"The coordinates "
"are in the molecule frame unless rawCoords is true, "
"in which case the coordinates are in pixels.")
.def("DrawString",
(void (RDKit::MolDraw2D::*)(const std::string &,
const RDGeom::Point2D &,
bool))&RDKit::MolDraw2D::drawString,
(python::arg("self"), python::arg("string"), python::arg("pos"),
python::arg("rawCoords") = false),
"add text to the canvas. The coordinates "
"are in the molecule frame unless rawCoords is true, "
"in which case the coordinates are in pixels.")
.def("DrawString", RDKit::drawStringHelper,
(python::arg("self"), python::arg("string"), python::arg("pos"),
python::arg("align"), python::arg("rawCoords") = false),
"add aligned text to the canvas. The align argument can be 0 "
"(=MIDDLE), 1 (=START), or 2 (=END)."
"The coordinates "
"are in the molecule frame unless rawCoords is true, "
"in which case the coordinates are in pixels.")
.def("GetDrawCoords",
(RDGeom::Point2D (RDKit::MolDraw2D::*)(const RDGeom::Point2D &)
const) &
RDKit::MolDraw2D::getDrawCoords,
(python::arg("self"), python::arg("point")),
"get the coordinates in drawing space for a particular point in "
"molecule space")
.def("GetDrawCoords",
(RDGeom::Point2D (RDKit::MolDraw2D::*)(int) const) &
RDKit::MolDraw2D::getDrawCoords,
(python::arg("self"), python::arg("atomIndex")),
"get the coordinates in drawing space for a particular atom")
.def("ClearDrawing", &RDKit::MolDraw2D::clearDrawing,
(python::arg("self")),
"clears the drawing by filling it with the background color")
.def("drawOptions",
(RDKit::MolDrawOptions & (RDKit::MolDraw2D::*)()) &
RDKit::MolDraw2D::drawOptions,
python::return_internal_reference<
1, python::with_custodian_and_ward_postcall<0, 1>>(),
python::args("self"),
"Returns a modifiable version of the current drawing options")
.def("SetDrawOptions", RDKit::setDrawOptions,
python::args("self", "opts"),
"Copies the drawing options passed in over our drawing options");
docString = "SVG molecule drawer";
python::class_<RDKit::MolDraw2DSVG, python::bases<RDKit::MolDraw2D>,
boost::noncopyable>(
"MolDraw2DSVG", docString.c_str(),
python::init<int, int, int, int, bool>(
(python::arg("self"), python::arg("width"), python::arg("height"),
python::arg("panelWidth") = -1, python::arg("panelHeight") = -1,
python::arg("noFreetype") = false)))
.def("FinishDrawing", &RDKit::MolDraw2DSVG::finishDrawing,
python::args("self"),
"add the last bits of SVG to finish the drawing")
.def("AddMoleculeMetadata",
(void (RDKit::MolDraw2DSVG::*)(const RDKit::ROMol &, int) const) &
RDKit::MolDraw2DSVG::addMoleculeMetadata,
((python::arg("self"), python::arg("mol")),
python::arg("confId") = -1),
"add RDKit-specific information to the bottom of the drawing")
.def("TagAtoms", RDKit::tagAtomHelper,
((python::arg("self"), python::arg("mol")),
python::arg("radius") = 0.2,
python::arg("events") = python::object()),
"allow atom selection in the SVG")
.def("GetDrawingText", &RDKit::MolDraw2DSVG::getDrawingText,
python::args("self"), "return the SVG");
#ifdef RDK_BUILD_CAIRO_SUPPORT
docString = "Cairo molecule drawer";
python::class_<RDKit::MolDraw2DCairo, python::bases<RDKit::MolDraw2D>,
boost::noncopyable>(
"MolDraw2DCairo", docString.c_str(),
python::init<int, int, int, int, bool>(
(python::arg("self"), python::arg("width"), python::arg("height"),
python::arg("panelWidth") = -1, python::arg("panelHeight") = -1,
python::arg("noFreetype") = false)))
.def("FinishDrawing", &RDKit::MolDraw2DCairo::finishDrawing,
python::args("self"), "add the last bits to finish the drawing")
.def("GetDrawingText", &RDKit::getCairoDrawingText, python::args("self"),
"return the PNG data as a string")
.def("WriteDrawingText", &RDKit::MolDraw2DCairo::writeDrawingText,
python::args("self", "fName"),
"write the PNG data to the named file");
#endif
docString =
"Does some cleanup operations on the molecule to prepare it to draw "
"nicely.\n"
"The operations include: kekulization, addition of chiral Hs (so "
"that we "
"can draw\n"
"wedges to them), wedging of bonds at chiral centers, and generation "
"of "
"a 2D\n"
"conformation if the molecule does not already have a conformation\n"
"\nReturns a modified copy of the molecule.\n";
python::def(
"PrepareMolForDrawing", &RDKit::prepMolForDrawing,
(python::arg("mol"), python::arg("kekulize") = true,
python::arg("addChiralHs") = true, python::arg("wedgeBonds") = true,
python::arg("forceCoords") = false, python::arg("wavyBonds") = false),
docString.c_str(),
python::return_value_policy<python::manage_new_object>());
python::def(
"PrepareAndDrawMolecule", &RDKit::prepareAndDrawMoleculeHelper,
(python::arg("drawer"), python::arg("mol"), python::arg("legend") = "",
python::arg("highlightAtoms") = python::object(),
python::arg("highlightBonds") = python::object(),
python::arg("highlightAtomColors") = python::object(),
python::arg("highlightBondColors") = python::object(),
python::arg("highlightAtomRadii") = python::object(),
python::arg("confId") = -1, python::arg("kekulize") = true),
"Preps a molecule for drawing and actually draws it\n");
python::def(
"DrawMoleculeACS1996", &RDKit::drawMoleculeACS1996Helper,
(python::arg("drawer"), python::arg("mol"), python::arg("legend") = "",
python::arg("highlightAtoms") = python::object(),
python::arg("highlightBonds") = python::object(),
python::arg("highlightAtomColors") = python::object(),
python::arg("highlightBondColors") = python::object(),
python::arg("highlightAtomRadii") = python::object(),
python::arg("confId") = -1),
"Draws molecule in ACS 1996 mode.");
docString = "Parameters for drawing contours";
python::class_<RDKit::MolDraw2DUtils::ContourParams>(
"ContourParams", docString.c_str(), python::init<>(python::args("self")))
.def_readwrite("setScale",
&RDKit::MolDraw2DUtils::ContourParams::setScale,
"set the scale of the drawing object (useful if you draw "
"the grid/contours first)")
.def_readwrite("dashNegative",
&RDKit::MolDraw2DUtils::ContourParams::dashNegative,
"use a dashed line for negative contours")
.def_readwrite("fillGrid",
&RDKit::MolDraw2DUtils::ContourParams::fillGrid,
"colors the grid in addition to drawing contours")
.def_readwrite("gridResolution",
&RDKit::MolDraw2DUtils::ContourParams::gridResolution,
"set the resolution of the grid")
.def_readwrite("contourWidth",
&RDKit::MolDraw2DUtils::ContourParams::contourWidth,
"line width of the contours")
.def_readwrite("extraGridPadding",
&RDKit::MolDraw2DUtils::ContourParams::extraGridPadding,
"extra space (in molecule coords) around the grid")
.def_readwrite(
"drawAsLines", &RDKit::MolDraw2DUtils::ContourParams::drawAsLines,
"draw the contours as continuous lines isntead of line segments")
.def_readwrite(
"coordScaleForQuantization",
&RDKit::MolDraw2DUtils::ContourParams::coordScaleForQuantization,
"scaling factor used to convert coordinates to ints when forming the continuous lines")
.def_readwrite(
"isovalScaleForQuantization",
&RDKit::MolDraw2DUtils::ContourParams::isovalScaleForQuantization,
"scaling factor used to convert isovalues to ints when forming the continuous lines")
.def_readwrite(
"useFillThreshold",
&RDKit::MolDraw2DUtils::ContourParams::useFillThreshold,
"use a magnitude threshold to determine if a grid point is filled")
.def_readwrite(
"fillThreshold", &RDKit::MolDraw2DUtils::ContourParams::fillThreshold,
"magnitude threshold to determine if a grid point is filled")
.def_readwrite(
"fillThresholdIsFraction",
&RDKit::MolDraw2DUtils::ContourParams::fillThresholdIsFraction,
"if true, fillThreshold is a fraction of the range of the data")
.add_property("colourMap", &RDKit::getColoursHelper,
&RDKit::setColoursHelper,
"the color map to use when filling the grid")
.add_property("contourColour", &RDKit::getContourColour,
&RDKit::setContourColour,
"the color to use for drawing the contours")
.def("setContourColour", &RDKit::setContourColour,
(python::arg("self"), python::arg("colour")))
.def("setColourMap", &RDKit::setColoursHelper,
(python::arg("self"), python::arg("colours")))
.def("__setattr__", &safeSetattr);
docString = R"DOC(Generates and draws contours for a set of gaussians
- drawer: the MolDraw2D object to use
- locs: locations of the gaussians
- heights: the heights (or weights) of the gaussians
- widths: the standard deviations of the gaussians
- nContours: the number of contours to draw
- levels: the contours to use
- ps: additional parameters controlling the contouring.
- mol: molecule used to help set scale.
The values are calculated on a grid with spacing params.gridResolution.
If params.setScale is set, the grid size will be calculated based on the
locations of the gaussians and params.extraGridPadding. Otherwise the current
size of the viewport will be used.
If the levels argument is empty, the contour levels will be determined
automatically from the max and min values on the grid and levels will
be updated to include the contour levels.
If params.fillGrid is set, the data on the grid will also be drawn using
the color scheme in params.colourMap
If mol is not 0, uses the molecule to help set the scale, assuming that
it will be drawn over the plot, so needs to fit on it.
*/)DOC";
python::def(
"ContourAndDrawGaussians", &RDKit::contourAndDrawGaussiansHelper,
(python::arg("drawer"), python::arg("locs"), python::arg("heights"),
python::arg("widths"), python::arg("nContours") = 10,
python::arg("levels") = python::object(),
python::arg("params") = RDKit::MolDraw2DUtils::ContourParams(),
python::arg("mol") = python::object()),
docString.c_str());
docString = R"DOC(Generates and draws contours for data on a grid
- drawer: the MolDraw2D object to use
- data: numpy array with the data to be contoured
- xcoords: the x coordinates of the grid
- ycoords: the y coordinates of the grid
- nContours: the number of contours to draw
- levels: the contours to use
- ps: additional parameters controlling the contouring
- mol: molecule used to help set scale.
The values are calculated on a grid with spacing params.gridResolution.
If params.setScale is set, the grid size will be calculated based on the
locations of the gaussians and params.extraGridPadding. Otherwise the current
size of the viewport will be used.
If the levels argument is empty, the contour levels will be determined
automatically from the max and min values on the grid and levels will
be updated to include the contour levels.
If params.fillGrid is set, the data on the grid will also be drawn using
the color scheme in params.colourMap
If mol is not 0, uses the molecule to help set the scale, assuming that
it will be drawn over the plot, so needs to fit on it.
*/)DOC";
python::def(
"ContourAndDrawGrid", &RDKit::contourAndDrawGridHelper,
(python::arg("drawer"), python::arg("data"), python::arg("xcoords"),
python::arg("ycoords"), python::arg("nContours") = 10,
python::arg("levels") = python::object(),
python::arg("params") = RDKit::MolDraw2DUtils::ContourParams(),
python::arg("mol") = python::object()),
docString.c_str());
python::def("UpdateMolDrawOptionsFromJSON", RDKit::updateMolDrawOptionsHelper,
(python::arg("opts"), python::arg("json")));
python::def("UpdateDrawerParamsFromJSON", RDKit::updateDrawerParamsHelper,
(python::arg("drawer"), python::arg("json")));
// ------------------------------------------------------------------------
docString = "Returns svg for a molecule";
python::def(
"MolToSVG", &RDKit::molToSVG,
(python::arg("mol"), python::arg("width") = 300,
python::arg("height") = 300,
python::arg("highlightAtoms") = python::object(),
python::arg("kekulize") = true, python::arg("lineWidthMult") = 1,
python::arg("includeAtomCircles") = true, python::arg("confId") = -1),
docString.c_str());
docString = "Returns ACS 1996 mode svg for a molecule";
python::def("MolToACS1996SVG", &RDKit::molToACS1996SVG,
(python::arg("mol"), python::arg("legend") = "",
python::arg("highlightAtoms") = python::object(),
python::arg("highlightBonds") = python::object(),
python::arg("highlightAtomColors") = python::object(),
python::arg("highlightBondColors") = python::object(),
python::arg("highlightAtomRadii") = python::object(),
python::arg("confId") = -1),
docString.c_str());
docString =
R"DOC(Set the draw options to produce something as close as possible to
the ACS 1996 guidelines as described at
https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style/Chemistry/Structure_drawing
- MolDrawOptions opt - the options what will be changed
- float meanBondLength - mean bond length of the molecule
Works best if the MolDraw2D object is created with width and height -1 (a
flexiCanvas).
The mean bond length may be calculated with MeanBondLength.
It is used to calculate the offset for the lines in multiple bonds.
Options changed are:
bondLineWidth = 0.6
scaleBondWidth = false
scalingFactor = 14.4 / meanBondLen
multipleBondOffset = 0.18
highlightBondWidthMultiplier = 32
setMonochromeMode - black and white
fixedFontSize = 10
additionalAtomLabelPadding = 0.066
fontFile - if it isn't set already, then if RDBASE is set and the file
exists, uses $RDBASE/Data/Fonts/FreeSans.ttf. Otherwise uses
BuiltinRobotoRegular.
*/
)DOC";
python::def("SetACS1996Mode", &RDKit::MolDraw2DUtils::setACS1996Options,
(python::arg("drawOptions"), python::arg("meanBondLength")),
docString.c_str());
python::def("MeanBondLength", &RDKit::MolDraw2DUtils::meanBondLength,
(python::arg("mol"), python::arg("confId") = -1),
"Calculate the mean bond length for the molecule.");
python::def("SetDarkMode",
(void (*)(RDKit::MolDrawOptions &))&RDKit::setDarkMode,
python::args("d2d"), "set dark mode for a MolDrawOptions object");
python::def("SetDarkMode", (void (*)(RDKit::MolDraw2D &))&RDKit::setDarkMode,
python::args("d2d"), "set dark mode for a MolDraw2D object");
python::def("SetMonochromeMode", RDKit::setMonochromeMode_helper1,
(python::arg("options"), python::arg("fgColour"),
python::arg("bgColour")),
"set monochrome mode for a MolDrawOptions object");
python::def(
"SetMonochromeMode", RDKit::setMonochromeMode_helper2,
(python::arg("drawer"), python::arg("fgColour"), python::arg("bgColour")),
"set monochrome mode for a MolDraw2D object");
}