roboticstoolbox-python 1.3.0__cp313-cp313-win_amd64.whl

roboticstoolbox/mobile/__init__.py

@@ -0,0 +1,193 @@
+# motion models
+from roboticstoolbox.mobile.Vehicle import VehicleBase, Bicycle, Unicycle, DiffSteer
+
+
+# planners
+from roboticstoolbox.mobile.PlannerBase import PlannerBase
+from roboticstoolbox.mobile.DistanceTransformPlanner import DistanceTransformPlanner
+from roboticstoolbox.mobile.DstarPlanner import DstarPlanner
+from roboticstoolbox.mobile.PRMPlanner import PRMPlanner
+from roboticstoolbox.mobile.LatticePlanner import LatticePlanner
+from roboticstoolbox.mobile.DubinsPlanner import DubinsPlanner
+from roboticstoolbox.mobile.ReedsSheppPlanner import ReedsSheppPlanner
+from roboticstoolbox.mobile.CurvaturePolyPlanner import CurvaturePolyPlanner
+from roboticstoolbox.mobile.QuinticPolyPlanner import QuinticPolyPlanner
+from roboticstoolbox.mobile.RRTPlanner import RRTPlanner
+
+from roboticstoolbox.mobile.Bug2 import Bug2
+
+from roboticstoolbox.mobile.OccGrid import (
+    BinaryOccupancyGrid,
+    OccupancyGrid,
+    PolygonMap,
+)
+
+# localization and state estimation
+from roboticstoolbox.mobile.landmarkmap import LandmarkMap
+from roboticstoolbox.mobile.sensors import RangeBearingSensor
+from roboticstoolbox.mobile.drivers import *
+from roboticstoolbox.mobile.Animations import (
+    VehicleAnimationBase,
+    VehicleMarker,
+    VehiclePolygon,
+    VehicleIcon,
+)
+
+from roboticstoolbox.mobile.PoseGraph import *
+from roboticstoolbox.mobile.EKF import EKF
+from roboticstoolbox.mobile.ParticleFilter import ParticleFilter
+
+__all__ = [
+    "VehicleBase",
+    "Bicycle",
+    "Unicycle",
+    "DiffSteer",
+    "VehicleAnimationBase",
+    "VehicleMarker",
+    "VehiclePolygon",
+    "VehicleIcon",
+    "Bug2",
+    "DistanceTransformPlanner",
+    "DstarPlanner",
+    "DubinsPlanner",
+    "LatticePlanner",
+    "ReedsSheppPlanner",
+    "CurvaturePolyPlanner",
+    "QuinticPolyPlanner",
+    "PRMPlanner",
+    "VehicleDriverBase",
+    "RandomPath",
+    "PurePursuit",
+    "LandmarkMap",
+    "RangeBearingSensor",
+    "PoseGraph",
+    "PolygonMap",
+    "BinaryOccupancyGrid",
+    "OccupancyGrid",
+    "PlannerBase",
+    "RRTPlanner",
+    "EKF",
+    "ParticleFilter",
+]
+
+
+# __doc__ = """
+# The Robotics Toolbox for Python
+# Based on the Matlab version
+# Peter Corke 2007
+# """
+
+######################
+#   Import Section   #
+######################
+
+# from numpy import *
+
+# # Import Link Constructor section
+# from Link import *
+
+# # Import Robot Constructor section
+# from Robot import *
+
+# # utility
+# from utility import *
+
+# # Import transformations section
+# from transform import *
+
+# from trplot import *
+
+# from jacobian import *
+
+# # import kinematics section
+# from kinematics import *
+
+# from manipulability import *
+
+# # import trajectories section
+# from trajectory import *
+
+# # import Quaternion constructor section
+# from Quaternion import *
+
+# # import dynamics section
+# from dynamics import *
+
+# # import robot models sections
+# #from puma560 import *
+# #from puma560akb import *
+# #from stanford import *
+# #from twolink import *
+
+# print """
+# Robotics Toolbox for Python
+# Based on Matlab Toolbox Version 7  April-2002
+
+# What's new.
+#   Readme      - New features and enhancements in this version.
+
+# Homogeneous transformations
+#   eul2tr      - Euler angle to transform
+#   oa2tr       - orientation and approach vector to transform
+#   rotx        - transform for rotation about X-axis
+#   roty        - transform for rotation about Y-axis
+#   rotz        - transform for rotation about Z-axis
+#   rpy2tr      - roll/pitch/yaw angles to transform
+#   tr2eul      - transform to Euler angles
+#   tr2rot      - transform to rotation submatrix
+#   tr2rpy      - transform to roll/pitch/yaw angles
+#   transl      - set or extract the translational component of a transform
+#   trnorm      - normalize a transform
+
+# Quaternions
+#   /           - divide quaternion by quaternion or scalar
+#   *           - multiply quaternion by a quaternion or vector
+#   inv         - invert a quaternion
+#   norm        - norm of a quaternion
+#   plot        - display a quaternion as a 3D rotation
+#   qinterp     - interpolate quaternions
+#   unit        - unitize a quaternion
+
+# Kinematics
+#   diff2tr     - differential motion vector to transform
+#   fkine       - compute forward kinematics
+#   ikine       - compute inverse kinematics
+#   ikine560    - compute inverse kinematics for Puma 560 like arm
+#   jacob0      - compute Jacobian in base coordinate frame
+#   jacobn      - compute Jacobian in end-effector coordinate frame
+#   tr2diff     - transform to differential motion vector
+#   tr2jac      - transform to Jacobian
+
+# Dynamics
+#   accel       - compute forward dynamics
+#   cinertia    - compute Cartesian manipulator inertia matrix
+#   coriolis    - compute centripetal/coriolis torque
+#   friction    - joint friction
+#   ftrans      - transform force/moment
+#   gravload    - compute gravity loading
+#   inertia     - compute manipulator inertia matrix
+#   itorque     - compute inertia torque
+#   nofriction  - remove friction from a robot object
+#   rne         - inverse dynamics
+
+# Trajectory generation
+#   ctraj       - Cartesian trajectory
+#   jtraj       - joint space trajectory
+#   trinterp    - interpolate transform s
+
+# Graphics
+#   drivebot    - drive a graphical  robot
+#   plot        - plot/animate robot
+
+# Other
+#   manipblty   - compute manipulability
+#   unit        - unitize a vector
+
+# Creation of robot models.
+#   link        - construct a robot link object
+#   puma560     - Puma 560 data
+#   puma560akb  - Puma 560 data (modified Denavit-Hartenberg)
+#   robot       - construct a robot object
+#   stanford    - Stanford arm data
+#   twolink     - simple 2-link example
+# """

