Skip to content

Commit

Permalink
Tweak the defaults in RoomSimulator and update docstring and error me…
Browse files Browse the repository at this point in the history
…ssage
  • Loading branch information
iver56 committed Mar 7, 2022
1 parent 48ca245 commit b319479
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions audiomentations/augmentations/room_simulator.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class RoomSimulator(BaseWaveformTransform):
> augment = RoomSimulator(use_ray_tracing=False)
Quickly add reverberation without caring for accuracy.
> augment = RoomSimulator(calculate_by_absorption_or_rt60="rt60", min_absorption_value_or_rt60=0.06, max_absorption_value_or_rt60=0.06, min_size_x = ...)
> augment = RoomSimulator(calculation_mode="rt60", min_target_rt60=0.06, max_target_rt60=0.06, min_size_x = ...)
Augment with randomly selected room impulse responses that have an RT60 of 0.06.
> augment = RoomSimulator(min_mic_radius=1.0, max_min_radius=1.0)
Expand All @@ -44,10 +44,10 @@ def __init__(
max_size_y: float = 3.9,
min_size_z: float = 2.4,
max_size_z: float = 3.0,
min_absorption_value: float = 0.15,
max_absorption_value: float = 0.45,
min_absorption_value: float = 0.075,
max_absorption_value: float = 0.4,
min_target_rt60: float = 0.15,
max_target_rt60: float = 0.45,
max_target_rt60: float = 0.8,
min_source_x: float = 0.1,
max_source_x: float = 3.5,
min_source_y: float = 0.1,
Expand Down Expand Up @@ -131,7 +131,7 @@ def __init__(
assert calculation_mode in [
"rt60",
"absorption",
], "`calculate_by_absorption_or_rt60` should either be `rt60` or `absorption`"
], "`calculation_mode` should either be `rt60` or `absorption`"

self.max_order = max_order
self.calculation_mode = calculation_mode
Expand Down

0 comments on commit b319479

Please sign in to comment.