audiblelight.worldstate.WorldStateShoebox

class audiblelight.worldstate.WorldStateShoebox

Bases: WorldState

A WorldState where audio propagation is simulated inside a parameterized (user-controllable) “shoebox” room.

__init__()

Methods

__init__()
add_emitter([position, alias, mic, ...])	Add an emitter to the state.
add_emitters([positions, aliases, mics, ...])	Add emitters to the state.
add_microphone([microphone_type, position, ...])	Add a microphone to the space.
add_microphone_and_emitter([position, ...])	Add both a microphone and emitter with specified relationship.
add_microphones([microphone_types, ...])	Add multiple microphones to the state.
clear_emitter(alias)	Given an alias for an emitter, clear that emitter and update the state.
clear_emitters()	Removes all current emitters.
clear_microphone(alias)	Given an alias for a microphone, clear that microphone if it exists and update the state.
clear_microphones()	Removes all current microphones.
define_trajectory(duration[, ...])	Defines a trajectory for a moving sound event with specified spatial bounds and event duration.
from_dict(input_dict)	Instantiate a WorldState from a dictionary.
get_emitter(alias[, emitter_idx])	Given a valid alias and index, get a single Emitter object, as in self.emitters[alias][emitter_idx]
get_emitters(alias)	Given a valid alias, get a list of associated Emitter objects, as in self.emitters[alias]
get_irs()	Get the IRs from the state
get_microphone(alias)	Given a valid alias, get an associated Microphone object, as in self.microphones[alias].
get_microphones()	Get all microphones associated with the current State
get_valid_position()	Get a valid position to place an object inside the state
path_exists_between_points(point_a, point_b)	Returns True if a direct point exists between point_a and point_b in the mesh, False otherwise.
simulate()	Simulates audio propagation in the state with the current listener and sound emitter positions.
to_dict()	Returns metadata for this object as a dictionary

Attributes

irs	(N_capsules, N_emitters, N_samples), mic001: (...)}
name
num_emitters	Returns the number of emitters in the state.

name = 'SHOEBOX'