User manual
Version: v4.5.2
4. 3D reconstruction related options (e.g. epipolar tolerance);
5. Wireless related options (e.g. marker button status streaming).
Each option has a type (
int32
,
float
or
ftkBuffer
), a read / write status and an optional ‘global’ flag
indicating whether the option is global, in which case it is handled at the library level and must be accessed
by specifying
0uLL
as serial number.
Unless explicitely flagged as ‘permanent’ in the option description, the set values are reset if the connec-
tion to the fusionTrack device is closed (i.e. after a call to
ftkClose
). In any case, a restart of the fusionTrack
device resets all options to their default values.
All options are identified by a unique ID of type
uint32
. The mapping between the option and its
unique ID is not necessarily preserved between releases, hence the option enumerating mechanism (i.e.
the
ftkEnumerateOptions
function) which allows to get the unique ID of each option at runtime (see also
the ‘ListOptions’ software described in Section 8.3).
8.1.1 Library related options
This subsection presents the library related options, which are options not directly linked to a specific device.
Name
Type
Description
Library Version
ftkBuffer
,
read-only,
global
Allows to read the SDK full version string.
Device library version
ftkBuffer
,
read-only,
global
Allows to read the device layer library full version
string.
Data directory
ftkBuffer
,
read/write,
global
Allows to access the path from where the marker
calibration files and AVT software parameters files
are retrieved.
Frame processing wall-
time
int32
,
read / write
Allows to set a walltime on the frame process-
ing. The default value (-1) set no walltime (which
is the legacy behaviour). Any positive number
n
is interpreted as follows: the walltime will be
n
·
100 µs. If a walltime is set, the
ftkGetLastFrame
function can return the
ftkError_FTK_ERR_-
ALGORITHMIC_WALLTIME
if the set value is ex-
ceeded, and the gotten frame will contain no data
but the picture header.
8.1.2 Device related options
This subsection presents the device related options, which tune the behaviour of a specific device. Some
of those are permanent, i.e. are only reset after a reboot of the device.
Name
Type
Description
Picture rejection thresh-
old
int32
,
read / write,
permanent
Allows to set a maximum picture size, above
which pictures won’t be sent by the fusionTrack
device, helping to keep up with the desired la-
tency.
Atracsys / 2020-06-17 / 16:48:00
46 / 113