Ir al contenido

API Reference

Esta página aún no está disponible en tu idioma.

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 metrology, underwater
spl, freq = metrology.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.
metrology.coreCore processing logic and FilterBank class for phonometry.
metrology.parametric_filtersWeighting filters (A, B, C, D, G, AU, Z) and time weighting utilities.
metrology.equalizerParametric equalizer biquads per the RBJ Audio EQ Cookbook.
metrology.frequenciesFrequency calculation logic according to ANSI/IEC standards.
metrology.complianceIEC 61260-1:2014 filter and IEC 61672-1:2013 weighting class verification.
ModuleSummary
metrology.levelsIntegrated and statistical sound levels (Leq, LAeq, LN percentiles).
metrology.calibrationCalibration utilities for mapping digital signals to physical SPL levels.
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.sharpnessSharpness per DIN 45692:2009-08.
psychoacoustics.roughness_ecmaPsychoacoustic roughness per ECMA-418-2:2025 (4th ed., Sottek Hearing Model).
psychoacoustics.tonalityProminent discrete tone assessment per ECMA-418-1:2024 (3rd edition).
psychoacoustics.tonality_ecmaPsychoacoustic tonality per ECMA-418-2:2025 (4th ed., Sottek Hearing Model).
psychoacoustics.tone_audibilityObjective audibility of tones in noise — engineering method (ISO/PAS 20065:2016).
psychoacoustics.fluctuation_strengthFluctuation strength after Fastl & Zwicker / Osses et al.
psychoacoustics.fluctuation_strength_ecmaPsychoacoustic fluctuation strength per ECMA-418-2:2025 (4th ed., Clause 9).
psychoacoustics.psychoacoustic_annoyancePsychoacoustic annoyance (PA) after Fastl & Zwicker.
ModuleSummary
hearing.stiSpeech Transmission Index (STI) per IEC 60268-16:2020 (Edition 5).
hearing.siiSpeech Intelligibility Index (SII) per ANSI S3.5-1997 (R2017).
hearing.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.room_acousticsRoom acoustic parameters from impulse responses per ISO 3382-1:2009 (performance spaces) and ISO 3382-2:2008 (ordinary rooms).
room.room_irImpulse-response acquisition per BS EN ISO 18233:2006.
room.room_noiseRoom-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.
ModuleSummary
building.insulationField airborne sound insulation (ISO 16283-1:2014) and impact sound insulation (ISO 16283-2), with single-number weighted ratings and spectrum adaptation terms (ISO 717-1 airborne, ISO 717-2 impact).
building.panel_transmissionPredicted airborne sound reduction index of panels (Bies, Hansen & Howard 2017, Engineering Noise Control 5e, Section 7.2; Sharp 1973).
building.aperture_transmissionSound transmission through slits, holes and apertures (Hopkins 2007, Sound Insulation, Section 4.3.10; Gomperts 1964; Wilson & Soroka 1965).
building.lab_insulationLaboratory sound insulation of building elements (ISO 10140).
building.survey_insulationField survey method for sound insulation and service-equipment noise (ISO 10052:2021).
building.intensity_insulationSound insulation measured with sound intensity (ISO 15186).
building.flanking_transmissionLaboratory measurement of flanking sound transmission (ISO 10848:2006/2010).
building.facade_predictionFaçade sound insulation and outdoor radiation prediction (EN 12354-3/-4:2000).
building.building_predictionBuilding acoustic performance prediction (EN 12354-1/-2:2000).
building.building_uncertaintyMeasurement uncertainty in building acoustics (ISO 12999-1:2020).
building.floor_covering_improvementImpact-sound improvement of floor coverings on a small mock-up (ISO 16251-1:2014).
building.structure_borne_powerStructure-borne sound power of building equipment (EN 15657:2018; ISO 9611).
building.installed_structure_borneInstalled structure-borne sound from service equipment (EN 12354-5:2009).
ModuleSummary
materials.sound_absorptionSound absorption in a reverberation room: BS EN ISO 354:2003.
materials.absorption_ratingSingle-number rating of sound absorption (ISO 11654:1997).
materials.absorption_uncertaintyMeasurement uncertainty for sound absorption (ISO 12999-2:2020).
materials.airflow_resistanceAirflow resistance of porous materials: ISO 9053-1 and ISO 9053-2.
materials.dynamic_stiffnessDynamic stiffness of resilient materials under floating floors (EN 29052-1:1992).
materials.impedance_tubeImpedance-tube material characterisation.
materials.porous_absorberPorous-material models and multilayer absorber prediction.
materials.slow_sound_absorberSlow-sound slit panels loaded with Helmholtz resonators (perfect absorbers).
materials.scattering_diffusionRandom-incidence scattering and directional diffusion coefficients.
materials.diffuser_designFar-field polar response and diffusion coefficient predicted from a diffuser design.
materials.road_absorptionIn-situ sound absorption of road surfaces (ISO 13472-1 / ISO 13472-2).
ModuleSummary
vibration.mechanical_mobilityMechanical mobility and the frequency-response-function family (ISO 7626-1:2011).
vibration.point_mobilityPoint mobilities and impedances of infinite structures (Cremer, Heckl & Petersson 2005, Chapter 5, Table 5.1).
vibration.radiation_efficiencyRadiation efficiency of a plate in bending (Hopkins 2007, Sound Insulation, Section 2.9; Leppington et al.
vibration.junction_transmissionBending-wave transmission coefficients for rigid plate junctions (Hopkins 2007, Sound Insulation, Section 5.2.1.3; Cremer et al.
vibration.transfer_stiffnessDynamic transfer stiffness of resilient elements (ISO 10846-1/-2/-3).
vibration.human_vibrationHuman exposure to whole-body and hand-transmitted vibration.
vibration.multiple_shock_vibrationWhole-body vibration containing multiple shocks (ISO 2631-5:2018).
ModuleSummary
environmental.outdoor_propagationOutdoor sound propagation: ISO 9613-2:1996 general method of calculation.
environmental.ground_barriersSpherical-wave ground effect and advanced barrier diffraction.
environmental.atmospheric_refractionAtmospheric refraction: ray tracing and the parabolic equation (PE).
environmental.air_absorptionAtmospheric absorption of sound: ISO 9613-1:1993.
environmental.impulse_prominenceProminence of impulsive sounds and the LAeq adjustment (NT ACOU 112:2002).
environmental.impulsive_soundObjective prominence of impulsive sounds and the LAeq adjustment (ISO/PAS 1996-3:2022).
environmental.ratingEnvironmental noise descriptors per ISO 1996-1:2016.
environmental.measurementDetermination of environmental-noise sound pressure levels (ISO 1996-2:2017).
ModuleSummary
aircraft.aircraft_noiseAircraft 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).
environmental.wind_turbine_noiseWind-turbine acoustic noise (IEC 61400-11:2012+A1:2018).
ModuleSummary
underwater.acousticsUnderwater-acoustics reference levels (ISO 18405:2017).
underwater.propagationUnderwater sound propagation: transmission loss (closed-form).
underwater.sound_speedSpeed of sound in sea water (empirical equations).
underwater.sonar_equationThe sonar equation (passive and active), in decibels.
underwater.ocean_ambient_noiseOcean ambient-noise spectrum levels (Wenz framework).
underwater.seabed_reflectionPlane-wave reflection at the seabed (fluid-fluid Rayleigh model).
underwater.ship_radiated_noiseShip radiated noise and equivalent monopole source level (ISO 17208-1/-2).
underwater.ship_traffic_noisePredicted source-level spectrum of shipping traffic (semi-empirical models).
underwater.pile_driving_noiseRadiated underwater sound from percussive pile driving (ISO 18406:2017).
underwater.numerical_propagationNumerical 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_intensitySound power level of a noise source by sound-intensity scanning: ISO 9614-2:1996 (engineering, grade 2; survey/control, grade 3).
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:1994 and the ISO 9614-1:1993 field indicators.
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.distortionDistortion metrics for electroacoustic equipment (IEC 60268-3 / AES17).
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).
ModuleSummary
noise_control.silencersReactive silencers by the four-pole (transmission-matrix) method.
noise_control.hvacHVAC duct acoustics: end reflection, bends, plenums and flow-generated noise.
noise_control.enclosuresInsertion loss of a close or free-standing machine enclosure.
ModuleSummary
broadcast.program_loudnessProgramme loudness and true-peak level (ITU-R BS.1770-5, EBU R 128).
ModuleSummary
metrology.uncertaintyMeasurement uncertainty by the GUM and its Monte Carlo supplement.
metrology.random_dataRandom-data qualification: stationarity tests and Rice crossing statistics.
ModuleSummary
metrology.spectraCalibrated spectral-density estimation with statistical error analysis.
metrology.misoMultiple and partial coherence of a multiple-input/single-output system.
metrology.time_frequencyCalibrated time-frequency analysis: STFT spectrogram and zoom FFT.
metrology.signalsTest signals and sample-rate utilities.
metrology.phasePhase utilities: minimum phase, group delay and excess phase.
metrology.cepstrumCepstral analysis: real/power/complex cepstrum, liftering and echo detection.
metrology.synchronous_averageTime synchronous averaging (TSA) of a periodic waveform in noise.
metrology.inversionRegularized spectral inversion with frequency-dependent regularization.
ModuleSummary
simulation.fdtd2D acoustic finite-difference time-domain (FDTD) simulation.
ModuleSummary
metrology.correlationCorrelation analysis and time-delay estimation.
metrology.envelopeEnvelope and instantaneous phase via the Hilbert transform.