labcore.analysis.analysis_base#

Classes

DatasetAnalysis(datafolder, name[, ...])

Exceptions

AnalysisExistsError

exception labcore.analysis.analysis_base.AnalysisExistsError[source]#

Bases: Exception

class labcore.analysis.analysis_base.DatasetAnalysis(datafolder, name, analysisfolder='./analysis/', has_period_in_name=False, raise_on_earlier_analysis=None)[source]#

Bases: object

add(**kwargs: Any) → None[source]#
add_figure(name, *arg, fig: Figure | None = None, **kwargs) → Figure[source]#
figure_save_format = ['png', 'pdf']#
get_analysis_data_file(name: str, format=['json'])[source]#
has_analysis_data(name: str, format=['json'])[source]#
load_analysis_data(name: str, format=['json'])[source]#
load_metadata_from_json(file_name, key)[source]#

Load a parameter from a metadata json file

Parameters:

  • file_name – file name inside the data directory.

  • key – which entry from the file we should get. only top-level keys supported currently.

Return type:

the requested data.

Raises:

ValueError – if requested data is not present in the file.

load_saved_parameter(parameter_name, parameter_manager_name='parameter_manager', file_name='parameters.json')[source]#
static load_table(path)[source]#
make_figure(name, *arg, fig: Figure | None = None, **kwargs) → Figure#
raise_on_earlier_analysis = None#
save()[source]#
save_da(data: DataArray, name: str, folder: Path) → Path[source]#
save_df(data: DataFrame, name: str, folder: Path) → Path[source]#
save_dict_data(data: dict, name: str, folder: Path) → Path[source]#
save_ds(data: Dataset, name: str, folder: Path) → Path[source]#
save_hv_plot(plot: Dimensioned, name: str, folder: Path) → Path[source]#

save a hvplot in a standard way to the dataset directory.

Parameters:

  • plot – the hvplot instance

  • name – name to give the figure

  • fmt – file format (defaults to png)

Return type:

Path of the saved file.

save_mpl_figure(fig: Figure, name: str, folder: Path) → List[Path][source]#

save a figure in a standard way to the dataset directory.

Parameters:

  • fig – the figure instance

  • name – name to give the figure

  • fmt – file format (defaults to png)

Return type:

A list of file paths where the figure was saved.

save_np(data: ndarray, name: str, folder: Path) → Path[source]#
save_pickle(data: Any, name: str, folder: Path) → Path[source]#
save_str(data: str, name: str, folder: Path) → Path[source]#
to_table(name, data: Dict[str, Any])[source]#