Skip to content

tesseract_robotics.motion_planners_trajopt_ifopt

The TrajOpt-Ifopt motion planner and its profiles. TrajOptCollisionConfig, SQPParameters and CollisionEvaluatorType are re-exported so a profile configures from one import. Overriding a profile hook on a Python subclass of a concrete profile raises ProfileOverrideNotDispatchedError; see breaking changes.

Reference

TrajOptIfoptPureVirtualCallError

Bases: NotImplementedError

create is pure virtual: super().create(...), or a Python TrajOpt-Ifopt profile without it.

TrajOptIfoptNodeLayoutChangedError

Bases: ValueError

A Python TrajOptIfoptCompositeProfile.create changed the planner's nodes (variables or values).

TrajOptIfoptProfileReturnTypeError

Bases: TypeError

A Python TrajOpt-Ifopt profile's create returned the wrong type.

TrajOptIfoptWaypointInfoWithoutNodeError

Bases: ValueError

A Python TrajOptIfoptMoveProfile.create returned a waypoint info without a node.

TrajOptIfoptWaypointInfoInUseError

Bases: ValueError

A Python TrajOptIfoptMoveProfile.create returned a waypoint info still referenced elsewhere.

TrajOptIfoptCartesianWaypointConfig

enabled property writable

Python
enabled: bool

use_tolerance_override property writable

Python
use_tolerance_override: bool

lower_tolerance property writable

Python
lower_tolerance: Annotated[NDArray[float64], dict(shape=(None,), order=C)]

upper_tolerance property writable

Python
upper_tolerance: Annotated[NDArray[float64], dict(shape=(None,), order=C)]

coeff property writable

Python
coeff: Annotated[NDArray[float64], dict(shape=(None,), order=C)]

__hash__ class-attribute instance-attribute

Python
__hash__: None = None

__init__

Python
__init__() -> None

__eq__

Python
__eq__(other: object) -> bool

__ne__

Python
__ne__(other: object) -> bool

TrajOptIfoptJointWaypointConfig

enabled property writable

Python
enabled: bool

use_tolerance_override property writable

Python
use_tolerance_override: bool

lower_tolerance property writable

Python
lower_tolerance: Annotated[NDArray[float64], dict(shape=(None,), order=C)]

upper_tolerance property writable

Python
upper_tolerance: Annotated[NDArray[float64], dict(shape=(None,), order=C)]

coeff property writable

Python
coeff: Annotated[NDArray[float64], dict(shape=(None,), order=C)]

__hash__ class-attribute instance-attribute

Python
__hash__: None = None

__init__

Python
__init__() -> None

__eq__

Python
__eq__(other: object) -> bool

__ne__

Python
__ne__(other: object) -> bool

TrajOptIfoptTermInfos

Constraint and cost sets a TrajOpt-Ifopt profile adds to the planner's problem

constraints property writable

Python
constraints: list[ConstraintSet]

squared_costs property writable

Python
squared_costs: list[ConstraintSet]

absolute_costs property writable

Python
absolute_costs: list[ConstraintSet]

hinge_costs property writable

Python
hinge_costs: list[ConstraintSet]

__init__

Python
__init__() -> None

TrajOptIfoptWaypointInfo

What a TrajOpt-Ifopt move profile builds for one waypoint: its variables and terms

term_infos property writable

Python
term_infos: TrajOptIfoptTermInfos

node property

Python
node: Node | None

The waypoint's variable node (owned by this object), or None

fixed property writable

Python
fixed: bool

Whether the waypoint is fixed (no collision terms at this step)

__init__

Python
__init__() -> None

TrajOptIfoptMoveProfile

Bases: Profile

__init__

Python
__init__() -> None

getKey

Python
getKey() -> int

createKey staticmethod

Python
createKey() -> int

The key every TrajOpt-Ifopt move profile carries

create

Python
create(move_instruction: MoveInstructionPoly, composite_manip_info: ManipulatorInfo, env: Environment, index: int) -> TrajOptIfoptWaypointInfo

Build the waypoint info the planner adds for this move instruction

TrajOptIfoptCompositeProfile

Bases: Profile

__init__

Python
__init__() -> None

getKey

Python
getKey() -> int

createKey staticmethod

Python
createKey() -> int

The key every TrajOpt-Ifopt composite profile carries

