lime_tbx.business.lime_algorithms.dolp.dolp module

This module calculates the extra-terrestrial lunar disk degree of polarisation.

It exports the following classes:

  • IDOLP - Interface that contains the methods of this module.

  • DOLP - Class that implements the methods exported by this module.

It follows equations described in the following documents: - Lunar irradiance model algorithm and theoretical basis document D7.

class lime_tbx.business.lime_algorithms.dolp.dolp.DOLP[source]

Bases: IDOLP

get_polarized(mpa_degrees: float, coefficients: PolarisationCoefficients, skip_uncs: bool = False) → SpectralData[source]

Calculation of the degree of linear polarisation.

Parameters:

  • mpa_degrees (float) – Moon phase angle in degrees.

  • coefficients (PolarisationCoefficients) – Coefficients needed in the dolp algorithm

  • skip_uncs (bool) – Flag for skipping the calculation of uncertainties.

Returns:

polarisations – List with the degrees of polarisation for each given wavelength.

Return type:

SpectralData

class lime_tbx.business.lime_algorithms.dolp.dolp.IDOLP[source]

Bases: ABC

Interface that contains the methods of this module.

It exports the following functions:
  • get_polarized: Calculates the extra-terrestrial lunar polarisation in fractions of unity for some

    given parameters.

abstract get_polarized(mpa_degrees: float, coefficients: PolarisationCoefficients, skip_uncs: bool = False) → SpectralData[source]

Calculation of the degree of linear polarisation.

Parameters:

  • mpa_degrees (float) – Moon phase angle in degrees.

  • coefficients (PolarisationCoefficients) – Coefficients needed in the dolp algorithm

  • skip_uncs (bool) – Flag for skipping the calculation of uncertainties.

Returns:

polarisations – SpectralData with the degrees of polarisation for each given wavelength.

Return type:

SpectralData