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}
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}
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}
get_prediction_error
Get the prediction error.
Parameters
source
"project"|"measurement"
The settings source.
Returns
float
The prediction error (in millimeters).
set_prediction_error
Set the prediction error.
Parameters
source
"project"|"measurement"
The settings source.
error
float
The prediction error (in millimeters).
get_max_residual
Get the maximum residual.
Parameters
source
"project"|"measurement"
The settings source.
Returns
float
The maximum residual (in millimeters).
set_max_residual
Set the maximum residual.
Parameters
source
"project"|"measurement"
The settings source.
residual
float
The maximum residual (in millimeters).
get_min_trajectory_length
Get the minimum trajectory length.
Parameters
source
"project"|"measurement"
The settings source.
Returns
integer
The minimum trajectory length (in samples).
set_min_trajectory_length
Set the minimum trajectory 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.
Parameters
source
"project"|"measurement"
The settings source.
Returns
integer
set_min_ray_count
Set the minimum marker ray 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.
Parameters
source
"project"|"measurement"
The settings source.
Returns
bool
set_auto_limit_ray_length
Set whether to automatically calculate ray length limits.
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.
Parameters
source
"project"|"measurement"
The settings source.
Returns
float
The minimum ray length (in meters).
set_min_ray_length
Set the minimum ray 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.
Parameters
source
"project"|"measurement"
The settings source.
Returns
float
The maximum ray length (in meters).
set_max_ray_length
Set the maximum ray 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.
Parameters
source
"project"|"measurement"
The settings source.
Returns
bool
set_store_rays
Set whether to store rays.
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.
Parameters
source
"project"|"measurement"
The settings source.
Returns
bool
set_auto_join
Set whether to automatically join trajectories.
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.
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.
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.
Parameters
source
"project"|"measurement"
The settings source.
Returns
bool
set_use_bounding_box
Set whether to use a bounding box.
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.
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.
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_discard_out_of_bounds_intersections
Get whether to discard out-of-bounds ray intersections.
Parameters
source
"project"|"measurement"
The settings source.
Returns
bool
set_discard_out_of_bounds_intersections
Set whether to discard out-of-bounds ray intersections.
This method requires bounding box to be enabled (see 'set_use_bounding_box').
Parameters
source
"project"|"measurement"
The settings source.
enable
bool
True if out-of-bounds ray intersections should be discarded, otherwise false.
get_auto_select_range
Get whether to automatically set the selected range after tracking.
Parameters
source
"project"|"measurement"
The settings source.
Returns
bool
set_auto_select_range
Set whether to automatically set the selected range after tracking.
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.
help
Get the documentation for a module or method.
Parameters
method
string?
The name of the method (if null, the documentation for the module will be returned instead).
Returns
string