room.enclosed_space_absorption
La referencia de la API se publica en inglés en los dos idiomas: se genera a partir de los docstrings del código, que son su texto original.
Sound absorption in enclosed spaces (EN 12354-6:2003).
Estimates the total equivalent sound absorption area of a room and the resulting reverberation time from the absorption of its surfaces and objects (the normative Clause 4 model).
The total equivalent absorption area sums the surface contributions, the equivalent absorption areas of objects and object arrays and the air absorption:
with the air term (Formula 2),
the object fraction (Formula 3) and,
for hard irregular objects, the empirical equivalent area
(Formula 4). The reverberation
time follows from
(Formula 5); with the standard’s m/s the factor
is the familiar 0.16.
The informative Annex D method for irregular spaces / uneven absorption distribution is out of scope.
Auto-generated from the source docstrings by
scripts/generate_api_docs.py(make api-docs). Do not edit by hand.
air_absorption_area
Section titled “air_absorption_area”air_absorption_area( m: float | np.floating[Any] | np.integer[Any], volume: float, object_fraction: float = 0.0,) -> float
air_absorption_area( m: Sequence[float] | Sequence[np.floating[Any]] | Sequence[np.integer[Any]] | NDArray[np.bool_ | np.integer[Any] | np.floating[Any]], volume: float, object_fraction: float = 0.0,) -> NDArray[np.float64]
air_absorption_area( m: NumericArrayLike, volume: float, object_fraction: float = 0.0,) -> float | NDArray[np.float64]Equivalent absorption area of the air (Formula 2).
Parameters
| Name | Description |
|---|---|
m |
Power attenuation coefficient of air, in Neper per metre (Table 1 prints it for the six conditions air_condition names). |
volume |
Volume of the empty enclosed space V, m3. |
object_fraction |
Object fraction psi (0-1). |
Returns: The air absorption area , m2; a float for a number; an array for a sequence or an array, a zero-dimensional one included.
Raises
| Exception | When |
|---|---|
| TypeError | if object_fraction or volume is not a single number, or m holds a text or a value that is not a real number. |
enclosed_space_reverberation
Section titled “enclosed_space_reverberation”enclosed_space_reverberation( surfaces: Sequence[tuple[float, NumericArrayLike]], volume: float, *, objects: NumericArrayLike = (), object_fraction: float = 0.0, air_condition: Literal['10C_30-50', '10C_50-70', '10C_70-90', '20C_30-50', '20C_50-70', '20C_70-90'] | None = None, frequencies: NumericArrayLike = ..., speed_of_sound: float = 345.6,) -> ReverberationResultPredict the absorption area and reverberation time per octave band.
Chains the total equivalent absorption area (Formula 1, with the air term
of Formula 2 from Table 1 when air_condition is given)
and the reverberation time (Formula 5).
Parameters
| Name | Description |
|---|---|
surfaces |
Sequence of (area, absorption_coefficient) pairs; each coefficient a per-band array aligned with frequencies. |
volume |
Volume of the empty enclosed space V, m3. |
objects |
Equivalent absorption areas of the objects Aobj, m2. |
object_fraction |
Object fraction psi (0-1). |
air_condition |
One of the six conditions of Table 1 to include air absorption ("10C_30-50", "10C_50-70", "10C_70-90", "20C_30-50", "20C_50-70", "20C_70-90"; clause 4.3 recommends "20C_50-70" when the room’s own conditions are not known), or None to neglect it. |
frequencies |
Octave-band centre frequencies, in hertz. The built-in air_condition profiles require the standard’s seven octave bands, 125 Hz to 8 kHz. |
speed_of_sound |
Speed of sound c0, m/s. |
Returns: The ReverberationResult.
Raises
| Exception | When |
|---|---|
| TypeError | if air_condition is not a text, or frequencies holds a text or a value that is not a real number. |
equivalent_absorption_area
Section titled “equivalent_absorption_area”equivalent_absorption_area( surfaces: Sequence[tuple[float, NumericArrayLike]], *, objects: NumericArrayLike = (), air_area: NumericArrayLike = 0.0,) -> float | NDArray[np.float64]Total equivalent sound absorption area (Formula 1).
Parameters
| Name | Description |
|---|---|
surfaces |
Sequence of (area, absorption_coefficient) pairs, one per surface (or object array treated as a surface). The absorption coefficient may be a scalar or a per-band array. |
objects |
Equivalent absorption areas of the objects Aobj, m2 (see hard_object_absorption): a single value, a 1-D sequence of one value per object, or a 2-D array (n_objects, n_bands) for per-band values; summed over the objects. |
air_area |
Air absorption area Aair, m2 (see air_absorption_area); scalar or per-band. |
Returns: The total equivalent absorption area A, m2; a float when the coefficients, an object’s entry and air_area are all numbers, a zero-dimensional array when each is one value and one of them is a zero-dimensional array, otherwise a per-band array.
Raises
| Exception | When |
|---|---|
| TypeError | if air_area, objects or surfaces holds a text or a value that is not a real number. |
hard_object_absorption
Section titled “hard_object_absorption”hard_object_absorption( object_volume: float | np.floating[Any] | np.integer[Any],) -> float
hard_object_absorption( object_volume: Sequence[float] | Sequence[np.floating[Any]] | Sequence[np.integer[Any]] | NDArray[np.bool_ | np.integer[Any] | np.floating[Any]],) -> NDArray[np.float64]
hard_object_absorption( object_volume: NumericArrayLike,) -> float | NDArray[np.float64]Equivalent absorption area of a hard object (Formula 4).
An empirical estimate for hard, irregularly shaped objects (machinery, furniture) whose equivalent area is not otherwise available.
Parameters
| Name | Description |
|---|---|
object_volume |
Volume Vobj of the hard object(s), m3. |
Returns: The equivalent absorption area , m2; a float for a number; an array for a sequence or an array, a zero-dimensional one included.
Raises
| Exception | When |
|---|---|
| TypeError | if object_volume holds a text or a value that is not a real number. |
object_fraction
Section titled “object_fraction”object_fraction(object_volumes: NumericArrayLike, volume: float) -> floatObject fraction psi of an enclosed space (Formula 3).
Parameters
| Name | Description |
|---|---|
object_volumes |
Volumes of the objects and object arrays, m3. |
volume |
Volume of the empty enclosed space V, m3. |
Returns: The object fraction .
Raises
| Exception | When |
|---|---|
| TypeError | if volume is not a single number, or object_volumes holds a text or a value that is not a real number. |
reverberation_time
Section titled “reverberation_time”reverberation_time( absorption_area: float | np.floating[Any] | np.integer[Any], volume: float, *, object_fraction: float = 0.0, speed_of_sound: float = 345.6,) -> float
reverberation_time( absorption_area: Sequence[float] | Sequence[np.floating[Any]] | Sequence[np.integer[Any]] | NDArray[np.bool_ | np.integer[Any] | np.floating[Any]], volume: float, *, object_fraction: float = 0.0, speed_of_sound: float = 345.6,) -> NDArray[np.float64]
reverberation_time( absorption_area: NumericArrayLike, volume: float, *, object_fraction: float = 0.0, speed_of_sound: float = 345.6,) -> float | NDArray[np.float64]Reverberation time from the equivalent absorption area (Formula 5).
Parameters
| Name | Description |
|---|---|
absorption_area |
Total equivalent absorption area A, m2. |
volume |
Volume of the empty enclosed space V, m3. |
object_fraction |
Object fraction psi (0-1). |
speed_of_sound |
Speed of sound c0, m/s (default 345.6, which gives the factor 0.16). |
Returns: The reverberation time , s; a float for a number; an array for a sequence or an array, a zero-dimensional one included.
Raises
| Exception | When |
|---|---|
| ValueError | if absorption_area is not positive and finite. |
| TypeError | if object_fraction, speed_of_sound or volume is not a single number, or absorption_area holds a text or a value that is not a real number. |
ReverberationResult
Section titled “ReverberationResult”ReverberationResult( frequencies: NDArray[np.float64], absorption_area: NDArray[np.float64], reverberation_time: NDArray[np.float64], volume: float, object_fraction: float,)Absorption area and reverberation time of an enclosed space (Clause 4).
Attributes
| Name | Description |
|---|---|
frequencies |
Octave-band centre frequencies, in hertz. |
absorption_area |
Total equivalent absorption area A per band, m2. |
reverberation_time |
Reverberation time T per band, s. |
volume |
Volume of the empty enclosed space, m3. |
object_fraction |
Object fraction psi (0-1). |
ReverberationResult.plot()
Section titled “ReverberationResult.plot()”ReverberationResult.plot( ax: Axes | None = None, *, language: Literal['en', 'es'] = 'en', **kwargs: Any,) -> AxesPlot the reverberation time over the octave bands.
Requires matplotlib (the [plot] extra); returns the
Axes.
Parameters
| Name | Description |
|---|---|
language |
The language of the labels: "en" or "es". |
ReverberationResult.report()
Section titled “ReverberationResult.report()”ReverberationResult.report( path: str | os.PathLike[str], *, metadata: ReportMetadata | None = None, engine: Literal['reportlab'] = 'reportlab', verbose: bool = False, language: Literal['en', 'es'] = 'en',) -> strRender an enclosed-space absorption/reverberation fiche to a PDF.
Writes a one-page report characterising an enclosed space by the
EN 12354-6:2003 Clause 4 model: a standard-basis line, an optional
metadata header block (client, room, description, room volume, object
fraction, climate …), a per-band table of the equivalent sound
absorption area A and the reverberation time T beside the
result’s own reverberation-time plot (plot), the boxed
mid-frequency reverberation time with the mid-frequency absorption area
alongside, and a footer with the fixed disclaimer. EN 12354-6 gives a
diffuse-field estimate rather than a measurement; a supplied
metadata.requirement is printed as a target reverberation-time
reference line without a PASS/FAIL verdict, since a room reverberation
time is a target range rather than a strictly higher/lower-is-better
quantity.
Parameters
| Name | Description |
|---|---|
path |
Destination path of the PDF file. |
metadata |
Optional ReportMetadata; None produces a bare characterisation fiche (body, result and disclaimer only). |
engine |
Rendering back end; only "reportlab" is supported. |
verbose |
Accepted for parity with the other fiches; the band table already shows both A and T, so it has no effect. |
language |
Fiche language: "en" (default, English) or "es" (Spanish, with a comma decimal separator). |
Returns: The written path as a str.
Raises
| Exception | When |
|---|---|
| ValueError | If engine is not "reportlab". |
| ImportError | If reportlab is not installed (the [report] extra), or matplotlib is missing for the embedded figure (the [plot] extra). |