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
|
//
// Copyright (C) 2018 Susan H. Leung
//
// @@ 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.
//
#include "Fragment.h"
#include <GraphMol/MolStandardize/FragmentCatalog/FragmentCatalogUtils.h>
#include <boost/tokenizer.hpp>
#include <utility>
typedef boost::tokenizer<boost::char_separator<char>> tokenizer;
#include <GraphMol/ChemTransforms/ChemTransforms.h>
#include <GraphMol/SmilesParse/SmilesWrite.h>
#include <GraphMol/Descriptors/MolDescriptors.h>
#include <GraphMol/Substruct/SubstructMatch.h>
#include <RDGeneral/types.h>
namespace RDKit {
namespace MolStandardize {
// constructor
FragmentRemover::FragmentRemover() {
BOOST_LOG(rdInfoLog) << "Initializing FragmentRemover\n";
FragmentCatalogParams fparams(defaultCleanupParameters.fragmentFile);
// unsigned int numfg = fparams->getNumFuncGroups();
// TEST_ASSERT(fparams->getNumFuncGroups() == 61);
this->d_fcat = new FragmentCatalog(&fparams);
this->LEAVE_LAST = true;
this->SKIP_IF_ALL_MATCH = false;
}
// overloaded constructor
FragmentRemover::FragmentRemover(const std::string fragmentFile,
bool leave_last, bool skip_if_all_match) {
std::string fname = !fragmentFile.empty()
? fragmentFile
: defaultCleanupParameters.fragmentFile;
FragmentCatalogParams fparams(fname);
this->d_fcat = new FragmentCatalog(&fparams);
if (!this->d_fcat) {
throw ValueErrorException(
"could not open fragment catalog parameter file " + fname);
}
this->LEAVE_LAST = leave_last;
this->SKIP_IF_ALL_MATCH = skip_if_all_match;
}
FragmentRemover::FragmentRemover(
const std::vector<std::pair<std::string, std::string>> &data,
bool leave_last, bool skip_if_all_match) {
FragmentCatalogParams fparams(data);
this->d_fcat = new FragmentCatalog(&fparams);
if (!this->d_fcat) {
throw ValueErrorException("could not process input data");
}
this->LEAVE_LAST = leave_last;
this->SKIP_IF_ALL_MATCH = skip_if_all_match;
}
// overloaded constructor
FragmentRemover::FragmentRemover(std::istream &fragmentStream, bool leave_last,
bool skip_if_all_match) {
FragmentCatalogParams fparams(fragmentStream);
this->d_fcat = new FragmentCatalog(&fparams);
if (!this->d_fcat) {
throw ValueErrorException("could not constract fragment catalog");
}
this->LEAVE_LAST = leave_last;
this->SKIP_IF_ALL_MATCH = skip_if_all_match;
}
// Destructor
FragmentRemover::~FragmentRemover() { delete d_fcat; };
ROMol *FragmentRemover::remove(const ROMol &mol) {
BOOST_LOG(rdInfoLog) << "Running FragmentRemover\n";
PRECONDITION(this->d_fcat, "");
const FragmentCatalogParams *fparams = this->d_fcat->getCatalogParams();
PRECONDITION(fparams, "");
const std::vector<std::shared_ptr<ROMol>> &fgrps = fparams->getFuncGroups();
bool sanitizeFrags = false;
// provides the list of atom numbers in each fragment
std::vector<std::vector<int>> atomFragMapping;
// track original fragment index with the fragment itself
std::vector<std::pair<boost::shared_ptr<ROMol>, unsigned int>> frags;
for (const auto &frag :
MolOps::getMolFrags(mol, sanitizeFrags, nullptr, &atomFragMapping)) {
frags.emplace_back(frag, frags.size());
}
for (auto &fgci : fgrps) {
size_t oCount = frags.size();
if (!oCount) {
break;
}
auto tfrags = frags;
// remove any fragments that this
frags.erase(std::remove_if(
frags.begin(), frags.end(),
[&fgci](const std::pair<boost::shared_ptr<ROMol>,
unsigned int> &frag) -> bool {
return fgci->getNumAtoms() == frag.first->getNumAtoms() &&
fgci->getNumBonds() == frag.first->getNumBonds() &&
SubstructMatch(*frag.first, *fgci).size() > 0;
}),
frags.end());
if (this->LEAVE_LAST && !this->SKIP_IF_ALL_MATCH && frags.empty()) {
// All the remaining fragments match this pattern - leave them all
frags = tfrags;
break;
}
if (frags.size() != oCount) {
BOOST_LOG(rdInfoLog) << "Removed fragment: "
<< fgci->getProp<std::string>(
common_properties::_Name)
<< "\n";
}
}
if (frags.empty()) {
if (this->SKIP_IF_ALL_MATCH) {
BOOST_LOG(rdInfoLog)
<< "All fragments matched; original molecule returned." << std::endl;
return new ROMol(mol);
}
return new ROMol();
}
boost::dynamic_bitset<> atomsToRemove(mol.getNumAtoms());
atomsToRemove.set();
// loop over remaining fragments and track atoms we aren't keeping
for (const auto &frag : frags) {
unsigned int fragIdx = frag.second;
for (auto atomIdx : atomFragMapping[fragIdx]) {
atomsToRemove.set(atomIdx, false);
}
}
// remove the atoms that need to go
auto *removed = new RWMol(mol);
removed->beginBatchEdit();
for (unsigned int i = 0; i < mol.getNumAtoms(); ++i) {
if (atomsToRemove[i]) {
removed->removeAtom(i);
}
}
removed->commitBatchEdit();
return static_cast<ROMol *>(removed);
}
bool isOrganic(const ROMol &frag) {
// Returns true if fragment contains at least one carbon atom.
for (const auto at : frag.atoms()) {
if (at->getAtomicNum() == 6) {
return true;
}
}
return false;
}
LargestFragmentChooser::LargestFragmentChooser(
const LargestFragmentChooser &other) {
BOOST_LOG(rdInfoLog) << "Initializing LargestFragmentChooser\n";
preferOrganic = other.preferOrganic;
useAtomCount = other.useAtomCount;
countHeavyAtomsOnly = other.countHeavyAtomsOnly;
}
ROMol *LargestFragmentChooser::choose(const ROMol &mol) {
BOOST_LOG(rdInfoLog) << "Running LargestFragmentChooser\n";
if (!mol.getNumAtoms()) {
return new ROMol(mol);
}
std::vector<boost::shared_ptr<ROMol>> frags = MolOps::getMolFrags(mol);
LargestFragmentChooser::Largest l;
for (const auto &frag : frags) {
std::string smiles = MolToSmiles(*frag);
BOOST_LOG(rdInfoLog) << "Fragment: " << smiles << "\n";
bool organic = isOrganic(*frag);
if (this->preferOrganic) {
// Skip this fragment if not organic and we already have an organic
// fragment as the largest so far
if (l.Fragment != nullptr && l.Organic && !organic) {
continue;
}
// Reset largest if it wasn't organic and this fragment is organic
// if largest and organic and not largest['organic']:
if (l.Fragment != nullptr && organic && !l.Organic) {
l.Fragment = nullptr;
}
}
unsigned int numatoms = 0;
if (this->useAtomCount) {
for (const auto at : frag->atoms()) {
++numatoms;
if (!this->countHeavyAtomsOnly) {
numatoms += at->getTotalNumHs();
}
}
// Skip this fragment if fewer atoms than the largest
if (l.Fragment != nullptr && (numatoms < l.NumAtoms)) {
continue;
}
}
// Skip this fragment if equal number of atoms but weight is lower
double weight = Descriptors::calcExactMW(*frag);
if (l.Fragment != nullptr &&
(!this->useAtomCount || numatoms == l.NumAtoms) &&
(weight < l.Weight)) {
continue;
}
// Skip this fragment if equal number of atoms and equal weight but smiles
// comes last alphabetically
if (l.Fragment != nullptr &&
(!this->useAtomCount || numatoms == l.NumAtoms) &&
(weight == l.Weight) && (smiles > l.Smiles)) {
continue;
}
BOOST_LOG(rdInfoLog) << "New largest fragment: " << smiles << " ("
<< numatoms << ")\n";
// Otherwise this is the largest so far
l.Smiles = smiles;
l.Fragment = frag;
l.NumAtoms = numatoms;
l.Weight = weight;
l.Organic = organic;
}
return new ROMol(*(l.Fragment));
}
LargestFragmentChooser::Largest::Largest() : Smiles(""), Fragment(nullptr) {}
LargestFragmentChooser::Largest::Largest(std::string &smiles,
boost::shared_ptr<ROMol> fragment,
unsigned int &numatoms, double &weight,
bool &organic)
: Smiles(smiles),
Fragment(std::move(fragment)),
NumAtoms(numatoms),
Weight(weight),
Organic(organic) {}
} // namespace MolStandardize
} // namespace RDKit
|