CLI Reference#
The package offers a command line interface (CLI). Installing the
package (into an environment) will make the command irdl available (in that
environment). All supported datasets are offered as subcommands. Please refer to
below documentation for reference or use --help to display the documentation
in the terminal.
irdl#
Usage
irdl [OPTIONS] COMMAND [ARGS]...
Options
- --install-completion#
Install completion for the current shell.
- --show-completion#
Show completion for the current shell, to copy it or customize the installation.
fabian#
Download and extract the FABIAN HRTF Database v4 from DepositOnce.
DOI: 10.14279/depositonce-5718.5
Usage
irdl fabian [OPTIONS]
Options
- --kind <kind>#
Type of HRTF to download. Either ‘measured’ or ‘modeled’.
- Default:
'measured'
- --hato <hato>#
Head-above-torso-rotation of HRTFs in degrees. Either 0, 10, 20, 30, 40, 50, 310, 320, 330, 340 or 350.
- Default:
0
- --path <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.
- Default:
PosixPath('/home/runner/.cache/irdl')
- --output-format <output_format>#
Output format of the returned data. Either ‘pyfar’ (default), ‘hdf5’, or ‘numpy’.
- Default:
'pyfar'
miracle#
Download and extract the MIRACLE database from DepositOnce.
DOI: 10.14279/depositonce-20837
Usage
irdl miracle [OPTIONS]
Options
- --scenario <scenario>#
Name of the scenario to download. Either ‘A1’, ‘A2’, ‘D1’ or ‘R2’.
- Default:
'A1'
- --dataset-split <dataset_split>#
Artificial dataset split. Analogous to dataset_split in :func:get_sriracha. One of ‘C1’, ‘C2’, ‘C3’, ‘C4’, or None (default).
- --path <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.
- Default:
PosixPath('/home/runner/.cache/irdl')
- --output-format <output_format>#
Output format of the returned data. Either ‘pyfar’ (default), ‘hdf5’, or ‘numpy’.
- Default:
'pyfar'
sriracha#
Download and extract the SRIRACHA database from DepositOnce.
DOI: 10.14279/depositonce-23943
Usage
irdl sriracha [OPTIONS]
Options
- --scenario <scenario>#
Name of the scenario to download. One of ‘SR1’, ‘SRA1’, ‘SR1-D’, ‘SRA1-D’, ‘SR2’, ‘SRA2’, ‘SR2-D’, or ‘SRA2-D’.
- Default:
'SR1-D'
- --dataset-split <dataset_split>#
Optional dataset split for full-plane scenarios. One of ‘C1’, ‘C2’, ‘C3’, ‘C4’, or None (default). Dense scenarios (ending in -D)do not have splits.
- --path <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.
- Default:
PosixPath('/home/runner/.cache/irdl')
- --output-format <output_format>#
Output format of the returned data. Either ‘pyfar’ (default), ‘hdf5’, or ‘numpy’.
- Default:
'pyfar'