openpiv.validation.sig2noise_val

openpiv.validation.sig2noise_val(s2n: numpy.ndarray, threshold: float = 1.0) → numpy.ndarray[source]

Marks spurious vectors if signal to noise ratio is below a specified threshold.

Parameters:
  • u (2d or 3d np.ndarray) – a two or three dimensional array containing the u velocity component.
  • v (2d or 3d np.ndarray) – a two or three dimensional array containing the v velocity component.
  • s2n (2d np.ndarray) – a two or three dimensional array containing the value of the signal to noise ratio from cross-correlation function.
  • w (2d or 3d np.ndarray) – a two or three dimensional array containing the w (in z-direction) velocity component.
  • threshold (float) – the signal to noise ratio threshold value.
Returns:

flag – a boolean array. True elements corresponds to outliers.
Return type:

boolean 2d np.ndarray

References

    1. Keane and R. J. Adrian, Measurement Science & Technology, 1990,

    1, 1202-1215.