1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658
|
package kmer;
import java.io.PrintStream;
import java.util.BitSet;
import dna.AminoAcid;
import jgi.Dedupe;
import shared.PreParser;
import shared.Shared;
import shared.Timer;
import shared.Tools;
import stream.Read;
import structures.IntList;
/**
* @author Brian Bushnell
* @date Mar 5, 2015
*
*/
public class TableReader {
/*--------------------------------------------------------------*/
/*---------------- Initialization ----------------*/
/*--------------------------------------------------------------*/
/**
* Code entrance from the command line.
* @param args Command line arguments
*/
public static void main(String[] args){
{//Preparse block for help, config files, and outstream
PreParser pp=new PreParser(args, null, false);
args=pp.args;
outstream=pp.outstream;
}
Timer t=new Timer();
AbstractKmerTable[] tables=TableLoaderLockFree.makeTables(AbstractKmerTable.ARRAY1D, 12, -1L, false, 1.0);
int k=31;
int mink=0;
int speed=0;
int hdist=0;
int edist=0;
boolean rcomp=true;
boolean maskMiddle=false;
//Create a new Loader instance
TableLoaderLockFree loader=new TableLoaderLockFree(tables, k, mink, speed, hdist, edist, rcomp, maskMiddle);
loader.setRefSkip(0);
loader.hammingDistance2=0;
loader.editDistance2=0;
loader.storeMode(TableLoaderLockFree.SET_IF_NOT_PRESENT);
///And run it
String[] refs=args;
String[] literals=null;
boolean keepNames=false;
boolean useRefNames=false;
long kmers=loader.processData(refs, literals, keepNames, useRefNames, false);
t.stop();
outstream.println("Load Time:\t"+t);
outstream.println("Return: \t"+kmers);
outstream.println("refKmers: \t"+loader.refKmers);
outstream.println("refBases: \t"+loader.refBases);
outstream.println("refReads: \t"+loader.refReads);
int qskip=0;
int qhdist=0;
TableReader tr=new TableReader(k, mink, speed, qskip, qhdist, rcomp, maskMiddle);
//TODO: Stuff...
//Close the print stream if it was redirected
Shared.closeStream(outstream);
}
public TableReader(int k_){
this(k_, 0, 0, 0, 0, true, false);
}
public TableReader(int k_, int mink_, int speed_, int qskip_, int qhdist_, boolean rcomp_, boolean maskMiddle_){
k=k_;
k2=k-1;
mink=mink_;
rcomp=rcomp_;
useShortKmers=(mink>0 && mink<k);
speed=speed_;
qSkip=qskip_;
qHammingDistance=qhdist_;
middleMask=maskMiddle ? ~(3L<<(2*(k/2))) : -1L;
noAccel=(speed<1 && qSkip<2);
accel=!noAccel;
}
/*--------------------------------------------------------------*/
/*---------------- Outer Methods ----------------*/
/*--------------------------------------------------------------*/
/**
* Mask a read to cover matching kmers.
* @param r Read to process
* @param sets Kmer tables
* @return Number of bases masked
*/
public final int kMask(final Read r, final AbstractKmerTable[] sets){
if(r==null){return 0;}
if(verbose){outstream.println("KMasking read "+r.id);}
BitSet bs=markBits(r, sets);
if(verbose){outstream.println("Null bitset.");}
if(bs==null){return 0;}
final byte[] bases=r.bases, quals=r.quality;
final int cardinality=bs.cardinality();
assert(cardinality>0);
//Replace kmer hit zone with the trim symbol
for(int i=0; i<bases.length; i++){
if(bs.get(i)){
if(kmaskLowercase){
bases[i]=(byte)Tools.toLowerCase(bases[i]);
}else{
bases[i]=trimSymbol;
if(quals!=null && trimSymbol=='N'){quals[i]=0;}
}
}
}
return cardinality;
}
/**
* Counts the number of kmer hits for a read.
* @param r Read to process
* @param sets Kmer tables
* @return Number of hits
*/
public final int countKmerHits(final Read r, final AbstractKmerTable[] sets){
if(r==null || r.length()<k){return 0;}
if((skipR1 && r.pairnum()==0) || (skipR2 && r.pairnum()==1)){return 0;}
final byte[] bases=r.bases;
final int minlen=k-1;
final int minlen2=(maskMiddle ? k/2 : k);
final int shift=2*k;
final int shift2=shift-2;
final long mask=(shift>63 ? -1L : ~((-1L)<<shift));
long kmer=0;
long rkmer=0;
int found=0;
int len=0;
final int start=(restrictRight<1 ? 0 : Tools.max(0, bases.length-restrictRight));
final int stop=(restrictLeft<1 ? bases.length : Tools.min(bases.length, restrictLeft));
/* Loop through the bases, maintaining a forward and reverse kmer via bitshifts */
for(int i=start; i<stop; i++){
byte b=bases[i];
long x=AminoAcid.baseToNumber0[b];
long x2=AminoAcid.baseToComplementNumber0[b];
kmer=((kmer<<2)|x)&mask;
rkmer=((rkmer>>>2)|(x2<<shift2))&mask;
if(b=='N' && forbidNs){len=0; rkmer=0;}else{len++;}
if(verbose){outstream.println("Scanning6 i="+i+", kmer="+kmer+", rkmer="+rkmer+", bases="+new String(bases, Tools.max(0, i-k2), Tools.min(i+1, k)));}
if(len>=minlen2 && i>=minlen){
final int id=getValue(kmer, rkmer, k, qHammingDistance, i, sets);
if(verbose){outstream.println("Testing kmer "+kmer+"; id="+id);}
if(id>0){
if(verbose){outstream.println("Found = "+(found+1)+"/"+minHits);}
if(found>=minHits){
return (found=found+1); //Early exit
}
found++;
}
}
}
return found;
}
/**
* Returns the id of the sequence with the most kmer matches to this read, or -1 if none are at least minHits.
* @param r Read to process
* @param sets Kmer tables
* @return id of best match
*/
public final int findBestMatch(final Read r, final AbstractKmerTable[] sets){
idList.size=0;
if(r==null || r.length()<k){return -1;}
if((skipR1 && r.pairnum()==0) || (skipR2 && r.pairnum()==1)){return -1;}
final byte[] bases=r.bases;
final int minlen=k-1;
final int minlen2=(maskMiddle ? k/2 : k);
final int shift=2*k;
final int shift2=shift-2;
final long mask=(shift>63 ? -1L : ~((-1L)<<shift));
long kmer=0;
long rkmer=0;
int len=0;
int found=0;
final int start=(restrictRight<1 ? 0 : Tools.max(0, bases.length-restrictRight));
final int stop=(restrictLeft<1 ? bases.length : Tools.min(bases.length, restrictLeft));
/* Loop through the bases, maintaining a forward and reverse kmer via bitshifts */
for(int i=start; i<stop; i++){
byte b=bases[i];
long x=AminoAcid.baseToNumber0[b];
long x2=AminoAcid.baseToComplementNumber0[b];
kmer=((kmer<<2)|x)&mask;
rkmer=((rkmer>>>2)|(x2<<shift2))&mask;
if(b=='N' && forbidNs){len=0; rkmer=0;}else{len++;}
if(verbose){outstream.println("Scanning6 i="+i+", kmer="+kmer+", rkmer="+rkmer+", bases="+new String(bases, Tools.max(0, i-k2), Tools.min(i+1, k)));}
if(len>=minlen2 && i>=minlen){
final int id=getValue(kmer, rkmer, k, qHammingDistance, i, sets);
if(id>0){
countArray[id]++;
if(countArray[id]==1){idList.add(id);}
found++;
if(verbose){outstream.println("Found = "+found+"/"+minHits);}
}
}
}
final int id, max;
if(found>=minHits){
max=condenseLoose(countArray, idList, countList);
int id0=-1;
for(int i=0; i<countList.size; i++){
if(countList.get(i)==max){
id0=idList.get(i); break;
}
}
id=id0;
}else{
max=0;
id=-1;
}
return id;
}
/**
* Mask a read to cover matching kmers.
* @param r Read to process
* @param sets Kmer tables
* @return Number of bases masked
*/
public final BitSet markBits(final Read r, final AbstractKmerTable[] sets){
if(r==null || r.length()<Tools.max(1, (useShortKmers ? Tools.min(k, mink) : k))){
if(verbose){outstream.println("Read too short.");}
return null;
}
if((skipR1 && r.pairnum()==0) || (skipR2 && r.pairnum()==1)){
if(verbose){outstream.println("Skipping read.");}
return null;
}
if(verbose){outstream.println("Marking bitset for read "+r.id);}
final byte[] bases=r.bases;
final int minlen=k-1;
final int minlen2=(maskMiddle ? k/2 : k);
final int shift=2*k;
final int shift2=shift-2;
final long mask=(shift>63 ? -1L : ~((-1L)<<shift));
long kmer=0;
long rkmer=0;
int found=0;
int len=0;
int id0=-1; //ID of first kmer found.
BitSet bs=new BitSet(bases.length+trimPad+1);
final int minus=k-1-trimPad;
final int plus=trimPad+1;
final int start=(restrictRight<1 ? 0 : Tools.max(0, bases.length-restrictRight));
final int stop=(restrictLeft<1 ? bases.length : Tools.min(bases.length, restrictLeft));
//Scan for normal kmers
for(int i=start; i<stop; i++){
byte b=bases[i];
long x=AminoAcid.baseToNumber0[b];
long x2=AminoAcid.baseToComplementNumber0[b];
kmer=((kmer<<2)|x)&mask;
rkmer=((rkmer>>>2)|(x2<<shift2))&mask;
if(b=='N' && forbidNs){len=0; rkmer=0;}else{len++;}
if(verbose){outstream.println("Scanning3 i="+i+", kmer="+kmer+", rkmer="+rkmer+", len="+len+", bases="+new String(bases, Tools.max(0, i-k2), Tools.min(i+1, k)));}
if(len>=minlen2 && i>=minlen){
final int id=getValue(kmer, rkmer, k, qHammingDistance, i, sets);
if(id>0){
if(id0<0){id0=id;}
if(verbose){
outstream.println("a: Found "+kmer);
outstream.println("Setting "+Tools.max(0, i-minus)+", "+(i+plus));
outstream.println("i="+i+", minus="+minus+", plus="+plus+", trimpad="+trimPad+", k="+k);
}
bs.set(Tools.max(0, i-minus), i+plus);
found++;
}
}
}
//If nothing was found, scan for short kmers.
if(useShortKmers){
assert(!maskMiddle && middleMask==-1) : maskMiddle+", "+middleMask+", k="+", mink="+mink;
//Look for short kmers on left side
{
kmer=0;
rkmer=0;
len=0;
final int lim=Tools.min(k, stop);
for(int i=start; i<lim; i++){
byte b=bases[i];
long x=Dedupe.baseToNumber[b];
long x2=Dedupe.baseToComplementNumber[b];
kmer=((kmer<<2)|x)&mask;
rkmer=rkmer|(x2<<(2*len));
len++;
if(verbose){outstream.println("Scanning4 i="+i+", kmer="+kmer+", rkmer="+rkmer+", bases="+new String(bases, Tools.max(0, i-k2), Tools.min(i+1, k)));}
if(len>=mink){
if(verbose){
outstream.println("Looking for left kmer "+AminoAcid.kmerToString(kmer, len));
outstream.println("Looking for left rkmer "+AminoAcid.kmerToString(rkmer, len));
}
final int id=getValue(kmer, rkmer, len, qHammingDistance2, i, sets);
if(id>0){
if(id0<0){id0=id;}
if(verbose){
outstream.println("b: Found "+kmer);
outstream.println("Setting "+0+", "+(i+plus));
}
bs.set(0, i+plus);
found++;
}
}
}
}
//Look for short kmers on right side
{
kmer=0;
rkmer=0;
len=0;
final int lim=Tools.max(-1, stop-k);
for(int i=stop-1; i>lim; i--){
byte b=bases[i];
long x=Dedupe.baseToNumber[b];
long x2=Dedupe.baseToComplementNumber[b];
kmer=kmer|(x<<(2*len));
rkmer=((rkmer<<2)|x2)&mask;
len++;
if(verbose){outstream.println("Scanning5 i="+i+", kmer="+kmer+", rkmer="+rkmer+", bases="+new String(bases, Tools.max(0, i-k2), Tools.min(i+1, k)));}
if(len>=mink){
if(verbose){
outstream.println("Looking for right kmer "+
AminoAcid.kmerToString(kmer&~lengthMasks[len], len)+"; value="+toValue(kmer, rkmer, lengthMasks[len])+"; kmask="+lengthMasks[len]);
}
final int id=getValue(kmer, rkmer, len, qHammingDistance2, i, sets);
if(id>0){
if(id0<0){id0=id;}
if(verbose){
outstream.println("c: Found "+kmer);
outstream.println("Setting "+Tools.max(0, i-trimPad)+", "+bases.length);
}
bs.set(Tools.max(0, i-trimPad), bases.length);
found++;
}
}
}
}
}
if(verbose){outstream.println("found="+found+", bitset="+bs);}
if(found==0){return null;}
assert(found>0) : "Overflow in 'found' variable.";
int cardinality=bs.cardinality();
assert(cardinality>0);
return bs;
}
/*--------------------------------------------------------------*/
/*---------------- Helper Methods ----------------*/
/*--------------------------------------------------------------*/
/**
* Transforms a kmer into all canonical values for a given Hamming distance.
* Returns the related id stored in the tables.
* @param kmer Forward kmer
* @param rkmer Reverse kmer
* @param len kmer length
* @param qHDist Hamming distance
* @param qPos Position of kmer in query
* @param sets Kmer hash tables
* @return Value stored in table, or -1
*/
public final int getValue(final long kmer, final long rkmer, final int len, final int qHDist, final int qPos, final AbstractKmerTable[] sets){
if(qSkip>1 && (qPos%qSkip!=0)){return -1;}
return qHDist<1 ? getValue(kmer, rkmer, len, sets) : getValue(kmer, rkmer, len, qHDist, sets);
}
/**
* Transforms a kmer into all canonical values for a given Hamming distance.
* Returns the related id stored in the tables.
* @param kmer Forward kmer
* @param rkmer Reverse kmer
* @param len kmer length
* @param qHDist Hamming distance
* @param sets Kmer hash tables
* @return Value stored in table, or -1
*/
public final int getValue(final long kmer, final long rkmer, final int len, final int qHDist, final AbstractKmerTable[] sets){
int id=getValue(kmer, rkmer, len, sets);
if(id<1 && qHDist>0){
final int qHDistMinusOne=qHDist-1;
//Sub
for(int j=0; j<4 && id<1; j++){
for(int i=0; i<len && id<1; i++){
final long temp=(kmer&clearMasks[i])|setMasks[j][i];
if(temp!=kmer){
long rtemp=AminoAcid.reverseComplementBinaryFast(temp, len);
id=getValue(temp, rtemp, len, qHDistMinusOne, sets);
}
}
}
}
return id;
}
/**
* Transforms a kmer into a canonical value stored in the table and search.
* @param kmer Forward kmer
* @param rkmer Reverse kmer
* @param len kmer length
* @param sets Kmer hash tables
* @return Value stored in table
*/
public final int getValue(final long kmer, final long rkmer, final int len, final AbstractKmerTable[] sets){
return getValueWithMask(kmer, rkmer, lengthMasks[len], sets);
}
/**
* Transforms a kmer into a canonical value stored in the table and search.
* @param kmer Forward kmer
* @param rkmer Reverse kmer
* @param lengthMask Bitmask with single '1' set to left of kmer
* @param sets Kmer hash tables
* @return Value stored in table
*/
public final int getValueWithMask(final long kmer, final long rkmer, final long lengthMask, final AbstractKmerTable[] sets){
assert(lengthMask==0 || (kmer<lengthMask && rkmer<lengthMask)) : lengthMask+", "+kmer+", "+rkmer;
// final long max=(rcomp ? Tools.max(kmer, rkmer) : kmer);
// final long key=(max&middleMask)|lengthMask;
final long key=toValue(kmer, rkmer, lengthMask);
if(noAccel || ((key/WAYS)&15)>=speed){
if(verbose){outstream.println("Testing key "+key);}
AbstractKmerTable set=sets[(int)(key%WAYS)];
final int id=set.getValue(key);
return id;
}
return -1;
}
/**
* Transforms a kmer into a canonical value stored in the table. Expected to be inlined.
* @param kmer Forward kmer
* @param rkmer Reverse kmer
* @param lengthMask Bitmask with single '1' set to left of kmer
* @return Canonical value
*/
private final long toValue(long kmer, long rkmer, long lengthMask){
assert(lengthMask==0 || (kmer<lengthMask && rkmer<lengthMask)) : lengthMask+", "+kmer+", "+rkmer;
long value=(rcomp ? Tools.max(kmer, rkmer) : kmer);
return (value&middleMask)|lengthMask;
}
/**
* Pack a list of counts from an array to an IntList.
* @param loose Counter array
* @param packed Unique values
* @param counts Counts of values
* @return Highest observed count
*/
public static int condenseLoose(int[] loose, IntList packed, IntList counts){
counts.size=0;
if(packed.size<1){return 0;}
int max=0;
for(int i=0; i<packed.size; i++){
final int p=packed.get(i);
final int c=loose[p];
counts.add(c);
loose[p]=0;
max=Tools.max(max, c);
}
return max;
}
public final int kmerToWay(final long kmer){
// final int way=(int)((kmer&coreMask)%WAYS);
// return way;
return (int)(kmer%WAYS);
}
/*--------------------------------------------------------------*/
/*---------------- Fields ----------------*/
/*--------------------------------------------------------------*/
/** Has this class encountered errors while processing? */
public boolean errorState=false;
/** Make the middle base in a kmer a wildcard to improve sensitivity */
public final boolean maskMiddle=false;
/** Search for query kmers with up to this many substitutions */
private final int qHammingDistance;
/** Search for short query kmers with up to this many substitutions */
public int qHammingDistance2=-1;
/** Trim this much extra around matched kmers */
public int trimPad=0;
/** If positive, only look for kmer matches in the leftmost X bases */
public int restrictLeft=0;
/** If positive, only look for kmer matches the rightmost X bases */
public int restrictRight=0;
/** Don't allow a read 'N' to match a reference 'A'.
* Reduces sensitivity when hdist>0 or edist>0. Default: false. */
public boolean forbidNs=false;
/** Replace bases covered by matched kmers with this symbol */
public byte trimSymbol='N';
/** Convert masked bases to lowercase */
public boolean kmaskLowercase=false;
/** Don't look for kmers in read 1 */
public boolean skipR1=false;
/** Don't look for kmers in read 2 */
public boolean skipR2=false;
/** A read must contain at least this many kmer hits before being considered a match. Default: 1 */
public int minHits=1;
/*--------------------------------------------------------------*/
/*---------------- Statistics ----------------*/
/*--------------------------------------------------------------*/
// public long storedKmers=0;
/*--------------------------------------------------------------*/
/*---------------- Per-Thread Fields ----------------*/
/*--------------------------------------------------------------*/
public int[] countArray;
private final IntList idList=new IntList();
private final IntList countList=new IntList();
/*--------------------------------------------------------------*/
/*---------------- Final Primitives ----------------*/
/*--------------------------------------------------------------*/
/** Look for reverse-complements as well as forward kmers. Default: true */
private final boolean rcomp;
/** AND bitmask with 0's at the middle base */
private final long middleMask;
/** Normal kmer length */
private final int k;
/** k-1; used in some expressions */
private final int k2;
/** Shortest kmer to use for trimming */
private final int mink;
/** Attempt to match kmers shorter than normal k on read ends when doing kTrimming. */
private final boolean useShortKmers;
/** Fraction of kmers to skip, 0 to 15 out of 16 */
private final int speed;
/** Skip this many kmers when examining the read. Default 1.
* 1 means every kmer is used, 2 means every other, etc. */
private final int qSkip;
/** noAccel is true if speed and qSkip are disabled, accel is the opposite. */
private final boolean noAccel, accel;
/*--------------------------------------------------------------*/
/*---------------- Static Fields ----------------*/
/*--------------------------------------------------------------*/
/** Number of tables (and threads, during loading) */
private static final int WAYS=7; //123
/** Verbose messages */
public static final boolean verbose=false; //123
/** Print messages to this stream */
private static PrintStream outstream=System.err;
/** x&clearMasks[i] will clear base i */
private static final long[] clearMasks;
/** x|setMasks[i][j] will set base i to j */
private static final long[][] setMasks;
/** x&leftMasks[i] will clear all bases to the right of i (exclusive) */
private static final long[] leftMasks;
/** x&rightMasks[i] will clear all bases to the left of i (inclusive) */
private static final long[] rightMasks;
/** x|kMasks[i] will set the bit to the left of the leftmost base */
private static final long[] lengthMasks;
/*--------------------------------------------------------------*/
/*---------------- Static Initializers ----------------*/
/*--------------------------------------------------------------*/
static{
clearMasks=new long[32];
leftMasks=new long[32];
rightMasks=new long[32];
lengthMasks=new long[32];
setMasks=new long[4][32];
for(int i=0; i<32; i++){
clearMasks[i]=~(3L<<(2*i));
}
for(int i=0; i<32; i++){
leftMasks[i]=((-1L)<<(2*i));
}
for(int i=0; i<32; i++){
rightMasks[i]=~((-1L)<<(2*i));
}
for(int i=0; i<32; i++){
lengthMasks[i]=((1L)<<(2*i));
}
for(int i=0; i<32; i++){
for(long j=0; j<4; j++){
setMasks[(int)j][i]=(j<<(2*i));
}
}
}
}
|