Ir al contenido

metrology.reciprocity_coupler

La referencia de la API se publica en inglés en los dos idiomas: se genera a partir de los docstrings del código, que son su texto original.

Pressure calibration of laboratory standard microphones by reciprocity in a closed coupler (IEC 61094-2:2009).

Two microphones close the two ends of a small cavity. A current through the transmitter makes its diaphragm a source of short-circuit volume velocity , the gas in the cavity turns that into the pressure on the receiver, and the receiver turns the pressure into its open-circuit voltage, so (Formula (2))

The electrical transfer impedance is measured; this module computes the acoustic transfer impedance it is divided by, with every correction the standard gives, and solves the three products for the sensitivities with reciprocity_calibration.

Two couplers (5.4 and Annex C). A large-volume coupler, small against the wavelength, holds a pure compliance, and Formula (3) adds the admittances of the gas and of the two microphones,

with the coupler volume plus the two front cavities (7.3.3.1), and the bores that Figure C.2 draws between each microphone face and the cavity (dimension F of Table C.2), and the complex equivalent volume of each microphone. A plane-wave coupler, of the diameter of the diaphragms, is a transmission line of length between them (Formula (4)):

Heat conduction (5.5 and Annex A). In the large-volume coupler the walls draw heat from the compressed gas and the volume looks larger, by the complex factor of Formula (A.1),

where is Gerber’s temperature transfer function of a finite cylinder: temperature_transfer_function computes it either by the approximation (A.2) or by the full solution of the reference [A.1], which A.2 requires below 20 Hz unless the uncertainty component is increased instead, and which reproduces every entry of Table A.1 to its stated 0.000 01. In the plane-wave coupler the propagation coefficient and the wave impedance of Formulas (A.3) and (A.4) carry the losses at the cylindrical wall, and the admittance of Formula (A.5) those at the two diaphragms.

Capillary tubes (5.6 and Annex B). Tubes that equalise the static pressure shunt the cavity, and Formula (6) divides the transfer impedance by

with the input impedance of an open tube of Formulas (B.1) to (B.3), which capillary_tube_impedance computes and Tables B.1 and B.2 test.

The microphone (7.3.3 and Annex E). Its acoustic impedance is a lumped compliance, mass and resistance, written as an equivalent volume, a resonance frequency and a loss factor (ReciprocityMicrophone); its front cavity adds volume, length and, through the excess of its measured volume over the cylinder of its depth, a further terminating admittance (7.3.3.1).

The wave-motion corrections of Table C.3 for the air-filled large-volume coupler of LS1P microphones are large_volume_wave_motion_correction, the coupler dimensions of Tables C.1 and C.2 are IEC61094_2_TABLE_C1 and IEC61094_2_TABLE_C2, and coupler_parameter_uncertainty finds the uncertainty each coupler and microphone parameter contributes, by the one-at-a-time recalculation 7.5 describes.

The properties of the gas, , , , and , are those of humid air by Annex F (air) at the conditions of the calibration, or of any Fluid passed as gas: 7.3.2.1 allows the coupler to be filled with hydrogen or helium.

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

capillary_tube_impedance(
frequencies: NumericArrayLike,
*,
length_m: float,
radius_m: float,
gas: Fluid,
) -> CapillaryTubeImpedance

The acoustic input impedance of an open capillary tube (IEC 61094-2:2009 B.1).

Formulas (B.2) and (B.3) give the product and the quotient of the propagation coefficient and the wave impedance of an infinite tube of radius ,

with and ; each follows from their product and quotient on the branch with a positive real part, and Formula (B.1) gives . A tube blocked along its length by a wire has instead (B.1), which a coupler without a capillary stands for.

Tables B.1 and B.2 tabulate at the reference conditions for tubes 50 mm and 100 mm long and 0.1667 mm, 0.20 mm and 0.25 mm in radius; the first radius is 1/6 mm, which is what the printed values were computed with.

Parameters

Name Description
frequencies The frequencies, in Hz, increasing.
length_m , in m.
radius_m , in m.
gas The gas in the tube.

Returns: The CapillaryTubeImpedance.

Raises

Exception When
ValueError for a length or radius that is not positive, or frequencies that are not positive and increasing.
TypeError if length_m or radius_m is not a single number.
CapillaryTube(
*,
length_m: float,
radius_m: float,
n_tubes: int | np.integer[Any] = 1,
)

Identical open capillary tubes that equalise the static pressure of a coupler (IEC 61094-2:2009 5.6 and Annex B).

Attributes

Name Description
length_m , the length of each tube, in m.
radius_m , its radius, in m. B.1 notes the impedance goes as the fourth power of it, and that a flow calibration may be needed to know the effective radius of a tube that is not circular.
n_tubes , the number of identical tubes.
CapillaryTubeImpedance(
frequencies: NDArray[np.float64],
length_m: float,
radius_m: float,
propagation_coefficient_per_m: NDArray[np.complex128],
wave_impedance_pa_s_m3: NDArray[np.complex128],
)

The acoustic input impedance of an open capillary tube (IEC 61094-2:2009 Formulas (B.1) to (B.3)).

Attributes

Name Description
frequencies The frequencies, in Hz.
length_m , in m.
radius_m , in m.
propagation_coefficient_per_m , complex, in 1/m.
wave_impedance_pa_s_m3 , the wave impedance of an infinite tube, complex, in Pa·s/m³.

property

(Formula (B.1)), in Pa·s/m³.

CapillaryTubeImpedance.plot(
ax: Axes | None = None,
*,
language: Literal['en', 'es'] = 'en',
**kwargs: Any,
) -> Axes

Plot the real and imaginary parts of in GPa·s/m³, the unit of Tables B.1 and B.2.

Parameters

Name Description
ax Existing axes to draw on, or None to create a figure.
language Label language, "en" (default) or "es".
kwargs Forwarded to the real-part curve.

Returns: The axes. Requires matplotlib (the [plot] extra).

check_coupler(
frequencies: NumericArrayLike,
coupler: PlaneWaveCoupler | LargeVolumeCoupler,
microphones: Sequence[ReciprocityMicrophone],
*,
temperature_c: float,
static_pressure_pa: float,
relative_humidity_percent: float,
gas: Fluid | None = None,
heat_conduction_method: Literal['exact', 'approximation'] = 'exact',
) -> CouplerCheck

Do the coupler formulas of IEC 61094-2:2009 hold for this calibration?

For a plane-wave coupler, Formulas (A.3) and (A.4) “are valid for the frequency range given by ” (A.3), which is required at the lowest frequency; C.2 recommends a ratio of the distance between the diaphragms to the diameter of 0.5 to 0.75, reported but not required. For a large-volume coupler with the approximation (A.2), A.2 states its accuracy for and , which is required; below 20 Hz A.2 asks for the full solution or a larger uncertainty component, which is reported but not required. In air, the conditions are checked against the domain Annex F states for its equations (15 °C to 27 °C, 60 kPa to 110 kPa, 10 % to 90 %).

Parameters

Name Description
frequencies The frequencies, in Hz, increasing.
coupler The coupler.
microphones The microphones that close it, two or a triad of one type; the first two give the front cavities that add to the volume, surface and length.
temperature_c The temperature, in °C.
static_pressure_pa The static pressure, in Pa.
relative_humidity_percent The relative humidity, in %.
gas Another gas than air, or None.
heat_conduction_method The method the calibration uses for . One of "exact" or "approximation".

Returns: The CouplerCheck.

Raises

Exception When
ValueError for frequencies that are not positive and increasing, fewer than two microphones, or an unknown method.
TypeError if heat_conduction_method is not a text. relative_humidity_percent, static_pressure_pa or temperature_c are refused the same way when any is not one real number.
coupler_parameter_uncertainty(
frequencies: NumericArrayLike,
coupler: PlaneWaveCoupler | LargeVolumeCoupler,
microphones: Sequence[ReciprocityMicrophone],
uncertainties: CouplerInputUncertainties,
*,
temperature_c: float,
static_pressure_pa: float,
relative_humidity_percent: float,
microphone: int = 1,
gas: Fluid | None = None,
heat_conduction_method: Literal['exact', 'approximation'] = 'exact',
) -> CouplerParameterUncertainty

The uncertainty components of the acoustic transfer impedance, one parameter at a time (IEC 61094-2:2009 7.5).

“Due to the complexity of the final expression for the pressure sensitivity in Equation (7) the uncertainty analysis of the acoustic transfer impedance is usually performed by repeating a calculation while the various components are changed one at a time by their associated uncertainty. The difference to the result derived by the unchanged components is then used to determine the standard uncertainty related to the various components.” This is that: each parameter with a non-zero standard uncertainty is moved by it, the three transfer impedances of the triad recomputed, and the change of the sensitivity level of microphone by Formula (7), with the measured electrical transfer impedances held, is its component. A microphone parameter is moved for each of the three microphones in turn, as three independent quantities, and their changes combined in quadrature into the one row of Table 1; so are the length and the radius of the capillary tubes.

Parameters

Name Description
frequencies The frequencies, in Hz, increasing.
coupler The coupler, the same for the three pairs.
microphones The three microphones.
uncertainties The standard uncertainty of each input quantity, a CouplerInputUncertainties.
temperature_c The temperature, in °C.
static_pressure_pa The static pressure, in Pa.
relative_humidity_percent The relative humidity, in %.
microphone The microphone whose level is analysed, 1, 2 or 3 (Default: 1).
gas A Fluid for a coupler filled with a gas other than air (7.3.2.1), as in coupler_transfer_impedance; None (default) takes humid air by Annex F at the conditions. A given gas keeps its properties whatever the conditions, so a step in the static pressure, the temperature or the humidity could not move them with it, and an uncertainty on any of the three is refused.
heat_conduction_method The method for (Default: "exact"). One of "exact" or "approximation".

Returns: The CouplerParameterUncertainty, with a component for each parameter given a non-zero uncertainty.

Raises

Exception When
ValueError for other than three microphones, a microphone index that is not 1, 2 or 3, an uncertainty on the volume or surface of a plane-wave coupler (they follow from its length and diameter), one on capillary tubes the coupler does not have, or one on the static pressure, the temperature or the humidity of a coupler filled with a given gas.
TypeError if heat_conduction_method is not a text. relative_humidity_percent, static_pressure_pa or temperature_c are refused the same way when any is not one real number.
coupler_transfer_impedance(
frequencies: NumericArrayLike,
coupler: PlaneWaveCoupler | LargeVolumeCoupler,
transmitter: ReciprocityMicrophone,
receiver: ReciprocityMicrophone,
*,
temperature_c: float,
static_pressure_pa: float,
relative_humidity_percent: float,
gas: Fluid | None = None,
heat_conduction_method: Literal['exact', 'approximation'] = 'exact',
) -> CouplerTransferImpedance

The acoustic transfer impedance of a coupler closed by two microphones (IEC 61094-2:2009 5.4 to 5.6).

A LargeVolumeCoupler takes Formula (3): the gas of the coupler, the two bores of Figure C.2 and the two front cavities (7.3.3.1) as one compliance, its volume multiplied by of Formula (A.1) for the heat conduction, in parallel with the equivalent volumes of the two microphones. The surface the heat conduction sees is that of the coupler plus the wall of each bore and front cavity and any thread in it (7.3.2.2): the diaphragm takes the place of the port it closes (LargeVolumeCoupler.closed_volume_m3, LargeVolumeCoupler.closed_surface_m2).

A PlaneWaveCoupler takes Formula (4): a line of length , the coupler plus the two front-cavity depths, terminated at each end by the microphone’s acoustic impedance in parallel with the excess volume of its front cavity (7.3.3.1); the losses of Formulas (A.3) to (A.5) give , and the same line without them .

Both are then divided by of Formula (6) for the capillary tubes. The pair is reciprocal, so which microphone transmits does not change the result.

Parameters

Name Description
frequencies The frequencies, in Hz, increasing.
coupler The coupler.
transmitter Microphone (1).
receiver Microphone (2).
temperature_c The temperature of the gas, in °C.
static_pressure_pa The static pressure , in Pa.
relative_humidity_percent The relative humidity, in %.
gas A Fluid for a coupler filled with a gas other than air; None (default) takes humid air by Annex F at the three conditions.
heat_conduction_method "exact" (default) or "approximation" for in a large-volume coupler (temperature_transfer_function).

Returns: The CouplerTransferImpedance.

Raises

Exception When
TypeError for a coupler that is neither a PlaneWaveCoupler nor a LargeVolumeCoupler, a static_pressure_pa that is not one number, or a heat_conduction_method that is not a text.
ValueError for frequencies that are not positive and increasing, a static pressure that is not positive, or an unknown method.
CouplerCheck(
coupler: Literal['plane_wave', 'large_volume'],
length_to_diameter_ratio: float,
broadband_margin: float | None,
lowest_x: float | None,
lowest_frequency_hz: float,
*,
heat_conduction_method: Literal['exact', 'approximation'],
temperature_c: float,
static_pressure_pa: float,
relative_humidity_percent: float,
in_air: bool,
)

Whether the formulas of IEC 61094-2:2009 apply to a coupler at the frequencies and conditions of a calibration.

Built by check_coupler. The verdicts are read from the figures and the conditions the check holds, against the ranges the standard prints, so they are not fields.

Attributes

Name Description
coupler "plane_wave" or "large_volume".
length_to_diameter_ratio : for a plane-wave coupler the distance between the diaphragms, , over the diameter (C.2, 5.4), for a large-volume one the length of the cavity over its diameter (A.2).
broadband_margin For a plane-wave coupler, at the lowest frequency, which A.3 requires above 1 for Formulas (A.3) and (A.4); None otherwise.
lowest_x For a large-volume coupler, at the lowest frequency; None otherwise. It binds only the approximation.
lowest_frequency_hz The lowest frequency of the calibration, in Hz.
heat_conduction_method The method the calibration uses for . One of "exact" or "approximation".
temperature_c The temperature, in °C.
static_pressure_pa The static pressure, in Pa.
relative_humidity_percent The relative humidity, in %.
in_air Whether the coupler is filled with air, the medium Annex F states its domain for, rather than another gas.

property

For a large-volume coupler computed with Formula (A.2), whether A.2 states its accuracy.

and ; None with the full solution or for a plane-wave coupler.

property

Whether Formulas (A.3) and (A.4) hold at every frequency.

property

For air, whether the conditions are within the domain Annex F states for its equations.

15 °C to 27 °C, 60 kPa to 110 kPa and 10 % to 90 %, ends included; None for another gas.

property

For a large-volume coupler computed with Formula (A.2), whether a frequency is below 20 Hz.

A.2 then asks for the full solution “or the corresponding uncertainty component shall be increased accordingly”; None with the full solution or for a plane-wave coupler. Advisory: it does not enter passes, because the larger uncertainty is the caller’s to state.

property

The verdict: the formulas the calibration uses hold where it uses them.

CouplerCheck.plot(
ax: Axes | None = None,
*,
language: Literal['en', 'es'] = 'en',
**kwargs: Any,
) -> Axes

Plot each condition as its margin to the limit it is held to.

Parameters

Name Description
ax Existing axes to draw on, or None to create a figure.
language Label language, "en" (default) or "es".
kwargs Forwarded to barh.

Returns: The axes. Requires matplotlib (the [plot] extra).

property

For a plane-wave coupler, whether is within the 0.5 to 0.75 C.2 recommends.

None for a large-volume one. Advisory: it does not enter passes.

CouplerDimensions(
*,
microphone_diameter_mm: float,
front_cavity_diameter_mm: float,
coupler_diameter_mm: float,
front_cavity_depth_mm: float,
coupler_length_mm: float | None = None,
coupler_length_range_mm: tuple[float, float] | None = None,
port_length_mm: float | None = None,
tolerance_mm: float | None = None,
)

One column of IEC 61094-2:2009 Table C.1 or Table C.2, the nominal dimensions of a coupler for one type of laboratory standard microphone, in millimetres as printed.

Attributes

Name Description
microphone_diameter_mm ø A, the outer diameter of the microphone.
front_cavity_diameter_mm ø B.
coupler_diameter_mm ø C.
front_cavity_depth_mm D.
coupler_length_mm E, the nominal length (Table C.2), or None.
coupler_length_range_mm E as a range (Table C.1), or None.
port_length_mm F (Table C.2 only), the length of the bore Figure C.2 draws between each microphone face and the cavity, or None.
tolerance_mm The ± tolerance Table C.2 prints on C, E and F, or None.
CouplerInputUncertainties(
*,
u_coupler_length_m: float = 0.0,
u_coupler_diameter_m: float = 0.0,
u_coupler_volume_m3: float = 0.0,
u_coupler_surface_area_m2: float = 0.0,
u_capillary_length_m: float = 0.0,
u_capillary_radius_m: float = 0.0,
u_static_pressure_pa: float = 0.0,
u_temperature_k: float = 0.0,
u_relative_humidity_percent: float = 0.0,
u_front_cavity_depth_m: float = 0.0,
u_front_cavity_volume_m3: float = 0.0,
u_equivalent_volume_m3: float = 0.0,
u_resonance_frequency_hz: float = 0.0,
u_loss_factor: float = 0.0,
)

