Skip to content

tesseract_robotics.task_composer_planning

Profiles for the planning nodes of the task composer pipelines: contact checks, state-bounds and state-collision fixes, kinematic limit checks, minimum length, profile switching and trajectory upsampling. Register them in a ProfileDictionary under the namespace of the node that reads them; see the Task Composer User Guide.

Reference

tesseract_task_composer planning-node profile Python bindings

ContactCheckProfile

Bases: Profile

contact_manager_config property writable

Python
contact_manager_config: ContactManagerConfig

collision_check_config property writable

Python
collision_check_config: CollisionCheckConfig

__hash__ class-attribute instance-attribute

Python
__hash__: None = None

createKey staticmethod

Python
createKey() -> int

__eq__

Python
__eq__(other: object) -> bool

__ne__

Python
__ne__(other: object) -> bool

from_yaml staticmethod

Python
from_yaml(config: str) -> ContactCheckProfile

Construct the profile from its YAML config text; malformed YAML raises ValueError.

Nested sub-configs are replaced, not merged: a key naming one rebuilds it from that struct's own defaults, so fields left out lose the profile's values. This is per struct; here collision_check_config: resets type to DISCRETE and longest_valid_segment_length to 0.005, and contact_manager_config: resets default_margin to None.

FixStateBoundsProfile

Bases: Profile

mode property writable

Python
mode: Settings

max_deviation_global property writable

Python
max_deviation_global: float

upper_bounds_reduction property writable

Python
upper_bounds_reduction: float

lower_bounds_reduction property writable

Python
lower_bounds_reduction: float

__hash__ class-attribute instance-attribute

Python
__hash__: None = None

Settings

Bases: Enum

START_ONLY class-attribute instance-attribute
Python
START_ONLY = 0
END_ONLY class-attribute instance-attribute
Python
END_ONLY = 1
ALL class-attribute instance-attribute
Python
ALL = 2
DISABLED class-attribute instance-attribute
Python
DISABLED = 3

__init__

Python
__init__(mode: Settings = FixStateBoundsProfile.Settings.ALL) -> None

createKey staticmethod

Python
createKey() -> int

__eq__

Python
__eq__(other: object) -> bool

__ne__

Python
__ne__(other: object) -> bool

from_yaml staticmethod

Python
from_yaml(config: str) -> FixStateBoundsProfile

Construct the profile from its YAML config text; malformed YAML raises ValueError.

No nested sub-configs: every key is a field of the profile itself. Other profiles' from_yaml behave per struct.

FixStateCollisionProfile

Bases: Profile

mode property writable

Python
mode: Settings

correction_workflow property writable

Python
correction_workflow: list[CorrectionMethod]

jiggle_factor property writable

Python
jiggle_factor: float

contact_manager_config property writable

Python
contact_manager_config: ContactManagerConfig

collision_check_config property writable

Python
collision_check_config: CollisionCheckConfig

sampling_attempts property writable

Python
sampling_attempts: int

update_workspace property writable

Python
update_workspace: bool

trajopt_joint_constraint_config property writable

Python
trajopt_joint_constraint_config: TrajOptJointWaypointConfig

Joint waypoint constraint config of the TrajOpt correction solve

trajopt_joint_cost_config property writable

Python
trajopt_joint_cost_config: TrajOptJointWaypointConfig

Joint waypoint cost config of the TrajOpt correction solve

collision_constraint_coeff property writable

Python
collision_constraint_coeff: CollisionCoeffData

Collision constraint coefficients of the TrajOpt correction solve

collision_cost_coeff property writable

Python
collision_cost_coeff: CollisionCoeffData

Collision cost coefficients of the TrajOpt correction solve

opt_params property writable

Python
opt_params: BasicTrustRegionSQPParameters

Optimization parameters of the TrajOpt correction solve

osqp_settings property writable

Python
osqp_settings: OSQPSettings

OSQP settings of the TrajOpt correction solve

__hash__ class-attribute instance-attribute

Python
__hash__: None = None

Settings

Bases: Enum

