Class
BamIndexAccess to BAM indices.
Access to BAM indices.
All Subcl's | BaiBamIndex |
---|---|
Defined in | <seqan/bam_io.h> |
Signature |
template <typename TSpec>
class BamIndex;
|
Interface Function Overview
-
uint64_t getUnalignedCount(index);
Query index for number of unaligned reads. -
bool open(index, filename);
Load a BAM index from a given file name. -
bool save(baiIndex, baiFileName);
Save a BamIndex object.
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
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
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
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.
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
If not stated otherwise, concurrent invocation is not guaranteed to be thread-safe.