Skip to content

Commit 2f626e0

Browse files
committed
update readme
1 parent 097f072 commit 2f626e0

File tree

1 file changed

+30
-25
lines changed

1 file changed

+30
-25
lines changed

rofunc/README.md

Lines changed: 30 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
11
# Robotics Functions (RoFunc)
22

33
- [Robotics Functions (RoFunc)](#robotics-functions-rofunc)
4-
- [Hello, robot world!](#hello-robot-world)
5-
- [Available functions](#available-functions)
6-
- [Xsens](#xsens)
7-
- [Convert mvnx file to npys](#convert-mvnx-file-to-npys)
8-
- [Visualize the motion data](#visualize-the-motion-data)
9-
- [Optitrack](#optitrack)
10-
- [Get useful data](#get-useful-data)
11-
- [Visualize the motion data](#visualize-the-motion-data-1)
4+
- [Hello, robot world!](#hello-robot-world)
5+
- [Available functions](#available-functions)
6+
- [Xsens](#xsens)
7+
- [Convert mvnx file to npys](#convert-mvnx-file-to-npys)
8+
- [Visualize the motion data](#visualize-the-motion-data)
9+
- [Optitrack](#optitrack)
10+
- [Get useful data](#get-useful-data)
11+
- [Visualize the motion data](#visualize-the-motion-data-1)
12+
- [Zed](#zed)
13+
- [Record](#record)
14+
- [Playback](#playback)
1215

1316
## Hello, robot world!
1417

@@ -22,23 +25,25 @@ import rofunc as rf
2225

2326
## Available functions
2427

25-
| Classes | Types | Functions | Description | Status |
26-
|----------------|-------------|-----------------------|-------------------------------------------------------|--------|
27-
| **Devices** | Xsens | `xsens.process` | Decoding the .mvnx file ||
28-
| | | `xsens.visualize` | Show or save gif about the motion ||
29-
| | Optitrack | `optitrack.process` | Process the output .csv data ||
30-
| | | `optitrack.visualize` | Show or save gif about the motion | |
31-
| | ZED | `zed.record` | Record with multiple cameras ||
32-
| | | `zed.playback` | Playback the recording and save snapshots | |
33-
| | Multi-modal | `mmodal.capture` | Capture multi-modal demonstration data simultaneously | |
34-
| **Logger** | | `logger.write` | Custom tensorboard-based logger | |
35-
| **Coordinate** | | `coord.custom_class` | Define the custom class of `Pose` | |
36-
| | | `coord.transform` | Useful functions about coordinate transformation | |
37-
| **VisuaLab** | 2D | `visualab.2d` | 2-dim trajectory visualization | |
38-
| | 3D | `visualab.3d` | 3-dim trajectory visualization | |
39-
| | 3D with ori | `visualab.3dori` | 3-dim trajectory visualization with orientation | |
40-
| **Planning** | LQT | `lqt.uni` | LQT for one agent | |
41-
| | | `lqt.bi` | LQT for two agent with constraints | |
28+
| Classes | Types | Functions | Description | Status |
29+
|----------------|-------------|-----------------------|------------------------------------------------------|--------|
30+
| **Devices** | Xsens | `xsens.record` | Record the human motion via network streaming | |
31+
| | | `xsens.process` | Decode the .mvnx file ||
32+
| | | `xsens.visualize` | Show or save gif about the motion ||
33+
| | Optitrack | `optitrack.record` | Record the motion of markers via network streaming | |
34+
| | | `optitrack.process` | Process the output .csv data ||
35+
| | | `optitrack.visualize` | Show or save gif about the motion | |
36+
| | ZED | `zed.record` | Record with multiple cameras ||
37+
| | | `zed.playback` | Playback the recording and save snapshots ||
38+
| | Multi-modal | `mmodal.record` | Record multi-modal demonstration data simultaneously | |
39+
| **Logger** | | `logger.write` | Custom tensorboard-based logger | |
40+
| **Coordinate** | | `coord.custom_class` | Define the custom class of `Pose` | |
41+
| | | `coord.transform` | Useful functions about coordinate transformation | |
42+
| **VisuaLab** | 2D | `visualab.2d` | 2-dim trajectory visualization | |
43+
| | 3D | `visualab.3d` | 3-dim trajectory visualization | |
44+
| | 3D with ori | `visualab.3dori` | 3-dim trajectory visualization with orientation | |
45+
| **Planning** | LQT | `lqt.uni` | LQT for one agent | |
46+
| | | `lqt.bi` | LQT for two agent with constraints | |
4247

4348
### Xsens
4449

0 commit comments

Comments
 (0)