Changed docs for actions_speeds_turns to state cm/frame and rad/frame instead of cm/s and rad/frame

docs/entity.md

@@ -64,13 +64,13 @@ As described in `robofish.io`, Files and Entities have useful properties.
 <small>
 
 | Entity function                                  | Description                                                                            |
-| ------------------------------------------------ | ------------------------------------------------------------------------ |
+| ------------------------------------------------ | -------------------------------------------------------------------------------------- |
 | `robofish.io.entity.Entity.positions`            | Positions as a `(timesteps, 2 (x, y))` array.                                          |
 | `robofish.io.entity.Entity.orientations`         | Orientations as a `(timesteps, 2 (ori_x, ori_y))` array.                               |
 | `robofish.io.entity.Entity.orientations_rad`     | Orientations as a `(timesteps, 1 (ori_rad))` array.                                    |
 | `robofish.io.entity.Entity.poses`                | Poses as a `(timesteps, 4 (x, y, x_ori, y_ori))` array.                                |
 | `robofish.io.entity.Entity.poses_rad`            | Poses as a `(timesteps, 3(x, y, ori_rad))` array.                                      |
-| `robofish.io.entity.Entity.actions_speeds_turns` | Speed and turn as a `(timesteps - 1, 2 (speed_cm/s, turn_rad/s))` array. |
+| `robofish.io.entity.Entity.actions_speeds_turns` | Speed and turn as a `(timesteps - 1, 2 (speed in cm/frame, turn in rad/frame))` array. |
 
 </small>
 

docs/index.md

@@ -125,13 +125,13 @@ In the same scheme the following properties are available:
 <small>
 
 | File/ Entity function         | Description                                                                                        |
-| ----------------------------- | ------------------------------------------------------------------------------------ |
-| *entity_*positions            | Positions as a `(*entities*, timesteps, 2 (x, y))` arary.                            |
-| *entity_*orientations         | Orientations as a `(*entities*, timesteps, 2 (ori_x, ori_y))` arary.                 |
-| *entity_*orientations_rad     | Orientations as a `(*entities*, timesteps, 1 (ori_rad))` arary.                      |
+| ----------------------------- | -------------------------------------------------------------------------------------------------- |
+| *entity_*positions            | Positions as a `(*entities*, timesteps, 2 (x, y))` array.                                          |
+| *entity_*orientations         | Orientations as a `(*entities*, timesteps, 2 (ori_x, ori_y))` array.                               |
+| *entity_*orientations_rad     | Orientations as a `(*entities*, timesteps, 1 (ori_rad))` array.                                    |
 | *entity_*poses                | Poses as a `(*entities*, timesteps, 4 (x, y, x_ori, y_ori))` array.                                |
 | *entity_*poses_rad            | Poses as a `(*entities*, timesteps, 3(x, y, ori_rad))` array.                                      |
-| *entity_*actions_speeds_turns | Speed and turn as a `(*entities*, timesteps - 1, 2 (speed_cm/s, turn_rad/s))` array. |
+| *entity_*actions_speeds_turns | Speed and turn as a `(*entities*, timesteps - 1, 2 (speed in cm/frame, turn in rad/frame))` array. |
 
 </small>
 

src/robofish/io/entity.py

@@ -241,15 +241,12 @@ class Entity(h5py.Group):
     def actions_speeds_turns(self):
         """Calculate the speed, turn and from the recorded positions and orientations.
 
-        The turn is calculated by the change of orientation.
+        The turn is calculated by the change of orientation between frames.
         The speed is calculated by the distance between the points, projected on the new orientation vector.
         The sideway change of position cannot be represented with this method.
 
         Returns:
-            An array with shape (number_of_positions -1, 3).
-            The first column is the speed (distance projected on new orientation).
-            The second column is the turning angle.
-
+            An array with shape (number_of_positions -1, 2 (speed in cm/frame, turn in rad/frame).
         """
 
         ori = self.orientations

src/robofish/io/file.py

@@ -463,6 +463,15 @@ class File(h5py.File):
 
     @property
     def entity_actions_speeds_turns(self):
+        """Calculate the speed, turn and from the recorded positions and orientations.
+
+        The turn is calculated by the change of orientation between frames.
+        The speed is calculated by the distance between the points, projected on the new orientation vector.
+        The sideway change of position cannot be represented with this method.
+
+        Returns:
+            An array with shape (number_of_entities, number_of_positions -1, 2 (speed in cm/frame, turn in rad/frame).
+        """
         return self.select_entity_property(
             None, entity_property=Entity.actions_speeds_turns
         )