Ir al contenido

vibration.human.exposure

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.

Human exposure to whole-body and hand-transmitted vibration.

The measurement chain of the ISO human-vibration family is implemented from the standards’ own analog definitions, clean-room:

  • ISO 8041-1:2017: the authoritative master definition of every frequency weighting. A single cascade (Formula (5)) of second-order band-limiting Butterworth sections (Formulae (1)/(2)), an acceleration-velocity transition (Formula (3)) and an upward step (Formula (4)) realises all nine weightings from the one Table 3 parameter set: Wb, Wc, Wd, We, Wf, Wh, Wj, Wk, Wm. The tabulated design-goal factors of Annex B (Tables B.1-B.9) are reproduced to their four-significant-figure precision. The band-limiting pair is published on its own as well (band_limiting_response), because 5.1 lists the band-limited value among the quantities an instrument must display and Annex B tabulates it in three columns of its own.

  • ISO 2631-1:1997 (whole-body vibration): the weighted r.m.s. acceleration a_w (Eq. (1)/(9)), the vibration total value a_v with axis multiplying factors k (Eq. (10)), the running r.m.s. and maximum transient vibration value MTVV (Eqs. (2)-(4)), the vibration dose value VDV (Eq. (5)), the crest factor (6.2.1) and the energy-equivalent magnitude relations of Annex B (Eqs. (B.1)-(B.3)).

  • ISO 2631-2:2003 (whole-body vibration in buildings): the direction-independent weighting Wm (Annex A).

  • ISO 2631-4:2001 (ride comfort in fixed-guideway transport such as rail): the vertical weighting Wb (Annex A) with the Wk axis multiplying factors. Wb is realised here from its exact ISO 8041-1 Table 3 parameters (of which ISO 2631-4 Table A.1 is the two-decimal rounding).

  • ISO 5349-1:2001 / ISO 5349-2:2001 (hand-transmitted vibration): the vibration total value a_hv (5349-1 Eq. (1)), the daily exposure A(8) for single and multiple operations (5349-1 Eqs. (2)/(3); 5349-2 Eqs. (1)-(3)) and the vibration-white-finger dose relation of 5349-1 Annex C (Eq. (C.1)).

  • Directive 2002/44/EC: the daily exposure action and limit values (Article 3) that ISO does not fix: hand-arm A(8) EAV 2.5 / ELV 5 m/s2; whole-body A(8) EAV 0.5 / ELV 1.15 m/s2 (or VDV EAV 9.1 / ELV 21 m/s^1.75). The hand-arm A(8) is based on the ISO 5349-1 vector total a_hv (Annex, Part A, point 1); the whole-body A(8) is based on the highest of the frequency-weighted axis values , , (Annex, Part B, point 1; see wbv_exposure_basis), not on the ISO 2631-1 Eq. (10) vector total.

The band (spectrum) method and the exposure arithmetic carry the standards’ worked-example oracles; the time-domain metrics operate on a weighted acceleration signal, which apply_weighting produces from a raw record by applying the exact analog response of ISO 8041-1 in the frequency domain.

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

Constant (float).

ACCELERATION_LEVEL_REFERENCE_M_S2 = 1e-06
apply_band_limiting(
x: Signal | NumericArrayLike,
fs: float | None = None,
*,
name: Literal['Wb', 'Wc', 'Wd', 'We', 'Wf', 'Wh', 'Wj', 'Wk', 'Wm'],
) -> NDArray[np.float64]

Apply the band-limiting weighting of name to a time signal.

The band-limiting weighting of band_limiting_response (ISO 8041-1 Formulae (1) and (2)) applied the way apply_weighting applies the overall weighting: the exact analog response, multiplied in the frequency domain. This is the signal path the type tests of 12.7, 12.10, 12.11 and 12.13 put the meter on, and the one the “Band limiting” rows of Tables 7 to 9 are measured through.

The multiplication is circular, exactly as in apply_weighting, so the record wraps at its ends. A test that has to reproduce the printed burst responses of 5.9 pads the record with zeros first, because the printed values come from a zero-state digital simulation (5.9, NOTE 1) and the switch-on transient is part of what they measure.

