PileupRange

The class for iterating reference bases together with reads overlapping them.

class PileupRange (

R

alias TColumn = PileupColumn

) {

alias Raw = Unqual!(ElementType!R);

alias Eager = EagerBamRead!Raw;

alias Read = PileupRead!Eager;

alias ReadArray = Read[];

alias Column = TColumn!ReadArray;

void add(Raw read);

this(R reads, bool skip_zero_coverage);

Column front();

bool empty();

void popFront();

void initNewReference();

}

Constructors

this this(R reads, bool skip_zero_coverage): Create new pileup iterator from a range of reads.

Members

Aliases

Column alias Column = TColumn!ReadArray: Undocumented in source.
Eager alias Eager = EagerBamRead!Raw: Undocumented in source.
Raw alias Raw = Unqual!(ElementType!R): Undocumented in source.
Read alias Read = PileupRead!Eager: Undocumented in source.
ReadArray alias ReadArray = Read[]: Undocumented in source.

Functions

add void add(Raw read): Undocumented in source. Be warned that the author may not have intended to support it.
empty bool empty(): Whether all reads have been processed.
front Column front(): Returns PileupColumn struct corresponding to the current position.
initNewReference void initNewReference(): Undocumented in source. Be warned that the author may not have intended to support it.
popFront void popFront(): Move to next position on the reference.

Meta

Source

See Implementation

bio std hts bam pileup classes

functions

manifest constants

useMD

structs