Mise à jour terminée. Pour connaître les apports de la version 13.8.4 par rapport à notre ancienne version vous pouvez lire les "Release Notes" suivantes :
https://about.gitlab.com/releases/2021/02/11/security-release-gitlab-13-8-4-released/
https://about.gitlab.com/releases/2021/02/05/gitlab-13-8-3-released/

segment.cpp 29.6 KB
Newer Older
Mikaël Salson's avatar
Mikaël Salson committed
1
/*
2
  This file is part of Vidjil <http://www.vidjil.org>
3
  Copyright (C) 2011, 2012, 2013, 2014, 2015, 2016 by Bonsai bioinformatics
4 5 6 7 8
  at CRIStAL (UMR CNRS 9189, Université Lille) and Inria Lille
  Contributors: 
      Mathieu Giraud <mathieu.giraud@vidjil.org>
      Mikaël Salson <mikael.salson@vidjil.org>
      Marc Duez <marc.duez@vidjil.org>
Mikaël Salson's avatar
Mikaël Salson committed
9 10 11 12 13 14 15 16 17 18 19 20 21 22

  "Vidjil" is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.

  "Vidjil" is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with "Vidjil". If not, see <http://www.gnu.org/licenses/>
*/
Mikaël Salson's avatar
Mikaël Salson committed
23
#include <algorithm>    // std::sort
Mikaël Salson's avatar
Mikaël Salson committed
24 25 26 27
#include <cassert>
#include "segment.h"
#include "tools.h"
#include "affectanalyser.h"
Mikaël Salson's avatar
Mikaël Salson committed
28
#include <sstream>
29
#include <cstring>
Marc Duez's avatar
Marc Duez committed
30
#include <string>
Mikaël Salson's avatar
Mikaël Salson committed
31

Mathieu Giraud's avatar
Mathieu Giraud committed
32
Segmenter::~Segmenter() {}
Mikaël Salson's avatar
Mikaël Salson committed
33

Mathieu Giraud's avatar
Mathieu Giraud committed
34
Sequence Segmenter::getSequence() const {
Mikaël Salson's avatar
Mikaël Salson committed
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54
  Sequence s ;
  s.label_full = info ;
  s.label = label + " " + (reversed ? "-" : "+");
  s.sequence = revcomp(sequence, reversed);

  return s ;
}

string Segmenter::getJunction(int l) const {
  assert(isSegmented());

  int start = (getLeft() + getRight())/2 - l/2;
  
  if (start < 0 or start + l > (int)sequence.size())  // TODO: +l ou +l-1 ?
    return "" ;

  return getSequence().sequence.substr(start, l);
}

int Segmenter::getLeft() const {
Mathieu Giraud's avatar
Mathieu Giraud committed
55
  return Vend;
Mikaël Salson's avatar
Mikaël Salson committed
56 57 58
}
  
int Segmenter::getRight() const {
Mathieu Giraud's avatar
Mathieu Giraud committed
59
  return Jstart;
Mikaël Salson's avatar
Mikaël Salson committed
60 61 62
}

int Segmenter::getLeftD() const {
Mathieu Giraud's avatar
Mathieu Giraud committed
63
  return Dstart;
Mikaël Salson's avatar
Mikaël Salson committed
64 65 66
}
  
int Segmenter::getRightD() const {
Mathieu Giraud's avatar
Mathieu Giraud committed
67
  return Dend;
Mikaël Salson's avatar
Mikaël Salson committed
68 69 70 71 72 73 74 75 76 77 78 79 80 81
}

bool Segmenter::isReverse() const {
  return reversed;
}

bool Segmenter::isSegmented() const {
  return segmented;
}

bool Segmenter::isDSegmented() const {
  return dSegmented;
}

82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100

// E-values

void Segmenter::checkLeftRightEvaluesThreshold(double threshold, int strand)
{
  if (threshold == NO_LIMIT_VALUE)
    return ;

  if (evalue_left >= threshold && evalue_right >= threshold)
    because = UNSEG_TOO_FEW_ZERO ;
  else if ((strand == 1 ? evalue_left : evalue_right) >= threshold)
    because = UNSEG_TOO_FEW_V ;
  else if ((strand == 1 ? evalue_right : evalue_left) >= threshold)
    because = UNSEG_TOO_FEW_J ;
  else if (evalue >= threshold) // left and right are <= threshold, but their sum is > threshold
    because = UNSEG_TOO_FEW_ZERO ;
}


Mikaël Salson's avatar
Mikaël Salson committed
101 102 103 104 105 106 107 108
// Chevauchement

string Segmenter::removeChevauchement()
{
  assert(isSegmented());
  
  string chevauchement = "" ;

Mathieu Giraud's avatar
Mathieu Giraud committed
109
  if (Vend >= Jstart)
Mikaël Salson's avatar
Mikaël Salson committed
110
    {
Mathieu Giraud's avatar
Mathieu Giraud committed
111
      int middle = (Vend + Jstart) / 2 ;
112
      chevauchement = " !ov " + string_of_int (Vend - Jstart + 1);
Mathieu Giraud's avatar
Mathieu Giraud committed
113 114
      Vend = middle ;
      Jstart = middle+1 ;
Mikaël Salson's avatar
Mikaël Salson committed
115 116 117 118 119 120 121 122 123 124 125 126 127 128
    }

  return chevauchement ;
}

// Prettyprint


