Baselines

The satrain.baselines module provides baseline precipitation retrieval algorithms for comparison and benchmarking purposes.

satrain.baselines

This module provides access to results from baseline retrievals.

get_ranked_results(base_sensor: str, metrics: list[str]) → pd.Dataframe

Loads baseline results in a pd.Dataframe sorted by their average rank across domains.

Parameters:

• base_sensor – The name of the base sensor (‘gmi’ or ‘atms’).

• metrics – The names of the metrics to load.

Returns:

A long-form pandas dataframe holding the baseline results.

load_baseline_results(base_sensor: str, domain: str = 'conus', baselines: List[str] | None = None) → Dataset

Load baseline results.

Parameters:

baselines – An optional list containing the baseline names to load. If not givne, results from all baselines are loaded.

Returns:

An xarray.Dataset containing the merged baseline results.

plot_baselines_interactive(results: pd.Dataframe, add_menu: bool = True) → plotly.Figure

Visualizes baseline results using plotly for interactive display on the web.

Parameters:

• results – A pandas long-form Dataframe holding the results to display.

• add_menu – If ‘True’, a menu is added to subset the displayed algorithms.

Returns:

The plotly figure object.