Package picard.illumina.parser.readers

Class FilterFileReader

java.lang.Object
picard.illumina.parser.readers.FilterFileReader
All Implemented Interfaces:
Iterator<Boolean>
public class FilterFileReader extends Object implements Iterator<Boolean>
Illumina uses an algorithm described in "Theory of RTA" that determines whether or not a cluster passes filter("PF") or not. These values are written as sequential bytes to Filter Files. The structure of a filter file is as follows: Bytes 0-3 : 0 Bytes 4-7 : unsigned int version Bytes 8-11 : unsigned int numClusters

  • Field Details

    • EXPECTED_VERSION

      public static final int EXPECTED_VERSION
      Expected Version
      See Also:

    • version

      public final int version
      Version number found in the FilterFile, this should equal 3

    • numClusters

      public final long numClusters
      The number of cluster's pf values stored in this file

  • Constructor Details

    • FilterFileReader

      public FilterFileReader(File file)

  • Method Details