argopy.utils.optical_modeling.Z_iPAR_threshold#
- Z_iPAR_threshold(axis: ndarray, par: ndarray, threshold: float = 15.0, tolerance: float = 5.0) float[source]#
Depth where unlabelled array of PAR reaches some threshold value (closest point)
The closest level in the vertical axis for which PAR is about a
thresholdvalue, with some tolerance.See
xarray.Dataset.argo.optic.Z_iPAR_thresholdfor more details on the methodology.- Parameters:
axis (array_like, 1 dimensional) β Vertical axis values, pressure or depth, positive, increasing downward, typically from the
PRESparameter of an Argo float.par (array_like, 1 dimensional) β Photosynthetically available radiation, typically from the
DOWNWELLING_PARparameter of an Argo float.threshold (float, optional, default: 15.) β Target value for
par. We use 15 as the default because it is the theoretical value below which the Fchla is no longer quenched (For correction of NPQ purposes).tolerance (float, optional, default: 5.) β PAR value tolerance with regard to the target threshold. If the closest PAR value to
thresholdis distant by more thantolerance, consider result invalid and return NaN.
- Return type: