scikit-bot

  • Installation
  • Examples
  • API Reference
  • skbot.ignition
    • skbot.ignition.create_frame_graph
    • skbot.ignition.download_fuel_model
    • skbot.ignition.FrustumProjection
    • skbot.ignition.get_fuel_model
    • skbot.ignition.get_fuel_model_info
    • skbot.ignition.Subscriber
    • skbot.ignition.sdformat.dumps
    • skbot.ignition.sdformat.get_version
    • skbot.ignition.sdformat.loads
    • skbot.ignition.sdformat.loads_generic
    • skbot.ignition.sdformat.to_frame_graph
    • SDFormat v1.8 Bindings
      • v18.actor.Actor
        • v18.actor.Actor.Animation
        • v18.actor.Actor.Plugin
        • v18.actor.Actor.Pose
        • v18.actor.Actor.Script
        • v18.actor.Actor.Skin
      • v18.collision.Collision
        • v18.collision.Collision.Pose
        • v18.collision.Collision.Surface
      • v18.geometry.Geometry
        • v18.geometry.Geometry.Box
        • v18.geometry.Geometry.Capsule
        • v18.geometry.Geometry.Cylinder
        • v18.geometry.Geometry.Ellipsoid
        • v18.geometry.Geometry.Heightmap
        • v18.geometry.Geometry.Image
        • v18.geometry.Geometry.Mesh
        • v18.geometry.Geometry.Plane
        • v18.geometry.Geometry.Polyline
        • v18.geometry.Geometry.Sphere
      • v18.joint.Joint
        • v18.joint.Joint.Axis
        • v18.joint.Joint.Axis2
        • v18.joint.Joint.Physics
        • v18.joint.Joint.Pose
      • v18.light.Light
        • v18.light.Light.Attenuation
        • v18.light.Light.Pose
        • v18.light.Light.Spot
      • v18.link.Link
        • v18.link.Link.AudioSource
        • v18.link.Link.Battery
        • v18.link.Link.Inertial
        • v18.link.Link.ParticleEmitter
        • v18.link.Link.Pose
        • v18.link.Link.Projector
        • v18.link.Link.VelocityDecay
      • v18.material.Material
        • v18.material.Material.Pbr
        • v18.material.Material.Script
        • v18.material.Material.Shader
      • v18.model.Model
        • v18.model.Model.Frame
        • v18.model.Model.Gripper
        • v18.model.Model.Include
        • v18.model.Model.Plugin
        • v18.model.Model.Pose
      • v18.physics.Physics
        • v18.physics.Physics.Bullet
        • v18.physics.Physics.Dart
        • v18.physics.Physics.Ode
        • v18.physics.Physics.Simbody
      • v18.scene.Scene
        • v18.scene.Scene.Fog
        • v18.scene.Scene.Sky
      • v18.sdf.Sdf
      • v18.sensor.Sensor
        • v18.sensor.Sensor.AirPressure
        • v18.sensor.Sensor.Altimeter
        • v18.sensor.Sensor.Camera
        • v18.sensor.Sensor.Contact
        • v18.sensor.Sensor.ForceTorque
        • v18.sensor.Sensor.Gps
        • v18.sensor.Sensor.Imu
        • v18.sensor.Sensor.Lidar
        • v18.sensor.Sensor.LogicalCamera
        • v18.sensor.Sensor.Magnetometer
        • v18.sensor.Sensor.Navsat
        • v18.sensor.Sensor.Plugin
        • v18.sensor.Sensor.Pose
        • v18.sensor.Sensor.Ray
        • v18.sensor.Sensor.Sonar
        • v18.sensor.Sensor.Transceiver
      • v18.state.State
        • v18.state.State.Deletions
        • v18.state.State.Insertions
        • v18.state.State.Light
      • v18.state.Model
        • v18.state.Model.Frame
        • v18.state.Model.Joint
        • v18.state.Model.Link
        • v18.state.Model.Pose
      • v18.visual.Visual
        • v18.visual.Visual.MetaType
        • v18.visual.Visual.Plugin
        • v18.visual.Visual.Pose
      • v18.world.World
        • v18.world.World.Atmosphere
        • v18.world.World.Audio
        • v18.world.World.Frame
        • v18.world.World.Gui
        • v18.world.World.Include
        • v18.world.World.Plugin
        • v18.world.World.Population
        • v18.world.World.Road
        • v18.world.World.SphericalCoordinates
        • v18.world.World.Wind
    • skbot.ignition.sdformat.generic_sdf
      • skbot.ignition.sdformat.generic_sdf.sdf.Sdf
      • skbot.ignition.sdformat.generic_sdf.camera.Camera
      • skbot.ignition.sdformat.generic_sdf.frame.Frame
      • skbot.ignition.sdformat.generic_sdf.joint.Joint
      • skbot.ignition.sdformat.generic_sdf.link.Link
      • skbot.ignition.sdformat.generic_sdf.model.Model
      • skbot.ignition.sdformat.generic_sdf.sensor.Sensor
      • skbot.ignition.sdformat.generic_sdf.world.World
      • skbot.ignition.sdformat.generic_sdf.include.Include
      • skbot.ignition.sdformat.generic_sdf.origin.Origin
      • skbot.ignition.sdformat.generic_sdf.state.State
      • skbot.ignition.sdformat.generic_sdf.light_state.Light
      • skbot.ignition.sdformat.generic_sdf.link_state.Link
      • skbot.ignition.sdformat.generic_sdf.model_state.Model
      • skbot.ignition.sdformat.generic_sdf.collision.Collision
      • skbot.ignition.sdformat.generic_sdf.inertial.Inertial
      • skbot.ignition.sdformat.generic_sdf.material.Material
      • skbot.ignition.sdformat.generic_sdf.geometry.Geometry
      • skbot.ignition.sdformat.generic_sdf.visual.Visual
      • skbot.ignition.sdformat.generic_sdf.actor.Actor
      • skbot.ignition.sdformat.generic_sdf.audio_sink.AudioSink
      • skbot.ignition.sdformat.generic_sdf.audio_source.AudioSource
      • skbot.ignition.sdformat.generic_sdf.collision_engine.CollisionEngine
      • skbot.ignition.sdformat.generic_sdf.gripper.Gripper
      • skbot.ignition.sdformat.generic_sdf.particle_emitter.ParticleEmitter
      • skbot.ignition.sdformat.generic_sdf.physics.Physics
      • skbot.ignition.sdformat.generic_sdf.scene.Scene
      • skbot.ignition.sdformat.generic_sdf.surface.Surface
      • skbot.ignition.sdformat.generic_sdf.urdf.URDF
      • skbot.ignition.sdformat.generic_sdf.sensors.Lidar
      • skbot.ignition.sdformat.generic_sdf.sensors.Ray
      • skbot.ignition.sdformat.generic_sdf.sensors.AirPressure
      • skbot.ignition.sdformat.generic_sdf.sensors.Altimeter
      • skbot.ignition.sdformat.generic_sdf.sensors.Contact
      • skbot.ignition.sdformat.generic_sdf.sensors.ForceTorque
      • skbot.ignition.sdformat.generic_sdf.sensors.Gps
      • skbot.ignition.sdformat.generic_sdf.sensors.Imu
      • skbot.ignition.sdformat.generic_sdf.sensors.LogicalCamera
      • skbot.ignition.sdformat.generic_sdf.sensors.Magnetometer
      • skbot.ignition.sdformat.generic_sdf.sensors.Navsat
      • skbot.ignition.sdformat.generic_sdf.sensors.RfidTag
      • skbot.ignition.sdformat.generic_sdf.sensors.Rfid
      • skbot.ignition.sdformat.generic_sdf.sensors.Sonar
      • skbot.ignition.sdformat.generic_sdf.sensors.Transceiver
      • skbot.ignition.sdformat.generic_sdf.light.Light
      • skbot.ignition.sdformat.generic_sdf.shapes.Box
      • skbot.ignition.sdformat.generic_sdf.shapes.Capsule
      • skbot.ignition.sdformat.generic_sdf.shapes.Cylinder
      • skbot.ignition.sdformat.generic_sdf.shapes.Ellipsoid
      • skbot.ignition.sdformat.generic_sdf.shapes.Heightmap
      • skbot.ignition.sdformat.generic_sdf.shapes.Image
      • skbot.ignition.sdformat.generic_sdf.shapes.Mesh
      • skbot.ignition.sdformat.generic_sdf.shapes.Plane
      • skbot.ignition.sdformat.generic_sdf.gui.Gui
      • skbot.ignition.sdformat.generic_sdf.atmosphere.Atmosphere
      • skbot.ignition.sdformat.generic_sdf.battery.Battery
      • skbot.ignition.sdformat.generic_sdf.noise.Noise
      • skbot.ignition.sdformat.generic_sdf.population.Population
      • skbot.ignition.sdformat.generic_sdf.projector.Projector
  • skbot.inverse_kinematics
    • skbot.inverse_kinematics.PositionTarget
    • skbot.inverse_kinematics.RotationTarget
    • skbot.inverse_kinematics.ccd
    • skbot.inverse_kinematics.gd
  • skbot.ros
    • skbot.ros.create_frame_graph
  • skbot.trajectory
    • skbot.trajectory.linear_trajectory
    • skbot.trajectory.spline_trajectory
  • skbot.transform
    • skbot.transform.Frame
    • skbot.transform.Link
    • skbot.transform.AffineSpace
    • skbot.transform.Translation
    • skbot.transform.Rotation
    • skbot.transform.PerspectiveProjection
    • skbot.transform.EulerRotation
    • skbot.transform.QuaternionRotation
    • skbot.transform.RotvecRotation
    • skbot.transform.FrustumProjection
    • skbot.transform.RotationalJoint
    • skbot.transform.PrismaticJoint
    • skbot.transform.Rotation2D
    • skbot.transform.AngleJoint
    • skbot.transform.AxialHexagonTransform
    • skbot.transform.HexagonAxisRound
    • skbot.transform.CustomLink
    • skbot.transform.CompundLink
    • skbot.transform.InvertLink
    • skbot.transform.simplify_links