Parameters

Name Description
x Unweighted acceleration time history (1-D), in m/s2. Accepts a phonometry.io.Signal for its rate; a calibration factor it carries is deliberately not applied, because this quantity is an acceleration in m/s2 and not a pressure.
fs Sampling frequency, in hertz (> 0). Required for a bare array; a Signal brings its own, and an explicit value that disagrees with it raises instead of silently winning.
name Weighting name (one of WEIGHTING_NAMES) whose band-limiting pair is applied. One of "Wb", "Wc", "Wd", "We", "Wf", "Wh", "Wj", "Wk" or "Wm".

Returns: The band-limited acceleration signal, same length as input.

Raises

Exception When
ValueError if x is not 1-D, fs is not positive, or name is unknown.
TypeError if fs is not a single number, or name is not a text.
apply_weighting(
x: Signal | NumericArrayLike,
fs: float | None = None,
*,
name: Literal['Wb', 'Wc', 'Wd', 'We', 'Wf', 'Wh', 'Wj', 'Wk', 'Wm'],
) -> NDArray[np.float64]

Apply frequency weighting name to a time signal (ISO 8041-1).

The exact analog response frequency_weighting is applied in the frequency domain (real FFT), so the weighted signal reproduces both the magnitude and phase of the standard’s cascade without bilinear warping. The multiplication is circular, so the record wraps at its ends; apply it to a record long enough (or pre-tapered) that the boundary transient is negligible, as for any block frequency-domain filtering.

Parameters

Name Description
x Unweighted acceleration time history (1-D), in m/s2. Accepts a phonometry.io.Signal for its rate; a calibration factor it carries is deliberately not applied, because this quantity is an acceleration in m/s2 and not a pressure.
fs Sampling frequency, in hertz (> 0). Required for a bare array; a Signal brings its own, and an explicit value that disagrees with it raises instead of silently winning.
name Weighting name (one of WEIGHTING_NAMES). One of "Wb", "Wc", "Wd", "We", "Wf", "Wh", "Wj", "Wk" or "Wm".

Returns: The frequency-weighted acceleration signal, same length as input.

Raises

Exception When
ValueError if x is not 1-D, fs is not positive, or name is unknown.
TypeError if fs is not a single number, or name is not a text.
band_limiting_factors(
name: Literal['Wb', 'Wc', 'Wd', 'We', 'Wf', 'Wh', 'Wj', 'Wk', 'Wm'],
frequencies: float | np.floating[Any] | np.integer[Any],
) -> float
band_limiting_factors(
name: Literal['Wb', 'Wc', 'Wd', 'We', 'Wf', 'Wh', 'Wj', 'Wk', 'Wm'],
frequencies: Sequence[float] | Sequence[np.floating[Any]] | Sequence[np.integer[Any]] | NDArray[np.bool_ | np.integer[Any] | np.floating[Any]],
) -> NDArray[np.float64]
band_limiting_factors(
name: Literal['Wb', 'Wc', 'Wd', 'We', 'Wf', 'Wh', 'Wj', 'Wk', 'Wm'],
frequencies: NumericArrayLike,
) -> float | NDArray[np.float64]

Band-limiting weighting factors (ISO 8041-1:2017, Annex B).

Convenience wrapper over band_limiting_response returning only the magnitude array, which is the “Band-limiting Factor” column of Tables B.1 to B.9.

Parameters

Name Description
name Weighting name (one of WEIGHTING_NAMES). One of "Wb", "Wc", "Wd", "We", "Wf", "Wh", "Wj", "Wk" or "Wm".
frequencies Band centre frequencies, in hertz.

Returns: Band-limiting factor per frequency. A float for a number, an array for a sequence or an array, a zero-dimensional one included.

Raises

Exception When
TypeError if name is not a text.
band_limiting_response(
name: Literal['Wb', 'Wc', 'Wd', 'We', 'Wf', 'Wh', 'Wj', 'Wk', 'Wm'],
frequencies: NumericArrayLike,
) -> WeightingResponse

Band-limiting weighting response (ISO 8041-1:2017, Formulae (1), (2)).

