building.datasheets

Sound insulation as a data sheet or a test report prints it.

The transmission loss tables of the books (catalogue) print a field-incidence loss per octave, rarely with a standard or a laboratory behind it. A product’s data sheet and a laboratory’s test report print two quantities that are measured to a standard and rated to another, and that are held here in a class each:

• the sound reduction index $R$ of an element measured in a laboratory to ISO 10140-2, one value per one-third octave band, rated to $R_{\mathrm{w}}$ with its spectrum adaptation terms $C$ and $C_{\mathrm{tr}}$ (ISO 717-1), and to the terms of the enlarged frequency ranges of its Annex B when the report prints the bands they need: SoundReductionSpectrum;
• the reduction of impact sound pressure level $\Delta L$ of a floor covering or a floating floor, defined by ISO 10140-1 Annex H (Equation (H.1), $\Delta L=L_{n0}-L_{\mathrm{n}}$ on a reference floor) with the levels measured by ISO 10140-3, one value per one-third octave band, rated to $\Delta L_{\mathrm{w}}$ against the heavyweight reference floor of ISO 717-2, with the adaptation terms $C_{\mathrm{I},\Delta }$ and $C_{\mathrm{I},\mathrm{r}}$ of its Clause A.2.2: ImpactImprovementSpectrum.

A book’s transmission loss is not a laboratory’s $R$, and a covering’s $\Delta L_{\mathrm{w}}$ is not the averaged improvement some handbooks print (impact_sound_improvement_db is one): each quantity has its own class and its own field names, so the mistake of taking one for the other shows at the call.

Each row carries the ratings the sheet prints beside the bands, as printed, and works them out again from the bands with its rating(). When a catalogue file is read, phonometry.io.read_catalogue compares the two and notes any difference beside the catalogue; it never reconciles them. A rating the sheet prints and no function of this library works out (a flanking level difference, an STC or an IIC) has no field here: it goes in the row’s note.

Nothing here ships with data. A caller’s own catalogue holds these rows, read by phonometry.io.read_catalogue from the file the caller typed from the sheet.

Auto-generated from the source docstrings by scripts/generate_api_docs.py (make api-docs). Do not edit by hand.

ImpactImprovementSpectrum(
    *,
    name: str,
    source: str,
    table: str = '',
    variant: str = '',
    basis: Mapping[str, str] = ...,
    approximate: frozenset[str] = frozenset(),
    derived: Mapping[str, str] = ...,
    converted: Mapping[str, tuple[str, str]] = ...,
    carried: Mapping[str, str] = ...,
    ranges: Mapping[str, tuple[float | None, float | None]] = ...,
    bounded_above: frozenset[str] = frozenset(),
    bounded_below: frozenset[str] = frozenset(),
    reported: Mapping[str, tuple[float | tuple[float, float], ...]] = ...,
    unquantified: Mapping[str, str] = ...,
    uncertainty: Mapping[str, float] = ...,
    not_derivable: Mapping[str, str] = ...,
    misprinted: Mapping[str, str] = ...,
    attributed_to: Mapping[str, str] = ...,
    group: str = '',
    note: str = '',
    provenance: Provenance | None = None,
    impact_improvement_50_db: float | None = None,
    impact_improvement_63_db: float | None = None,
    impact_improvement_80_db: float | None = None,
    impact_improvement_100_db: float | None = None,
    impact_improvement_125_db: float | None = None,
    impact_improvement_160_db: float | None = None,
    impact_improvement_200_db: float | None = None,
    impact_improvement_250_db: float | None = None,
    impact_improvement_315_db: float | None = None,
    impact_improvement_400_db: float | None = None,
    impact_improvement_500_db: float | None = None,
    impact_improvement_630_db: float | None = None,
    impact_improvement_800_db: float | None = None,
    impact_improvement_1000_db: float | None = None,
    impact_improvement_1250_db: float | None = None,
    impact_improvement_1600_db: float | None = None,
    impact_improvement_2000_db: float | None = None,
    impact_improvement_2500_db: float | None = None,
    impact_improvement_3150_db: float | None = None,
    impact_improvement_4000_db: float | None = None,
    impact_improvement_5000_db: float | None = None,
    weighted_impact_improvement_db: float | None = None,
    reference_floor_adaptation_term_db: float | None = None,
    impact_improvement_adaptation_term_db: float | None = None,
)

One covering or floating floor of a report, with its $\Delta L$.