The standard uncertainty of each input quantity of the acoustic transfer impedance in a coupler: those Table 1 of IEC 61094-2:2009 lists under “Coupler properties” (7.3.2) and “Microphone parameters” (7.3.3) that coupler_parameter_uncertainty can move.

Each one left at zero contributes no component. A microphone parameter is the uncertainty of that parameter on each of the three microphones.

Parameters

Name Description
u_coupler_length_m Of the coupler length, in m.
u_coupler_diameter_m Of its diameter, in m.
u_coupler_volume_m3 Of the volume of a large-volume coupler, in m³.
u_coupler_surface_area_m2 Of its surface, in m².
u_capillary_length_m Of the length of the capillary tubes, in m.
u_capillary_radius_m Of their radius, in m.
u_static_pressure_pa Of the static pressure, in Pa.
u_temperature_k Of the temperature, in K.
u_relative_humidity_percent Of the relative humidity, in percentage points.
u_front_cavity_depth_m Of each front cavity depth, in m.
u_front_cavity_volume_m3 Of each front cavity volume, in m³.
u_equivalent_volume_m3 Of each equivalent volume, in m³.
u_resonance_frequency_hz Of each resonance frequency, in Hz.
u_loss_factor Of each loss factor.

Raises

Exception When
ValueError for an uncertainty that is negative or not finite.
CouplerParameterUncertainty(
frequencies: NDArray[np.float64],
component_uncertainties_db: Mapping[Literal['series_impedance', 'voltage_ratio', 'cross_talk', 'noise', 'distortion', 'frequency', 'receiver_ground_shield', 'transmitter_ground_shield', 'coupler_length', 'coupler_diameter', 'coupler_volume', 'coupler_surface_area', 'leakage', 'capillary_tube_dimensions', 'static_pressure', 'temperature', 'relative_humidity', 'front_cavity_depth', 'front_cavity_volume', 'equivalent_volume', 'resonance_frequency', 'loss_factor', 'diaphragm_compliance', 'diaphragm_mass', 'diaphragm_resistance', 'front_cavity_thread', 'polarizing_voltage', 'heat_conduction_theory', 'excess_volume', 'viscosity_losses', 'radial_wave_motion', 'rounding', 'repeatability', 'static_pressure_corrections', 'temperature_corrections'], NDArray[np.float64]],
microphone: int,
)

The standard uncertainty of a sensitivity level that each parameter of the acoustic transfer impedance contributes (IEC 61094-2:2009 7.5).

Built by coupler_parameter_uncertainty; ready to pass to reciprocity_uncertainty_budget.

Attributes

Name Description
frequencies The frequencies, in Hz.
component_uncertainties_db The component of each parameter, keyed by its name in IEC61094_2_TABLE_1, in dB at each frequency. Keyed by any of "series_impedance", "voltage_ratio", "cross_talk", "noise", "distortion", "frequency", "receiver_ground_shield", "transmitter_ground_shield", "coupler_length", "coupler_diameter", "coupler_volume", "coupler_surface_area", "leakage", "capillary_tube_dimensions", "static_pressure", "temperature", "relative_humidity", "front_cavity_depth", "front_cavity_volume", "equivalent_volume", "resonance_frequency", "loss_factor", "diaphragm_compliance", "diaphragm_mass", "diaphragm_resistance", "front_cavity_thread", "polarizing_voltage", "heat_conduction_theory", "excess_volume", "viscosity_losses", "radial_wave_motion", "rounding", "repeatability", "static_pressure_corrections" or "temperature_corrections".
microphone The microphone whose level they are for, 1, 2 or 3.
CouplerParameterUncertainty.plot(
ax: Axes | None = None,
*,
language: Literal['en', 'es'] = 'en',
**kwargs: Any,
) -> Axes

Plot each component against frequency.

Parameters

Name Description
ax Existing axes to draw on, or None to create a figure.
language Label language, "en" (default) or "es".
kwargs Forwarded to the first component’s curve.

Returns: The axes. Requires matplotlib (the [plot] extra).

CouplerTransferImpedance(
frequencies: NDArray[np.float64],
coupler: Literal['plane_wave', 'large_volume'],
adiabatic_impedance_pa_s_m3: NDArray[np.complex128],
heat_conducting_impedance_pa_s_m3: NDArray[np.complex128],
capillary_correction: NDArray[np.complex128],
heat_conduction: HeatConductionCorrection | None = None,
)

The acoustic transfer impedance of a coupler closed by two microphones, with its corrections (IEC 61094-2:2009 5.4 to 5.6).

Attributes

Name Description
frequencies The frequencies, in Hz.
coupler "plane_wave" or "large_volume".
adiabatic_impedance_pa_s_m3 , adiabatic and without losses (Formula (3) or (4)), in Pa·s/m³.
heat_conducting_impedance_pa_s_m3 , corrected for heat conduction (5.5): with in a large-volume coupler, with Formulas (A.3) to (A.5) in a plane-wave one, in Pa·s/m³.
capillary_correction of Formula (6), 1 without capillary tubes.
heat_conduction The HeatConductionCorrection of a large-volume coupler, None for a plane-wave one.

CouplerTransferImpedance.capillary_correction_db

Section titled “CouplerTransferImpedance.capillary_correction_db”

property

, the change of the tubes cause, in dB.

CouplerTransferImpedance.heat_conduction_correction

Section titled “CouplerTransferImpedance.heat_conduction_correction”

property

, in dB.

CouplerTransferImpedance.plot(
ax: Axes | None = None,
*,
language: Literal['en', 'es'] = 'en',
**kwargs: Any,
) -> Axes

Plot the heat-conduction and capillary corrections of the transfer impedance, in dB, against frequency.

Parameters

Name Description
ax Existing axes to draw on, or None to create a figure.
language Label language, "en" (default) or "es".
kwargs Forwarded to the heat-conduction curve.

Returns: The axes. Requires matplotlib (the [plot] extra).

CouplerTransferImpedance.transfer_impedance_pa_s_m3

Section titled “CouplerTransferImpedance.transfer_impedance_pa_s_m3”

property

, the impedance the electrical transfer impedance is divided by, in Pa·s/m³.

heat_conduction_correction(
frequencies: NumericArrayLike,
*,
volume_m3: float,
surface_area_m2: float,
length_to_diameter_ratio: float,
gas: Fluid,
method: Literal['exact', 'approximation'] = 'exact',
) -> HeatConductionCorrection

The heat-conduction correction of a closed cavity (IEC 61094-2:2009 5.5, A.2).

multiplies the geometrical volume in Formula (3). For a coupler closed by microphones, and the surface are those of the coupler together with the front cavities (7.3.2.2), which coupler_transfer_impedance assembles; is that of the coupler.

Parameters

Name Description
frequencies The frequencies, in Hz, increasing.
volume_m3 The total volume, in m³.
surface_area_m2 The total surface, in m².
length_to_diameter_ratio .
gas The gas: its thermal diffusivity and ratio of specific heats.
method "exact" (default) or "approximation" (temperature_transfer_function).

Returns: The HeatConductionCorrection.

Raises

Exception When
ValueError for a volume, surface or ratio that is not positive, or frequencies that are not positive and increasing.
TypeError if surface_area_m2 or volume_m3 is not a single number, or method is not a text.
HeatConductionCorrection(
frequencies: NDArray[np.float64],
length_to_diameter_ratio: float,
volume_to_surface_m: float,
x: NDArray[np.float64],
transfer_function: NDArray[np.complex128],
heat_capacity_ratio: float,
method: Literal['exact', 'approximation'],
)

The heat-conduction correction of a closed cavity at low frequencies (IEC 61094-2:2009 5.5 and A.2, Formula (A.1)).

Attributes

Name Description
frequencies The frequencies, in Hz.
length_to_diameter_ratio .
volume_to_surface_m , the volume to surface ratio, in m.
x at each frequency.
transfer_function at each frequency.
heat_capacity_ratio of the gas.
method "exact" or "approximation".

property

, the apparent increase of the volume, in dB.

HeatConductionCorrection.plot(
ax: Axes | None = None,
*,
language: Literal['en', 'es'] = 'en',
**kwargs: Any,
) -> Axes

Plot in dB and its phase against frequency.

Parameters

Name Description
ax Existing axes to draw on, or None to create a figure.
language Label language, "en" (default) or "es".
kwargs Forwarded to the modulus curve.

Returns: The axes. Requires matplotlib (the [plot] extra).

property

, the complex factor on the geometrical volume (Formula (A.1)).

Constant (mapping).

IEC61094_2_TABLE_C1 = {'LS1P': CouplerDimensions(microphone_diameter_mm=23.77, front_cavity_diameter_mm=18.6, coupler_diameter_mm=18.6, front_cavity_depth_mm=1.95, coupler_length_mm=None, coupler_length_range_mm=(3.5, 9.5), port_length_mm=None, tolerance_mm=None), 'LS2aP': CouplerDimensions(microphone_diameter_mm=13.2, front_cavity_diameter_mm=9.3, coupler_diameter_mm=9.3, front_cavity_depth_mm=0.5, coupler_length_mm=None, coupler_length_range_mm=(3.0, 7.0), port_length_mm=None, tolerance_mm=None), 'LS2bP': CouplerDimensions(microphone_diameter_mm=12.15, front_cavity_diameter_mm=9.8, coupler_diameter_mm=9.8, front_cavity_depth_mm=0.7, coupler_length_mm=None, coupler_length_range_mm=(3.5, 6.0), port_length_mm=None, tolerance_mm=None)}

Constant (mapping).

IEC61094_2_TABLE_C2 = {'LS1P': CouplerDimensions(microphone_diameter_mm=23.77, front_cavity_diameter_mm=18.6, coupler_diameter_mm=42.88, front_cavity_depth_mm=1.95, coupler_length_mm=12.55, coupler_length_range_mm=None, port_length_mm=0.8, tolerance_mm=0.03), 'LS2aP': CouplerDimensions(microphone_diameter_mm=13.2, front_cavity_diameter_mm=9.3, coupler_diameter_mm=18.3, front_cavity_depth_mm=0.5, coupler_length_mm=3.5, coupler_length_range_mm=None, port_length_mm=0.4, tolerance_mm=0.03), 'LS2bP': CouplerDimensions(microphone_diameter_mm=12.15, front_cavity_diameter_mm=9.8, coupler_diameter_mm=18.3, front_cavity_depth_mm=0.7, coupler_length_mm=3.5, coupler_length_range_mm=None, port_length_mm=0.4, tolerance_mm=0.03)}

Constant (mapping).

IEC61094_2_TABLE_C3 = {800.0: 0.0, 1000.0: -0.002, 1250.0: -0.013, 1600.0: -0.034, 2000.0: -0.06, 2500.0: -0.087}
large_volume_wave_motion_correction(
frequencies: NumericArrayLike,
*,
speed_of_sound_ratio: float = 1.0,
) -> WaveMotionCorrection

