Frames¶
#include <pbbam/Frames.h>
-
class
PacBio::BAM::
Frames
¶ The Frames class represents pulse frame data.
Frame data may be stored in either their raw, 16-bit values or using a lossy, 8-bit compression scheme.
This class is used to store the data and convert between the 2 storage types.
Conversion Methods
-
static Frames
Decode
(const std::vector<uint8_t> &codedData)¶ Constructs a Frames object from encoded (lossy, 8-bit) data.
- Note
- This method should probably not be needed often by client code working with frame data. It exists primarily for (internal) parsing & interpretation of the BAM file contents. The method is available, though, should the conversion operation be needed.
- Return
- Frames object
- Parameters
codedData
: encoded data
-
static std::vector<uint8_t>
Encode
(const std::vector<uint16_t> &frames)¶ Creates encoded, compressed frame data from raw input data.
- Return
- lossy, 8-bit encoded frame data
- Parameters
frames
: raw frame data
-
std::vector<uint8_t>
Encode
() const¶ - Return
- Frame data in (lossy, 8-bit) encoded form.
Access Data
-
std::vector<uint16_t> &
DataRaw
()¶ - Return
- Frame data in expanded (not encoded) form
-
const std::vector<uint16_t> &
Data
() const¶
Comparison Operators
STL Compatbility
-
std::vector<uint16_t>::const_iterator
cbegin
() const¶ - Return
- A const_iterator to the beginning of the sequence.
-
std::vector<uint16_t>::const_iterator
cend
() const¶ - Return
- A const_iterator to the element past the end of the sequence.
-
std::vector<uint16_t>::const_iterator
begin
() const¶ - Return
- A const_iterator to the beginning of the sequence.
-
std::vector<uint16_t>::const_iterator
end
() const¶ - Return
- A const_iterator to the element past the end of the sequence.
-
std::vector<uint16_t>::iterator
begin
()¶ - Return
- An iterator to the beginning of the sequence.
-
std::vector<uint16_t>::iterator
end
()¶ - Return
- An iterator to the element past the end of the sequence.
-
size_t
size
() const¶ - Return
- The number of frame data points.
-
bool
empty
() const¶ - Return
- True if the container is empty, false otherwise.
-
static Frames