segment.cpp 32.1 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

32
#define NO_FORBIDDEN_ID (-1)
33

34 35 36
AlignBox::AlignBox(string _key) {
  key = _key;

37 38 39 40 41 42 43 44 45 46 47 48 49 50
  del_left = 0 ;
  start = 0 ;
  end = 0 ;
  del_right = 0 ;

  ref_nb = 0 ;
  ref = "";
  ref_label = "";
}

string AlignBox::getSequence(string sequence) {
  return sequence.substr(start, end-start+1);
}

51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
void AlignBox::addToJson(json &seg) {

  seg[key] = ref_label;

  if (key == "5")
    {
      seg[key+"end"] = end;
      seg[key+"del"] = del_right;
    }
  else if (key == "3")
    {
      seg[key+"del"] = del_left;
      seg[key+"start"] = start;
    }
  else
    {
      seg[key+"delLeft"] = del_left;
      seg[key+"start"] = start;
      seg[key+"end"] = end;
      seg[key+"delRight"] = del_right;
    }
}
73

74 75 76 77 78 79 80 81 82 83 84
ostream &operator<<(ostream &out, const AlignBox &box)
{
  out << "[/" << box.del_left << " " ;
  out << "@" << box.start << " " ;
  out << box.ref_label << "(" << box.ref_nb << ") " ;
  out << "@" << box.end << " " ;
  out << box.del_right << "/]" ;

  return out ;
}

85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
string codeFromBoxes(vector <AlignBox*> boxes, string sequence)
{
  string code = "";

  int n = boxes.size();

  for (int i=0; i<n; i++) {

    if (i>0) {
      code += " " + string_of_int(boxes[i-1]->del_right) + "/"
        // From box_left->end + 1 to box_right->start - 1
        + sequence.substr(boxes[i-1]->end + 1, boxes[i]->start - boxes[i-1]->end - 1)
        + "/" + string_of_int(boxes[i]->del_left) + " " ;
    }

    code += boxes[i]->ref_label ;
  }

  return code;
}
105

106

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

Mathieu Giraud's avatar
Mathieu Giraud committed
109
Sequence Segmenter::getSequence() const {
Mikaël Salson's avatar
Mikaël Salson committed
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
  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 {
130
  return box_V->end;
Mikaël Salson's avatar
Mikaël Salson committed
131 132 133
}
  
int Segmenter::getRight() const {
134
  return box_J->start;
Mikaël Salson's avatar
Mikaël Salson committed
135 136 137
}

int Segmenter::getLeftD() const {
138
  return box_D->start;
Mikaël Salson's avatar
Mikaël Salson committed
139 140 141
}
  
int Segmenter::getRightD() const {
142
  return box_D->end;
Mikaël Salson's avatar
Mikaël Salson committed
143 144 145 146 147 148 149 150 151 152 153 154 155 156
}

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

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

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

157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175

// 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
176 177 178 179 180 181 182 183
// Chevauchement

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

184
  if (box_V->end >= box_J->start)
Mikaël Salson's avatar
Mikaël Salson committed
185
    {
186 187 188 189
      int middle = (box_V->end + box_J->start) / 2 ;
      chevauchement = " !ov " + string_of_int (box_V->end - box_J->start + 1);
      box_V->end = middle ;
      box_J->start = middle+1 ;
Mikaël Salson's avatar
Mikaël Salson committed
190 191 192 193 194 195 196 197 198 199 200 201 202 203
    }

  return chevauchement ;
}

// Prettyprint


