1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311
|
//
// Copyright (C) 2004-2019 Greg Ladrum and Rational Discovery LLC
//
// @@ 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.
//
#define NO_IMPORT_ARRAY
#include <RDBoost/python.h>
#include <string>
#include "rdchem.h"
#include "props.hpp"
#include <GraphMol/RDKitBase.h>
#include <RDGeneral/types.h>
#include <Geometry/point.h>
#include <GraphMol/Conformer.h>
#include <RDBoost/PySequenceHolder.h>
#define NPY_NO_DEPRECATED_API NPY_1_7_API_VERSION
#include <numpy/arrayobject.h>
#include <RDGeneral/BoostStartInclude.h>
#include <boost/python/numpy.hpp>
#include <RDGeneral/BoostEndInclude.h>
namespace python = boost::python;
namespace np = boost::python::numpy;
namespace RDKit {
RDGeom::Point3D GetAtomPos(const Conformer *conf, unsigned int aid) {
RDGeom::Point3D res = conf->getAtomPos(aid);
return res;
}
PyObject *GetPos(const Conformer *conf) {
const RDGeom::POINT3D_VECT &pos = conf->getPositions();
// define a 2D array with the following size
npy_intp dims[2];
dims[0] = pos.size();
dims[1] = 3;
// initialize the array
auto *res = (PyArrayObject *)PyArray_SimpleNew(2, dims, NPY_DOUBLE);
// represent the array as a 1D/flat array of doubles
auto *resData = reinterpret_cast<double *>(PyArray_DATA(res));
// manually insert the data, 3 corresponds to the x, y and z dimensions
for (unsigned int i = 0; i < pos.size(); ++i) {
resData[3 * i + 0] = pos[i].x;
resData[3 * i + 1] = pos[i].y;
resData[3 * i + 2] = pos[i].z;
}
return PyArray_Return(res);
}
void SetPos(Conformer *conf, np::ndarray const &array) {
if (array.get_dtype() != np::dtype::get_builtin<double>()) {
PyErr_SetString(PyExc_TypeError, "Incorrect array data type");
python::throw_error_already_set();
}
if (array.get_nd() != 2) {
PyErr_SetString(PyExc_TypeError, "Input array shape must be of rank 2");
python::throw_error_already_set();
}
if (array.shape(0) != conf->getNumAtoms()) {
PyErr_SetString(
PyExc_ValueError,
"Position array shape doesn't equal the number of atoms in the conformer");
python::throw_error_already_set();
}
if (array.shape(1) < 2 || array.shape(1) > 3) {
PyErr_SetString(PyExc_ValueError,
"Position array point dimension must be 2 or 3 (2d or 3d)");
python::throw_error_already_set();
}
// pointer to start of contiguous data block that numpy holds
// this isn't necessarily in pure C order
const auto *dataptr = array.get_data();
// the number of *bytes* to skip to jump to next row in data array
int stride_atom = array.strides(0);
// the number of *bytes* to skip to move between x, y, z in a row
int stride_dim = array.strides(1);
// i.e. stride_atom/dim would be 24 & 8 in a contiguous 3D input,
// but numpy will play with this when doing slicing/transposing etc
RDGeom::POINT3D_VECT &pos = conf->getPositions();
if (array.shape(1) == 2) {
for (size_t i = 0; i < conf->getNumAtoms(); ++i) {
pos[i].x = * reinterpret_cast<const double *>(dataptr + i * stride_atom);
pos[i].y = * reinterpret_cast<const double *>(dataptr + i * stride_atom + stride_dim);
pos[i].z = 0.0;
}
} else {
for (size_t i = 0; i < conf->getNumAtoms(); ++i) {
pos[i].x = * reinterpret_cast<const double *>(dataptr + i * stride_atom);
pos[i].y = * reinterpret_cast<const double *>(dataptr + i * stride_atom + stride_dim);
pos[i].z = * reinterpret_cast<const double *>(dataptr + i * stride_atom + 2 * stride_dim);
}
}
}
void SetAtomPos(Conformer *conf, unsigned int aid, python::object loc) {
// const std::vector<double> &loc) {
int dim = python::extract<int>(loc.attr("__len__")());
CHECK_INVARIANT(dim == 3, "");
PySequenceHolder<double> pdata(loc);
RDGeom::Point3D pt(pdata[0], pdata[1], pdata[2]);
conf->setAtomPos(aid, pt);
}
std::string confClassDoc =
"The class to store 2D or 3D conformation of a molecule\n";
struct conformer_wrapper {
static void wrap() {
python::class_<Conformer, CONFORMER_SPTR>(
"Conformer", confClassDoc.c_str(), python::init<>(python::args("self")))
.def(python::init<unsigned int>(
python::args("self", "numAtoms"),
"Constructor with the number of atoms specified"))
.def(python::init<const Conformer &>(python::args("self", "other")))
.def("GetNumAtoms", &Conformer::getNumAtoms, python::args("self"),
"Get the number of atoms in the conformer\n")
.def("HasOwningMol", &Conformer::hasOwningMol, python::args("self"),
"Returns whether or not this instance belongs to a molecule.\n")
.def("GetOwningMol", &Conformer::getOwningMol,
"Get the owning molecule\n",
python::return_value_policy<python::reference_existing_object>(),
python::args("self"))
.def("GetId", &Conformer::getId, python::args("self"),
"Get the ID of the conformer")
.def("SetId", &Conformer::setId, python::args("self", "id"),
"Set the ID of the conformer\n")
.def("GetAtomPosition", GetAtomPos, python::args("self", "aid"),
"Get the posistion of an atom\n")
.def("GetPositions", GetPos, python::args("self"),
"Get positions of all the atoms\n")
.def(
"SetPositions", SetPos,
(python::args("self"), python::args("positions")),
"Set positions of all the atoms given a 2D or 3D numpy array of type double\n")
.def("SetAtomPosition", SetAtomPos, python::args("self", "aid", "loc"),
"Set the position of the specified atom\n")
.def("SetAtomPosition",
(void(Conformer::*)(unsigned int, const RDGeom::Point3D &)) &
Conformer::setAtomPos,
python::args("self", "atomId", "position"),
"Set the position of the specified atom\n")
.def("Set3D", &Conformer::set3D, python::args("self", "v"),
"Set the 3D flag of the conformer\n")
.def("Is3D", &Conformer::is3D, python::args("self"),
"returns the 3D flag of the conformer\n")
// properties
.def("SetProp", MolSetProp<Conformer, std::string>,
(python::arg("self"), python::arg("key"), python::arg("val"),
python::arg("computed") = false),
"Sets a molecular property\n\n"
" ARGUMENTS:\n"
" - key: the name of the property to be set (a string).\n"
" - value: the property value (a string).\n"
" - computed: (optional) marks the property as being "
"computed.\n"
" Defaults to False.\n\n")
.def("SetDoubleProp", MolSetProp<Conformer, double>,
(python::arg("self"), python::arg("key"), python::arg("val"),
python::arg("computed") = false),
"Sets a double valued molecular property\n\n"
" ARGUMENTS:\n"
" - key: the name of the property to be set (a string).\n"
" - value: the property value as a double.\n"
" - computed: (optional) marks the property as being "
"computed.\n"
" Defaults to 0.\n\n")
.def("SetIntProp", MolSetProp<Conformer, int>,
(python::arg("self"), python::arg("key"), python::arg("val"),
python::arg("computed") = false),
"Sets an integer valued molecular property\n\n"
" ARGUMENTS:\n"
" - key: the name of the property to be set (an unsigned "
"number).\n"
" - value: the property value as an integer.\n"
" - computed: (optional) marks the property as being "
"computed.\n"
" Defaults to False.\n\n")
.def("SetUnsignedProp", MolSetProp<Conformer, unsigned int>,
(python::arg("self"), python::arg("key"), python::arg("val"),
python::arg("computed") = false),
"Sets an unsigned integer valued molecular property\n\n"
" ARGUMENTS:\n"
" - key: the name of the property to be set (a string).\n"
" - value: the property value as an unsigned integer.\n"
" - computed: (optional) marks the property as being "
"computed.\n"
" Defaults to False.\n\n")
.def("SetBoolProp", MolSetProp<Conformer, bool>,
(python::arg("self"), python::arg("key"), python::arg("val"),
python::arg("computed") = false),
"Sets a boolean valued molecular property\n\n"
" ARGUMENTS:\n"
" - key: the name of the property to be set (a string).\n"
" - value: the property value as a bool.\n"
" - computed: (optional) marks the property as being "
"computed.\n"
" Defaults to False.\n\n")
.def("HasProp", MolHasProp<Conformer>, python::args("self", "key"),
"Queries a conformer to see if a particular property has been "
"assigned.\n\n"
" ARGUMENTS:\n"
" - key: the name of the property to check for (a string).\n")
.def(
"GetProp", GetPyProp<Conformer>,
(python::arg("self"), python::arg("key"),
python::arg("autoConvert") = false),
"Returns the value of the property.\n\n"
" ARGUMENTS:\n"
" - key: the name of the property to return (a string).\n\n"
" - autoConvert: if True attempt to convert the property into a python object\n\n"
" RETURNS: a string\n\n"
" NOTE:\n"
" - If the property has not been set, a KeyError exception "
"will be raised.\n")
.def("GetDoubleProp", GetProp<Conformer, double>,
python::args("self", "key"),
"Returns the double value of the property if possible.\n\n"
" ARGUMENTS:\n"
" - key: the name of the property to return (a string).\n\n"
" RETURNS: a double\n\n"
" NOTE:\n"
" - If the property has not been set, a KeyError exception "
"will be raised.\n")
.def("GetIntProp", GetProp<Conformer, int>, python::args("self", "key"),
"Returns the integer value of the property if possible.\n\n"
" ARGUMENTS:\n"
" - key: the name of the property to return (a string).\n\n"
" RETURNS: an integer\n\n"
" NOTE:\n"
" - If the property has not been set, a KeyError exception "
"will be raised.\n")
.def("GetUnsignedProp", GetProp<Conformer, unsigned int>,
python::args("self", "key"),
"Returns the unsigned int value of the property if possible.\n\n"
" ARGUMENTS:\n"
" - key: the name of the property to return (a string).\n\n"
" RETURNS: an unsigned integer\n\n"
" NOTE:\n"
" - If the property has not been set, a KeyError exception "
"will be raised.\n")
.def("GetBoolProp", GetProp<Conformer, bool>,
python::args("self", "key"),
"Returns the Bool value of the property if possible.\n\n"
" ARGUMENTS:\n"
" - key: the name of the property to return (a string).\n\n"
" RETURNS: a bool\n\n"
" NOTE:\n"
" - If the property has not been set, a KeyError exception "
"will be raised.\n")
.def("ClearProp", MolClearProp<Conformer>, python::args("self", "key"),
"Removes a property from the conformer.\n\n"
" ARGUMENTS:\n"
" - key: the name of the property to clear (a string).\n")
.def("ClearComputedProps", MolClearComputedProps<Conformer>,
python::args("self"),
"Removes all computed properties from the conformer.\n\n")
.def("GetPropNames", &Conformer::getPropList,
(python::arg("self"), python::arg("includePrivate") = false,
python::arg("includeComputed") = false),
"Returns a tuple with all property names for this conformer.\n\n"
" ARGUMENTS:\n"
" - includePrivate: (optional) toggles inclusion of private "
"properties in the result set.\n"
" Defaults to 0.\n"
" - includeComputed: (optional) toggles inclusion of computed "
"properties in the result set.\n"
" Defaults to 0.\n\n"
" RETURNS: a tuple of strings\n")
.def("GetPropsAsDict", GetPropsAsDict<Conformer>,
(python::arg("self"), python::arg("includePrivate") = false,
python::arg("includeComputed") = false,
python::arg("autoConvertStrings") = true),
"Returns a dictionary populated with the conformer's properties.\n"
" n.b. Some properties are not able to be converted to python "
"types.\n\n"
" ARGUMENTS:\n"
" - includePrivate: (optional) toggles inclusion of private "
"properties in the result set.\n"
" Defaults to False.\n"
" - includeComputed: (optional) toggles inclusion of computed "
"properties in the result set.\n"
" Defaults to False.\n\n"
" RETURNS: a dictionary\n");
};
};
} // namespace RDKit
void wrap_conformer() { RDKit::conformer_wrapper::wrap(); }
|