PbiFile

#include <pbbam/PbiFile.h>

enum PacBio::BAM::PbiFile::Section

This enum describes the PBI file sections.

Values:

BASIC = 0x0000

BasicData (required)

MAPPED = 0x0001

MappedData (always optional)

REFERENCE = 0x0002

ReferenceData (always optional)

BARCODE = 0x0004

BarcodeData (always optional)

ALL = BASIC | MAPPED | REFERENCE | BARCODE

Synonym for ‘all sections’.

using PacBio::BAM::PbiFile::Sections = typedef uint16_t

Helper typedef for storing multiple Section flags.

enum PacBio::BAM::PbiFile::VersionEnum

This enum describes the PBI file version.

Values:

Version_3_0_0 = 0x030000

v3.0.0

Version_3_0_1 = 0x030001

v3.0.1

CurrentVersion = Version_3_0_1

Synonym for the current PBI version.

PBBAM_EXPORT void PacBio::BAM::PbiFile::CreateFrom(const BamFile & bamFile, const PbiBuilder::CompressionLevel compressionLevel = PbiBuilder::DefaultCompression, const size_t numThreads = 4)

Builds PBI index data from the supplied BAM file and writes a ”.pbi” file.

Parameters

• bamFile: source BAM file

Exceptions

• std::runtime_error: if index file could not be created