muspan.datasets.

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

  • Macrophage-hypoxia-ROI

  • Mouse-Colon-Carcinoma

  • Synthetic-Points-Density

  • Synthetic-Points-Clusters

  • Synthetic-Points-Aggregation

  • Synthetic-Points-Exclusion

  • Synthetic-Points-Architecture

Examples

>>> example_domain=load_example_domain('Synthetic-Points-Aggregation')