ppcpy.qc.overlapEst#

Functions

load

read the overlap function from files into a structure similar to the others

overlapCalc

Calculate overlap function.

overlapCalcRaman

Calculate overlap function from Polly measurements based on Wandinger and Ansmann 2002 https://doi.org/10.1364/AO.41.000511

run_frnr_cldFreeGrps

run_raman_cldFreeGrps

ppcpy.qc.overlapEst.run_frnr_cldFreeGrps(data_cube, collect_debug=True)[source]#
ppcpy.qc.overlapEst.overlapCalc(height, sigFR, bgFR, sigNR, bgNR, hFullOverlap=600)[source]#

Calculate overlap function.

Parameters:

  • height (ndarray) – Height above ground (m).

  • sigFR (ndarray) – Far-field signal (photon count).

  • bgFR (ndarray) – Background of far-field signal (photon count).

  • sigNR (ndarray) – Near-field signal (photon count).

  • bgNR (ndarray) – Background of near-field signal (photon count).

  • hFullOverlap (float, optional) – Minimum height with full overlap for far-range signal (default: 600 m).

Returns:

  • overlap (ndarray) – Overlap function.

  • overlapStd (ndarray) – Standard deviation of overlap function.

  • sigRatio (float) – Signal ratio between near-range and far-range signals.

  • normRange (list) – Height index of the signal normalization range.

  • History

  • ——-

  • - 2021-05-18 (First edition by Zhenping)

ppcpy.qc.overlapEst.run_raman_cldFreeGrps(data_cube, collect_debug=True)[source]#
ppcpy.qc.overlapEst.overlapCalcRaman(Lambda_el, Lambda_Ra, height, sigFRel, sigFRRa, molExt, molBsc_r, molExt_r, aerBsc, hFullOverlap=600, smoothbins=1, AE=1, hres=150)[source]#

Calculate overlap function from Polly measurements based on Wandinger and Ansmann 2002 https://doi.org/10.1364/AO.41.000511

Parameters:

  • Lambda_el (float) – Elastic wavelength.

  • Lambda_Ra (float) – Raman wavelength.

  • height (ndarray) – Height above ground (m).

  • sigFRel (ndarray) – Far-field elastic signal.

  • sigFRRa (ndarray) – Far-field Raman signal.

  • bgFRel (ndarray) – Far-field elastic signal background.

  • bgFRRa (ndarray) – Far-field Raman signal background.

  • kwargs (dict) –

    Additional parameters: - hFullOverlap : float, optional

    Minimum height with complete overlap (default: 600).

    • aerBscndarray, optional

      Particle backscattering derived with the Raman method (m^-1).

    • AEfloat, optional

      Angström exponent.

    • smoothbinsint, optional

      Number of bins for smoothing (default: 1).

    • hresfloat, optional

      Instrument height resolution.

Returns:

  • olFunc (ndarray) – Overlap function.

  • olStd (float) – Standard deviation of overlap function.

  • olFunc0 (ndarray) – Overlap function with no smoothing.

  • History

  • ——-

  • - 2023-06-06 (First edition by Cristofer)

ppcpy.qc.overlapEst.load(data_cube)[source]#

read the overlap function from files into a structure similar to the others