bool Segmenter::finishSegmentation() 
{
  assert(isSegmented());
  
  string seq = getSequence().sequence;
    
Mathieu Giraud's avatar
Mathieu Giraud committed
129 130 131 132 133
  seg_V = seq.substr(0, Vend+1) ;
  seg_N = seq.substr(Vend+1, Jstart-Vend-1) ;  // Twice computed for FineSegmenter, but only once in KmerSegmenter !
  seg_J = seq.substr(Jstart) ;
  Dstart=0;
  Dend=0;
Mikaël Salson's avatar
Mikaël Salson committed
134 135 136 137 138 139 140 141 142 143 144 145 146

  info = "VJ \t" + string_of_int(FIRST_POS) + " " + info + " " + string_of_int(seq.size() - 1 + FIRST_POS) ;
  info += "\t" + code ;

  info = (reversed ? "- " : "+ ") + info ;

  return true ;
}

bool Segmenter::finishSegmentationD() 
{
  string seq = getSequence().sequence;

Mathieu Giraud's avatar
Mathieu Giraud committed
147 148
  seg_V = seq.substr(0, Vend+1) ; // From pos. 0 to Vend
  seg_J = seq.substr(Jstart) ;
149
  seg_N = seq.substr(Vend+1, Jstart-Vend-1) ;  // Twice computed for FineSegmenter, but only once in KmerSegmenter !
Mathieu Giraud's avatar
Mathieu Giraud committed
150
  seg_D  = seq.substr(Dstart, Dend-Dstart+1) ; // From Dstart to Dend
Mikaël Salson's avatar
Mikaël Salson committed
151
  
Mathieu Giraud's avatar
Mathieu Giraud committed
152 153 154 155
  info = "VDJ \t0 " + string_of_int(Vend) +
		" " + string_of_int(Dstart) + 
		" " + string_of_int(Dend) +
		" " + string_of_int(Jstart) +
Mikaël Salson's avatar
Mikaël Salson committed
156 157 158 159 160 161 162 163 164
		" " + string_of_int(seq.size()-1+FIRST_POS) ;
		
  info += "\t" + code ;
  
  info = (reversed ? "- " : "+ ") + info ;

  return true ;
}

165 166
string Segmenter::getInfoLine() const
{
167
  string s = "" ;
168 169 170 171 172

  s += (segmented ? "" : "! ") + info ;
  s += " " + info_extra ;
  s += " " + segmented_germline->code ;
  s += " " + string(segmented_mesg[because]) ;
173 174 175 176

  if (evalue > NO_LIMIT_VALUE)
    s += " " + scientific_string_of_double(evalue);

177 178 179 180 181
  if (evalue_left > NO_LIMIT_VALUE)
    s += " " + scientific_string_of_double(evalue_left);
  if (evalue_right > NO_LIMIT_VALUE)
    s += "/" + scientific_string_of_double(evalue_right);

182 183 184
  return s ;
}

185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200
string KmerSegmenter::getInfoLineWithAffects() const
{
   stringstream ss;

   ss << "# "
      << right << setw(3) << score << " "
      << left << setw(30)
      << getInfoLine() ;

   if (getSegmentationStatus() != UNSEG_TOO_SHORT)
     ss << getKmerAffectAnalyser()->toString();

   return ss.str();
}


Mikaël Salson's avatar
Mikaël Salson committed
201 202
ostream &operator<<(ostream &out, const Segmenter &s)
{
203
  out << ">" << s.label << " " ;
204
  out << s.getInfoLine() << endl;
Mikaël Salson's avatar
Mikaël Salson committed
205 206 207 208 209 210 211 212 213

  if (s.segmented)
    {
      out << s.seg_V << endl ;
      out << s.seg_N << endl ;
      out << s.seg_J << endl ;
    }
  else
    {
214
      out << s.getSequence().sequence << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
215 216 217 218 219 220 221 222
    }

  return out ;
}


// KmerSegmenter (Cheap)

223 224
KmerSegmenter::KmerSegmenter() { kaa = 0 ; }