bool Segmenter::finishSegmentation() 
{
  assert(isSegmented());
  
  string seq = getSequence().sequence;
    
204 205 206 207 208
  seg_V = seq.substr(0, box_V->end+1) ;
  seg_N = seq.substr(box_V->end+1, box_J->start-box_V->end-1) ;  // Twice computed for FineSegmenter, but only once in KmerSegmenter !
  seg_J = seq.substr(box_J->start) ;
  box_D->start=0;
  box_D->end=0;
Mikaël Salson's avatar
Mikaël Salson committed
209 210 211 212 213 214 215 216 217 218 219 220 221

  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;

222 223 224 225
  seg_V = seq.substr(0, box_V->end+1) ; // From pos. 0 to box_V->end
  seg_J = seq.substr(box_J->start) ;
  seg_N = seq.substr(box_V->end+1, box_J->start-box_V->end-1) ;  // Twice computed for FineSegmenter, but only once in KmerSegmenter !
  seg_D  = seq.substr(box_D->start, box_D->end-box_D->start+1) ; // From Dstart to Dend
Mikaël Salson's avatar
Mikaël Salson committed
226
  
227 228 229 230
  info = "VDJ \t0 " + string_of_int(box_V->end) +
                " " + string_of_int(box_D->start) +
		" " + string_of_int(box_D->end) +
		" " + string_of_int(box_J->start) +
Mikaël Salson's avatar
Mikaël Salson committed
231 232 233 234 235 236 237 238 239
		" " + string_of_int(seq.size()-1+FIRST_POS) ;
		
  info += "\t" + code ;
  
  info = (reversed ? "- " : "+ ") + info ;

  return true ;
}

240 241
string Segmenter::getInfoLine() const
{
242
  string s = "" ;
243 244 245 246 247

  s += (segmented ? "" : "! ") + info ;
  s += " " + info_extra ;
  s += " " + segmented_germline->code ;
  s += " " + string(segmented_mesg[because]) ;
248 249 250 251

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

252 253 254 255 256
  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);

257 258 259
  return s ;
}

260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
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
276 277
ostream &operator<<(ostream &out, const Segmenter &s)
{
278
  out << ">" << s.label << " " ;
279
  out << s.getInfoLine() << endl;
Mikaël Salson's avatar
Mikaël Salson committed
280 281 282 283 284 285 286 287 288

  if (s.segmented)
    {
      out << s.seg_V << endl ;
      out << s.seg_N << endl ;
      out << s.seg_J << endl ;
    }
  else
    {
289
      out << s.getSequence().sequence << endl ;
Mikaël Salson's avatar
Mikaël Salson committed
290 291 292 293 294 295 296 297
    }

  return out ;
}


// KmerSegmenter (Cheap)

298 299
KmerSegmenter::KmerSegmenter() { kaa = 0 ; }

300
KmerSegmenter::KmerSegmenter(Sequence seq, Germline *germline, double threshold, int multiplier)
Mikaël Salson's avatar
Mikaël Salson committed
301
{
302 303 304 305
  box_V = new AlignBox();
  box_D = new AlignBox();
  box_J = new AlignBox();

Mikaël Salson's avatar
Mikaël Salson committed
306 307 308
  label = seq.label ;
  sequence = seq.sequence ;
  info = "" ;
309
  info_extra = "seed";
Mikaël Salson's avatar
Mikaël Salson committed
310
  segmented = false;
311
  segmented_germline = germline ;
312
  system = germline->code; // useful ?
313
  reversed = false;
314
  because = NOT_PROCESSED ; // Cause of unsegmentation
315
  score = 0 ;
316
  evalue = NO_LIMIT_VALUE;
317 318
  evalue_left = NO_LIMIT_VALUE;
  evalue_right = NO_LIMIT_VALUE;
319

320
  int s = (size_t)germline->index->getS() ;
Mikaël Salson's avatar
Mikaël Salson committed
321
  int length = sequence.length() ;
Mikaël Salson's avatar
Mikaël Salson committed
322

323
  if (length < s) 
Mikaël Salson's avatar
Mikaël Salson committed
324
    {
Mathieu Giraud's avatar
Mathieu Giraud committed
325 326
      because = UNSEG_TOO_SHORT;
      kaa = NULL;
327
      return ;
Mikaël Salson's avatar
Mikaël Salson committed
328 329
    }
 
330
  kaa = new KmerAffectAnalyser(*(germline->index), sequence);
Mikaël Salson's avatar
Mikaël Salson committed
331 332
  
  // Check strand consistency among the affectations.
Mikaël Salson's avatar
Mikaël Salson committed
333 334 335 336 337 338 339 340 341
  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
342 343 344
    }
  }

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

347 348
  reversed = (nb_strand[0] > nb_strand[1]) ;

349 350
  if ((germline->seg_method == SEG_METHOD_MAX12)
      || (germline->seg_method == SEG_METHOD_MAX1U))