create

Python
create(composite_manip_info: ManipulatorInfo, env: Environment, nodes: Sequence[Node], fixed_indices: Sequence[int]) -> TrajOptIfoptTermInfos

Build the trajectory-wide terms the planner adds over all waypoint nodes. nodes are the planner's and read-only: a Python override that adds variables or sets values raises TrajOptIfoptNodeLayoutChangedError.

TrajOptIfoptSolverProfile

Bases: Profile

opt_params property writable

Python
opt_params: SQPParameters

callbacks property writable

Python
callbacks: list[SQPCallback]

SQP callbacks registered on the solver, called once per SQP iteration

createOptimizationCallbacks

Python
createOptimizationCallbacks() -> list[tesseract_robotics.trajopt_sqp.SQPCallback]

getKey

Python
getKey() -> int

createKey staticmethod

Python
createKey() -> int

The key every TrajOpt-Ifopt solver profile carries

create

Python
create(verbose: bool = False) -> tesseract_robotics.trajopt_sqp.TrustRegionSQPSolver

Build the TrustRegionSQPSolver the planner solves with

TrajOptIfoptDefaultMoveProfile

Bases: TrajOptIfoptMoveProfile

cartesian_cost_config property writable

Python
cartesian_cost_config: TrajOptIfoptCartesianWaypointConfig

cartesian_constraint_config property writable

Python
cartesian_constraint_config: TrajOptIfoptCartesianWaypointConfig

joint_cost_config property writable

Python
joint_cost_config: TrajOptIfoptJointWaypointConfig

joint_constraint_config property writable

Python
joint_constraint_config: TrajOptIfoptJointWaypointConfig

__hash__ class-attribute instance-attribute

Python
__hash__: None = None

__init__

Python
__init__() -> None

__eq__

Python
__eq__(other: object) -> bool

__ne__

Python
__ne__(other: object) -> bool

from_yaml staticmethod

Python
from_yaml(config: str) -> TrajOptIfoptDefaultMoveProfile

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

__init_subclass__ classmethod

Python
__init_subclass__(**kwargs: object) -> None

TrajOptIfoptDefaultCompositeProfile

Bases: TrajOptIfoptCompositeProfile

collision_cost_config property writable

Python
collision_cost_config: TrajOptCollisionConfig

collision_constraint_config property writable

Python
collision_constraint_config: TrajOptCollisionConfig

smooth_velocities property writable

Python
smooth_velocities: bool

velocity_coeff property writable

Python
velocity_coeff: Annotated[NDArray[float64], dict(shape=(None,), order=C)]

smooth_accelerations property writable

Python
smooth_accelerations: bool

acceleration_coeff property writable

Python
acceleration_coeff: Annotated[NDArray[float64], dict(shape=(None,), order=C)]

smooth_jerks property writable

Python
smooth_jerks: bool

jerk_coeff property writable

Python
jerk_coeff: Annotated[NDArray[float64], dict(shape=(None,), order=C)]

__hash__ class-attribute instance-attribute

Python
__hash__: None = None

__init__

Python
__init__() -> None

__eq__

Python
__eq__(other: object) -> bool

__ne__

Python
__ne__(other: object) -> bool

from_yaml staticmethod

Python
from_yaml(config: str) -> TrajOptIfoptDefaultCompositeProfile

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

__init_subclass__ classmethod

Python
__init_subclass__(**kwargs: object) -> None

TrajOptIfoptOSQPSolverProfile

Bases: TrajOptIfoptSolverProfile

__hash__ class-attribute instance-attribute

Python
__hash__: None = None

__init__

Python
__init__() -> None

setPolish

Python
setPolish(polish: bool) -> None

Polish the ADMM solution (OSQP polishing).

getPolish

Python
getPolish() -> bool

setWarmStart

Python
setWarmStart(warm_start: bool) -> None

Warm-start each QP solve from the previous solution (OSQP warm_starting).

getWarmStart

Python
getWarmStart() -> bool

setAdaptiveRho

Python
setAdaptiveRho(adaptive_rho: bool) -> None

Adapt the ADMM step size rho (OSQP adaptive_rho).

getAdaptiveRho

Python
getAdaptiveRho() -> bool

setAdaptiveRhoInterval

Python
setAdaptiveRhoInterval(interval: int) -> None

