lime_tbx.application.simulation.comparison.comparison module

This module abstracts and encapsulates use-cases related to performing comparisons between user measurements and the model output.

It exports the following classes:

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

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

class lime_tbx.application.simulation.comparison.comparison.Comparison(kernels_path: KernelsPath)[source]

Bases: IComparison

get_simulations(observations: List[LunarObservation], srf: SpectralResponseFunction, coefficients: ReflectanceCoefficients, lime_simulation: ILimeSimulation, callback_observation: Callable | None = None) → List[ComparisonData][source]

Obtain a list of comparison data for the given observation scenarios, each element corresponding to the comparisons of one channel.

Parameters:

  • observations (list of LunarObservations) – LunarObservations read from a GLOD datafile.

  • srf (SpectralResponseFunction) – SpectralResponseFunction that is used.

  • coefficients (ReflectanceCoefficients) – Coefficients to be used.

  • lime_simulation (ILimeSimulation) – Lime simulation instance, storing the current state of the simulation.

  • callback_observation (Callable) – Function that will be called once for every observation when simulated.

Returns:

comparisons – List of ComparisonData, each element corresponding to the comparisons of one channel.

Return type:

list of ComparisonData

class lime_tbx.application.simulation.comparison.comparison.IComparison[source]

Bases: ABC

Interface that contains the methods of this module.

It exports the following functions:

  • get_simulations - Simulate the moon irradiance for the given scenarios.

abstract get_simulations(observations: List[LunarObservation], srf: SpectralResponseFunction, coefficients: ReflectanceCoefficients, lime_simulation: ILimeSimulation, callback_observation: Callable | None = None) → List[ComparisonData][source]

Obtain a list of comparison data for the given observation scenarios, each element corresponding to the comparisons of one channel.

Parameters:

  • observations (list of LunarObservations) – LunarObservations read from a GLOD datafile.

  • srf (SpectralResponseFunction) – SpectralResponseFunction that is used.

  • coefficients (ReflectanceCoefficients) – Coefficients to be used.

  • lime_simulation (ILimeSimulation) – Lime simulation instance, storing the current state of the simulation.

  • callback_observation (Callable) – Function that will be called once for every observation when simulated.

Returns:

comparisons – List of ComparisonData, each element corresponding to the comparisons of one channel.

Return type:

list of ComparisonData