351 352 353 354
    { // Pseudo-germline, MAX12 and MAX1U
      pair <KmerAffect, KmerAffect> max12 ;
      CountKmerAffectAnalyser ckaa(*(germline->index), sequence);

355 356 357 358 359

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

360
      if (germline->seg_method == SEG_METHOD_MAX12)
361 362 363
        // MAX12: two maximum k-mers (no unknown)
        {
          max12 = ckaa.max12(forbidden);
364

365 366 367 368 369 370
          if (max12.first.isUnknown() || max12.second.isUnknown())
            {
              because = UNSEG_TOO_FEW_ZERO ;
              return ;
            }
        }
371

372 373
      else
        // MAX1U: the maximum k-mers (no unknown) + unknown
374
        {
375 376 377 378 379 380 381 382 383
          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());
384 385
        }

386 387 388 389 390
      pair <KmerAffect, KmerAffect> before_after =  ckaa.sortLeftRight(max12);

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

391 392 393
      // 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
394
      strand = reversed ? -1 : 1 ;
395 396 397 398 399
    }

  else
    { // Regular germline

400
  // Test on which strand we are, select the before and after KmerAffects
Mikaël Salson's avatar
Mikaël Salson committed
401
  if (nb_strand[0] == 0 && nb_strand[1] == 0) {
402
    because = UNSEG_TOO_FEW_ZERO ;
403
    return ;
Mikaël Salson's avatar
Mikaël Salson committed
404 405
  } else if (nb_strand[0] > RATIO_STRAND * nb_strand[1]) {
    strand = -1;
406 407
    before = KmerAffect(germline->affect_3, -1); 
    after = KmerAffect(germline->affect_5, -1);
Mikaël Salson's avatar
Mikaël Salson committed
408 409
  } else if (nb_strand[1] > RATIO_STRAND * nb_strand[0]) {
    strand = 1;
410 411
    before = KmerAffect(germline->affect_5, 1); 
    after = KmerAffect(germline->affect_3, 1);    
Mikaël Salson's avatar
Mikaël Salson committed
412 413
  } else {
    // Ambiguous information: we have positive and negative strands
414 415 416 417 418
    // 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 ;
419
    return ;
Mikaël Salson's avatar
Mikaël Salson committed
420 421
  }

422
    } // endif Pseudo-germline
423
 
424
  computeSegmentation(strand, before, after, threshold, multiplier);
Mathieu Giraud's avatar
Mathieu Giraud committed
425
}
Mikaël Salson's avatar
Mikaël Salson committed
426

Mathieu Giraud's avatar
Mathieu Giraud committed
427
KmerSegmenter::~KmerSegmenter() {
428 429
  if (kaa)
    delete kaa;
430 431 432 433

  delete box_V;
  delete box_D;
  delete box_J;
434 435
}

436 437
KmerMultiSegmenter::KmerMultiSegmenter(Sequence seq, MultiGermline *multigermline, ostream *out_unsegmented,
                                       double threshold, int nb_reads_for_evalue)
438
{
439 440
  bool found_seg = false ; // Found a segmentation
  double best_evalue_seg = NO_LIMIT_VALUE ; // Best evalue, segmented sequences
441
  int best_score_unseg = 0 ; // Best score, unsegmented sequences
442
  the_kseg = NULL;
443
  multi_germline = multigermline;
444
  threshold_nb_expected = threshold;
445 446 447

  // E-value multiplier
  int multiplier = multi_germline->germlines.size() * nb_reads_for_evalue;
448
  
449 450 451 452 453
  // Iterate over the germlines
  for (list<Germline*>::const_iterator it = multigermline->germlines.begin(); it != multigermline->germlines.end(); ++it)
    {
      Germline *germline = *it ;

454
      KmerSegmenter *kseg = new KmerSegmenter(seq, germline, threshold, multiplier);
455
      bool keep_seg = false;
456

457 458 459
      if (out_unsegmented)
        {
          // Debug, display k-mer affectation and segmentation result for this germline
460
          *out_unsegmented << kseg->getInfoLineWithAffects() << endl ;
461 462
        }

463 464
      // Always remember the first kseg
      if (the_kseg == NULL)
465
        keep_seg = true;
466
      
467
      if (kseg->isSegmented())
468 469
        {
          // Yes, it is segmented
470
          // Should we keep the kseg ?
471
          if (!found_seg || (kseg->evalue < best_evalue_seg))
472
            {
473
              keep_seg = true;
474 475 476
              best_evalue_seg = kseg->evalue ;

              found_seg = true;
477
            }
478
        }
479 480 481 482 483 484 485
      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 ;
486
              if (!found_seg)
487 488 489 490
                keep_seg = true;
            }
        }
      
