Skip to content

Commit

Permalink
Create segmentation-mask-v2.2.yaml
Browse files Browse the repository at this point in the history
Add top-level "extras" directory
  • Loading branch information
j-uranic authored Nov 14, 2024
1 parent 1d91919 commit f0b0234
Showing 1 changed file with 46 additions and 0 deletions.
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
files:
-
pattern: extras\/.*
required: True
description: Folder for general lab-specific files related to the dataset.
-
pattern: derived\/.*
required: True
description: The EPIC data is placed in TOP/derived/ so it does not conflict with any files if it is uploaded with a primary dataset.
-
pattern: derived\/extras\/.*
required: True
description: Folder for general lab-specific files related to the derived dataset.
-
pattern: derived\/segmentation_masks\/.*
required: True
description: Directory containing segmentation masks.
-
pattern: derived\/segmentation_masks\/[^\/]+\.segmentations\.ome\.tiff
required: True
description: The segmentation masks should be stored as multi-channel pyramidal OME TIFF bitmasks with one channel per mask, where a single mask contains all instances of a type of object (e.g., all cells, a class of FTUs, etc). The class of objects contained in the mask is documented in the segmentation-masks.csv file. Each individual object in a mask should be represented by a unique integer pixel value starting at 1, with 0 meaning background (e.g., all pixels belonging to the first instance of a T-cell have a value of 1, the pixels for the second instance of a T-cell have a value of 2, etc). The pixel values should be unique within a mask. FTUs and other structural elements should be captured the same way as cells with segmentation masks and the appropriate channel feature definitions.
is_qa_qc: False
-
pattern: derived\/segmentation_masks\/[^\/]+-objects\.(?:tsv|xlsx)
required: True
description: This is a matrix where each row describes an individual object (e.g., one row per cell in the case where a mask contains all cells) and columns are features (i.e., object type, marker intensity, classification strategies, etc). One file should be created per mask with the name of the mask prepended to the file name. For example, if there is a cell segmentation map called "cells" then you would include a file called "cells-objects.csv" and that file would contain one row per cell in the "cells" mask and one column per feature, such as marker intensity and/or cell type. A minimum set of fields (required and optional) is included below.
is_qa_qc: False
-
pattern: derived\/segmentation_masks\/[^\/]+-centroid-adjacency\.csv
required: False
description: Objects are required to be in the same mask. A separate centroid-adjacency file can be included per mask.
is_qa_qc: False
-
pattern: derived\/segmentation_masks\/[^\/]+-linkage-adjacency\.csv
required: False
description: Objects are required to be in the same mask. A separate linkage-adjacency file can be included per mask.
is_qa_qc: False
-
pattern: derived\/segmentation_masks\/[^\/]+-mesh\.glb
required: False
description: This is a file with 3D mesh images for a 3D map.
is_qa_qc: False
-
pattern: derived\/segmentation_masks\/transformations\/.*
required: False
description: This directory should include any transformation files that pertain to a 3D reconstruction from serial sections. The mask protocol should explain the structure of these transformation files and how they can be used to reconstruct the 3D map from the 2D sections.

0 comments on commit f0b0234

Please sign in to comment.