The band-limiting weighting is the high-pass and low-pass pair of the cascade on its own, , with the f1 and f2 corners of Table 3 and the Butterworth . It is a displayed quantity in its own right: 5.1 (folio 9) lists the “time-averaged band-limited vibration acceleration value over the measurement duration” among the three things an instrument must be able to display, 5.6.6 (folio 14) says the Table 5 limits “apply to the weightings, including the corresponding band-limiting weightings”, and Annex B gives it three columns of its own in every one of Tables B.1 to B.9. It is also the signal path the type tests are written on: 12.7, 12.10.1, 12.11.2, 12.11.3 and 12.13 all set the meter to the band-limiting frequency weighting first.

Only four corner pairs exist among the nine weightings, as Table 3 prints them: 0.4 Hz and 100 Hz for Wb, Wc, Wd, We, Wj and Wk; 10**(8/10) Hz and 10**(31/10) Hz for Wh; 10**(-0.1) Hz and 100 Hz for Wm; 0.08 Hz and 0.63 Hz for Wf. The response is still asked for by weighting name, because that is how the standard cites it.

Parameters

Name Description
name Weighting name (one of WEIGHTING_NAMES) whose band-limiting pair is wanted. One of "Wb", "Wc", "Wd", "We", "Wf", "Wh", "Wj", "Wk" or "Wm".
frequencies Frequencies at which to evaluate, in hertz (> 0).

Returns: A WeightingResponse with band_limiting true and .plot().

Raises

Exception When
ValueError if name is unknown or frequencies is empty.
TypeError if name is not a text, or frequencies holds a text or a value that is not a real number.
combined_daily_exposure(partials: NumericArrayLike) -> float

Combine partial exposures into A(8) (ISO 5349-1/-2 Eq. (3)).

.

Parameters

Name Description
partials Partial exposures , in m/s2.

Returns: The combined daily exposure A(8), in m/s2.

Raises

Exception When
ValueError if partials is empty.
TypeError if partials holds a text or a value that is not a real number.
crest_factor(x: Signal | NumericArrayLike) -> float

Crest factor of a weighted signal (ISO 2631-1 clause 6.2.1).

The modulus of the ratio of the peak weighted acceleration to its r.m.s. value. ISO 2631-1 6.2.2 deems the basic (r.m.s.) method adequate for a crest factor up to 9.

Emits a HumanVibrationWarning when the crest factor exceeds 9, the threshold above which ISO 2631-1 6.2.2 deems the basic method inadequate.

Parameters

Name Description
x Frequency-weighted acceleration signal (1-D), in m/s2. Accepts a phonometry.io.Signal, of which only the samples are read: a peak-to-r.m.s. ratio needs no sample rate, and a calibration factor the object carries is deliberately not applied, because this quantity is an acceleration in m/s2 and not a pressure.

Returns: The crest factor (dimensionless); 0 for an all-zero signal.

daily_exposure(total_value: float, duration_s: float) -> float

Daily exposure A(8) for one operation (ISO 5349-1 Eq. (2)).

with h. The identical form gives the whole-body A(8) of Directive 2002/44/EC, whose magnitude is the Annex Part B dominant-axis value (see wbv_exposure_basis) rather than a vector total. Called with the value and duration of one operation of a working day, it returns that operation’s partial vibration exposure (ISO 5349-2 Eq. (2)), the term combined_daily_exposure sums.

Parameters

Name Description
total_value Vibration total value a_hv (or a_v), in m/s2.
duration_s Daily exposure duration T, in seconds.

Returns: The daily exposure A(8), in m/s2.

Raises

Exception When
ValueError for a non-finite or negative magnitude or duration.
TypeError if duration_s or total_value is not a single number.
daily_vibration_exposure(
total_values: NumericArrayLike,
durations_s: NumericArrayLike,
*,
kind: Literal['hav', 'wbv'],
labels: list[str] | tuple[str, ...] | None = None,
) -> DailyVibrationExposure

Daily exposure from several operations, assessed (ISO 5349 + Directive).

Combines the operations via the partial exposures of ISO 5349-1/-2 Eqs. (2)/(3) and assesses the resulting A(8) against the Directive 2002/44/EC action and limit values for kind.