491
      if (keep_seg) {
492 493
        if (the_kseg)
          delete the_kseg;
494 495 496 497
        the_kseg = kseg;
      } else {
        delete kseg;
      }
498 499 500
    } // end for (Germlines)
}

501
KmerMultiSegmenter::~KmerMultiSegmenter() {
502 503
  if (the_kseg)
    delete the_kseg;
Mathieu Giraud's avatar
Mathieu Giraud committed
504 505
}

506 507
void KmerSegmenter::computeSegmentation(int strand, KmerAffect before, KmerAffect after,
                                        double threshold, int multiplier) {
508
  // Try to segment, computing 'box_V->end' and 'box_J->start'
509 510
  // If not segmented, put the cause of unsegmentation in 'because'

511
  affect_infos max;
512
  max = kaa->getMaximum(before, after);
Mikaël Salson's avatar
Mikaël Salson committed
513

514 515 516
  // 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
517 518 519 520 521 522 523 524 525
    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 ;
526
    else
527
      because = UNSEG_TOO_FEW_ZERO ;
528 529 530 531 532

    return ;
  }


533
  // E-values
534 535 536
  pair <double, double> pvalues = kaa->getLeftRightProbabilityAtLeastOrAbove();
  evalue_left = pvalues.first * multiplier ;
  evalue_right = pvalues.second * multiplier ;
537
  evalue = evalue_left + evalue_right ;
538

539
  checkLeftRightEvaluesThreshold(threshold, strand);
540

541
  if (because != NOT_PROCESSED)
542 543
    return ;

544 545
   // There was a good segmentation point

546 547
   box_V->end = max.first_pos_max;
   box_J->start = max.last_pos_max + 1;
548
   if (strand == -1) {
549 550 551
     int tmp = sequence.size() - box_V->end - 1;
     box_V->end = sequence.size() - box_J->start - 1;
     box_J->start = tmp;
552 553 554 555 556 557
   }

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

558
  info = string_of_int(box_V->end + FIRST_POS) + " " + string_of_int(box_J->start + FIRST_POS)  ;
559 560 561 562 563 564

  // 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
565
}
Mikaël Salson's avatar
Mikaël Salson committed
566

567
KmerAffectAnalyser *KmerSegmenter::getKmerAffectAnalyser() const {
Mathieu Giraud's avatar
Mathieu Giraud committed
568 569
  return kaa;
}
Mikaël Salson's avatar
Mikaël Salson committed
570

571
int Segmenter::getSegmentationStatus() const {
Mathieu Giraud's avatar
Mathieu Giraud committed
572
  return because;
Mikaël Salson's avatar
Mikaël Salson committed
573 574
}

575 576 577 578 579
void Segmenter::setSegmentationStatus(int status) {
  because = status;
  segmented = (status == SEG_PLUS || status == SEG_MINUS);
}

Mikaël Salson's avatar
Mikaël Salson committed
580 581
// FineSegmenter

582

583
string check_and_resolve_overlap(string seq, int seq_begin, int seq_end,
584 585
                                 AlignBox *box_left, AlignBox *box_right,
                                 Cost segment_cost)
