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
|
package clump;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Comparator;
import bloom.KCountArray;
import dna.AminoAcid;
import jgi.BBMerge;
import shared.Shared;
import shared.Tools;
import sketch.SketchTool;
import stream.Read;
/**
* @author Brian Bushnell
* @date Nov 4, 2015
*
*/
public class KmerComparator implements Comparator<Read> {
public KmerComparator(int k_, boolean addName_, boolean rcomp_){
this(k_, defaultSeed, defaultBorder, defaultHashes, addName_, rcomp_);
}
public KmerComparator(int k_, long seed_, int border_, int hashes_, boolean addName_, boolean rcomp_){
k=k_;
assert(k>0 && k<32);
shift=2*k;
shift2=shift-2;
mask=(shift>63 ? -1L : ~((-1L)<<shift));
seed=seed_;
border=Tools.max(0, border_);
hashes=Tools.mid(0, hashes_, 8);
codes=SketchTool.makeCodes(8, 256, seed_, true);
if(verbose){
System.err.println("Made a comparator with k="+k+", seed="+seed+", border="+border+", hashes="+hashes);
}
addName=addName_;
rcompReads=rcomp_;
}
public void hashThreaded(ArrayList<Read> list, KCountArray table, int minCount){
int threads=Shared.threads();
ArrayList<HashThread> alt=new ArrayList<HashThread>(threads);
for(int i=0; i<threads; i++){alt.add(new HashThread(i, threads, list, table, minCount));}
for(HashThread ht : alt){ht.start();}
/* Wait for threads to die */
for(HashThread ht : alt){
/* Wait for a thread to die */
while(ht.getState()!=Thread.State.TERMINATED){
try {
ht.join();
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}
}
public void hash(ArrayList<Read> list, KCountArray table, int minCount, boolean setObject) {
for(Read r : list){hash(r, table, minCount, setObject);}
}
public long hash(Read r1, KCountArray table, int minCount, boolean setObject){
long x=hash_inner(r1, table, minCount, setObject);
if(Clump.containment && r1.mate!=null){hash_inner(r1.mate, table, minCount, setObject);}
return x;
}
private long hash_inner(Read r1, KCountArray table, int minCount, boolean setObject){
ReadKey key;
if(setObject){
if(r1.obj==null){
key=ReadKey.makeKey(r1, true);
}else{
key=(ReadKey)r1.obj;
key.clear();
}
}else{
key=getLocalKey();
}
assert(key.kmer==key.position && key.position==0);
return fillMax(r1, key, table, minCount);
}
// public void fuse(Read r1){
// Read r2=r1.mate;
// if(r2==null){return;}
// r1.mate=null;
// final int len1=r1.length(), len2=r2.length();
// int len=len1+len2+1;
// byte[] bases=new byte[len];
// for(int i=0; i<len1; i++){bases[i]=r1.bases[i];}
// bases[len1]='N';
// for(int i=0, j=len1+1; i<len2; i++){bases[j]=r2.bases[i];}
// }
/* (non-Javadoc)
* @see java.util.Comparator#compare(java.lang.Object, java.lang.Object)
*/
@Override
public int compare(Read a, Read b) {
final ReadKey keyA, keyB;
if(a.obj==null){
keyA=ReadKey.makeKey(a, true);
fillMax(a, keyA, null, 0);
}else{keyA=(ReadKey)a.obj;}
if(b.obj==null){
keyB=ReadKey.makeKey(b, true);
fillMax(b, keyB, null, 0);
}else{keyB=(ReadKey)b.obj;}
int x=keyA.compareTo(keyB);
if(x==0 && compareSequence){
x=KmerComparator2.compareSequence(a, b, 0);
}
if(x==0){
float ea=a.expectedErrorsIncludingMate(true);
float eb=b.expectedErrorsIncludingMate(true);
if(ea!=eb){return ea>eb ? -1 : 1;}
}
return x==0 ? a.id.compareTo(b.id) : x;
}
/** Finds the global maximum */
public long fillMax(Read r, ReadKey key, KCountArray table, int minCount){
if(mergeFirst && r.pairnum()==0 && r.mate!=null){//This is probably unsafe in multithreaded mode unless the same thread handles both reads.
int x=BBMerge.findOverlapStrict(r, r.mate, false);
if(x>0){
if(r.swapped()==r.mate.swapped()){r.mate.reverseComplement();}
Read merged=r.joinRead(x);
if(r.swapped()==r.mate.swapped()){r.mate.reverseComplement();}
fillMax(merged, key, table, minCount);
if(key.flipped){
r.reverseComplement();
r.setSwapped(true);
}
return key.kmer;
}
}
if(r.length()<k){return fillShort(r, key);}
assert(minCount>0 || table==null) : minCount;
assert(table==null || minCount<=table.maxValue) : minCount;
key.set(0, k-1, false); //TODO: Why is this k-1 rather than 0?
final byte[] bases=r.bases, quals=r.quality;
long kmer=0;
long rkmer=0;
int len=0;
float prob=1;
if(bases==null || bases.length<k){return -1;}
long topCode=Long.MIN_VALUE;
int topCount=-2;
float topProb=0;
final int localBorder=(bases.length>k+4*border ? border : 0);
final int max=bases.length-localBorder;
for(int i=localBorder; i<max; i++){
byte b=bases[i];
long x=AminoAcid.baseToNumber[b];
long x2=AminoAcid.baseToComplementNumber[b];
kmer=((kmer<<2)|x)&mask;
rkmer=((rkmer>>>2)|(x2<<shift2))&mask;
if(minProb>0 && quals!=null){//Update probability
prob=prob*PROB_CORRECT[quals[i]];
if(len>k){
byte oldq=quals[i-k];
prob=prob*PROB_CORRECT_INVERSE[oldq];
}
}
if(x<0){
len=0;
prob=1;
}else{len++;}
if(len>=k){
final long kmax=Tools.max(kmer, rkmer);
final long code=hash(kmax);
boolean accept=false;
int count=0;
if(table!=null){
assert(minCount>=1);
if(code>topCode){
count=table.read(kmax);
accept=(count>=minCount || topCount<minCount);
}else if(topCount<minCount){
count=table.read(kmax);
accept=count>=minCount;
}
}else{
if(code>topCode){
accept=(prob>=minProb || topProb<minProb);
}else{
accept=(prob>=minProb && topProb<minProb);
}
}
if(accept){
topCode=code;
topCount=count;
topProb=minProb;
key.set(kmax, i, (kmax!=kmer));
}
}
}
if(topCode==Long.MIN_VALUE){
return fillShort(r, key);
}
// if(bases.length<k){
// final long kmax=Tools.max(kmer, rkmer);
// key.set(kmax, bases.length-1, (kmax!=kmer));
// }
// assert(minCount<2) : minCount+", "+topCode+", "+topCount;
// assert(minCount>0) : minCount+", "+topCode+", "+topCount;
// if(topCode<0 && minCount>1){//Not needed
// return fillMax(r, kmers, null, 0);
// }
// r.id+=" "+key.position+","+rcomp+","+(bases.length-key.position+k-2);
if(key.kmerMinusStrand && rcompReads){
key.flip(r, k);
}
// if(shortName){//This actually takes a lot of time!
// r.id=r.numericID+" 1:"+(rcomp ? "t" : "f");
// if(r.mate!=null){
// r.mate.id=r.numericID+" 2:f";
// }
// }else
if(addName){r.id+=" "+key;}
assert(key.kmer>=0 && key.position>=0) : key+"\n"+r;
return key.kmer;
}
/* For teaching */
/** Finds the global maximum, forward only */
public long example1(Read r){
//Handle degenerate reads shorter than kmer length
if(r.length()<k){return fillShort(r, null);}
final byte[] bases=r.bases;
long kmer=0;//Stores the current kmer being built and analyzed
int len=0;//Length bases since last N encountered
long topCode=Long.MIN_VALUE;//Maximal hash code encountered
long topKmer=Long.MIN_VALUE;//Kmer for maximal hash code
for(int i=0; i<bases.length; i++){
byte b=bases[i];//The base, A, C, G, T, or N
long x=AminoAcid.baseToNumber[b];//2-bit value, 0, 1, 2, 3, or -1
kmer=((kmer<<2)|x)&mask;//Shift the new 2 bits into the kmer
if(x<0){//If an N is encountered, reset the length
len=0;
}else{len++;}
if(len>=k){//If the kmer is valid and full length, hash it
final long code=hash(kmer);//Some arbitrary hash function
if(code>topCode){//If this is a new maximum, retain it
topKmer=kmer;
topCode=code;
}
}
}
//If for whatever reason it failed (e.g., Ns), use the short method
if(topCode==Long.MIN_VALUE){return fillShort(r, null);}
//Return the pivot kmer.
//It's also useful to store (and return) the position and orientation.
return topKmer;
}
/* For teaching */
/** Finds the global maximum, forward and reverse */
public long example2(Read r){
if(r.length()<k){return fillShort(r, null);}
final byte[] bases=r.bases;
long kmer=0;
long rkmer=0;
int len=0;
if(bases==null || bases.length<k){return -1;}
long topCode=Long.MIN_VALUE;
long topKmer=Long.MIN_VALUE;
for(int i=0; i<bases.length; i++){
byte b=bases[i];
long x=AminoAcid.baseToNumber[b];
long x2=AminoAcid.baseToComplementNumber[b];
kmer=((kmer<<2)|x)&mask;
rkmer=((rkmer>>>2)|(x2<<shift2))&mask;
if(x<0){
len=0;
}else{len++;}
if(len>=k){
final long kmax=Tools.max(kmer, rkmer);
final long code=hash(kmax);
if(code>topCode){
topKmer=kmax;
topCode=code;
}
}
}
if(topCode==Long.MIN_VALUE){
return fillShort(r, null);
}
return topKmer;
}
/* For teaching */
/** Finds the global maximum, forward and reverse, with qualities and border */
public long example3(Read r){
if(r.length()<k){return fillShort(r, null);}
final byte[] bases=r.bases, quals=r.quality;
long kmer=0;
long rkmer=0;
int len=0;
float prob=1;
if(bases==null || bases.length<k){return -1;}
long topCode=Long.MIN_VALUE;
long topKmer=Long.MIN_VALUE;
float topProb=0;
final int localBorder=(bases.length>k+4*border ? border : 0);
final int max=bases.length-localBorder;
for(int i=localBorder; i<max; i++){
byte b=bases[i];
long x=AminoAcid.baseToNumber[b];
long x2=AminoAcid.baseToComplementNumber[b];
kmer=((kmer<<2)|x)&mask;
rkmer=((rkmer>>>2)|(x2<<shift2))&mask;
if(minProb>0 && quals!=null){//Update probability
prob=prob*PROB_CORRECT[quals[i]];
if(len>k){
byte oldq=quals[i-k];
prob=prob*PROB_CORRECT_INVERSE[oldq];
}
}
if(x<0){
len=0;
prob=1;
}else{len++;}
if(len>=k){
final long kmax=Tools.max(kmer, rkmer);
final long code=hash(kmax);
boolean accept=false;
if(code>topCode){
accept=(prob>=minProb || topProb<minProb);
}else{
accept=(prob>=minProb && topProb<minProb);
}
if(accept){
topKmer=kmax;
topCode=code;
topProb=minProb;
}
}
}
if(topCode==Long.MIN_VALUE){
return fillShort(r, null);
}
return topKmer;
}
/** Generates a key when the read is shorter than k */
public long fillShort(Read r, ReadKey key){
final byte[] bases=r.bases;
final int max=Tools.min(bases.length, k);
key.set(0, max-1, false);
long kmer=0;
long rkmer=0;
for(int i=0; i<max; 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;
}
final long kmax=Tools.max(kmer, rkmer);
key.set(kmax, max-1, (kmax!=kmer));
if(key.kmerMinusStrand && rcompReads){
key.flip(r, k);
}
if(addName){r.id+=" "+key;}
return key.kmer;
}
public static synchronized void setHashes(int x){
defaultHashes=Tools.mid(0, x, 8);
}
//TODO: This can be swapped with BBSketch hashing code. Check speed.
public final long hash(long kmer){
long code=kmer;
for(int i=0; i<hashes; i++){//4 only half-hashes; 8 does full hashing
int x=(int)(kmer&0xFF);
kmer>>=8;
code^=codes[i][x];
}
return code&Long.MAX_VALUE;
}
private class HashThread extends Thread{
HashThread(int id_, int threads_, ArrayList<Read> list_, KCountArray table_, int minCount_){
id=id_;
threads=threads_;
list=list_;
table=table_;
minCount=minCount_;
}
@Override
public void run(){
for(int i=id; i<list.size(); i+=threads){
hash(list.get(i), table, minCount, true);
}
}
final int id;
final int threads;
final ArrayList<Read> list;
final KCountArray table;
final int minCount;
}
static ReadKey getLocalKey(){
ReadKey key=localReadKey.get();
if(key==null){
localReadKey.set(key=new ReadKey());
}
key.clear();
return key;
}
public final int k;
final int shift;
final int shift2;
final long mask;
final long seed;
final int border;
final int hashes;
final boolean addName;
final boolean rcompReads;
private final long[][] codes;
static long defaultSeed=1;
static int defaultHashes=4;
static int defaultBorder=1;
public static float minProb=0f;
public static boolean verbose=true;
public static boolean mergeFirst=false;
public static boolean compareSequence=true;
public static ThreadLocal<ReadKey> localReadKey=new ThreadLocal<ReadKey>();
public static final float[] PROB_CORRECT=Arrays.copyOf(align2.QualityTools.PROB_CORRECT, 127);
public static final float[] PROB_CORRECT_INVERSE=Arrays.copyOf(align2.QualityTools.PROB_CORRECT_INVERSE, 127);
}
|