added Sparsh pose estimation dataset

README.md

@@ -0,0 +1,105 @@
+---
+license: cc-by-nc-4.0
+tags:
+- sparsh
+- DIGIT
+- pose estimation
+- slip detection
+---
+
+# Dataset Details
+
+This dataset contains time-synchronized pairs of DIGIT images and SE(3) object poses. In our setup, the robot hand is stationary with its palm facing downwards and pressing against the object on a table. The robot hand has DIGIT sensors mounted on the index, middle, and ring fingertips, all of which are in contact with the object. A human manually perturbs the object's pose by translating and rotating it in SE(2). We use tag tracking to obtain the object's pose. We collect data using two objects: a Pringles can and the YCB sugar box, both of which have a tag fixed to their top surfaces. The following image illustrates our setting:
+
+![](assets/pose_estimation.png)
+
+This dataset is part of TacBench for evaluating Sparsh touch representations. For more information, please visit https://sparsh-ssl.github.io/.
+
+## Uses
+
+This dataset contains aligned DIGIT tactile data and world frame object poses. It is designed to evaluate the performance of [Sparsh encoders](https://huggingface.co/collections/facebook/sparsh-67167ce57566196a4526c328) in enhancing perception by predicting relative pose changes with respect to the sensor gel of the fingers,  denoted as $S_t^{t-H} \triangleq (\Delta x, \Delta y, \Delta \theta)  \in \mathbf{SE}(2)$, where H is the time stride.
+
+For more information on how to use this dataset and set up corresponding downstream tasks, please refer to the [Sparsh repository](https://github.com/facebookresearch/sparsh).
+
+
+## Dataset Structure
+
+The dataset is a collection of sequences where a human manually perturbs the object's pose. We collect data using two objects: a Pringles can and the YCB sugar box. Each sequence corresponds to a pickle file containing the following labeled data:
+
+- DIGIT tactile images for index, middle and ring fingers
+- Object pose tracked from tag in format (x, y, z, qw, qx, qy, qz)
+- Robot hand joint positions
+- `object_index_rel_pose_n5`: the pose change within the last 5 samples as a transformation matrix. The object pose is with respect to the index finger.
+- `object_middle_rel_pose_n5`: the pose change within the last 5 samples as a transformation matrix. The object pose is with respect to the middle finger.
+- `object_ring_rel_pose_n5`: the pose change within the last 5 samples as a transformation matrix. The object pose is with respect to the ring finger.
+
+We also provide reference (no contact) images for each of the DIGITs to facilitate pre-processing such as background subtraction.
+
+```bash
+train
+├── pringles 
+│   ├── bag_00.pkl
+│   ├── ...
+│   ├── bag_37.pkl
+│   ├── bag_38.pkl
+├── sugar 
+│   ├── ...
+test
+├── pringles 
+│   ├── bag_00.pkl
+│   ├── ...
+│   ├── bag_05.pkl
+│   ├── bag_06.pkl
+├── sugar 
+│   ├── ...
+bgs
+├── digit_index.png
+├── digit_index.png
+├── digit_index.png
+```
+
+The following code is an example about how to load the data:
+
+```python
+def load_bin_image(io_buf):
+    img = Image.open(io.BytesIO(io_buf))
+    img = np.array(img)
+    return img
+
+def load_dataset_poses(dataset_name, finger_type, t_stride):
+    path_data = f"{dataset_name}.pkl"
+
+    with open(path_data, "rb") as file:
+        data = pickle.load(file)
+
+    idx_max = np.min(
+        [
+            len(data[f"digit_{finger_type}"]),
+            len(data[f"object_{finger_type}_rel_pose_n{t_stride}"]),
+        ]
+    )
+
+    dataset_digit = data[f"digit_{finger_type}"][:idx_max]
+    dataset_poses = data[f"object_{finger_type}_rel_pose_n{t_stride}"][:idx_max]
+
+    return dataset_digit, dataset_poses
+
+dataset_digit, dataset_poses = load_dataset_poses("train/pringles/bag_00.pkl", "ring", 5)
+delta_rel_pose_gt = dataset_poses[0]
+img = load_bin_image(dataset_digit[0])
+```
+
+Please refer to [Sparsh repository](https://github.com/facebookresearch/sparsh) for further information about using the pose estimation dataset and downstream task training.
+
+## BibTeX entry and citation info
+
+```bibtex
+@inproceedings{
+    higuera2024sparsh,
+    title={Sparsh: Self-supervised touch representations for vision-based tactile sensing},
+    author={Carolina Higuera and Akash Sharma and Chaithanya Krishna Bodduluri and Taosha Fan and Patrick Lancaster and Mrinal Kalakrishnan and Michael Kaess and Byron Boots and Mike Lambeta and Tingfan Wu and Mustafa Mukadam},
+    booktitle={8th Annual Conference on Robot Learning},
+    year={2024},
+    url={https://openreview.net/forum?id=xYJn2e1uu8}
+}
+```

test/pringles/bag_00.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:16ae6c582a2005944d11a61931b46a5acd4914ca09b6ff704b2a7edf2c734533
+size 240924797

test/pringles/bag_01.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:affd014133b2deb85bf13b645715c3f5747a19600516aaf36cd5d09aadd1a0e0
+size 245475933

test/pringles/bag_02.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:51766daf41421d00a385e818bf135ac155a3805555ba806413b56a01705def36
+size 343950202

test/pringles/bag_03.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:00e5038654bbd03a99ebc3fecc6ea8ee1e23a421743a68eee38d0b063cd7a721
+size 408703619

test/pringles/bag_04.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:2ab344c5f2a812318d103d760cf1b9b8a0270091018ff31a581032f3e16b77db
+size 304104254

test/pringles/bag_05.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:c0431b3a897441d89a9c8948f3589efb4c6a922b0f4a38d80c153ff740494e2d
+size 306850664

test/pringles/bag_06.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ca67710137b2619a050f06fca7793b4fcee9aba06383ea940d5f1bba60752ae0
+size 303287913

test/sugar/bag_00.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:706df05a9c2e4f2a1a0847594e1a089a068db050bf7a34afa147d8870cfe5291
+size 372216382

test/sugar/bag_01.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d6323a2f777d578dc222232190ae47b04ae93a41e9f51c20aac24e535d2b2062
+size 247409141

test/sugar/bag_02.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:e8a49537383eac86df97911a089e5a5cd9d200c9fb45ab0886220347afb7d6e6
+size 173647736

test/sugar/bag_03.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6e637588bf8f0489f36dca3c512e89882b4f9398d8f80187cceae385e2f9ea53
+size 175087385

test/sugar/bag_04.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:fc5395648f0b4ff1bab1062a734dcd1631aa4c10aea502166c0e15153a999c21
+size 213606261

test/sugar/bag_05.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:63855e74e4691011ae01831a66bebb68b59cab9591a96a59f44ddd2382454aec
+size 181587944

test/sugar/bag_06.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:76afcf0fbff2d1fc301ab08058340650e3032fe6c6791df3749143b678c91710
+size 223213169

train/pringles/bag_00.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:16ae6c582a2005944d11a61931b46a5acd4914ca09b6ff704b2a7edf2c734533
+size 240924797

train/pringles/bag_01.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:affd014133b2deb85bf13b645715c3f5747a19600516aaf36cd5d09aadd1a0e0
+size 245475933

train/pringles/bag_02.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:51766daf41421d00a385e818bf135ac155a3805555ba806413b56a01705def36
+size 343950202

train/pringles/bag_03.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:00e5038654bbd03a99ebc3fecc6ea8ee1e23a421743a68eee38d0b063cd7a721
+size 408703619

train/pringles/bag_05.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:db973dbb7f485d5d8041b8bc195d6c57ae8ff2224db4454b646b3000c00c6608
+size 319458465

train/pringles/bag_06.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:651f087f32c8a3deb9bcb26007c422afe7e2b0d213c243da3732e1a541f0a38a
+size 376866045

train/pringles/bag_07.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:3896808ce048cf2070a5e5a30701a5dc1145cbcbe57ea340de77a680eb5cce40
+size 304075627

train/pringles/bag_08.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d0b41fa664e664351a6b5c5455fbfa823ea5c4ccd7339242b295ea5106741bb5
+size 303866836

train/pringles/bag_09.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:da3ca94ad44616831a28e07b38b17edc5971d5515201a69f5bfaddc4a2335fb4
+size 364318120

train/pringles/bag_10.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b0f10bef040fbaab46174f02a690f15433be6ce0a2cf735714464becc1a168f2
+size 344882006

train/pringles/bag_11.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:dd25356a9f69891a285a107b0fe7aff75eba224577cb3bde704144869df28504
+size 305109040

train/pringles/bag_12.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8295ce012fb6b63a455be9b4a4c4e5ca108dd359eb47a09f03980a22502fba0f
+size 289103858

train/pringles/bag_13.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:af113b7d070cad2d1870ec01daa6a62ebe535f56c5497d262537d3e583ab314c
+size 290827526

train/pringles/bag_14.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ac929f52e8a9d3c79a9864ab20b36a294c200fbe144898fc56581c80e8d8eb41
+size 276986683

train/pringles/bag_15.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:7959685a1a77aab58a15bac08bcd9763f617fd5c80a0a53ff96c028abe522f28
+size 304116822

train/pringles/bag_16.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:0073ad666e2244133c04883b4249cd64c6492dc87d0b7e25b5ddb6c591c0f3c9
+size 333445056

train/pringles/bag_18.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:f6ee569a13db039f360aacd9ca175770d6bcb07cf08d897e776b76d7c035ee09
+size 246124059

train/pringles/bag_19.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:8e9cea826957762b2916f5b98dceac5f837ad946b2fd1695af516c97b56a8641
+size 213988998

train/pringles/bag_20.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4f41b90aaf963248e7a0da8265f1f01608970f5c3eebab61b84a90bae92cd2b5
+size 294517054

train/pringles/bag_21.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:49fac4c4d6759e84a2a6a18724161595b8e0e601e7d5d5722f73add612c7b14b
+size 213362085

train/pringles/bag_22.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:f842a2f334ff9bf677dc9a58d4c13c8e5be91160fec3456bbe77646258ab276d
+size 415407096

train/pringles/bag_23.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:52e29a4b5ae4cdc4a5e35b2dfba8ef4e1d95053ae933130ca40ef7f7fe9e0c42
+size 302594515

train/pringles/bag_24.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:57151a2d7c94f6138d9b8b0960da34c8f86f8b6202ff8a4968a68212c42d7d8a
+size 275028791

train/pringles/bag_25.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:53680b805160bbaf504adc6aea3b3b90d5f8bcaeaaa81a9ab21591e3c8ed4683
+size 272336486

train/pringles/bag_26.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:4fd7f2e40dade7b8b7bcc59e9aba0cead51a30f6f7e97c6440cf55cd21c31797
+size 325596507

train/pringles/bag_27.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:297ec415b92a336c91239fb2e8e505ed28d43711b0b911447533a6ec082acb5c
+size 317450270

train/pringles/bag_28.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:a57dde77374a620953063f5db72efa18b5b6c70fb68063c69ef81932c2fd415f
+size 419279243

train/pringles/bag_29.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ba88415598822622eeb1290d82470b5f98da214b60f815c7eccaacca10f2b6b4
+size 378926583

train/pringles/bag_31.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:70008e41165175a7c29ad702a1963180381d1a53022fb2c5d3a75a89c82dca92
+size 319933048

train/pringles/bag_32.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:ded6e516637b14e0df5003434f51b637e7f8bc2fd571c99717fcdb6c31db0846
+size 265241037

train/pringles/bag_34.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:2f88b7cb1d8e72cc015ca5628c7d1e8165daa30d0eea4da4194883286079b17a
+size 338297793