Class Specialization
BGZF Stream
Reading and writing of BGZF data.

StreamConcept

Stream

BGZF Stream

Stream<Bgzf>
Include Headers
seqan/stream.h
Remarks
Not copy constructable, not assignable.
BGZF is the Block GZip Format which is used as the underlying format for BAM and TABIX. Data is written out compressed with gzip but the uncompressed data is split into blocks with a maximum block size. It is therefore possible to jump to beginnings of blocks in the resulting files, decompress the block and then jump into the block itself.
Specialization of
Stream
Implements
StreamConcept
Functions

atEnd | Determines whether an iterator is at the end position. (Stream)
attachToFile | Attach to already open input / output file.
checkEof | Check that the EOF marker is present in a BGZF(/BAM) file.
close | Closes a file. (Stream)
jumpToOrphans | Seek to orphans block in BAM BGZF stream using an index.
jumpToRegion | Seek in BAM BGZF stream using an index.
open | Opens a file, stream, or persistent string.
size | Gets the file size.

Examples
Stream<Bgzf> stream;
if (!open(stream, "myfile.bam", "r"))
return 1; // error
// ... work
SeqAn - Sequence Analysis Library - www.seqan.de

Page built @2014/10/13 16:13:00