btkSetFirstFrame

Module

BTKAcquisitionModifier

Description#

Sets acquisition's first frame index (and optionally adapt events' frame/time).

Parameters#

h	Handle pointing to a C++ btk::Acquisition object.
ff	Integer with the index of the new first frame.
adaptEvents	Integer used as an option to adapt the events' frame/time.

Returned Values#

Detailed Description#

• btkSetFirstFrame(h, ff) Set acquisition's first frame index.
• btkSetFirstFrame(h, ff, adaptEvents) Adapt also event's frame/time if the option adaptEvents is set to a non-null value.

The event's frame is shifted by the difference between the new first frame and the old one. The event's time is recomputed using the new frame and the current point's frequency.

Notes#

See also#

btkSetAnalogNumber, btkSetAnalogResolution, btkSetAnalogSampleNumberPerFrame, btkSetFrameNumber, btkSetFrequency, btkSetMaxInterpolationGap, btkSetPointNumber