HTAN Imaging Data

The HTAN data model for imaging data is based upon the Minimum Information about Tissue Imaging (MITI) reporting guidelines. These comprise minimal metadata for highly multiplexed tissue images and were developed in consultation with methods developers, experts in imaging metadata (e.g., DICOM and OME) and multiple large-scale atlasing projects; they are guided by existing standards and accommodate most multiplexed imaging technologies and both centralized and distributed data storage.

For further information on the MITI guidelines, please see the MITI website, specification on Github, and Nature Methods publication.

The HTAN data model for imaging was intended primarily for multiplexed imaging, such as CODEX, CyCIF, and IMC, in addition to brightfield imaging of H&E stained tissues.

As with sequencing data, the imaging data model is split into data levels as follows:

LevelDescription
1Raw imaging data requiring tiling, stitching, illumination correction, registration or other pre-processing.
2Imaging data compiled into a single file format, preferably a tiled and pyramidal OME-TIFF.

Accompanied by a csv file containing channel metadata.
3Segmentation mask, Validated channel metadata, QC checked image.
4An object-by-feature table (typically cell-by-marker) generated from the segmentation mask and image.

Attributes

WARNING: Manifests provided on this page are for reference only. DO NOT USE THESE MANIFESTS FOR DATA SUBMISSION.

Directions

The interactive tables below are provided to help users understand the HTAN Data Model. The tables allow a user to view, search or download attributes either:

  1. in a specific manifest; or
  2. in all manifests represented on this page.

To view a specific manifest, click on the link in the Manifests tab. The manifest will appear in a new tab on the page. Navigate to the new tab to search for attributes or download the manifest.
To search for attributes among all manifests, navigate to the All Attributes tab and use the search box provided at the top of the tab. All attributes can also be downloaded as a csv file.