The Directive fixes the per-operation magnitude each kind must be fed with (Annex, points 1): for kind="hav" the ISO 5349-1 Eq. (1) vector total a_hv (Part A); for kind="wbv" the highest frequency- weighted axis value max(1,4*a_wx, 1,4*a_wy, a_wz) that wbv_exposure_basis returns (Part B), not the ISO 2631-1 Eq. (10) vector total a_v.

Parameters

Name Description
total_values Per-operation vibration magnitude, in m/s2: the hand-arm vibration total value a_hv,i (kind="hav") or the Directive Part B dominant-axis value of wbv_exposure_basis (kind="wbv").
durations_s Duration T_i per operation, in seconds.
kind "hav" or "wbv" (selects the EAV/ELV).
labels Optional operation labels; defaults to op 1, op 2, …

Returns: A DailyVibrationExposure with .plot().

Raises

Exception When
ValueError if the inputs differ in length, carry non-finite values, or labels mismatches.
TypeError if durations_s or total_values holds a text or a value that is not a real number, or kind is not a text.
DailyVibrationExposure(
a8: float,
labels: tuple[str, ...],
total_values: NDArray[np.float64],
durations_s: NDArray[np.float64],
partials: NDArray[np.float64],
assessment: ExposureAssessment,
)

A daily exposure built from several operations, with its assessment.

Attributes

Name Description
a8 The daily exposure A(8), in m/s2.
labels A label per operation.
total_values Vibration total value a_hvi per operation, in m/s2.
durations_s Duration T_i per operation, in seconds.
partials Partial exposure A_i(8) per operation, in m/s2.
assessment The ExposureAssessment of a8.
DailyVibrationExposure.plot(
ax: Axes | None = None,
*,
language: Literal['en', 'es'] = 'en',
**kwargs: Any,
) -> Axes

Plot the partial exposures against the EAV / ELV thresholds.

Requires matplotlib (the [plot] extra); returns the Axes and never calls plt.show.

Parameters

Name Description
language The language of the labels: "en" or "es".
DailyVibrationExposure.report(
path: str | os.PathLike[str],
*,
metadata: ReportMetadata | None = None,
engine: Literal['reportlab'] = 'reportlab',
verbose: bool = False,
language: Literal['en', 'es'] = 'en',
) -> str

Render a daily vibration exposure assessment fiche to a PDF.

Writes a one-page assessment sheet laid out like the hand-arm / whole-body vibration exposure calculators of the occupational-hygiene practice: the standard-basis line naming the applied ISO method (ISO 5349-1/-2:2001 for hand-transmitted vibration, ISO 2631-1:1997 for whole-body vibration) and the Directive 2002/44/EC it is assessed against, an optional metadata header (company, operator/worker, workplace, instrumentation, calibration), the per-operation exposure analysis (the vibration magnitude, which is the hand-arm vector total a_hv or the whole-body Directive Part B dominant-axis value a_w,max; the daily exposure time T_i and the partial exposure A_i(8) of ISO 5349-1/-2 Eq. (2), closed by the daily total and the combined A(8) of Eq. (3)), the per-operation contribution chart, the boxed A(8) with its exposure zone, an assessment table against the exposure action value (EAV) and exposure limit value (ELV) of Directive 2002/44/EC (Article 3), a PASS/FAIL verdict against the limit value, and a footer identity/disclaimer block.

Parameters

Name Description
path Destination path of the PDF file.
metadata Optional ReportMetadata supplying the header identity (client is the company, specimen the operator/worker, test_room the workplace) plus the instrumentation and calibration free-text fields and the footer identity.
engine Rendering back end; only "reportlab" is supported.
verbose When True, the operations table adds each operation’s share of the daily vibration energy .
language Fiche language: "en" (default, English) or "es" (Spanish, with a comma decimal separator).

Returns: The written path as a str.

Raises

Exception When
ValueError If engine is not "reportlab" or language is unknown.
ImportError If reportlab or matplotlib is not installed. The fiche always embeds the contribution chart, so both are required (the [report] and [plot] extras).
energy_equivalent_acceleration(
magnitudes: NumericArrayLike,
durations_s: NumericArrayLike,
) -> float

