irdl.get_miracle

irdl.get_miracle(scenario: str = 'A1', dataset_split: str = None, path: str = PosixPath('/home/runner/.cache/irdl'), output_format: str = 'pyfar')

Download and extract the MIRACLE database from DepositOnce.

DOI: 10.14279/depositonce-20837

Parameters:

scenariostr

Name of the scenario to download. Either 'A1', 'A2', 'D1' or 'R2'.

dataset_splitstr or None

Artificial dataset split. Analogous to dataset_split in get_sriracha(). One of 'C1', 'C2', 'C3', 'C4', or None (default).

pathstr or pathlib.Path

Path to the directory where the data should be stored. Will be overwritten, if the environment variable IRDL_DATA_DIR is set. Default is the user cache directory.

output_formatstr

Output format of the returned data. Either 'pyfar' (default), 'hdf5', or 'numpy'.

Returns:

datadict or pathlib.Path

Returned data depends on output_format:

• 'pyfar': dict with keys 'impulse_response' (pyfar.Signal), 'source_coordinates' (pyfar.Coordinates), and 'receiver_coordinates' (pyfar.Coordinates)

• 'hdf5': pathlib.Path to the HDF5 file containing the data.

• 'numpy': dict with keys 'impulse_response' (numpy.ndarray), 'source_coordinates' (numpy.ndarray), 'receiver_coordinates' (numpy.ndarray), and 'sampling_rate' (float).