Manifest
Description
Raw imaging data
Raw and pre-processed image data
Object segmentations
Derived imaging data: Object-by-feature array
Attribute
Manifest Name
Description
Required
Conditional If
Data Type
Valid Values
Filename
- Imaging Level 1
- Imaging Level 2
- Imaging Level 3
- Imaging Level 4
Name of a file
True
String
File Format
- Imaging Level 1
- Imaging Level 2
- Imaging Level 3
- Imaging Level 4
Format of a file (e.g. txt, csv, fastq, bam, etc.)
True
String
- hdf5
- bedgraph
- idx
- idat
- bam
- bai
- excel
- powerpoint
- tif
- tiff
- ome-tiff
- png
- doc
- pdf
- fasta
- fastq
- sam
- vcf
- bcf
- maf
- bed
- chp
- cel
- sif
- tsv
- csv
- txt
- plink
- bigwig
- wiggle
- gct
- bgzip
- zip
- seg
- html
- mov
- hyperlink
- svs
- md
- flagstat
- gtf
- raw
- msf
- rmd
- bed narrowpeak
- bed broadpeak
- bed gappedpeak
- avi
- pzfx
- fig
- xml
- tar
- r script
- abf
- bpm
- dat
- jpg
- locs
- sentrix descriptor file
- python script
- sav
- gzip
- sdf
- rdata
- hic
- ab1
- 7z
- gff3
- json
- sqlite
- svg
- sra
- recal
- tranches
- mtx
- tagalign
- dup
- dicom
- czi
- mex
- cloupe
- am
- cell am
- mpg
- m
- mzml
- scn
- dcc
- rcc
- pkc
- sf
- bedpe
HTAN Parent Biospecimen ID
- Imaging Level 1
- Imaging Level 2
HTAN Biospecimen Identifier (eg HTANx_yyy_zzz) indicating the biospecimen(s) from which these files were derived; multiple parent biospecimen should be comma-separated
True
- Is lowest level is "Yes - Is lowest level"
String
HTAN Data File ID
- Imaging Level 1
- Imaging Level 2
- Imaging Level 3
- Imaging Level 4
Self-identifier for this data file - HTAN ID of this file HTAN ID SOP (eg HTANx_yyy_zzz)
True
String
Imaging Assay Type
- Imaging Level 1
- Imaging Level 2
Type of imaging assay
True
String
- h&e
- cycif
- t-cycif
- ihc
- mihc
- mxif
- saber
- imc
- codex
- geomx-dsp
- mibi
- merfish
- exseq
- rarecyte orion
- not applicable
Software and Version
- Imaging Level 1
- Imaging Level 2
- Imaging Level 3
- Imaging Level 4
Name of software used to generate expression values. String
True
- Pseudo Alignment Used is "Yes - Pseudo Alignment Used"
String
Commit SHA
- Imaging Level 1
- Imaging Level 3
- Imaging Level 4
Short SHA for software version [8 hexadecimal characters (for github), comma separated if multiple]
False
String
Pre-processing Completed
- Imaging Level 1
Pre-processing steps completed to convert level 1 raw data to a single level 2 image
True
String
- illumination correction
- tile stitching
- channel/cycle registration
- tma de-arraying
- none
- other
Pre-processing Required
- Imaging Level 1
Pre-processing steps required to convert level 1 raw data to a single level 2 image
True
String
- illumination correction
- tile stitching
- channel/cycle registration
- tma de-arraying
- none
- other
Comment
- Imaging Level 1
- Imaging Level 2
Free text field (generally for QC comment)
False
- Passed QC is "No - Channels QC"
String
HTAN Participant ID
- Imaging Level 2
HTAN ID associated with a patient based on HTAN ID SOP (eg HTANx_yyy )
True
String
Channel Metadata Filename
- Imaging Level 2
Full path within Synapse project of uploaded companion CSV file containing channel-level metadata details
True
String
Microscope
- Imaging Level 2
Microscope type (manufacturer, model, etc) used for this experiment
True
String
Objective
- Imaging Level 2
Objective
False
String
NominalMagnification
- Imaging Level 2
The magnification of the lens as specified by the manufacturer - i.e. '60' is a 60X lens. floating point value > 1(no units)
True
String
LensNA
- Imaging Level 2
The numerical aperture of the lens. Floating point value > 0.
False
String
WorkingDistance
- Imaging Level 2
The working distance of the lens, expressed as a floating point number. Floating point > 0.
False
String
WorkingDistanceUnit
- Imaging Level 2
The units of the working distance. See OME enumeration of allowed values for the UnitsLength attribute -- default: microns (um)
False
String
- cm
- mm
- µm
- nm
- å
Immersion
- Imaging Level 2
Immersion medium
False
String
- air
- oil
- water
- other
Pyramid
- Imaging Level 2
Does data file contain pyramid of images
True
String
- yes
- no
Zstack
- Imaging Level 2
Does data file contain a Z-stack of images
True
String
- yes
- no
Tseries
- Imaging Level 2
Does data file contain a time-series of images
True
String
- yes
- no
Passed QC
- Imaging Level 2
Did all channels pass QC (if not add free text Comment)
True
String
- yes
- no - channels qc
FOV number
- Imaging Level 2
Index of FOV (as it pertains to its sequence order). Integer >= 1
False
String
FOVX
- Imaging Level 2
Field of view X dimension. Floating point
False
String
FOVXUnit
- Imaging Level 2
Field of view X dimension units. See OME enumeration of allowed values for the UnitsLength attribute -- default: microns (um)
False
String
- cm
- mm
- µm
- nm
- å
FOVY
- Imaging Level 2
Field of view Y dimension. Floating point value
False
String
FOVYUnit
- Imaging Level 2
Field of view Y dimension units. See OME enumeration of allowed values for the UnitsLength attribute -- default: microns (um)
False
String
- cm
- mm
- µm
- nm
- å
Frame Averaging
- Imaging Level 2
Number of frames averaged together (if no averaging, set to 1). Integer >= 1
False
String
Image ID
- Imaging Level 2
Unique internal image identifier. eg "Image:0". (To be extracted from OME-XML)
True
String
DimensionOrder
- Imaging Level 2
The order in which the individual planes of data are interleaved.
True
String
- xyzct
- xyztc
- xyctz
- xyczt
- xytzc
- zyx
PhysicalSizeX
- Imaging Level 2
Physical size (X-dimension) of a pixel. Units are set by PhysicalSizeXUnit. Floating point value > 0.
True
String
PhysicalSizeXUnit
- Imaging Level 2
The units of the physical size of a pixel. See OME enumeration of allowed values for the UnitsLength attribute -- default: microns (um)
True
String
- cm
- mm
- µm
- nm
- å
PhysicalSizeY
- Imaging Level 2
Physical size (Y-dimension) of a pixel. Units are set by PhysicalSizeYUnit. Floating point value > 0.
True
String
PhysicalSizeYUnit
- Imaging Level 2
The units of the physical size of a pixel. See OME enumeration of allowed values for the UnitsLength attribute -- default: microns (um)
True
String
- cm
- mm
- µm
- nm
- å
PhysicalSizeZ
- Imaging Level 2
Physical size (Z-dimension) of a pixel. Units are set by PhysicalSizeZUnit. Floating point value > 0.
True
String
PhysicalSizeZUnit
- Imaging Level 2
The units of the physical size of a pixel. See OME enumeration of allowed values for the UnitsLength attribute -- default: microns (um)
True
String
- cm
- mm
- µm
- nm
- å
Pixels BigEndian
- Imaging Level 2
Boolean (True/False)
True
String
- true
- false
PlaneCount
- Imaging Level 2
Number of Z-planes (not to be confused with downsampled "pyramid"). Integer >=1
True
String
SizeC
- Imaging Level 2
Number of channels. Integer >= 1
True
String
SizeT
- Imaging Level 2
Number of time points. Integer >= 1
True
String
SizeX
- Imaging Level 2
Size of image: X dimension (in pixels). Integer >= 1
True
String
SizeY
- Imaging Level 2
Size of image: Y dimension (in pixels). Integer >= 1
True
String
SizeZ
- Imaging Level 2
Size of image: Z dimension (in pixels). Integer >= 1
True
String
PixelType
- Imaging Level 2
Data type for each pixel value. E.g. "uint16"
True
String
- int8
- int16
- int32
- uint8
- uint16
- uint32
- float
- double
- bit
MERFISH Positions File
- Imaging Level 2
The positions file is an auxiliary MERFISH file that describes the location of bead positions in the assay.
False
String
MERFISH Codebook File
- Imaging Level 2
The codebook is an auxiliary MERFISH file that describes how each grouping of bits is converted to a gene name.
False
String
HTAN Parent Data File ID
- Imaging Level 3
- Imaging Level 4
HTAN Data File Identifier indicating the file(s) from which these files were derived
True
String
Imaging Segmentation Data Type
- Imaging Level 3
Specifies how the segmentation is stored
True
String
- mask
- outline
- polygon
- probability map
- point