traveler.skims.omx.OMX.add_matrix#

OMX.add_matrix(name, obj, *, overwrite=False, complevel=1, complib='zlib', ignore_shape=False, **kwargs)[source]#

Add a matrix to the OMX file.

Parameters:

  • name (str) – The name of the matrix to add.

  • obj (array-like) – The data for the new matrix.

  • overwrite (bool, default False) – Whether to overwrite an existing matrix with the same name.

  • complevel (int, default 1) – Compression level.

  • complib (str, default 'zlib') – Compression library.

  • ignore_shape (bool, default False) – Whether to ignore all checks on the shape of the matrix being added. Setting this to True allows adding a matrix with a different shape than any other existing matrices, which may result in an invalid OMX file.

Return type:

h5py.Dataset