The reduction of impact sound pressure level $\Delta L$ of ISO 10140-1 Annex H, Equation (H.1): the normalized impact sound pressure level of a reference floor without the covering less the one with it, both measured by ISO 10140-3. It is the difference a floor covering or a floating floor makes to the impact level of the floor, one value per one-third octave band from 50 Hz to 5 kHz as the report prints them, and the single numbers of ISO 717-2 printed beside them. rating rates the bands again; the printed numbers stay as printed.

$\Delta L_{\mathrm{w}}$ has a field of its own because it is a rating against the reference floor of ISO 717-2 Table 4, not a mean over frequency: a handbook’s averaged improvement is another quantity, and this class never reads it.

Attributes

ImpactImprovementSpectrum.bands() -> tuple[int, ...]

The bands this row prints a value for, in hertz.

ImpactImprovementSpectrum.basis_of(field_name: str) -> str

What the source says this field is, one of CATALOGUE_BASES.

The five are measured, declared, calculated, estimated and extended.

Parameters

Returns: The field’s own entry in basis, else the row’s, else the empty string, which means the source does not say.

classmethod

ImpactImprovementSpectrum.from_printed(**cells: Any) -> Self

A row built from the cells its page prints, completed and marked.

The one path that works anything out. The cells are what the page prints, under the field names of the class and with the hedges each cell carries, as a data file writes them. A figure written in another unit of the same kind as its field (thickness_m for thickness_mm, flow_resistivity_kpa_s_m2 for flow_resistivity_pa_s_m2), or in a unit the class takes as an alias of its own (an AbsorptionAreaSpectrum takes absorption_area_125_ft2 for absorption_area_125_m2), is converted on its digits with an exact factor and rounded once, whether it is a value or stands as the key of a hedge (the ends of a range, the readings of a list and a plus-or-minus convert with it), and converted records the figure and its unit. Every number of one cell is written in one unit. The row is then built and held to the contract the class docstring lists, so every cell is checked before any arithmetic reads it. Last, the class fills what follows from those cells (a modulus from a plate speed, a density and a Poisson ratio), never over a cell that holds a value or one the row says something else about, and derived says how each filled value was reached and, when the cells it rests on do not share one basis, the basis of each. Cells the arithmetic cannot take are refused rather than turned into a value that would be wrong: a modulus of 1 GPa and a shear modulus of 0.1 GPa give a Poisson ratio of 4, which no isotropic solid has, and a row whose cells are not meant to give a value says so in not_derivable, which keeps the arithmetic from running.

Cls(...) stays literal: it holds what it is given and works nothing out. To change a cell of a row and have what follows from it follow again, change it in printed_fields and build again here; dataclasses.replace would copy the derived values as they were:

cells = row.printed_fields()
cells["density_kg_m3"] = 2400.0
row = type(row).from_printed(**cells)

Parameters

Returns: The row, with what follows from its cells filled in.

Raises

ImpactImprovementSpectrum.impact_improvement_db(band_hz: int) -> float

The reduction of impact level in one band, or a refusal.

Parameters

Returns: The printed $\Delta L$, in decibels.

Raises

ImpactImprovementSpectrum.is_approximate(field_name: str) -> bool

Whether the page prints this field with a ~.

Parameters

Returns: True when the page rounded the cell on purpose.

ImpactImprovementSpectrum.is_derived(field_name: str) -> bool

Whether this library computed this field instead of reading it.

Parameters

Returns: True when the page did not print it and the value follows from cells that it did. derived says how. A value the page prints in another unit, or gives by reference to another of its rows, answers False: the number is the page’s, and converted or carried says so.

ImpactImprovementSpectrum.printed(
    field_name: str,
    *,
    wanted_by: str = 'the caller',
) -> float

One quantity this page prints, or a refusal that says what it had.

Every quantity of a row is optional, because the pages print different columns, so a caller passing one into a function that requires a float has to narrow it. Doing it here beats an assertion at each call site: the refusal names the field, who wanted it and what the page had in that cell, which is the difference between a cell the book left empty and a cell holding the word “model”.

Parameters

Returns: The value, as a float.

Raises

ImpactImprovementSpectrum.printed_fields() -> dict[str, Any]

The cells the page prints, as from_printed takes them.

Every field, the name, the citation, the table and every hedge included, except the values this library derived, derived itself, and a field left at a default that holds nothing (a quantity the page leaves out, an empty text or hedge). A text field whose default says something is kept even when it holds no text: the per of an area per unit is a person unless the row says otherwise, and a row that leaves it empty has said otherwise. A value converted from the page’s unit and one the page gives by reference to another of its rows are the page’s, so they stay, with converted and carried beside them.

