DataSelection API Reference

geoloop.plotting.load_data.DataSelection

A class to select datasets required for plotting. It stores subsets of simulation input parameters and simulation results for the different plot types.

Attributes:

Name	Type	Description
crossplot_params_df	pd.DataFrame or list of pd.DataFrame	DataFrame (or list of DataFrames) of simulation input parameters for the cross-plots.
crossplot_results_df	pd.DataFrame or list of pd.DataFrame	DataFrame (or list of DataFrames) of simulation results for the cross-plots.
timeplot_results_df	pd.DataFrame or list of pd.DataFrame	DataFrame (or list of DataFrames) of simulation results for the time-plots.
depthplot_params_ds	xarray.Dataset or list of xarray.Dataset	Datasets (or list of Datasets) of simulation input parameters for the depth-plots.
depthplot_results_ds	xarray.Dataset or list of xarray.Dataset	Datasets (or list of Datasets) of simulation results for the depth-plots.

select_sub_datasets classmethod

select_sub_datasets(
    plotinput: PlotInput, datatotal: DataTotal
) -> DataSelection

Selects and aggregates subsets of datasets for plotting, based on PlotInput settings.

Parameters:

Name	Type	Description	Default
plotinput	PlotInput	Plotting configuration.	required
datatotal	DataTotal	Object containing simulation datasets (including simulation results and input parameters).	required

Returns:

Type	Description
DataSelection	Object containing selected subsets of datasets ready for plotting.