FrameConverter#
- class pyCGM2.Utils.utils.FrameConverter(firstFrame: int, lastFrame: int, nppf: int)#
A class for converting frame numbers between point and analog data formats.
- firstFrame#
The first frame number in the dataset.
- Type:
int
- lastFrame#
The last frame number in the dataset.
- Type:
int
- nppf#
Number of analog points per frame.
- Type:
int
- toAnalog(self, pointFrame, reframeToOne)#
Convert a point frame number to an analog frame number.
- toPoint(self, analogFrame, reframeToOne)#
Convert an analog frame number to a point frame number.
- __init__(firstFrame: int, lastFrame: int, nppf: int)#
Initialize the FrameConverter with frame range and conversion factor
Methods
__init__(firstFrame, lastFrame, nppf)Initialize the FrameConverter with frame range and conversion factor
toAnalog(pointFrame[, reframeToOne])Convert a point frame number to an analog frame number.
toPoint(analogFrame[, reframeToOne])Convert an analog frame number to a point frame number.
- toAnalog(pointFrame: int, reframeToOne: bool = False)#
Convert a point frame number to an analog frame number.
- Parameters:
pointFrame (int) – The frame number in point format.
reframeToOne (bool, optional) – If True, reframe to start from one. Defaults to False.
- Returns:
int – The corresponding frame number in analog format.
- toPoint(analogFrame: int, reframeToOne: bool = False)#
Convert an analog frame number to a point frame number.
- Parameters:
analogFrame (int) – The frame number in analog format.
reframeToOne (bool, optional) – If True, reframe to start from one. Defaults to False.
- Returns:
int – The corresponding frame number in point format.