Mikaël Salson's avatar
Mikaël Salson committed
586
{
587
  // Overlap size
588
  int overlap = box_left->end - box_right->start + 1;
589 590 591

  if (overlap > 0)
    {
592 593
      string seq_left = seq.substr(seq_begin, box_left->end - seq_begin + 1);
      string seq_right = seq.substr(box_right->start, seq_end - box_right->start + 1);
594

Mikaël Salson's avatar
Mikaël Salson committed
595 596 597 598
      int score_r[overlap+1];
      int score_l[overlap+1];
      
      //LEFT
599
      DynProg dp_l = DynProg(seq_left, box_left->ref,
Mikaël Salson's avatar
Mikaël Salson committed
600
			   DynProg::Local, segment_cost);
601
      score_l[0] = dp_l.compute();
602

Mikaël Salson's avatar
Mikaël Salson committed
603 604
      
      //RIGHT
605
      // reverse right sequence
606
      string ref_right=string(box_right->ref.rbegin(), box_right->ref.rend());
607 608 609
      seq_right=string(seq_right.rbegin(), seq_right.rend());


610
      DynProg dp_r = DynProg(seq_right, ref_right,
Mikaël Salson's avatar
Mikaël Salson committed
611
			   DynProg::Local, segment_cost);
612
      score_r[0] = dp_r.compute();
613 614 615 616 617 618 619 620 621



      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
622
      }
623

624 625 626 627 628 629

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

630 631
      cout << "seq:" << seq_left << "\t\t" << seq_right << endl;
      cout << "ref:" << ref_left << "\t\t" << ref_right << endl;
632 633 634 635 636 637 638 639
      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
640

641
      // Find (i, j), with i+j >= overlap,
642
      // maximizing score_l[j] + score_r[i]
Mikaël Salson's avatar
Mikaël Salson committed
643 644
      for (int i=0; i<=overlap; i++){
	for (int j=overlap-i; j<=overlap; j++){
645
          int score_ij = score_l[i] + score_r[j];
646

647 648 649
	  if (score_ij > score) {
            best_i = i ;
            best_j = j ;
650 651
            box_left->del_right = box_left->ref.size() - trim_l[i];
	    box_right->del_left = box_right->ref.size() - trim_r[j];
652
	    score = score_ij;
Mikaël Salson's avatar
Mikaël Salson committed
653 654 655
	  }
	}
      }
656

657 658
      box_left->end -= best_i ;
      box_right->start += best_j ;
659 660

#ifdef DEBUG_OVERLAP
661
      cout << "overlap: " << overlap << ", " << "best_overlap_split: " << score
662 663
           << "    left: " << best_i << "-" << box_left->del_right << " @" << box_left->end
           << "    right:" << best_j << "-" << box_right->del_left << " @" << box_right->start
664
           << endl;
665
#endif
666 667
    } // end if (overlap > 0)

668 669
  // From box_left->end + 1 to box_right->start - 1
  return seq.substr(box_left->end + 1, box_right->start - box_left->end - 1);
Mikaël Salson's avatar
Mikaël Salson committed
670 671
}

Mikaël Salson's avatar
Mikaël Salson committed
672 673 674 675 676
bool comp_pair (pair<int,int> i,pair<int,int> j)
{
  return ( i.first > j.first);
}

677 678 679 680 681

/**
 * Align a read against a collection of sequences, maximizing the alignment 'score'
 * @param read:         the read
 * @param rep:          a collection of reference sequences
682
 * @param reverse_ref:  if true, reverse the reference sequences (VkVk)
683
 * @param reverse_both: if true, reverse both the read and the reference sequences (J segment)
684
 * @param local:        if true, Local alignment (D segment), otherwise LocalEndWithSomeDeletions and onlyBottomTriangle (V and J segments)
685
 * @param box:          the AligBox to fill
686
 * @param segment_cost: the cost used by the dynamic programing
687
 * @post  box is filled
688 689
 */

690 691
void align_against_collection(string &read, Fasta &rep, int forbidden_rep_id,
                              bool reverse_ref, bool reverse_both, bool local,
692
                             AlignBox *box, Cost segment_cost)
Mikaël Salson's avatar
Mikaël Salson committed
693 694 695
{
  
  int best_score = MINUS_INF ;
696
  box->ref_nb = MINUS_INF ;
Mikaël Salson's avatar
Mikaël Salson committed
697 698 699 700
  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 ;
701

Mikaël Salson's avatar
Mikaël Salson committed
702
  vector<pair<int, int> > score_r;
Mikaël Salson's avatar
Mikaël Salson committed
703 704 705

  DynProg::DynProgMode dpMode = DynProg::LocalEndWithSomeDeletions;
  if (local==true) dpMode = DynProg::Local;
706 707 708

  // 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
709 710 711
  
  for (int r = 0 ; r < rep.size() ; r++)
    {
712 713 714
      if (r == forbidden_rep_id)
        continue;

715
      DynProg dp = DynProg(sequence_or_rc, rep.sequence(r),
Mikaël Salson's avatar
Mikaël Salson committed
716 717 718
			   dpMode, // DynProg::SemiGlobalTrans, 
			   segment_cost, // DNA
			   reverse_both, reverse_both);
719 720 721

      bool onlyBottomTriangle = !local ;
      int score = dp.compute(onlyBottomTriangle, BOTTOM_TRIANGLE_SHIFT);
Mikaël Salson's avatar
Mikaël Salson committed
722
      
Mikaël Salson's avatar
Mikaël Salson committed
723 724 725 726 727 728 729 730 731 732 733
      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 ;
734 735
	  box->ref_nb = r ;
	  box->ref_label = rep.label(r) ;
Mikaël Salson's avatar
Mikaël Salson committed
736
	}
Mikaël Salson's avatar
Mikaël Salson committed
737 738
	
	score_r.push_back(make_pair(score, r));
Mathieu Giraud's avatar
Mathieu Giraud committed
739 740 741 742 743 744

	// #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
745 746

    }