225
KmerSegmenter::KmerSegmenter(Sequence seq, Germline *germline, double threshold, int multiplier)
Mikaël Salson's avatar
Mikaël Salson committed
226 227 228 229
{
  label = seq.label ;
  sequence = seq.sequence ;
  info = "" ;
230
  info_extra = "seed";
Mikaël Salson's avatar
Mikaël Salson committed
231
  segmented = false;
232
  segmented_germline = germline ;
233
  system = germline->code; // useful ?
234
  reversed = false;
Mathieu Giraud's avatar
Mathieu Giraud committed
235
  Dend=0;
236
  because = NOT_PROCESSED ; // Cause of unsegmentation
237
  score = 0 ;
238
  evalue = NO_LIMIT_VALUE;
239 240
  evalue_left = NO_LIMIT_VALUE;
  evalue_right = NO_LIMIT_VALUE;
241

242
  int s = (size_t)germline->index->getS() ;
Mikaël Salson's avatar
Mikaël Salson committed
243
  int length = sequence.length() ;
Mikaël Salson's avatar
Mikaël Salson committed
244

245
  if (length < s) 
Mikaël Salson's avatar
Mikaël Salson committed
246
    {
Mathieu Giraud's avatar
Mathieu Giraud committed
247 248
      because = UNSEG_TOO_SHORT;
      kaa = NULL;
249
      return ;
Mikaël Salson's avatar
Mikaël Salson committed
250 251
    }
 
252
  kaa = new KmerAffectAnalyser(*(germline->index), sequence);
Mikaël Salson's avatar
Mikaël Salson committed
253 254
  
  // Check strand consistency among the affectations.
Mikaël Salson's avatar
Mikaël Salson committed
255 256 257 258 259 260 261 262 263
  int strand;
  int nb_strand[2] = {0,0};     // In cell 0 we'll put the number of negative
                                // strand, while in cell 1 we'll put the
                                // positives
  for (int i = 0; i < kaa->count(); i++) { 
    KmerAffect it = kaa->getAffectation(i);
    if (! it.isAmbiguous() && ! it.isUnknown()) {
      strand = affect_strand(it.affect);
      nb_strand[(strand + 1) / 2] ++; // (strand+1) / 2 → 0 if strand == -1; 1 if strand == 1
Mikaël Salson's avatar
Mikaël Salson committed
264 265 266
    }
  }

267 268
  score = nb_strand[0] + nb_strand[1] ; // Used only for non-segmented germlines

269 270
  reversed = (nb_strand[0] > nb_strand[1]) ;

271 272
  if ((germline->seg_method == SEG_METHOD_MAX12)
      || (germline->seg_method == SEG_METHOD_MAX1U))
273 274 275 276
    { // Pseudo-germline, MAX12 and MAX1U
      pair <KmerAffect, KmerAffect> max12 ;
      CountKmerAffectAnalyser ckaa(*(germline->index), sequence);

277 278 279 280 281

      set<KmerAffect> forbidden;
      forbidden.insert(KmerAffect::getAmbiguous());
      forbidden.insert(KmerAffect::getUnknown());

282
      if (germline->seg_method == SEG_METHOD_MAX12)
283 284 285
        // MAX12: two maximum k-mers (no unknown)
        {
          max12 = ckaa.max12(forbidden);
286

287 288 289 290 291 292
          if (max12.first.isUnknown() || max12.second.isUnknown())
            {
              because = UNSEG_TOO_FEW_ZERO ;
              return ;
            }
        }
293

294 295
      else
        // MAX1U: the maximum k-mers (no unknown) + unknown
296
        {
297 298 299 300 301 302 303 304 305
          CountKmerAffectAnalyser ckaa(*(germline->index), sequence);
          KmerAffect max = ckaa.max(forbidden);

          if (max.isUnknown())
            {
              because = UNSEG_TOO_FEW_ZERO ;
              return ;
            }
          max12 = make_pair(max, KmerAffect::getUnknown());
306 307
        }

308 309 310 311 312
      pair <KmerAffect, KmerAffect> before_after =  ckaa.sortLeftRight(max12);

      before = before_after.first ;
      after = before_after.second ;

313 314 315
      // This strand computation is only a heuristic, especially for chimera +/- reads
      // Anyway, it allows to gather such reads and their reverse complement into a unique window...
      // ... except when the read is quite different outside the window
316
      strand = reversed ? -1 : 1 ;
317 318 319 320 321
    }

  else
    { // Regular germline

322
  // Test on which strand we are, select the before and after KmerAffects
Mikaël Salson's avatar
Mikaël Salson committed
323
  if (nb_strand[0] == 0 && nb_strand[1] == 0) {
324
    because = UNSEG_TOO_FEW_ZERO ;
325
    return ;
Mikaël Salson's avatar
Mikaël Salson committed
326 327
  } else if (nb_strand[0] > RATIO_STRAND * nb_strand[1]) {
    strand = -1;
328 329
    before = KmerAffect(germline->affect_3, -1); 
    after = KmerAffect(germline->affect_5, -1);
Mikaël Salson's avatar
Mikaël Salson committed
330 331
  } else if (nb_strand[1] > RATIO_STRAND * nb_strand[0]) {
    strand = 1;
332 333
    before = KmerAffect(germline->affect_5, 1); 
    after = KmerAffect(germline->affect_3, 1);    
Mikaël Salson's avatar
Mikaël Salson committed
334 335
  } else {
    // Ambiguous information: we have positive and negative strands
336 337 338 339 340
    // and there is not enough difference to put them apart.
    if (nb_strand[0] + nb_strand[1] >= DETECT_THRESHOLD_STRAND)
      because = UNSEG_STRAND_NOT_CONSISTENT ;
    else
      because = UNSEG_TOO_FEW_ZERO ;
341
    return ;
Mikaël Salson's avatar
Mikaël Salson committed
342 343
  }

344
    } // endif Pseudo-germline
345
 
346
  computeSegmentation(strand, before, after, threshold, multiplier);
Mathieu Giraud's avatar
Mathieu Giraud committed
347
}
Mikaël Salson's avatar
Mikaël Salson committed
348

Mathieu Giraud's avatar
Mathieu Giraud committed
349
KmerSegmenter::~KmerSegmenter() {
350 351
  if (kaa)
    delete kaa;
352 353
}

354 355
KmerMultiSegmenter::KmerMultiSegmenter(Sequence seq, MultiGermline *multigermline, ostream *out_unsegmented,
                                       double threshold, int nb_reads_for_evalue)
356
{
357 358
  bool found_seg = false ; // Found a segmentation
  double best_evalue_seg = NO_LIMIT_VALUE ; // Best evalue, segmented sequences
359
  int best_score_unseg = 0 ; // Best score, unsegmented sequences
360
  the_kseg = NULL;
361
  multi_germline = multigermline;
362
  threshold_nb_expected = threshold;
363 364 365

  // E-value multiplier
  int multiplier = multi_germline->germlines.size() * nb_reads_for_evalue;
366
  
367 368 369 370 371
  // Iterate over the germlines
  for (list<Germline*>::const_iterator it = multigermline->germlines.begin(); it != multigermline->germlines.end(); ++it)
    {
      Germline *germline = *it ;

372
      KmerSegmenter *kseg = new KmerSegmenter(seq, germline, threshold, multiplier);
373
      bool keep_seg = false;
374

375 376 377
      if (out_unsegmented)
        {
          // Debug, display k-mer affectation and segmentation result for this germline
378
          *out_unsegmented << kseg->getInfoLineWithAffects() << endl ;
379 380
        }

381 382
      // Always remember the first kseg
      if (the_kseg == NULL)
383
        keep_seg = true;
384
      
385
      if (kseg->isSegmented())
386 387
        {
          // Yes, it is segmented
388
          // Should we keep the kseg ?
389
          if (!found_seg || (kseg->evalue < best_evalue_seg))
390
            {
391
              keep_seg = true;
392 393 394
              best_evalue_seg = kseg->evalue ;

              found_seg = true;
395
            }
396
        }
397 398 399 400 401 402 403
      else
        {
          // It is not segmented
          // Should we keep the kseg (with the unsegmentation cause) ?
            if (kseg->score > best_score_unseg)
            {              
              best_score_unseg = kseg->score ;
404
              if (!found_seg)
405 406 407 408
                keep_seg = true;
            }
        }
      
409
      if (keep_seg) {
410 411
        if (the_kseg)
          delete the_kseg;
412 413 414 415
        the_kseg = kseg;
      } else {
        delete kseg;
      }
416 417 418
    } // end for (Germlines)
}