Energy-equivalent weighted acceleration (ISO 2631-1 Eq. (B.3)).

.

Parameters

Name Description
magnitudes Weighted r.m.s. magnitudes , in m/s2.
durations_s Duration per period, in seconds.

Returns: The energy-equivalent magnitude , in m/s2.

Raises

Exception When
ValueError if the inputs differ in length, are empty, or the total duration is zero.
TypeError if durations_s or magnitudes holds a text or a value that is not a real number.
exposure_assessment(
value: float,
*,
kind: Literal['hav', 'wbv'],
metric: Literal['a8', 'vdv'] = 'a8',
) -> ExposureAssessment

Assess a daily exposure against Directive 2002/44/EC (Article 3).

Parameters

Name Description
value The daily exposure A(8) in m/s2 (metric="a8") or the vibration dose value in m/s^1.75 (metric="vdv", whole-body only).
kind "hav" (hand-arm) or "wbv" (whole-body).
metric "a8" (default) or "vdv".

Returns: An ExposureAssessment.

Raises

Exception When
ValueError for an unknown kind/metric combination or a non-finite or negative value.
TypeError if kind or metric is not a text. value is refused the same way when it is not one real number.
ExposureAssessment(
value: float,
kind: Literal['hav', 'wbv'],
metric: Literal['a8', 'vdv'],
)

A daily exposure assessed against the Directive 2002/44/EC values.

The two values of Article 3 are the Directive’s, read from kind and metric as properties together with the verdicts they give, so an assessment cannot be built against other values.

Attributes

Name Description
value The assessed daily exposure A(8) (or VDV), in its unit.
kind "hav" or "wbv".
metric "a8" (m/s2) or "vdv" (m/s^1.75).

property

The exposure action value (EAV) of Article 3 for the kind and metric.

property

Whether value reaches or exceeds the EAV.

property

Whether value reaches or exceeds the ELV.

property

The exposure limit value (ELV) of Article 3 for the kind and metric.

property

"below action", "action" (EAV<=value<ELV) or "limit" (value>=ELV).

frequency_weighting(
name: Literal['Wb', 'Wc', 'Wd', 'We', 'Wf', 'Wh', 'Wj', 'Wk', 'Wm'],
frequencies: NumericArrayLike,
) -> WeightingResponse

Frequency-weighting response H(f) (ISO 8041-1:2017, Formula (5)).

Evaluates the overall weighting (band limiting, acceleration-velocity transition and upward step) of weighting name at frequencies.

Parameters

Name Description
name Weighting name (one of WEIGHTING_NAMES). One of "Wb", "Wc", "Wd", "We", "Wf", "Wh", "Wj", "Wk" or "Wm".
frequencies Frequencies at which to evaluate, in hertz (> 0).

Returns: A WeightingResponse with .plot().

Raises

Exception When
ValueError if name is unknown or frequencies is empty.
TypeError if name is not a text, or frequencies holds a text or a value that is not a real number.
hav_daily_exposure(
total_values: NumericArrayLike,
durations_s: NumericArrayLike,
) -> float

Daily exposure A(8) for several operations (ISO 5349-1 Eq. (3)).

.

Parameters

Name Description
total_values Vibration total value per operation, in m/s2.
durations_s Duration per operation, in seconds.

Returns: The daily exposure A(8), in m/s2.

Raises

Exception When
ValueError if the inputs differ in length, are empty or negative.
TypeError if durations_s or total_values holds a text or a value that is not a real number.

Constant (float).

HAV_EAV_A8_M_S2 = 2.5

Constant (float).

HAV_ELV_A8_M_S2 = 5.0
hav_vwf_lifetime_years(a8: float) -> float

Years to 10 % vibration-white-finger prevalence (ISO 5349-1 Eq. (C.1)).

: the group-mean lifetime exposure that produces finger blanching in 10 % of an exposed group (informative Annex C).

Parameters

Name Description
a8 Daily vibration exposure A(8), in m/s2 (> 0).

