Method pick

mne/channels/layout.py:146–256

Pick a subset of channels. Parameters ---------- %(picks_layout)s exclude : str | int | array-like of str or int Set of channels to exclude, only used when ``picks`` is set to ``'all'`` or ``None``. Exclude will not drop channels explicitly pr

(self, picks=None, exclude=(), *, verbose=None)

    @verbose
    def pick(self, picks=None, exclude=(), *, verbose=None):
        """Pick a subset of channels.

        Parameters
        ----------
        %(picks_layout)s
        exclude : str | int | array-like of str or int
            Set of channels to exclude, only used when ``picks`` is set to ``'all'`` or
            ``None``. Exclude will not drop channels explicitly provided in ``picks``.
        %(verbose)s

        Returns
        -------
        layout : instance of Layout
            The modified layout.

        Notes
        -----
        .. versionadded:: 1.7
        """
        # TODO: all the picking functions operates on an 'info' object which is missing
        # for a layout, thus we have to do the extra work here. The logic below can be
        # replaced when https://github.com/mne-tools/mne-python/issues/11913 is solved.
        if (isinstance(picks, str) and picks == "all") or (picks is None):
            picks = deepcopy(self.names)
            apply_exclude = True
        elif isinstance(picks, str):
            picks = [picks]
            apply_exclude = False
        elif isinstance(picks, slice):
            try:
                picks = np.arange(len(self.names))[picks]
            except TypeError:
                raise TypeError(
                    "If a slice is provided, it must be a slice of integers."
                )
            apply_exclude = False
        else:
            try:
                picks = [_ensure_int(picks)]
            except TypeError:
                picks = (
                    list(picks) if isinstance(picks, tuple | set) else deepcopy(picks)
                )
            apply_exclude = False
        if apply_exclude:
            if isinstance(exclude, str):
                exclude = [exclude]
            else:
                try:
                    exclude = [_ensure_int(exclude)]
                except TypeError:
                    exclude = (
                        list(exclude)
                        if isinstance(exclude, tuple | set)
                        else deepcopy(exclude)
                    )
        for var, var_name in ((picks, "picks"), (exclude, "exclude")):