START_ONLY class-attribute instance-attribute
Python
START_ONLY = 0
END_ONLY class-attribute instance-attribute
Python
END_ONLY = 1
INTERMEDIATE_ONLY class-attribute instance-attribute
Python
INTERMEDIATE_ONLY = 2
ALL class-attribute instance-attribute
Python
ALL = 3
ALL_EXCEPT_START class-attribute instance-attribute
Python
ALL_EXCEPT_START = 4
ALL_EXCEPT_END class-attribute instance-attribute
Python
ALL_EXCEPT_END = 5
DISABLED class-attribute instance-attribute
Python
DISABLED = 6

CorrectionMethod

Bases: Enum

NONE class-attribute instance-attribute
Python
NONE = 0
TRAJOPT class-attribute instance-attribute
Python
TRAJOPT = 1
RANDOM_SAMPLER class-attribute instance-attribute
Python
RANDOM_SAMPLER = 2

__init__

Python
__init__(mode: Settings = FixStateCollisionProfile.Settings.ALL) -> None

createKey staticmethod

Python
createKey() -> int

__eq__

Python
__eq__(other: object) -> bool

__ne__

Python
__ne__(other: object) -> bool

from_yaml staticmethod

Python
from_yaml(config: str) -> FixStateCollisionProfile

Construct the profile from its YAML config text; malformed YAML raises ValueError.

Nested sub-configs are replaced, not merged: a key naming one rebuilds it from that struct's own defaults, so fields left out lose the profile's values. This is per struct; here collision_check_config: resets contact_request.type to ALL, and trajopt_joint_constraint_config: resets coeff to 5. contact_manager_config:, opt_params: and osqp_settings: keep the profile's defaults.

KinematicLimitsCheckProfile

Bases: Profile

check_position property writable

Python
check_position: bool

check_velocity property writable

Python
check_velocity: bool

check_acceleration property writable

Python
check_acceleration: bool

__hash__ class-attribute instance-attribute

Python
__hash__: None = None

__init__

Python
__init__(check_position: bool = True, check_velocity: bool = True, check_acceleration: bool = True) -> None

createKey staticmethod

Python
createKey() -> int

__eq__

Python
__eq__(other: object) -> bool

__ne__

Python
__ne__(other: object) -> bool

from_yaml staticmethod

Python
from_yaml(config: str) -> KinematicLimitsCheckProfile

Construct the profile from its YAML config text; malformed YAML raises ValueError.

No nested sub-configs: every key is a field of the profile itself. Other profiles' from_yaml behave per struct.

MinLengthProfile

Bases: Profile

min_length property writable

Python
min_length: int

__hash__ class-attribute instance-attribute

Python
__hash__: None = None

createKey staticmethod

Python
createKey() -> int

__eq__

Python
__eq__(other: object) -> bool

__ne__

Python
__ne__(other: object) -> bool

from_yaml staticmethod

Python
from_yaml(config: str) -> MinLengthProfile

Construct the profile from its YAML config text; malformed YAML raises ValueError.

No nested sub-configs: every key is a field of the profile itself. Other profiles' from_yaml behave per struct.

ProfileSwitchProfile

Bases: Profile

return_value property writable

Python
return_value: int

__hash__ class-attribute instance-attribute

Python
__hash__: None = None

__init__

Python
__init__(return_value: int = 1) -> None

createKey staticmethod

Python
createKey() -> int

__eq__

Python
__eq__(other: object) -> bool

__ne__

Python
__ne__(other: object) -> bool

from_yaml staticmethod

Python
from_yaml(config: str) -> ProfileSwitchProfile

Construct the profile from its YAML config text; malformed YAML raises ValueError.

No nested sub-configs: every key is a field of the profile itself. Other profiles' from_yaml behave per struct.

UpsampleTrajectoryProfile

Bases: Profile

longest_valid_segment_length property writable

Python
longest_valid_segment_length: float

__hash__ class-attribute instance-attribute

Python
__hash__: None = None

createKey staticmethod

Python
createKey() -> int

__eq__

Python
__eq__(other: object) -> bool

__ne__

Python
__ne__(other: object) -> bool

from_yaml staticmethod

Python
from_yaml(config: str) -> UpsampleTrajectoryProfile

Construct the profile from its YAML config text; malformed YAML raises ValueError.

No nested sub-configs: every key is a field of the profile itself. Other profiles' from_yaml behave per struct.