Mikaël Salson's avatar
Mikaël Salson committed
747
    sort(score_r.begin(),score_r.end(),comp_pair);
Mikaël Salson's avatar
Mikaël Salson committed
748

749 750 751 752
  box->ref = rep.sequence(box->ref_nb);
  box->del_right = reverse_both ? best_best_j : box->ref.size() - best_best_j - 1;
  box->del_left = best_first_j;
  box->start = best_first_i;
Mikaël Salson's avatar
Mikaël Salson committed
753
  
754
  box->score = score_r;
Mathieu Giraud's avatar
Mathieu Giraud committed
755 756

#ifdef DEBUG_SEGMENT	
757
  cout << "best: " << box->ref_label << " " << best_score ;
758
  cout << "del/del2/begin:" << (box->del_right) << "/" << (box->del_left) << "/" << (box->start) << endl;
Mathieu Giraud's avatar
Mathieu Giraud committed
759 760
  cout << endl;
#endif
761 762 763 764

  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 ;
765 766

  box->end = best_best_i ;
Mikaël Salson's avatar
Mikaël Salson committed
767 768 769 770 771 772 773
}

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

774
FineSegmenter::FineSegmenter(Sequence seq, Germline *germline, Cost segment_c,  double threshold, int multiplier)
Mikaël Salson's avatar
Mikaël Salson committed
775
{
776 777 778
  box_V = new AlignBox("5");
  box_D = new AlignBox("4");
  box_J = new AlignBox("3");
779

780 781
  segmented = false;
  dSegmented = false;
782
  because = NOT_PROCESSED ;
783
  segmented_germline = germline ;
784
  info_extra = "" ;
Mikaël Salson's avatar
Mikaël Salson committed
785 786 787
  label = seq.label ;
  sequence = seq.sequence ;
  segment_cost=segment_c;
788
  evalue = NO_LIMIT_VALUE;
789 790
  evalue_left = NO_LIMIT_VALUE;
  evalue_right = NO_LIMIT_VALUE;
Mikaël Salson's avatar
Mikaël Salson committed
791

792 793
  CDR3start = -1;
  CDR3end = -1;
794

795 796 797
  bool reverse_V = false ;
  bool reverse_J = false ;

798
  if ((germline->seg_method == SEG_METHOD_MAX12) || (germline->seg_method == SEG_METHOD_MAX1U))
799
    {
800
      // We check whether this sequence is segmented with MAX12 or MAX1U (with default e-value parameters)
801
      KmerSegmenter *kseg = new KmerSegmenter(seq, germline, THRESHOLD_NB_EXPECTED, 1);
802
      if (kseg->isSegmented())
803
        {
804 805 806 807 808
          reversed = kseg->isReverse();

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

809 810
          delete kseg ;

811 812 813
          reverse_V = (left.getStrand() == -1);
          reverse_J = (right.getStrand() == -1);

814
          code = "Unexpected ";
815

816 817 818 819
          code += left.toStringSigns() + germline->index->getLabel(left).name;
          code += "/";
          code += right.toStringSigns() + germline->index->getLabel(right).name;
          info_extra += " " + left.toString() + "/" + right.toString() + " (" + code + ")";
820 821 822 823 824

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

          germline->override_rep5_rep3_from_labels(left, right);
825
        }
826
      else
827 828 829 830
        {
          delete kseg ;
          return ;
        }
831
    }
832

833 834 835 836 837 838 839
  // 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();
840
  delete kseg ;
Mikaël Salson's avatar
Mikaël Salson committed
841
  
842
  sequence_or_rc = revcomp(sequence, reversed); // sequence, possibly reversed
843

Mathieu Giraud's avatar
Mathieu Giraud committed
844 845

  /* Segmentation */
846
  align_against_collection(sequence_or_rc, germline->rep_5, NO_FORBIDDEN_ID, reverse_V, reverse_V, false,
847
                                        box_V, segment_cost);
848

849
  align_against_collection(sequence_or_rc, germline->rep_3, NO_FORBIDDEN_ID, reverse_J, !reverse_J, false,
850
                                          box_J, segment_cost);
851 852 853 854 855

  // J was run with '!reverseJ', we copy the box informations from right to left
  // Should this directly be handled in align_against_collection() ?
  box_J->start = box_J->end ;
  box_J->del_left = box_J->del_right;
856

857
  /* E-values */
858 859
  evalue_left  = multiplier * sequence.size() * germline->rep_5.totalSize() * segment_cost.toPValue(box_V->score[0].first);
  evalue_right = multiplier * sequence.size() * germline->rep_3.totalSize() * segment_cost.toPValue(box_J->score[0].first);
860
  evalue = evalue_left + evalue_right ;
861 862

  /* Unsegmentation causes */
863
  if (box_V->end == (int) string::npos)
864
    {
865
      evalue_left = BAD_EVALUE ;
866
    }
867
      
868
  if (box_J->start == (int) string::npos)
869
    {
870
      evalue_right = BAD_EVALUE ;
871 872
    }

873 874
  checkLeftRightEvaluesThreshold(threshold, reversed ? -1 : 1);

875 876 877
  if (because != NOT_PROCESSED)
    {
      segmented = false;
878
      info = " @" + string_of_int (box_V->end + FIRST_POS) + "  @" + string_of_int(box_J->start + FIRST_POS) ;
Mikaël Salson's avatar
Mikaël Salson committed
879 880
      return ;
    }
881 882 883 884

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

Mikaël Salson's avatar
Mikaël Salson committed
886
    //overlap VJ
887
  seg_N = check_and_resolve_overlap(sequence_or_rc, 0, sequence_or_rc.length(),
888
                                    box_V, box_J, segment_cost);
889

890
  // Why could this happen ?
891 892
      if (box_J->start>=(int) sequence.length())
	  box_J->start=sequence.length()-1;
Mikaël Salson's avatar
Mikaël Salson committed
893

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

896
  boxes.clear();
897 898
  boxes.push_back(box_V);
  boxes.push_back(box_J);
899
  code = codeFromBoxes(boxes, sequence_or_rc);
Mikaël Salson's avatar
Mikaël Salson committed
900

901
  info = string_of_int(box_V->end + FIRST_POS) + " " + string_of_int(box_J->start + FIRST_POS) ;
Mikaël Salson's avatar
Mikaël Salson committed
902 903 904
  finishSegmentation();
}

905
bool FineSegmenter::FineSegmentD(Germline *germline,
906
                                 AlignBox *box_Y, AlignBox *box_DD, AlignBox *box_Z,
907
                                 int forbidden_id,
908
                                 int extend_DD_on_Y, int extend_DD_on_Z,
909
                                 double evalue_threshold, int multiplier){
910

911 912
    // Create a zone where to look for D, adding some nucleotides on both sides
    int l = box_Y->end - extend_DD_on_Y;
Mikaël Salson's avatar
Mikaël Salson committed
913 914 915
    if (l<0) 
      l=0 ;

916
    int r = box_Z->start + extend_DD_on_Z;
Mikaël Salson's avatar
Mikaël Salson committed
917

918 919 920 921
    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
922
      
923
    string str = seq.substr(l, r-l);
Mikaël Salson's avatar
Mikaël Salson committed
924 925

    // Align
926
    align_against_collection(str, germline->rep_4, forbidden_id, false, false, true,
927
                                           box_DD, segment_cost);
928

929 930 931 932
    box_DD->start += l ;
    box_DD->end += l ;

    float evalue_D = multiplier * (r-l) * germline->rep_4.totalSize() * segment_cost.toPValue(box_DD->score[0].first);
933