Adapt rho every interval iterations. OSQP's 0 adapts on wall-clock timing, which makes solutions differ run to run; a fixed interval (e.g. 25) makes them reproducible.

getAdaptiveRhoInterval

Python
getAdaptiveRhoInterval() -> int

setMaxIteration

Python
setMaxIteration(max_iter: int) -> None

Maximum ADMM iterations per QP solve.

getMaxIteration

Python
getMaxIteration() -> int

setAbsoluteTolerance

Python
setAbsoluteTolerance(abs_tol: float) -> None

Absolute convergence tolerance (OSQP eps_abs).

getAbsoluteTolerance

Python
getAbsoluteTolerance() -> float

setRelativeTolerance

Python
setRelativeTolerance(rel_tol: float) -> None

Relative convergence tolerance (OSQP eps_rel).

getRelativeTolerance

Python
getRelativeTolerance() -> float

setVerbosity

Python
setVerbosity(verbose: bool) -> None

Write OSQP's progress to the console.

getVerbosity

Python
getVerbosity() -> bool

__eq__

Python
__eq__(other: object) -> bool

__ne__

Python
__ne__(other: object) -> bool

from_yaml staticmethod

Python
from_yaml(config: str) -> TrajOptIfoptOSQPSolverProfile

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

__init_subclass__ classmethod

Python
__init_subclass__(**kwargs: object) -> None

TrajOptIfoptPIQPSolverProfile

Bases: TrajOptIfoptSolverProfile

qp_settings property writable

Python
qp_settings: PIQPSettings

PIQP settings for each QP

__hash__ class-attribute instance-attribute

Python
__hash__: None = None

__init__

Python
__init__() -> None

__eq__

Python
__eq__(other: object) -> bool

__ne__

Python
__ne__(other: object) -> bool

from_yaml staticmethod

Python
from_yaml(config: str) -> TrajOptIfoptPIQPSolverProfile

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

settings: (PIQP, read into qp_settings) and opt_params: are merged into the profile's values; settings PIQP's sparse backend rejects raise RuntimeError.

TrajOptIfoptMotionPlanner

Bases: MotionPlanner

__init__

Python
__init__(name: str) -> None

createJointPositionConstraint

Python
createJointPositionConstraint(joint_waypoint: JointWaypointPoly, var: Var, coeffs: Annotated[NDArray[float64], dict(shape=(None,), order=C)] | Sequence[float]) -> tesseract_robotics.trajopt_ifopt.ConstraintSet

Joint position constraint at a waypoint: equality to its position, or its tolerance band

createCollisionConstraints

Python
createCollisionConstraints(vars: Sequence[Var], env: Environment, manip_info: ManipulatorInfo, config: TrajOptCollisionConfig, fixed_indices: Sequence[int], fixed_sparsity: bool) -> list[tesseract_robotics.trajopt_ifopt.ConstraintSet]

Collision constraint sets of config's collision check type: one per unfixed step (DISCRETE) or one per segment (LVS_DISCRETE, LVS_CONTINUOUS, CONTINUOUS); none for NONE

createJointVelocityConstraint

Python
createJointVelocityConstraint(target: Annotated[NDArray[float64], dict(shape=(None,), writable=False)] | Sequence[float], vars: Sequence[Var], coeffs: Annotated[NDArray[float64], dict(shape=(None,), order=C)] | Sequence[float]) -> tesseract_robotics.trajopt_ifopt.ConstraintSet

Joint velocity constraint over vars toward target

createJointAccelerationConstraint

Python
createJointAccelerationConstraint(target: Annotated[NDArray[float64], dict(shape=(None,), writable=False)] | Sequence[float], vars: Sequence[Var], coeffs: Annotated[NDArray[float64], dict(shape=(None,), order=C)] | Sequence[float]) -> tesseract_robotics.trajopt_ifopt.ConstraintSet

Joint acceleration constraint over vars toward target

createJointJerkConstraint

Python
createJointJerkConstraint(target: Annotated[NDArray[float64], dict(shape=(None,), writable=False)] | Sequence[float], vars: Sequence[Var], coeffs: Annotated[NDArray[float64], dict(shape=(None,), order=C)] | Sequence[float]) -> tesseract_robotics.trajopt_ifopt.ConstraintSet

Joint jerk constraint over vars toward target