mne.io.read_raw_boxy¶
-
mne.io.
read_raw_boxy
(fname, preload=False, verbose=None)[source]¶ Reader for an optical imaging recording.
This function has been tested using the ISS Imagent I and II systems and versions 0.40/0.84 of the BOXY recording software.
- Parameters
- fname
str
Path to the BOXY data file.
- preloadbool or
str
(defaultFalse
) Preload data into memory for data manipulation and faster indexing. If True, the data will be preloaded into memory (fast, requires large amount of memory). If preload is a string, preload is the file name of a memory-mapped file which is used to store the data on the hard drive (slower, requires less memory).
- verbosebool,
str
,int
, orNone
If not None, override default verbose level (see
mne.verbose()
and Logging documentation for more). If used, it should be passed as a keyword-argument only.
- fname
- Returns
- rawinstance of RawBOXY
A Raw object containing BOXY data.
See also
mne.io.Raw
Documentation of attribute and methods.