For every row from_printed builds, and so for every packaged one, type(row).from_printed(**row.printed_fields()) is the row again, and changing a cell before building it again is how a row is edited without carrying a derived value that no longer follows from it. A derived passed to the literal constructor is the caller’s own; it is left out here with its value, like every derived one, so building again gives back only what the class works out.

Returns: A new dictionary of constructor keywords. The values are the ones the row holds, frozen as the row holds them.

ImpactImprovementSpectrum.rating() -> ImpactImprovementRatingResult

The single numbers of ISO 717-2 worked out from the row’s bands.

weighted_impact_improvement and impact_improvement_adaptation_term on the 16 one-third octaves 100 Hz to 3150 Hz, and $C_{\mathrm{I},\mathrm{r}}=C_{\mathrm{I},\mathrm{r},0}-C_{\mathrm{I},\Delta }$ with $C_{\mathrm{I},\mathrm{r},0}=-11$ dB (Clause A.2.2).

Returns: The ImpactImprovementRatingResult.

Raises

ImpactImprovementSpectrum.spectrum() -> dict[int, float]

The row as {band_hz: value} over the bands it prints.

A band the page left empty, or printed as something other than a number, is left out rather than filled with a zero; why_missing on that band’s field says which it was.

ImpactImprovementSpectrum.values_at(
    frequencies_hz: ArrayLike,
) -> NDArray[np.float64]

The row’s value at each of frequencies_hz, or a refusal.

The adapter for a function that takes one value per band by position (the absorption of a surface in a reverberation formula, the transmission loss of a panel at the frequencies an enclosure model asks for), because an array handed over by position cannot say which band is missing and a row can. Each frequency is read as the band of these tables whose centre is nearest on a logarithmic scale, and matches it when it lies within a sixth of the spacing between bands: a sixth of an octave for octave bands, an eighteenth for one-third octave bands. That takes the nominal centre, the exact base-ten one and the exact base-two one alike (160 Hz, 158.49 Hz and 157.49 Hz are one band) and never reaches the next band. A band the row does not print is refused, as printed refuses it, with what the page had there; it is never read as zero and never filled from its neighbours.

Parameters

Returns: A new array of the same shape, one value per frequency.

Raises

ImpactImprovementSpectrum.why_missing(field_name: str) -> str

Why this field is None, in the page’s own terms.

A catalogue that answers None and stops is asking the caller to guess whether the material has no such property, whether the book measured it and printed a dash, or whether the cell holds something that is not a number. Each of those is a different answer.

The sentence names the document by its kind: "the datasheet", "the test report", and "the page" for a row with no provenance, which is every packaged one. For a cell the row holds in another unit than the page’s, a bound, a range or a list quotes the page’s figure and unit first and the row’s value after it: "the datasheet prints a lower bound of 5 kPa s/m2 (5000 Pa s/m2) and no value", never a figure the page does not print.

Parameters

Returns: What the page had in that cell, or the empty string when the field is not missing at all. A field the page has no column for and this library cannot derive, because the cells it would need are themselves a range, answers that it does not follow.

Raises

