HutubsDataset

class irdl.HutubsDataset

Bases: AKTZipBaseDataset

Download the HUTUBS HRTF database from DepositOnce.

_category = 'head_related_impulse_responses'

_source_filename(**dataset_kwargs) → str

Construct the ingest-ready SOFA file name.

_validate_params(**dataset_kwargs) → None

Validate HUTUBS-specific parameters.

_zipfile: str = 'HRIRs.zip'

doi: str = '10.14279/depositonce-8487'

classmethod get(subject: int = 1, kind: str = 'measured', cache_dir: str | Path | None = None, export_dir: str | Path | None = None, output_format: str = 'pyfar') → dict | Path | None

Download the HUTUBS HRTF database from DepositOnce.

DOI: https://doi.org/10.14279/depositonce-8487

Parameters:

cache_dirstr

Cache directory for downloads. Defaults is the OS user cache directory. This default can be overridden by setting IRDL_CACHE_DIR environment variable.

export_dirstr, optional

Directory for final output. If specified, the data will be exported to <export_dir/HUTUBS/>. Else, it remains in <cache_dir/output/>.

output_formatstr

Output format: ‘pyfar’, ‘numpy’, ‘hdf5’, ‘sofa’, or ‘raw’.

subjectint, optional

Subject identifier. Must be an integer in the range 1 to 96. Default is 1.

kindstr, optional

HUTUBS HRIR variant. Either ‘measured’ or ‘simulated’. Default is ‘measured’.

Returns:

dict or Path

For ‘pyfar’ / ‘numpy’: dict of in-memory objects. For ‘sofa’ / ‘hdf5’ / ‘raw’: Path to file on disk.

name: str = 'hutubs'