The wave-motion correction of the large-volume coupler used with LS1P microphones (IEC 61094-2:2009 C.3, Table C.3).

The correction is to be added to the pressure sensitivity level determined in the air-filled coupler of Table C.2, when it is not practical to determine it for the individual coupler and microphones. It is nil up to 800 Hz and printed at five frequencies from 1 kHz to 2.5 kHz, where C.3 sets the upper limit of the coupler for LS1P microphones. A frequency within 2 % of a printed one takes its value; one between two rows is interpolated linearly in lg f, and flagged.

For a coupler filled with hydrogen, C.3 allows the same corrections “provided the frequency scale is multiplied by a factor equal to the ratio of the speed of sound”: speed_of_sound_ratio is that factor, and each frequency is read at its value divided by it.

Parameters

Name Description
frequencies The frequencies, in Hz, increasing.
speed_of_sound_ratio The speed of sound in the gas re that in air (Default: 1, air).

Returns: The WaveMotionCorrection.

Raises

Exception When
ValueError for a frequency whose air equivalent is above 2 500 Hz, or a ratio that is not positive.
TypeError if speed_of_sound_ratio is not a single number.
LargeVolumeCoupler(
*,
length_m: float,
diameter_m: float,
port_length_m: float,
capillary: CapillaryTube | None = None,
volume_m3: float | None = None,
surface_area_m2: float | None = None,
)

A large-volume coupler: a cylinder much larger than the front cavities and the equivalent volumes (IEC 61094-2:2009 C.3, Table C.2 and Figure C.2).

Figure C.2 draws each microphone with its face port_length_m back from the cavity: the front cavity, of diameter B, continues through the wall of the coupler as a bore of length F to the cavity. Each bore adds to the volume of Formula (3) and to the surface the heat conduction sees, with B the front-cavity diameter of the microphone in it (coupler_transfer_impedance). For the coupler of Table C.2 the two bores of LS1P microphones are 2.4 % of the cavity, about 0.1 dB on each sensitivity.

Attributes

Name Description
length_m The length of the cavity, in m (dimension E).
diameter_m Its diameter, in m (dimension C).
port_length_m The length of the bore between each microphone face and the cavity, in m (dimension F of Table C.2: 0.80 mm for LS1P, 0.40 mm for LS2P); zero for microphones whose faces close the cavity.
capillary The capillary tubes, or None.
volume_m3 The measured volume of the cavity of length E, without the bores and the front cavities, in m³, or None for the cylinder of length_m and diameter_m. A volume measured between the two microphone faces includes the bores: pass it with port_length_m=0.
surface_area_m2 Its measured surface, in m², or None for that of the closed cylinder; measured between the faces, with port_length_m=0 as well.

property

The surface of the cavity of length E, in m²: the measured one, or the closed cylinder’s.

property

The volume of the cavity of length E, in m³: the measured one, or the cylinder’s.

LargeVolumeCoupler.closed_surface_m2(
microphones: Sequence[ReciprocityMicrophone],
) -> float

The surface the heat conduction sees with the coupler closed by two microphones, in m²: the closed cylinder, the wall of each bore and of each front cavity, and any thread in it (7.3.2.2); each diaphragm takes the place of the port it closes.

Parameters

Name Description
microphones The two microphones that close it.

Returns: The surface, in m².

Raises

Exception When
ValueError for other than two microphones.
LargeVolumeCoupler.closed_volume_m3(
microphones: Sequence[ReciprocityMicrophone],
) -> float

The volume of Formula (3) with the coupler closed by two microphones, in m³: the cavity, the two bores and the two front cavities (7.3.3.1, Figure C.2).

Parameters

Name Description
microphones The two microphones that close it.

Returns: , in m³.

Raises

Exception When
ValueError for other than two microphones.
microphone_acoustic_impedance(
electrical_admittance_s: complex | np.number[Any],
blocked_impedance_ohm: complex | np.number[Any],
pressure_sensitivity_v_per_pa: complex | np.number[Any],
) -> complex
microphone_acoustic_impedance(
electrical_admittance_s: Sequence[complex] | Sequence[np.number[Any]] | NDArray[np.bool_ | np.number[Any]],
blocked_impedance_ohm: NumericArrayLike,
pressure_sensitivity_v_per_pa: NumericArrayLike,
) -> NDArray[np.complex128]
microphone_acoustic_impedance(
electrical_admittance_s: complex | np.number[Any],
blocked_impedance_ohm: Sequence[complex] | Sequence[np.number[Any]] | NDArray[np.bool_ | np.number[Any]],
pressure_sensitivity_v_per_pa: NumericArrayLike,
) -> NDArray[np.complex128]
microphone_acoustic_impedance(
electrical_admittance_s: complex | np.number[Any],
blocked_impedance_ohm: complex | np.number[Any],
pressure_sensitivity_v_per_pa: Sequence[complex] | Sequence[np.number[Any]] | NDArray[np.bool_ | np.number[Any]],
) -> NDArray[np.complex128]
microphone_acoustic_impedance(
electrical_admittance_s: NumericArrayLike,
blocked_impedance_ohm: NumericArrayLike,
pressure_sensitivity_v_per_pa: NumericArrayLike,
) -> complex | NDArray[np.complex128]

The acoustic impedance of a microphone from its electrical admittance (IEC 61094-2:2009 E.4, Formula (E.1)).

