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
¶
TrajOptIfoptJointWaypointConfig
¶
TrajOptIfoptTermInfos
¶
Constraint and cost sets a TrajOpt-Ifopt profile adds to the planner's problem
TrajOptIfoptWaypointInfo
¶
TrajOptIfoptMoveProfile
¶
TrajOptIfoptCompositeProfile
¶
Bases: Profile
createKey
staticmethod
¶
The key every TrajOpt-Ifopt composite profile carries
create
¶
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
¶
TrajOptIfoptDefaultMoveProfile
¶
Bases: TrajOptIfoptMoveProfile
TrajOptIfoptDefaultCompositeProfile
¶
TrajOptIfoptOSQPSolverProfile
¶
Bases: TrajOptIfoptSolverProfile
setWarmStart
¶
Warm-start each QP solve from the previous solution (OSQP warm_starting).
setAdaptiveRho
¶
Adapt the ADMM step size rho (OSQP adaptive_rho).
setAdaptiveRhoInterval
¶
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.
setMaxIteration
¶
Maximum ADMM iterations per QP solve.
setAbsoluteTolerance
¶
Absolute convergence tolerance (OSQP eps_abs).
setRelativeTolerance
¶
Relative convergence tolerance (OSQP eps_rel).
from_yaml
staticmethod
¶
Construct the profile from its YAML config text; malformed YAML raises ValueError.
TrajOptIfoptPIQPSolverProfile
¶
Bases: TrajOptIfoptSolverProfile
from_yaml
staticmethod
¶
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
createJointPositionConstraint
¶
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
¶
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
¶
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
¶
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
¶
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