Upload README.md

README.md

@@ -1,7 +1,74 @@
----
-language:
-- en
-tags:
-- Novel-View-Synthesis
-- 3D-Reconstruction
----
+# RefRef: A Synthetic Dataset and Benchmark for Reconstructing Scenes with Refractive and Reflective Objects
+
+## Overview
+**RefRef** is a synthetic dataset and benchmark for reconstructing scenes with **Ref**ractive-**Ref**lective objects. Our dataset includes 50 objects with varying complexity, from single-material to multi-material compositions with different Indices of Refraction (IoRs) and transparency levels. Each object is placed in two distinct scenes featuring ornate textures and patterns, resulting in 100 scenes in total.
+
+## Directory Structure
+
+```plaintext
+RefRef_Dataset/
+├── README.md
+├── dataset_info/                 # Metadata and dataset description files
+│   ├── object_list.txt
+│   ├── scene_list.txt
+│   └── IoR_info.json             # IoR values mapped to each object
+├── image_data/                   # Rendered images, depth maps, and masks for each object
+│   ├── textured_cube_scene/
+│   │   └── {simple_shapes, complex_shapes, household_items, lab_equipment}/
+│   │       └── {object_name}/
+│   │           ├── train/        # Training set
+│   │           │   ├── r_0.png              # RGB image
+│   │           │   ├── r_0_depth_0000.png   # Depth map
+│   │           │   ├── r_0_mask_0000.png    # Mask
+│   │           │   ├── r_1.png
+│   │           │   ├── r_1_depth_0000.png
+│   │           │   ├── r_1_mask_0000.png
+│   │           │   └── ...
+│   │           ├── val/          # Validation set
+│   │           ├── test/         # Testing set
+│   │           ├── transforms_train.json
+│   │           ├── transforms_val.json
+│   │           └── transforms_test.json
+│   ├── textured_sphere_scene/
+│       └── ...
+├── mesh_files/                   # 3D mesh files (.ply format) for each object
+│   └── {simple_shapes, complex_shapes, household_items, lab_equipment}/
+│       └── ...
+├── blender_files/                # Blender source files for each object, organised by scene
+│   ├── bgpanels_cube/            # Background panels for cube scene
+│   ├── bgpanels_sphere/          # Background panels for sphere scene
+│   └── {textured_cube_scene, textured_sphere_scene}/
+│       └── ...
+└── benchmarks/                   # Benchmark results from various methods
+    ├── oracle_method/
+    ├── Zip-NeRF/
+    ├── Ray Deformation/
+    ├── MS-NeRF/
+    ├── NeUS/
+    └── ...
+```
+
+## Object and Scenes
+
+The dataset includes 50 objects categorised into four groups based on their complexity, material composition, and shape:
+1. **simple_shapes**: Basic geometries with single material.
+2. **complex_shapes**: Intricate geometries with single material, such as sculptures.
+3. **household_items**: Objects with potentially mixed materials, including items like wine glasses, plastic bottles, and teapots.
+4. **lab_equipment**: Laboratory objects that may include single and multi-material compositions, such as beakers and test tubes.
+
+Each object is placed in two distinct scenes:
+- `textured_cube_scene/`: Objects placed within a textured cube environment.
+- `textured_sphere_scene/`: Objects placed within a textured sphere environment.
+
+## IoR Information
+
+A single JSON file, `IoR_info.json`, will be provided in the `dataset_info/` directory. This file maps each object (by filename) to its Index of Refraction (IoR) values. This helps in identifying the IoR for each `.ply` file in `mesh_files`.
+
+Example format for `IoR_info.json`:
+```json
+{
+  "cube.ply": {"IoR": 1.5},
+  "diamond.ply": {"IoR": 2.4},
+  "wine_glass_with_wine.ply": {"IoR": {"glass": 1.5, "wine": 1.33}},
+  ...
+}