with the admittance measured while the diaphragm is terminated by a closed quarter-wavelength tube (), and the blocked impedance at 100 kHz to 200 kHz, where the diaphragm cannot move. E.4 calculates it “by iteration”, because the pressure sensitivity is itself the result of a calibration that used : alternate this with pressure_reciprocity until both stop changing.

Parameters

Name Description
electrical_admittance_s , complex, in S.
blocked_impedance_ohm , complex, in Ω.
pressure_sensitivity_v_per_pa , complex, in V/Pa.

Returns: , complex, in Pa·s/m³, an array of the broadcast shape of the three, zero-dimensional for numbers. A complex when electrical_admittance_s, blocked_impedance_ohm and pressure_sensitivity_v_per_pa are all numbers, an array when one of them is a sequence or an array, a zero-dimensional one included.

Raises

Exception When
ValueError for an admittance or a sensitivity of zero, or a value that is not finite.
TypeError if blocked_impedance_ohm, electrical_admittance_s or pressure_sensitivity_v_per_pa holds a text or a value that is not a number.
PlaneWaveCoupler(
*,
length_m: float,
diameter_m: float,
capillary: CapillaryTube | None = None,
)

A plane-wave coupler: a cylinder of the diameter of the front cavities (IEC 61094-2:2009 C.2, Table C.1 and Figure C.1).

Attributes

Name Description
length_m The length of the coupler, between its two faces, in m (dimension E); the distance between the diaphragms adds the depths of the two front cavities (7.3.3.1).
diameter_m Its diameter, in m (dimension C).
capillary The capillary tubes, or None for none or tubes blocked by a wire ().
pressure_reciprocity(
electrical_transfer_impedances_ohm: Sequence[NumericArrayLike],
acoustic_transfer_impedances: Sequence[NumericArrayLike | CouplerTransferImpedance],
*,
frequencies: NumericArrayLike,
corrections: Mapping[str, NumericArrayLike] | None = None,
expanded_uncertainty_db: NumericArrayLike | None = None,
) -> ReciprocityCalibration

The pressure sensitivities of three microphones calibrated in pairs in a coupler (IEC 61094-2:2009 5.7.1, Formula (7)).

Each pair gives the product (Formula (2)), and Formula (7) solves the three:

with similar expressions for the other two, and the phase “by a similar procedure from the phase angle of each term”. The library solves the complex products together, on the branch described in reciprocity_calibration.

Parameters

Name Description
frequencies The frequencies, in Hz, increasing.
electrical_transfer_impedances_ohm , and , complex, in Ω, each one value or one per frequency.
acoustic_transfer_impedances , and , each a CouplerTransferImpedance or complex values in Pa·s/m³ already corrected.
corrections Corrections added to every sensitivity level, by name, in dB: large_volume_wave_motion_correction for the large-volume coupler of LS1P microphones (Default: none).
expanded_uncertainty_db The expanded uncertainty of the levels, in dB, one value or one per frequency, from reciprocity_uncertainty_budget (Default: None).

Returns: The ReciprocityCalibration.

Raises

Exception When
ValueError for other than three pairs, values that are zero or not finite, or a column of the wrong length.
pressure_reciprocity_pair(
electrical_transfer_impedance_ohm: NumericArrayLike,
acoustic_transfer_impedance: NumericArrayLike | CouplerTransferImpedance,
sensitivity_ratio: NumericArrayLike,
*,
frequencies: NumericArrayLike,
corrections: Mapping[str, NumericArrayLike] | None = None,
expanded_uncertainty_db: NumericArrayLike | None = None,
) -> ReciprocityCalibration

The pressure sensitivities of two microphones and an auxiliary sound source (IEC 61094-2:2009 5.1.3 and 5.7.2, Formula (8)).

with the ratio of the two sensitivities measured by exposing both to the same pressure of the auxiliary source; only microphone (1) needs to be reciprocal (5.1.1).

Parameters

Name Description
frequencies The frequencies, in Hz, increasing.
electrical_transfer_impedance_ohm , complex, in Ω.
acoustic_transfer_impedance , a CouplerTransferImpedance or complex values in Pa·s/m³.
sensitivity_ratio , complex, one value or one per frequency.
corrections Corrections added to both levels (Default: none).
expanded_uncertainty_db The expanded uncertainty, in dB (Default: None).

Returns: The ReciprocityCalibration, of two microphones.

Raises

Exception When
ValueError for values that are zero or not finite, or a column of the wrong length.
ReciprocityMicrophone(
*,
equivalent_volume_m3: float,
resonance_frequency_hz: float,
loss_factor: float,
front_cavity_volume_m3: float,
front_cavity_depth_m: float,
front_cavity_diameter_m: float,
thread_area_m2: float = 0.0,
)

The parameters of a laboratory standard microphone that enter the acoustic transfer impedance (IEC 61094-2:2009 7.3.3 and Annex E).

The acoustic impedance is the lumped series compliance, mass and resistance of E.4, written as the equivalent volume at low frequencies, the resonance frequency and the loss factor:

E.4 states this representation is generally sufficient up to about 1.3 times the resonance frequency.

Attributes

Name Description
equivalent_volume_m3 , the low-frequency real part of the equivalent volume, in m³.
resonance_frequency_hz , where the imaginary part of vanishes, in Hz.
loss_factor .
front_cavity_volume_m3 The measured volume of the front cavity, in m³ (7.3.3.1, E.3).
front_cavity_depth_m Its depth, in m (E.2).
front_cavity_diameter_m Its diameter, in m (dimension B of Tables C.1 and C.2).
thread_area_m2 The surface an inner thread of the front cavity adds to the cavity wall, in m²; added to in Formula (A.5) (A.3, [A.4]) and to the surface of a large-volume coupler (7.3.2.2).

ReciprocityMicrophone.acoustic_impedance_pa_s_m3()

