SandhyaH commited on
Commit
5229ea4
·
verified ·
1 Parent(s): c9dfc75

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +98 -98
README.md CHANGED
@@ -1,99 +1,99 @@
1
- # FusionX Multimodal Sample Dataset
2
-
3
- This repository contains multimodal dataset capturing synchronized vision and tactile glove data across distinct tasks.
4
-
5
- ## Dataset Overview
6
-
7
- * **RGB Video:** 30 Hz high-definition color stream (`.mp4`).
8
- * **Depth Data:** Lossless 16-bit depth stream (`.mkv`) and raw 16-bit PNG frames.
9
- * **Mono Vision:** Left and right monochrome camera views (raw PNG).
10
- * **Tactile Data:** Per-frame aligned glove sensor data stored in high-performance `.parquet` format.
11
- * **Calibration:** Intrinsic and extrinsic camera parameters provided in `.json`.
12
-
13
- ---
14
-
15
- ## Repository Structure
16
-
17
- The dataset is organized by task. To optimize performance, raw image frames are compressed into modality-specific ZIP archives.
18
-
19
- ```text
20
- dataset/
21
- ├── dataset_info.json # Global dataset metadata
22
- ├─ [task_name]/ # e.g., box_cut1, drill1, waterpour3
23
- │ ├── depth.mkv # Post-processed depth video
24
- │ ├── rgb.mp4 # Post-processed RGB video
25
- │ ├── preview_all.mp4 # Synced visualization (Grid view)
26
- │ ├── preview_glove.mp4 # Tactile data visualization
27
- │ ├── frames.parquet # Main data index (Timestamps + Tactile)
28
- │ ├── calib.json # Camera calibration matrices
29
- │ ├── video_meta.json # Technical video specifications
30
- │ ├── depth.zip # Raw 16-bit PNG frames
31
- │ ├── mono_left.zip # Raw mono-left PNG frames
32
- │ ├── mono_right.zip # Raw mono-right PNG frames
33
- │ └── rgb.zip # Raw RGB JPG frames
34
- ```
35
-
36
- ## Tactile Data Schema (`frames.parquet`)
37
-
38
- The `frames.parquet` file is the central index for the dataset, providing per-frame synchronization between vision and tactile sensors.
39
-
40
- ### 1. Vision & Synchronization
41
- | Column | Description |
42
- | :--- | :--- |
43
- | `frame_idx` | Integer index of the frame. |
44
- | `timestamp` | Global synchronized UNIX timestamp. |
45
- | `rgb_path`, `depth_path` | Relative paths to the original RGB and Depth images. |
46
- | `mono_left_path`, `mono_right_path` | Relative paths to the monochrome stereo images. |
47
-
48
- ### 2. Camera IMU (OAK-D)
49
- | Column | Description |
50
- | :--- | :--- |
51
- | `oak_imu_quaternion` | 4-element orientation vector (W, X, Y, Z). |
52
- | `oak_imu_gyro` | Angular velocity (rad/s) for X, Y, Z axes. |
53
- | `oak_imu_accel` | Linear acceleration (m/s²) for X, Y, Z axes. |
54
-
55
- ### 3. Tactile Glove Data (Left Hand: `lh_`, Right Hand: `rh_`)
56
- Each hand contains independent timestamping and comprehensive pressure/bend sensing:
57
-
58
- | Feature | Columns |
59
- | :--- | :--- |
60
- | **Glove Timing** | `_glove_timestamp`, `_glove_dt_ms` |
61
- | **Raw Pressure** | `_thumb_pressure`, `_index_pressure`, `_middle_pressure`, `_ring_pressure`, `_little_pressure`, `_palm_pressure` |
62
- | **Calibrated Pressure** | `_thumb_pressure_cal`, `_index_pressure_cal`, `_middle_pressure_cal`, `_ring_pressure_cal`, `_little_pressure_cal`, `_palm_pressure_cal` |
63
- | **Finger Kinematics** | `_finger_bend` (Raw), `_finger_bend_cal` (Calibrated) |
64
- | **Glove IMU** | `_imu_quaternion`, `_imu_gyro`, `_imu_accel` |
65
-
66
- ---
67
-
68
- ## How to Use
69
-
70
- ### 1. Download the Dataset
71
- You can clone this repository using Git LFS or use the `huggingface_hub` library:
72
-
73
- ```python
74
- from huggingface_hub import snapshot_download
75
-
76
- # Download the specific task you need
77
- snapshot_download(
78
- repo_id="touchtronix/FusionX-Multimodal-Sample-Data-V2",
79
- repo_type="dataset",
80
- allow_patterns="box_cut1/*"
81
- )
82
- ```
83
- ### 2. Accessing Raw Frames
84
- If you require the original image files instead of the video streams, extract the modality zips within the task folder:
85
-
86
- ```bash
87
- unzip box_cut1/rgb.zip -d box_cut1/rgb/
88
- ```
89
- ---
90
-
91
- ## License
92
-
93
- **Creative Commons Attribution 4.0 (CC BY 4.0)** You are free to:
94
- * **Use:** Incorporate the data into your own projects.
95
- * **Share:** Copy and redistribute the material in any medium or format.
96
- * **Modify:** Remix, transform, and build upon the material.
97
- * **Commercial Use:** Use the data for commercial purposes.
98
-
99
  *As long as appropriate attribution is provided to **Touchtronix Robotics**.*
 