skbot.transform.CustomLink¶

class skbot.transform.CustomLink(parent_dim, child_dim, transformation)[source]¶

A link representing a custom transformation.

Initialize a new link from the callable transformation that transforms a vector from the parent frame to the child frame. This link can represent arbitrary transformations between two frames.

Parameters
parentFrame

The frame in which vectors are specified.

childFrame

The frame into which this link transforms vectors.

transfomrationCallable[[ArrayLike], np.ndarray]

A callable that takes a vector - in the parent frame - as input and returns the vector in the child frame.

Notes

This function does not implement Link.__inverse_transform__().

Method Summary

__call__(parent[, child, add_inverse])

Add this link to the parent frame.

invert()

Returns a new link that is the inverse of this link.

transform(x)

Expresses the vector x (assumed to be given in the parent's frame) in the child's frame.

__inverse_transform__(x)

Transform x (given in the child frame) into the parent frame.

Methods

__call__(parent, child=None, *, add_inverse=True)¶

Add this link to the parent frame.

Parameters
parentFrame

The Frame from which vectors originate.

childFrame

The Frame in which vectors are expressed after they were mapped by this link’s transform. If None, a new child will be created.

add_inversebool

Also add the inverse link to the child if this Link is invertible. Defaults to True.

Returns
childFrame

The Frame in which vectors are expressed after they were mapped by this link’s transform.

Return type

Frame

invert()¶

Returns a new link that is the inverse of this link.

The links share parameters, i.e., if the transform of a link changes, the transform of its inverse does also.

Return type

Frame

transform(x)[source]¶

Expresses the vector x (assumed to be given in the parent’s frame) in the child’s frame.

Parameters
xArrayLike

The vector expressed in the parent’s frame

Returns
yArrayLike

The vector expressed in the child’s frame

Return type

ndarray

__inverse_transform__(x)¶

Transform x (given in the child frame) into the parent frame.

Parameters
xArrayLike

The vector expressed in the childs’s frame

Returns
yArrayLike

The vector expressed in the parents’s frame

Return type

ndarray

previous

skbot.transform.HexagonAxisRound

next

skbot.transform.CompundLink

© Copyright 2021, Sebastian Wallkötter.

Created using Sphinx 4.4.0.