Method split

mne/label.py:721–765

Split the Label into two or more parts. Parameters ---------- parts : int >= 2 | tuple of str | str Number of labels to create (default is 2), or tuple of strings specifying label names for new labels (from posterior to anterior), or 'cont

(self, parts=2, subject=None, subjects_dir=None, freesurfer=False)

    @fill_doc
    def split(self, parts=2, subject=None, subjects_dir=None, freesurfer=False):
        """Split the Label into two or more parts.

        Parameters
        ----------
        parts : int >= 2 | tuple of str | str
            Number of labels to create (default is 2), or tuple of strings
            specifying label names for new labels (from posterior to anterior),
            or 'contiguous' to split the label into connected components.
            If a number or 'contiguous' is specified, names of the new labels
            will be the input label's name with div1, div2 etc. appended.
        %(subject_label)s
        %(subjects_dir)s
        freesurfer : bool
            By default (``False``) ``split_label`` uses an algorithm that is
            slightly optimized for performance and numerical precision. Set
            ``freesurfer`` to ``True`` in order to replicate label splits from
            FreeSurfer's ``mris_divide_parcellation``.

        Returns
        -------
        labels : list of Label, shape (n_parts,)
            The labels, starting from the lowest to the highest end of the
            projection axis.

        Notes
        -----
        If using 'contiguous' split, you must ensure that the label being split
        uses the same triangular resolution as the surface mesh files in
        ``subjects_dir`` Also, some small fringe labels may be returned that
        are close (but not connected) to the large components.

        The spatial split finds the label's principal eigen-axis on the
        spherical surface, projects all label vertex coordinates onto this
        axis, and divides them at regular spatial intervals.
        """
        if isinstance(parts, str) and parts == "contiguous":
            return _split_label_contig(self, subject, subjects_dir)
        elif isinstance(parts, tuple | int):
            return split_label(self, parts, subject, subjects_dir, freesurfer)
        else:
            raise ValueError(
                "Need integer, tuple of strings, or string "
                f"('contiguous'). Got {type(parts)})"
            )

    def get_vertices_used(self, vertices=None):
        """Get the source space's vertices inside the label.