419
KmerMultiSegmenter::~KmerMultiSegmenter() {
420 421
  if (the_kseg)
    delete the_kseg;
Mathieu Giraud's avatar
Mathieu Giraud committed
422 423
}

424 425
void KmerSegmenter::computeSegmentation(int strand, KmerAffect before, KmerAffect after,
                                        double threshold, int multiplier) {
426
  // Try to segment, computing 'Vend' and 'Jstart'
427 428
  // If not segmented, put the cause of unsegmentation in 'because'

429
  affect_infos max;
430
  max = kaa->getMaximum(before, after);
Mikaël Salson's avatar
Mikaël Salson committed
431

432 433 434
  // We did not find a good segmentation point
  if (!max.max_found) {
    // We labeled it detected if there were both enough affect_5 and enough affect_3
435 436 437 438 439 440 441 442 443
    bool detected_before = (max.nb_before_left + max.nb_before_right >= DETECT_THRESHOLD);
    bool detected_after = (max.nb_after_left + max.nb_after_right >= DETECT_THRESHOLD);

    if (detected_before && detected_after)
      because = UNSEG_AMBIGUOUS ;
    else if ((strand == 1 && detected_before) || (strand == -1 && detected_after))
      because = UNSEG_TOO_FEW_J ;
    else if ((strand == 1 && detected_after) || (strand == -1 && detected_before))
      because = UNSEG_TOO_FEW_V ;
444
    else
445
      because = UNSEG_TOO_FEW_ZERO ;
446 447 448 449 450

    return ;
  }


451
  // E-values
452 453 454
  pair <double, double> pvalues = kaa->getLeftRightProbabilityAtLeastOrAbove();
  evalue_left = pvalues.first * multiplier ;
  evalue_right = pvalues.second * multiplier ;
455
  evalue = evalue_left + evalue_right ;
456

457
  checkLeftRightEvaluesThreshold(threshold, strand);
458

459
  if (because != NOT_PROCESSED)
460 461
    return ;

462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
   // There was a good segmentation point

   Vend = max.first_pos_max;
   Jstart = max.last_pos_max + 1;
   if (strand == -1) {
     int tmp = sequence.size() - Vend - 1;
     Vend = sequence.size() - Jstart - 1;
     Jstart = tmp;
   }

  // Yes, it is segmented
  segmented = true;
  because = reversed ? SEG_MINUS : SEG_PLUS ;

  info = string_of_int(Vend + FIRST_POS) + " " + string_of_int(Jstart + FIRST_POS)  ;

  // removeChevauchement is called once info was already computed: it is only to output info_extra
  info_extra += removeChevauchement();
  finishSegmentation();

  return ;
Mathieu Giraud's avatar
Mathieu Giraud committed
483
}
Mikaël Salson's avatar
Mikaël Salson committed
484

485
KmerAffectAnalyser *KmerSegmenter::getKmerAffectAnalyser() const {
Mathieu Giraud's avatar
Mathieu Giraud committed
486 487
  return kaa;
}
Mikaël Salson's avatar
Mikaël Salson committed
488

489
int Segmenter::getSegmentationStatus() const {
Mathieu Giraud's avatar
Mathieu Giraud committed
490
  return because;
Mikaël Salson's avatar
Mikaël Salson committed
491 492
}

493 494 495 496 497
void Segmenter::setSegmentationStatus(int status) {
  because = status;
  segmented = (status == SEG_PLUS || status == SEG_MINUS);
}

Mikaël Salson's avatar
Mikaël Salson committed
498 499
// FineSegmenter

500

501
string check_and_resolve_overlap(string seq, int seq_begin, int seq_end,
502
                        string ref_left, string ref_right,
503 504
                        int *pos_seq_left, int *pos_seq_right,
                        int *trim_ref_left, int *trim_ref_right, Cost segment_cost)
