Chris Oswald
commited on
Commit
·
73fde29
1
Parent(s):
bf6091f
updated README
Browse files
README.md
CHANGED
|
@@ -113,12 +113,14 @@ changes can be loaded with the corresponding image data.
|
|
| 113 |
This version of the SPIDER dataset (i.e., available through the HuggingFace `datasets` library) differs from the original
|
| 114 |
data available on [Zenodo](https://zenodo.org/records/8009680) in two key ways:
|
| 115 |
|
| 116 |
-
1. Image Rescaling/Resizing: The original 3D volumetric MRI data
|
| 117 |
-
To enable the data to be loaded through the HuggingFace `datasets` library, all 447 MRI series
|
| 118 |
-
|
|
|
|
|
|
|
| 119 |
If you need a different standardization, you have two options:
|
| 120 |
|
| 121 |
-
i. Pass your preferred
|
| 122 |
|
| 123 |
ii. After loading the dataset from HuggingFace, use the `SimpleITK` library to import each image using the file path of the locally cached .mha file.
|
| 124 |
The local cache file path is provided for each example when iterating over the dataset (again, see the [LoadData Tutorial](placeholder)).
|
|
@@ -142,9 +144,9 @@ The format for each generated data instance is as follows:
|
|
| 142 |
|
| 143 |
2. **scan_type**: an indicator for whether the image is a T1-weighted, T2-weighted, or T2-SPACE MRI
|
| 144 |
|
| 145 |
-
3. **image**: a
|
| 146 |
|
| 147 |
-
4. **mask**: a
|
| 148 |
|
| 149 |
- 0 = background
|
| 150 |
- 1-25 = vertebrae (numbered from the bottom, i.e., L5 = 1)
|
|
@@ -235,7 +237,7 @@ An additional hidden test set provided by the paper authors
|
|
| 235 |
> Sagittal T2 SPACE sequence images had a near isotropic spatial resolution with a voxel size of 0.90 x 0.47 x 0.47 mm.
|
| 236 |
> (https://spider.grand-challenge.org/data/)
|
| 237 |
|
| 238 |
-
Note that all images are rescaled to have
|
| 239 |
for compatibility with the HuggingFace `datasets` library. If you want to use the original resolution, you can
|
| 240 |
load the original images from the local cache indicated in each example's `image_path` and `mask_path` features.
|
| 241 |
See the [tutorial](tutorials/load_data.ipynb) for more information.
|
|
@@ -257,6 +259,6 @@ against the original data provided by the researchers on [Zenodo](https://zenodo
|
|
| 257 |
|
| 258 |
### Known Issues/Bugs
|
| 259 |
|
| 260 |
-
1. Serializing data into Apache Arrow format is required to make the dataset available via HuggingFace's `datasets` library. However, it
|
| 261 |
mask integer values that do not map exactly to a defined [anatomical feature category](https://grand-challenge.org/algorithms/spider-baseline-iis/).
|
| 262 |
See the data loading [tutorial](tutorials/load_data.ipynb) for more information and temporary work-arounds.
|
|
|
|
| 113 |
This version of the SPIDER dataset (i.e., available through the HuggingFace `datasets` library) differs from the original
|
| 114 |
data available on [Zenodo](https://zenodo.org/records/8009680) in two key ways:
|
| 115 |
|
| 116 |
+
1. Image Rescaling/Resizing: The original 3D volumetric MRI data are stored as .mha files and do not have a standardized height, width, depth, and image resolution.
|
| 117 |
+
To enable the data to be loaded through the HuggingFace `datasets` library, all 447 MRI series are standardized to have height and width of `(512, 512)` and (unsigned) 16-bit integer resolution.
|
| 118 |
+
Segmentation masks have the same height and width dimension but are (unsigned) 8-bit integer resolution.
|
| 119 |
+
The depth dimension has not been modified; rather, each scan is formatted as a sequence of `(512, 512)` grayscale images, where the index in the sequence indicates the depth value.
|
| 120 |
+
N-dimensional interpolation is used to resize and/or rescale the images (via the `skimage.transform.resize` and `skimage.img_as_uint` functions).
|
| 121 |
If you need a different standardization, you have two options:
|
| 122 |
|
| 123 |
+
i. Pass your preferred height and width size as a `Tuple[int, int]` to the `resize_shape` argument in `load_dataset` (see the [LoadData Tutorial](placeholder)); OR
|
| 124 |
|
| 125 |
ii. After loading the dataset from HuggingFace, use the `SimpleITK` library to import each image using the file path of the locally cached .mha file.
|
| 126 |
The local cache file path is provided for each example when iterating over the dataset (again, see the [LoadData Tutorial](placeholder)).
|
|
|
|
| 144 |
|
| 145 |
2. **scan_type**: an indicator for whether the image is a T1-weighted, T2-weighted, or T2-SPACE MRI
|
| 146 |
|
| 147 |
+
3. **image**: a sequence of 2-dimensional grayscale images of the MRI scan
|
| 148 |
|
| 149 |
+
4. **mask**: a sequence of 2-dimensional values indicating the following segmented anatomical feature(s):
|
| 150 |
|
| 151 |
- 0 = background
|
| 152 |
- 1-25 = vertebrae (numbered from the bottom, i.e., L5 = 1)
|
|
|
|
| 237 |
> Sagittal T2 SPACE sequence images had a near isotropic spatial resolution with a voxel size of 0.90 x 0.47 x 0.47 mm.
|
| 238 |
> (https://spider.grand-challenge.org/data/)
|
| 239 |
|
| 240 |
+
Note that all images are rescaled to have unsigned 16-bit integer resolution
|
| 241 |
for compatibility with the HuggingFace `datasets` library. If you want to use the original resolution, you can
|
| 242 |
load the original images from the local cache indicated in each example's `image_path` and `mask_path` features.
|
| 243 |
See the [tutorial](tutorials/load_data.ipynb) for more information.
|
|
|
|
| 259 |
|
| 260 |
### Known Issues/Bugs
|
| 261 |
|
| 262 |
+
1. Serializing data into Apache Arrow format is required to make the dataset available via HuggingFace's `datasets` library. However, it can introduce some segmentation
|
| 263 |
mask integer values that do not map exactly to a defined [anatomical feature category](https://grand-challenge.org/algorithms/spider-baseline-iis/).
|
| 264 |
See the data loading [tutorial](tutorials/load_data.ipynb) for more information and temporary work-arounds.
|