Section titled “ReciprocityMicrophone.acoustic_impedance_pa_s_m3()”
ReciprocityMicrophone.acoustic_impedance_pa_s_m3(
frequencies: float | np.floating[Any] | np.integer[Any],
) -> complex
ReciprocityMicrophone.acoustic_impedance_pa_s_m3(
frequencies: Sequence[float] | Sequence[np.floating[Any]] | Sequence[np.integer[Any]] | NDArray[np.bool_ | np.integer[Any] | np.floating[Any]],
) -> NDArray[np.complex128]
ReciprocityMicrophone.acoustic_impedance_pa_s_m3(
frequencies: NumericArrayLike,
) -> complex | NDArray[np.complex128]

, in Pa·s/m³.

Parameters

Name Description
frequencies The frequencies, in Hz, positive.

Returns: at each frequency, in Pa·s/m³. A complex for a number, an array for a sequence or an array, a zero-dimensional one included.

Raises

Exception When
TypeError if frequencies holds a text or a value that is not a real number.

ReciprocityMicrophone.complex_equivalent_volume_m3()

Section titled “ReciprocityMicrophone.complex_equivalent_volume_m3()”
ReciprocityMicrophone.complex_equivalent_volume_m3(
frequencies: float | np.floating[Any] | np.integer[Any],
) -> complex
ReciprocityMicrophone.complex_equivalent_volume_m3(
frequencies: Sequence[float] | Sequence[np.floating[Any]] | Sequence[np.integer[Any]] | NDArray[np.bool_ | np.integer[Any] | np.floating[Any]],
) -> NDArray[np.complex128]
ReciprocityMicrophone.complex_equivalent_volume_m3(
frequencies: NumericArrayLike,
) -> complex | NDArray[np.complex128]

The complex equivalent volume of Formula (3), in m³, which tends to equivalent_volume_m3 at low frequencies:

Parameters

Name Description
frequencies The frequencies, in Hz.

Returns: at each frequency, in m³. A complex for a number, an array for a sequence or an array, a zero-dimensional one included.

Raises

Exception When
TypeError if frequencies holds a text or a value that is not a real number.

ReciprocityMicrophone.compliance_m3_per_pa

Section titled “ReciprocityMicrophone.compliance_m3_per_pa”

property

, in m³/Pa.

property

, in kg/m⁴.

property

, in Pa·s/m³.

temperature_transfer_function(
length_to_diameter_ratio: float,
x: float | np.floating[Any] | np.integer[Any],
*,
method: Literal['exact', 'approximation'] = ...,
) -> complex
temperature_transfer_function(
length_to_diameter_ratio: float,
x: Sequence[float] | Sequence[np.floating[Any]] | Sequence[np.integer[Any]] | NDArray[np.bool_ | np.integer[Any] | np.floating[Any]],
*,
method: Literal['exact', 'approximation'] = ...,
) -> NDArray[np.complex128]
temperature_transfer_function(
length_to_diameter_ratio: float,
x: NumericArrayLike,
*,
method: Literal['exact', 'approximation'] = ...,
) -> complex | NDArray[np.complex128]

Gerber’s complex temperature transfer function of a cylindrical cavity (IEC 61094-2:2009 A.2, Formula (A.2) and Table A.1).

is “the ratio of the space average of the sinusoidal temperature variation associated with the sound pressure to the sinusoidal temperature variation that would be generated if the walls of the coupler were perfectly non-conducting”, a function of the length-to-diameter ratio of the cylinder and of

with its volume to surface ratio and the thermal diffusivity of the gas.

method="exact" (default) sums the full solution of the annex’s reference [A.1], which A.2 requires below 20 Hz unless the uncertainty component is increased instead, and which reproduces all 96 entries of Table A.1 to the 0.000 01 the annex states for them. method="approximation" is Formula (A.2), whose modulus the annex states accurate to 0.01 % for and ; its first two terms are the approximation the annex allows for a coupler that is not a right circular cylinder.

Parameters

Name Description
length_to_diameter_ratio , positive.
x , one value or several, positive.
method "exact" or "approximation".

Returns: , complex, with the shape of x. A complex for a number, an array for a sequence or an array, a zero-dimensional one included.

Raises

Exception When
ValueError for a ratio or an that is not positive and finite, or an unknown method.
TypeError if method is not a text, or length_to_diameter_ratio is not a single number, or x holds a text or a value that is not a real number.
WaveMotionCorrection(
frequencies: NDArray[np.float64],
correction: NDArray[np.float64],
speed_of_sound_ratio: float,
)

The wave-motion correction of the large-volume coupler for LS1P microphones (IEC 61094-2:2009 C.3, Table C.3).

Attributes

Name Description
frequencies The frequencies, in Hz.
correction The correction added to the pressure sensitivity level, in dB.
speed_of_sound_ratio The ratio of the speed of sound in the gas of the coupler to that in air, 1 for air.

Whether each value was interpolated between rows of the table (interpolated) is read from the frequencies and the ratio, so it is not a field.

property

Whether each value was interpolated between rows of Table C.3.

A frequency whose air equivalent lies within 2 % of a printed row takes that row, and one below the first row takes its nil correction; any other is interpolated between two rows.

Returns: One boolean per frequency.

WaveMotionCorrection.plot(
ax: Axes | None = None,
*,
language: Literal['en', 'es'] = 'en',
**kwargs: Any,
) -> Axes

Plot the correction against frequency, with the rows of Table C.3.

Parameters

Name Description
ax Existing axes to draw on, or None to create a figure.
language Label language, "en" (default) or "es".
kwargs Forwarded to the correction curve.

Returns: The axes. Requires matplotlib (the [plot] extra).