Mikaël Salson's avatar
Mikaël Salson committed
505
{
506 507 508 509 510 511 512 513
  // Overlap size
  int overlap = *pos_seq_left - *pos_seq_right + 1;

  if (overlap > 0)
    {
      string seq_left = seq.substr(seq_begin, *pos_seq_left - seq_begin + 1);
      string seq_right = seq.substr(*pos_seq_right, seq_end - *pos_seq_right + 1);

Mikaël Salson's avatar
Mikaël Salson committed
514 515 516 517
      int score_r[overlap+1];
      int score_l[overlap+1];
      
      //LEFT
518
      DynProg dp_l = DynProg(seq_left, ref_left,
Mikaël Salson's avatar
Mikaël Salson committed
519
			   DynProg::Local, segment_cost);
520
      score_l[0] = dp_l.compute();
521

Mikaël Salson's avatar
Mikaël Salson committed
522 523
      
      //RIGHT
524 525 526 527 528
      // reverse right sequence
      ref_right=string(ref_right.rbegin(), ref_right.rend());
      seq_right=string(seq_right.rbegin(), seq_right.rend());


529
      DynProg dp_r = DynProg(seq_right, ref_right,
Mikaël Salson's avatar
Mikaël Salson committed
530
			   DynProg::Local, segment_cost);
531
      score_r[0] = dp_r.compute();
532 533 534 535 536 537 538 539 540



      int trim_l[overlap+1];
      int trim_r[overlap+1];

      for(int i=0; i<=overlap; i++) {
        score_l[i] = i < seq_left.size()  ? dp_l.best_score_on_i(seq_left.size()  - i, trim_l + i) : MINUS_INF ;
        score_r[i] = i < seq_right.size() ? dp_r.best_score_on_i(seq_right.size() - i, trim_r + i) : MINUS_INF ;
Mikaël Salson's avatar
Mikaël Salson committed
541
      }
542

543 544 545 546 547 548

// #define DEBUG_OVERLAP
#ifdef DEBUG_OVERLAP
      cout << dp_l ;
      cout << dp_r ;

549 550
      cout << "seq:" << seq_left << "\t\t" << seq_right << endl;
      cout << "ref:" << ref_left << "\t\t" << ref_right << endl;
551 552 553 554 555 556 557 558
      for(int i=0; i<=overlap; i++)
        cout << i << "  left: " << score_l[i] << "/" << trim_l[i] << "     right: " << score_r[i] << "/" << trim_r[i] << endl;
#endif

      int score = MINUS_INF;
      int best_i = 0 ;
      int best_j = 0 ;

Mikaël Salson's avatar
Mikaël Salson committed
559

560
      // Find (i, j), with i+j >= overlap,
561
      // maximizing score_l[j] + score_r[i]
Mikaël Salson's avatar
Mikaël Salson committed
562 563
      for (int i=0; i<=overlap; i++){
	for (int j=overlap-i; j<=overlap; j++){
564
          int score_ij = score_l[i] + score_r[j];
565

566 567 568 569 570
	  if (score_ij > score) {
            best_i = i ;
            best_j = j ;
            *trim_ref_left  = ref_left.size() - trim_l[i];
	    *trim_ref_right = ref_right.size() - trim_r[j];
571
	    score = score_ij;
Mikaël Salson's avatar
Mikaël Salson committed
572 573 574
	  }
	}
      }
575 576 577 578 579

      *pos_seq_left -= best_i ;
      *pos_seq_right += best_j ;

#ifdef DEBUG_OVERLAP
580 581 582 583
      cout << "overlap: " << overlap << ", " << "best_overlap_split: " << score
           << "    left: " << best_i << "-" << *trim_ref_left << " @" << *pos_seq_right
           << "    right:" << best_j << "-" << *trim_ref_right << " @" << *pos_seq_right
           << endl;
584
#endif
585 586 587 588
    } // end if (overlap > 0)

  // From *pos_seq_left + 1 to *pos_seq_right - 1
  return seq.substr(*pos_seq_left + 1, *pos_seq_right - *pos_seq_left - 1);
Mikaël Salson's avatar
Mikaël Salson committed
589 590
}

Mikaël Salson's avatar
Mikaël Salson committed
591 592 593 594 595
bool comp_pair (pair<int,int> i,pair<int,int> j)
{
  return ( i.first > j.first);
}

596 597 598 599 600

/**
 * Align a read against a collection of sequences, maximizing the alignment 'score'
 * @param read:         the read
 * @param rep:          a collection of reference sequences
601
 * @param reverse_ref:  if true, reverse the reference sequences (VkVk)
602
 * @param reverse_both: if true, reverse both the read and the reference sequences (J segment)
603
 * @param local:        if true, Local alignment (D segment), otherwise LocalEndWithSomeDeletions and onlyBottomTriangle (V and J segments)
604 605 606 607 608 609 610 611 612 613
 * @param segment_cost: the cost used by the dynamic programing
 * @return score:       the maximized score, together with the following values:
 * @return tag:           - the name of the sequence
 * @return del:           - the number of deletions at the end of the reference sequence (or at the start if 'reverse_both')
 * @return del2:          - the number of deletions at the start of the reference sequence (used with 'local')
 * @return begin:         - the start position of the aligned segment in the read
 * @return length:        - the length of the alignmed segment in the read
 * @return best_best_i: ?
 */

