Draft BEP031

mkdocs.yml

@@ -37,6 +37,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

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.  `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

src/99-appendices/04-entity-table.md

@@ -36,3 +36,7 @@ while entity definitions are in [Appendix IX](09-entities.md).
 ## Behavioral Data
 
 {{ MACROS___make_entity_table(datatypes=["beh"], auxdatatypes=[]) }}
+
+## Microscopy
+
+{{ MACROS___make_entity_table(datatypes=["microscopy"], auxdatatypes=[]) }}

src/schema/datatypes/microscopy.yaml

@@ -0,0 +1,43 @@
+---
+# Microscopy
+- suffixes:
+    - TEM
+    - SEM
+    - CT
+    - BF
+    - DF
+    - PC
+    - DIC
+    - FLUO
+    - CONF
+    - PLI
+    - CARS
+    - 2PE
+    - MPE
+    - SR
+    - NLO
+    - OCT
+    - SPIM
+  extensions:
+    - .ome.tif
+    - .ome.btf
+    - .png
+    - .tiff
+    - .json
+  entities:
+    subject: required
+    session: optional
+    sample: required
+    chunk: optional
+    acquisition: optional
+    stain: optional
+    run: optional
+- suffixes:
+    - photo
+  extensions:
+    - .jpg
+  entities:
+    subject: required
+    session: optional
+    sample: required
+    acquisition: optional

src/schema/entities.yaml

@@ -38,6 +38,15 @@ sample:
     The label MUST be unique per subject and is RECOMMENDED to be unique
     throughout the dataset.
   format: label
+chunk:
+  name: Chunk
+  entity: chunk
+  description: |
+    The `chunk-<index>` key/value pair is used to distinguish between different
+    regions, 2D images or 3D volumes files, of the same physical sample with
+    different fields of view acquired in the same imaging experiment.
+  type: string
+  format: index
 task:
   name: Task
   entity: task
@@ -91,6 +100,17 @@ tracer:
     although the label may be different.
   type: string
   format: label
+stain:
+  name: Stain
+  entity: stain
+  description: |
+    The `stain-<label>` key/pair values can be used to distinguish image files
+    from the same sample using different stains or antibodies for contrast enhancement.
+    Stains or antibodies SHOULD be indicated as appropriate in the `SampleStaining`,
+    `SamplePrimaryAntibodies` and/or `SampleSecondaryAntobodies` keys in the JSON file,
+    although the label may be different.
+  type: string
+  format: label
 reconstruction:
   name: Reconstruction
   entity: rec

src/schema/modalities.yaml

@@ -27,3 +27,7 @@ pet:
   name: Positron Emission Tomography
   datatypes:
     - pet
+microscopy:
+  name: Microscopy
+  datatypes:
+    - microscopy