AlignedFilter (htsjdk 2.18.2 API)

java.lang.Object
- htsjdk.samtools.filter.AlignedFilter

All Implemented Interfaces:

SamRecordFilter
```
public class AlignedFilter
extends Object
implements SamRecordFilter
```
Filter to either include or exclude aligned reads $Id$

Constructor Summary

Constructors
Constructor Description

AlignedFilter(boolean includeAligned)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`filterOut(SAMRecord record)`	Determines whether a SAMRecord matches this filter
`boolean`	`filterOut(SAMRecord first, SAMRecord second)`	Determines whether a pair of SAMRecord matches this filter

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AlignedFilter
```
public AlignedFilter(boolean includeAligned)
```
- Method Detail
  - filterOut
```
public boolean filterOut(SAMRecord record)
```
    Determines whether a SAMRecord matches this filter
    
    Specified by:
    
    filterOut in interface SamRecordFilter
    
    Parameters:
    
    record - the SAMRecord to evaluate
    
    Returns:
    
    true if the SAMRecord matches the filter, otherwise false
  - filterOut
```
public boolean filterOut(SAMRecord first,
                         SAMRecord second)
```
    Determines whether a pair of SAMRecord matches this filter
    
    Specified by:
    
    filterOut in interface SamRecordFilter
    
    Parameters:
    
    first - the first SAMRecord to evaluate
    
    second - the second SAMRecord to evaluate
    
    Returns:
    
    true if the SAMRecords matches the filter, otherwise false