nispace.datasets.fetch_plot

nispace.datasets.fetch_plot(name, kind=None, display=False, nispace_data_dir=None, overwrite=False, check_file_hash=True, verbose=True)[source]

Fetch the overview plot PNG for a parcellation or reference dataset.

Parameters:

  • name (str) – Parcellation name (e.g. "Yan200") or reference dataset name (e.g. "pet").

  • kind ({"parcellation", "reference"}, optional) – Whether to look up name in the parcellation or reference library. If None (default), both libraries are searched automatically.

  • display (bool) – If True, display the image inline (Jupyter / IPython).

  • nispace_data_dir (str or Path, optional) – Override the NiSpace data directory (deprecated; use NISPACE_DATA_DIR).

  • overwrite (bool) – Re-download even if the local file already exists.

  • check_file_hash (bool) – Verify SHA-256 against the known hash after download.

  • verbose (bool) – Enable verbose logging.

Returns:

Local path to the downloaded PNG file.

Return type:

Path