/*
* The MIT License
*
* Copyright (c) 2009 The Broad Institute
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/
package htsjdk.samtools.filter;
import htsjdk.samtools.SAMRecord;
import htsjdk.samtools.util.SequenceUtil;
/**
* Filter to determine whether a read is "noisy" due to a poly-A run that is a sequencing artifact.
* Currently we filter out only reads that are composed entirely of As.
*
* $Id$
*/
public class SolexaNoiseFilter implements SamRecordFilter {
/**
* Determines whether a SAMRecord matches this filter
*
* @param record the SAMRecord to evaluate
* @return true if the SAMRecord matches the filter, otherwise false
*/
public boolean filterOut(final SAMRecord record) {
final byte[] sequence = record.getReadBases();
for (final byte base : sequence) {
if (base != 'A' && base != 'a' &&
!SequenceUtil.isNoCall(base)) {
return false;
}
}
return true;
}
/**
* Determines whether a pair of SAMRecord matches this filter
*
* @param first the first SAMRecord to evaluate
* @param second the second SAMRecord to evaluate
*
* @return true if the SAMRecords matches the filter, otherwise false
*/
public boolean filterOut(final SAMRecord first, final SAMRecord second) {
// only filter out the pair if both first and second reads have all As
return (filterOut(first) && filterOut(second));
}
}