Method save

mne/preprocessing/ica.py:2426–2459

Store ICA solution into a fiff file. Parameters ---------- fname : path-like The absolute path of the file name to save the ICA solution into. The file name should end with ``-ica.fif`` or ``-ica.fif.gz``. %(overwrite)s .. version

(self, fname, *, overwrite=False, verbose=None)

    @verbose
    def save(self, fname, *, overwrite=False, verbose=None):
        """Store ICA solution into a fiff file.

        Parameters
        ----------
        fname : path-like
            The absolute path of the file name to save the ICA solution into.
            The file name should end with ``-ica.fif`` or ``-ica.fif.gz``.
        %(overwrite)s

            .. versionadded:: 1.0
        %(verbose)s

        Returns
        -------
        ica : instance of ICA
            The object.

        See Also
        --------
        read_ica
        """
        if self.current_fit == "unfitted":
            raise RuntimeError("No fit available. Please first fit ICA")

        check_fname(
            fname, "ICA", ("-ica.fif", "-ica.fif.gz", "_ica.fif", "_ica.fif.gz")
        )
        fname = _check_fname(fname, overwrite=overwrite)

        logger.info(f"Writing ICA solution to {fname}...")
        with start_and_end_file(fname) as fid:
            _write_ica(fid, self)
        return self

    def copy(self):
        """Copy the ICA object.