load_example_domain

load_example_domain(domain_name)

Load an example domain file.

Parameters:

domain_namestr

The name of the domain to load. If not provided, a ValueError is raised.

Returns:

object

The loaded domain object.

Raises:

ValueError

If domain_name is not provided.

Notes

The available domains are:

• Xenium-Healthy-Colon

• Visium-Colon-Adenocarcinoma

• Macrophage-Hypoxia-ROI

• Mouse-Colon-Carcinoma

• Synthetic-Points-Random

• Synthetic-Points-Aggregation

• Synthetic-Points-Exclusion

• Synthetic-Points-Architecture

• Earth-Land-Map

Examples

import muspan as ms

# load the synthetic points architecture dataset stored within MuSpAn
loaded_domain = ms.datasets.load_example_domain('Synthetic-Points-Architecture')