roboticstoolbox/mobile/drivers.py

@@ -0,0 +1,390 @@
+"""
+Python Vehicle
+@Author: Peter Corke, original MATLAB code and Python version
+@Author: Kristian Gibson, initial MATLAB port
+"""
+
+from abc import ABC, abstractmethod
+import warnings
+from math import pi, sin, cos, tan, atan2
+import numpy as np
+from scipy import integrate, linalg, interpolate
+
+import matplotlib.pyplot as plt
+from matplotlib import patches
+import matplotlib.transforms as mtransforms
+
+from spatialmath import SE2, base
+import roboticstoolbox as rtb
+
+
+class VehicleDriverBase(ABC):
+    """
+    Abstract Vehicle driver class
+
+    Abtract class that can drive a mobile robot.
+
+    :seealso: :class:`RandomPath`
+    """
+
+    def __init__(
+        self,
+        workspace=None,
+        speed=1,
+        headinggain=0.3,
+        goalmarkerstyle=None,
+        verbose=False,
+    ):
+        """
+        _summary_
+
+        :param workspace: dimension of workspace, see :func:`spatialmath.base.exand_dims`
+        :type workspace: scalar, array_like(2), array_like(4)
+        :param speed: forward speed, defaults to 1
+        :type speed: float, optional
+        :param headinggain: _description_, defaults to 0.3
+        :type headinggain: float, optional
+        :param verbose: _description_, defaults to False
+        :type verbose: bool, optional
+
+        The workspace of the robot is a rectangular region defined by `workspace`
+        that is specified by  (see ``plotvol2``):
+
+        ==============  =======  =======
+        ``workspace``   x-range  y-range
+        ==============  =======  =======
+        A (scalar)      -A:A     -A:A
+        [A, B]           A:B      A:B
+        [A, B, C, D]     A:B      C:D
+        ==============  =======  =======
+        """
+        if hasattr(workspace, "workspace"):
+            # workspace can be defined by an object with a workspace attribute
+            self._workspace = base.expand_dims(workspace.workspace)
+        else:
+            self._workspace = base.expand_dims(workspace)
+
+        self._speed = speed
+        self._headinggain = headinggain
+        self._verbose = verbose
+
+        if goalmarkerstyle is None:
+            self._goal_marker_style = {
+                "marker": "D",
+                "markersize": 6,
+                "color": "r",
+                "linestyle": "None",
+            }
+        else:
+            self._goal_marker_style = goalmarkerstyle
+
+    @abstractmethod
+    def demand(self):
+        """
+        Compute speed and heading
+
+        :return: speed and steering for :class:`VehicleBase`
+
+        When an instance of a :class:`VehicleDriverBase` class is attached as
+        the control for an instance of a :class:`VehicleBase` class, this method
+        is called at each time step to provide the control input.
+
+        Has access to the vehicle and its state through the :meth:`vehicle`
+        property.
+        """
+        pass
+
+    @abstractmethod
+    def init(self):
+        """
+        Initialize driving agent
+
+        Called at the start of a simulation run.  Used to initialize state
+        including random number generator state.
+        """
+        pass
+
+    @property
+    def vehicle(self):
+        """
+        Set/get the vehicle under control
+
+        :getter: return :class:`VehicleBase` instance
+        :setter: set :class:`VehicleBase` instance
+
+        .. note:: The setter is invoked by ``vehicle.control = driver``
+        """
+        return self._veh
+
+    @vehicle.setter
+    def vehicle(self, v):
+
+        self._veh = v
+
+    def __repr__(self):
+        return str(self)
+
+    @property
+    def workspace(self):
+        """
+        Size of robot driving workspace
+
+        :return: workspace bounds [xmin, xmax, ymin, ymax]
+        :rtype: ndarray(4)
+
+        Returns the bounds of the workspace as specified by constructor
+        option ``workspace``
+        """
+        return self._workspace
+
+    def driveto(self, goal):
+
+        goal_heading = atan2(goal[1] - self._veh._x[1], goal[0] - self._veh._x[0])
+        delta_heading = base.angdiff(goal_heading, self._veh._x[2])
+        print(
+            f"t={self._veh._t:.1f}, pos=({self._veh._x[0]:.1f}, {self._veh._x[1]:.1f}), ",
+            f"goal_heading={goal_heading * 180 / pi:.1f}, delta_heading={delta_heading * 180 / pi:.1f}",
+        )
+
+        return np.r_[self._speed, self._headinggain * delta_heading]
+
+
+# ========================================================================= #
+
+
+class RandomPath(VehicleDriverBase):
+    def __init__(self, dthresh=0.05, seed=0, **kwargs):
+        """
+        Driving agent for random path
+
+
+        :param dthresh: distance threshold, defaults to 0.05
+        :type dthresh: float, optional
+
+        :raises ValueError: bad workspace specified
+
+        Returns a *driver* object that drives the attached vehicle to a
+        sequence of random waypoints.
+
+        The driver is connected to the vehicle by::
+
+            Vehicle(control=driver)
+
+        or::
+
+            veh = Vehicle()
+            veh.control = driver
+
+        The waypoints are positioned inside a rectangular region defined by
+        the `workspace`
+
+        .. note::
+            - It is possible in some cases for the vehicle to move outside the desired
+              region, for instance if moving to a waypoint near the edge, the limited
+              turning circle may cause the vehicle to temporarily move outside.
+            - The vehicle chooses a new waypoint when it is closer than ``dthresh``
+              to the current waypoint.
+            - Uses its own random number generator so as to not influence the performance
+              of other randomized algorithms such as path planning. Set ``seed=None`` to have it randomly initialized from the
+              operating system.
+
+        :seealso: :class:`Bicycle` :class:`Unicycle` :func:`~spatialmath.base.graphics.plotvol2`
+        """
+
+        # TODO options to specify region, maybe accept a Map object?
+
+        super().__init__(**kwargs)
+
+        self._dthresh = dthresh * np.diff(self._workspace[0:2])
+        self._goal_marker = None
+
+        self._d_prev = np.inf
+        self._random = np.random.default_rng(seed)
+        self._seed = seed
+        self._goal = None
+        self._dthresh = dthresh * max(
+            self._workspace[1] - self._workspace[0],
+            self._workspace[3] - self._workspace[2],
+        )
+
+        self._veh = None
+
+    def __str__(self):
+        """Convert to string
+
+        :return: driver parameters and state in in a compact human readable format
+        :rtype: str
+        """
+
+        s = "RandomPath driver object\n"
+        s += (
+            f"  X {self._workspace[0]} : {self._workspace[1]}; Y {self._workspace[0]} :"
+            f" {self._workspace[1]}, dthresh={self._dthresh}\n"
+        )
+        s += f"  current goal={self._goal}"
+        return s
+
+    def init(self, ax=None):
+        """
+        Initialize random path driving agent
+
+        :param ax: axes in which to draw via points, defaults to None
+        :type ax: Axes, optional
+
+        Called at the start of a simulation run.  Ensures that the
+        random number generated is reseeded to ensure that
+        the sequence of random waypoints is repeatable.
+        """
+
+        if self._seed is not None:
+            self._random = np.random.default_rng(self._seed)
+
+        self._goal = None
+        # delete(driver.h_goal);   % delete the goal
+        # driver.h_goal = [];
+        if ax is not None:
+            self._goal_marker = plt.plot(
+                np.nan, np.nan, **self._goal_marker_style, label="random waypoint"
+            )[0]
+
+    def demand(self):
+        """
+        Compute speed and heading for random waypoint
+            %
+            % [SPEED,STEER] = R.demand() is the speed and steer angle to
+            % drive the vehicle toward the next waypoint.  When the vehicle is
+            % within R.dtresh a new waypoint is chosen.
+            %
+            % See also Vehicle."""
+
+        if self._goal is None:
+            self._new_goal()
+
+        # if nearly at goal point, choose the next one
+        d = np.linalg.norm(self._veh._x[0:2] - self._goal)
+        if d < self._dthresh or abs(d - self._d_prev) < 1e-3:
+            self._new_goal()
+        # elif d > 2 * self._d_prev:
+        #     self.choose_goal()
+        self._d_prev = d
+
+        return self.driveto(self._goal)
+
+    ## private method, invoked from demand() to compute a new waypoint
+
+    def _new_goal(self):
+
+        # choose a uniform random goal within inner 80% of driving area
+        while True:
+            r = self._random.uniform(0.1, 0.9)
+            gx = self._workspace[0:2] @ np.r_[r, 1 - r]
+
+            r = self._random.uniform(0.1, 0.9)
+            gy = self._workspace[2:4] @ np.r_[r, 1 - r]
+
+            self._goal = np.r_[gx, gy]
+
+            # check not too close to last goal
+            if np.linalg.norm(self._goal - self._veh._x[0:2]) > 2 * self._dthresh:
+                break
+
+        if self._veh.verbose or self._verbose:
+            print(f"set goal: {self._goal}")
+
+        # update the goal marker
+        if self._goal_marker is not None:
+            self._goal_marker.set_xdata([self._goal[0]])
+            self._goal_marker.set_ydata([self._goal[1]])
+
+
+# ========================================================================= #
+
+
+class PurePursuit(VehicleDriverBase):
+    def __init__(self, path, lookahead=1, linemarkerstyle=None, **kwargs):
+        """
+        Driving agent for pure pursuit
+
+        :param path: path as a set of waypoints
+        :type path: array_like(2,n) one column per point, optional
+        :param lookahead: lookahead distance, defaults to 1
+        :type lookahead: float, optional
+        """
+        super().__init__(**kwargs)
+        self._path = path
+        self._lookahead = lookahead
+        self._linemarkerstyle = linemarkerstyle
+
+    def __str__(self):
+        """Convert to string
+
+        :return: driver parameters and state in in a compact human readable format
+        :rtype: str
+        """
+
+        s = "PurePursuit driver object\n"
+        s += (
+            f"  X {self._workspace[0]} : {self._workspace[1]}; Y {self._workspace[0]} :"
+            f" {self._workspace[1]}, lookahead={self._lookahead}\n"
+        )
+        return s
+
+    def init(self, ax=None):
+        if ax is not None:
+            h = plt.plot(
+                self._path[0, :],
+                self._path[1, :],
+                **self._linemarkerstyle,
+                label="waypoints",
+            )[0]
+        self._current_waypint = None
+
+    def demand(self):
+
+        cp = self._veh._x[0:2]  # current point
+
+        # find closest point on the path to current point
+        d = np.linalg.norm(self._path.T - cp, axis=1)  # rely on implicit expansion
+        i = np.argmin(d)
+
+        # find all points on the path at least lookahead distance away
+        (k,) = np.where(d[i + 1 :] >= self._lookahead)  # find all points beyond horizon
+        if len(k) == 0:
+            # no such points, we must be near the end, goal is the end
+            goal = self._path[:, -1]
+            k = -1
+        else:
+            # many such points, take the first one
+            k = k[0] + 1  # first point beyond look ahead distance
+            goal = self._path[:, k + i]
+            k += i
+
+        if self._waypoint_marker is not None:
+            pass
+            for marker in self._waypoint_marker:
+                marker.set_color("blue")
+            self._waypoint_marker[k].set_color("red")
+
+        return self.driveto(goal)
+
+
+# ========================================================================= #
+
+if __name__ == "__main__":
+    # import unittest
+
+    import roboticstoolbox as rtb
+
+    # veh = rtb.Bicycle(control=rtb.RandomPath(workspace=10), animation="car")
+    # print(veh.control)
+    # veh.run(20, animate=True)
+
+    # create the path
+    path = np.array([[10.0, 10], [10, 60], [80, 80], [50, 10]]).T
+    veh = rtb.Bicycle(
+        control=rtb.PurePursuit(path, speed=4, lookahead=5, workspace=[0, 100]),
+        animation="car",
+    )
+    print(veh)
+    print(veh.control)
+    veh.run(60, animate=True)