underwater.sources.ship_radiated_noise
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.
Ship radiated noise and equivalent monopole source level (ISO 17208-1/-2).
A surface ship measured in deep water is characterised by its radiated noise level and then by an equivalent monopole source level referred to a point source below the sea surface:
radiated_noise_level: dB re 1 µPa·m (ISO 17208-1), the level of the product of the far-field RMS pressure and the source distance.monopole_source_level: convertsLRNto the source level with the Lloyd’s-mirror surface correction of ISO 17208-2 Formula 3, for a nominal source depth (Formula 1).
Supporting helpers give the ISO 17208-1 three-hydrophone measurement depths
(hydrophone_depths) and the ISO 17208-2 tabulated source-level
uncertainty (source_level_uncertainty). The conversion assumes an ideal
pressure-release sea surface and ignores wind; the reported source level is an
equivalent monopole broadside value and must be quoted with its source depth.
Auto-generated from the source docstrings by
scripts/generate_api_docs.py(make api-docs). Do not edit by hand.
hydrophone_depths
Section titled “hydrophone_depths”hydrophone_depths( cpa_distance: float, *, angles_deg: NumericArrayLike = (15.0, 30.0, 45.0),) -> NDArray[np.float64]Hydrophone depths for the ISO 17208-1 deep-water geometry.
At the closest point of approach the three hydrophones sit at depression
angles from the sea surface seen from the ship reference point; at a
horizontal range equal to cpa_distance the depth of each is
.
Parameters
| Name | Description |
|---|---|
cpa_distance |
Horizontal distance at the closest point of approach, in m (). |
angles_deg |
Depression angles, in degrees (default 15°, 30°, 45°). |
Returns: The hydrophone depths, in m.
Raises
| Exception | When |
|---|---|
| ValueError | If the distance or any angle is out of range. |
| TypeError | if angles_deg holds a text or a value that is not a real number. |
monopole_source_level
Section titled “monopole_source_level”monopole_source_level( rnl: NumericArrayLike, draft_m: float, *, frequency: NumericArrayLike, speed_of_sound: float = 1500.0,) -> ShipSourceLevelResultEquivalent monopole source level from radiated noise level (ISO 17208-2).
with the surface correction
where , and the nominal source depth is (Formula 1).
Parameters
| Name | Description |
|---|---|
rnl |
Radiated noise level per frequency, in dB re 1 µPa·m (scalar or array; array length must match frequency). |
frequency |
Frequency or frequencies, in Hz. |
draft_m |
Ship draught D (mean of bow and stern), in m. |
speed_of_sound |
Speed of sound in sea water, in m/s (default 1500). |
Returns: A ShipSourceLevelResult.
Raises
| Exception | When |
|---|---|
| ValueError | If the inputs are invalid or the shapes mismatch. |
| TypeError | if frequency or rnl holds a text or a value that is not a real number. |
radiated_noise_level
Section titled “radiated_noise_level”radiated_noise_level(rms_pressure_pa: float, distance: float) -> floatRadiated noise level LRN (ISO 17208-1), dB re 1 µPa·m.
, the level of the product of the far-field RMS sound pressure and the source distance, referred to 1 µPa·m.
Parameters
| Name | Description |
|---|---|
rms_pressure_pa |
Far-field RMS sound pressure p_rms, in Pa. |
distance |
Distance r from the ship reference point, in m. |
Returns: Radiated noise level, in dB re 1 µPa·m.
Raises
| Exception | When |
|---|---|
| ValueError | If the pressure or distance is not positive. |
ShipSourceLevelResult
Section titled “ShipSourceLevelResult”ShipSourceLevelResult( frequencies: NDArray[np.float64], radiated_noise_level: NDArray[np.float64], surface_correction: NDArray[np.float64], source_level: NDArray[np.float64], source_depth: float, speed_of_sound: float,)Equivalent monopole source level of a ship (ISO 17208-2).
Attributes
| Name | Description |
|---|---|
frequencies |
Frequencies, in Hz. |
radiated_noise_level |
Input RNL per frequency, in dB re 1 µPa·m. |
surface_correction |
Lloyd’s-mirror correction per frequency, dB. |
source_level |
Equivalent monopole source level , in dB re 1 µPa·m. |
source_depth |
Nominal source depth , in m. |
speed_of_sound |
Speed of sound used, in m/s. |
ShipSourceLevelResult.plot()
Section titled “ShipSourceLevelResult.plot()”ShipSourceLevelResult.plot( ax: Axes | None = None, *, language: Literal['en', 'es'] = 'en', **kwargs: Any,) -> AxesPlot RNL, source level and the ΔL surface correction vs frequency.
Parameters
| Name | Description |
|---|---|
language |
The language of the labels: "en" or "es". |
source_level_uncertainty
Section titled “source_level_uncertainty”source_level_uncertainty(frequency: float) -> floatTabulated expanded source-level uncertainty (ISO 17208-2 §5), in dB.
5 dB for the low-frequency bands (the standard lists 10 Hz-100 Hz; values below 10 Hz reuse it), 3 dB for the mid-frequency bands (125 Hz-16 kHz) and 4 dB for the high-frequency bands. Part 2 prints its high band as ”> 20 000 Hz”, which leaves the 20 kHz band itself unassigned; Part 1, from which the values are taken, prints ”>= 20 000 Hz”. This implementation follows Part 1, so the 4 dB high-band value applies from the 20 kHz band upwards (the cut is written at 16 kHz because no one-third-octave band lies between the two). These are representative values, not exact.
Parameters
| Name | Description |
|---|---|
frequency |
One-third-octave band centre frequency, in Hz. |
Returns: The representative expanded uncertainty, in dB.
Raises
| Exception | When |
|---|---|
| ValueError | If the frequency is not positive. |