SoundReductionSpectrum(
    *,
    name: str,
    source: str,
    table: str = '',
    variant: str = '',
    basis: Mapping[str, str] = ...,
    approximate: frozenset[str] = frozenset(),
    derived: Mapping[str, str] = ...,
    converted: Mapping[str, tuple[str, str]] = ...,
    carried: Mapping[str, str] = ...,
    ranges: Mapping[str, tuple[float | None, float | None]] = ...,
    bounded_above: frozenset[str] = frozenset(),
    bounded_below: frozenset[str] = frozenset(),
    reported: Mapping[str, tuple[float | tuple[float, float], ...]] = ...,
    unquantified: Mapping[str, str] = ...,
    uncertainty: Mapping[str, float] = ...,
    not_derivable: Mapping[str, str] = ...,
    misprinted: Mapping[str, str] = ...,
    attributed_to: Mapping[str, str] = ...,
    group: str = '',
    note: str = '',
    provenance: Provenance | None = None,
    sound_reduction_index_50_db: float | None = None,
    sound_reduction_index_63_db: float | None = None,
    sound_reduction_index_80_db: float | None = None,
    sound_reduction_index_100_db: float | None = None,
    sound_reduction_index_125_db: float | None = None,
    sound_reduction_index_160_db: float | None = None,
    sound_reduction_index_200_db: float | None = None,
    sound_reduction_index_250_db: float | None = None,
    sound_reduction_index_315_db: float | None = None,
    sound_reduction_index_400_db: float | None = None,
    sound_reduction_index_500_db: float | None = None,
    sound_reduction_index_630_db: float | None = None,
    sound_reduction_index_800_db: float | None = None,
    sound_reduction_index_1000_db: float | None = None,
    sound_reduction_index_1250_db: float | None = None,
    sound_reduction_index_1600_db: float | None = None,
    sound_reduction_index_2000_db: float | None = None,
    sound_reduction_index_2500_db: float | None = None,
    sound_reduction_index_3150_db: float | None = None,
    sound_reduction_index_4000_db: float | None = None,
    sound_reduction_index_5000_db: float | None = None,
    weighted_sound_reduction_index_db: float | None = None,
    spectrum_adaptation_term_db: float | None = None,
    traffic_spectrum_adaptation_term_db: float | None = None,
    spectrum_adaptation_term_50_3150_db: float | None = None,
    spectrum_adaptation_term_50_5000_db: float | None = None,
    spectrum_adaptation_term_100_5000_db: float | None = None,
    traffic_spectrum_adaptation_term_50_3150_db: float | None = None,
    traffic_spectrum_adaptation_term_50_5000_db: float | None = None,
    traffic_spectrum_adaptation_term_100_5000_db: float | None = None,
    surface_density_kg_m2: float | None = None,
    thickness_mm: float | None = None,
    construction: str = '',
)

One element of a laboratory report, with its sound reduction index.

The sound reduction index $R$ of ISO 10140-2, measured between two rooms with the flanking paths suppressed, one value per one-third octave band from 50 Hz to 5 kHz as the report prints them, and the single numbers of ISO 717-1 printed beside them. rating rates the bands again; the printed numbers stay as printed.

Attributes

SoundReductionSpectrum.bands() -> tuple[int, ...]

The bands this row prints a value for, in hertz.

SoundReductionSpectrum.basis_of(field_name: str) -> str

What the source says this field is, one of CATALOGUE_BASES.

The five are measured, declared, calculated, estimated and extended.

Parameters

Returns: The field’s own entry in basis, else the row’s, else the empty string, which means the source does not say.

classmethod

SoundReductionSpectrum.from_printed(**cells: Any) -> Self

A row built from the cells its page prints, completed and marked.

The one path that works anything out. The cells are what the page prints, under the field names of the class and with the hedges each cell carries, as a data file writes them. A figure written in another unit of the same kind as its field (thickness_m for thickness_mm, flow_resistivity_kpa_s_m2 for flow_resistivity_pa_s_m2), or in a unit the class takes as an alias of its own (an AbsorptionAreaSpectrum takes absorption_area_125_ft2 for absorption_area_125_m2), is converted on its digits with an exact factor and rounded once, whether it is a value or stands as the key of a hedge (the ends of a range, the readings of a list and a plus-or-minus convert with it), and converted records the figure and its unit. Every number of one cell is written in one unit. The row is then built and held to the contract the class docstring lists, so every cell is checked before any arithmetic reads it. Last, the class fills what follows from those cells (a modulus from a plate speed, a density and a Poisson ratio), never over a cell that holds a value or one the row says something else about, and derived says how each filled value was reached and, when the cells it rests on do not share one basis, the basis of each. Cells the arithmetic cannot take are refused rather than turned into a value that would be wrong: a modulus of 1 GPa and a shear modulus of 0.1 GPa give a Poisson ratio of 4, which no isotropic solid has, and a row whose cells are not meant to give a value says so in not_derivable, which keeps the arithmetic from running.

Cls(...) stays literal: it holds what it is given and works nothing out. To change a cell of a row and have what follows from it follow again, change it in printed_fields and build again here; dataclasses.replace would copy the derived values as they were:

cells = row.printed_fields()
cells["density_kg_m3"] = 2400.0
row = type(row).from_printed(**cells)

Parameters

Returns: The row, with what follows from its cells filled in.

Raises

SoundReductionSpectrum.is_approximate(field_name: str) -> bool

Whether the page prints this field with a ~.

Parameters

Returns: True when the page rounded the cell on purpose.

SoundReductionSpectrum.is_derived(field_name: str) -> bool

Whether this library computed this field instead of reading it.

Parameters

