[READ-ONLY] Mirror of https://github.com/jmrplens/phonometry. Standards-conformant acoustics library for Python: measurement and metrology, docs.jmrp.io/phonometry
1.0 MB · 2,480 lines
Markdown
at main

← [Documentation index](../../README.md) # API Reference All core functionality lives in twenty-one subpackages, and every public name is reached through the one that owns it. The top-level `phonometry` package publishes those twenty-one and four names that belong to none of them: `Signal`, `ReportMetadata`, `PhonometryWarning` and `__version__`. > **Note.** This page is the curated quick table for the GitHub/PyPI audience: > one row per public name, kept complete by a CI gate > (`scripts/check_api_reference.py`). The full generated reference, with every > signature, parameter table and cross-link, lives on the site: > [phonometry API reference](https://docs.jmrp.io/phonometry/reference/api/). ## Namespaces The library is organized into twenty-one subpackages, and importing the namespace is the primary form used throughout the documentation: ```python from phonometry import aircraft contour = aircraft.noise_contour(..., x=..., y=...) # the shape of every call ``` | Subpackage | Scope | | :--- | :--- | | `phonometry.filters` | Octave and fractional-octave filter banks, frequency weightings and time weighting, parametric EQ, IEC 61260-1 and IEC 61672-1 class verification | | `phonometry.signals` | Levels (Leq, LAeq, percentiles), Welch and multitaper spectra, coherence, time-frequency, correlation, envelope, cepstrum, phase, synchronous averaging, test signals | | `phonometry.metrology` | Calibration, GUM uncertainty and Monte Carlo, data qualification (stationarity, trends, peak statistics), the ISO 1683 reference values | | `phonometry.fluids` | The state of the propagating medium: humid air from IEC 61094-2:2009 Annex F (CIPM-2007), with the conditions it was computed for and the domain its model states for itself | | `phonometry.solids` | The elastic constants of a solid and the three longitudinal wave speeds that follow from them, named apart by the shape the wave travels in (beam, plate, unbounded), with the inverse of each and the `h f_c` a materials table prints | | `phonometry.io` | Files. Measur…