Skip to content

API Reference

The complete public API, one page per module. Import the domain subpackage and call through it:

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

from phonometry import filters, underwater
spl, freq = filters.octave_filter(x, fs)
snr = underwater.passive_sonar_equation(185.0, 60.0, 50.0)

Every documented name can also be imported directly from the top-level package (from phonometry import leq).

ModuleSummary
phonometryPackage-level names defined in phonometry/__init__.py itself.
filters.coreCore processing logic and FilterBank class for phonometry.
filters.weightingWeighting filters (A, B, C, D, G, AU, Z), time weighting utilities and the Linkwitz-Riley crossover.
filters.equalizerParametric equalizer biquads per the RBJ Audio EQ Cookbook.
filters.frequenciesFrequency calculation logic according to ANSI/IEC standards.
filters.complianceIEC 61260-1:2014 band-filter class verification.
filters.weighting_complianceIEC 61672-1:2013 frequency-weighting class verification.
ModuleSummary
signals.levelsIntegrated and statistical sound levels (Leq, LAeq, LN percentiles).
signals.spectraCalibrated spectral-density estimation with statistical error analysis.
signals.multitaperThomson multitaper spectral estimation (Percival & Walden 1993, Ch.
signals.windowsFigures of merit of a spectral-analysis taper (Harris 1978).
signals.misoMultiple and partial coherence of a multiple-input/single-output system.
signals.time_frequencyCalibrated time-frequency analysis: STFT spectrogram and zoom FFT.
signals.test_signalsTest signals and sample-rate utilities.
signals.phasePhase utilities: minimum phase, group delay and excess phase.
signals.cepstrumCepstral analysis: real/power/complex cepstrum, liftering and echo detection.
signals.synchronous_averageTime synchronous averaging (TSA) of a periodic waveform in noise.
signals.inversionRegularized spectral inversion with frequency-dependent regularization.
signals.correlationCorrelation analysis and time-delay estimation.
signals.envelopeEnvelope and instantaneous phase via the Hilbert transform.
ModuleSummary
metrology.calibrationCalibration utilities for mapping digital signals to physical SPL levels.
metrology.uncertaintyMeasurement uncertainty by the GUM and its Monte Carlo supplement.
metrology.data_qualificationRandom-data qualification: stationarity tests and Rice crossing statistics.
ModuleSummary
psychoacoustics.loudness.zwickerZwicker loudness for stationary and time-varying sounds per ISO 532-1:2017.
psychoacoustics.loudness.moore_glasbergStationary loudness per ISO 532-2:2017 (Moore-Glasberg method).
psychoacoustics.loudness.moore_glasberg_timeTime-varying loudness per ISO 532-3:2023 (Moore-Glasberg-Schlittenlacher).
psychoacoustics.loudness.ecmaPsychoacoustic loudness per ECMA-418-2:2025 (4th ed., Sottek Hearing Model).
psychoacoustics.loudness.contoursNormal equal-loudness-level contours per ISO 226:2023.
psychoacoustics.quality.sharpnessSharpness per DIN 45692:2009-08.
psychoacoustics.quality.roughness_ecmaPsychoacoustic roughness per ECMA-418-2:2025 (4th ed., Sottek Hearing Model).
psychoacoustics.quality.tonalityProminent discrete tone assessment per ECMA-418-1:2024 (3rd edition).
psychoacoustics.quality.tonality_ecmaPsychoacoustic tonality per ECMA-418-2:2025 (4th ed., Sottek Hearing Model).
psychoacoustics.quality.tone_audibilityObjective audibility of tones in noise — engineering method (ISO/PAS 20065:2016).
psychoacoustics.quality.fluctuation_strengthFluctuation strength after Fastl & Zwicker / Osses et al.
psychoacoustics.quality.fluctuation_strength_ecmaPsychoacoustic fluctuation strength per ECMA-418-2:2025 (4th ed., Clause 9).
psychoacoustics.quality.annoyancePsychoacoustic annoyance (PA) after Fastl & Zwicker.
psychoacoustics.erb_scaleThe ERB_N scale: auditory-filter bandwidth and the Cam frequency scale.
ModuleSummary
speech.stiSpeech Transmission Index (STI) per IEC 60268-16:2020 (Edition 5).
speech.siiSpeech Intelligibility Index (SII) per ANSI S3.5-1997 (R2017).
speech.objective_intelligibilityShort-Time Objective Intelligibility (STOI and ESTOI).
ModuleSummary
hearing.thresholdAge-related hearing threshold (ISO 7029:2017) and audiometric reference zero (ISO 389-7:2005).
hearing.noise_induced_hearing_lossEstimation of noise-induced hearing loss (ISO 1999:2013).
hearing.occupational_exposureOccupational noise exposure: measurement strategies and uncertainty (ISO 9612:2009).
ModuleSummary
room.acousticsRoom acoustic parameters from impulse responses per ISO 3382-1:2009 (performance spaces) and ISO 3382-2:2008 (ordinary rooms).
room.impulse_responseImpulse-response acquisition per BS EN ISO 18233:2006.
room.noise_criteriaRoom-noise rating curves per ANSI/ASA S12.2-2019.
room.open_planOpen-plan-office spatial metrics per ISO 3382-3:2012.
room.reverberation_predictionReverberation-time prediction from room geometry and absorption.
room.enclosed_space_absorptionSound absorption in enclosed spaces (EN 12354-6:2003).
room.image_sourceSynthetic room impulse response by the image-source method (rectangular room).
room.steady_fieldSteady-state sound field in a room: room constant, critical distance, level.
room.modesNormal modes of a rectangular room: frequencies, kinds, count and density.
room.crowd_noiseCrowd self-noise in a restaurant: the cocktail-party equilibrium.
ModuleSummary
building.measurement.insulationField measurement of sound insulation: airborne (ISO 16283-1:2014), impact (ISO 16283-2) and facade (ISO 16283-3:2016).
building.measurement.ratingsSingle-number weighted ratings of sound insulation and their spectrum adaptation terms (ISO 717-1 airborne, ISO 717-2 impact).
building.prediction.panel_transmissionPredicted airborne sound reduction index of panels (Bies, Hansen & Howard 2017, Engineering Noise Control 5e, Section 7.2; Sharp 1973).
building.prediction.masonry_cavity_wallWall ties in masonry cavity walls: the structural bridge across the cavity (Hopkins 2007, Sections 3.11.3.2 and 4.3.5.4.1).
building.measurement.heavy_impactHeavy and soft impact sources: rubber ball and bang machine (ISO 16283-2:2020 Annex A, ISO 10140-5:2010 Annex F, JIS A 1418-2:2019, ISO 717-2:2020 Annex D).
building.prediction.ceiling_plenumSuspended-ceiling plenum flanking path (Vigran 9.2.3 after Mechel 1980; ISO 140-9 / ISO 10848-2; ASTM E1414 / ASTM E413).
building.prediction.aperture_transmissionSound transmission through slits, holes and apertures (Hopkins 2007, Sound Insulation, Section 4.3.10; Gomperts 1964; Wilson & Soroka 1965).
building.measurement.lab_insulationLaboratory sound insulation of building elements (ISO 10140).
building.measurement.survey_insulationField survey method for sound insulation and service-equipment noise (ISO 10052:2021).
building.measurement.intensity_insulationSound insulation measured with sound intensity (ISO 15186).
building.measurement.flanking_transmissionLaboratory measurement of flanking sound transmission (ISO 10848:2006/2010).
building.prediction.facadeFaçade sound insulation and outdoor radiation prediction (EN 12354-3/-4:2000).
building.prediction.simplified_modelBuilding acoustic performance prediction (EN 12354-1/-2:2000).
building.prediction.detailed_modelDetailed per-band building prediction (EN/ISO 12354-1/-2:2017).
building.measurement.uncertaintyMeasurement uncertainty in building acoustics (ISO 12999-1:2020).
building.measurement.floor_covering_improvementImpact-sound improvement of floor coverings on a small mock-up (ISO 16251-1:2014).
building.prediction.resilient_layersPrediction of resilient-layer performance: tapping force, floor coverings, floating floors.
building.prediction.liningsPrediction of wall and ceiling linings: the weighted improvement an additional layer gives the element behind it (ISO 12354-1:2017 Annex D).
building.measurement.structure_borne_powerStructure-borne sound power of building equipment (EN 15657:2018; ISO 9611).
building.prediction.installed_structure_borneInstalled structure-borne sound from service equipment (EN 12354-5:2009).
building.regulation.spainSpanish building code CTE DB-HR: global indices and requirement checks.
ModuleSummary
materials.absorbers.sound_absorptionSound absorption in a reverberation room: BS EN ISO 354:2003.
materials.absorbers.ratingSingle-number rating of sound absorption (ISO 11654:1997).
materials.absorbers.uncertaintyMeasurement uncertainty for sound absorption (ISO 12999-2:2020).
materials.absorbers.airflow_resistanceAirflow resistance of porous materials: ISO 9053-1 and ISO 9053-2.
materials.resilient.dynamic_stiffnessDynamic stiffness of resilient materials under floating floors (EN 29052-1:1992).
materials.absorbers.impedance_tubeTwo-microphone transfer-function method in the impedance tube.
materials.absorbers.four_microphoneFour-microphone transfer-matrix method for the transmission of a specimen.
materials.absorbers.standing_waveStanding-wave-ratio method for normal-incidence absorption and impedance.
materials.absorbers.porousPorous-material models and resonant sheet impedances.
materials.absorbers.layeredDeclarative layer stacks and the transfer-matrix absorber solver.
materials.absorbers.biotBiot poroelastic layers: the three waves and the 6x6 transfer matrix.
materials.absorbers.slow_soundSlow-sound slit panels loaded with Helmholtz resonators (perfect absorbers).
materials.diffusers.scattering_diffusionDirectional and random-incidence diffusion coefficients in a free field.
materials.diffusers.reverberation_room_scatteringRandom-incidence scattering coefficient in a reverberation room.
materials.diffusers.designFar-field polar response and diffusion coefficient predicted from a diffuser design.
materials.diffusers.metadiffuserMetadiffusers: deep-subwavelength Schroeder-like sound diffusers.
materials.surfaces.road_absorptionIn-situ sound absorption of road surfaces (ISO 13472-1 / ISO 13472-2).
ModuleSummary
vibration.structural.mechanical_mobilityMechanical mobility and the frequency-response-function family (ISO 7626-1:2011).
vibration.structural.point_mobilityPoint mobilities and impedances of infinite structures (Cremer, Heckl & Petersson 2005, Chapter 5, Table 5.1).
vibration.structural.radiation_efficiencyRadiation efficiency of a plate in bending (Hopkins 2007, Sound Insulation, Section 2.9; Leppington et al.
vibration.structural.junction_transmissionBending-wave transmission coefficients for rigid plate junctions (Hopkins 2007, Sound Insulation, Section 5.2.1.3; Cremer et al.
vibration.structural.experimental_seaExperimental statistical energy analysis: coupling loss factors from measured energies (Norton & Karczub Ch.
vibration.machinery.diagnosticsKinematic fault frequencies of rotating machinery (Norton & Karczub Ch.
vibration.structural.transfer_stiffnessDynamic transfer stiffness of resilient elements (ISO 10846-1/-2/-3).
vibration.human.exposureHuman exposure to whole-body and hand-transmitted vibration.
vibration.human.multiple_shockWhole-body vibration containing multiple shocks (ISO 2631-5:2018).
ModuleSummary
environment.propagation.outdoor_propagationOutdoor sound propagation: ISO 9613-2:1996 general method of calculation.
environment.sources.cnossos_roadCNOSSOS-EU road traffic source emission (Directive 2002/49/EC Annex II, 2.2).
environment.propagation.ground_barriersSpherical-wave ground effect and advanced barrier diffraction.
environment.propagation.refractionAtmospheric refraction: ray tracing and the parabolic equation (PE).
environment.propagation.air_absorptionAtmospheric absorption of sound: ISO 9613-1:1993.
environment.sources.cnossos_railCNOSSOS-EU railway source emission (Directive 2002/49/EC Annex II, 2.3).
environment.assessment.impulsive_soundProminence of impulsive sounds and the LAeq adjustment (NT ACOU 112:2002, ISO/PAS 1996-3:2022).
environment.assessment.ratingEnvironmental noise descriptors per ISO 1996-1:2016.
environment.sources.wind_turbineWind-turbine acoustic noise (IEC 61400-11:2012+A1:2018).
environment.assessment.measurementDetermination of environmental-noise sound pressure levels (ISO 1996-2:2017).
environment.assessment.spainSpanish noise regulation: the corrected level LKeq (Real Decreto 1367/2007).
ModuleSummary
aircraft.certificationAircraft noise certification: Effective Perceived Noise Level (ICAO Annex 16).
aircraft.atmospheric_absorptionOne-third-octave-band atmospheric absorption for aircraft noise (SAE ARP 5534).
aircraft.airport_noiseNoise-Power-Distance (NPD) event-level interpolation (ECAC Doc 29).
aircraft.anp_fleetEASA ANP fleet database bridge for the ECAC Doc 29 airport-noise chain.
aircraft.rotorcraft_noiseRotorcraft noise by the hemisphere method (ECAC Doc 32 / NORAH2).
aircraft.rotorcraft_propagationRotorcraft propagation, ground effect and screening (ECAC Doc 32 / NORAH2).
aircraft.measurement_systemAircraft-noise measurement-system tolerances (IEC 61265:1995).
ModuleSummary
underwater.acousticsUnderwater-acoustics reference levels (ISO 18405:2017).
underwater.propagation.closed_formUnderwater sound propagation: propagation loss (closed-form).
underwater.propagation.weston_regimesWeston’s shallow-water propagation regimes (flux theory).
underwater.propagation.sound_speedSpeed of sound in sea water (empirical equations).
underwater.sonar_equationThe sonar equation (passive and active), in decibels.
underwater.sources.ambient_noiseOcean ambient-noise spectrum levels (Wenz framework).
underwater.propagation.seabed_reflectionPlane-wave reflection at the seabed (fluid-fluid Rayleigh model).
underwater.sources.ship_radiated_noiseShip radiated noise and equivalent monopole source level (ISO 17208-1/-2).
underwater.sources.ship_traffic_noisePredicted source-level spectrum of shipping traffic (semi-empirical models).
underwater.sources.pile_driving_noiseRadiated underwater sound from percussive pile driving (ISO 18406:2017).
underwater.bioacoustics.audiogramsMarine-mammal hearing thresholds (group audiograms and the orca audiogram).
underwater.bioacoustics.weightingRegulatory auditory weighting and exposure criteria for marine mammals.
underwater.propagation.numericalNumerical models of underwater sound propagation (range-independent ocean).
ModuleSummary
emission.sound_powerSound power level of a noise source from sound pressure measurements over an enveloping measurement surface: ISO 3744:2010 (engineering, accuracy grade 2) and ISO 3746:2010 (survey, accuracy grade 3).
emission.sound_power_anechoicSound power level of a noise source in an anechoic or hemi-anechoic room, from sound pressure measurements over an enveloping surface: ISO 3745:2012 (precision, accuracy grade 1).
emission.sound_power_intensitySound power level of a noise source by sound-intensity scanning: ISO 9614-2:1996 (engineering, grade 2; survey/control, grade 3) and ISO 9614-3:2002 (precision, grade 1).
emission.sound_power_reverberationSound power level of a noise source measured in a reverberation test room: ISO 3741:2010 (precision method, accuracy grade 1).
emission.intensityTwo-microphone (p-p) sound intensity per IEC 61043:1993 and the ISO 9614-1:1993 field indicators.
emission.intensity_complianceIEC 61043:1993 sound-intensity instrument class verification.
emission.vibration_sound_powerAirborne sound power from surface vibration (ISO/TS 7849-1/-2:2009).
emission.declarationISO 4871:1996 declaration of noise emission values of machinery and equipment.
ModuleSummary
electroacoustics.distortionHarmonic distortion of electroacoustic equipment (IEC 60268-3 / AES17).
electroacoustics.intermodulationIntermodulation distortion of audio equipment (IEC 60268-3 14.12.7-10).
electroacoustics.noise_measurementsNoise measurements of audio equipment (AES17-2015 6.4).
electroacoustics.frequency_responseFrequency-response and coherence estimators (Bendat & Piersol).
electroacoustics.swept_sineHarmonic-distortion separation with exponential sweeps (Farina / Novak).
electroacoustics.pistonRadiation of a rigid circular piston set in an infinite baffle.
electroacoustics.loudspeakerRated loudspeaker characteristics (IEC 60268-5).
electroacoustics.microphoneRated microphone characteristics (IEC 60268-4).
electroacoustics.sound_reinforcementGain before feedback of a sound-reinforcement system.
ModuleSummary
noise_control.silencersReactive silencers by the four-pole (transmission-matrix) method.
noise_control.hvacHVAC duct acoustics: fan power, duct losses, plenums and flow-generated noise.
noise_control.duct_pathEnd-to-end duct-borne noise calculation: fan to room, element by element.
noise_control.duct_modesHigher-order acoustic modes in ducts, with the mean-flow cut-on shift.
noise_control.enclosuresInsertion loss of a close or free-standing machine enclosure.
noise_control.room_to_roomRoom-to-room noise reduction: source room, partition, receiving room, criterion.
ModuleSummary
broadcast.program_loudnessProgramme loudness and true-peak level (ITU-R BS.1770-5, EBU R 128).
ModuleSummary
simulation.fdtd2D acoustic finite-difference time-domain (FDTD) simulation.
simulation.ntff2D near-to-far-field (NTFF) transformation over a closed contour.
simulation.elastic_fdtd2D elastic finite-difference time-domain (P-SV) simulation.

Published , updated