Write source spaces to a file. Parameters ---------- fname : path-like The name of the file, which should end with ``-src.fif`` or ``-src.fif.gz``. src : instance of SourceSpaces The source spaces (as returned by read_source_spaces). %(overwrite)s %(v
(fname, src, *, overwrite=False, verbose=None)
| 1287 | |
| 1288 | @verbose |
| 1289 | def write_source_spaces(fname, src, *, overwrite=False, verbose=None): |
| 1290 | """Write source spaces to a file. |
| 1291 | |
| 1292 | Parameters |
| 1293 | ---------- |
| 1294 | fname : path-like |
| 1295 | The name of the file, which should end with ``-src.fif`` or |
| 1296 | ``-src.fif.gz``. |
| 1297 | src : instance of SourceSpaces |
| 1298 | The source spaces (as returned by read_source_spaces). |
| 1299 | %(overwrite)s |
| 1300 | %(verbose)s |
| 1301 | |
| 1302 | See Also |
| 1303 | -------- |
| 1304 | read_source_spaces |
| 1305 | """ |
| 1306 | _validate_type(src, SourceSpaces, "src") |
| 1307 | check_fname( |
| 1308 | fname, "source space", ("-src.fif", "-src.fif.gz", "_src.fif", "_src.fif.gz") |
| 1309 | ) |
| 1310 | _check_fname(fname, overwrite=overwrite) |
| 1311 | |
| 1312 | with start_and_end_file(fname) as fid: |
| 1313 | _write_source_spaces(fid, src) |
| 1314 | |
| 1315 | |
| 1316 | def _write_source_spaces(fid, src): |