jmrp.io / PyOctaveBand

0

[READ-ONLY] Mirror of https://github.com/jmrplens/PyOctaveBand. [Python3] Octave-Band and Fractional Octave-Band filter. For signal in time domain. jmrplens.github.io/PyOctaveBand/

acoustics audio filter frequency frequency-analysis frequency-domain octave python3 signal time-domain

0

PyOctaveBand / docs /

at docs/audit-bilingual 33 files

José M. Requena Plens Audit pass 6: split the three overloaded guides (#115) 15d ago

Audit pass 6: split the three overloaded guides (#115) * docs: split the three overloaded guides Audit batch 6 - reorganization with full content preservation (verified line-by-line against HEAD across the three surfaces): - room-acoustics (1096 lines) keeps ISO 18233 + ISO 3382-1/2/3 + ISO 354 measurement; the building half (ISO 16283 + ISO 717, ISO 10140, EN 12354-1/2, ISO 12999-1) moves to a new docs/building-acoustics.md built from the site's existing split, resolving the repo/site asymmetry. The flanking figure is reunited with its <details> code and flanking_path is introduced before it is referenced (audit fixes), on all three surfaces. - psychoacoustics extracts STI/STIPA to speech-transmission.md (paralleling speech-intelligibility.md) with STI-vs-SII disambiguation boxes on the three pages involved; ISO 226 moves into psychoacoustics where its perception content belongs, fixing its stale 'upcoming feature' sentence. - levels extracts occupational-exposure.md (ISO 9612) and tone-prominence.md (ECMA-418-1), keeping Leq/LN/peak/SEL/Lden and the spectrogram. Indexes, sidebar, theory/guide cross-links (~40 edits in 19 files) and the llms.txt generator PAGES list follow the moves; the four extracted topics now survive into llms-full.txt instead of dropping out. * docs: Spanish grammar fixes in the split guides - 'función de conveniencia' instead of the false friend 'comodidad' for convenience function (Gemini) - plural agreement 'estrategias basadas' at the two flagged sites (Gemini); the remaining 'basada' occurrences are correct singular agreements ('medición basada en tareas', 'la estrategia basada...') * docs: address second-round review on the splits - flanking_path() gains its own parameter table (with the kij_min Formula E.4 floor contract) in the building guide, all three surfaces (CodeRabbit) - the flanking figure snippet explicitly annotates its reuse of paths/ res from the snippet above; the speech-transmission figure snippet is now fully self-contained (imports + fs) on all surfaces (CodeRabbit) - ISO 10140-3 joins the laboratory standards footer (CodeRabbit) - the Speech Intelligibility guide joins llms.txt (regenerated) and the root README table (CodeRabbit)

2 weeks ago

Audit pass 6: split the three overloaded guides (#115) * docs: split the three overloaded guides Audit batch 6 - reorganization with full content preservation (verified line-by-line against HEAD across the three surfaces): - room-acoustics (1096 lines) keeps ISO 18233 + ISO 3382-1/2/3 + ISO 354 measurement; the building half (ISO 16283 + ISO 717, ISO 10140, EN 12354-1/2, ISO 12999-1) moves to a new docs/building-acoustics.md built from the site's existing split, resolving the repo/site asymmetry. The flanking figure is reunited with its <details> code and flanking_path is introduced before it is referenced (audit fixes), on all three surfaces. - psychoacoustics extracts STI/STIPA to speech-transmission.md (paralleling speech-intelligibility.md) with STI-vs-SII disambiguation boxes on the three pages involved; ISO 226 moves into psychoacoustics where its perception content belongs, fixing its stale 'upcoming feature' sentence. - levels extracts occupational-exposure.md (ISO 9612) and tone-prominence.md (ECMA-418-1), keeping Leq/LN/peak/SEL/Lden and the spectrogram. Indexes, sidebar, theory/guide cross-links (~40 edits in 19 files) and the llms.txt generator PAGES list follow the moves; the four extracted topics now survive into llms-full.txt instead of dropping out. * docs: Spanish grammar fixes in the split guides - 'función de conveniencia' instead of the false friend 'comodidad' for convenience function (Gemini) - plural agreement 'estrategias basadas' at the two flagged sites (Gemini); the remaining 'basada' occurrences are correct singular agreements ('medición basada en tareas', 'la estrategia basada...') * docs: address second-round review on the splits - flanking_path() gains its own parameter table (with the kij_min Formula E.4 floor contract) in the building guide, all three surfaces (CodeRabbit) - the flanking figure snippet explicitly annotates its reuse of paths/ res from the snippet above; the speech-transmission figure snippet is now fully self-contained (imports + fs) on all surfaces (CodeRabbit) - ISO 10140-3 joins the laboratory standards footer (CodeRabbit) - the Speech Intelligibility guide joins llms.txt (regenerated) and the root README table (CodeRabbit)

2 weeks ago

api-reference.md

Audit pass 5: complete API reference and theory coverage (#114) * docs: complete API reference and theory coverage Audit batch 5 — the reference layer catches up with everything merged since PR ~#95: API reference (repo + site EN/ES): from 152 to 351 documented names, verified complete against phonometry.__all__ (the six callable aliases and four PEP 562 renamed names live in a deprecated-aliases note instead of rows). All quoted example outputs are computed, not written by hand. Also deduplicates two warning rows in the site mirror, updates the .plot() availability note (38 result classes) and escapes the math | characters that broke GFM table rendering. Theory (repo + site EN/ES): sections for the sixteen standards the document did not cover - NT ACOU 112, ANSI S3.5 SII, ISO 389-7/7029, ISO 1999, ANSI S12.2, ISO 17497-1/2, ISO 13472-1/2, ISO 11654, ISO 9053-1/2, ISO 10534-1/2 + ASTM E2611, ISO 8041-1 + ISO 2631-1/2 + ISO 5349 + Directive 2002/44/EC, ISO 2631-5, EN 12354-6, ISO 3745, ISO 9614-3, DIN 45692 and the GUM + Supplement 1 - each with its formulas, normative constants taken from the code, design decisions and validation anchors, cross-linked to its guide. EN site mirror verified byte-identical to the repo file modulo frontmatter; ES translated with the site's conventions. * docs: Spanish decimal fixes in the new reference content - the described |H| output list in the ES API reference uses comma decimals like the surrounding prose (Gemini) - the two LaTeX exponents in the new ES theory sections use the {,} convention (Gemini) The def.: literals keep points deliberately - they are Python default literals and the file's ~150 existing rows already follow that style; the legacy point-decimals in pre-existing ES theory LaTeX belong to the systematic {,} migration scheduled in the bilingual batch.

2 weeks ago

block-processing.md

Audit pass 4b: deprecation-cycle renames of published API (#112) * refactor: deprecation-cycle renames of published API Audit batch 4b — the published names that violate the naming convention gain canonical replacements, with the old names working for one cycle (NEP 23 DeprecationWarning: deprecated since 3.1, removal in 4.0): - module loudness -> loudness_zwicker, with a PEP 562 __getattr__ shim (plain 'import phonometry' emits no warning) - renamed keywords via the sklearn sentinel, positional compatibility preserved: road_absorption sample_rate -> fs; outdoor_propagation humidity -> relative_humidity; sound_power room_volume -> volume - legacy PyOctaveBand names normalized: octave_filter, nominal_frequencies, normalized_frequencies and sensitivity are the canonical implementations; octavefilter, getansifrequencies, normalizedfreq and calculate_sensitivity delegate with a warning via the shared _warn_renamed helper - public string enums annotated with Literal (sex, field, presentation, method) - annotation only, runtime validation untouched Tests, scripts, docs and site sweep to the canonical names (~310 occurrences in 46 files); tests/test_deprecated_aliases.py pins every alias with pytest.warns plus delegation equality and the both-given / missing-required error paths. * fix: address review feedback on the deprecation batch - an explicit room_volume=None (the old default) no longer trips the deprecation warning; only a real value through the alias warns, with a regression test (Copilot) - the calibration snippets stop shadowing the imported sensitivity() with their result variable, in the repo doc and both site languages (Copilot) FutureWarning declined again with the rationale posted on the PR: DeprecationWarning is the ecosystem norm for renames (NEP 23, scipy), now codified in CONTRIBUTING. * fix: second-pass review feedback on the deprecation batch - loudness_zwicker validates calibration_factor through the shared require_positive, closing the NaN/inf-permeable check (CodeRabbit) - test names catch up with the octave_filter and sensitivity renames (CodeRabbit) - markdownlint MD022 blank line before the ES calibration heading (CodeRabbit)

2 weeks ago

building-acoustics.md

Audit pass 6: split the three overloaded guides (#115) * docs: split the three overloaded guides Audit batch 6 - reorganization with full content preservation (verified line-by-line against HEAD across the three surfaces): - room-acoustics (1096 lines) keeps ISO 18233 + ISO 3382-1/2/3 + ISO 354 measurement; the building half (ISO 16283 + ISO 717, ISO 10140, EN 12354-1/2, ISO 12999-1) moves to a new docs/building-acoustics.md built from the site's existing split, resolving the repo/site asymmetry. The flanking figure is reunited with its <details> code and flanking_path is introduced before it is referenced (audit fixes), on all three surfaces. - psychoacoustics extracts STI/STIPA to speech-transmission.md (paralleling speech-intelligibility.md) with STI-vs-SII disambiguation boxes on the three pages involved; ISO 226 moves into psychoacoustics where its perception content belongs, fixing its stale 'upcoming feature' sentence. - levels extracts occupational-exposure.md (ISO 9612) and tone-prominence.md (ECMA-418-1), keeping Leq/LN/peak/SEL/Lden and the spectrogram. Indexes, sidebar, theory/guide cross-links (~40 edits in 19 files) and the llms.txt generator PAGES list follow the moves; the four extracted topics now survive into llms-full.txt instead of dropping out. * docs: Spanish grammar fixes in the split guides - 'función de conveniencia' instead of the false friend 'comodidad' for convenience function (Gemini) - plural agreement 'estrategias basadas' at the two flagged sites (Gemini); the remaining 'basada' occurrences are correct singular agreements ('medición basada en tareas', 'la estrategia basada...') * docs: address second-round review on the splits - flanking_path() gains its own parameter table (with the kij_min Formula E.4 floor contract) in the building guide, all three surfaces (CodeRabbit) - the flanking figure snippet explicitly annotates its reuse of paths/ res from the snippet above; the speech-transmission figure snippet is now fully self-contained (imports + fs) on all surfaces (CodeRabbit) - ISO 10140-3 joins the laboratory standards footer (CodeRabbit) - the Speech Intelligibility guide joins llms.txt (regenerated) and the root README table (CodeRabbit)

2 weeks ago

Audit pass 4b: deprecation-cycle renames of published API (#112) * refactor: deprecation-cycle renames of published API Audit batch 4b — the published names that violate the naming convention gain canonical replacements, with the old names working for one cycle (NEP 23 DeprecationWarning: deprecated since 3.1, removal in 4.0): - module loudness -> loudness_zwicker, with a PEP 562 __getattr__ shim (plain 'import phonometry' emits no warning) - renamed keywords via the sklearn sentinel, positional compatibility preserved: road_absorption sample_rate -> fs; outdoor_propagation humidity -> relative_humidity; sound_power room_volume -> volume - legacy PyOctaveBand names normalized: octave_filter, nominal_frequencies, normalized_frequencies and sensitivity are the canonical implementations; octavefilter, getansifrequencies, normalizedfreq and calculate_sensitivity delegate with a warning via the shared _warn_renamed helper - public string enums annotated with Literal (sex, field, presentation, method) - annotation only, runtime validation untouched Tests, scripts, docs and site sweep to the canonical names (~310 occurrences in 46 files); tests/test_deprecated_aliases.py pins every alias with pytest.warns plus delegation equality and the both-given / missing-required error paths. * fix: address review feedback on the deprecation batch - an explicit room_volume=None (the old default) no longer trips the deprecation warning; only a real value through the alias warns, with a regression test (Copilot) - the calibration snippets stop shadowing the imported sensitivity() with their result variable, in the repo doc and both site languages (Copilot) FutureWarning declined again with the rationale posted on the PR: DeprecationWarning is the ecosystem norm for renames (NEP 23, scipy), now codified in CONTRIBUTING. * fix: second-pass review feedback on the deprecation batch - loudness_zwicker validates calibration_factor through the shared require_positive, closing the NaN/inf-permeable check (CodeRabbit) - test names catch up with the octave_filter and sensitivity renames (CodeRabbit) - markdownlint MD022 blank line before the ES calibration heading (CodeRabbit)

2 weeks ago

enclosed-space-absorption.md

Audit pass 6: split the three overloaded guides (#115) * docs: split the three overloaded guides Audit batch 6 - reorganization with full content preservation (verified line-by-line against HEAD across the three surfaces): - room-acoustics (1096 lines) keeps ISO 18233 + ISO 3382-1/2/3 + ISO 354 measurement; the building half (ISO 16283 + ISO 717, ISO 10140, EN 12354-1/2, ISO 12999-1) moves to a new docs/building-acoustics.md built from the site's existing split, resolving the repo/site asymmetry. The flanking figure is reunited with its <details> code and flanking_path is introduced before it is referenced (audit fixes), on all three surfaces. - psychoacoustics extracts STI/STIPA to speech-transmission.md (paralleling speech-intelligibility.md) with STI-vs-SII disambiguation boxes on the three pages involved; ISO 226 moves into psychoacoustics where its perception content belongs, fixing its stale 'upcoming feature' sentence. - levels extracts occupational-exposure.md (ISO 9612) and tone-prominence.md (ECMA-418-1), keeping Leq/LN/peak/SEL/Lden and the spectrogram. Indexes, sidebar, theory/guide cross-links (~40 edits in 19 files) and the llms.txt generator PAGES list follow the moves; the four extracted topics now survive into llms-full.txt instead of dropping out. * docs: Spanish grammar fixes in the split guides - 'función de conveniencia' instead of the false friend 'comodidad' for convenience function (Gemini) - plural agreement 'estrategias basadas' at the two flagged sites (Gemini); the remaining 'basada' occurrences are correct singular agreements ('medición basada en tareas', 'la estrategia basada...') * docs: address second-round review on the splits - flanking_path() gains its own parameter table (with the kij_min Formula E.4 floor contract) in the building guide, all three surfaces (CodeRabbit) - the flanking figure snippet explicitly annotates its reuse of paths/ res from the snippet above; the speech-transmission figure snippet is now fully self-contained (imports + fs) on all surfaces (CodeRabbit) - ISO 10140-3 joins the laboratory standards footer (CodeRabbit) - the Speech Intelligibility guide joins llms.txt (regenerated) and the root README table (CodeRabbit)

2 weeks ago

filter-banks.md

Audit pass 4b: deprecation-cycle renames of published API (#112) * refactor: deprecation-cycle renames of published API Audit batch 4b — the published names that violate the naming convention gain canonical replacements, with the old names working for one cycle (NEP 23 DeprecationWarning: deprecated since 3.1, removal in 4.0): - module loudness -> loudness_zwicker, with a PEP 562 __getattr__ shim (plain 'import phonometry' emits no warning) - renamed keywords via the sklearn sentinel, positional compatibility preserved: road_absorption sample_rate -> fs; outdoor_propagation humidity -> relative_humidity; sound_power room_volume -> volume - legacy PyOctaveBand names normalized: octave_filter, nominal_frequencies, normalized_frequencies and sensitivity are the canonical implementations; octavefilter, getansifrequencies, normalizedfreq and calculate_sensitivity delegate with a warning via the shared _warn_renamed helper - public string enums annotated with Literal (sex, field, presentation, method) - annotation only, runtime validation untouched Tests, scripts, docs and site sweep to the canonical names (~310 occurrences in 46 files); tests/test_deprecated_aliases.py pins every alias with pytest.warns plus delegation equality and the both-given / missing-required error paths. * fix: address review feedback on the deprecation batch - an explicit room_volume=None (the old default) no longer trips the deprecation warning; only a real value through the alias warns, with a regression test (Copilot) - the calibration snippets stop shadowing the imported sensitivity() with their result variable, in the repo doc and both site languages (Copilot) FutureWarning declined again with the rationale posted on the PR: DeprecationWarning is the ecosystem norm for renames (NEP 23, scipy), now codified in CONTRIBUTING. * fix: second-pass review feedback on the deprecation batch - loudness_zwicker validates calibration_factor through the shared require_positive, closing the NaN/inf-permeable check (CodeRabbit) - test names catch up with the octave_filter and sensitivity renames (CodeRabbit) - markdownlint MD022 blank line before the ES calibration heading (CodeRabbit)

2 weeks ago

getting-started.md

Audit pass 4b: deprecation-cycle renames of published API (#112) * refactor: deprecation-cycle renames of published API Audit batch 4b — the published names that violate the naming convention gain canonical replacements, with the old names working for one cycle (NEP 23 DeprecationWarning: deprecated since 3.1, removal in 4.0): - module loudness -> loudness_zwicker, with a PEP 562 __getattr__ shim (plain 'import phonometry' emits no warning) - renamed keywords via the sklearn sentinel, positional compatibility preserved: road_absorption sample_rate -> fs; outdoor_propagation humidity -> relative_humidity; sound_power room_volume -> volume - legacy PyOctaveBand names normalized: octave_filter, nominal_frequencies, normalized_frequencies and sensitivity are the canonical implementations; octavefilter, getansifrequencies, normalizedfreq and calculate_sensitivity delegate with a warning via the shared _warn_renamed helper - public string enums annotated with Literal (sex, field, presentation, method) - annotation only, runtime validation untouched Tests, scripts, docs and site sweep to the canonical names (~310 occurrences in 46 files); tests/test_deprecated_aliases.py pins every alias with pytest.warns plus delegation equality and the both-given / missing-required error paths. * fix: address review feedback on the deprecation batch - an explicit room_volume=None (the old default) no longer trips the deprecation warning; only a real value through the alias warns, with a regression test (Copilot) - the calibration snippets stop shadowing the imported sensitivity() with their result variable, in the repo doc and both site languages (Copilot) FutureWarning declined again with the rationale posted on the PR: DeprecationWarning is the ecosystem norm for renames (NEP 23, scipy), now codified in CONTRIBUTING. * fix: second-pass review feedback on the deprecation batch - loudness_zwicker validates calibration_factor through the shared require_positive, closing the NaN/inf-permeable check (CodeRabbit) - test names catch up with the octave_filter and sensitivity renames (CodeRabbit) - markdownlint MD022 blank line before the ES calibration heading (CodeRabbit)

2 weeks ago

gum-uncertainty.md

feat: measurement uncertainty (GUM ISO/IEC Guide 98-3:2008 + Monte Carlo Supplement 1) (#102) Adds a `phonometry.uncertainty` module implementing the two propagation methods of the GUM: * Law of propagation of uncertainty (ISO/IEC Guide 98-3:2008, clause 5) — `combine_uncertainty` builds the combined standard uncertainty from central-difference sensitivity coefficients, with optional input correlations (validated for shape, symmetry, unit diagonal and positive-semidefiniteness), Welch-Satterthwaite effective degrees of freedom (Annex G.4) and the expanded uncertainty U = k*uc (clause 6). * Monte Carlo method (ISO/IEC Guide 98-3-1:2008, Supplement 1, clause 7) — `monte_carlo` propagates the input PDFs and returns the estimate, its standard uncertainty and the probabilistically symmetric coverage interval (clause 7.7). Type B quantities from a half-width: `rectangular` (a/sqrt3), `triangular` (a/sqrt6), `u_shaped` (a/sqrt2). Results expose `.expanded()` and `.plot()` (uncertainty budget). Validated against the Guides' worked examples: additive uc=2.0 (Suppl. 1, 9.2), coverage factor k=2.92 at p=0.99/v=16 (Table G.2), Welch-Satterthwaite v_eff=40 (Annex G.4), Monte Carlo interval [-3.88, 3.88] (Suppl. 1, 9.2.3). Conformance 79/79. Includes the budget/Monte-Carlo figure, the two-lane GUM-vs-Monte-Carlo diagram (EN/ES, light/dark), the repo doc and the EN/ES site guides under a new "Metrology & uncertainty" section.

2 weeks ago

hearing-threshold.md

feat: hearing threshold (ISO 7029:2017 age model, ISO 389-7:2006 reference) (#101) Add phonometry.hearing: age_threshold (ISO 7029:2017 statistical age distribution — median, spreads, population fractile) and reference_threshold (ISO 389-7:2006 free/diffuse-field audiometric zero) over 125 Hz - 8000 Hz. Coefficients parsed digit-exact from the standard. AgeThresholdResult with .plot(); 11 tests; 3 conformance checks (76/76); figure + diagram (EN/ES, light/dark); repo doc + site guides EN/ES.

2 weeks ago

human-vibration.md

Human vibration exposure (ISO 8041-1, ISO 2631, ISO 5349, Directive 2002/44/EC) (#94) New `human_vibration` module implementing the ISO 8041-1:2017 master weighting cascade (all nine weightings Wb/Wc/Wd/We/Wf/Wh/Wj/Wk/Wm), ISO 2631-1/-2/-4 whole-body metrics (running RMS, MTVV, VDV, MSDV, crest factor, vibration total value, energy-equivalent acceleration), the ISO 5349-1/-2 hand-arm A(8) arithmetic and vibration-white-finger latency, and the Directive 2002/44/EC EAV/ELV assessment. Every result object exposes .plot(); validated to <0.05% against the ISO 8041-1 Annex B tables and the ISO 5349-2 Annex E worked examples. Includes docs page, figures, setup diagram, and 7 conformance checks (100%).

2 weeks ago

impulse-prominence.md

Audit pass 4a: concept-based names for the four unpublished modules (#111) * refactor: concept-based names for the four unpublished modules Audit batch 4a — the four modules named after standard numbers were all merged after v3.0.0 and never published, so they rename cleanly (no deprecation shims), aligned with their documentation pages: - iso1999 -> noise_induced_hearing_loss - iso2631_5 -> multiple_shock_vibration - ntacou112 -> impulse_prominence - en12354_6 -> enclosed_space_absorption - class ImpulseProminence -> ImpulseProminenceResult Everything that referenced the old module paths moves with them: package imports/__all__, the plotting layer (including plot_en12354_6 -> plot_enclosed_space_absorption), the test files (1:1 names, history preserved), the conformance checks and the figure/diagram generator functions (generate_nihl -> generate_noise_induced_hearing_loss for consistency). Committed image basenames stay unchanged (published docs link them). CONTRIBUTING.md gains the validated Naming Conventions section (per-group table + deprecation mechanics: NEP 23-format DeprecationWarning, PEP 562 module __getattr__ shims, the sklearn deprecated-kwarg sentinel, removal only in majors) so the drift that produced the standard-number names cannot recur. * docs: align the deprecation policy with the implemented shims - CONTRIBUTING: the stacklevel rule now says what it is for (point at the caller's line: 2 direct, 3 via a shared helper) instead of a literal that contradicted the existing helper-based shims (CodeRabbit) - the insulation_* deprecation messages carry the NEP 23 version metadata (deprecated since 3.1, removal in 4.0) Gemini's FutureWarning suggestion is declined again: the ecosystem research (NEP 23, scipy) settles DeprecationWarning for renames; FutureWarning is reserved for behavior changes.

2 weeks ago

Audit pass 1: hard bugs in docs, figures and plotting (#108) * fix: first pass of audit findings (docs, figures, plotting) Documentation: - fix the Spanish filter-figure regression: _showfilter gains a close flag and the generator saves through themed_path after drawing, so the translation pass runs on the finished figure; restore the two _ES_EXACT keys removed in #82 (they are emitted by filter_design, not by the script) - repair the broken building-acoustics.md link in the enclosed-space guide (the repo split lives in room-acoustics.md) - make the multiple-shock and intensity snippets self-contained: define az/fs with a synthetic shock train (verified outputs 20.94 m/s2, R=0.46, probability 0.03) and import numpy with stated outputs (F2=3.41, Ld=8.0), in the repo doc and both site languages - decimal points in the English Formula texts (1.07, 55.3) that had kept the Spanish comma Figures: - stop drawing data series in the grid colour (invisible on light backgrounds): time-weighting input burst, hearing-threshold 20 yr and NIPTS 10 yr curves, and the unweighted/partial bars now use a visible neutral grey; regenerate the 15 affected figure sets Plotting layer: - plot_facade_insulation forwards user kwargs to the primary D2m,nT curve only, so label=/color= no longer raise or merge the four curves; the kwargs-forwarding test now covers the facade plot - harden three edge cases: all-masked SII (zero contribution no longer divides 0/0), empty per-impulse prominence, and nearest-band lookup for the NC governing marker instead of float equality - sharpness normalization sanity guards raise RuntimeError instead of AssertionError * refactor: address review feedback on the NC marker and facade test - plot_noise_criterion: pick the nearest valid (non-NaN) band and place the governing marker on that band's frequency so x and y stay paired; skip the marker if every level is NaN (Copilot) - add an explicit regression test for plot_facade_insulation(label=...), which used to raise TypeError (Copilot)

2 weeks ago

Audit pass 6: split the three overloaded guides (#115) * docs: split the three overloaded guides Audit batch 6 - reorganization with full content preservation (verified line-by-line against HEAD across the three surfaces): - room-acoustics (1096 lines) keeps ISO 18233 + ISO 3382-1/2/3 + ISO 354 measurement; the building half (ISO 16283 + ISO 717, ISO 10140, EN 12354-1/2, ISO 12999-1) moves to a new docs/building-acoustics.md built from the site's existing split, resolving the repo/site asymmetry. The flanking figure is reunited with its <details> code and flanking_path is introduced before it is referenced (audit fixes), on all three surfaces. - psychoacoustics extracts STI/STIPA to speech-transmission.md (paralleling speech-intelligibility.md) with STI-vs-SII disambiguation boxes on the three pages involved; ISO 226 moves into psychoacoustics where its perception content belongs, fixing its stale 'upcoming feature' sentence. - levels extracts occupational-exposure.md (ISO 9612) and tone-prominence.md (ECMA-418-1), keeping Leq/LN/peak/SEL/Lden and the spectrogram. Indexes, sidebar, theory/guide cross-links (~40 edits in 19 files) and the llms.txt generator PAGES list follow the moves; the four extracted topics now survive into llms-full.txt instead of dropping out. * docs: Spanish grammar fixes in the split guides - 'función de conveniencia' instead of the false friend 'comodidad' for convenience function (Gemini) - plural agreement 'estrategias basadas' at the two flagged sites (Gemini); the remaining 'basada' occurrences are correct singular agreements ('medición basada en tareas', 'la estrategia basada...') * docs: address second-round review on the splits - flanking_path() gains its own parameter table (with the kij_min Formula E.4 floor contract) in the building guide, all three surfaces (CodeRabbit) - the flanking figure snippet explicitly annotates its reuse of paths/ res from the snippet above; the speech-transmission figure snippet is now fully self-contained (imports + fs) on all surfaces (CodeRabbit) - ISO 10140-3 joins the laboratory standards footer (CodeRabbit) - the Speech Intelligibility guide joins llms.txt (regenerated) and the root README table (CodeRabbit)

2 weeks ago

docs: correct impedance-tube inputs in materials reference (#96) transfer_matrix_two_load / transfer_matrix_one_load take the four microphone transfer functions (H1, H2, H3, H4) of each load (ASTM E2611), not "wave amplitudes". Aligns docs/materials.md with the API docstring and the documentation site.

2 weeks ago

multichannel.md

Audit pass 4b: deprecation-cycle renames of published API (#112) * refactor: deprecation-cycle renames of published API Audit batch 4b — the published names that violate the naming convention gain canonical replacements, with the old names working for one cycle (NEP 23 DeprecationWarning: deprecated since 3.1, removal in 4.0): - module loudness -> loudness_zwicker, with a PEP 562 __getattr__ shim (plain 'import phonometry' emits no warning) - renamed keywords via the sklearn sentinel, positional compatibility preserved: road_absorption sample_rate -> fs; outdoor_propagation humidity -> relative_humidity; sound_power room_volume -> volume - legacy PyOctaveBand names normalized: octave_filter, nominal_frequencies, normalized_frequencies and sensitivity are the canonical implementations; octavefilter, getansifrequencies, normalizedfreq and calculate_sensitivity delegate with a warning via the shared _warn_renamed helper - public string enums annotated with Literal (sex, field, presentation, method) - annotation only, runtime validation untouched Tests, scripts, docs and site sweep to the canonical names (~310 occurrences in 46 files); tests/test_deprecated_aliases.py pins every alias with pytest.warns plus delegation equality and the both-given / missing-required error paths. * fix: address review feedback on the deprecation batch - an explicit room_volume=None (the old default) no longer trips the deprecation warning; only a real value through the alias warns, with a regression test (Copilot) - the calibration snippets stop shadowing the imported sensitivity() with their result variable, in the repo doc and both site languages (Copilot) FutureWarning declined again with the rationale posted on the PR: DeprecationWarning is the ecosystem norm for renames (NEP 23, scipy), now codified in CONTRIBUTING. * fix: second-pass review feedback on the deprecation batch - loudness_zwicker validates calibration_factor through the shared require_positive, closing the NaN/inf-permeable check (CodeRabbit) - test names catch up with the octave_filter and sensitivity renames (CodeRabbit) - markdownlint MD022 blank line before the ES calibration heading (CodeRabbit)

2 weeks ago

multiple-shock-vibration.md

Audit pass 1: hard bugs in docs, figures and plotting (#108) * fix: first pass of audit findings (docs, figures, plotting) Documentation: - fix the Spanish filter-figure regression: _showfilter gains a close flag and the generator saves through themed_path after drawing, so the translation pass runs on the finished figure; restore the two _ES_EXACT keys removed in #82 (they are emitted by filter_design, not by the script) - repair the broken building-acoustics.md link in the enclosed-space guide (the repo split lives in room-acoustics.md) - make the multiple-shock and intensity snippets self-contained: define az/fs with a synthetic shock train (verified outputs 20.94 m/s2, R=0.46, probability 0.03) and import numpy with stated outputs (F2=3.41, Ld=8.0), in the repo doc and both site languages - decimal points in the English Formula texts (1.07, 55.3) that had kept the Spanish comma Figures: - stop drawing data series in the grid colour (invisible on light backgrounds): time-weighting input burst, hearing-threshold 20 yr and NIPTS 10 yr curves, and the unweighted/partial bars now use a visible neutral grey; regenerate the 15 affected figure sets Plotting layer: - plot_facade_insulation forwards user kwargs to the primary D2m,nT curve only, so label=/color= no longer raise or merge the four curves; the kwargs-forwarding test now covers the facade plot - harden three edge cases: all-masked SII (zero contribution no longer divides 0/0), empty per-impulse prominence, and nearest-band lookup for the NC governing marker instead of float equality - sharpness normalization sanity guards raise RuntimeError instead of AssertionError * refactor: address review feedback on the NC marker and facade test - plot_noise_criterion: pick the nearest valid (non-NaN) band and place the governing marker on that band's frequency so x and y stay paired; skip the marker if every level is NaN (Copilot) - add an explicit regression test for plot_facade_insulation(label=...), which used to raise TypeError (Copilot)

2 weeks ago

noise-induced-hearing-loss.md

Audit pass 4a: concept-based names for the four unpublished modules (#111) * refactor: concept-based names for the four unpublished modules Audit batch 4a — the four modules named after standard numbers were all merged after v3.0.0 and never published, so they rename cleanly (no deprecation shims), aligned with their documentation pages: - iso1999 -> noise_induced_hearing_loss - iso2631_5 -> multiple_shock_vibration - ntacou112 -> impulse_prominence - en12354_6 -> enclosed_space_absorption - class ImpulseProminence -> ImpulseProminenceResult Everything that referenced the old module paths moves with them: package imports/__all__, the plotting layer (including plot_en12354_6 -> plot_enclosed_space_absorption), the test files (1:1 names, history preserved), the conformance checks and the figure/diagram generator functions (generate_nihl -> generate_noise_induced_hearing_loss for consistency). Committed image basenames stay unchanged (published docs link them). CONTRIBUTING.md gains the validated Naming Conventions section (per-group table + deprecation mechanics: NEP 23-format DeprecationWarning, PEP 562 module __getattr__ shims, the sklearn deprecated-kwarg sentinel, removal only in majors) so the drift that produced the standard-number names cannot recur. * docs: align the deprecation policy with the implemented shims - CONTRIBUTING: the stacklevel rule now says what it is for (point at the caller's line: 2 direct, 3 via a shared helper) instead of a literal that contradicted the existing helper-based shims (CodeRabbit) - the insulation_* deprecation messages carry the NEP 23 version metadata (deprecated since 3.1, removal in 4.0) Gemini's FutureWarning suggestion is declined again: the ecosystem research (NEP 23, scipy) settles DeprecationWarning for renames; FutureWarning is reserved for behavior changes.

2 weeks ago

occupational-exposure.md

Audit pass 6: split the three overloaded guides (#115) * docs: split the three overloaded guides Audit batch 6 - reorganization with full content preservation (verified line-by-line against HEAD across the three surfaces): - room-acoustics (1096 lines) keeps ISO 18233 + ISO 3382-1/2/3 + ISO 354 measurement; the building half (ISO 16283 + ISO 717, ISO 10140, EN 12354-1/2, ISO 12999-1) moves to a new docs/building-acoustics.md built from the site's existing split, resolving the repo/site asymmetry. The flanking figure is reunited with its <details> code and flanking_path is introduced before it is referenced (audit fixes), on all three surfaces. - psychoacoustics extracts STI/STIPA to speech-transmission.md (paralleling speech-intelligibility.md) with STI-vs-SII disambiguation boxes on the three pages involved; ISO 226 moves into psychoacoustics where its perception content belongs, fixing its stale 'upcoming feature' sentence. - levels extracts occupational-exposure.md (ISO 9612) and tone-prominence.md (ECMA-418-1), keeping Leq/LN/peak/SEL/Lden and the spectrogram. Indexes, sidebar, theory/guide cross-links (~40 edits in 19 files) and the llms.txt generator PAGES list follow the moves; the four extracted topics now survive into llms-full.txt instead of dropping out. * docs: Spanish grammar fixes in the split guides - 'función de conveniencia' instead of the false friend 'comodidad' for convenience function (Gemini) - plural agreement 'estrategias basadas' at the two flagged sites (Gemini); the remaining 'basada' occurrences are correct singular agreements ('medición basada en tareas', 'la estrategia basada...') * docs: address second-round review on the splits - flanking_path() gains its own parameter table (with the kij_min Formula E.4 floor contract) in the building guide, all three surfaces (CodeRabbit) - the flanking figure snippet explicitly annotates its reuse of paths/ res from the snippet above; the speech-transmission figure snippet is now fully self-contained (imports + fs) on all surfaces (CodeRabbit) - ISO 10140-3 joins the laboratory standards footer (CodeRabbit) - the Speech Intelligibility guide joins llms.txt (regenerated) and the root README table (CodeRabbit)

2 weeks ago

outdoor-propagation.md

Audit pass 6: split the three overloaded guides (#115) * docs: split the three overloaded guides Audit batch 6 - reorganization with full content preservation (verified line-by-line against HEAD across the three surfaces): - room-acoustics (1096 lines) keeps ISO 18233 + ISO 3382-1/2/3 + ISO 354 measurement; the building half (ISO 16283 + ISO 717, ISO 10140, EN 12354-1/2, ISO 12999-1) moves to a new docs/building-acoustics.md built from the site's existing split, resolving the repo/site asymmetry. The flanking figure is reunited with its <details> code and flanking_path is introduced before it is referenced (audit fixes), on all three surfaces. - psychoacoustics extracts STI/STIPA to speech-transmission.md (paralleling speech-intelligibility.md) with STI-vs-SII disambiguation boxes on the three pages involved; ISO 226 moves into psychoacoustics where its perception content belongs, fixing its stale 'upcoming feature' sentence. - levels extracts occupational-exposure.md (ISO 9612) and tone-prominence.md (ECMA-418-1), keeping Leq/LN/peak/SEL/Lden and the spectrogram. Indexes, sidebar, theory/guide cross-links (~40 edits in 19 files) and the llms.txt generator PAGES list follow the moves; the four extracted topics now survive into llms-full.txt instead of dropping out. * docs: Spanish grammar fixes in the split guides - 'función de conveniencia' instead of the false friend 'comodidad' for convenience function (Gemini) - plural agreement 'estrategias basadas' at the two flagged sites (Gemini); the remaining 'basada' occurrences are correct singular agreements ('medición basada en tareas', 'la estrategia basada...') * docs: address second-round review on the splits - flanking_path() gains its own parameter table (with the kij_min Formula E.4 floor contract) in the building guide, all three surfaces (CodeRabbit) - the flanking figure snippet explicitly annotates its reuse of paths/ res from the snippet above; the speech-transmission figure snippet is now fully self-contained (imports + fs) on all surfaces (CodeRabbit) - ISO 10140-3 joins the laboratory standards footer (CodeRabbit) - the Speech Intelligibility guide joins llms.txt (regenerated) and the root README table (CodeRabbit)

2 weeks ago

psychoacoustics.md

Audit pass 6: split the three overloaded guides (#115) * docs: split the three overloaded guides Audit batch 6 - reorganization with full content preservation (verified line-by-line against HEAD across the three surfaces): - room-acoustics (1096 lines) keeps ISO 18233 + ISO 3382-1/2/3 + ISO 354 measurement; the building half (ISO 16283 + ISO 717, ISO 10140, EN 12354-1/2, ISO 12999-1) moves to a new docs/building-acoustics.md built from the site's existing split, resolving the repo/site asymmetry. The flanking figure is reunited with its <details> code and flanking_path is introduced before it is referenced (audit fixes), on all three surfaces. - psychoacoustics extracts STI/STIPA to speech-transmission.md (paralleling speech-intelligibility.md) with STI-vs-SII disambiguation boxes on the three pages involved; ISO 226 moves into psychoacoustics where its perception content belongs, fixing its stale 'upcoming feature' sentence. - levels extracts occupational-exposure.md (ISO 9612) and tone-prominence.md (ECMA-418-1), keeping Leq/LN/peak/SEL/Lden and the spectrogram. Indexes, sidebar, theory/guide cross-links (~40 edits in 19 files) and the llms.txt generator PAGES list follow the moves; the four extracted topics now survive into llms-full.txt instead of dropping out. * docs: Spanish grammar fixes in the split guides - 'función de conveniencia' instead of the false friend 'comodidad' for convenience function (Gemini) - plural agreement 'estrategias basadas' at the two flagged sites (Gemini); the remaining 'basada' occurrences are correct singular agreements ('medición basada en tareas', 'la estrategia basada...') * docs: address second-round review on the splits - flanking_path() gains its own parameter table (with the kij_min Formula E.4 floor contract) in the building guide, all three surfaces (CodeRabbit) - the flanking figure snippet explicitly annotates its reuse of paths/ res from the snippet above; the speech-transmission figure snippet is now fully self-contained (imports + fs) on all surfaces (CodeRabbit) - ISO 10140-3 joins the laboratory standards footer (CodeRabbit) - the Speech Intelligibility guide joins llms.txt (regenerated) and the root README table (CodeRabbit)

2 weeks ago

room-acoustics.md

Audit pass 6: split the three overloaded guides (#115) * docs: split the three overloaded guides Audit batch 6 - reorganization with full content preservation (verified line-by-line against HEAD across the three surfaces): - room-acoustics (1096 lines) keeps ISO 18233 + ISO 3382-1/2/3 + ISO 354 measurement; the building half (ISO 16283 + ISO 717, ISO 10140, EN 12354-1/2, ISO 12999-1) moves to a new docs/building-acoustics.md built from the site's existing split, resolving the repo/site asymmetry. The flanking figure is reunited with its <details> code and flanking_path is introduced before it is referenced (audit fixes), on all three surfaces. - psychoacoustics extracts STI/STIPA to speech-transmission.md (paralleling speech-intelligibility.md) with STI-vs-SII disambiguation boxes on the three pages involved; ISO 226 moves into psychoacoustics where its perception content belongs, fixing its stale 'upcoming feature' sentence. - levels extracts occupational-exposure.md (ISO 9612) and tone-prominence.md (ECMA-418-1), keeping Leq/LN/peak/SEL/Lden and the spectrogram. Indexes, sidebar, theory/guide cross-links (~40 edits in 19 files) and the llms.txt generator PAGES list follow the moves; the four extracted topics now survive into llms-full.txt instead of dropping out. * docs: Spanish grammar fixes in the split guides - 'función de conveniencia' instead of the false friend 'comodidad' for convenience function (Gemini) - plural agreement 'estrategias basadas' at the two flagged sites (Gemini); the remaining 'basada' occurrences are correct singular agreements ('medición basada en tareas', 'la estrategia basada...') * docs: address second-round review on the splits - flanking_path() gains its own parameter table (with the kij_min Formula E.4 floor contract) in the building guide, all three surfaces (CodeRabbit) - the flanking figure snippet explicitly annotates its reuse of paths/ res from the snippet above; the speech-transmission figure snippet is now fully self-contained (imports + fs) on all surfaces (CodeRabbit) - ISO 10140-3 joins the laboratory standards footer (CodeRabbit) - the Speech Intelligibility guide joins llms.txt (regenerated) and the root README table (CodeRabbit)

2 weeks ago

fix: SonarCloud smells + CodeRabbit review on room-noise (#100) Hoist the repeated "upper right" legend location into a Final constant (S1192); build the RC spectral tag with explicit concatenation (S5797); show the interpolated NC rating with :g so the figure title and prose agree (NC-42.5), regenerating the figure and alt text.

2 weeks ago

Audit pass 6: split the three overloaded guides (#115) * docs: split the three overloaded guides Audit batch 6 - reorganization with full content preservation (verified line-by-line against HEAD across the three surfaces): - room-acoustics (1096 lines) keeps ISO 18233 + ISO 3382-1/2/3 + ISO 354 measurement; the building half (ISO 16283 + ISO 717, ISO 10140, EN 12354-1/2, ISO 12999-1) moves to a new docs/building-acoustics.md built from the site's existing split, resolving the repo/site asymmetry. The flanking figure is reunited with its <details> code and flanking_path is introduced before it is referenced (audit fixes), on all three surfaces. - psychoacoustics extracts STI/STIPA to speech-transmission.md (paralleling speech-intelligibility.md) with STI-vs-SII disambiguation boxes on the three pages involved; ISO 226 moves into psychoacoustics where its perception content belongs, fixing its stale 'upcoming feature' sentence. - levels extracts occupational-exposure.md (ISO 9612) and tone-prominence.md (ECMA-418-1), keeping Leq/LN/peak/SEL/Lden and the spectrogram. Indexes, sidebar, theory/guide cross-links (~40 edits in 19 files) and the llms.txt generator PAGES list follow the moves; the four extracted topics now survive into llms-full.txt instead of dropping out. * docs: Spanish grammar fixes in the split guides - 'función de conveniencia' instead of the false friend 'comodidad' for convenience function (Gemini) - plural agreement 'estrategias basadas' at the two flagged sites (Gemini); the remaining 'basada' occurrences are correct singular agreements ('medición basada en tareas', 'la estrategia basada...') * docs: address second-round review on the splits - flanking_path() gains its own parameter table (with the kij_min Formula E.4 floor contract) in the building guide, all three surfaces (CodeRabbit) - the flanking figure snippet explicitly annotates its reuse of paths/ res from the snippet above; the speech-transmission figure snippet is now fully self-contained (imports + fs) on all surfaces (CodeRabbit) - ISO 10140-3 joins the laboratory standards footer (CodeRabbit) - the Speech Intelligibility guide joins llms.txt (regenerated) and the root README table (CodeRabbit)

2 weeks ago

speech-intelligibility.md

Audit pass 6: split the three overloaded guides (#115) * docs: split the three overloaded guides Audit batch 6 - reorganization with full content preservation (verified line-by-line against HEAD across the three surfaces): - room-acoustics (1096 lines) keeps ISO 18233 + ISO 3382-1/2/3 + ISO 354 measurement; the building half (ISO 16283 + ISO 717, ISO 10140, EN 12354-1/2, ISO 12999-1) moves to a new docs/building-acoustics.md built from the site's existing split, resolving the repo/site asymmetry. The flanking figure is reunited with its <details> code and flanking_path is introduced before it is referenced (audit fixes), on all three surfaces. - psychoacoustics extracts STI/STIPA to speech-transmission.md (paralleling speech-intelligibility.md) with STI-vs-SII disambiguation boxes on the three pages involved; ISO 226 moves into psychoacoustics where its perception content belongs, fixing its stale 'upcoming feature' sentence. - levels extracts occupational-exposure.md (ISO 9612) and tone-prominence.md (ECMA-418-1), keeping Leq/LN/peak/SEL/Lden and the spectrogram. Indexes, sidebar, theory/guide cross-links (~40 edits in 19 files) and the llms.txt generator PAGES list follow the moves; the four extracted topics now survive into llms-full.txt instead of dropping out. * docs: Spanish grammar fixes in the split guides - 'función de conveniencia' instead of the false friend 'comodidad' for convenience function (Gemini) - plural agreement 'estrategias basadas' at the two flagged sites (Gemini); the remaining 'basada' occurrences are correct singular agreements ('medición basada en tareas', 'la estrategia basada...') * docs: address second-round review on the splits - flanking_path() gains its own parameter table (with the kij_min Formula E.4 floor contract) in the building guide, all three surfaces (CodeRabbit) - the flanking figure snippet explicitly annotates its reuse of paths/ res from the snippet above; the speech-transmission figure snippet is now fully self-contained (imports + fs) on all surfaces (CodeRabbit) - ISO 10140-3 joins the laboratory standards footer (CodeRabbit) - the Speech Intelligibility guide joins llms.txt (regenerated) and the root README table (CodeRabbit)

2 weeks ago

speech-transmission.md

Audit pass 6: split the three overloaded guides (#115) * docs: split the three overloaded guides Audit batch 6 - reorganization with full content preservation (verified line-by-line against HEAD across the three surfaces): - room-acoustics (1096 lines) keeps ISO 18233 + ISO 3382-1/2/3 + ISO 354 measurement; the building half (ISO 16283 + ISO 717, ISO 10140, EN 12354-1/2, ISO 12999-1) moves to a new docs/building-acoustics.md built from the site's existing split, resolving the repo/site asymmetry. The flanking figure is reunited with its <details> code and flanking_path is introduced before it is referenced (audit fixes), on all three surfaces. - psychoacoustics extracts STI/STIPA to speech-transmission.md (paralleling speech-intelligibility.md) with STI-vs-SII disambiguation boxes on the three pages involved; ISO 226 moves into psychoacoustics where its perception content belongs, fixing its stale 'upcoming feature' sentence. - levels extracts occupational-exposure.md (ISO 9612) and tone-prominence.md (ECMA-418-1), keeping Leq/LN/peak/SEL/Lden and the spectrogram. Indexes, sidebar, theory/guide cross-links (~40 edits in 19 files) and the llms.txt generator PAGES list follow the moves; the four extracted topics now survive into llms-full.txt instead of dropping out. * docs: Spanish grammar fixes in the split guides - 'función de conveniencia' instead of the false friend 'comodidad' for convenience function (Gemini) - plural agreement 'estrategias basadas' at the two flagged sites (Gemini); the remaining 'basada' occurrences are correct singular agreements ('medición basada en tareas', 'la estrategia basada...') * docs: address second-round review on the splits - flanking_path() gains its own parameter table (with the kij_min Formula E.4 floor contract) in the building guide, all three surfaces (CodeRabbit) - the flanking figure snippet explicitly annotates its reuse of paths/ res from the snippet above; the speech-transmission figure snippet is now fully self-contained (imports + fs) on all surfaces (CodeRabbit) - ISO 10140-3 joins the laboratory standards footer (CodeRabbit) - the Speech Intelligibility guide joins llms.txt (regenerated) and the root README table (CodeRabbit)

2 weeks ago

surface-scattering.md

Audit pass 4c: final identifier sweep against the naming convention (#113) * refactor: final identifier sweep against the naming convention Audit batch 4c — the remaining non-conforming identifiers, closing the library-wide rename batch: - public constants drop the unit suffix (units belong in docstrings): OCTAVE_BANDS, THIRD_OCTAVE_BANDS (absorption_rating) and BASE_PLATE_BANDS (scattering_diffusion), with PEP 562 __getattr__ shims in the home modules and at the package root; plain import stays warning-free (verified with -W error) - sii.BAND_CENTRES -> BAND_CENTERS (American spelling, module shim); the private road_absorption centres constant renames directly - ExposureWarning -> OccupationalExposureWarning; the module __getattr__ returns the same class object so isinstance/except and warning filters via the old name keep matching - multiple_shock_vibration reuses hearing.SEXES instead of a private duplicate - tests/reference_data.py families gain their standard designations (ANSIS3_5_*, ANSIS12_2_*, NTACOU112_*, ISO7029_*, ISO389_7_*) - misleading test files renamed: test_parametrized_signals.py (it never tested parametric_filters) and test_loudness_contours.py (1:1 with its module); scripts/gen_llms.py -> generate_llms.py (workflow and Makefile updated) - conformance internals catch up (_chk_impulse_*) and an internal use of the deprecated expanded_uncertainty alias is migrated Flagged and deliberately left: REFERENCE_DURATION_S (the mixed-units carve-out applies - seconds and hours coexist in the exposure API) and the private British 'unfavourable' constants (ISO 717/11654 normative wording; private tables are named after the standard). Six new alias tests (root and module access, class identity, the AttributeError path). * test: anchor the renamed band tables value-by-value The tests around the renamed constants asserted lengths or spot values; they now pin every element (nominal one-third-octave and base-plate bands, the SII band centers, and the per-impulse Formula 1 values), verified against the code, so an accidental table edit cannot pass (Gemini).

2 weeks ago

Audit pass 6: split the three overloaded guides (#115) * docs: split the three overloaded guides Audit batch 6 - reorganization with full content preservation (verified line-by-line against HEAD across the three surfaces): - room-acoustics (1096 lines) keeps ISO 18233 + ISO 3382-1/2/3 + ISO 354 measurement; the building half (ISO 16283 + ISO 717, ISO 10140, EN 12354-1/2, ISO 12999-1) moves to a new docs/building-acoustics.md built from the site's existing split, resolving the repo/site asymmetry. The flanking figure is reunited with its <details> code and flanking_path is introduced before it is referenced (audit fixes), on all three surfaces. - psychoacoustics extracts STI/STIPA to speech-transmission.md (paralleling speech-intelligibility.md) with STI-vs-SII disambiguation boxes on the three pages involved; ISO 226 moves into psychoacoustics where its perception content belongs, fixing its stale 'upcoming feature' sentence. - levels extracts occupational-exposure.md (ISO 9612) and tone-prominence.md (ECMA-418-1), keeping Leq/LN/peak/SEL/Lden and the spectrogram. Indexes, sidebar, theory/guide cross-links (~40 edits in 19 files) and the llms.txt generator PAGES list follow the moves; the four extracted topics now survive into llms-full.txt instead of dropping out. * docs: Spanish grammar fixes in the split guides - 'función de conveniencia' instead of the false friend 'comodidad' for convenience function (Gemini) - plural agreement 'estrategias basadas' at the two flagged sites (Gemini); the remaining 'basada' occurrences are correct singular agreements ('medición basada en tareas', 'la estrategia basada...') * docs: address second-round review on the splits - flanking_path() gains its own parameter table (with the kij_min Formula E.4 floor contract) in the building guide, all three surfaces (CodeRabbit) - the flanking figure snippet explicitly annotates its reuse of paths/ res from the snippet above; the speech-transmission figure snippet is now fully self-contained (imports + fs) on all surfaces (CodeRabbit) - ISO 10140-3 joins the laboratory standards footer (CodeRabbit) - the Speech Intelligibility guide joins llms.txt (regenerated) and the root README table (CodeRabbit)

2 weeks ago

time-weighting.md

Docs usability: measurement-role snippet clarity, one-line result plots, responsive figures (#86) * fix: responsive figure sizing — full-width on mobile, 92% plots on desktop (plan 16 T4) Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * docs: snippet clarity wave — recording/excitation convention (plan 16 T1) Apply the recording/excitation naming convention from the P16 audit across the calibration, intensity, block-processing, time-weighting, levels, weighting and room-acoustics guides (docs/ + EN guides + ES guides). - calibration: ref_signal->calibrator_recording, signal->recording (J1 cascade) - intensity: probe-recording synth + swap-in disclosure on p1/p2 - block-processing / time-weighting: audio_blocks provenance comments - levels / time-weighting / weighting: signal->recording, provenance upgraded to convention - room-acoustics: play/record framing on sweep/recorded; synthetic-IR stand-in note EN docs/guides kept code-identical; ES mirrored with UNE wording. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * feat: one-line canonical plots on result objects (plan 16 T2) Add a thin plot(ax=None, **kwargs) method to each result dataclass that renders the essence of its guide's canonical figure in one line, following the sklearn/statsmodels/librosa pattern. matplotlib stays a soft dependency: importing phonometry and computing works without it; .plot() raises a clear ImportError with install guidance. Rendering lives in a new lazy _plotting module; dataclass methods are thin delegates. Covers ZwickerLoudness, STIResult, WeightedRatingResult/ImpactRatingResult, RoomAcousticsResult, SoundPowerResult/ReverberationSoundPowerResult/ SoundPowerIntensityResult, IntensityResult and a new frozen DecayCurve (returned by decay_curve, tuple-unpackable for backward compat). Rating results gain band_centers/measured/shifted_reference fields for the figure. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * fix: plot kwargs forwarding, deterministic invalid-band test, octave-impact annotation - _plot_rating now accepts **kwargs and forwards to the measured curve, so result.plot(linewidth=2) no longer raises TypeError; parametrized test covers every public .plot() forwarding a benign kwarg to its primary artist. - Replace skip-if-all-valid room-acoustics invalid-band test with a directly constructed RoomAcousticsResult (500 Hz band flagged invalid); assert exactly the flagged bars are hatched and greyed. - plot_impact_rating keeps the shifted-reference curve normatively honest (ref - shift) and marks/annotates the 500 Hz read value with the ISO 717-2 Clause 4.3.2 -5 dB octave rule instead of distorting the curve. - Move _bar_width next to its only consumer, plot_intensity. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * docs: .plot() one-liners and figure-code collapsibles (plan 16 T3) Add one-line res.plot() mentions to every guide section whose result type gained .plot() in T2, and figure-code collapsibles (both the one-liner and the manual matplotlib path) under the five .plot()-backed data figures. Document .plot() availability and the DecayCurve return type in the API reference and CHANGELOG. EN docs + EN/ES site; llms-full.txt regenerated. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * docs: collapsibles for STI-vs-T60 and open-plan figures Controller follow-up to plan 16 T3: the two figures are reproducible with public API only. STI-vs-T60 sweeps sti_from_impulse_response over synthetic exponential IRs at a 10-point T60 grid; the open-plan collapsible rebuilds the D2,S regression and rD/rP crossings from the OpenPlanResult fields. EN docs + EN/ES site; executed on Agg; llms-full.txt regenerated. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * docs: final-review polish — result-field docs, comment hygiene, naming Document band_centers/measured/shifted_reference on WeightedRatingResult and ImpactRatingResult (CHANGELOG + EN/ES API tables), strip internal plan tags from theme-images.css and test_result_plots.py, note that [plot] also powers result .plot() methods, tighten the plot_zwicker_loudness docstring to say the two-panel layout only occurs when ax is None, sentence-case the intensity provenance comments, and rename the shadowed impact rating var to res_imp on the room-acoustics pages. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * fix: PR 86 review round 1 — log-axis bars, style kwargs overrides, snippet physics and notation Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf

2 weeks ago

tone-prominence.md

Audit pass 6: split the three overloaded guides (#115) * docs: split the three overloaded guides Audit batch 6 - reorganization with full content preservation (verified line-by-line against HEAD across the three surfaces): - room-acoustics (1096 lines) keeps ISO 18233 + ISO 3382-1/2/3 + ISO 354 measurement; the building half (ISO 16283 + ISO 717, ISO 10140, EN 12354-1/2, ISO 12999-1) moves to a new docs/building-acoustics.md built from the site's existing split, resolving the repo/site asymmetry. The flanking figure is reunited with its <details> code and flanking_path is introduced before it is referenced (audit fixes), on all three surfaces. - psychoacoustics extracts STI/STIPA to speech-transmission.md (paralleling speech-intelligibility.md) with STI-vs-SII disambiguation boxes on the three pages involved; ISO 226 moves into psychoacoustics where its perception content belongs, fixing its stale 'upcoming feature' sentence. - levels extracts occupational-exposure.md (ISO 9612) and tone-prominence.md (ECMA-418-1), keeping Leq/LN/peak/SEL/Lden and the spectrogram. Indexes, sidebar, theory/guide cross-links (~40 edits in 19 files) and the llms.txt generator PAGES list follow the moves; the four extracted topics now survive into llms-full.txt instead of dropping out. * docs: Spanish grammar fixes in the split guides - 'función de conveniencia' instead of the false friend 'comodidad' for convenience function (Gemini) - plural agreement 'estrategias basadas' at the two flagged sites (Gemini); the remaining 'basada' occurrences are correct singular agreements ('medición basada en tareas', 'la estrategia basada...') * docs: address second-round review on the splits - flanking_path() gains its own parameter table (with the kij_min Formula E.4 floor contract) in the building guide, all three surfaces (CodeRabbit) - the flanking figure snippet explicitly annotates its reuse of paths/ res from the snippet above; the speech-transmission figure snippet is now fully self-contained (imports + fs) on all surfaces (CodeRabbit) - ISO 10140-3 joins the laboratory standards footer (CodeRabbit) - the Speech Intelligibility guide joins llms.txt (regenerated) and the root README table (CodeRabbit)

2 weeks ago

Docs usability: measurement-role snippet clarity, one-line result plots, responsive figures (#86) * fix: responsive figure sizing — full-width on mobile, 92% plots on desktop (plan 16 T4) Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * docs: snippet clarity wave — recording/excitation convention (plan 16 T1) Apply the recording/excitation naming convention from the P16 audit across the calibration, intensity, block-processing, time-weighting, levels, weighting and room-acoustics guides (docs/ + EN guides + ES guides). - calibration: ref_signal->calibrator_recording, signal->recording (J1 cascade) - intensity: probe-recording synth + swap-in disclosure on p1/p2 - block-processing / time-weighting: audio_blocks provenance comments - levels / time-weighting / weighting: signal->recording, provenance upgraded to convention - room-acoustics: play/record framing on sweep/recorded; synthetic-IR stand-in note EN docs/guides kept code-identical; ES mirrored with UNE wording. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * feat: one-line canonical plots on result objects (plan 16 T2) Add a thin plot(ax=None, **kwargs) method to each result dataclass that renders the essence of its guide's canonical figure in one line, following the sklearn/statsmodels/librosa pattern. matplotlib stays a soft dependency: importing phonometry and computing works without it; .plot() raises a clear ImportError with install guidance. Rendering lives in a new lazy _plotting module; dataclass methods are thin delegates. Covers ZwickerLoudness, STIResult, WeightedRatingResult/ImpactRatingResult, RoomAcousticsResult, SoundPowerResult/ReverberationSoundPowerResult/ SoundPowerIntensityResult, IntensityResult and a new frozen DecayCurve (returned by decay_curve, tuple-unpackable for backward compat). Rating results gain band_centers/measured/shifted_reference fields for the figure. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * fix: plot kwargs forwarding, deterministic invalid-band test, octave-impact annotation - _plot_rating now accepts **kwargs and forwards to the measured curve, so result.plot(linewidth=2) no longer raises TypeError; parametrized test covers every public .plot() forwarding a benign kwarg to its primary artist. - Replace skip-if-all-valid room-acoustics invalid-band test with a directly constructed RoomAcousticsResult (500 Hz band flagged invalid); assert exactly the flagged bars are hatched and greyed. - plot_impact_rating keeps the shifted-reference curve normatively honest (ref - shift) and marks/annotates the 500 Hz read value with the ISO 717-2 Clause 4.3.2 -5 dB octave rule instead of distorting the curve. - Move _bar_width next to its only consumer, plot_intensity. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * docs: .plot() one-liners and figure-code collapsibles (plan 16 T3) Add one-line res.plot() mentions to every guide section whose result type gained .plot() in T2, and figure-code collapsibles (both the one-liner and the manual matplotlib path) under the five .plot()-backed data figures. Document .plot() availability and the DecayCurve return type in the API reference and CHANGELOG. EN docs + EN/ES site; llms-full.txt regenerated. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * docs: collapsibles for STI-vs-T60 and open-plan figures Controller follow-up to plan 16 T3: the two figures are reproducible with public API only. STI-vs-T60 sweeps sti_from_impulse_response over synthetic exponential IRs at a 10-point T60 grid; the open-plan collapsible rebuilds the D2,S regression and rD/rP crossings from the OpenPlanResult fields. EN docs + EN/ES site; executed on Agg; llms-full.txt regenerated. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * docs: final-review polish — result-field docs, comment hygiene, naming Document band_centers/measured/shifted_reference on WeightedRatingResult and ImpactRatingResult (CHANGELOG + EN/ES API tables), strip internal plan tags from theme-images.css and test_result_plots.py, note that [plot] also powers result .plot() methods, tighten the plot_zwicker_loudness docstring to say the two-panel layout only occurs when ax is None, sentence-case the intensity provenance comments, and rename the shadowed impact rating var to res_imp on the room-acoustics pages. Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf * fix: PR 86 review round 1 — log-axis bars, style kwargs overrides, snippet physics and notation Claude-Session: https://claude.ai/code/session_013kkVt3nxi9svp1an28uHxf

2 weeks ago

why-phonometry.md

Audit pass 4c: final identifier sweep against the naming convention (#113) * refactor: final identifier sweep against the naming convention Audit batch 4c — the remaining non-conforming identifiers, closing the library-wide rename batch: - public constants drop the unit suffix (units belong in docstrings): OCTAVE_BANDS, THIRD_OCTAVE_BANDS (absorption_rating) and BASE_PLATE_BANDS (scattering_diffusion), with PEP 562 __getattr__ shims in the home modules and at the package root; plain import stays warning-free (verified with -W error) - sii.BAND_CENTRES -> BAND_CENTERS (American spelling, module shim); the private road_absorption centres constant renames directly - ExposureWarning -> OccupationalExposureWarning; the module __getattr__ returns the same class object so isinstance/except and warning filters via the old name keep matching - multiple_shock_vibration reuses hearing.SEXES instead of a private duplicate - tests/reference_data.py families gain their standard designations (ANSIS3_5_*, ANSIS12_2_*, NTACOU112_*, ISO7029_*, ISO389_7_*) - misleading test files renamed: test_parametrized_signals.py (it never tested parametric_filters) and test_loudness_contours.py (1:1 with its module); scripts/gen_llms.py -> generate_llms.py (workflow and Makefile updated) - conformance internals catch up (_chk_impulse_*) and an internal use of the deprecated expanded_uncertainty alias is migrated Flagged and deliberately left: REFERENCE_DURATION_S (the mixed-units carve-out applies - seconds and hours coexist in the exposure API) and the private British 'unfavourable' constants (ISO 717/11654 normative wording; private tables are named after the standard). Six new alias tests (root and module access, class identity, the AttributeError path). * test: anchor the renamed band tables value-by-value The tests around the renamed constants asserted lengths or spot values; they now pin every element (nominal one-third-octave and base-plate bands, the SII band centers, and the per-impulse Formula 1 values), verified against the code, so an accidental table edit cannot pass (Gemini).

2 weeks ago

README.md

phonometry Documentation#

Full documentation for phonometry. Also available as a website: https://jmrplens.github.io/phonometry/

Guides#

Getting Started — installation and first analysis
Filter Banks — architectures, responses, band decomposition
Frequency Weighting — A, C, Z curves
Time Weighting — Fast, Slow, Impulse ballistics
Integrated & Statistical Levels — Leq, LAeq, L10/L50/L90, LCpeak/SEL, noise dose (IEC 61252), Lden and rating levels (ISO 1996-1), octave spectrogram
Occupational noise exposure — the ISO 9612 task-based, job-based and full-day measurement strategies and the Annex C uncertainty budget behind every LEX,8h report
Prominent discrete tones — the ECMA-418-1 tone-to-noise and prominence ratios that decide whether a discrete tone is prominent and justify tonal rating adjustments
Psychoacoustics — Zwicker, Moore-Glasberg and Sottek loudness, sharpness, equal-loudness contours (ISO 226), tonality and roughness
Speech Transmission Index — how much of the speech envelope a room or sound system preserves: the IEC 60268-16 modulation transfer function, indirect method and direct STIPA measurement
Speech Intelligibility Index — the ANSI S3.5-1997 one-third-octave-band SII: band-importance weighting (Table 3), self-speech and upward spread of masking, band audibility, and the index in noise and hearing loss
Room-noise criteria — the ANSI/ASA S12.2-2019 room-noise ratings: the NC tangency method (Table 1) and the RC Mark II rating with its rumble/hiss/neutral spectral tag (Annex D)
Hearing threshold — the age-related hearing threshold distribution (ISO 7029:2017) and the free-field/diffuse-field reference threshold of hearing (ISO 389-7:2006)
Noise-induced hearing loss — the ISO 1999:2013 noise-induced permanent threshold shift (NIPTS) and its population distribution, and the combination with age into the hearing threshold level associated with age and noise (HTLAN)
Impulsive-sound prominence — the NT ACOU 112:2002 predicted prominence of impulsive sounds (onset rate and level difference) and the graduated adjustment KI added to LAeq
Measurement uncertainty — the GUM law of propagation of uncertainty and the Monte Carlo method (ISO/IEC Guide 98-3:2008 and Supplement 1): combined and expanded uncertainty, Welch–Satterthwaite effective degrees of freedom, and probabilistically symmetric coverage intervals
Sound Intensity (p-p) — two-microphone intensity and field indicators
Room Acoustics — impulse-response acquisition (ISO 18233), reverberation and room parameters (ISO 3382-1/2), open-plan speech metrics (ISO 3382-3), reverberation-room sound absorption (ISO 354)
Building Acoustics — field airborne/impact/façade insulation and weighted ratings (ISO 16283-1/2/3, ISO 717-1/2), laboratory characterisation (ISO 10140), flanking-transmission prediction (EN 12354-1/2), measurement uncertainty (ISO 12999-1)
Sound absorption in enclosed spaces — the EN 12354-6:2003 prediction of a room's total equivalent absorption area and reverberation time from its surfaces and objects (Clause 4)
Outdoor Sound Propagation — atmospheric absorption α(f) (ISO 9613-1) and the ISO 9613-2 general method: divergence, atmospheric absorption, ground effect and barrier screening
Sound Power — sound power level by enveloping surface (ISO 3744/3746), reverberation room (ISO 3741), intensity scanning (ISO 9614-2), and the precision grades in an anechoic room (ISO 3745) and by precision intensity scanning (ISO 9614-3)
Acoustic Materials — sound-absorption rating α_w and classes (ISO 11654), airflow resistance static and alternating methods (ISO 9053-1/-2), and impedance-tube measurement of absorption, surface impedance and transmission loss (ISO 10534-1/-2, ASTM E2611)
Surface Scattering, Diffusion and In-situ Absorption — random-incidence scattering (ISO 17497-1), free-field diffusion coefficient (ISO 17497-2), and in-situ road-surface absorption by the extended-surface subtraction technique (ISO 13472-1) and the spot method (ISO 13472-2)
Human Vibration — whole-body and hand-arm frequency weightings (ISO 8041-1), weighted r.m.s. acceleration, running r.m.s./MTVV/VDV and crest factor (ISO 2631-1), vibration in buildings (ISO 2631-2), vibration total value and daily exposure A(8) (ISO 5349-1/-2), and the exposure action/limit values of Directive 2002/44/EC
Multiple-shock whole-body vibration — the ISO 2631-5:2018 spinal-response model: the seat-to-spine transfer function, the acceleration and daily dose from the response peaks (Clause 5), and the compressive stress, stress variable R and Weibull probability of lumbar injury (Annex C)
Calibration and dBFS — physical SPL and digital analysis
Block Processing — stateful real-time workflows
Multichannel — vectorized multichannel analysis

Reference#

API Reference — every public function and class
Theory — standards, math and design decisions
Why phonometry — IEC compliance vs other libraries

Development#

Run the test suite with pytest tests/, the full quality gate with make check (ruff + mypy + bandit + tests), and regenerate the documentation images with make graphs. See CONTRIBUTING.md.