glidertools.optics.quenching_report

glidertools.optics.quenching_report(flr, flr_corrected, quenching_layer, dives, depth, pcolor_kwargs={})

A report for the results of optics.quenching_correction.

The function creates a figure object of 3 subplots containing a pcolormesh of the original fluorescence data, the quenching corrected fluorescence data and the quenching layer calculated from the optics.quenching_correction function.

Parameters:

  • flr (numpy.ndarray or pandas.Series) – Fluorescence data after cleaning and factory calibration conversion.

  • flr_corrected (numpy.ndarray or pandas.Series) – The fluorescence data corrected for quenching.

  • layer (quenching) – A boolean mask of where the fluorescence is quenched.

  • dives (numpy.ndarray or pandas.Series) – The dive count (round is down dives, 0.5 is up dives).

  • depth (numpy.ndarray or pandas.Series) – The depth array in metres.

  • pcolor_kwargs (dict) – A dictionary of keyword arguements passed to pcolormesh.

Returns:

figure – Creates a figure object with 3 subplots containing a pcolormesh of the original fluorescence data, the quenching corrected fluorescence data and the quenching layer calculated from the optics.quenching_correction function.

Return type:

object