Function test_read_labels_from_annot

mne/tests/test_label.py:469–543

Test reading labels from FreeSurfer parcellation.

(tmp_path)

@testing.requires_testing_data
def test_read_labels_from_annot(tmp_path):
    """Test reading labels from FreeSurfer parcellation."""
    pytest.importorskip("nibabel")
    # test some invalid inputs
    pytest.raises(
        ValueError,
        read_labels_from_annot,
        "sample",
        hemi="bla",
        subjects_dir=subjects_dir,
    )
    pytest.raises(
        ValueError,
        read_labels_from_annot,
        "sample",
        annot_fname="bla.annot",
        subjects_dir=subjects_dir,
    )
    with pytest.raises(OSError, match="does not exist"):
        _read_annot_cands("foo")
    with pytest.raises(OSError, match="no candidate"):
        _read_annot(str(tmp_path))

    # read labels using hemi specification
    labels_lh = read_labels_from_annot("sample", hemi="lh", subjects_dir=subjects_dir)
    for label in labels_lh:
        assert label.name.endswith("-lh")
        assert label.hemi == "lh"
        assert label.color is not None

    # read labels using annot_fname
    annot_fname = subjects_dir / "sample" / "label" / "rh.aparc.annot"
    labels_rh = read_labels_from_annot(
        "sample", annot_fname=annot_fname, subjects_dir=subjects_dir
    )
    for label in labels_rh:
        assert label.name.endswith("-rh")
        assert label.hemi == "rh"
        assert label.color is not None

    # combine the lh, rh, labels and sort them
    labels_lhrh = list()
    labels_lhrh.extend(labels_lh)
    labels_lhrh.extend(labels_rh)

    names = [label.name for label in labels_lhrh]
    labels_lhrh = [label for (name, label) in sorted(zip(names, labels_lhrh))]

    # read all labels at once
    labels_both = read_labels_from_annot("sample", subjects_dir=subjects_dir)

    # we have the same result
    _assert_labels_equal(labels_lhrh, labels_both)

    # aparc has 68 cortical labels
    assert len(labels_both) == 68

    # test regexp