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
|
package aligner;
import java.io.PrintStream;
import java.util.ArrayList;
import java.util.concurrent.atomic.AtomicInteger;
import java.util.concurrent.locks.ReadWriteLock;
import java.util.concurrent.locks.ReentrantReadWriteLock;
import fileIO.ByteFile;
import fileIO.ByteStreamWriter;
import fileIO.FileFormat;
import fileIO.ReadWrite;
import shared.Parse;
import shared.Parser;
import shared.PreParser;
import shared.Shared;
import shared.Timer;
import shared.Tools;
import sketch.SketchObject;
import stream.ConcurrentReadInputStream;
import stream.FastaReadInputStream;
import stream.Read;
import template.Accumulator;
import template.ThreadWaiter;
import tracker.ReadStats;
/**
* Aligns all sequences to all sequences and produces an identity matrix.
*
* @author Brian Bushnell
* @date January 27, 2020
*
*/
public class AllToAll implements Accumulator<AllToAll.ProcessThread> {
/*--------------------------------------------------------------*/
/*---------------- Initialization ----------------*/
/*--------------------------------------------------------------*/
/**
* Code entrance from the command line.
* @param args Command line arguments
*/
public static void main(String[] args){
//Start a timer immediately upon code entrance.
Timer t=new Timer();
//Create an instance of this class
AllToAll x=new AllToAll(args);
//Run the object
x.process(t);
//Close the print stream if it was redirected
Shared.closeStream(x.outstream);
}
/**
* Constructor.
* @param args Command line arguments
*/
public AllToAll(String[] args){
{//Preparse block for help, config files, and outstream
PreParser pp=new PreParser(args, getClass(), false);
args=pp.args;
outstream=pp.outstream;
}
//Set shared static variables prior to parsing
ReadWrite.USE_PIGZ=ReadWrite.USE_UNPIGZ=true;
ReadWrite.setZipThreads(Shared.threads());
{//Parse the arguments
final Parser parser=parse(args);
Parser.processQuality();
maxReads=parser.maxReads;
overwrite=ReadStats.overwrite=parser.overwrite;
append=ReadStats.append=parser.append;
in1=parser.in1;
qfin1=parser.qfin1;
extin=parser.extin;
out1=parser.out1;
}
validateParams();
fixExtensions(); //Add or remove .gz or .bz2 as needed
checkFileExistence(); //Ensure files can be read and written
checkStatics(); //Adjust file-related static fields as needed for this program
//Create output FileFormat objects
ffout1=FileFormat.testOutput(out1, FileFormat.TXT, null, true, overwrite, append, ordered);
//Create input FileFormat objects
ffin1=FileFormat.testInput(in1, FileFormat.FASTQ, extin, true, true);
}
/*--------------------------------------------------------------*/
/*---------------- Initialization Helpers ----------------*/
/*--------------------------------------------------------------*/
/** Parse arguments from the command line */
private Parser parse(String[] args){
//Create a parser object
Parser parser=new Parser();
parser.out1="stdout.txt";
//Set any necessary Parser defaults here
//parser.foo=bar;
//Parse each argument
for(int i=0; i<args.length; i++){
String arg=args[i];
//Break arguments into their constituent parts, in the form of "a=b"
String[] split=arg.split("=");
String a=split[0].toLowerCase();
String b=split.length>1 ? split[1] : null;
if(b!=null && b.equalsIgnoreCase("null")){b=null;}
if(a.equals("verbose")){
verbose=Parse.parseBoolean(b);
}else if(a.equals("ordered")){
ordered=Parse.parseBoolean(b);
}else if(a.equals("parse_flag_goes_here")){
long fake_variable=Parse.parseKMG(b);
//Set a variable here
}else if(parser.parse(arg, a, b)){//Parse standard flags in the parser
//do nothing
}else{
outstream.println("Unknown parameter "+args[i]);
assert(false) : "Unknown parameter "+args[i];
}
}
return parser;
}
/** Add or remove .gz or .bz2 as needed */
private void fixExtensions(){
in1=Tools.fixExtension(in1);
qfin1=Tools.fixExtension(qfin1);
}
/** Ensure files can be read and written */
private void checkFileExistence(){
//Ensure output files can be written
if(!Tools.testOutputFiles(overwrite, append, false, out1)){
outstream.println((out1==null)+", "+out1);
throw new RuntimeException("\n\noverwrite="+overwrite+"; Can't write to output file "+out1+"\n");
}
//Ensure input files can be read
if(!Tools.testInputFiles(false, true, in1)){
throw new RuntimeException("\nCan't read some input files.\n");
}
//Ensure that no file was specified multiple times
if(!Tools.testForDuplicateFiles(true, in1, out1)){
throw new RuntimeException("\nSome file names were specified multiple times.\n");
}
}
/** Adjust file-related static fields as needed for this program */
private static void checkStatics(){
//Adjust the number of threads for input file reading
if(!ByteFile.FORCE_MODE_BF1 && !ByteFile.FORCE_MODE_BF2 && Shared.threads()>2){
ByteFile.FORCE_MODE_BF2=true;
}
assert(FastaReadInputStream.settingsOK());
}
/** Ensure parameter ranges are within bounds and required parameters are set */
private boolean validateParams(){
//Ensure there is an input file
if(in1==null){throw new RuntimeException("Error - at least one input file is required.");}
return true;
}
/*--------------------------------------------------------------*/
/*---------------- Outer Methods ----------------*/
/*--------------------------------------------------------------*/
/** Create read streams and process all reads */
void process(Timer t){
//Turn off read validation in the input threads to increase speed
final boolean vic=Read.VALIDATE_IN_CONSTRUCTOR;
Read.VALIDATE_IN_CONSTRUCTOR=Shared.threads()<4;
//Reset counters
readsProcessed=alignments=0;
basesProcessed=0;
//Fetch data
reads=ConcurrentReadInputStream.getReads(maxReads, true, ffin1, null, qfin1, null); //TODO: Note that this does not return the error state
results=new float[reads.size()][];
outstream.println("Loaded "+reads.size()+" sequences.");
//Process the reads in separate threads
spawnThreads();
mirrorMatrix(results);
if(verbose){outstream.println("Finished alignment.");}
printResults();
//Reset read validation
Read.VALIDATE_IN_CONSTRUCTOR=vic;
//Report timing and results
t.stop();
outstream.println(Tools.timeReadsBasesProcessed(t, readsProcessed, basesProcessed, 8));
outstream.println(Tools.number("Alignments:", alignments, 8));
//Throw an exception of there was an error in a thread
if(errorState){
throw new RuntimeException(getClass().getName()+" terminated in an error state; the output may be corrupt.");
}
}
private static void mirrorMatrix(float[][] matrix){
for(int i=0; i<matrix.length; i++) {
for(int j=i; j<matrix.length; j++) {
assert(matrix[i][j]==0) : matrix[i][j];
matrix[i][j]=(i==j ? 1 : matrix[j][i]);
}
}
}
private void printResults(){
if(ffout1==null){return;}
ByteStreamWriter bsw=new ByteStreamWriter(ffout1);
bsw.start();
final int max=reads.size();
bsw.print("Name");
for(int rnum=0; rnum<max; rnum++){
bsw.tab().print(reads.get(rnum).id);
}
bsw.println();
for(int qnum=0; qnum<max; qnum++){
bsw.print(reads.get(qnum).id);
final float[] scores=results[qnum];
for(int rnum=0; rnum<max; rnum++){
bsw.tab().print(100*scores[rnum], 2);
}
bsw.println();
}
bsw.poisonAndWait();
}
/*--------------------------------------------------------------*/
/*---------------- Thread Management ----------------*/
/*--------------------------------------------------------------*/
/** Spawn process threads */
private void spawnThreads(){
//Do anything necessary prior to processing
//Determine how many threads may be used
final int threads=Shared.threads();
AtomicInteger atom=new AtomicInteger(0);
//Fill a list with ProcessThreads
ArrayList<ProcessThread> alpt=new ArrayList<ProcessThread>(threads);
for(int i=0; i<threads; i++){
alpt.add(new ProcessThread(reads, results, atom, i));
}
//Start the threads and wait for them to finish
boolean success=ThreadWaiter.startAndWait(alpt, this);
errorState&=!success;
//Do anything necessary after processing
}
@Override
public final void accumulate(ProcessThread pt){
readsProcessed+=pt.readsProcessedT;
basesProcessed+=pt.basesProcessedT;
alignments+=pt.alignmentsT;
errorState|=(!pt.success);
}
@Override
public final boolean success(){return !errorState;}
/*--------------------------------------------------------------*/
/*---------------- Inner Methods ----------------*/
/*--------------------------------------------------------------*/
/*--------------------------------------------------------------*/
/*---------------- Inner Classes ----------------*/
/*--------------------------------------------------------------*/
/** This class is static to prevent accidental writing to shared variables.
* It is safe to remove the static modifier. */
static class ProcessThread extends Thread {
//Constructor
ProcessThread(final ArrayList<Read> reads_, float[][] results_, final AtomicInteger atom_, final int tid_){
reads=reads_;
results=results_;
atom=atom_;
tid=tid_;
}
//Called by start()
@Override
public void run(){
//Do anything necessary prior to processing
//Process the reads
processInner();
//Do anything necessary after processing
//Indicate successful exit status
success=true;
}
/** Iterate through the reads */
void processInner(){
for(int next=atom.getAndIncrement(); next<reads.size(); next=atom.getAndIncrement()){
processQuery(next);
}
}
void processQuery(final int qnum){
final Read query=reads.get(qnum);
final float[] scores=new float[reads.size()];
readsProcessedT++;
basesProcessedT+=query.length();
for(int rnum=0; rnum<qnum; rnum++){
final Read ref=reads.get(rnum);
float identity=SketchObject.align(query.bases, ref.bases);
scores[rnum]=identity;
alignmentsT++;
}
synchronized(results){
results[qnum]=scores;
}
}
/**
* Process a read or a read pair.
* @param r1 Read 1
* @param r2 Read 2 (may be null)
* @return True if the reads should be kept, false if they should be discarded.
*/
boolean processReadPair(final Read r1, final Read r2){
throw new RuntimeException("TODO: Implement this method."); //TODO
// return true;
}
/** Number of reads processed by this thread */
protected long readsProcessedT=0;
/** Number of bases processed by this thread */
protected long basesProcessedT=0;
/** Number of reads retained by this thread */
protected long alignmentsT=0;
/** Number of bases retained by this thread */
protected long basesOutT=0;
/** True only if this thread has completed successfully */
boolean success=false;
/** Thread ID */
final int tid;
final ArrayList<Read> reads;
final float[][] results;
final AtomicInteger atom;
}
/*--------------------------------------------------------------*/
/*---------------- Fields ----------------*/
/*--------------------------------------------------------------*/
/** Primary input file path */
private String in1=null;
private String qfin1=null;
/** Primary output file path */
private String out1=null;
/** Override input file extension */
private String extin=null;
/*--------------------------------------------------------------*/
ArrayList<Read> reads;
float[][] results;
/** Number of reads processed */
protected long readsProcessed=0;
/** Number of bases processed */
protected long basesProcessed=0;
/** Number of reads retained */
protected long alignments=0;
/** Quit after processing this many input reads; -1 means no limit */
private long maxReads=-1;
/*--------------------------------------------------------------*/
/*---------------- Final Fields ----------------*/
/*--------------------------------------------------------------*/
/** Primary input file */
private final FileFormat ffin1;
/** Primary output file */
private final FileFormat ffout1;
@Override
public final ReadWriteLock rwlock() {return rwlock;}
private final ReadWriteLock rwlock=new ReentrantReadWriteLock();
/*--------------------------------------------------------------*/
/*---------------- Common Fields ----------------*/
/*--------------------------------------------------------------*/
/** Print status messages to this output stream */
private PrintStream outstream=System.err;
/** Print verbose messages */
public static boolean verbose=false;
/** True if an error was encountered */
public boolean errorState=false;
/** Overwrite existing output files */
private boolean overwrite=true;
/** Append to existing output files */
private boolean append=false;
/** Reads are output in input order */
private boolean ordered=false;
}
|