module documentation

Frame utilities.

Copyright 2017-2025, Voxel51, Inc.

Exception FrameError Exception raised when an invalid frame number is encountered.
Function is_frame_number Determines whether the provided value is a frame number.
Function validate_frame_number Validates that the provided value is a frame number.
def is_frame_number(value): (source)

Determines whether the provided value is a frame number.

Frame numbers are strictly positive integers.

Parameters
valuea value
Returns
True/False
Raises
FrameErrorif value is an integer but is not strictly positive
def validate_frame_number(value): (source)

Validates that the provided value is a frame number.

Frame numbers are strictly positive integers.

Parameters
valuea value
Raises
FrameErrorif value is not a frame number