diff --git a/README.md b/README.md index 41136e0fd3..3ac31ba5ed 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,7 @@ BIDS currently supports the following data modalities with more to come in the f - behavioral - physiological - PET +- microscopy # Formatting your data with BIDS diff --git a/mkdocs.yml b/mkdocs.yml index 08f809aa0e..0f37932c70 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -39,6 +39,7 @@ nav: - Behavioral experiments (with no neural recordings): 04-modality-specific-files/07-behavioral-experiments.md - Genetic Descriptor: 04-modality-specific-files/08-genetic-descriptor.md - Positron Emission Tomography: 04-modality-specific-files/09-positron-emission-tomography.md + - Microscopy: 04-modality-specific-files/10-microscopy.md - Derivatives: - BIDS Derivatives: 05-derivatives/01-introduction.md - Common data types and metadata: 05-derivatives/02-common-data-types.md diff --git a/src/02-common-principles.md b/src/02-common-principles.md index 337705235c..0736457e1c 100644 --- a/src/02-common-principles.md +++ b/src/02-common-principles.md @@ -56,6 +56,7 @@ misunderstanding we clarify them here. 1. `ieeg` (intracranial electroencephalography) 1. `beh` (behavioral) 1. `pet` (positron emission tomography) + 1. `micr` (microscopy) Data files are contained in a directory named for the data type. In raw datasets, the data type directory is nested inside subject and diff --git a/src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md b/src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md index a6c911a2c4..5422515ad8 100644 --- a/src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md +++ b/src/04-modality-specific-files/01-magnetic-resonance-imaging-data.md @@ -17,7 +17,7 @@ by Ben Inglis. "Manufacturer": ("RECOMMENDED", "Corresponds to DICOM Tag 0008, 0070 `Manufacturer`."), "ManufacturersModelName": ("RECOMMENDED", "Corresponds to DICOM Tag 0008, 1090 `Manufacturers Model Name`."), "DeviceSerialNumber": ("RECOMMENDED", "Corresponds to DICOM Tag 0018, 1000 `DeviceSerialNumber`."), - "StationName": "RECOMMENDED", + "StationName": ("RECOMMENDED", "Corresponds to DICOM Tag 0008, 1010 `Station Name`."), "SoftwareVersions": ("RECOMMENDED", "Corresponds to DICOM Tag 0018, 1020 `Software Versions`."), "HardcopyDeviceSoftwareVersion": "DEPRECATED", "MagneticFieldStrength": "RECOMMENDED, but REQUIRED for Arterial Spin Labeling", diff --git a/src/04-modality-specific-files/09-positron-emission-tomography.md b/src/04-modality-specific-files/09-positron-emission-tomography.md index 134512b81d..70e6d77f18 100644 --- a/src/04-modality-specific-files/09-positron-emission-tomography.md +++ b/src/04-modality-specific-files/09-positron-emission-tomography.md @@ -143,7 +143,7 @@ which we divide into several categories: "InstitutionName": ("RECOMMENDED", "Corresponds to DICOM Tag 0008, 0080 `InstitutionName`."), "InstitutionAddress": ("RECOMMENDED", "Corresponds to DICOM Tag 0008, 0081 `InstitutionAddress`."), "InstitutionalDepartmentName": ("RECOMMENDED", "Corresponds to DICOM Tag 0008, 1040 `Institutional Department Name`."), - "BodyPart": "RECOMMENDED", + "BodyPart": ("RECOMMENDED", "Corresponds to DICOM Tag 0018, 0015 `Body Part Examined`."), } ) }} diff --git a/src/04-modality-specific-files/10-microscopy.md b/src/04-modality-specific-files/10-microscopy.md new file mode 100644 index 0000000000..efb1542c52 --- /dev/null +++ b/src/04-modality-specific-files/10-microscopy.md @@ -0,0 +1,439 @@ +# Microscopy + +Support for Microscopy was developed as a +[BIDS Extension Proposal](../07-extensions.md#bids-extension-proposals). + +Please see [Citing BIDS](../01-introduction.md#citing-bids) +on how to appropriately credit this extension when referring to it in the +context of the academic literature. + +Microscopy datasets formatted using this specification are available on the +[BIDS examples repository](https://github.com/bids-standard/bids-examples#microscopy-datasets) +and can be used for practical guidance when curating a new dataset. + +Further Microscopy datasets are available: + +- In PNG format: [`data_axondeepseg_sem`](https://doi.org/10.5281/zenodo.5498378) +- In OME-TIFF format: [`Broca's Area Light-Sheet Microscopy`](https://doi.org/10.5281/zenodo.5517223) + +## Microscopy imaging data + +{{ MACROS___make_filename_template(datatypes=["micr"], suffixes=["TEM", "SEM", "uCT", "BF", "DF", +"PC", "DIC", "FLUO", "CONF", "PLI", "CARS", "2PE", "MPE", "SR", "NLO", "OCT", "SPIM"], n_dupes_to_combine=4) }} + +Microscopy data MUST be stored in the `micr` directory. + +### File formats +The Microscopy community uses a variety of formats for storing raw data, and there is no single +standard that all researchers agree on. However, a standardized file structure has been developed +by the [Open Microscopy Environment](https://www.openmicroscopy.org/) for whole-slide imaging with +the [OME-TIFF file specifications](https://docs.openmicroscopy.org/ome-model/6.1.2/ome-tiff/file-structure.html). +The OME-TIFF file allows for multi-page TIFF files to store multiple image planes and supports +multi-resolution pyramidal tiled images. An OME-XML data block is also embedded inside the +file’s header. + +The BIDS standard accepts microscopy data in a number of file formats to accommodate datasets +stored in 2D image formats and whole-slide imaging formats, to accommodate lossless and lossy +compression, and to avoid unnecessary conversions of the original data from a non-tiled to a +tiled format, or vice-versa. + +Microscopy raw data MUST be stored in one of the following formats: + +- [Portable Network Graphics](http://www.libpng.org/pub/png/) (`.png`) + +- [Tag Image File Format](https://www.adobe.io/open/standards/TIFF.html) (`.tif`) + +- [OME-TIFF](https://docs.openmicroscopy.org/ome-model/6.1.2/ome-tiff/specification.html#) + (`.ome.tif` for standard TIFF files or `.ome.btf` for + [BigTIFF](https://www.awaresystems.be/imaging/tiff/bigtiff.html) files) + +If different from PNG, TIFF or OME-TIFF, the original unprocessed data in the native format MAY be +stored in the [`/sourcedata` directory](../02-common-principles.md#source-vs-raw-vs-derived-data). + +Future versions may extend this list of supported file formats, for example with the +Next-Generation File Formats currently developed by OME ([OME-NGFF](https://ngff.openmicroscopy.org/latest/)) +as a successor to OME-TIFF for better remote sharing of large datasets. + +### Modality suffixes +Microscopy data currently support the following imaging modalities: + +{{ MACROS___make_suffix_table( + [ + "TEM", + "SEM", + "uCT", + "BF", + "DF", + "PC", + "DIC", + "FLUO", + "CONF", + "PLI", + "CARS", + "2PE", + "MPE", + "SR", + "NLO", + "OCT", + "SPIM", + ] + ) +}} + +### Filename entities + +In the context of Microscopy, a session ([`ses-