Class Projection

mne/_fiff/proj.py:38–196

Dictionary-like object holding a projection vector. Projection vectors are stored in a list in ``inst.info["projs"]``. Each projection vector has 5 keys: ``active``, ``data``, ``desc``, ``explained_var``, ``kind``. .. warning:: This class is generally not meant to be instantiated

class Projection(dict):
    """Dictionary-like object holding a projection vector.

    Projection vectors are stored in a list in ``inst.info["projs"]``. Each projection
    vector has 5 keys: ``active``, ``data``, ``desc``, ``explained_var``, ``kind``.

    .. warning:: This class is generally not meant to be instantiated
                 directly, use ``compute_proj_*`` functions instead.

    Parameters
    ----------
    data : dict
        The data dictionary.
    desc : str
        The projector description.
    kind : int
        The projector kind.
    active : bool
        Whether or not the projector has been applied.
    explained_var : float | None
        The proportion of explained variance.
    """

    def __init__(
        self,
        *,
        data,
        desc="",
        kind=FIFF.FIFFV_PROJ_ITEM_FIELD,
        active=False,
        explained_var=None,
    ):
        super().__init__(
            desc=desc, kind=kind, active=active, data=data, explained_var=explained_var
        )

    def __repr__(self):  # noqa: D105
        s = str(self["desc"])
        s += f", active : {self['active']}"
        s += f", n_channels : {len(self['data']['col_names'])}"
        if self["explained_var"] is not None:
            s += f", exp. var : {self['explained_var'] * 100:0.2f}%"
        return f"<Projection | {s}>"

    # speed up info copy by taking advantage of mutability
    def __deepcopy__(self, memodict):
        """Make a deepcopy."""
        cls = self.__class__
        result = cls.__new__(cls)
        for k, v in self.items():
            if k == "data":
                v = v.copy()
                v["data"] = v["data"].copy()
                result[k] = v
            else:
                result[k] = v  # kind, active, desc, explained_var immutable
        return result