Returns: The lifetime exposure duration , in years.

Raises

Exception When
ValueError if a8 is not positive.
TypeError if a8 is not a single number.

Advisory for out-of-range human-vibration measurement conditions.

motion_sickness_dose_value(
x: Signal | NumericArrayLike,
fs: float | None = None,
) -> float

Motion sickness dose value MSDV (ISO 2631-1 clause 9; 8041-1 3.1.2.5).

, in m/s^1.5; the Wf-weighted signal is the intended input.

Parameters

Name Description
x Frequency-weighted acceleration signal (1-D), in m/s2. Accepts a phonometry.io.Signal for its rate; a calibration factor it carries is deliberately not applied, because this quantity is an acceleration in m/s2 and not a pressure.
fs Sampling frequency, in hertz. Required for a bare array; a Signal brings its own, and an explicit value that disagrees with it raises instead of silently winning.

Returns: The MSDV, in m/s^1.5.

Raises

Exception When
ValueError for a bad signal or non-positive fs.
TypeError if fs is not a single number.
mtvv(
x: Signal | NumericArrayLike,
fs: float | None = None,
*,
integration_time: float = 1.0,
method: Literal['linear', 'exponential'] = 'linear',
) -> float

Maximum transient vibration value (ISO 2631-1 Eq. (4)).

MTVV = max a_w(t0), the peak of the 1 s running r.m.s. value.

The averaging is the one running_rms is asked for, because the two give different answers and both are graded: ISO 8041-1 Table 8 (folios 18 and 19) prints an “MTVV linear” and an “MTVV exponential” column side by side, 48 cells each with a 10 % tolerance, and Annex D D.3 (folio 79) spends its text on how far apart the two can sit. The default is the linear average of Eq. (2), which is what ISO 2631-1 defines the MTVV on.

Parameters

Name Description
x Frequency-weighted acceleration signal (1-D), in m/s2. Accepts a phonometry.io.Signal for its rate; a calibration factor it carries is deliberately not applied, because this quantity is an acceleration in m/s2 and not a pressure.
fs Sampling frequency, in hertz. Required for a bare array; a Signal brings its own, and an explicit value that disagrees with it raises instead of silently winning.
integration_time Running-r.m.s. averaging time, in seconds (1 s).
method "linear" (Eq. (2), the default) or "exponential" (Eq. (3)), forwarded to running_rms.

Returns: The MTVV, in m/s2.

Raises

Exception When
ValueError for a bad signal, non-positive fs/tau or an unknown method.
TypeError if method is not a text.

Constant (float).

REFERENCE_DURATION_S = 28800.0
running_rms(
x: Signal | NumericArrayLike,
fs: float | None = None,
*,
integration_time: float = 1.0,
method: Literal['linear', 'exponential'] = 'linear',
) -> NDArray[np.float64]

Running r.m.s. of a weighted signal (ISO 2631-1 Eqs. (2)/(3)).

Parameters

Name Description
x Frequency-weighted acceleration signal (1-D), in m/s2. Accepts a phonometry.io.Signal for its rate; a calibration factor it carries is deliberately not applied, because this quantity is an acceleration in m/s2 and not a pressure.
fs Sampling frequency, in hertz. Required for a bare array; a Signal brings its own, and an explicit value that disagrees with it raises instead of silently winning.
integration_time Averaging time tau, in seconds (default 1 s, the “slow” constant of ISO 2631-1 6.3.1).
method "linear" (Eq. (2), a sliding rectangular average) or "exponential" (Eq. (3), a single-pole average).

Returns: The running r.m.s. value a_w(t0) per sample, in m/s2.

Raises

Exception When
ValueError for a bad signal, non-positive fs/tau or an unknown method.
TypeError if fs or integration_time is not a single number, or method is not a text.
vibration_dose_value(
x: Signal | NumericArrayLike,
fs: float | None = None,
) -> float

Vibration dose value VDV (ISO 2631-1 Eq. (5)).

, in m/s^1.75; more sensitive to peaks than the r.m.s. value.

Parameters

