Method as_volume

mne/source_estimate.py:2578–2618

Export volume source estimate as a nifti object. Parameters ---------- src : instance of SourceSpaces The source spaces (should all be of type volume, or part of a mixed source space). dest : ``'mri'`` | ``'surf'`` If ``'mri'`` the

(
        self,
        src,
        dest="mri",
        mri_resolution=False,
        format="nifti1",  # noqa: A002
    )

        nib.save(img, fname)

    def as_volume(
        self,
        src,
        dest="mri",
        mri_resolution=False,
        format="nifti1",  # noqa: A002
    ):
        """Export volume source estimate as a nifti object.

        Parameters
        ----------
        src : instance of SourceSpaces
            The source spaces (should all be of type volume, or part of a
            mixed source space).
        dest : ``'mri'`` | ``'surf'``
            If ``'mri'`` the volume is defined in the coordinate system of
            the original T1 image. If 'surf' the coordinate system
            of the FreeSurfer surface is used (Surface RAS).
        mri_resolution : bool
            It True the image is saved in MRI resolution.

            .. warning: If you have many time points the file produced can be
                        huge. The default is ``mri_resolution=False``.
        format : str
            Either 'nifti1' (default) or 'nifti2'.

        Returns
        -------
        img : instance of Nifti1Image
            The image object.

        Notes
        -----
        .. versionadded:: 0.9.0
        """
        from .morph import _interpolate_data

        data = self.magnitude() if self._data_ndim == 3 else self
        return _interpolate_data(
            data, src, mri_resolution=mri_resolution, mri_space=True, output=format
        )


@fill_doc