lime_tbx.application.simulation.comparison.utils module

This module abstracts and encapsulates utilities related to performing and showing comparisons between user measurements and the model output.

It exports the following methods:

• average_comparisons - Returns a ComparisonData based on the average

  of a list of ComparisonData, now classified by channel.

• sort_by_mpa - Returns a copy of the given list of ComparisonData

  but sorted by moon phase angle.

lime_tbx.application.simulation.comparison.utils.average_comparisons(wlens: List[float], comps: List[ComparisonData]) → ComparisonData

Returns a ComparisonData based on the average of a list of ComparisonData, now classified by channel.

Parameters:

comparisons (list of ComparisonData) – List of ComparisonData that will be merged and averaged.

Returns:

avg_comparison – ComparisonData based on the average data of the given comparisons.

Return type:

ComparisonData

lime_tbx.application.simulation.comparison.utils.sort_by_mpa(comparisons: List[ComparisonData]) → List[ComparisonData]

Returns a copy of the given list of ComparisonData but sorted by moon phase angle.

Parameters:

comparisons (list of ComparisonData) – List of ComparisonData that will be sorted by mpa.

Returns:

sorted_comparisons – List with the same ComparisonData instances but sorted by the moon phase angle.

Return type:

list of ComparisonData