Name Description
x Frequency-weighted acceleration signal (1-D), in m/s2. Accepts a phonometry.io.Signal for its rate; a calibration factor it carries is deliberately not applied, because this quantity is an acceleration in m/s2 and not a pressure.
fs Sampling frequency, in hertz. Required for a bare array; a Signal brings its own, and an explicit value that disagrees with it raises instead of silently winning.

Returns: The VDV, in m/s^1.75.

Raises

Exception When
ValueError for a bad signal or non-positive fs.
TypeError if fs is not a single number.
vibration_total_value(
components: NumericArrayLike,
*,
k: NumericArrayLike | None = None,
) -> float

Vibration total value a_v / a_hv (ISO 2631-1 Eq. (10)).

over the (up to three) axis-weighted r.m.s. accelerations. With k = None the unweighted vector sum of ISO 5349-1 Eq. (1) (a_hv, all ) is returned.

Parameters

Name Description
components Axis-weighted r.m.s. accelerations , in m/s2.
k Optional per-axis multiplying factors (ISO 2631-1 7.2.3); None uses unity for every axis.

Returns: The vibration total value, in m/s2.

Raises

Exception When
ValueError if components is empty or k differs in length.
TypeError if components or k holds a text or a value that is not a real number.

Constant (float).

WBV_EAV_A8_M_S2 = 0.5

Constant (float).

WBV_EAV_VDV = 9.1

Constant (float).

WBV_ELV_A8_M_S2 = 1.15

Constant (float).

WBV_ELV_VDV = 21.0
wbv_exposure_basis(a_wx: float, a_wy: float, a_wz: float) -> float

Whole-body exposure basis of Directive 2002/44/EC (Annex, Part B).

: the Directive bases the whole-body daily exposure A(8) on the highest of the frequency-weighted axis values , , for a seated or standing worker (Annex, Part B, point 1, with the ISO 2631-1 clause 7.2.3 multiplying factors), not on the ISO 2631-1 Eq. (10) vector total a_v. Feed the returned dominant-axis value to daily_vibration_exposure (kind="wbv") for a Directive-conforming whole-body assessment; the hand-arm basis is the vector total a_hv instead (Annex, Part A, point 1).

Parameters

Name Description
a_wx Wd-weighted r.m.s. acceleration on the x axis, in m/s2.
a_wy Wd-weighted r.m.s. acceleration on the y axis, in m/s2.
a_wz Wk-weighted r.m.s. acceleration on the z axis, in m/s2.

Returns: The dominant-axis value , in m/s2.

Raises

Exception When
ValueError for a negative or non-finite axis value.
TypeError if a_wx, a_wy or a_wz is not a single number.
weighted_acceleration(
band_accelerations: NumericArrayLike,
weighting: Literal['Wb', 'Wc', 'Wd', 'We', 'Wf', 'Wh', 'Wj', 'Wk', 'Wm'],
*,
frequencies: NumericArrayLike,
) -> WeightedSpectrum

Weighted r.m.s. acceleration from a band spectrum (ISO 2631-1 Eq. (9)).

with the per-band weighting factors of ISO 8041-1 evaluated at the band centres (ISO 5349-1 Eq. (A.1) is the identical construction for the hand-arm weighting Wh).

Parameters

Name Description
band_accelerations r.m.s. acceleration per band, in m/s2.
frequencies Band centre frequencies, in hertz (true one-third-octave centres for table-conformant band values).
weighting Weighting name (one of WEIGHTING_NAMES). One of "Wb", "Wc", "Wd", "We", "Wf", "Wh", "Wj", "Wk" or "Wm".

Returns: A WeightedSpectrum with .plot().

Raises

Exception When
ValueError if the inputs differ in length, are empty or carry non-finite values.
TypeError if band_accelerations or frequencies holds a text or a value that is not a real number, or weighting is not a text.
WeightedSpectrum(
frequencies: NDArray[np.float64],
band_accelerations: NDArray[np.float64],
weighting_name: Literal['Wb', 'Wc', 'Wd', 'We', 'Wf', 'Wh', 'Wj', 'Wk', 'Wm'],
weighting_factors: NDArray[np.float64],
weighted: NDArray[np.float64],
overall: float,
)

