mne.io.read_raw_boxy#
- mne.io.read_raw_boxy(fname: Path | str, preload: bool | str = False, verbose: bool | str | int | None = None) RawBOXY[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:
- fnamepath-like
Path to the BOXY data file.
- preloadbool |
str 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|None Control verbosity of the logging output. If
None, use the default verbosity level. See the logging documentation andmne.verbose()for details. Should only be passed as a keyword argument.
- Returns:
- rawinstance of
RawBOXY A Raw object containing BOXY data. See
mne.io.Rawfor documentation of attributes and methods.
- rawinstance of
See also
mne.io.RawDocumentation of attributes and methods of RawBOXY.