Returns: True when the page did not print it and the value follows from cells that it did. derived says how. A value the page prints in another unit, or gives by reference to another of its rows, answers False: the number is the page’s, and converted or carried says so.

SoundReductionSpectrum.printed(
    field_name: str,
    *,
    wanted_by: str = 'the caller',
) -> float

One quantity this page prints, or a refusal that says what it had.

Every quantity of a row is optional, because the pages print different columns, so a caller passing one into a function that requires a float has to narrow it. Doing it here beats an assertion at each call site: the refusal names the field, who wanted it and what the page had in that cell, which is the difference between a cell the book left empty and a cell holding the word “model”.

Parameters

Returns: The value, as a float.

Raises

SoundReductionSpectrum.printed_fields() -> dict[str, Any]

The cells the page prints, as from_printed takes them.

Every field, the name, the citation, the table and every hedge included, except the values this library derived, derived itself, and a field left at a default that holds nothing (a quantity the page leaves out, an empty text or hedge). A text field whose default says something is kept even when it holds no text: the per of an area per unit is a person unless the row says otherwise, and a row that leaves it empty has said otherwise. A value converted from the page’s unit and one the page gives by reference to another of its rows are the page’s, so they stay, with converted and carried beside them.

For every row from_printed builds, and so for every packaged one, type(row).from_printed(**row.printed_fields()) is the row again, and changing a cell before building it again is how a row is edited without carrying a derived value that no longer follows from it. A derived passed to the literal constructor is the caller’s own; it is left out here with its value, like every derived one, so building again gives back only what the class works out.

Returns: A new dictionary of constructor keywords. The values are the ones the row holds, frozen as the row holds them.

SoundReductionSpectrum.rating() -> ExtendedWeightedRatingResult

The single numbers of ISO 717-1 worked out from the row’s bands.

weighted_rating_extended on every band the row prints: $R_{\mathrm{w}}$, $C$ and $C_{\mathrm{tr}}$ from the 16 one-third octaves 100 Hz to 3150 Hz (Clauses 4.4 and 4.5), which the result also carries as the weighted_rating of those bands in its core, and each adaptation term of Annex B whose range the row prints every band of. A term whose range has a band the row does not print is None: nothing is filled in to reach it.

Returns: The ExtendedWeightedRatingResult.

Raises

SoundReductionSpectrum.sound_reduction_index_db(band_hz: int) -> float

The sound reduction index in one band, or a refusal.

Parameters

Returns: The printed $R$, in decibels.

Raises

SoundReductionSpectrum.spectrum() -> dict[int, float]

The row as {band_hz: value} over the bands it prints.

A band the page left empty, or printed as something other than a number, is left out rather than filled with a zero; why_missing on that band’s field says which it was.

SoundReductionSpectrum.values_at(
    frequencies_hz: ArrayLike,
) -> NDArray[np.float64]

The row’s value at each of frequencies_hz, or a refusal.

The adapter for a function that takes one value per band by position (the absorption of a surface in a reverberation formula, the transmission loss of a panel at the frequencies an enclosure model asks for), because an array handed over by position cannot say which band is missing and a row can. Each frequency is read as the band of these tables whose centre is nearest on a logarithmic scale, and matches it when it lies within a sixth of the spacing between bands: a sixth of an octave for octave bands, an eighteenth for one-third octave bands. That takes the nominal centre, the exact base-ten one and the exact base-two one alike (160 Hz, 158.49 Hz and 157.49 Hz are one band) and never reaches the next band. A band the row does not print is refused, as printed refuses it, with what the page had there; it is never read as zero and never filled from its neighbours.

Parameters

Returns: A new array of the same shape, one value per frequency.

Raises

SoundReductionSpectrum.why_missing(field_name: str) -> str

Why this field is None, in the page’s own terms.

A catalogue that answers None and stops is asking the caller to guess whether the material has no such property, whether the book measured it and printed a dash, or whether the cell holds something that is not a number. Each of those is a different answer.

The sentence names the document by its kind: "the datasheet", "the test report", and "the page" for a row with no provenance, which is every packaged one. For a cell the row holds in another unit than the page’s, a bound, a range or a list quotes the page’s figure and unit first and the row’s value after it: "the datasheet prints a lower bound of 5 kPa s/m2 (5000 Pa s/m2) and no value", never a figure the page does not print.

Parameters

Returns: What the page had in that cell, or the empty string when the field is not missing at all. A field the page has no column for and this library cannot derive, because the cells it would need are themselves a range, answers that it does not follow.

Raises