modelarrayio.storage.h5_storage.create_empty_scalar_matrix_dataset

modelarrayio.storage.h5_storage.create_empty_scalar_matrix_dataset(h5file, dataset_path, n_files, n_elements, storage_dtype='float32', compression='gzip', compression_level=4, shuffle=True, chunk_voxels=0, target_chunk_mb=2.0, sources_list=None | pandas.Series | list)[source]

Create an empty scalar matrix dataset in an HDF5 file.

Parameters:

  • h5file (h5py.File) – HDF5 file.

  • dataset_path (str) – Dataset path.

  • n_files (int) – Number of subjects.

  • n_elements (int) – Number of items.

  • storage_dtype (str) – Storage dtype.

  • compression (str) – Compression method.

  • compression_level (int) – Compression level.

  • shuffle (bool) – Whether to shuffle the data.

  • chunk_voxels (int) – Chunk voxels.

  • target_chunk_mb (float) – Target chunk size in MB.

  • sources_list (list) – Sources list.

Returns:

Empty scalar matrix dataset.

Return type:

h5py.Dataset