614
int align_against_collection(string &read, Fasta &rep, bool reverse_ref, bool reverse_both, bool local, int *tag,
Mikaël Salson's avatar
Mikaël Salson committed
615
			     int *del, int *del2, int *begin, int *length, vector<pair<int, int> > *score
Mikaël Salson's avatar
Mikaël Salson committed
616 617 618 619 620 621 622 623 624 625
			    , Cost segment_cost)
{
  
  int best_score = MINUS_INF ;
  int best_r = MINUS_INF ;
  int best_best_i = (int) string::npos ;
  int best_best_j = (int) string::npos ;
  int best_first_i = (int) string::npos ;
  int best_first_j = (int) string::npos ;
  string best_label = "" ;
Mikaël Salson's avatar
Mikaël Salson committed
626
  vector<pair<int, int> > score_r;
Mikaël Salson's avatar
Mikaël Salson committed
627 628 629

  DynProg::DynProgMode dpMode = DynProg::LocalEndWithSomeDeletions;
  if (local==true) dpMode = DynProg::Local;
630 631 632

  // With reverse_ref, the read is reversed to prevent calling revcomp on each reference sequence
  string sequence_or_rc = revcomp(read, reverse_ref);
Mikaël Salson's avatar
Mikaël Salson committed
633 634 635
  
  for (int r = 0 ; r < rep.size() ; r++)
    {
636
      DynProg dp = DynProg(sequence_or_rc, rep.sequence(r),
Mikaël Salson's avatar
Mikaël Salson committed
637 638 639
			   dpMode, // DynProg::SemiGlobalTrans, 
			   segment_cost, // DNA
			   reverse_both, reverse_both);
640 641 642

      bool onlyBottomTriangle = !local ;
      int score = dp.compute(onlyBottomTriangle, BOTTOM_TRIANGLE_SHIFT);
Mikaël Salson's avatar
Mikaël Salson committed
643
      
Mikaël Salson's avatar
Mikaël Salson committed
644 645 646 647 648 649 650 651 652 653 654 655 656 657
      if (local==true){ 
	dp.backtrack();
      }
      
      if (score > best_score)
	{
	  best_score = score ;
	  best_best_i = dp.best_i ;
	  best_best_j = dp.best_j ;
	  best_first_i = dp.first_i ;
	  best_first_j = dp.first_j ;
	  best_r = r ;
	  best_label = rep.label(r) ;
	}
Mikaël Salson's avatar
Mikaël Salson committed
658 659
	
	score_r.push_back(make_pair(score, r));
Mathieu Giraud's avatar
Mathieu Giraud committed
660 661 662 663 664 665

	// #define DEBUG_SEGMENT      

#ifdef DEBUG_SEGMENT	
	cout << rep.label(r) << " " << score << " " << dp.best_i << endl ;
#endif
Mikaël Salson's avatar
Mikaël Salson committed
666 667

    }
Mikaël Salson's avatar
Mikaël Salson committed
668
    sort(score_r.begin(),score_r.end(),comp_pair);
Mikaël Salson's avatar
Mikaël Salson committed
669 670 671 672

  *del = reverse_both ? best_best_j : rep.sequence(best_r).size() - best_best_j - 1;
  *del2 = best_first_j;
  *begin = best_first_i;
Mathieu Giraud's avatar
Mathieu Giraud committed
673
  *tag = best_r ; 
Mikaël Salson's avatar
Mikaël Salson committed
674 675
  
  *length -= *del ;
Mikaël Salson's avatar
Mikaël Salson committed
676 677
  
  *score=score_r;
Mathieu Giraud's avatar
Mathieu Giraud committed
678 679 680 681 682 683

#ifdef DEBUG_SEGMENT	
  cout << "best: " << best_labels << " " << best_score ;
  cout << "del/del2/begin:" << (*del) << "/" << (*del2) << "/" << (*begin) << endl;
  cout << endl;
#endif
684 685 686 687

  if (reverse_ref)
    // Why -1 here and +1 in dynprog.cpp /// best_i = m - best_i + 1 ;
    best_best_i = read.length() - best_best_i - 1 ;
Mikaël Salson's avatar
Mikaël Salson committed
688 689 690 691 692 693 694 695 696
  
  return best_best_i ;
}

string format_del(int deletions)
{
  return deletions ? *"(" + string_of_int(deletions) + " del)" : "" ;
}