A weighted one-third-octave acceleration spectrum and its a_w.

Attributes

Name Description
frequencies Band centre frequencies, in hertz.
band_accelerations Unweighted r.m.s. acceleration per band, in m/s2.
weighting_name Weighting applied (one of WEIGHTING_NAMES). One of "Wb", "Wc", "Wd", "We", "Wf", "Wh", "Wj", "Wk" or "Wm".
weighting_factors Weighting factor W_i per band.
weighted Weighted band contribution W_i*a_i, in m/s2.
overall Overall weighted r.m.s. acceleration a_w, in m/s2.
WeightedSpectrum.plot(
ax: Axes | None = None,
*,
language: Literal['en', 'es'] = 'en',
**kwargs: Any,
) -> Axes

Plot the unweighted and weighted band spectra with a_w.

Requires matplotlib (the [plot] extra); returns the Axes and never calls plt.show.

Parameters

Name Description
language The language of the labels: "en" or "es".
weighting_factors(
name: Literal['Wb', 'Wc', 'Wd', 'We', 'Wf', 'Wh', 'Wj', 'Wk', 'Wm'],
frequencies: float | np.floating[Any] | np.integer[Any],
) -> float
weighting_factors(
name: Literal['Wb', 'Wc', 'Wd', 'We', 'Wf', 'Wh', 'Wj', 'Wk', 'Wm'],
frequencies: Sequence[float] | Sequence[np.floating[Any]] | Sequence[np.integer[Any]] | NDArray[np.bool_ | np.integer[Any] | np.floating[Any]],
) -> NDArray[np.float64]
weighting_factors(
name: Literal['Wb', 'Wc', 'Wd', 'We', 'Wf', 'Wh', 'Wj', 'Wk', 'Wm'],
frequencies: NumericArrayLike,
) -> float | NDArray[np.float64]

Weighting factors |H(f)| of weighting name (ISO 8041-1).

Convenience wrapper over frequency_weighting returning only the magnitude array (the W_i of ISO 2631-1 Eq. (9) / ISO 5349-1 Eq. (A.1)).

Parameters

Name Description
name Weighting name (one of WEIGHTING_NAMES). One of "Wb", "Wc", "Wd", "We", "Wf", "Wh", "Wj", "Wk" or "Wm".
frequencies Band centre frequencies, in hertz.

Returns: Weighting factor per frequency. A float for a number, an array for a sequence or an array, a zero-dimensional one included.

Raises

Exception When
TypeError if name is not a text.

Constant (tuple).

WEIGHTING_NAMES = ('Wb', 'Wc', 'Wd', 'We', 'Wf', 'Wh', 'Wj', 'Wk', 'Wm')
WeightingResponse(
name: Literal['Wb', 'Wc', 'Wd', 'We', 'Wf', 'Wh', 'Wj', 'Wk', 'Wm'],
frequencies: NDArray[np.float64],
response: NDArray[np.complex128],
magnitude: NDArray[np.float64],
magnitude_db: NDArray[np.float64],
*,
band_limiting: bool = False,
)

A frequency-weighting magnitude response (ISO 8041-1, Formula (5)).

Attributes

Name Description
name Weighting name (one of WEIGHTING_NAMES). One of "Wb", "Wc", "Wd", "We", "Wf", "Wh", "Wj", "Wk" or "Wm".
frequencies Frequencies at which the response was evaluated, in Hz.
response Complex weighting per frequency.
magnitude Weighting factor per frequency.
magnitude_db per frequency, in decibels.
band_limiting Whether the response is the band-limiting weighting of name (Formulae (1) and (2) alone) rather than the overall weighting of Formula (5). The standard tabulates the two side by side in Annex B and grades both against Table 5, so the flag is what tells a reader, and .plot(), which of the two curves this is.
WeightingResponse.plot(
ax: Axes | None = None,
*,
language: Literal['en', 'es'] = 'en',
**kwargs: Any,
) -> Axes

Plot the weighting factor (dB) versus frequency.

Requires matplotlib (the [plot] extra); returns the Axes and never calls plt.show.

Parameters

Name Description
language The language of the labels: "en" or "es".