]> git.donarmstrong.com Git - rsem.git/blob - PairedEndQModel.h
RSEM Source Codes
[rsem.git] / PairedEndQModel.h
1 #ifndef PAIREDENDQMODEL_H_
2 #define PAIREDENDQMODEL_H_
3
4 #include<cmath>
5 #include<cstdio>
6 #include<cassert>
7 #include<cstring>
8 #include<string>
9 #include<algorithm>
10 #include<sstream>
11
12 #include "utils.h"
13 #include "Orientation.h"
14 #include "LenDist.h"
15 #include "RSPD.h"
16 #include "QualDist.h"
17 #include "QProfile.h"
18 #include "NoiseQProfile.h"
19
20 #include "ModelParams.h"
21 #include "RefSeq.h"
22 #include "Refs.h"
23 #include "SingleReadQ.h"
24 #include "PairedEndReadQ.h"
25 #include "PairedEndHit.h"
26 #include "ReadReader.h"
27
28 #include "simul.h"
29
30 class PairedEndQModel {
31 public:
32         PairedEndQModel(Refs* refs = NULL) {
33                 this->refs = refs;
34                 M = (refs != NULL ? refs->getM() : 0);
35                 memset(N, 0, sizeof(N));
36                 estRSPD = false;
37                 needCalcConPrb = true;
38
39                 ori = new Orientation();
40                 gld = new LenDist();
41                 rspd = new RSPD(estRSPD);
42                 qd = new QualDist();
43                 qpro = new QProfile();
44                 nqpro = new NoiseQProfile();
45                 mld = new LenDist();
46
47                 mw = NULL;
48                 seedLen = 0;
49         }
50
51         //If it is not a master node, only init & update can be used!
52         PairedEndQModel(ModelParams& params, bool isMaster = true) {
53                 M = params.M;
54                 memcpy(N, params.N, sizeof(params.N));
55                 refs = params.refs;
56                 estRSPD = params.estRSPD;
57                 seedLen = params.seedLen;
58                 needCalcConPrb = true;
59
60                 ori = NULL; gld = NULL; rspd = NULL; qd = NULL; qpro = NULL; nqpro = NULL; mld = NULL;
61                 mw = NULL;
62
63                 if (isMaster) {
64                         ori = new Orientation(params.probF);
65                         if (!estRSPD) rspd = new RSPD(estRSPD);
66                         qd = new QualDist();
67                         mld = new LenDist(params.mate_minL, params.mate_maxL);
68                 }
69
70                 gld = new LenDist(params.minL, params.maxL);
71                 if (estRSPD) rspd = new RSPD(estRSPD, params.B);
72                 qpro = new QProfile();
73                 nqpro = new NoiseQProfile();
74         }
75
76         ~PairedEndQModel() {
77                 refs = NULL;
78                 if (ori != NULL) delete ori;
79                 if (gld != NULL) delete gld;
80                 if (rspd != NULL) delete rspd;
81                 if (qd != NULL) delete qd;
82                 if (qpro != NULL) delete qpro;
83                 if (nqpro != NULL) delete nqpro;
84                 if (mld != NULL) delete mld;
85                 if (mw != NULL) delete mw;
86         }
87
88         void estimateFromReads(const char*);
89
90         //if prob is too small, just make it 0
91         double getConPrb(const PairedEndReadQ& read, const PairedEndHit& hit) {
92                 if (read.isLowQuality()) return 0.0;
93
94                 double prob;
95                 int sid = hit.getSid();
96                 RefSeq &ref = refs->getRef(sid);
97                 int dir = hit.getDir();
98                 int pos = hit.getPos();
99                 int fullLen = ref.getFullLen();
100                 int totLen = ref.getTotLen();
101                 int insertLen = hit.getInsertL();
102
103                 int fpos = (dir == 0 ? pos : totLen - pos - insertLen); // the aligned position reported in SAM file, should be a coordinate in forward strand
104                 int effL = std::min(fullLen, totLen - insertLen + 1);
105
106                 assert(fpos >= 0 && fpos + insertLen <= totLen && insertLen <= totLen);
107                 if (fpos >= fullLen || ref.getMask(fpos)) return 0.0; // For paired-end model, fpos is the seedPos
108
109                 prob = ori->getProb(dir) * gld->getAdjustedProb(insertLen, totLen) *
110                        rspd->getAdjustedProb(fpos, effL, fullLen);
111
112                 const SingleReadQ& mate1 = read.getMate1();
113                 prob *= mld->getAdjustedProb(mate1.getReadLength(), insertLen) *
114                         qpro->getProb(mate1.getReadSeq(), mate1.getQScore(), ref, pos, dir);
115
116                 const SingleReadQ& mate2 = read.getMate2();
117                 int m2pos = totLen - pos - insertLen;
118                 int m2dir = !dir;
119                 prob *= mld->getAdjustedProb(mate2.getReadLength(), hit.getInsertL()) *
120                         qpro->getProb(mate2.getReadSeq(), mate2.getQScore(), ref, m2pos, m2dir);
121
122                 if (prob < EPSILON) { prob = 0.0; }
123
124                 prob = (mw[sid] < EPSILON ? 0.0 : prob / mw[sid]);
125
126                 return prob;
127         }
128
129         double getNoiseConPrb(const PairedEndReadQ& read) {
130                 if (read.isLowQuality()) return 0.0;
131
132                 double prob;
133                 const SingleReadQ& mate1 = read.getMate1();
134                 const SingleReadQ& mate2 = read.getMate2();
135
136                 prob = mld->getProb(mate1.getReadLength()) * nqpro->getProb(mate1.getReadSeq(), mate1.getQScore());
137                 prob *= mld->getProb(mate2.getReadLength()) * nqpro->getProb(mate2.getReadSeq(), mate2.getQScore());
138
139                 if (prob < EPSILON) { prob = 0.0; }
140
141                 prob = (mw[0] < EPSILON ? 0.0: prob / mw[0]);
142
143                 return prob;
144         }
145
146         double getLogP() { return nqpro->getLogP(); }
147
148         void init();
149
150         void update(const PairedEndReadQ& read, const PairedEndHit& hit, double frac) {
151                 if (read.isLowQuality() || frac < EPSILON) return;
152
153                 RefSeq& ref = refs->getRef(hit.getSid());
154                 const SingleReadQ& mate1 = read.getMate1();
155                 const SingleReadQ& mate2 = read.getMate2();
156
157                 gld->update(hit.getInsertL(), frac);
158                 if (estRSPD) {
159                         int fpos = (hit.getDir() == 0 ? hit.getPos() : ref.getTotLen() - hit.getPos() - hit.getInsertL());
160                         rspd->update(fpos, ref.getFullLen(), frac);
161                 }
162                 qpro->update(mate1.getReadSeq(), mate1.getQScore(), ref, hit.getPos(), hit.getDir(), frac);
163
164                 int m2pos = ref.getTotLen() - hit.getPos() - hit.getInsertL();
165                 int m2dir = !hit.getDir();
166                 qpro->update(mate2.getReadSeq(), mate2.getQScore(), ref, m2pos, m2dir, frac);
167         }
168
169         void updateNoise(const PairedEndReadQ& read, double frac) {
170                 if (read.isLowQuality() || frac < EPSILON) return;
171
172                 const SingleReadQ& mate1 = read.getMate1();
173                 const SingleReadQ& mate2 = read.getMate2();
174
175                 nqpro->update(mate1.getReadSeq(), mate1.getQScore(), frac);
176                 nqpro->update(mate2.getReadSeq(), mate2.getQScore(), frac);
177         }
178
179         void finish();
180
181         void collect(const PairedEndQModel&);
182
183         bool getNeedCalcConPrb() { return needCalcConPrb; }
184         void setNeedCalcConPrb(bool value) { needCalcConPrb = value; }
185
186         void read(const char*);
187         void write(const char*);
188
189         const LenDist& getGLD() { return *gld; }
190
191         void startSimulation(simul*, double*);
192         bool simulate(int, PairedEndReadQ&, int&);
193         void finishSimulation();
194
195         //Use it after function 'read' or 'estimateFromReads'
196         double* getMW() { 
197           assert(mw != NULL);
198           return mw;
199         }
200
201         int getModelType() const { return model_type; }
202
203         bool simulate(int, PairedEndReadQ&, SingleReadQ&, int&);
204  
205 private:
206         static const int model_type = 3;
207         static const int read_type = 3;
208
209         int M;
210         int N[3];
211         Refs *refs;
212         int seedLen;
213
214         bool estRSPD;
215         bool needCalcConPrb; //true need, false does not need
216
217         Orientation *ori;
218         LenDist *gld, *mld; //mld1 mate_length_dist
219         RSPD *rspd;
220         QualDist *qd;
221         QProfile *qpro;
222         NoiseQProfile *nqpro;
223
224         simul *sampler; // for simulation
225         double *theta_cdf; // for simulation
226
227         double *mw; // for masking
228
229         void calcMW();
230 };
231
232 void PairedEndQModel::estimateFromReads(const char* readFN) {
233         int s;
234         char readFs[2][STRLEN];
235     PairedEndReadQ read;
236
237     mld->init();
238     for (int i = 0; i < 3; i++)
239         if (N[i] > 0) {
240                 genReadFileNames(readFN, i, read_type, s, readFs);
241                 ReadReader<PairedEndReadQ> reader(s, readFs);
242
243                 int cnt = 0;
244                 while (reader.next(read)) {
245                         SingleReadQ mate1 = read.getMate1();
246                         SingleReadQ mate2 = read.getMate2();
247
248                         mld->update(mate1.getReadLength(), 1.0);
249                         mld->update(mate2.getReadLength(), 1.0);
250
251                         qd->update(mate1.getQScore());
252                         qd->update(mate2.getQScore());
253
254                         if (i == 0) {
255                                 nqpro->updateC(mate1.getReadSeq(), mate1.getQScore());
256                                 nqpro->updateC(mate2.getReadSeq(), mate2.getQScore());
257                         }
258
259                         ++cnt;
260                         if (verbose && cnt % 1000000 == 0) { printf("%d READS PROCESSED\n", cnt); }
261                 }
262
263                 if (verbose) { printf("estimateFromReads, N%d finished.\n", i); }
264         }
265
266     mld->finish();
267     qd->finish();
268     nqpro->calcInitParams();
269
270     mw = new double[M + 1];
271     calcMW();
272 }
273
274 void PairedEndQModel::init() {
275         gld->init();
276         if (estRSPD) rspd->init();
277         qpro->init();
278         nqpro->init();
279 }
280
281 void PairedEndQModel::finish() {
282         gld->finish();
283         if (estRSPD) rspd->finish();
284         qpro->finish();
285         nqpro->finish();
286         needCalcConPrb = true;
287         calcMW();
288 }
289
290 void PairedEndQModel::collect(const PairedEndQModel& o) {
291         gld->collect(*(o.gld));
292         if (estRSPD) rspd->collect(*(o.rspd));
293         qpro->collect(*(o.qpro));
294         nqpro->collect(*(o.nqpro));
295 }
296
297 //Only master node can call
298 void PairedEndQModel::read(const char* inpF) {
299         int val;
300         FILE *fi = fopen(inpF, "r");
301         if (fi == NULL) { fprintf(stderr, "Cannot open %s! It may not exist.\n", inpF); exit(-1); }
302
303         fscanf(fi, "%d", &val);
304         assert(val == model_type);
305
306         ori->read(fi);
307         gld->read(fi);
308         mld->read(fi);
309         rspd->read(fi);
310         qd->read(fi);
311         qpro->read(fi);
312         nqpro->read(fi);
313
314         if (fscanf(fi, "%d", &M) == 1) {
315           mw = new double[M + 1];
316           for (int i = 0; i <= M; i++) fscanf(fi, "%lf", &mw[i]);
317         }
318
319         fclose(fi);
320 }
321
322 //Only master node can call
323 void PairedEndQModel::write(const char* outF) {
324         FILE *fo = fopen(outF, "w");
325
326         fprintf(fo, "%d\n", model_type);
327         fprintf(fo, "\n");
328
329         ori->write(fo);  fprintf(fo, "\n");
330         gld->write(fo);  fprintf(fo, "\n");
331         mld->write(fo);  fprintf(fo, "\n");
332         rspd->write(fo); fprintf(fo, "\n");
333         qd->write(fo);   fprintf(fo, "\n");
334         qpro->write(fo); fprintf(fo, "\n");
335         nqpro->write(fo);
336
337         if (mw != NULL) {
338           fprintf(fo, "%d\n", M);
339           for (int i = 0; i < M; i++) {
340             fprintf(fo, "%.15g ", mw[i]);
341           }
342           fprintf(fo, "%.15g\n", mw[M]);
343         }
344
345         fclose(fo);
346 }
347
348 void PairedEndQModel::startSimulation(simul* sampler, double* theta) {
349         this->sampler = sampler;
350
351         theta_cdf = new double[M + 1];
352         for (int i = 0; i <= M; i++) {
353                 theta_cdf[i] = theta[i];
354                 if (i > 0) theta_cdf[i] += theta_cdf[i - 1];
355         }
356
357         rspd->startSimulation(M, refs);
358         qd->startSimulation();
359         qpro->startSimulation();
360         nqpro->startSimulation();
361 }
362
363 bool PairedEndQModel::simulate(int rid, PairedEndReadQ& read, int& sid) {
364         int dir, pos;
365         int insertL, mateL1, mateL2;
366         std::string name;
367         std::string qual1, qual2, readseq1, readseq2;
368         std::ostringstream strout;
369
370         sid = sampler->sample(theta_cdf, M + 1);
371
372         if (sid == 0) {
373                 dir = pos = insertL = 0;
374                 mateL1 = mld->simulate(sampler, -1);
375                 qual1 = qd->simulate(sampler, mateL1);
376                 readseq1 = nqpro->simulate(sampler, mateL1, qual1);
377
378                 mateL2 = mld->simulate(sampler, -1);
379                 qual2 = qd->simulate(sampler, mateL2);
380                 readseq2 = nqpro->simulate(sampler, mateL2, qual2);
381         }
382         else {
383                 RefSeq &ref = refs->getRef(sid);
384                 dir = ori->simulate(sampler);
385                 insertL = gld->simulate(sampler, ref.getTotLen());
386                 if (insertL < 0) return false;
387                 int effL = std::min(ref.getFullLen(), ref.getTotLen() - insertL + 1);
388                 pos = rspd->simulate(sampler, sid, effL);
389                 if (pos < 0) return false;
390                 if (dir > 0) pos = ref.getTotLen() - pos - insertL;
391
392                 mateL1 = mld->simulate(sampler, insertL);
393                 qual1 = qd->simulate(sampler, mateL1);
394                 readseq1 = qpro->simulate(sampler, mateL1, pos, dir, qual1, ref);
395
396                 int m2pos = ref.getTotLen() - pos - insertL;
397                 int m2dir = !dir;
398
399                 mateL2 = mld->simulate(sampler, insertL);
400                 qual2 = qd->simulate(sampler, mateL2);
401                 readseq2 = qpro->simulate(sampler, mateL2, m2pos, m2dir, qual2, ref);
402         }
403
404         std::ostringstream stdout;
405         stdout<<rid<<"_"<<dir<<"_"<<sid<<"_"<<pos<<"_"<<insertL;
406         name = stdout.str();
407
408         read = PairedEndReadQ(SingleReadQ(name + "/1", readseq1, qual1), SingleReadQ(name + "/2", readseq2, qual2));
409
410         return true;
411 }
412
413 void PairedEndQModel::finishSimulation() {
414         delete[] theta_cdf;
415
416         rspd->finishSimulation();
417         qd->finishSimulation();
418         qpro->finishSimulation();
419         nqpro->finishSimulation();
420 }
421
422
423 void PairedEndQModel::calcMW() {
424   assert(seedLen >= OLEN && mld->getMinL() >= seedLen);
425
426   memset(mw, 0, sizeof(double) * (M + 1));
427   mw[0] = 1.0;
428
429   for (int i = 1; i <= M; i++) { 
430     RefSeq& ref = refs->getRef(i);
431     int totLen = ref.getTotLen();
432     int fullLen = ref.getFullLen();
433     int end = std::min(fullLen, totLen - gld->getMinL() + 1);
434     double value = 0.0;
435     int minL, maxL;
436     int effL, pfpos;
437
438     //seedPos is fpos here
439     for (int seedPos = 0; seedPos < end; seedPos++) 
440       if (ref.getMask(seedPos)) {
441         minL = gld->getMinL();
442         maxL = std::min(gld->getMaxL(), totLen - seedPos);
443         pfpos = seedPos;
444         for (int fragLen = minL; fragLen <= maxL; fragLen++) {
445           effL = std::min(fullLen, totLen - fragLen + 1); 
446           value += gld->getAdjustedProb(fragLen, totLen) * rspd->getAdjustedProb(pfpos, effL, fullLen); 
447         }
448       }
449     
450     mw[i] = 1.0 - value;
451
452     if (mw[i] < 1e-8) { 
453       //      fprintf(stderr, "Warning: %dth reference sequence is masked for almost all positions!\n", i);
454       mw[i] = 0.0;
455     }
456   }
457 }
458
459 #endif /* PAIREDENDQMODEL_H_ */