697
FineSegmenter::FineSegmenter(Sequence seq, Germline *germline, Cost segment_c,  double threshold, int multiplier)
Mikaël Salson's avatar
Mikaël Salson committed
698
{
699 700
  segmented = false;
  dSegmented = false;
701
  because = NOT_PROCESSED ;
702
  segmented_germline = germline ;
703
  info_extra = "" ;
Mikaël Salson's avatar
Mikaël Salson committed
704 705
  label = seq.label ;
  sequence = seq.sequence ;
Mathieu Giraud's avatar
Mathieu Giraud committed
706
  Dend=0;
Mikaël Salson's avatar
Mikaël Salson committed
707
  segment_cost=segment_c;
708
  evalue = NO_LIMIT_VALUE;
709 710
  evalue_left = NO_LIMIT_VALUE;
  evalue_right = NO_LIMIT_VALUE;
Mikaël Salson's avatar
Mikaël Salson committed
711

712 713
  CDR3start = -1;
  CDR3end = -1;
714

715 716 717
  bool reverse_V = false ;
  bool reverse_J = false ;

718
  if ((germline->seg_method == SEG_METHOD_MAX12) || (germline->seg_method == SEG_METHOD_MAX1U))
719
    {
720
      // We check whether this sequence is segmented with MAX12 or MAX1U (with default e-value parameters)
721
      KmerSegmenter *kseg = new KmerSegmenter(seq, germline, THRESHOLD_NB_EXPECTED, 1);
722
      if (kseg->isSegmented())
723
        {
724 725 726 727 728
          reversed = kseg->isReverse();

          KmerAffect left = reversed ? KmerAffect(kseg->after, true) : kseg->before ;
          KmerAffect right = reversed ? KmerAffect(kseg->before, true) : kseg->after ;

729 730
          delete kseg ;

731 732 733
          reverse_V = (left.getStrand() == -1);
          reverse_J = (right.getStrand() == -1);

734
          code = "Unexpected ";
735

736 737 738 739
          code += left.toStringSigns() + germline->index->getLabel(left).name;
          code += "/";
          code += right.toStringSigns() + germline->index->getLabel(right).name;
          info_extra += " " + left.toString() + "/" + right.toString() + " (" + code + ")";
740 741 742 743 744

          if (germline->seg_method == SEG_METHOD_MAX1U)
            return ;

          germline->override_rep5_rep3_from_labels(left, right);
745
        }
746
      else
747 748 749 750
        {
          delete kseg ;
          return ;
        }
751
    }
752

753 754 755 756 757 758 759
  // Strand determination, with KmerSegmenter (with default e-value parameters)
  // Note that we use only the 'strand' component
  // When the KmerSegmenter fails, continue with positive strand
  // TODO: flag to force a strand / to test both strands ?

  KmerSegmenter *kseg = new KmerSegmenter(seq, germline, THRESHOLD_NB_EXPECTED, 1);
  reversed = kseg->isReverse();
760
  delete kseg ;
Mikaël Salson's avatar
Mikaël Salson committed
761
  
762 763
  string sequence_or_rc = revcomp(sequence, reversed); // sequence, possibly reversed

Mathieu Giraud's avatar
Mathieu Giraud committed
764 765

  /* Segmentation */
Mikaël Salson's avatar
Mikaël Salson committed
766 767 768
  int plus_length = 0 ;
  int del2=0;
  int beg=0;
Mikaël Salson's avatar
Mikaël Salson committed
769
  
770 771
  Vend = align_against_collection(sequence_or_rc, germline->rep_5, reverse_V, reverse_V, false,
                                  &best_V, &del_V, &del2, &beg,
Mathieu Giraud's avatar
Mathieu Giraud committed
772
					   &plus_length, &score_V
Mikaël Salson's avatar
Mikaël Salson committed
773
					   , segment_cost);
774 775 776

  Jstart = align_against_collection(sequence_or_rc, germline->rep_3, reverse_J, !reverse_J, false,
                                    &best_J, &del_J, &del2, &beg,
Mathieu Giraud's avatar
Mathieu Giraud committed
777
					    &plus_length, &score_J
Mikaël Salson's avatar
Mikaël Salson committed
778
					    , segment_cost);
Mathieu Giraud's avatar
Mathieu Giraud committed
779
  plus_length += Jstart - Vend ;
Mikaël Salson's avatar
Mikaël Salson committed
780

781
  /* E-values */
Mathieu Giraud's avatar
Mathieu Giraud committed
782 783
  evalue_left  = multiplier * sequence.size() * germline->rep_5.totalSize() * segment_cost.toPValue(score_V[0].first);
  evalue_right = multiplier * sequence.size() * germline->rep_3.totalSize() * segment_cost.toPValue(score_J[0].first);
784
  evalue = evalue_left + evalue_right ;
785 786 787 788

  /* Unsegmentation causes */
  if (Vend == (int) string::npos)
    {
789
      evalue_left = BAD_EVALUE ;
790
    }
791
      
792 793
  if (Jstart == (int) string::npos)
    {
794
      evalue_right = BAD_EVALUE ;
795 796
    }

797 798
  checkLeftRightEvaluesThreshold(threshold, reversed ? -1 : 1);

799 800 801 802
  if (because != NOT_PROCESSED)
    {
      segmented = false;
      info = " @" + string_of_int (Vend + FIRST_POS) + "  @" + string_of_int(Jstart + FIRST_POS) ;
Mikaël Salson's avatar
Mikaël Salson committed
803 804
      return ;
    }
805 806 807 808

  /* The sequence is segmented */
  segmented = true ;
  because = reversed ? SEG_MINUS : SEG_PLUS ;
809

Mikaël Salson's avatar
Mikaël Salson committed
810
    //overlap VJ
811
  seg_N = check_and_resolve_overlap(sequence_or_rc, 0, sequence_or_rc.length(),
812
                         germline->rep_5.sequence(best_V), germline->rep_3.sequence(best_J),
813 814
                         &Vend, &Jstart, &del_V, &del_J, segment_cost);

815
  // Why could this happen ?
816
      if (Jstart>=(int) sequence.length())
Mathieu Giraud's avatar
Mathieu Giraud committed
817
	  Jstart=sequence.length()-1;
Mikaël Salson's avatar
Mikaël Salson committed
818

819
  // seg_N will be recomputed in finishSegmentation()
Mikaël Salson's avatar
Mikaël Salson committed
820

821
  code = germline->rep_5.label(best_V) +
Mikaël Salson's avatar
Mikaël Salson committed
822 823 824 825
    " "+ string_of_int(del_V) + 
    "/" + seg_N + 
    // chevauchement +
    "/" + string_of_int(del_J) +
826
    " " + germline->rep_3.label(best_J); 
Mikaël Salson's avatar
Mikaël Salson committed
827

Mathieu Giraud's avatar
Mathieu Giraud committed
828
  info = string_of_int(Vend + FIRST_POS) + " " + string_of_int(Jstart + FIRST_POS) ;
Mikaël Salson's avatar
Mikaël Salson committed
829 830 831
  finishSegmentation();
}

