building.measurement.insulation
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.
Field measurement of sound insulation: airborne (ISO 16283-1:2014), impact (ISO 16283-2) and facade (ISO 16283-3:2016).
Field quantities (ISO 16283-1:2014). From the energy-average sound pressure levels in the source and receiving rooms this module forms the level difference (Clause 3.12, Formula (1)), the standardized level difference with the reference reverberation time s (Clause 3.13, Formula (2)), and the apparent sound reduction index with the Sabine equivalent absorption area (Clause 3.14/3.15, Formula (4) and (5)). Source and receiving levels may be supplied already averaged (one value per band) or as several microphone positions, which are then energy-averaged with (Clause 7.8, Formula (9)). All quantities are evaluated per one-third-octave band over the core range 100 Hz to 3150 Hz (Clause 5), the caller having already applied any background-noise correction (Clause 9.2).
Field impact quantities (ISO 16283-2). With the tapping machine as the
impact source this module forms, from the energy-average impact sound
pressure level Li in the receiving room, the standardized impact sound
pressure level with
s (Clause
3.13, Formula (1)) and the normalized impact sound pressure level
with the Sabine absorption area
and the reference area m² (Clause 3.14, Formula (2)).
Levels
may be supplied already averaged or as several microphone positions, then
energy-averaged (Clause 7.8, Formula (10)), over the core one-third-octave
range 100 Hz to 3150 Hz (Clause 5.1).
Field façade quantities (ISO 16283-3:2016). With an outdoor sound
source this module forms, from the level 2 m in front of the façade
L1,2m and the receiving-room level L2, the level difference
(Clause 3.14), its standardized form
with s
(Clause 3.15) and
normalized form with the Sabine
absorption
area (Clause 3.17) and reference m²
(Clause 3.16): the global loudspeaker / traffic quantities
Dls,2m,* / Dtr,2m,*. When a surface level L1,s (microphone on
the test element) with the element area S and volume are given it
forms the apparent sound reduction index
for the
loudspeaker element method
(Clause 3.12) or for
the
road-traffic element method (Clause 3.13). These quantities are defined by
unnumbered formulas inline in the Clause 3 terms; positions are
energy-averaged with the surface-level formula (Clause 9.5.1, Formula (7)).
Quantities are evaluated over the core one-third-octave range 100 Hz to
3150 Hz (Clause 5), optionally extended to 50-5000 Hz. The façade quantity
is airborne, so its single-number rating uses the ISO 717-1 airborne
reference curve and method (Clause 2, Annex F) via weighted_rating
unchanged.
The single-number rating of any of these curves is the subject of
phonometry.building.measurement.ratings, which implements ISO 717-1
(airborne) and ISO 717-2 (impact); the report() methods below call it to
box the rating on the field report form.
Auto-generated from the source docstrings by
scripts/generate_api_docs.py(make api-docs). Do not edit by hand.
airborne_insulation
Section titled “airborne_insulation”airborne_insulation( l1: Sequence[float] | np.ndarray, l2: Sequence[float] | np.ndarray, t2: Sequence[float] | np.ndarray, *, area: float | None = None, volume: float | None = None, t0: float = 0.5,) -> AirborneInsulationResultField airborne sound insulation per ISO 16283-1:2014.
Computes, per frequency band, the level difference (Formula (1)), the standardized level difference (Formula (2)) and, when the partition area and receiving-room volume are given, the apparent sound reduction index with (Formula (4) and (5)).
l1 and l2 may be one value per band (already energy-averaged)
or a two-dimensional (positions, bands) array, in which case the
positions are energy-averaged with Formula (9). The band levels are
assumed already corrected for background noise (Clause 9.2).
Parameters
| Name | Description |
|---|---|
l1 | Source-room sound pressure levels, in dB. |
l2 | Receiving-room sound pressure levels, in dB. |
t2 | Receiving-room reverberation time per band, in seconds. |
area | Area S of the common partition, in m² (optional; required together with volume for R'). |
volume | Receiving-room volume V, in m³ (optional; required together with area for R'). |
t0 | Reference reverberation time T0, in seconds (default 0,5 s for dwellings, Clause 3.13). |
Returns: AirborneInsulationResult with d, dnt and r_prime (the latter None unless area and volume are both given).
Raises
| Exception | When |
|---|---|
| ValueError | If the band counts of l1, l2 and t2 differ, if only one of area/volume is supplied, if t2/t0 are not positive, or if inputs are non-finite. |
AirborneInsulationResult
Section titled “AirborneInsulationResult”AirborneInsulationResult( d: np.ndarray, dnt: np.ndarray, r_prime: np.ndarray | None, l1: np.ndarray | None = None, l2: np.ndarray | None = None, t2: np.ndarray | None = None, t0: float | None = None,)Per-band field airborne sound insulation (ISO 16283-1:2014).
Attributes
| Name | Description |
|---|---|
d | Level difference per band, in dB (Clause 3.12, Formula (1)). |
dnt | Standardized level difference DnT per band, in dB (Clause 3.13, Formula (2)). |
r_prime | Apparent sound reduction index R' per band, in dB (Clause 3.14, Formula (4)), or None when the partition area and receiving-room volume were not supplied. |
l1 | Energy-average source-room levels the quantities were formed from, in dB (after any position averaging, Formula (9)). Defaults to None for backward-compatible construction. |
l2 | Energy-average receiving-room levels, in dB. Defaults to None. |
t2 | Receiving-room reverberation time per band, in seconds. Defaults to None. |
t0 | Reference reverberation time T0 used for DnT, in seconds. Defaults to None. |
AirborneInsulationResult.plot()
Section titled “AirborneInsulationResult.plot()”AirborneInsulationResult.plot( ax: Axes | None = None, *, language: str = 'en', **kwargs: Any,) -> AxesPlot the per-band insulation quantities (DnT, D, R').
Requires matplotlib (pip install phonometry[plot]); returns the
Axes.
AirborneInsulationResult.report()
Section titled “AirborneInsulationResult.report()”AirborneInsulationResult.report( path: str, *, quantity: str = 'dnt', metadata: ReportMetadata | None = None, engine: str = 'reportlab', verbose: bool = False, language: str = 'en',) -> strRender an ISO 16283-1 field airborne sound-insulation report to a PDF.
Writes the one-page field test report of ISO 16283-1:2014 Clause 14
in the layout of the recommended Annex B form: the standard-basis
line, an optional metadata header block (client, construction, room
volumes, partition area …), the one-third-octave table beside the
measured-versus-shifted-reference curve, the boxed field rating
DnT,w (C; Ctr) or R'w (C; Ctr) (evaluated per ISO 717-1 over
the 16 core bands), the mandatory field-method statement, an optional
verdict row and a footer with the identity block and disclaimer.
Parameters
| Name | Description |
|---|---|
path | Destination path of the PDF file. |
quantity | The reported field quantity: "dnt" (default, the standardized level difference of Annex B Figure B.1) or "r_prime" (the apparent sound reduction index of Figure B.2; requires the result to carry r_prime). |
metadata | Optional ReportMetadata; None produces a lightweight fiche (body, rating and disclaimer only). |
engine | Rendering back end; only "reportlab" is supported. |
verbose | When True, the table shows the measurement chain per band (energy-average L1 and L2, reverberation time T and the quantity) instead of the two-column f | value form; it requires the result to carry l1, l2 and t2 (populated by airborne_insulation). |
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 or quantity is unknown, the selected quantity is not available, the result does not hold the 16 core one-third-octave bands (100 Hz to 3150 Hz) the ISO 717-1 rating needs, or verbose=True without the per-band chain. |
| ImportError | If reportlab is not installed (pip install phonometry[report]), or matplotlib is missing for the embedded figure (pip install phonometry[plot]). |
energy_average_level
Section titled “energy_average_level”energy_average_level( levels: Sequence[float] | np.ndarray, axis: int = -1,) -> np.ndarray | floatEnergy-average sound pressure level (ISO 16283-1:2014, Formula (9)).
Combines sound pressure levels measured at several microphone positions into .
Parameters
| Name | Description |
|---|---|
levels | Sound pressure levels, in dB, at the n positions to be averaged along axis. |
axis | Axis over which to average (default the last axis). |
Returns: The energy-average level, in dB; a scalar float when the result is zero-dimensional, otherwise an array.
Raises
| Exception | When |
|---|---|
| ValueError | If levels is empty or contains non-finite values. |
facade_insulation
Section titled “facade_insulation”facade_insulation( l1_2m: Sequence[float] | np.ndarray, l2: Sequence[float] | np.ndarray, t2: Sequence[float] | np.ndarray, *, area: float | None = None, volume: float | None = None, surface_level: Sequence[float] | np.ndarray | None = None, method: str = 'loudspeaker', t0: float = 0.5, frequencies: Sequence[float] | np.ndarray | None = None,) -> FacadeInsulationResultField façade sound insulation per ISO 16283-3:2016.
Computes, per frequency band, the global-method level difference
(Clause 3.14), its standardized form
(Clause 3.15) and, when the
receiving-room volume is given, its normalized form
with the Sabine equivalent
absorption
area (Clause 3.17) and m²
(Clause 3.16).
When a surface level L1,s (microphone on the test element),
together with the element area S and the volume, is supplied it
also computes the apparent sound reduction index of the element
method: for a
loudspeaker
source (Clause 3.12) or
for a
road-traffic source (Clause 3.13). The defining formulas are unnumbered
inline in the Clause 3 terms.
l1_2m, l2 and surface_level may be one value per band
(already energy-averaged) or a two-dimensional (positions, bands)
array, in which case the positions are energy-averaged with the
surface-level formula (Clause 9.5.1, Formula (7)). Band levels are
assumed already corrected for background
noise. The single-number rating uses the ISO 717-1 airborne reference
curve (Annex F); pass the desired 16-band quantity to
weighted_rating.
Parameters
| Name | Description |
|---|---|
l1_2m | Outdoor sound pressure levels 2 m in front of the façade, in dB. |
l2 | Receiving-room sound pressure levels, in dB. |
t2 | Receiving-room reverberation time per band, in seconds. |
area | Area S of the test element, in m² (optional; required with volume and surface_level for R'). |
volume | Receiving-room volume V, in m³ (optional; required for D2m,n and for R'). |
surface_level | Outdoor surface level L1,s on the test element, in dB (optional; required with area and volume for R'). |
method | "loudspeaker" (45° incidence, -1,5 dB) or "road_traffic" (all-angle incidence, -3 dB); selects the R' correction (Clause 3.12 / 3.13). |
t0 | Reference reverberation time T0, in seconds (default 0,5 s for dwellings, Clause 3.15). |
frequencies | Optional band centre frequencies, in Hz, carried on the result for plotting. |
Returns: FacadeInsulationResult with d_2m, d_2m_nt, d_2m_n (None unless volume is given) and r_prime (None unless surface_level, area and volume are all given).
Raises
| Exception | When |
|---|---|
| ValueError | If band counts differ, if method is unknown, if t2/t0/area/volume are not positive, if area is given without surface_level, if surface_level and area are given without volume, if frequencies is given with a length that differs from the band count, or if inputs are non-finite. Supplying surface_level alone is not an error: r_prime simply stays None. |
FacadeInsulationResult
Section titled “FacadeInsulationResult”FacadeInsulationResult( d_2m: np.ndarray, d_2m_nt: np.ndarray, d_2m_n: np.ndarray | None, r_prime: np.ndarray | None, frequencies: np.ndarray | None = None, method: str = 'loudspeaker',)Per-band field façade sound insulation (ISO 16283-3).
Attributes
| Name | Description |
|---|---|
d_2m | Level difference per band, in dB (Clause 3.14; Dls,2m loudspeaker, Dtr,2m traffic). |
d_2m_nt | Standardized level difference per band, in dB (Clause 3.15). |
d_2m_n | Normalized level difference per band, in dB (Clause 3.16), or None when the receiving-room volume was not supplied. |
r_prime | Apparent sound reduction index R'45° (loudspeaker, Clause 3.12) or R'tr,s (road traffic, Clause 3.13) per band, in dB, or None unless a surface level together with the element area and receiving-room volume were supplied. |
frequencies | Band centre frequencies, in Hz, or None. |
method | The sound source of the measurement: "loudspeaker" (45° incidence) or "road_traffic". It selects which apparent index r_prime is (R'45 or R'tr,s) and how the report labels it. |
FacadeInsulationResult.plot()
Section titled “FacadeInsulationResult.plot()”FacadeInsulationResult.plot( ax: Axes | None = None, *, language: str = 'en', **kwargs: Any,) -> AxesPlot the per-band façade insulation profile (ISO 16283-3).
Draws the standardized level difference and any other available
quantities (D2m, D2m,n, R') against frequency. Requires
matplotlib (pip install phonometry[plot]); returns the
Axes.
FacadeInsulationResult.report()
Section titled “FacadeInsulationResult.report()”FacadeInsulationResult.report( path: str, *, quantity: str = 'd_2m_nt', metadata: ReportMetadata | None = None, engine: str = 'reportlab', verbose: bool = False, language: str = 'en',) -> strRender an ISO 16283-3 field facade sound-insulation report to a PDF.
Writes the one-page field facade test report of ISO 16283-3:2016: the
standard-basis line, an optional metadata header block, the
one-third-octave table beside the measured-versus-shifted-reference
curve, the boxed ISO 717-1 field rating of the reported quantity
(D2m,nT,w for d_2m_nt, D2m,n,w for d_2m_n or, for
r_prime, R'45,w / R'tr,s,w following the result’s
method, each with C; Ctr and evaluated over the 16 core
bands), the mandatory field-method statement, an optional verdict row
and a footer with the identity block and disclaimer.
Parameters
| Name | Description |
|---|---|
path | Destination path of the PDF file. |
quantity | The reported facade quantity: "d_2m_nt" (default, the standardized facade level difference D2m,nT), "d_2m_n" (the normalized facade level difference D2m,n; requires the result to carry d_2m_n) or "r_prime" (the apparent sound reduction index; requires the result to carry r_prime). The r_prime fiche is labelled R'45 (Clause 3.12, loudspeaker method) or R'tr,s (Clause 3.13, road traffic method) according to the result’s method. |
metadata | Optional ReportMetadata; None produces a lightweight fiche (body, rating and disclaimer only). |
engine | Rendering back end; only "reportlab" is supported. |
verbose | When True, the table shows the ISO 717 evaluation per band (the reported quantity, the shifted reference and the unfavourable deviation) instead of the two-column f | value form. |
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 or quantity is unknown, the selected quantity is not available, or the result does not hold the 16 core one-third-octave bands (100 Hz to 3150 Hz) the ISO 717-1 rating needs. |
| ImportError | If reportlab is not installed (pip install phonometry[report]), or matplotlib is missing for the embedded figure (pip install phonometry[plot]). |
impact_insulation
Section titled “impact_insulation”impact_insulation( li: Sequence[float] | np.ndarray, t2: Sequence[float] | np.ndarray, *, volume: float | None = None, t0: float = 0.5,) -> ImpactInsulationResultField impact sound insulation per ISO 16283-2 (tapping machine).
Computes, per frequency band, the standardized impact sound pressure level (Formula (1)) and, when the receiving-room volume is given, the normalized impact sound pressure level with the Sabine equivalent absorption area (Formula (6)) and the reference absorption area m² (Formula (2)).
li may be one value per band (already energy-averaged) or a
two-dimensional (positions, bands) array, in which case the
positions are energy-averaged with Formula (10). The band levels are
assumed already corrected for background noise (Clause 9).
Parameters
| Name | Description |
|---|---|
li | Energy-average impact sound pressure levels, in dB. |
t2 | Receiving-room reverberation time per band, in seconds. |
volume | Receiving-room volume V, in m³ (optional; required for L'n). |
t0 | Reference reverberation time T0, in seconds (default 0,5 s for dwellings, Clause 3.13). |
Returns: ImpactInsulationResult with l_n_t and l_n (the latter None unless volume is given).
Raises
| Exception | When |
|---|---|
| ValueError | If the band counts of li and t2 differ, if t2/t0/volume are not positive, or if inputs are non-finite. |
ImpactInsulationResult
Section titled “ImpactInsulationResult”ImpactInsulationResult( l_n_t: np.ndarray, l_n: np.ndarray | None, li: np.ndarray | None = None, t2: np.ndarray | None = None, t0: float | None = None,)Per-band field impact sound insulation (ISO 16283-2).
Attributes
| Name | Description |
|---|---|
l_n_t | Standardized impact sound pressure level per band, in dB (Clause 3.13, Formula (1)). |
l_n | Normalized impact sound pressure level per band, in dB (Clause 3.14, Formula (2)), or None when the receiving-room volume was not supplied. |
li | Energy-average impact sound pressure levels the quantities were formed from, in dB (after any position averaging, Formula (10)). Defaults to None for backward-compatible construction. |
t2 | Receiving-room reverberation time per band, in seconds. Defaults to None. |
t0 | Reference reverberation time T0 used for L'nT, in seconds. Defaults to None. |
ImpactInsulationResult.plot()
Section titled “ImpactInsulationResult.plot()”ImpactInsulationResult.plot( ax: Axes | None = None, *, language: str = 'en', **kwargs: Any,) -> AxesPlot the per-band impact levels (L'nT and, if present, L'n).
Requires matplotlib (pip install phonometry[plot]); returns the
Axes.
ImpactInsulationResult.report()
Section titled “ImpactInsulationResult.report()”ImpactInsulationResult.report( path: str, *, quantity: str = 'l_n_t', metadata: ReportMetadata | None = None, engine: str = 'reportlab', verbose: bool = False, language: str = 'en',) -> strRender an ISO 16283-2 field impact sound-insulation report to a PDF.
Writes the one-page field test report of ISO 16283-2:2020 Clause 14
in the layout of the recommended Annex C form: the standard-basis
line, an optional metadata header block, the one-third-octave table
beside the measured-versus-shifted-reference curve, the boxed field
rating L'nT,w (CI) or L'n,w (CI) (evaluated per ISO 717-2
over the 16 core bands), the mandatory field-method statement, an
optional verdict row and a footer with the identity block and
disclaimer.
Parameters
| Name | Description |
|---|---|
path | Destination path of the PDF file. |
quantity | The reported field quantity: "l_n_t" (default, the standardized level of Annex C Figure C.1) or "l_n" (the normalized level of Figure C.2; requires the result to carry l_n). |
metadata | Optional ReportMetadata; None produces a lightweight fiche (body, rating and disclaimer only). |
engine | Rendering back end; only "reportlab" is supported. |
verbose | When True, the table shows the measurement chain per band (energy-average Li, reverberation time T and the quantity) instead of the two-column f | value form; it requires the result to carry li and t2 (populated by impact_insulation). |
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 or quantity is unknown, the selected quantity is not available, the result does not hold the 16 core one-third-octave bands (100 Hz to 3150 Hz) the ISO 717-2 rating needs, or verbose=True without the per-band chain. |
| ImportError | If reportlab is not installed (pip install phonometry[report]), or matplotlib is missing for the embedded figure (pip install phonometry[plot]). |
ReportMetadata
Section titled “ReportMetadata”ReportMetadata( specimen: str | None = None, client: str | None = None, mounted_by: str | None = None, manufacturer: str | None = None, area: float | None = None, mass_per_area: float | None = None, source_volume: float | None = None, receiving_volume: float | None = None, room_volume: float | None = None, source_positions: int | None = None, receiver_positions: int | None = None, temperature: float | None = None, relative_humidity: float | None = None, source_temperature: float | None = None, source_relative_humidity: float | None = None, receiving_temperature: float | None = None, receiving_relative_humidity: float | None = None, pressure: float | None = None, tube_diameter: float | None = None, mic_spacing: float | None = None, thickness: float | None = None, test_room: str | None = None, instrumentation: str | None = None, calibration: str | None = None, mounting: str | None = None, measurement_standard: str | None = None, test_date: str | None = None, laboratory: str | None = None, operator: str | None = None, report_id: str | None = None, requirement: float | None = None, required_class: int | None = None, notes: str | None = None, tube_shape: str | None = None,)Descriptive metadata for the accredited ISO 717 report fiche.
All fields are optional (default None); the report renders only the
fields that are supplied, so a partially populated instance is valid. The
numeric fields are validated on construction by physical range: the
dimension, mass, volume and pressure fields must be finite and strictly
positive; the temperature and requirement fields need only be finite (0
degrees Celsius or below is a valid test condition, and a programme-loudness
target in LUFS is negative); and the relative-humidity fields must lie
within 0..100 %. A violation raises ValueError.
Attributes
| Name | Description |
|---|---|
specimen | Specimen description printed in the header (the tested element, e.g. "200 mm concrete wall"). |
client | Client the test was carried out for. |
mounted_by | Who mounted the specimen in the test opening. |
manufacturer | Manufacturer of the tested element. |
area | Specimen area S, in m^2 (the free test opening area). |
mass_per_area | Measured mass per unit area, in kg/m^2. |
source_volume | Source-room volume, in m^3. |
receiving_volume | Receiving-room volume, in m^3. |
room_volume | Volume of the single room under test, in m^3. Room acoustics (ISO 3382-1/-2) characterises one enclosure rather than a source/receiving pair, and ISO 3382-2:2008 Clause 9 requires the room volume to be reported; the room-acoustics fiche prints it in the header. Distinct from the source_volume/receiving_volume pair, which describe a sound-transmission measurement. |
source_positions | Number of source (loudspeaker/omnidirectional) positions used in the measurement, an integer (ISO 3382-1:2009 Table 1 and ISO 3382-2:2008 Clause 8 require reporting the number of source positions). Printed by the room-acoustics fiche. |
receiver_positions | Number of microphone (receiver) positions used, an integer (ISO 3382-1:2009 Table 1 and ISO 3382-2:2008 Clause 8 require reporting the number of microphone positions). Printed by the room-acoustics fiche. |
temperature | Air temperature during the test, in degrees Celsius (a single representative value; use the per-room fields below when the source and receiving rooms are reported separately). |
relative_humidity | Relative humidity during the test, in %. |
source_temperature | Source-room air temperature, in degrees Celsius. |
source_relative_humidity | Source-room relative humidity, in %. |
receiving_temperature | Receiving-room air temperature, in degrees Celsius. |
receiving_relative_humidity | Receiving-room relative humidity, in %. |
pressure | Ambient (static) air pressure during the test, in kPa. |
test_room | Test-room / facility identification. |
instrumentation | Identification and class of the instrumentation used (manufacturer, model, serial number), as free text. The occupational noise-exposure fiche prints it for ISO 9612:2009 Clause 15 c; when it is not supplied that fiche falls back to the result’s own instrument class. |
calibration | Calibration traceability, as free text (calibrator, date and result of the most recent verification, the before/after field checks). Printed by the occupational noise-exposure fiche (ISO 9612:2009 Clause 15 c). |
tube_diameter | Impedance-tube inner diameter d (circular tube) or maximum lateral dimension (rectangular tube), in metres. Printed by the impedance-tube fiche (ISO 10534-2), where it fixes the upper plane-wave cut-on frequency. |
mic_spacing | Microphone spacing s between the two measurement positions of the impedance tube, in metres. Printed by the impedance-tube fiche (ISO 10534-2), where it bounds the working frequency range. |
tube_shape | Cross-section of the impedance tube: "circular", "rectangular" or "square". Printed by the impedance-tube fiche (ISO 10534-2) next to the tube diameter, which it qualifies (inner diameter for a circular tube, maximum lateral dimension otherwise). |
thickness | Specimen thickness under the applied static load, in metres. Printed by the dynamic-stiffness fiche (EN 29052-1 / ISO 9052-1), where EN 29052-1:1992 Clause 9 b) requires reporting the thickness of the resilient layer under load; it is shown in millimetres. |
mounting | Mounting condition of the specimen (e.g. the ISO 10140-1 mounting code or a short description). |
measurement_standard | Measurement standard the spectrum was obtained under (e.g. "ISO 10140-2" or "ISO 16283-1"); it forms the report’s standard-basis line together with the ISO 717 rating part. |
test_date | Date of the test, as a free-form string. |
laboratory | Testing laboratory / institute name (footer). |
operator | Operator who carried out the test (footer signature line). |
report_id | Report / test number (footer). |
requirement | Target single-number value the verdict row compares the rating against, expressed in the rating’s own unit (e.g. dB, a dimensionless absorption coefficient, sone, or a programme-loudness level in LUFS). It need only be finite (a loudness target in LUFS is negative), so its sign is not constrained. The pass direction is defined by each rating’s report method: quantities where more is better (airborne insulation, absorption) pass at or above the requirement, and quantities where less is better (impact level, loudness, aircraft noise) pass at or below it; the programme-loudness fiche reads it as the target level and passes within a tolerance. |
required_class | Target performance-class index for a class-compliance verdict (the IEC 61260-1 filter fiche): 0, 1 or 2, where class 0 is the strictest. When supplied, the fiche’s verdict passes if the achieved overall class is at least as strict as this class (a smaller or equal class index). None (the default) prints no verdict row. |
notes | Free-form remarks printed in the footer. |
Raises
| Exception | When |
|---|---|
| ValueError | If a supplied dimension/mass/volume/pressure is not finite and strictly positive, a temperature or requirement is not finite, a relative humidity is outside 0..100 %, a required class is not one of 0, 1, 2, a position count is not a finite, positive integer, or a tube shape is not one of "circular", "rectangular", "square". |
ReportMetadata.is_empty()
Section titled “ReportMetadata.is_empty()”ReportMetadata.is_empty() -> boolReturn True when no field is set (an all-None instance).