extras\/.*
| ✓ | Folder for general lab-specific files related to the dataset. [Exists in all assays] | |
+| extras\/microscope_hardware\.json
| ✓ | **[QA/QC]** A file generated by the micro-meta app that contains a description of the hardware components of the microscope. Email HuBMAP Consortium Help Desk extras\/microscope_settings\.json
| | **[QA/QC]** A file generated by the micro-meta app that contains a description of the settings that were used to acquire the image data. Email HuBMAP Consortium Help Desk raw\/.*
| ✓ | This is a directory containing raw data. | |
+| lab_processed\/images\/[^\/]+\.ome\.tiff
| ✓ | OME-TIFF file (multichannel, multi-layered) produced by the experiment. If compressed, must use loss-less compression algorithm. See the following link for the set of fields that are required in the OME TIFF file XML header. lab_processed\/images\/[^\/]*ome-tiff\.channels\.csv
| ✓ | This file should describe any processing that was done to generate the images in each channel of the accommpanying OME TIFF. The file should contain one row per OME TIFF channel. Two columns should be booleans "is this a channel to use for nuclei segmentation" and "is this a channel to use for cell segmentation". | |
+| lab_processed\/annotations\/.*
| | Directory containing segmentation masks. | |
+| lab_processed\/annotations\/[^\/]+\.segmentations\.ome\.tiff
| | 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. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/segmentation-masks\.csv
| | This file contains details about each mask, with one row per mask. Each column in this file contains details describing the mask (e.g., channel number, mask name, ontological ID, etc). Each mask is stored as a channel in the segmentations.ome.tiff file and the mask name should be ontologically based and linked to the ASCT+B table where possible. The number of rows in this file should equal the number of channels in the segmentations.ome.tiff. For example, one row in this file would ontologically describe cells, if the segmentations.ome.tiff file contained a mask of all cells. A minimum set of fields (required and optional) is included below. If multiple segmentations.ome.tiff files are used, this segmentation-masks.csv file should document the masks across all of the OME TIFF files. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/[^\/]+-objects\.csv
| | 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’s 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. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/[^\/]+\.geojson
| | A GeoJSON file(s) containing the geometries of each object within a mask. For example, if the mask contains multiple FTUs, multiple cells, etc, each of the objects in the mask would be independently documented in the GeoJSON file. There would be a single GeoJSON file per mask and the name of the file should be the name of the mask. If this file is generated by QuPath, the coordinates will be in pixel units with the origin (0, 0) as the top left corner of the full-resolution image. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/tissue-boundary\.geojson
| | **[QA/QC]** If the boundaries of the tissue have been identified (e.g., by manual efforts), then the boundary geometry can be included as a GeoJSON file named “tissue-boundary.geojson”. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/regions-of-concern\.csv
| | This file and the associated GeoJSON file can be used to denote any regions in the image that may contain QA/QC concerns. For example, if there are folds in the tissue, the region of the fold can be highlighted. This file should contain one row per region and include documentation about the region and why it's being flagged. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/regions-of-concern\.geojson
| | This file and the associated CSV file can be used to denote any regions in the image that may contain QA/QC concerns. For example, if there are folds in the tissue, the region of the fold can be highlighted. This file should contain the geometric coordinates of each region being flagged. | lab_processed\/annotations\/.* |
+| [^\/]*NAV[^\/]*\.tif
(example: NAV.tif
) | | Navigational Image showing Region of Interest (Keyance Microscope only) | |
+| [^\/]+\.pdf
(example: summary.pdf
) | | **[QA/QC]** PDF export of Powerpoint slide deck containing the Image Analysis Report | |
+| extras\/dir-schema-v2-with-dataset-json
| ✓ | Empty file whose presence indicates the version of the directory schema in use | |
+| processed\/drv_[^\/]*\/
| ✓ | Processed files produced by the Akoya software or alternative software. | |
+| raw\/cyc[^\/]*_reg[^\/]*\/.*
| ✓ | Intermediary directory | |
+| raw\/src_[^\/]*\/
| ✓ | Intermediary directory | |
+| raw\/cyc[^\/]*_reg[^\/]*\/[^\/]*_z[^\/]*_CH[^\/]*\.tif
| ✓ | TIFF files produced by the experiment. General folder format: Cycle(n)_Region(n)_date; General file format: name_tileNumber(n)_zplaneNumber(n)_channelNumber(n) | |
+| raw\/src_[^\/]*\/cyc[^\/]*_reg[^\/]*_[^\/]*\/[^\/]+\.gci
| | Group Capture Information File (Keyance Microscope only) | |
+| raw\/dataset\.json
(example: raw/dataset.json
) | ✓ | Data processing parameters file. This will include additional CODEX specific metadata needed for the HIVE processing workflow. | |
+| raw\/reg_[^\/]*\.png
(example: raw/reg_00.png
) | | Region overviews | |
+| raw\/experiment\.json
(example: raw/experiment.json
) | | JSON file produced by the Akoya software which contains the metadata for the experiment, including the software version used, microscope parameters, channel names, pixel dimensions, etc. (required for HuBMAP pipeline) | |
diff --git a/docs/enhanced-srs/current/index.md b/docs/enhanced-srs/current/index.md
index 09ed5590d..868a5ba3c 100644
--- a/docs/enhanced-srs/current/index.md
+++ b/docs/enhanced-srs/current/index.md
@@ -28,5 +28,38 @@ See the following link for the set of fields that are required in the OME TIFF f
extras\/.*
| ✓ | Folder for general lab-specific files related to the dataset. [Exists in all assays] | |
+| extras\/microscope_hardware\.json
| ✓ | **[QA/QC]** A file generated by the micro-meta app that contains a description of the hardware components of the microscope. Email HuBMAP Consortium Help Desk extras\/microscope_settings\.json
| ✓ | **[QA/QC]** A file generated by the micro-meta app that contains a description of the settings that were used to acquire the image data. Email HuBMAP Consortium Help Desk raw\/.*
| ✓ | Raw data files for the experiment. | |
+| raw\/channel_layout\.tsv
| ✓ | Table that includes a dictionary for channel to moiety, which may be a protein given in an OMAP panel or captured in the ASCT+B table. | |
+| raw\/lightpath_configuration\.tsv
| | This file documents the light path setttings not captured in the OME-TIFF - will be deprecated upon the implementation of MicroMeta. | |
+| raw\/fingerprint_layout\.tsv
| | Table that includes a dictionary for channel to moiety which is determined from spectral clustering and may include lipids, protein, etc. This file is specific to hyper-spectral imaging. | |
+| raw\/images\/.*
| ✓ | Raw image files. Using this subdirectory allows for harmonization with other imaging assays. [This directory must include at least one raw file.] | |
+| raw\/images\/[^\/]+\.(?:xml|nd2|oir|lif|czi|tiff)
| ✓ | Raw microscope file for the experiment | |
+| lab_processed\/.*
| ✓ | Experiment files that were processed by the lab generating the data. | |
+| lab_processed\/images\/.*
| ✓ | Processed image files | |
+| lab_processed\/images\/[^\/]+\.ome\.tiff
(example: lab_processed/images/HBM892.MDXS.293.ome.tiff
) | ✓ | OME-TIFF files (multichannel, multi-layered) produced by the microscopy experiment. If compressed, must use loss-less compression algorithm. See the following link for the set of fields that are required in the OME TIFF file XML header. lab_processed\/images\/[^\/]*ome-tiff\.channels\.csv
| ✓ | This file provides essential documentation pertaining to each channel of the accommpanying OME TIFF. The file should contain one row per OME TIFF channel. The required fields are detailed lab_processed\/transformations\/.*
| | This directory contains transformation matrices that capture how each modality is aligned with the other and can be used to visualize overlays of multimodal data. This is needed to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). In these cases data type may have different pixel sizes and slightly different orientations (i.e., one may be rotated relative to another). | |
+| lab_processed\/transformations\/[^\/]*transformations\.txt
| | Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). | |
+| qa_qc\/.*
| ✓ | Directory containing QA and/or QC information. | |
+| qa_qc\/resolution_report\/.*
| ✓ | Directory containing the results of resolution tests and/or vendor preventative maintenance reports. | |
+| qa_qc\/resolution_report\/resolution\.txt
| | This file summarizes the results of resolution tests or vendor reports from preventative maintenance visits. | |
+| qa_qc\/resolution_report\/[^\/]+\.pdf
| | This file is a pdf from a vendor preventative maintenance visit or resolution check tool demonstrating resolution. This file may include illumination test results. | |
+| qa_qc\/illumination_report\/.*
| ✓ | Directory containing the results of illumination tests and/or vendor preventative maintenance reports. | |
+| qa_qc\/illumination_report\/illumination.txt
| | This file summarizes the results of illumination tests or vendor reports from preventative maintenance visits. | |
+| qa_qc\/illumination_report\/[^\/]+\.pdf
| | This file is a pdf from a vendor preventative maintenance visit or illumination check tool demonstrating illumination intensity. | |
+| lab_processed\/annotations\/.*
| | Directory containing segmentation masks. | |
+| lab_processed\/annotations\/[^\/]+\.segmentations\.ome\.tiff
| | 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. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/segmentation-masks\.csv
| | This file contains details about each mask, with one row per mask. Each column in this file contains details describing the mask (e.g., channel number, mask name, ontological ID, etc). Each mask is stored as a channel in the segmentations.ome.tiff file and the mask name should be ontologically based and linked to the ASCT+B table where possible. The number of rows in this file should equal the number of channels in the segmentations.ome.tiff. For example, one row in this file would ontologically describe cells, if the segmentations.ome.tiff file contained a mask of all cells. A minimum set of fields (required and optional) is included below. If multiple segmentations.ome.tiff files are used, this segmentation-masks.csv file should document the masks across all of the OME TIFF files. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/[^\/]+-objects\.csv
| | 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’s 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. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/[^\/]+\.geojson
| | A GeoJSON file(s) containing the geometries of each object within a mask. For example, if the mask contains multiple FTUs, multiple cells, etc, each of the objects in the mask would be independently documented in the GeoJSON file. There would be a single GeoJSON file per mask and the name of the file should be the name of the mask. If this file is generated by QuPath, the coordinates will be in pixel units with the origin (0, 0) as the top left corner of the full-resolution image. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/tissue-boundary\.geojson
| | **[QA/QC]** If the boundaries of the tissue have been identified (e.g., by manual efforts), then the boundary geometry can be included as a GeoJSON file named “tissue-boundary.geojson”. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/regions-of-concern\.csv
| | This file and the associated GeoJSON file can be used to denote any regions in the image that may contain QA/QC concerns. For example, if there are folds in the tissue, the region of the fold can be highlighted. This file should contain one row per region and include documentation about the region and why it's being flagged. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/regions-of-concern\.geojson
| | This file and the associated CSV file can be used to denote any regions in the image that may contain QA/QC concerns. For example, if there are folds in the tissue, the region of the fold can be highlighted. This file should contain the geometric coordinates of each region being flagged. | lab_processed\/annotations\/.* |
diff --git a/docs/mxif/current/index.md b/docs/mxif/current/index.md
index f7bb0c794..968d9f78d 100644
--- a/docs/mxif/current/index.md
+++ b/docs/mxif/current/index.md
@@ -26,3 +26,39 @@ If you are planning to submit new data of this assay type, reach out to help@hub
extras\/.*
| ✓ | Folder for general lab-specific files related to the dataset. [Exists in all assays] | |
+| extras\/microscope_hardware\.json
| ✓ | **[QA/QC]** A file generated by the micro-meta app that contains a description of the hardware components of the microscope. Email HuBMAP Consortium Help Desk extras\/microscope_settings\.json
| ✓ | **[QA/QC]** A file generated by the micro-meta app that contains a description of the settings that were used to acquire the image data. Email HuBMAP Consortium Help Desk raw\/.*
| ✓ | Raw data files for the experiment. | |
+| raw\/channel_layout\.tsv
| ✓ | Table that includes a dictionary for channel to moiety, which may be a protein given in an OMAP panel or captured in the ASCT+B table. | |
+| raw\/lightpath_configuration\.tsv
| | This file documents the light path setttings not captured in the OME-TIFF - will be deprecated upon the implementation of MicroMeta. | |
+| raw\/fingerprint_layout\.tsv
| | Table that includes a dictionary for channel to moiety which is determined from spectral clustering and may include lipids, protein, etc. This file is specific to hyper-spectral imaging. | |
+| raw\/images\/.*
| ✓ | Raw image files. Using this subdirectory allows for harmonization with other imaging assays. [This directory must include at least one raw file.] | |
+| raw\/images\/[^\/]+\.(?:xml|nd2|oir|lif|czi|tiff)
| ✓ | Raw microscope file for the experiment | |
+| lab_processed\/.*
| ✓ | Experiment files that were processed by the lab generating the data. | |
+| lab_processed\/images\/.*
| ✓ | Processed image files | |
+| lab_processed\/images\/[^\/]+\.ome\.tiff
(example: lab_processed/images/HBM892.MDXS.293.ome.tiff
) | ✓ | OME-TIFF files (multichannel, multi-layered) produced by the microscopy experiment. If compressed, must use loss-less compression algorithm. See the following link for the set of fields that are required in the OME TIFF file XML header. lab_processed\/images\/[^\/]*ome-tiff\.channels\.csv
| ✓ | This file provides essential documentation pertaining to each channel of the accommpanying OME TIFF. The file should contain one row per OME TIFF channel. The required fields are detailed lab_processed\/transformations\/.*
| | This directory contains transformation matrices that capture how each modality is aligned with the other and can be used to visualize overlays of multimodal data. This is needed to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). In these cases data type may have different pixel sizes and slightly different orientations (i.e., one may be rotated relative to another). | |
+| lab_processed\/transformations\/[^\/]*transformations\.txt
| | Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). | |
+| qa_qc\/.*
| ✓ | Directory containing QA and/or QC information. | |
+| qa_qc\/resolution_report\/.*
| ✓ | Directory containing the results of resolution tests and/or vendor preventative maintenance reports. | |
+| qa_qc\/resolution_report\/resolution\.txt
| | This file summarizes the results of resolution tests or vendor reports from preventative maintenance visits. | |
+| qa_qc\/resolution_report\/[^\/]+\.pdf
| | This file is a pdf from a vendor preventative maintenance visit or resolution check tool demonstrating resolution. This file may include illumination test results. | |
+| qa_qc\/illumination_report\/.*
| ✓ | Directory containing the results of illumination tests and/or vendor preventative maintenance reports. | |
+| qa_qc\/illumination_report\/illumination.txt
| | This file summarizes the results of illumination tests or vendor reports from preventative maintenance visits. | |
+| qa_qc\/illumination_report\/[^\/]+\.pdf
| | This file is a pdf from a vendor preventative maintenance visit or illumination check tool demonstrating illumination intensity. | |
+| lab_processed\/annotations\/.*
| | Directory containing segmentation masks. | |
+| lab_processed\/annotations\/[^\/]+\.segmentations\.ome\.tiff
| | 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. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/segmentation-masks\.csv
| | This file contains details about each mask, with one row per mask. Each column in this file contains details describing the mask (e.g., channel number, mask name, ontological ID, etc). Each mask is stored as a channel in the segmentations.ome.tiff file and the mask name should be ontologically based and linked to the ASCT+B table where possible. The number of rows in this file should equal the number of channels in the segmentations.ome.tiff. For example, one row in this file would ontologically describe cells, if the segmentations.ome.tiff file contained a mask of all cells. A minimum set of fields (required and optional) is included below. If multiple segmentations.ome.tiff files are used, this segmentation-masks.csv file should document the masks across all of the OME TIFF files. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/[^\/]+-objects\.csv
| | 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’s 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. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/[^\/]+\.geojson
| | A GeoJSON file(s) containing the geometries of each object within a mask. For example, if the mask contains multiple FTUs, multiple cells, etc, each of the objects in the mask would be independently documented in the GeoJSON file. There would be a single GeoJSON file per mask and the name of the file should be the name of the mask. If this file is generated by QuPath, the coordinates will be in pixel units with the origin (0, 0) as the top left corner of the full-resolution image. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/tissue-boundary\.geojson
| | **[QA/QC]** If the boundaries of the tissue have been identified (e.g., by manual efforts), then the boundary geometry can be included as a GeoJSON file named “tissue-boundary.geojson”. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/regions-of-concern\.csv
| | This file and the associated GeoJSON file can be used to denote any regions in the image that may contain QA/QC concerns. For example, if there are folds in the tissue, the region of the fold can be highlighted. This file should contain one row per region and include documentation about the region and why it's being flagged. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/regions-of-concern\.geojson
| | This file and the associated CSV file can be used to denote any regions in the image that may contain QA/QC concerns. For example, if there are folds in the tissue, the region of the fold can be highlighted. This file should contain the geometric coordinates of each region being flagged. | lab_processed\/annotations\/.* |
+
diff --git a/docs/second-harmonic-generation/current/index.md b/docs/second-harmonic-generation/current/index.md
index 132969088..35ae3bc3f 100644
--- a/docs/second-harmonic-generation/current/index.md
+++ b/docs/second-harmonic-generation/current/index.md
@@ -28,5 +28,38 @@ Related files:
extras\/.*
| ✓ | Folder for general lab-specific files related to the dataset. [Exists in all assays] | |
+| extras\/microscope_hardware\.json
| ✓ | **[QA/QC]** A file generated by the micro-meta app that contains a description of the hardware components of the microscope. Email HuBMAP Consortium Help Desk extras\/microscope_settings\.json
| ✓ | **[QA/QC]** A file generated by the micro-meta app that contains a description of the settings that were used to acquire the image data. Email HuBMAP Consortium Help Desk raw\/.*
| ✓ | Raw data files for the experiment. | |
+| raw\/channel_layout\.tsv
| ✓ | Table that includes a dictionary for channel to moiety, which may be a protein given in an OMAP panel or captured in the ASCT+B table. | |
+| raw\/lightpath_configuration\.tsv
| | This file documents the light path setttings not captured in the OME-TIFF - will be deprecated upon the implementation of MicroMeta. | |
+| raw\/fingerprint_layout\.tsv
| | Table that includes a dictionary for channel to moiety which is determined from spectral clustering and may include lipids, protein, etc. This file is specific to hyper-spectral imaging. | |
+| raw\/images\/.*
| ✓ | Raw image files. Using this subdirectory allows for harmonization with other imaging assays. [This directory must include at least one raw file.] | |
+| raw\/images\/[^\/]+\.(?:xml|nd2|oir|lif|czi|tiff)
| ✓ | Raw microscope file for the experiment | |
+| lab_processed\/.*
| ✓ | Experiment files that were processed by the lab generating the data. | |
+| lab_processed\/images\/.*
| ✓ | Processed image files | |
+| lab_processed\/images\/[^\/]+\.ome\.tiff
(example: lab_processed/images/HBM892.MDXS.293.ome.tiff
) | ✓ | OME-TIFF files (multichannel, multi-layered) produced by the microscopy experiment. If compressed, must use loss-less compression algorithm. See the following link for the set of fields that are required in the OME TIFF file XML header. lab_processed\/images\/[^\/]*ome-tiff\.channels\.csv
| ✓ | This file provides essential documentation pertaining to each channel of the accommpanying OME TIFF. The file should contain one row per OME TIFF channel. The required fields are detailed lab_processed\/transformations\/.*
| | This directory contains transformation matrices that capture how each modality is aligned with the other and can be used to visualize overlays of multimodal data. This is needed to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). In these cases data type may have different pixel sizes and slightly different orientations (i.e., one may be rotated relative to another). | |
+| lab_processed\/transformations\/[^\/]*transformations\.txt
| | Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). | |
+| qa_qc\/.*
| ✓ | Directory containing QA and/or QC information. | |
+| qa_qc\/resolution_report\/.*
| ✓ | Directory containing the results of resolution tests and/or vendor preventative maintenance reports. | |
+| qa_qc\/resolution_report\/resolution\.txt
| | This file summarizes the results of resolution tests or vendor reports from preventative maintenance visits. | |
+| qa_qc\/resolution_report\/[^\/]+\.pdf
| | This file is a pdf from a vendor preventative maintenance visit or resolution check tool demonstrating resolution. This file may include illumination test results. | |
+| qa_qc\/illumination_report\/.*
| ✓ | Directory containing the results of illumination tests and/or vendor preventative maintenance reports. | |
+| qa_qc\/illumination_report\/illumination.txt
| | This file summarizes the results of illumination tests or vendor reports from preventative maintenance visits. | |
+| qa_qc\/illumination_report\/[^\/]+\.pdf
| | This file is a pdf from a vendor preventative maintenance visit or illumination check tool demonstrating illumination intensity. | |
+| lab_processed\/annotations\/.*
| | Directory containing segmentation masks. | |
+| lab_processed\/annotations\/[^\/]+\.segmentations\.ome\.tiff
| | 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. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/segmentation-masks\.csv
| | This file contains details about each mask, with one row per mask. Each column in this file contains details describing the mask (e.g., channel number, mask name, ontological ID, etc). Each mask is stored as a channel in the segmentations.ome.tiff file and the mask name should be ontologically based and linked to the ASCT+B table where possible. The number of rows in this file should equal the number of channels in the segmentations.ome.tiff. For example, one row in this file would ontologically describe cells, if the segmentations.ome.tiff file contained a mask of all cells. A minimum set of fields (required and optional) is included below. If multiple segmentations.ome.tiff files are used, this segmentation-masks.csv file should document the masks across all of the OME TIFF files. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/[^\/]+-objects\.csv
| | 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’s 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. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/[^\/]+\.geojson
| | A GeoJSON file(s) containing the geometries of each object within a mask. For example, if the mask contains multiple FTUs, multiple cells, etc, each of the objects in the mask would be independently documented in the GeoJSON file. There would be a single GeoJSON file per mask and the name of the file should be the name of the mask. If this file is generated by QuPath, the coordinates will be in pixel units with the origin (0, 0) as the top left corner of the full-resolution image. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/tissue-boundary\.geojson
| | **[QA/QC]** If the boundaries of the tissue have been identified (e.g., by manual efforts), then the boundary geometry can be included as a GeoJSON file named “tissue-boundary.geojson”. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/regions-of-concern\.csv
| | This file and the associated GeoJSON file can be used to denote any regions in the image that may contain QA/QC concerns. For example, if there are folds in the tissue, the region of the fold can be highlighted. This file should contain one row per region and include documentation about the region and why it's being flagged. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/regions-of-concern\.geojson
| | This file and the associated CSV file can be used to denote any regions in the image that may contain QA/QC concerns. For example, if there are folds in the tissue, the region of the fold can be highlighted. This file should contain the geometric coordinates of each region being flagged. | lab_processed\/annotations\/.* |
diff --git a/src/ingest_validation_tools/directory-schemas/codex-v2.yaml b/src/ingest_validation_tools/directory-schemas/codex-v2.yaml
index e8d46e7ee..372c7d6c3 100644
--- a/src/ingest_validation_tools/directory-schemas/codex-v2.yaml
+++ b/src/ingest_validation_tools/directory-schemas/codex-v2.yaml
@@ -1,5 +1,86 @@
-# GE CellDIVE Directory Schema
-draft: true
files:
-
- draft_link: 'https://docs.google.com/spreadsheets/d/1pZD2e51e4QkxzIk6xjHPPu1RBZpx5mzoykMmlaDK8rA'
\ No newline at end of file
+ pattern: extras\/.*
+ required: True
+ description: Folder for general lab-specific files related to the dataset. [Exists in all assays]
+ -
+ pattern: extras\/microscope_hardware\.json
+ required: True
+ description: A file generated by the micro-meta app that contains a description of the hardware components of the microscope. Email HuBMAP Consortium Help Desk extras\/.*
| ✓ | Folder for general lab-specific files related to the dataset. [Exists in all assays] | |
-| extras\/microscope_hardware\.json
| ✓ | **[QA/QC]** A file generated by the micro-meta app that contains a description of the hardware components of the microscope. Email HuBMAP Consortium Help Desk extras\/microscope_settings\.json
| ✓ | **[QA/QC]** A file generated by the micro-meta app that contains a description of the settings that were used to acquire the image data. Email HuBMAP Consortium Help Desk raw\/.*
| ✓ | Raw data files for the experiment. | |
-| raw\/channel_layout\.tsv
| ✓ | Table that includes a dictionary for channel to moiety, which may be a protein given in an OMAP panel or captured in the ASCT+B table. | |
-| raw\/lightpath_configuration\.tsv
| | This file documents the light path setttings not captured in the OME-TIFF - will be deprecated upon the implementation of MicroMeta. | |
-| raw\/fingerprint_layout\.tsv
| | Table that includes a dictionary for channel to moiety which is determined from spectral clustering and may include lipids, protein, etc. This file is specific to hyper-spectral imaging. | |
-| raw\/images\/.*
| ✓ | Raw image files. Using this subdirectory allows for harmonization with other imaging assays. [This directory must include at least one raw file.] | |
-| raw\/images\/[^\/]+\.(?:xml|nd2|oir|lif|czi|tiff)
| ✓ | Raw microscope file for the experiment | |
-| lab_processed\/.*
| ✓ | Experiment files that were processed by the lab generating the data. | |
-| lab_processed\/images\/.*
| ✓ | Processed image files | |
-| lab_processed\/images\/[^\/]+\.ome\.tiff
(example: lab_processed/images/HBM892.MDXS.293.ome.tiff
) | ✓ | OME-TIFF files (multichannel, multi-layered) produced by the microscopy experiment. If compressed, must use loss-less compression algorithm. See the following link for the set of fields that are required in the OME TIFF file XML header. lab_processed\/images\/[^\/]*ome-tiff\.channels\.csv
| ✓ | This file provides essential documentation pertaining to each channel of the accommpanying OME TIFF. The file should contain one row per OME TIFF channel. The required fields are detailed lab_processed\/transformations\/.*
| | This directory contains transformation matrices that capture how each modality is aligned with the other and can be used to visualize overlays of multimodal data. This is needed to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). In these cases data type may have different pixel sizes and slightly different orientations (i.e., one may be rotated relative to another). | |
-| lab_processed\/transformations\/[^\/]*transformations\.txt
| | Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). | |
-| qa_qc\/.*
| ✓ | Directory containing QA and/or QC information. | |
-| qa_qc\/resolution_report\/.*
| ✓ | Directory containing the results of resolution tests and/or vendor preventative maintenance reports. | |
-| qa_qc\/resolution_report\/resolution\.txt
| | This file summarizes the results of resolution tests or vendor reports from preventative maintenance visits. | |
-| qa_qc\/resolution_report\/[^\/]+\.pdf
| | This file is a pdf from a vendor preventative maintenance visit or resolution check tool demonstrating resolution. This file may include illumination test results. | |
-| qa_qc\/illumination_report\/.*
| ✓ | Directory containing the results of illumination tests and/or vendor preventative maintenance reports. | |
-| qa_qc\/illumination_report\/illumination.txt
| | This file summarizes the results of illumination tests or vendor reports from preventative maintenance visits. | |
-| qa_qc\/illumination_report\/[^\/]+\.pdf
| | This file is a pdf from a vendor preventative maintenance visit or illumination check tool demonstrating illumination intensity. | |
-| lab_processed\/annotations\/.*
| | Directory containing segmentation masks. | |
-| lab_processed\/annotations\/[^\/]+\.segmentations\.ome\.tiff
| | 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. | lab_processed\/annotations\/.* |
-| lab_processed\/annotations\/segmentation-masks\.csv
| | This file contains details about each mask, with one row per mask. Each column in this file contains details describing the mask (e.g., channel number, mask name, ontological ID, etc). Each mask is stored as a channel in the segmentations.ome.tiff file and the mask name should be ontologically based and linked to the ASCT+B table where possible. The number of rows in this file should equal the number of channels in the segmentations.ome.tiff. For example, one row in this file would ontologically describe cells, if the segmentations.ome.tiff file contained a mask of all cells. A minimum set of fields (required and optional) is included below. If multiple segmentations.ome.tiff files are used, this segmentation-masks.csv file should document the masks across all of the OME TIFF files. | lab_processed\/annotations\/.* |
-| lab_processed\/annotations\/[^\/]+-objects\.csv
| | 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’s 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. | lab_processed\/annotations\/.* |
-| lab_processed\/annotations\/[^\/]+\.geojson
| | A GeoJSON file(s) containing the geometries of each object within a mask. For example, if the mask contains multiple FTUs, multiple cells, etc, each of the objects in the mask would be independently documented in the GeoJSON file. There would be a single GeoJSON file per mask and the name of the file should be the name of the mask. If this file is generated by QuPath, the coordinates will be in pixel units with the origin (0, 0) as the top left corner of the full-resolution image. | lab_processed\/annotations\/.* |
-| lab_processed\/annotations\/tissue-boundary\.geojson
| | **[QA/QC]** If the boundaries of the tissue have been identified (e.g., by manual efforts), then the boundary geometry can be included as a GeoJSON file named “tissue-boundary.geojson”. | lab_processed\/annotations\/.* |
-| lab_processed\/annotations\/regions-of-concern\.csv
| | This file and the associated GeoJSON file can be used to denote any regions in the image that may contain QA/QC concerns. For example, if there are folds in the tissue, the region of the fold can be highlighted. This file should contain one row per region and include documentation about the region and why it's being flagged. | lab_processed\/annotations\/.* |
-| lab_processed\/annotations\/regions-of-concern\.geojson
| | This file and the associated CSV file can be used to denote any regions in the image that may contain QA/QC concerns. For example, if there are folds in the tissue, the region of the fold can be highlighted. This file should contain the geometric coordinates of each region being flagged. | lab_processed\/annotations\/.* |
-
diff --git a/docs/thick-section-multiphoton-mxif/current/index.md b/docs/thick-section-multiphoton-mxif/current/index.md
index 7f7bdd233..b86af0c7c 100644
--- a/docs/thick-section-multiphoton-mxif/current/index.md
+++ b/docs/thick-section-multiphoton-mxif/current/index.md
@@ -28,5 +28,38 @@ Related files:
extras\/.*
| ✓ | Folder for general lab-specific files related to the dataset. [Exists in all assays] | |
+| extras\/microscope_hardware\.json
| ✓ | **[QA/QC]** A file generated by the micro-meta app that contains a description of the hardware components of the microscope. Email HuBMAP Consortium Help Desk extras\/microscope_settings\.json
| ✓ | **[QA/QC]** A file generated by the micro-meta app that contains a description of the settings that were used to acquire the image data. Email HuBMAP Consortium Help Desk raw\/.*
| ✓ | Raw data files for the experiment. | |
+| raw\/channel_layout\.tsv
| ✓ | Table that includes a dictionary for channel to moiety, which may be a protein given in an OMAP panel or captured in the ASCT+B table. | |
+| raw\/lightpath_configuration\.tsv
| | This file documents the light path setttings not captured in the OME-TIFF - will be deprecated upon the implementation of MicroMeta. | |
+| raw\/fingerprint_layout\.tsv
| | Table that includes a dictionary for channel to moiety which is determined from spectral clustering and may include lipids, protein, etc. This file is specific to hyper-spectral imaging. | |
+| raw\/images\/.*
| ✓ | Raw image files. Using this subdirectory allows for harmonization with other imaging assays. [This directory must include at least one raw file.] | |
+| raw\/images\/[^\/]+\.(?:xml|nd2|oir|lif|czi|tiff)
| ✓ | Raw microscope file for the experiment | |
+| lab_processed\/.*
| ✓ | Experiment files that were processed by the lab generating the data. | |
+| lab_processed\/images\/.*
| ✓ | Processed image files | |
+| lab_processed\/images\/[^\/]+\.ome\.tiff
(example: lab_processed/images/HBM892.MDXS.293.ome.tiff
) | ✓ | OME-TIFF files (multichannel, multi-layered) produced by the microscopy experiment. If compressed, must use loss-less compression algorithm. See the following link for the set of fields that are required in the OME TIFF file XML header. lab_processed\/images\/[^\/]*ome-tiff\.channels\.csv
| ✓ | This file provides essential documentation pertaining to each channel of the accommpanying OME TIFF. The file should contain one row per OME TIFF channel. The required fields are detailed lab_processed\/transformations\/.*
| | This directory contains transformation matrices that capture how each modality is aligned with the other and can be used to visualize overlays of multimodal data. This is needed to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). In these cases data type may have different pixel sizes and slightly different orientations (i.e., one may be rotated relative to another). | |
+| lab_processed\/transformations\/[^\/]*transformations\.txt
| | Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). | |
+| qa_qc\/.*
| ✓ | Directory containing QA and/or QC information. | |
+| qa_qc\/resolution_report\/.*
| ✓ | Directory containing the results of resolution tests and/or vendor preventative maintenance reports. | |
+| qa_qc\/resolution_report\/resolution\.txt
| | This file summarizes the results of resolution tests or vendor reports from preventative maintenance visits. | |
+| qa_qc\/resolution_report\/[^\/]+\.pdf
| | This file is a pdf from a vendor preventative maintenance visit or resolution check tool demonstrating resolution. This file may include illumination test results. | |
+| qa_qc\/illumination_report\/.*
| ✓ | Directory containing the results of illumination tests and/or vendor preventative maintenance reports. | |
+| qa_qc\/illumination_report\/illumination.txt
| | This file summarizes the results of illumination tests or vendor reports from preventative maintenance visits. | |
+| qa_qc\/illumination_report\/[^\/]+\.pdf
| | This file is a pdf from a vendor preventative maintenance visit or illumination check tool demonstrating illumination intensity. | |
+| lab_processed\/annotations\/.*
| | Directory containing segmentation masks. | |
+| lab_processed\/annotations\/[^\/]+\.segmentations\.ome\.tiff
| | 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. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/segmentation-masks\.csv
| | This file contains details about each mask, with one row per mask. Each column in this file contains details describing the mask (e.g., channel number, mask name, ontological ID, etc). Each mask is stored as a channel in the segmentations.ome.tiff file and the mask name should be ontologically based and linked to the ASCT+B table where possible. The number of rows in this file should equal the number of channels in the segmentations.ome.tiff. For example, one row in this file would ontologically describe cells, if the segmentations.ome.tiff file contained a mask of all cells. A minimum set of fields (required and optional) is included below. If multiple segmentations.ome.tiff files are used, this segmentation-masks.csv file should document the masks across all of the OME TIFF files. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/[^\/]+-objects\.csv
| | 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’s 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. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/[^\/]+\.geojson
| | A GeoJSON file(s) containing the geometries of each object within a mask. For example, if the mask contains multiple FTUs, multiple cells, etc, each of the objects in the mask would be independently documented in the GeoJSON file. There would be a single GeoJSON file per mask and the name of the file should be the name of the mask. If this file is generated by QuPath, the coordinates will be in pixel units with the origin (0, 0) as the top left corner of the full-resolution image. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/tissue-boundary\.geojson
| | **[QA/QC]** If the boundaries of the tissue have been identified (e.g., by manual efforts), then the boundary geometry can be included as a GeoJSON file named “tissue-boundary.geojson”. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/regions-of-concern\.csv
| | This file and the associated GeoJSON file can be used to denote any regions in the image that may contain QA/QC concerns. For example, if there are folds in the tissue, the region of the fold can be highlighted. This file should contain one row per region and include documentation about the region and why it's being flagged. | lab_processed\/annotations\/.* |
+| lab_processed\/annotations\/regions-of-concern\.geojson
| | This file and the associated CSV file can be used to denote any regions in the image that may contain QA/QC concerns. For example, if there are folds in the tissue, the region of the fold can be highlighted. This file should contain the geometric coordinates of each region being flagged. | lab_processed\/annotations\/.* |
diff --git a/src/ingest_validation_tools/directory-schemas/mxif-v2.yaml b/src/ingest_validation_tools/directory-schemas/mxif-v2.yaml
deleted file mode 100644
index 57a6c3add..000000000
--- a/src/ingest_validation_tools/directory-schemas/mxif-v2.yaml
+++ /dev/null
@@ -1,103 +0,0 @@
-files:
- -
- pattern: extras\/.*
- required: True
- description: Folder for general lab-specific files related to the dataset. [Exists in all assays]
- -
- pattern: extras\/microscope_hardware\.json
- required: True
- description: A file generated by the micro-meta app that contains a description of the hardware components of the microscope. Email HuBMAP Consortium Help Desk lab_processed\/images\/[^\/]+\.ome\.tiff
(example: lab_processed/images/HBM892.MDXS.293.ome.tiff
) | ✓ | OME-TIFF files (multichannel, multi-layered) produced by the microscopy experiment. If compressed, must use loss-less compression algorithm. See the following link for the set of fields that are required in the OME TIFF file XML header. lab_processed\/images\/[^\/]*ome-tiff\.channels\.csv
| ✓ | This file provides essential documentation pertaining to each channel of the accommpanying OME TIFF. The file should contain one row per OME TIFF channel. The required fields are detailed lab_processed\/transformations\/.*
| | This directory contains transformation matrices that capture how each modality is aligned with the other and can be used to visualize overlays of multimodal data. This is needed to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). In these cases data type may have different pixel sizes and slightly different orientations (i.e., one may be rotated relative to another). | |
-| lab_processed\/transformations\/[^\/]*transformations\.txt
| | Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). | |
+| lab_processed\/transformations\/[^\/]+\.txt
| | Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). | |
| qa_qc\/.*
| ✓ | Directory containing QA and/or QC information. | |
| qa_qc\/resolution_report\/.*
| ✓ | Directory containing the results of resolution tests and/or vendor preventative maintenance reports. | |
| qa_qc\/resolution_report\/resolution\.txt
| | This file summarizes the results of resolution tests or vendor reports from preventative maintenance visits. | |
diff --git a/docs/confocal/current/index.md b/docs/confocal/current/index.md
index 6294cb534..85d80a57e 100644
--- a/docs/confocal/current/index.md
+++ b/docs/confocal/current/index.md
@@ -44,7 +44,7 @@ Related files:
| lab_processed\/images\/[^\/]+\.ome\.tiff
(example: lab_processed/images/HBM892.MDXS.293.ome.tiff
) | ✓ | OME-TIFF files (multichannel, multi-layered) produced by the microscopy experiment. If compressed, must use loss-less compression algorithm. See the following link for the set of fields that are required in the OME TIFF file XML header. lab_processed\/images\/[^\/]*ome-tiff\.channels\.csv
| ✓ | This file provides essential documentation pertaining to each channel of the accommpanying OME TIFF. The file should contain one row per OME TIFF channel. The required fields are detailed lab_processed\/transformations\/.*
| | This directory contains transformation matrices that capture how each modality is aligned with the other and can be used to visualize overlays of multimodal data. This is needed to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). In these cases data type may have different pixel sizes and slightly different orientations (i.e., one may be rotated relative to another). | |
-| lab_processed\/transformations\/[^\/]*transformations\.txt
| | Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). | |
+| lab_processed\/transformations\/[^\/]+\.txt
| | Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). | |
| qa_qc\/.*
| ✓ | Directory containing QA and/or QC information. | |
| qa_qc\/resolution_report\/.*
| ✓ | Directory containing the results of resolution tests and/or vendor preventative maintenance reports. | |
| qa_qc\/resolution_report\/resolution\.txt
| | This file summarizes the results of resolution tests or vendor reports from preventative maintenance visits. | |
diff --git a/docs/desi/current/index.md b/docs/desi/current/index.md
index 6d7732684..f5d43dc5e 100644
--- a/docs/desi/current/index.md
+++ b/docs/desi/current/index.md
@@ -43,7 +43,7 @@ See the following link for the set of fields that are required in the OME TIFF f
| lab_processed\/images\/[^\/]+\.ome\.tiff
| ✓ | OME-TIFF files (multichannel, multi-layered) produced by the microscopy experiment. If compressed, must use loss-less compression algorithm. See the following link for the set of fields that are required in the OME TIFF file XML header. lab_processed\/images\/[^\/]*ome-tiff\.channels\.csv
| ✓ | This file provides essential documentation pertaining to each channel of the accommpanying OME TIFF. The file should contain one row per OME TIFF channel. The required fields are detailed lab_processed\/transformations\/.*
| | Directory containing image transformations. |
-| lab_processed\/transformations\/[^\/]*transformations\.txt
| | Transformations/map back to autofluorescence microscopy (related) data |
+| lab_processed\/transformations\/[^\/]+\.txt
| | Transformations/map back to autofluorescence microscopy (related) data |
| lab_processed\/annotations\/.*
| ✓ | Directory containing annotations |
| lab_processed\/annotations\/[^\/]+_MolecularAssignments\.tsv
| ✓ | TSV file containing the m/z, molecular assignment, etc. |
diff --git a/docs/enhanced-srs/current/index.md b/docs/enhanced-srs/current/index.md
index 868a5ba3c..240a06a1b 100644
--- a/docs/enhanced-srs/current/index.md
+++ b/docs/enhanced-srs/current/index.md
@@ -46,7 +46,7 @@ See the following link for the set of fields that are required in the OME TIFF f
| lab_processed\/images\/[^\/]+\.ome\.tiff
(example: lab_processed/images/HBM892.MDXS.293.ome.tiff
) | ✓ | OME-TIFF files (multichannel, multi-layered) produced by the microscopy experiment. If compressed, must use loss-less compression algorithm. See the following link for the set of fields that are required in the OME TIFF file XML header. lab_processed\/images\/[^\/]*ome-tiff\.channels\.csv
| ✓ | This file provides essential documentation pertaining to each channel of the accommpanying OME TIFF. The file should contain one row per OME TIFF channel. The required fields are detailed lab_processed\/transformations\/.*
| | This directory contains transformation matrices that capture how each modality is aligned with the other and can be used to visualize overlays of multimodal data. This is needed to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). In these cases data type may have different pixel sizes and slightly different orientations (i.e., one may be rotated relative to another). | |
-| lab_processed\/transformations\/[^\/]*transformations\.txt
| | Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). | |
+| lab_processed\/transformations\/[^\/]+\.txt
| | Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). | |
| qa_qc\/.*
| ✓ | Directory containing QA and/or QC information. | |
| qa_qc\/resolution_report\/.*
| ✓ | Directory containing the results of resolution tests and/or vendor preventative maintenance reports. | |
| qa_qc\/resolution_report\/resolution\.txt
| | This file summarizes the results of resolution tests or vendor reports from preventative maintenance visits. | |
diff --git a/docs/histology/current/index.md b/docs/histology/current/index.md
index 1aeb4e071..b4321f384 100644
--- a/docs/histology/current/index.md
+++ b/docs/histology/current/index.md
@@ -43,7 +43,7 @@ See the following link for the set of fields that are required in the OME TIFF f
| lab_processed\/images\/[^\/]+\.ome\.tiff
(example: lab_processed/images/HBM892.MDXS.293.ome.tiff
) | ✓ | OME-TIFF files (multichannel, multi-layered) produced by the microscopy experiment. If compressed, must use loss-less compression algorithm. See the following link for the set of fields that are required in the OME TIFF file XML header. lab_processed\/images\/[^\/]*ome-tiff\.channels\.csv
| ✓ | This file provides essential documentation pertaining to each channel of the accommpanying OME TIFF. The file should contain one row per OME TIFF channel. The required fields are detailed here lab_processed\/transformations\/.*
| | This directory contains transformation matrices that capture how each modality is aligned with the other and can be used to visualize overlays of multimodal data. This is needed to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). In these cases data type may have different pixel sizes and slightly different orientations (i.e., one may be rotated relative to another). | |
-| lab_processed\/transformations\/[^\/]*transformations\.txt
| | Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). | |
+| lab_processed\/transformations\/[^\/]+\.txt
| | Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). | |
| lab_processed\/probabilities\/.*
| | Directory containing probabilities pertaining to lab processed data (e.g., from Ilastik pixel classification). | |
| lab_processed\/probabilities\/[^\/]+\.tiff
| | **[QA/QC]** A TIFF file that contains pixel probabilities. | |
| lab_processed\/annotations\/.*
| | Directory containing segmentation masks. | |
diff --git a/docs/lightsheet/current/index.md b/docs/lightsheet/current/index.md
index a112e9a7a..472f2c7e7 100644
--- a/docs/lightsheet/current/index.md
+++ b/docs/lightsheet/current/index.md
@@ -45,7 +45,7 @@ See the following link for the set of fields that are required in the OME TIFF f
| lab_processed\/images\/[^\/]+\.ome\.tiff
(example: lab_processed/images/HBM892.MDXS.293.ome.tiff
) | ✓ | OME-TIFF files (multichannel, multi-layered) produced by the microscopy experiment. If compressed, must use loss-less compression algorithm. See the following link for the set of fields that are required in the OME TIFF file XML header. lab_processed\/images\/[^\/]*ome-tiff\.channels\.csv
| ✓ | This file provides essential documentation pertaining to each channel of the accommpanying OME TIFF. The file should contain one row per OME TIFF channel. The required fields are detailed lab_processed\/transformations\/.*
| | This directory contains transformation matrices that capture how each modality is aligned with the other and can be used to visualize overlays of multimodal data. This is needed to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). In these cases data type may have different pixel sizes and slightly different orientations (i.e., one may be rotated relative to another). | |
-| lab_processed\/transformations\/[^\/]*transformations\.txt
| | Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). | |
+| lab_processed\/transformations\/[^\/]+\.txt
| | Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). | |
| qa_qc\/.*
| ✓ | Directory containing QA and/or QC information. | |
| qa_qc\/resolution_report\/.*
| ✓ | Directory containing the results of resolution tests and/or vendor preventative maintenance reports. | |
| qa_qc\/resolution_report\/resolution\.txt
| | This file summarizes the results of resolution tests or vendor reports from preventative maintenance visits. | |
diff --git a/docs/maldi/current/index.md b/docs/maldi/current/index.md
index f88d8431a..dd7f0275f 100644
--- a/docs/maldi/current/index.md
+++ b/docs/maldi/current/index.md
@@ -43,7 +43,7 @@ See the following link for the set of fields that are required in the OME TIFF f
| lab_processed\/images\/[^\/]+\.ome\.tiff
| ✓ | OME-TIFF files (multichannel, multi-layered) produced by the microscopy experiment. If compressed, must use loss-less compression algorithm. See the following link for the set of fields that are required in the OME TIFF file XML header. lab_processed\/images\/[^\/]*ome-tiff\.channels\.csv
| ✓ | This file provides essential documentation pertaining to each channel of the accommpanying OME TIFF. The file should contain one row per OME TIFF channel. The required fields are detailed lab_processed\/transformations\/.*
| | Directory containing image transformations. |
-| lab_processed\/transformations\/[^\/]*transformations\.txt
| | Transformations/map back to autofluorescence microscopy (related) data |
+| lab_processed\/transformations\/[^\/]+\.txt
| | Transformations/map back to autofluorescence microscopy (related) data |
| lab_processed\/annotations\/.*
| ✓ | Directory containing annotations |
| lab_processed\/annotations\/[^\/]+_MolecularAssignments\.tsv
| ✓ | TSV file containing the m/z, molecular assignment, etc. |
diff --git a/docs/second-harmonic-generation/current/index.md b/docs/second-harmonic-generation/current/index.md
index 35ae3bc3f..20a5a784a 100644
--- a/docs/second-harmonic-generation/current/index.md
+++ b/docs/second-harmonic-generation/current/index.md
@@ -46,7 +46,7 @@ Related files:
| lab_processed\/images\/[^\/]+\.ome\.tiff
(example: lab_processed/images/HBM892.MDXS.293.ome.tiff
) | ✓ | OME-TIFF files (multichannel, multi-layered) produced by the microscopy experiment. If compressed, must use loss-less compression algorithm. See the following link for the set of fields that are required in the OME TIFF file XML header. lab_processed\/images\/[^\/]*ome-tiff\.channels\.csv
| ✓ | This file provides essential documentation pertaining to each channel of the accommpanying OME TIFF. The file should contain one row per OME TIFF channel. The required fields are detailed lab_processed\/transformations\/.*
| | This directory contains transformation matrices that capture how each modality is aligned with the other and can be used to visualize overlays of multimodal data. This is needed to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). In these cases data type may have different pixel sizes and slightly different orientations (i.e., one may be rotated relative to another). | |
-| lab_processed\/transformations\/[^\/]*transformations\.txt
| | Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). | |
+| lab_processed\/transformations\/[^\/]+\.txt
| | Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). | |
| qa_qc\/.*
| ✓ | Directory containing QA and/or QC information. | |
| qa_qc\/resolution_report\/.*
| ✓ | Directory containing the results of resolution tests and/or vendor preventative maintenance reports. | |
| qa_qc\/resolution_report\/resolution\.txt
| | This file summarizes the results of resolution tests or vendor reports from preventative maintenance visits. | |
diff --git a/docs/sims/current/index.md b/docs/sims/current/index.md
index 8613ea8a9..94bd189e1 100644
--- a/docs/sims/current/index.md
+++ b/docs/sims/current/index.md
@@ -43,7 +43,7 @@ See the following link for the set of fields that are required in the OME TIFF f
| lab_processed\/images\/[^\/]+\.ome\.tiff
| ✓ | OME-TIFF files (multichannel, multi-layered) produced by the microscopy experiment. If compressed, must use loss-less compression algorithm. See the following link for the set of fields that are required in the OME TIFF file XML header. lab_processed\/images\/[^\/]*ome-tiff\.channels\.csv
| ✓ | This file provides essential documentation pertaining to each channel of the accommpanying OME TIFF. The file should contain one row per OME TIFF channel. The required fields are detailed lab_processed\/transformations\/.*
| | Directory containing image transformations. |
-| lab_processed\/transformations\/[^\/]*transformations\.txt
| | Transformations/map back to autofluorescence microscopy (related) data |
+| lab_processed\/transformations\/[^\/]+\.txt
| | Transformations/map back to autofluorescence microscopy (related) data |
| lab_processed\/annotations\/.*
| ✓ | Directory containing annotations |
| lab_processed\/annotations\/[^\/]+_MolecularAssignments\.tsv
| ✓ | TSV file containing the m/z, molecular assignment, etc. |
diff --git a/docs/thick-section-multiphoton-mxif/current/index.md b/docs/thick-section-multiphoton-mxif/current/index.md
index b86af0c7c..13da46541 100644
--- a/docs/thick-section-multiphoton-mxif/current/index.md
+++ b/docs/thick-section-multiphoton-mxif/current/index.md
@@ -46,7 +46,7 @@ Related files:
| lab_processed\/images\/[^\/]+\.ome\.tiff
(example: lab_processed/images/HBM892.MDXS.293.ome.tiff
) | ✓ | OME-TIFF files (multichannel, multi-layered) produced by the microscopy experiment. If compressed, must use loss-less compression algorithm. See the following link for the set of fields that are required in the OME TIFF file XML header. lab_processed\/images\/[^\/]*ome-tiff\.channels\.csv
| ✓ | This file provides essential documentation pertaining to each channel of the accommpanying OME TIFF. The file should contain one row per OME TIFF channel. The required fields are detailed lab_processed\/transformations\/.*
| | This directory contains transformation matrices that capture how each modality is aligned with the other and can be used to visualize overlays of multimodal data. This is needed to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). In these cases data type may have different pixel sizes and slightly different orientations (i.e., one may be rotated relative to another). | |
-| lab_processed\/transformations\/[^\/]*transformations\.txt
| | Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). | |
+| lab_processed\/transformations\/[^\/]+\.txt
| | Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). | |
| qa_qc\/.*
| ✓ | Directory containing QA and/or QC information. | |
| qa_qc\/resolution_report\/.*
| ✓ | Directory containing the results of resolution tests and/or vendor preventative maintenance reports. | |
| qa_qc\/resolution_report\/resolution\.txt
| | This file summarizes the results of resolution tests or vendor reports from preventative maintenance visits. | |
diff --git a/docs/visium-no-probes/current/index.md b/docs/visium-no-probes/current/index.md
index e4d147e9f..7c87d3081 100644
--- a/docs/visium-no-probes/current/index.md
+++ b/docs/visium-no-probes/current/index.md
@@ -49,7 +49,7 @@ REQUIRED - For this assay, you must also prepare and submit two additional metad
| lab_processed\/images\/[^\/]+\.ome\.tiff
(example: lab_processed/images/HBM892.MDXS.293.ome.tiff
) | ✓ | OME-TIFF files (multichannel, multi-layered) produced by the microscopy experiment. If compressed, must use loss-less compression algorithm. For Visium this stitched file should only include the single capture area relevant to the current dataset. For GeoMx there will be one OME TIFF file per slide, with each slide including multiple AOIs. See the following link for the set of fields that are required in the OME TIFF file XML header. lab_processed\/images\/[^\/]*ome-tiff\.channels\.csv
| ✓ | This file provides essential documentation pertaining to each channel of the accommpanying OME TIFF. The file should contain one row per OME TIFF channel. The required fields are detailed lab_processed\/transformations\/.*
| | This directory contains transformation matrices that capture how each modality is aligned with the other and can be used to visualize overlays of multimodal data. This is needed to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). In these cases data type may have different pixel sizes and slightly different orientations (i.e., one may be rotated relative to another). | |
-| lab_processed\/transformations\/[^\/]*transformations\.txt
| | Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). | |
+| lab_processed\/transformations\/[^\/]+\.txt
| | Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). | |
| lab_processed\/annotations\/.*
| | Directory containing segmentation masks. | |
| lab_processed\/annotations\/[^\/]+\.segmentations\.ome\.tiff
| | 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. | lab_processed\/annotations\/.* |
| lab_processed\/annotations\/segmentation-masks\.csv
| | This file contains details about each mask, with one row per mask. Each column in this file contains details describing the mask (e.g., channel number, mask name, ontological ID, etc). Each mask is stored as a channel in the segmentations.ome.tiff file and the mask name should be ontologically based and linked to the ASCT+B table where possible. The number of rows in this file should equal the number of channels in the segmentations.ome.tiff. For example, one row in this file would ontologically describe cells, if the segmentations.ome.tiff file contained a mask of all cells. A minimum set of fields (required and optional) is included below. If multiple segmentations.ome.tiff files are used, this segmentation-masks.csv file should document the masks across all of the OME TIFF files. | lab_processed\/annotations\/.* |
diff --git a/src/ingest_validation_tools/directory-schemas/af-v2.yaml b/src/ingest_validation_tools/directory-schemas/af-v2.yaml
index 30b917f15..0b34117bf 100644
--- a/src/ingest_validation_tools/directory-schemas/af-v2.yaml
+++ b/src/ingest_validation_tools/directory-schemas/af-v2.yaml
@@ -55,7 +55,7 @@ files:
required: False
description: This directory contains transformation matrices that capture how each modality is aligned with the other and can be used to visualize overlays of multimodal data. This is needed to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). In these cases data type may have different pixel sizes and slightly different orientations (i.e., one may be rotated relative to another).
-
- pattern: lab_processed\/transformations\/[^\/]*transformations\.txt
+ pattern: lab_processed\/transformations\/[^\/]+\.txt
required: False
description: Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains).
is_qa_qc: False
diff --git a/src/ingest_validation_tools/directory-schemas/confocal-v2.yaml b/src/ingest_validation_tools/directory-schemas/confocal-v2.yaml
index 44d4c9cd6..24c6ef057 100644
--- a/src/ingest_validation_tools/directory-schemas/confocal-v2.yaml
+++ b/src/ingest_validation_tools/directory-schemas/confocal-v2.yaml
@@ -55,7 +55,7 @@ files:
required: False
description: This directory contains transformation matrices that capture how each modality is aligned with the other and can be used to visualize overlays of multimodal data. This is needed to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). In these cases data type may have different pixel sizes and slightly different orientations (i.e., one may be rotated relative to another).
-
- pattern: lab_processed\/transformations\/[^\/]*transformations\.txt
+ pattern: lab_processed\/transformations\/[^\/]+\.txt
required: False
description: Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains).
is_qa_qc: False
diff --git a/src/ingest_validation_tools/directory-schemas/desi-v2.yaml b/src/ingest_validation_tools/directory-schemas/desi-v2.yaml
index 10ef5b573..85afe980c 100644
--- a/src/ingest_validation_tools/directory-schemas/desi-v2.yaml
+++ b/src/ingest_validation_tools/directory-schemas/desi-v2.yaml
@@ -45,7 +45,7 @@ files:
required: False
description: Directory containing image transformations.
-
- pattern: lab_processed\/transformations\/[^\/]*transformations\.txt
+ pattern: lab_processed\/transformations\/[^\/]+\.txt
required: False
description: Transformations/map back to autofluorescence microscopy (related) data
-
diff --git a/src/ingest_validation_tools/directory-schemas/enhanced-srs-v2.yaml b/src/ingest_validation_tools/directory-schemas/enhanced-srs-v2.yaml
index 57a6c3add..40e374130 100644
--- a/src/ingest_validation_tools/directory-schemas/enhanced-srs-v2.yaml
+++ b/src/ingest_validation_tools/directory-schemas/enhanced-srs-v2.yaml
@@ -64,7 +64,7 @@ files:
required: False
description: This directory contains transformation matrices that capture how each modality is aligned with the other and can be used to visualize overlays of multimodal data. This is needed to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). In these cases data type may have different pixel sizes and slightly different orientations (i.e., one may be rotated relative to another).
-
- pattern: lab_processed\/transformations\/[^\/]*transformations\.txt
+ pattern: lab_processed\/transformations\/[^\/]+\.txt
required: False
description: Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains).
is_qa_qc: False
diff --git a/src/ingest_validation_tools/directory-schemas/histology-v2.yaml b/src/ingest_validation_tools/directory-schemas/histology-v2.yaml
index c6f2a88ca..222fdfa97 100644
--- a/src/ingest_validation_tools/directory-schemas/histology-v2.yaml
+++ b/src/ingest_validation_tools/directory-schemas/histology-v2.yaml
@@ -49,7 +49,7 @@ files:
required: False
description: This directory contains transformation matrices that capture how each modality is aligned with the other and can be used to visualize overlays of multimodal data. This is needed to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). In these cases data type may have different pixel sizes and slightly different orientations (i.e., one may be rotated relative to another).
-
- pattern: lab_processed\/transformations\/[^\/]*transformations\.txt
+ pattern: lab_processed\/transformations\/[^\/]+\.txt
required: False
description: Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains).
is_qa_qc: False
diff --git a/src/ingest_validation_tools/directory-schemas/lightsheet-v2.yaml b/src/ingest_validation_tools/directory-schemas/lightsheet-v2.yaml
index 3639072e9..eef40f4bb 100644
--- a/src/ingest_validation_tools/directory-schemas/lightsheet-v2.yaml
+++ b/src/ingest_validation_tools/directory-schemas/lightsheet-v2.yaml
@@ -59,7 +59,7 @@ files:
required: False
description: This directory contains transformation matrices that capture how each modality is aligned with the other and can be used to visualize overlays of multimodal data. This is needed to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). In these cases data type may have different pixel sizes and slightly different orientations (i.e., one may be rotated relative to another).
-
- pattern: lab_processed\/transformations\/[^\/]*transformations\.txt
+ pattern: lab_processed\/transformations\/[^\/]+\.txt
required: False
description: Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains).
is_qa_qc: False
diff --git a/src/ingest_validation_tools/directory-schemas/maldi-v2.yaml b/src/ingest_validation_tools/directory-schemas/maldi-v2.yaml
index 10ef5b573..37799ccab 100644
--- a/src/ingest_validation_tools/directory-schemas/maldi-v2.yaml
+++ b/src/ingest_validation_tools/directory-schemas/maldi-v2.yaml
@@ -45,7 +45,7 @@ files:
required: False
description: Directory containing image transformations.
-
- pattern: lab_processed\/transformations\/[^\/]*transformations\.txt
+ pattern: lab_processed\/transformations\/[^\/]+\.txt
required: False
description: Transformations/map back to autofluorescence microscopy (related) data
-
@@ -57,3 +57,4 @@ files:
required: True
description: TSV file containing the m/z, molecular assignment, etc.
+
diff --git a/src/ingest_validation_tools/directory-schemas/second-harmonic-generation-v2.yaml b/src/ingest_validation_tools/directory-schemas/second-harmonic-generation-v2.yaml
index 57a6c3add..40e374130 100644
--- a/src/ingest_validation_tools/directory-schemas/second-harmonic-generation-v2.yaml
+++ b/src/ingest_validation_tools/directory-schemas/second-harmonic-generation-v2.yaml
@@ -64,7 +64,7 @@ files:
required: False
description: This directory contains transformation matrices that capture how each modality is aligned with the other and can be used to visualize overlays of multimodal data. This is needed to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). In these cases data type may have different pixel sizes and slightly different orientations (i.e., one may be rotated relative to another).
-
- pattern: lab_processed\/transformations\/[^\/]*transformations\.txt
+ pattern: lab_processed\/transformations\/[^\/]+\.txt
required: False
description: Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains).
is_qa_qc: False
diff --git a/src/ingest_validation_tools/directory-schemas/sims-v2.yaml b/src/ingest_validation_tools/directory-schemas/sims-v2.yaml
index 10ef5b573..85afe980c 100644
--- a/src/ingest_validation_tools/directory-schemas/sims-v2.yaml
+++ b/src/ingest_validation_tools/directory-schemas/sims-v2.yaml
@@ -45,7 +45,7 @@ files:
required: False
description: Directory containing image transformations.
-
- pattern: lab_processed\/transformations\/[^\/]*transformations\.txt
+ pattern: lab_processed\/transformations\/[^\/]+\.txt
required: False
description: Transformations/map back to autofluorescence microscopy (related) data
-
diff --git a/src/ingest_validation_tools/directory-schemas/thick-section-multiphoton-mxif-v2.yaml b/src/ingest_validation_tools/directory-schemas/thick-section-multiphoton-mxif-v2.yaml
index 57a6c3add..40e374130 100644
--- a/src/ingest_validation_tools/directory-schemas/thick-section-multiphoton-mxif-v2.yaml
+++ b/src/ingest_validation_tools/directory-schemas/thick-section-multiphoton-mxif-v2.yaml
@@ -64,7 +64,7 @@ files:
required: False
description: This directory contains transformation matrices that capture how each modality is aligned with the other and can be used to visualize overlays of multimodal data. This is needed to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). In these cases data type may have different pixel sizes and slightly different orientations (i.e., one may be rotated relative to another).
-
- pattern: lab_processed\/transformations\/[^\/]*transformations\.txt
+ pattern: lab_processed\/transformations\/[^\/]+\.txt
required: False
description: Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains).
is_qa_qc: False
diff --git a/src/ingest_validation_tools/directory-schemas/visium-no-probes-v2.yaml b/src/ingest_validation_tools/directory-schemas/visium-no-probes-v2.yaml
index e81280ff9..828ad2784 100644
--- a/src/ingest_validation_tools/directory-schemas/visium-no-probes-v2.yaml
+++ b/src/ingest_validation_tools/directory-schemas/visium-no-probes-v2.yaml
@@ -68,7 +68,7 @@ files:
required: False
description: This directory contains transformation matrices that capture how each modality is aligned with the other and can be used to visualize overlays of multimodal data. This is needed to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains). In these cases data type may have different pixel sizes and slightly different orientations (i.e., one may be rotated relative to another).
-
- pattern: lab_processed\/transformations\/[^\/]*transformations\.txt
+ pattern: lab_processed\/transformations\/[^\/]+\.txt
required: False
description: Transformation matrices used to overlay images from the exact same tissue section (e.g., MALDI imaging mass spec, autofluorescence microscopy, MxIF, histological stains).
is_qa_qc: False
@@ -77,4 +77,3 @@ files:
required: False
description: Directory containing segmentation masks.
dependency: segmentation-masks-v2
-
From baaf03400085f5ffd909b92ab9cac68ea1f1902a Mon Sep 17 00:00:00 2001
From: jpuerto-psc <68066250+jpuerto-psc@users.noreply.github.com>
Date: Thu, 7 Dec 2023 16:16:41 -0500
Subject: [PATCH 04/11] Jpuerto/remove cedar organ (#1271)
* General: Remove CEDAR organ page
* General: Remove CEDAR organ page
---------
Co-authored-by: Juan Puerto <=>
---
CHANGELOG.md | 1 +
docs/field-assays.yaml | 5 ---
docs/field-descriptions.yaml | 3 +-
docs/field-entities.yaml | 3 --
docs/field-schemas.xlsx | Bin 33293 -> 33329 bytes
docs/field-schemas.yaml | 3 --
docs/organ/current/README.md | 1 -
docs/organ/current/index.md | 29 ------------------
.../table-schemas/others/organ-v3.yaml | 20 ------------
9 files changed, 3 insertions(+), 62 deletions(-)
delete mode 100644 docs/organ/current/README.md
delete mode 100644 docs/organ/current/index.md
delete mode 100644 src/ingest_validation_tools/table-schemas/others/organ-v3.yaml
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 83af2652c..cead8c3c2 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -62,6 +62,7 @@
- Add CODEX, Thick section Multiphoton MxIF, Second Harmonic Generation, and Enhanced Stimulated Raman Spectroscopy (SRS) next-gen directory schemas
- Move Thick section Multiphoton MxIF next-gen directory schema to placeholder file
- Update file path in Visium no probes, Histology, AF, MxIF, SHG, SRS, Confocal, Light Sheet, MALDI, SIMS, DESI
+- Remove Organ CEDAR page
## v0.0.15 - 2023-04-04
diff --git a/docs/field-assays.yaml b/docs/field-assays.yaml
index 0f9894221..faadd87a7 100644
--- a/docs/field-assays.yaml
+++ b/docs/field-assays.yaml
@@ -233,7 +233,6 @@ assay_category:
- NanoDESI
- NanoPOTS
- OCT
-- Organ
- PAS microscopy
- PhenoCycler
- RNAseq
@@ -319,7 +318,6 @@ assay_type:
- NanoDESI
- NanoPOTS
- OCT
-- Organ
- PAS microscopy
- PhenoCycler
- Publication
@@ -838,7 +836,6 @@ is_cedar:
- Molecular Cartography
- Multiplex Ion Beam Imaging
- OCT
-- Organ
- PAS microscopy
- PhenoCycler
- Publication
@@ -1534,8 +1531,6 @@ operator_email:
- snRNAseq
- snRNAseq-10xGenomics-v2
- snRNAseq-10xGenomics-v3
-organ_id:
-- Organ
overall_protocols_io_doi:
- AF
- CE-MS
diff --git a/docs/field-descriptions.yaml b/docs/field-descriptions.yaml
index 70164f270..c0d1798e4 100644
--- a/docs/field-descriptions.yaml
+++ b/docs/field-descriptions.yaml
@@ -268,7 +268,8 @@ orcid_id: ORCID ID of contributor
organ_condition: Health status of the organ at the time of sample recovery.
organ_height_unit: Height unit.
organ_height_value: The height value of the organ.
-organ_id: UUID or HuBMAP ID of organ
+organ_id: Unique HuBMAP identifier for the organ. This can be found in the Submission
+ ID section of a registered donor on the Ingest UI.
organ_length_unit: Length unit.
organ_length_value: The length value of the organ.
organ_volume_unit: Volume unit.
diff --git a/docs/field-entities.yaml b/docs/field-entities.yaml
index c246b3bcf..81484128b 100644
--- a/docs/field-entities.yaml
+++ b/docs/field-entities.yaml
@@ -38,11 +38,9 @@ area_value:
- sample
assay_category:
- dataset
-- organ
- sample
assay_type:
- dataset
-- organ
- sample
bead_barcode_offset:
- dataset
@@ -200,7 +198,6 @@ is_cedar:
- antibodies
- contributors
- dataset
-- organ
- sample
is_contact:
- contributors
diff --git a/docs/field-schemas.xlsx b/docs/field-schemas.xlsx
index 8ec5c4ecaf53f272fbfa0edec9f7f32516ee6c91..cb08542b4b0adc81bc90412c745d812f15619412 100644
GIT binary patch
delta 19825
zcmZs?1CV7)w>8>j+qP}n?k?N5UA3#rwr#t*>@M53ZTqitzWeU|-+eD)MXWV)W@hA`
zIp@eR*NPn#2wWEkT)PAUC0t5L3r6tchjGI;$SD|r_Zb9#3kc!bPr|)Ngm;?>|C$iN
zJrRO;90dOeDdsM8$fJLcch>>`hBL-JQ-XJr9B2!w0T**ry!!BF{B*uWP*1bjN-LPqgF#U(aMK_In
zeGt$vSP*XWHF{WVD97wQ0=~@}AVpDdaDpq4t?%#4;*v#BV+EJ+4eesx0vnF(x||Z*
zzpSa}vW0ft@Y;se_s#)8P6Kwh?GM*=5s_H(DlZbSI>y#LitpJZPae<1Hbk`b-=93R
zPbroLYnz4`2NS_K!Y!WB#|tJ4E6T7D{g5+y=E$D8#b1jB**l^qD{_8VA(zW#MGMLK
zJg-b#R8y
z2XgME$@4h=B8(J&KMSUGh#wqMaFDC^AI+d5?SKZTtx?oT@e
Q@8%pAg!-A|50g>XM@i7dUlKzyaaXFM-~fN*BB8y+?i_qP=Tx
zwdEK6-G#A-mr9W(K37cc_YeyQf>2M9bA%g0OY_}Ps4HBxgo9Ao;mEoF0ZNde;am{E
zK5!4XfVr{$@}g%n!{MBQfj#?+JW5XmMxtfQnye!#R_9!&OLxb;fO3e^>r4w~kMMHu
z2^Pd70*uB+j%bbc@}-ky#9Dj}a$$O&hI4@$fMrq>zTCC!@l?a(z6I}zwsXbgn=5hD
zUvs<-g|_NYvn91qIg3ue0YsaV@(e*9c^d)%+G`5(OV`Utj*V1y&@=q7