Source code for pycrostates.io.reader

"""Reader module to reader clusters."""

from pathlib import Path

from ..utils._checks import _check_type
from ..utils._docs import fill_doc
from ..utils._logs import logger
from .fiff import _read_cluster as _read_cluster_fif




@fill_doc
def read_cluster(fname: str | Path):
    """Read clustering solution from disk.

    Parameters
    ----------
    %(fname_fiff)s

    Returns
    -------
    cluster : :ref:`Clustering`
        Fitted clustering instance.
    """
    _check_type(fname, ("path-like",), "fname")
    fname = Path(fname)

    readers = {
        ".fif": _read_cluster_fif,
        ".fif.gz": _read_cluster_fif,
    }

    ext = "".join(fname.suffixes)
    if ext in readers:
        cluster, version = readers[ext](fname)
        logger.info("Cluster solution loaded was saved with pycrostates '%s'.", version)
        return cluster
    else:
        raise ValueError("File format is not supported.")