Dataset Classes#

These classes define the main loading interfaces for the current on-disk dataset format: a base class, one dataset per modality (H&E, multiplex imaging such as IMC, CODEX, and CycIF, and IHC), a composed multimodal dataset, and a multi-cohort dataset.

BaseImagingDataset(name, modality, resolution)

Base class for all imaging datasets.

HEImagingDataset(name, resolution[, path, ...])

Class for handling H&E stained imaging datasets.

MultiplexImagingDataset(name, modality, ...)

Class for handling multiplex imaging datasets.

SingleIHCImagingDataset(name, marker_name, ...)

Class for handling IHC stained imaging datasets.

ComposedImagingDataset(name, modalities, ...)

Compose multiple unimodal datasets (HE, Multiplex, etc.) into a single handle.

SporaDataset(dataset_names, *[, ...])

Dataset-of-datasets wrapper for sampling tissues or tiles across cohorts.