qtm.settings.processing._3d
Access and modify 3d processing settings.
import qtm
min_trajectory_length = 2
qtm.settings.processing._3d.set_min_trajectory_length("project", min_trajectory_length)
print(qtm.settings.processing._3d.get_min_trajectory_length("project"))
# 2
print(qtm.settings.processing._3d.get_bounding_box("measurement"))
# {'min_x': -10000.0, 'max_x': 10000.0, 'min_y': -10000.0, 'max_y': 10000.0, 'min_z': -10000.0, 'max_z': 10000.0}
qtm.settings.processing._3d.set_settings("project", {"auto_join": True, "auto_limit_ray_length": False, "min_ray_length": 0, "max_ray_length": 1000})
qtm.settings.processing._3d.get_settings("project")
# {'auto_limit_ray_length': False, 'min_ray_length': 0.0, 'max_ray_length': 1000.0, 'auto_join': True, ...}
min_trajectory_length = 2
qtm.settings.processing._3d.set_min_trajectory_length("project", min_trajectory_length)
print(qtm.settings.processing._3d.get_min_trajectory_length("project"))
-- 2
print(qtm.settings.processing._3d.get_bounding_box("measurement"))
-- {min_y = -1000.0, max_x = 20000.0, max_z = 1500.0, min_z = -100.0, max_y = 1000.0, min_x = -2000.0}
qtm.settings.processing._3d.set_settings("project", {auto_join = true, auto_limit_ray_length = false, min_ray_length = 0.0, max_ray_length = 1000.0})
qtm.settings.processing._3d.get_settings("project")
-- {auto_limit_ray_length = false, min_ray_length = 0.0, max_ray_length = 1000.0, auto_join = true, ...}
set min_trajectory_length=2
curl --json "[\"project\", %min_trajectory_length%]" http://localhost:7979/api/scripting/qtm/settings/processing/_3d/set_min_trajectory_length
curl --json "[\"project\"]" http://localhost:7979/api/scripting/qtm/settings/processing/_3d/get_min_trajectory_length
:: 2
curl --json "[\"measurement\"]" http://localhost:7979/api/scripting/qtm/settings/processing/_3d/get_bounding_box
:: {"max_x":20000,"max_y":1000,"max_z":1500,"min_x":-2000,"min_y":-1000,"min_z":-100}
curl --json "[\"project\", {\"auto_join\":true,\"auto_limit_ray_length\":false,\"min_ray_length\":0,\"max_ray_length\":1000}]" http://localhost:7979/api/scripting/qtm/settings/processing/_3d/set_settings/
curl --json "[\"project\"]" http://localhost:7979/api/scripting/qtm/settings/processing/_3d/get_settings/
:: {"auto_join":true,"auto_limit_ray_length":false,"max_ray_length":1000,"min_ray_length":0...}
get_prediction_error
Get the prediction error.
qtm.settings.processing._3d.get_prediction_error(source)
Parameters
source "project"|"measurement"
The settings source.
Returns
float The prediction error (in millimeters).
set_prediction_error
Set the prediction error.
qtm.settings.processing._3d.set_prediction_error(source, error)
Parameters
source "project"|"measurement"
The settings source.
error float
The prediction error (in millimeters).
get_max_residual
Get the maximum residual.
qtm.settings.processing._3d.get_max_residual(source)
Parameters
source "project"|"measurement"
The settings source.
Returns
float The maximum residual (in millimeters).
set_max_residual
Set the maximum residual.
qtm.settings.processing._3d.set_max_residual(source, residual)
Parameters
source "project"|"measurement"
The settings source.
residual float
The maximum residual (in millimeters).
get_min_trajectory_length
Get the minimum trajectory length.
qtm.settings.processing._3d.get_min_trajectory_length(source)
Parameters
source "project"|"measurement"
The settings source.
Returns
integer The minimum trajectory length (in samples).
set_min_trajectory_length
Set the minimum trajectory length.
qtm.settings.processing._3d.set_min_trajectory_length(source, length)
Parameters
source "project"|"measurement"
The settings source.
length integer
The minimum trajectory length (in samples). Must be within the [2, 100] range.
get_min_ray_count
Get the minimum marker ray count.
qtm.settings.processing._3d.get_min_ray_count(source)
Parameters
source "project"|"measurement"
The settings source.
Returns
integer
set_min_ray_count
Set the minimum marker ray count.
qtm.settings.processing._3d.set_min_ray_count(source, count)
Parameters
source "project"|"measurement"
The settings source.
count integer
The minimum ray count. Must be within the [2, 5] range.
get_auto_limit_ray_length
Get whether to automatically calculate ray length limits.
qtm.settings.processing._3d.get_auto_limit_ray_length(source)
Parameters
source "project"|"measurement"
The settings source.
Returns
bool
set_auto_limit_ray_length
Set whether to automatically calculate ray length limits.
qtm.settings.processing._3d.set_auto_limit_ray_length(source, enable)
Parameters
source "project"|"measurement"
The settings source.
enable bool
True if ray length limits should be automatically calculated, otherwise false.
get_min_ray_length
Get the minimum ray length.
qtm.settings.processing._3d.get_min_ray_length(source)
Parameters
source "project"|"measurement"
The settings source.
Returns
float The minimum ray length (in meters).
set_min_ray_length
Set the minimum ray length.
qtm.settings.processing._3d.set_min_ray_length(source, length)
This method requires manual ray length limits (see 'set_auto_limit_ray_length')
Parameters
source "project"|"measurement"
The settings source.
length float
The minimum ray length (in meters).
get_max_ray_length
Get the maximum ray length.
qtm.settings.processing._3d.get_max_ray_length(source)
Parameters
source "project"|"measurement"
The settings source.
Returns
float The maximum ray length (in meters).
set_max_ray_length
Set the maximum ray length.
qtm.settings.processing._3d.set_max_ray_length(source, length)
This method requires manual ray length limits (see 'set_auto_limit_ray_length').
Parameters
source "project"|"measurement"
The settings source.
length float
The maximum ray length (in meters).
get_store_rays
Get whether to store rays.
qtm.settings.processing._3d.get_store_rays(source)
Parameters
source "project"|"measurement"
The settings source.
Returns
bool
set_store_rays
Set whether to store rays.
qtm.settings.processing._3d.set_store_rays(source, enable)
Parameters
source "project"|"measurement"
The settings source.
enable bool
True if rays should be stored, otherwise false.
get_auto_join
Get whether to automatically join trajectories.
qtm.settings.processing._3d.get_auto_join(source)
Parameters
source "project"|"measurement"
The settings source.
Returns
bool
set_auto_join
Set whether to automatically join trajectories.
qtm.settings.processing._3d.set_auto_join(source, enable)
Parameters
source "project"|"measurement"
The settings source.
enable bool
True if trajectories should be automatically joined, otherwise false.
get_max_auto_join_gap_length
Get the maximum gap length for automatically joining trajectories.
qtm.settings.processing._3d.get_max_auto_join_gap_length(source)
Parameters
source "project"|"measurement"
The settings source.
Returns
integer The maximum gap length (in samples).
set_max_auto_join_gap_length
Set the maximum gap length for automatically joining trajectories.
qtm.settings.processing._3d.set_max_auto_join_gap_length(source, length)
This method requires automatic joining of trajectories to be enabled (see 'set_auto_join').
Parameters
source "project"|"measurement"
The settings source.
length integer
The maximum gap length (in samples).
get_use_bounding_box
Get whether to use a bounding box.
qtm.settings.processing._3d.get_use_bounding_box(source)
Parameters
source "project"|"measurement"
The settings source.
Returns
bool
set_use_bounding_box
Set whether to use a bounding box.
qtm.settings.processing._3d.set_use_bounding_box(source, enable)
Parameters
source "project"|"measurement"
The settings source.
enable bool
True if a bounding box should be used, otherwise false.
get_bounding_box
Get the bounding box.
qtm.settings.processing._3d.get_bounding_box(source)
Parameters
source "project"|"measurement"
The settings source.
Returns
{"min_x": float, "max_x": float, "min_y": float, "max_y": float, "min_z": float, "max_z": float} The bounding box (in millimeters).
set_bounding_box
Set the bounding box.
qtm.settings.processing._3d.set_bounding_box(source, box)
This method requires bounding box to be enabled (see 'set_use_bounding_box').
Parameters
source "project"|"measurement"
The settings source.
box {"min_x": float, "max_x": float, "min_y": float, "max_y": float, "min_z": float, "max_z": float}
The bounding box (in millimeters).
get_auto_select_range
Get whether to automatically set the selected range after tracking.
qtm.settings.processing._3d.get_auto_select_range(source)
Parameters
source "project"|"measurement"
The settings source.
Returns
bool
set_auto_select_range
Set whether to automatically set the selected range after tracking.
qtm.settings.processing._3d.set_auto_select_range(source, enable)
If enabled, the selected range will be set to the tracked range.
Parameters
source "project"|"measurement"
The settings source.
enable bool
True if selected range should be automatically set, otherwise false.
get_settings
Get all settings.
qtm.settings.processing._3d.get_settings(source)
Parameters
source "project"|"measurement"
The settings source.
Returns
{"prediction_error": float?, "max_residual": float?, "min_trajectory_length": integer?, "min_ray_count": integer?, "auto_limit_ray_length": bool?, "min_ray_length": float?, "max_ray_length": float?, "store_rays": bool?, "auto_join": bool?, "max_auto_join_gap_length": integer?, "use_bounding_box": bool?, "bounding_box": {"min_x": float, "max_x": float, "min_y": float, "max_y": float, "min_z": float, "max_z": float}?, "auto_select_range": bool?}
set_settings
Set some or all settings.
qtm.settings.processing._3d.set_settings(source, settings)
Parameters
source "project"|"measurement"
The settings source.
settings {"prediction_error": float?, "max_residual": float?, "min_trajectory_length": integer?, "min_ray_count": integer?, "auto_limit_ray_length": bool?, "min_ray_length": float?, "max_ray_length": float?, "store_rays": bool?, "auto_join": bool?, "max_auto_join_gap_length": integer?, "use_bounding_box": bool?, "bounding_box": {"min_x": float, "max_x": float, "min_y": float, "max_y": float, "min_z": float, "max_z": float}?, "auto_select_range": bool?}
The settings (if a setting is omitted or null, then it will not be set).
help
Get the documentation for a module or method.
qtm.settings.processing._3d.help(method?)
Parameters
method string?
The name of the method (if null, the documentation for the module will be returned instead).
Returns
string