832 833 834 835 836
bool FineSegmenter::FineSegmentD(Germline *germline,
                                 string seq_Y, int *Yend, int *del_Y,
                                 int *del_DD_left, int *DD_start, int *best_DD, int *DD_end, int *del_DD_right,
                                 int *del_Z, int *Zstart, string seq_Z,
                                 double evalue_threshold, int multiplier){
Mikaël Salson's avatar
Mikaël Salson committed
837 838 839 840 841
    int end = (int) string::npos ;
    int length = 0 ;
    int begin = 0;
    
    // Create a zone where to look for D, adding at most EXTEND_D_ZONE nucleotides at each side
842
    int l = *Yend - EXTEND_D_ZONE;
Mikaël Salson's avatar
Mikaël Salson committed
843 844 845
    if (l<0) 
      l=0 ;

846
    int r = *Zstart + EXTEND_D_ZONE;
Mikaël Salson's avatar
Mikaël Salson committed
847

848 849 850 851
    string seq = getSequence().sequence; // segmented sequence, possibly rev-comped

    if (r > (int) seq.length())
      r = seq.length();
Mikaël Salson's avatar
Mikaël Salson committed
852
      
853
    string str = seq.substr(l, r-l);
Mikaël Salson's avatar
Mikaël Salson committed
854 855

    // Align
856
    end = align_against_collection(str, germline->rep_4, false, false, true,
857
                                   best_DD, del_DD_right, del_DD_left, &begin,
Mikaël Salson's avatar
Mikaël Salson committed
858
				&length, &score_D, segment_cost);
859 860 861

    *DD_start = l + begin;
    *DD_end = l + end;
Mikaël Salson's avatar
Mikaël Salson committed
862
	
863
    float evalue_D = multiplier * (r-l) * germline->rep_4.totalSize() * segment_cost.toPValue(score_D[0].first);
864

865
    if (evalue_D > evalue_threshold)
866
      return false;
Mikaël Salson's avatar
Mikaël Salson committed
867 868
    
    //overlap VD
869 870 871
    seg_N1 = check_and_resolve_overlap(seq, 0, *DD_end,
                         seq_Y, germline->rep_4.sequence(*best_DD),
                         Yend, DD_start, del_Y, del_DD_left, segment_cost);
Mikaël Salson's avatar
Mikaël Salson committed
872 873
    
    //overlap DJ
874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892
    seg_N2 = check_and_resolve_overlap(seq, *DD_start, seq.length(),
                         germline->rep_4.sequence(*best_DD), seq_Z,
                         DD_end, Zstart, del_DD_right, del_Z, segment_cost);

    return true;
}

void FineSegmenter::FineSegmentD(Germline *germline, double evalue_threshold, int multiplier){

  if (segmented){

    dSegmented = FineSegmentD(germline,
                              germline->rep_5.sequence(best_V), &Vend, &del_V,
                              &del_D_left, &Dstart, &best_D, &Dend, &del_D_right,
                              &del_J, &Jstart, germline->rep_3.sequence(best_J),
                              evalue_threshold, multiplier);

    if (!dSegmented)
      return ;
893

894
    code = germline->rep_5.label(best_V) +
Mikaël Salson's avatar
Mikaël Salson committed
895 896 897 898
    " "+ string_of_int(del_V) + 
    "/" + seg_N1 + 
    
    "/" + string_of_int(del_D_left) +
899
    " " + germline->rep_4.label(best_D) +
Mikaël Salson's avatar
Mikaël Salson committed
900 901 902 903
    " " + string_of_int(del_D_right) +
    
    "/" + seg_N2 +
    "/" + string_of_int(del_J) +
904
    " " + germline->rep_3.label(best_J); 
Mikaël Salson's avatar
Mikaël Salson committed
905
    
Mikaël Salson's avatar
Mikaël Salson committed
906 907 908
    finishSegmentationD();
  }
}
Mikaël Salson's avatar
Mikaël Salson committed
909

Marc Duez's avatar
Marc Duez committed
910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928
void FineSegmenter::findCDR3(){
    string str = getSequence().sequence;
    
    list<string> codon_start;
    codon_start.push_back("TGT");
    codon_start.push_back("TGC");
    
    list<string> codon_end;
    codon_end.push_back("TTT");
    codon_end.push_back("TTC");
    codon_end.push_back("TGG");
    
    list<int> p_start;
    list<int> p_end;

    size_t loc;
    std::list<string>::const_iterator it;
    for (it = codon_start.begin(); it != codon_start.end(); ++it) {//filter 1 : start codon must be in V
        loc = 0;
929
        while ( loc != string::npos && loc < (size_t)Vend){
Marc Duez's avatar
Marc Duez committed
930
            loc = str.find(*it, loc+3);
931
            if (loc != string::npos && loc < (size_t)Vend) {
Marc Duez's avatar
Marc Duez committed
932 933 934 935 936 937 938 939 940 941 942 943 944 945 946
                p_start.push_front(loc);
            }
        }
    }

    for (it = codon_end.begin(); it != codon_end.end(); ++it) {//filter 2 : end codon must be in J
        loc = Jstart;
        while ( loc != string::npos){
            loc = str.find(*it, loc+3);
            if (loc != string::npos) {
                p_end.push_back(loc);
            }
        }
    }

947 948
    CDR3start = -1;
    CDR3end = -1;
Marc Duez's avatar
Marc Duez committed
949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967
    
    std::list<int>::const_iterator it1;
    for (it1 = p_start.begin(); it1 != p_start.end(); ++it1) {
        
        std::list<int>::const_iterator it2;
        for (it2 = p_end.begin(); it2 != p_end.end(); ++it2) {
            
            if ( (*it2-*it1)%3 == 0){       //filter 3 : start/stop codon must be seprated by a multiple of 3
                
                if ( fabs((*it2-*it1)-36 ) < fabs((CDR3end-CDR3start)-36) ){ //filter 4 : cdr3 length must be close to 12 AA
                    CDR3start = *it1;
                    CDR3end = *it2;
                }
            }
        }
    }
    
}

Marc Duez's avatar
Marc Duez committed
968 969 970
json FineSegmenter::toJson(){
  json seg;
    
Mathieu Giraud's avatar
Mathieu Giraud committed
971
  if (isSegmented()) {
Marc Duez's avatar
Marc Duez committed
972 973 974
    seg["5"] = segmented_germline->rep_5.label(best_V);
    seg["5start"] = 0;
    seg["5end"] = Vend;
975
    seg["5del"] = del_V;
Mathieu Giraud's avatar
Mathieu Giraud committed
976
    
977
    if (isDSegmented()) {