1
+ # FusionX Multimodal Sample Dataset
2
+
3
+ This repository contains multimodal dataset capturing synchronized vision and tactile glove data across distinct tasks.
4
+
5
+ ## Dataset Overview
6
+
7
+ * **RGB Video:** 30 Hz 720p color stream (`.mp4`).
8
+ * **Depth Data:** Lossless 16-bit depth stream (`.mkv`) and raw 16-bit PNG frames.
9
+ * **Mono Vision:** Left and right monochrome camera views (raw PNG).
10
+ * **Tactile Data:** Per-frame aligned glove sensor data stored in high-performance `.parquet` format.
11
+ * **Calibration:** Intrinsic and extrinsic parameters provided in `.json`.
12
+
13
+ ---
14
+
15
+ ## Repository Structure
16
+
17
+ The dataset is organized by task. To optimize performance, raw image frames are compressed into modality-specific ZIP archives.
18
+
19
+ ```text
20
+ dataset/
21
+ ├── dataset_info.json # Global dataset metadata
22
+ ├─�� [task_name]/ # e.g., box_cut1, drill1, waterpour3
23
+ │ ├── depth.mkv # Post-processed depth video
24
+ │ ├── rgb.mp4 # Post-processed RGB video
25
+ │ ├── preview_all.mp4 # Synced visualization (Grid view)
26
+ │ ├── preview_glove.mp4 # Tactile data visualization
27
+ │ ├── frames.parquet # Main data index (Timestamps + Tactile)
28
+ │ ├── calib.json # Calibration matrices
29
+ │ ├── video_meta.json # Post-processed video specifications
30
+ │ ├── depth.zip # Raw 16-bit PNG frames
31
+ │ ├── mono_left.zip # Raw mono-left PNG frames
32
+ │ ├── mono_right.zip # Raw mono-right PNG frames
33
+ │ └── rgb.zip # Raw RGB JPG frames
34
+ ```
35
+
36
+ ## Tactile Data Schema (`frames.parquet`)
37
+
38
+ The `frames.parquet` file is the central index for the dataset, providing per-frame synchronization between vision and tactile sensors.
39
+
40
+ ### 1. Vision & Synchronization
41
+ | Column | Description |
42
+ | :--- | :--- |
43
+ | `frame_idx` | Integer index of the frame. |
44
+ | `timestamp` | Global synchronized UNIX timestamp. |
45
+ | `rgb_path`, `depth_path` | Relative paths to the original RGB and Depth images. |
46
+ | `mono_left_path`, `mono_right_path` | Relative paths to the monochrome stereo images. |
47
+
48
+ ### 2. Camera IMU (OAK-D)
49
+ | Column | Description |
50
+ | :--- | :--- |
51
+ | `oak_imu_quaternion` | 4-element orientation vector (W, X, Y, Z). |
52
+ | `oak_imu_gyro` | Angular velocity (rad/s) for X, Y, Z axes. |
53
+ | `oak_imu_accel` | Linear acceleration (m/s²) for X, Y, Z axes. |
54
+
55
+ ### 3. Tactile Glove Data (Left Hand: `lh_`, Right Hand: `rh_`)
56
+ Each hand contains independent timestamping and comprehensive pressure/bend sensing:
57
+
58
+ | Feature | Columns |
59
+ | :--- | :--- |
60
+ | **Glove Timing** | `_glove_timestamp`, `_glove_dt_ms` |
61
+ | **Raw Pressure** | `_thumb_pressure`, `_index_pressure`, `_middle_pressure`, `_ring_pressure`, `_little_pressure`, `_palm_pressure` |
62
+ | **Calibrated Pressure** | `_thumb_pressure_cal`, `_index_pressure_cal`, `_middle_pressure_cal`, `_ring_pressure_cal`, `_little_pressure_cal`, `_palm_pressure_cal` |
63
+ | **Finger Kinematics** | `_finger_bend` (Raw), `_finger_bend_cal` (Calibrated) |
64
+ | **Glove IMU** | `_imu_quaternion`, `_imu_gyro`, `_imu_accel` |
65
+
66
+ ---
67
+
68
+ ## How to Use
69
+
70
+ ### 1. Download the Dataset
71
+ You can clone this repository using Git LFS or use the `huggingface_hub` library:
72
+
73
+ ```python
74
+ from huggingface_hub import snapshot_download
75
+
76
+ # Download the specific task you need
77
+ snapshot_download(
78
+ repo_id="touchtronix/FusionX-Multimodal-Sample-Data-V2",
79
+ repo_type="dataset",
80
+ allow_patterns="box_cut1/*"
81
+ )
82
+ ```
83
+ ### 2. Accessing Raw Frames
84
+ If you require the original image files instead of the video streams, extract the modality zips within the task folder:
85
+
86
+ ```bash
87
+ unzip box_cut1/rgb.zip -d box_cut1/rgb/
88
+ ```
89
+ ---
90
+
91
+ ## License
92
+
93
+ **Creative Commons Attribution 4.0 (CC BY 4.0)** You are free to:
94
+ * **Use:** Incorporate the data into your own projects.
95
+ * **Share:** Copy and redistribute the material in any medium or format.
96
+ * **Modify:** Remix, transform, and build upon the material.
97
+ * **Commercial Use:** Use the data for commercial purposes.
98
+
99
  *As long as appropriate attribution is provided to **Touchtronix Robotics**.*