symforce.geo package

Package for symbolic geometric types using the Sympy API, focused on 2D and 3D transforms for use in robotics and optimization.

Implements strict notions of Storage types, Group types, and LieGroup types.

The design of these concepts is similar to those in GTSAM and Sophus:

• https://gtsam.org/

• https://github.com/strasdat/Sophus

Subpackages

• symforce.geo.unsupported package
  • Submodules
    • symforce.geo.unsupported.pose2_se2 module
      • Pose2_SE2
    • symforce.geo.unsupported.pose3_se3 module
      • Pose3_SE3

Submodules

• symforce.geo.complex module
  • Complex
    • storage_dim()
    • to_storage()
    • from_storage()
    • symbolic()
    • identity()
    • compose()
    • inverse()
    • zero()
    • conj()
    • squared_norm()
    • __mul__()
    • __add__()
    • __neg__()
    • __div__()
    • __truediv__()
    • random_uniform()
    • unit_random()
    • unit_random_from_uniform_sample()
• symforce.geo.dual_quaternion module
  • DualQuaternion
    • storage_dim()
    • to_storage()
    • from_storage()
    • identity()
    • compose()
    • inverse()
    • __mul__()
    • __div__()
    • __truediv__()
    • squared_norm()
    • conj()
• symforce.geo.matrix module
  • Matrix
    • MatrixT
    • SHAPE
    • __new__()
    • rows
    • cols
    • shape
    • is_Matrix
    • storage_dim()
    • from_storage()
    • to_storage()
    • tangent_dim()
    • from_tangent()
    • to_tangent()
    • storage_D_tangent()
    • tangent_D_storage()
    • zero()
    • zeros()
    • one()
    • ones()
    • diag()
    • eye()
    • det()
    • inv()
    • symbolic()
    • row_join()
    • col_join()
    • block_matrix()
    • simplify()
    • limit()
    • jacobian()
    • diff()
    • T
    • transpose()
    • lower_triangle()
    • Triangle
      • LOWER
      • UPPER
    • symmetric_copy()
    • reshape()
    • dot()
    • cross()
    • squared_norm()
    • norm()
    • normalized()
    • clamp_norm()
    • multiply_elementwise()
    • applyfunc()
    • __getitem__()
    • row()
    • col()
    • __neg__()
    • __add__()
    • __sub__()
    • __mul__()
    • __rmul__()
    • __div__()
    • compute_AtA()
    • LU()
    • LDL()
    • FFLU()
    • FFLDU()
    • solve()
    • __truediv__()
    • are_parallel()
    • skew_symmetric()
    • evalf()
    • to_list()
    • to_flat_list()
    • from_flat_list()
    • to_numpy()
    • column_stack()
    • is_vector()
    • init_printing()
  • Matrix11
    • SHAPE
  • Matrix21
    • SHAPE
    • unit_x()
    • unit_y()
    • x
    • y
  • Matrix31
    • SHAPE
    • unit_x()
    • unit_y()
    • unit_z()
    • x
    • y
    • z
  • Matrix41
    • SHAPE
  • Matrix51
    • SHAPE
  • Matrix61
    • SHAPE
  • Matrix71
    • SHAPE
  • Matrix81
    • SHAPE
  • Matrix91
    • SHAPE
  • Matrix12
    • SHAPE
  • Matrix22
    • SHAPE
  • Matrix32
    • SHAPE
  • Matrix42
    • SHAPE
  • Matrix52
    • SHAPE
  • Matrix62
    • SHAPE
  • Matrix72
    • SHAPE
  • Matrix82
    • SHAPE
  • Matrix92
    • SHAPE
  • Matrix13
    • SHAPE
  • Matrix23
    • SHAPE
  • Matrix33
    • SHAPE
  • Matrix43
    • SHAPE
  • Matrix53
    • SHAPE
  • Matrix63
    • SHAPE
  • Matrix73
    • SHAPE
  • Matrix83
    • SHAPE
  • Matrix93
    • SHAPE
  • Matrix14
    • SHAPE
  • Matrix24
    • SHAPE
  • Matrix34
    • SHAPE
  • Matrix44
    • SHAPE
  • Matrix54
    • SHAPE
  • Matrix64
    • SHAPE
  • Matrix74
    • SHAPE
  • Matrix84
    • SHAPE
  • Matrix94
    • SHAPE
  • Matrix15
    • SHAPE
  • Matrix25
    • SHAPE
  • Matrix35
    • SHAPE
  • Matrix45
    • SHAPE
  • Matrix55
    • SHAPE
  • Matrix65
    • SHAPE
  • Matrix75
    • SHAPE
  • Matrix85
    • SHAPE
  • Matrix95
    • SHAPE
  • Matrix16
    • SHAPE
  • Matrix26
    • SHAPE
  • Matrix36
    • SHAPE
  • Matrix46
    • SHAPE
  • Matrix56
    • SHAPE
  • Matrix66
    • SHAPE
  • Matrix76
    • SHAPE
  • Matrix86
    • SHAPE
  • Matrix96
    • SHAPE
  • Matrix17
    • SHAPE
  • Matrix27
    • SHAPE
  • Matrix37
    • SHAPE
  • Matrix47
    • SHAPE
  • Matrix57
    • SHAPE
  • Matrix67
    • SHAPE
  • Matrix77
    • SHAPE
  • Matrix87
    • SHAPE
  • Matrix97
    • SHAPE
  • Matrix18
    • SHAPE
  • Matrix28
    • SHAPE
  • Matrix38
    • SHAPE
  • Matrix48
    • SHAPE
  • Matrix58
    • SHAPE
  • Matrix68
    • SHAPE
  • Matrix78
    • SHAPE
  • Matrix88
    • SHAPE
  • Matrix98
    • SHAPE
  • Matrix19
    • SHAPE
  • Matrix29
    • SHAPE
  • Matrix39
    • SHAPE
  • Matrix49
    • SHAPE
  • Matrix59
    • SHAPE
  • Matrix69
    • SHAPE
  • Matrix79
    • SHAPE
  • Matrix89
    • SHAPE
  • Matrix99
    • SHAPE
  • m
  • matrix_type_from_shape()
  • M
  • Vector1
  • Vector2
  • Vector3
  • Vector4
  • Vector5
  • Vector6
  • Vector7
  • Vector8
  • Vector9
  • V1
  • V2
  • V3
  • V4
  • V5
  • V6
  • V7
  • V8
  • V9
  • M11
  • M21
  • M31
  • M41
  • M51
  • M61
  • M71
  • M81
  • M91
  • M12
  • M22
  • M32
  • M42
  • M52
  • M62
  • M72
  • M82
  • M92
  • M13
  • M23
  • M33
  • M43
  • M53
  • M63
  • M73
  • M83
  • M93
  • M14
  • M24
  • M34
  • M44
  • M54
  • M64
  • M74
  • M84
  • M94
  • M15
  • M25
  • M35
  • M45
  • M55
  • M65
  • M75
  • M85
  • M95
  • M16
  • M26
  • M36
  • M46
  • M56
  • M66
  • M76
  • M86
  • M96
  • M17
  • M27
  • M37
  • M47
  • M57
  • M67
  • M77
  • M87
  • M97
  • M18
  • M28
  • M38
  • M48
  • M58
  • M68
  • M78
  • M88
  • M98
  • M19
  • M29
  • M39
  • M49
  • M59
  • M69
  • M79
  • M89
  • M99
  • I1()
  • I11()
  • I2()
  • I22()
  • I3()
  • I33()
  • I4()
  • I44()
  • I5()
  • I55()
  • I6()
  • I66()
  • I7()
  • I77()
  • I8()
  • I88()
  • I9()
  • I99()
