stereo.io.write_h5mu¶

stereo.io.write_h5mu(ms_data, output=None, compression='gzip')[source]¶

Convert the MSData to a MuData and save it as a h5mu file.

The single samples saved in MSData.data_list are named as ‘sample_{i}’. The scope data merged from some samples are named starting with ‘scope_[{i0,i1,i2…}]’.

Parameters:

ms_data (MSData) – The object of MSData to be converted and saved.
output (Optional[str]) – The path of file into which MSData is saved, if None, Only convert the MSData to a MuData object.
compression (Optional[Literal['gzip', 'lzf']]) – The compression method used to save the h5mu file.

Returns:

The MuData object.

Note

You need to install the mudata package before using this function:

pip install mudata