Class BamIndex
Access to BAM indices.

All Subcl's BaiBamIndex
Defined in <seqan/bam_io.h>
Signature template <typename TSpec> class BamIndex;

Interface Function Overview

Detailed Description

This is an abstract class; don't use it itself but its specializations.

See Also

Interface Functions Detail

uint64_t getUnalignedCount(index);

Query index for number of unaligned reads.

Parameters

index Index to query.

Returns

uint64_t The number of unaligned reads.

Data Races

Thread safety unknown!

bool open(index, filename);

Load a BAM index from a given file name.

Parameters

index Target data structure.
filename Path to file to load. Types: char const *

Returns

bool Returns true on success, false otherwise.

Data Races

Thread safety unknown!

bool save(baiIndex, baiFileName);

Save a BamIndex object.

Parameters

baiIndex The BamIndex to write out.
baiFileName The name of the BAI file to write to.

Returns

bool true on success, false otherwise.

Data Races

Thread safety unknown!