diplomat.utils.extract_frames.unpack_frame_string¶

diplomat.utils.extract_frames.unpack_frame_string(frame_string: bytes, frames_per_iter: int = 0) → Tuple[List[str], TrackingData | Generator[TrackingData, None, None]][source]¶

Unpack a frame store string into a tracking data object for access to the original probability frame data.

Parameters:

frame_string – A bytes object containing the base64 encoded frame store file.
frames_per_iter – Number of frames to return in each TrackingData object generated. If this value is set to 0 or less, this function returns a single TrackingData object storing all frames instead of returning a generator.

Returns:

A tuple containing a list of strings (body parts) and, a single TrackingData object if frames_per_iter <= 0, or a Generator of TrackingData objects if frames_per_iter > 0.