BrasRs8Dataset

class irdl.BrasRs8Dataset

Bases: AKTZipBaseDataset

Download the BRAS RS8 dataset from DepositOnce.

BRAS RS8 extends the Benchmark for Room Acoustical Simulation (BRAS) by a finite curved reflector. The dataset contains nine scenes with various source and receiver configurations, covering dispersing and focusing reflections, as well as diffraction around the surface. In total, nearly 3,000 impulse responses were measured under controlled anechoic conditions.

Attributes:

namestr

Dataset name (“bras-rs8”).

doistr

Digital Object Identifier (“10.14279/depositonce-25649”).

_category = 'room_impulse_responses'

_source_filename(**dataset_kwargs) → str

Construct the ingest-ready (SOFA) filename.

Parameters:

**dataset_kwargsdict

Expected key: scene.

Returns:

str

File name in format “RS8_{scene}.sofa”.

_validate_params(**dataset_kwargs) → None

Validate BRAS-RS8-specific parameters.

Parameters:

**dataset_kwargsdict

Must contain ‘scene’ (one of the valid scene identifiers).

Raises:

ValueError

If scene is not one of the valid scene identifiers.

_zipfile: str = '1_Scene_descriptions.zip'

doi: str = '10.14279/depositonce-25649'

classmethod get(scene: str = '01a', cache_dir: Path | str | None = None, export_dir: Path | str | None = None, output_format: str = 'pyfar') → dict | Path | None

Download the BRAS RS8 dataset from DepositOnce.

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

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/BRAS-RS8/>. Else, it remains in <cache_dir/output/>.

output_formatstr

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

scenestr, optional

Scene identifier to download. One of: ‘01a’, ‘01b’, ‘01c’, ‘02’, ‘03a’, ‘03b’, ‘03c’, ‘03d’, ‘03e’. Default is ‘01a’.

Returns:

dict or Path

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

name: str = 'bras-rs8'