- debug
[alexxy/gromacs-colorvec.git] / src / colorvec.cpp
1 /*
2  * This file is part of the GROMACS molecular simulation package.
3  *
4  * Copyright (c) 2013,2014,2015, by the GROMACS development team, led by
5  * Mark Abraham, David van der Spoel, Berk Hess, and Erik Lindahl,
6  * and including many others, as listed in the AUTHORS file in the
7  * top-level source directory and at http://www.gromacs.org.
8  *
9  * GROMACS is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public License
11  * as published by the Free Software Foundation; either version 2.1
12  * of the License, or (at your option) any later version.
13  *
14  * GROMACS is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with GROMACS; if not, see
21  * http://www.gnu.org/licenses, or write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA.
23  *
24  * If you want to redistribute modifications to GROMACS, please
25  * consider that scientific software is very special. Version
26  * control is crucial - bugs must be traceable. We will be happy to
27  * consider code for inclusion in the official distribution, but
28  * derived work must not be called official GROMACS. Details are found
29  * in the README & COPYING files - if they are missing, get the
30  * official version at http://www.gromacs.org.
31  *
32  * To help us fund GROMACS development, we humbly ask that you cite
33  * the research papers on the package. Check out http://www.gromacs.org.
34  */
35 /*! \internal \file
36  * \brief
37  * Implements gmx::analysismodules::Freevolume.
38  *
39  * \author Titov Anatoly <Wapuk-cobaka@yandex.ru>
40  * \ingroup module_trajectoryanalysis
41  */
42
43 #include <gromacs/trajectoryanalysis.h>
44 #include <gromacs/trajectoryanalysis/topologyinformation.h>
45 #include <gromacs/selection/nbsearch.h>
46
47 #include <iostream>
48 #include <fstream>
49 //#include <chrono>
50 #include <cfloat>
51 #include <omp.h>
52 #include <vector>
53 #include <cstdio>
54 #include <iomanip>
55
56 // структура углов для одной краски
57 struct colorLocalAngles {
58     gmx::RVec   a1, a2;
59     gmx::RVec   b1, b2;
60     gmx::RVec   n1, n2;
61     double      a12, b12, n12;
62     std::vector< double > betaAngles;
63 };
64
65 // хрен пойми почему, но захотелось рекурсивно сделать | можно сделать и через вайл
66 long long returnBetaEnd(const std::string &currentLine, long long pos) {
67     switch (currentLine[pos]) {
68         case 'B' :
69             returnBetaEnd(currentLine, pos + 1);
70             break;
71         case 'E' :
72             returnBetaEnd(currentLine, pos + 1);
73             break;
74         default :
75             return (pos - 1);
76             break;
77     }
78     return (pos - 1); // формально логически лишняя строчка, но Qt ругается
79 }
80
81 // функция парсинга одной строки
82 void parseBetaListDATLine(const std::string &currentLine, std::vector< std::vector< unsigned int > > &localInputBL) {
83     size_t                      equalCount = 0;
84     std::vector< unsigned int > a;
85     a.resize(0);
86     for (size_t i = 0; i < currentLine.size(); ++i) {
87         if (currentLine[i] == '=') { // подсчитываем число "пустых" символов
88             ++equalCount;
89         } else {
90             long long temp = returnBetaEnd(currentLine, i);
91             if (temp - static_cast< long long >(i) > 3) {
92                 localInputBL.push_back(a);
93                 for (size_t j = i; j <= temp; ++j) {
94                     localInputBL.back().push_back(j - equalCount);
95                 }
96                 i = temp;
97             }
98         }
99     }
100 }
101
102 // функция нахождения бета-листов в структуре по файлу ДССП
103 void betaListDigestion(const std::string &inputFile, std::vector< std::vector< std::vector< unsigned int > > > &inputBL) {
104     inputBL.resize(0);
105     std::ifstream   file(inputFile);
106     std::string     line;
107     getline(file, line); // считываем число в первой строке - кол-во осмысленных элементов в строках - нам не нужно
108     getline(file, line);
109     if (line.size() > 3) {
110         do {
111             inputBL.resize(inputBL.size() + 1);
112             parseBetaListDATLine(line, inputBL.back());
113             line = "";
114             getline(file, line);
115         } while (line.size() > 3);
116     } else {
117         throw "DSSP DAT FILE IS EMPTY";
118     }
119     file.close();
120 }
121
122 // функция выделения индексов для бэталистов
123 inline void aminoacidsIndexation(const std::vector< size_t > &inputIndex, const gmx::TopologyInformation &top, std::vector< std::vector< size_t > > &aminoacidsIndex) {
124     aminoacidsIndex.resize(0);
125     for (size_t i = 0; i < inputIndex.size(); ++i) {
126         aminoacidsIndex.resize(std::max(aminoacidsIndex.size(), static_cast< size_t >(top.atoms()->atom[inputIndex[i]].resind + 1)));
127         aminoacidsIndex[top.atoms()->atom[inputIndex[i]].resind].push_back(inputIndex[i]);
128     }
129 }
130
131 // функция поиска RVec в кадре по имени->индексу
132 gmx::RVec returnRVec(const std::vector< gmx::RVec > &frame, const std::vector< std::pair< std::string, size_t > > &colorsIndex, const std::string &toFind) {
133     for (auto &i : colorsIndex) {
134         if (i.first == toFind) {
135             return frame[i.second];
136         }
137     }
138     throw "WRONG COLOR ATOM NAME TO EVALUATE VECTORS";
139 }
140
141 // функция векторного произведения двух RVec'ов
142 inline void RVecVecMultiply(gmx::RVec &n, const gmx::RVec &a, const gmx::RVec &b) {
143     n[0] = a[1] * b[2] - a[2] * b[1];
144     n[1] = a[2] * b[0] - a[0] * b[2];
145     n[2] = a[0] * b[1] - a[2] * b[0];
146 }
147
148 // поиск угла между двумя RVec'ами
149 inline double RVecAngle(const gmx::RVec &a, const gmx::RVec &b) {
150     return std::acos((a[0] * b[0] + a[1] * b[1] + a[2] * b[2]) / (a.norm() * b.norm()));
151 }
152
153 // вычисление внутренних углов в краске
154 void colorsAnglesEvaluation(const std::vector< gmx::RVec > &frame, const std::vector< std::vector< std::pair< std::string, size_t > > > &colorsIndex,
155                             std::vector< colorLocalAngles > &colorStruct) {
156     colorStruct.resize(colorsIndex.size());
157     #pragma omp parallel for ordered schedule(dynamic)
158     for (size_t i = 0; i < colorsIndex.size(); ++i) {
159         colorStruct[i].betaAngles.resize(0);
160         // "левый" блок
161         colorStruct[i].a1 = returnRVec(frame, colorsIndex[i], "CAF") - returnRVec(frame, colorsIndex[i], "CAJ") + returnRVec(frame, colorsIndex[i], "CAK") - returnRVec(frame, colorsIndex[i], "CAO");
162         colorStruct[i].a1 /= colorStruct[i].a1.norm();
163         colorStruct[i].b1 = returnRVec(frame, colorsIndex[i], "CAO") - returnRVec(frame, colorsIndex[i], "CAJ") + returnRVec(frame, colorsIndex[i], "CAM") - returnRVec(frame, colorsIndex[i], "CAH") + returnRVec(frame, colorsIndex[i], "CAK") - returnRVec(frame, colorsIndex[i], "CAF");
164         colorStruct[i].b1 /= colorStruct[i].b1.norm();
165         RVecVecMultiply(colorStruct[i].n1, colorStruct[i].a1, colorStruct[i].b1);
166         colorStruct[i].n1 /= colorStruct[i].n1.norm();
167         // "правый" блок
168         colorStruct[i].a2 = returnRVec(frame, colorsIndex[i], "CAB") - returnRVec(frame, colorsIndex[i], "CBQ") + returnRVec(frame, colorsIndex[i], "CBP") - returnRVec(frame, colorsIndex[i], "CBL");
169         colorStruct[i].a2 /= colorStruct[i].a2.norm();
170         colorStruct[i].b2 = returnRVec(frame, colorsIndex[i], "CBL") - returnRVec(frame, colorsIndex[i], "CBQ") + returnRVec(frame, colorsIndex[i], "CBN") - returnRVec(frame, colorsIndex[i], "CBS") + returnRVec(frame, colorsIndex[i], "CBP") - returnRVec(frame, colorsIndex[i], "CAB");
171         colorStruct[i].b2 /= colorStruct[i].b2.norm();
172         RVecVecMultiply(colorStruct[i].n2, colorStruct[i].a2, colorStruct[i].b2);
173         colorStruct[i].n2 *= -1; // для "сонаправленности" векторов нормали
174         colorStruct[i].n2 /= colorStruct[i].n2.norm();
175         colorStruct[i].a12 = RVecAngle(colorStruct[i].a1, colorStruct[i].a2);
176         colorStruct[i].b12 = RVecAngle(colorStruct[i].b1, colorStruct[i].b2);
177         colorStruct[i].n12 = RVecAngle(colorStruct[i].n1, colorStruct[i].n2);
178     }
179     #pragma omp barrier
180 }
181
182 // вычисление направляющего вектора в бэта-листе
183 inline void betaListsRVecsEvaluation(const std::vector< gmx::RVec > &frame, const std::vector< std::vector< unsigned int > > &inputBetaLists,
184                                      std::vector< gmx::RVec > &temp, const std::vector< size_t > &inputCA) {
185     temp.resize(0);
186     gmx::RVec tempA;
187     for (const auto &i : inputBetaLists) {
188         tempA = frame[inputCA[i[i.size() - 1]]] + frame[inputCA[i[i.size() - 2]]] - frame[inputCA[i[1]]] - frame[inputCA[i[0]]];
189         tempA /= tempA.norm();
190         temp.push_back(tempA);
191     }
192 }
193
194 // определение близко ли к белку находится краска
195 bool isNearPeptide(const t_trxframe &fr, const t_pbc *pbc, const std::vector< gmx::RVec > &inputFrame,
196                           gmx::AnalysisNeighborhood &nbhood, const std::vector< size_t > &inputIndex,
197                           const std::vector< std::pair< std::string, size_t > > &inputColor) {
198     gmx::AnalysisNeighborhoodSearch     nbsearch = nbhood.initSearch(pbc, gmx::AnalysisNeighborhoodPositions(fr.x, fr.natoms));
199     gmx::AnalysisNeighborhoodPair       pair;
200     for (const auto &i : inputColor) {
201         gmx::AnalysisNeighborhoodPairSearch pairSearch = nbsearch.startPairSearch(inputFrame[i.second].as_vec());
202         std::cout << std::endl << i.first << std::endl;
203         int count1 {0};
204         while (pairSearch.findNextPair(&pair)) {
205             std::cout << " " << ++count1 << std::endl;
206             for (const auto &j : inputIndex) {
207                 std::cout << " " << j;
208                 if (pair.refIndex() == j) {
209                     return true;
210                 }
211             }
212         }
213         std::cout << " " << i.first;
214     }
215     return false;
216 }
217
218 // поиск ближайших к краске бэта-листов
219 inline void searchNearBetaLists(const t_trxframe &fr, const t_pbc *pbc, const std::vector< gmx::RVec > &inputFrame,
220                                 gmx::AnalysisNeighborhood &nbhood,
221                                 const std::vector< std::vector< unsigned int > > &inputBLists,
222                                 const std::vector< std::pair< std::string, size_t > > &inputColor,
223                                 std::vector< bool > &outputList, const std::vector< std::vector< size_t > > &inputAminoacids) {
224     outputList.resize(0);
225     outputList.resize(inputBLists.size(), false);
226     gmx::AnalysisNeighborhoodSearch      nbsearch = nbhood.initSearch(pbc, gmx::AnalysisNeighborhoodPositions(fr.x, fr.natoms));
227     gmx::AnalysisNeighborhoodPair        pair;
228     for (const auto &i : inputColor) {
229         while (nbsearch.startPairSearch(inputFrame[i.second].as_vec()).findNextPair(&pair)) {
230             for (size_t j = 0; j < inputBLists.size(); ++j) {
231                 for (size_t k = 0; k < inputBLists[j].size(); ++k) {
232                     for (size_t m = 0; m < inputAminoacids[inputBLists[j][k]].size(); ++m) {
233                         if (pair.testIndex() == inputAminoacids[inputBLists[j][k]][m]) {
234                             outputList[j] = true;
235                         }
236                     }
237                 }
238             }
239         }
240     }
241
242 }
243
244 // определение углов между краской и направляющим вектором бэта-листа
245 inline void computeAnglesColorsVsBeta(const gmx::RVec &inputBetaRVec, colorLocalAngles &colorFormation) {
246     colorFormation.betaAngles.push_back(RVecAngle(inputBetaRVec, colorFormation.a1));
247     colorFormation.betaAngles.push_back(RVecAngle(inputBetaRVec, colorFormation.b1));
248     colorFormation.betaAngles.push_back(RVecAngle(inputBetaRVec, colorFormation.n1));
249     colorFormation.betaAngles.push_back(RVecAngle(inputBetaRVec, colorFormation.a2));
250     colorFormation.betaAngles.push_back(RVecAngle(inputBetaRVec, colorFormation.b2));
251     colorFormation.betaAngles.push_back(RVecAngle(inputBetaRVec, colorFormation.n2));
252 }
253
254 // функция записи в файл значений углов для кадра
255 void anglesFileDump(const int frameNum, const std::string &output, const std::vector< bool > &toPeptide, const std::vector< colorLocalAngles > &colorFormation) {
256     std::ofstream   file(output);
257     int temp = 0;
258     std::vector< double > betaTemp;
259     betaTemp.resize(0);
260     file << "frame =" << std::setw(8) << frameNum << std::endl;
261     for (size_t i = 0; i < colorFormation.size(); ++i) {
262         file << "color #" << std::setw(3) << i;
263         if (toPeptide[i]) {
264             file << std::setw(4) << "yes";
265         } else {
266             file << std::setw(4) << "no";
267         }
268         file << std::setw(7) << std::setprecision(2) << colorFormation[i].a12 << colorFormation[i].b12 << colorFormation[i].n12;
269         temp = colorFormation[i].betaAngles.size() / 6;
270         if (temp == 0) {
271             file << std::setw(4) << 0;
272         } else {
273             betaTemp.resize(6, 0.); // magic number, meh
274             for (size_t j = 0; j < colorFormation[i].betaAngles.size(); ++j) {
275                 betaTemp[j % 6] += colorFormation[i].betaAngles[j];
276             }
277             for (size_t j = 0; j < betaTemp.size(); ++j) {
278                 betaTemp[j] /= temp;
279             }
280             file << std::setw(4) << temp;
281             for (size_t j = 0; j < betaTemp.size(); ++j) {
282                 file << std::setw(7) << std::setprecision(2) << betaTemp[j];
283             }
284             for (size_t j = 0; j < colorFormation[i].betaAngles.size(); ++j) {
285                 file << std::setw(7) << std::setprecision(2) << colorFormation[i].betaAngles[j];
286             }
287         }
288     }
289     file.close();
290 }
291
292 /*! \brief
293  * \ingroup module_trajectoryanalysis
294  */
295 class colorVec : public gmx::TrajectoryAnalysisModule
296 {
297     public:
298
299         colorVec();
300         virtual ~colorVec();
301
302         //! Set the options and setting
303         virtual void initOptions(gmx::IOptionsContainer          *options,
304                                  gmx::TrajectoryAnalysisSettings *settings);
305
306         //! First routine called by the analysis framework
307         // virtual void initAnalysis(const t_trxframe &fr, t_pbc *pbc);
308         virtual void initAnalysis(const gmx::TrajectoryAnalysisSettings &settings,
309                                   const gmx::TopologyInformation        &top);
310
311         //! Call for each frame of the trajectory
312         // virtual void analyzeFrame(const t_trxframe &fr, t_pbc *pbc);
313         virtual void analyzeFrame(int frnr, const t_trxframe &fr, t_pbc *pbc,
314                                   gmx::TrajectoryAnalysisModuleData *pdata);
315
316         //! Last routine called by the analysis framework
317         // virtual void finishAnalysis(t_pbc *pbc);
318         virtual void finishAnalysis(int nframes);
319
320         //! Routine to write output, that is additional over the built-in
321         virtual void writeOutput();
322
323     private:
324
325         gmx::SelectionList                                              sel_;
326         std::string                                                     fnOut           {"name"};   // selectable
327         std::string                                                     fnBetaListsDat;             // selectable
328         float                                                           effRad          {0.8};      // selectable
329         std::vector< size_t >                                           index;
330         std::vector< size_t >                                           indexCA;
331         std::vector< std::vector< size_t > >                            aminoacidsIndex;
332         std::vector< std::vector< std::pair< std::string, size_t > > >  colorsNames;
333         std::vector< std::vector< std::vector< unsigned int > > >       betaLists;
334         gmx::AnalysisNeighborhood                                       nb_;
335
336         // Copy and assign disallowed by base.
337 };
338
339 colorVec::colorVec(): TrajectoryAnalysisModule()
340 {
341 }
342
343 colorVec::~colorVec()
344 {
345 }
346
347 /*
348  * ndx:
349  * [peptide]
350  * [CA]
351  * [color_{i}]
352  *
353  */
354
355 void
356 colorVec::initOptions(  gmx::IOptionsContainer          *options,
357                         gmx::TrajectoryAnalysisSettings *settings)
358 {
359     static const char *const desc[] = {
360         "[THISMODULE] to be done"
361     };
362     // Add the descriptive text (program help text) to the options
363     settings->setHelpText(desc);
364     // Add option for selection list
365     options->addOption(gmx::SelectionOption("sel")
366                             .storeVector(&sel_)
367                             .required().dynamicMask().multiValue()
368                             .description("select pepride and colors / -sf"));
369     // Add option for input file names
370     options->addOption(gmx::StringOption("dat")
371                             .store(&fnBetaListsDat)
372                             .description("a file to make dynamic beta lists"));
373     // Add option for output file name
374     options->addOption(gmx::StringOption("out")
375                             .store(&fnOut)
376                             .description("Index file for the algorithm output."));
377     // Add option for effRad constant
378     options->addOption(gmx::FloatOption("efRad")
379                             .store(&effRad)
380                             .description("max distance from colors to peptide in nm to consider to be \"near\""));
381     // Control input settings
382     settings->setFlags(gmx::TrajectoryAnalysisSettings::efNoUserPBC);
383     settings->setFlag(gmx::TrajectoryAnalysisSettings::efUseTopX);
384     //settings->setFlag(TrajectoryAnalysisSettings::efRequireTop);
385     settings->setPBC(true);
386 }
387
388 void
389 colorVec::initAnalysis( const gmx::TrajectoryAnalysisSettings   &settings,
390                         const gmx::TopologyInformation          &top)
391 {
392     // считывание индекса
393     index.resize(0);
394     for (gmx::ArrayRef< const int >::iterator ai {sel_.front().atomIndices().begin()}; (ai < sel_.front().atomIndices().end()); ai++) {
395         index.push_back(static_cast< size_t >(*ai));
396     }
397     // считывание индекса
398     indexCA.resize(0);
399     for (gmx::ArrayRef< const int >::iterator ai {sel_[1].atomIndices().begin()}; (ai < sel_[2].atomIndices().end()); ai++) {
400         index.push_back(static_cast< size_t >(*ai));
401     }
402     // считывание красок
403     colorsNames.resize(sel_.size() - 2);
404     for (size_t i = 2; i < sel_.size(); ++i) {
405         for (gmx::ArrayRef< const int >::iterator ai {sel_[i].atomIndices().begin()}; (ai < sel_[i].atomIndices().end()); ai++) {
406             colorsNames[i - 2].push_back(std::make_pair(*(top.atoms()->atomname[*ai]), static_cast< size_t >(*ai)));
407         }
408     }
409     // разбор dat файла для создания бэта листов
410     betaListDigestion(fnBetaListsDat, betaLists);
411     // разбор топологии для индексации бета листов
412     aminoacidsIndexation(index, top, aminoacidsIndex);
413     // задание радиуса рассматриваемых соседей
414     nb_.setCutoff(effRad);
415     /*
416      * формально можно сделать:
417      * найти соотношение между именами для углов и индексными номерами
418      * заполнить std::vector< std::vector< size_t > > nameToIndex;
419      * и в последствии считать:
420      * a1 = frame[nameToIndex[0][1] + ... - ... - ...
421      * b1 a2 b2 по аналогии только для [@<-[1, 2, 3]]
422      *
423      */
424 }
425
426 void
427 colorVec::analyzeFrame(int frnr, const t_trxframe &fr, t_pbc *pbc, gmx::TrajectoryAnalysisModuleData *pdata)
428 {
429     std::cout << "\tFrame analisis start ..." << std::endl;
430     std::vector< gmx::RVec > trajectoryFrame;
431     trajectoryFrame.resize(0);
432     // считывания текущего фрейма траектории
433     for (size_t i {0}; i < index.size(); ++i) {
434         trajectoryFrame.push_back(fr.x[index[i]]);
435     }
436     // подсчёт углов в красках
437     std::vector< colorLocalAngles > colorFormation;
438     std::cout << "\t\tColors' angles evaluation." << std::endl;
439     colorsAnglesEvaluation(trajectoryFrame, colorsNames, colorFormation);
440     // рассчёт положения относительно белка
441     /*
442      * формально можно совместить определение близости с белком и определение ближайших бэта-листов
443      * для этого думаю нужно как-то соотнести или сделать соотношение между индексом и бэта-листами (т.е. хранить что бы за О(1) делать)
444      *
445      */
446
447     std::vector< bool >     colorsToPeptide;
448     colorsToPeptide.resize(0);
449     colorsToPeptide.resize(colorsNames.size(), false);
450     std::cout << "\t\tWhich colors are \"near\" the pepride mass." << std::endl;
451     for (size_t i = 0; i < colorsNames.size(); ++i) {
452         colorsToPeptide[i] = isNearPeptide(fr, pbc, trajectoryFrame, nb_, index, colorsNames[i]);
453     }
454     // расчёт угла и среднего угла с ближайшими бета листами
455     std::vector< std::vector< bool > > colorsToBeta;
456     colorsToBeta.resize(0);
457     colorsToBeta.resize(colorsNames.size());
458     std::vector< std::vector< double > > colorsToBetaAngles;
459     colorsToBetaAngles.resize(0);
460     std::vector< gmx::RVec > betaListsRVecs;
461     std::cout << "\t\tBeta-lists' RVecs search." << std::endl;
462     betaListsRVecsEvaluation(trajectoryFrame, betaLists[frnr], betaListsRVecs, indexCA);
463     std::cout << "\t\tSearching nearby beta-lists." << std::endl;
464     for (size_t i = 0; i < colorsToPeptide.size(); ++i) {
465         if (colorsToPeptide[i]) {
466             searchNearBetaLists(fr, pbc, trajectoryFrame, nb_, betaLists[frnr], colorsNames[i], colorsToBeta[i], aminoacidsIndex);
467         }
468     }
469     std::cout << "\t\tComputing angles colors vs betas." << std::endl;
470     for (size_t i = 0; i < colorsToBeta.size(); ++i) {
471         for (size_t j = 0; j < colorsToBeta[i].size(); ++j) {
472             if (colorsToBeta[i][j]) {
473                 computeAnglesColorsVsBeta(betaListsRVecs[j], colorFormation[i]);
474             }
475         }
476     }
477     // вывод в файл(ы) информацию для фрейма
478     std::cout << "\t\tDumping data." << std::endl;
479     anglesFileDump(frnr, fnOut, colorsToPeptide, colorFormation);
480     std::cout << "\tFrame analysed." << std::endl;
481 }
482
483 void
484 colorVec::finishAnalysis(int nframes)
485 {
486
487 }
488
489 void
490 colorVec::writeOutput()
491 {
492     /*
493      *
494      * frame #<current frame number>
495      * color #<color number> <yes/no for "close" to peptide> a12 b12 n12 <number of beta lists> <6 avg beta angles> [<6 angles for each beta list>]
496      *
497      */
498     std::cout << "\n\t colorAngles finished successfully" << std::endl;
499 }
500
501 /*! \brief
502  * The main function for the analysis template.
503  */
504 int
505 main(int argc, char *argv[])
506 {
507     return gmx::TrajectoryAnalysisCommandLineRunner::runAsMain<colorVec>(argc, argv);
508 }