• symforce.geo.pose2 module
  • Pose2
    • Pose2T
    • rotation()
    • position()
    • storage_dim()
    • to_storage()
    • from_storage()
    • identity()
    • compose()
    • inverse()
    • tangent_dim()
    • from_tangent()
    • to_tangent()
    • storage_D_tangent()
    • tangent_D_storage()
    • retract()
    • local_coordinates()
    • __mul__()
    • to_homogenous_matrix()
• symforce.geo.pose3 module
  • Pose3
    • Pose3T
    • rotation()
    • position()
    • storage_dim()
    • to_storage()
    • from_storage()
    • symbolic()
    • identity()
    • compose()
    • inverse()
    • tangent_dim()
    • from_tangent()
    • to_tangent()
    • storage_D_tangent()
    • tangent_D_storage()
    • retract()
    • local_coordinates()
    • __mul__()
    • to_homogenous_matrix()
• symforce.geo.quaternion module
  • Quaternion
    • x
    • y
    • z
    • storage_dim()
    • to_storage()
    • from_storage()
    • symbolic()
    • identity()
    • compose()
    • inverse()
    • __mul__()
    • __neg__()
    • __add__()
    • __div__()
    • __truediv__()
    • zero()
    • squared_norm()
    • conj()
    • unit_random()
    • unit_random_from_uniform_samples()
• symforce.geo.rot2 module
  • Rot2
    • storage_dim()
    • to_storage()
    • from_storage()
    • symbolic()
    • identity()
    • compose()
    • inverse()
    • tangent_dim()
    • from_tangent()
    • to_tangent()
    • hat()
    • storage_D_tangent()
    • tangent_D_storage()
    • __mul__()
    • from_angle()
    • to_angle()
    • to_rotation_matrix()
    • random()
    • random_from_uniform_sample()
• symforce.geo.rot3 module
  • Rot3
    • storage_dim()
    • to_storage()
    • from_storage()
    • symbolic()
    • identity()
    • compose()
    • inverse()
    • tangent_dim()
    • from_tangent()
    • to_tangent()
    • hat()
    • storage_D_tangent()
    • tangent_D_storage()
    • __mul__()
    • to_tangent_norm()
    • to_rotation_matrix()
    • from_rotation_matrix()
    • to_yaw_pitch_roll()
    • from_yaw_pitch_roll()
    • from_angle_axis()
    • from_two_unit_vectors()
    • angle_between()
    • random()
    • random_from_uniform_samples()
• symforce.geo.unit3 module
  • Unit3
    • E_Z
    • storage_dim()
    • to_storage()
    • from_storage()
    • symbolic()
    • identity()
    • compose()
    • inverse()
    • tangent_dim()
    • from_tangent()
    • to_tangent()
    • storage_D_tangent()
    • tangent_D_storage()
    • to_rotation()
    • to_unit_vector()
    • from_vector()
    • random()