Class RawArray

mne/io/array/_array.py:14–96

Raw object from numpy array. Parameters ---------- data : array, shape (n_channels, n_times) The channels' time series. See notes for proper units of measure. %(info_not_none)s Consider using :func:`mne.create_info` to populate this structure. This may be modified in

@fill_doc
class RawArray(BaseRaw):
    """Raw object from numpy array.

    Parameters
    ----------
    data : array, shape (n_channels, n_times)
        The channels' time series. See notes for proper units of measure.
    %(info_not_none)s Consider using :func:`mne.create_info` to populate
        this structure. This may be modified in place by the class.
    first_samp : int
        First sample offset used during recording (default 0).

        .. versionadded:: 0.12
    copy : {'data', 'info', 'both', 'auto', None}
        Determines what gets copied on instantiation. "auto" (default)
        will copy info, and copy "data" only if necessary to get to
        double floating point precision.

        .. versionadded:: 0.18
    %(verbose)s

    See Also
    --------
    mne.EpochsArray
    mne.EvokedArray
    mne.create_info

    Notes
    -----
    Proper units of measure:

    * V: eeg, eog, seeg, dbs, emg, ecg, bio, ecog
    * T: mag
    * T/m: grad
    * M: hbo, hbr
    * Am: dipole
    * AU: misc
    """

    @verbose
    def __init__(self, data, info, first_samp=0, copy="auto", verbose=None):
        _validate_type(info, "info", "info")
        _check_option("copy", copy, ("data", "info", "both", "auto", None))
        dtype = np.complex128 if np.any(np.iscomplex(data)) else np.float64
        orig_data = data
        data = np.asanyarray(orig_data, dtype=dtype)
        if data.ndim != 2:
            raise ValueError(
                "Data must be a 2D array of shape (n_channels, n_samples), got shape "
                f"{data.shape}"
            )
        if len(data) != len(info["ch_names"]):
            raise ValueError(
                'len(data) ({}) does not match len(info["ch_names"]) ({})'.format(
                    len(data), len(info["ch_names"])
                )
            )
        assert len(info["ch_names"]) == info["nchan"]