xjxu21 commited on
Commit
b6b4d44
·
verified ·
1 Parent(s): d7e488c

docs: correct the tools install path and Clip usage

Browse files
Files changed (1) hide show
  1. README.md +11 -5
README.md CHANGED
@@ -86,17 +86,23 @@ Clips are 11 s to 8.5 min of continuous motion — no cuts, no teleports.
86
 
87
  ```bash
88
  git clone https://github.com/AlayaLab/WorldRover
89
- pip install -r WorldRover/requirements.txt
 
90
  ```
91
 
92
  ```python
93
  from worldrover import Clip
94
- clip = Clip("venice/fp/venice_000000")
95
- rgb, depth_m = clip.rgb_frame(100), clip.depth_frame(100) # sRGB uint8; metres
96
- pts = clip.points_world(100) # world points, centimetres
 
 
 
97
  ```
98
 
99
- The loader handles the three conventions above for you.
 
 
100
 
101
  ## License
102
 
 
86
 
87
  ```bash
88
  git clone https://github.com/AlayaLab/WorldRover
89
+ pip install -r WorldRover/tools/requirements.txt # numpy, opencv-python; ffmpeg/ffprobe on PATH
90
+ cd WorldRover/tools # the package is not pip-installable yet
91
  ```
92
 
93
  ```python
94
  from worldrover import Clip
95
+
96
+ clip = Clip("/data/WorldRover-6scenes/venice/fp/venice_000000")
97
+ rgb = clip.rgb_frame(100) # uint8 (H, W, 3), sRGB
98
+ depth_m = clip.depth_frame(100) # planar depth in metres
99
+ pts = clip.points_world(100) # world points, centimetres
100
+ poses = clip.poses # per-frame pose + intrinsics
101
  ```
102
 
103
+ `Clip` takes a filesystem path to a clip directory. The reader takes the depth pixel format
104
+ from that clip's own `depth/depth.meta.json`, so it handles both encodings used across these
105
+ repositories, and it converts radial depth and the off-by-one trajectory row for you.
106
 
107
  ## License
108