labcore.analysis.analysis_base

Classes

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

Exceptions

AnalysisExistsError

exception labcore.analysis.analysis_base.AnalysisExistsError

Bases: Exception

class labcore.analysis.analysis_base.DatasetAnalysis(datafolder: str | Path, name: str, analysisfolder: str | Path = './analysis/', has_period_in_name: bool = False, raise_on_earlier_analysis: Any = None)

Bases: object

add(**kwargs: Any) → None

add_figure(name: str, *arg: Any, fig: Figure | None = None, **kwargs: Any) → Figure

figure_save_format = ['png', 'pdf']

get_analysis_data_file(name: str, format: List[str] = ['json']) → Path

has_analysis_data(name: str, format: List[str] = ['json']) → bool

load_analysis_data(name: str, format: List[str] = ['json']) → Any

load_metadata_from_json(file_name: str, key: str) → Any

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: str, parameter_manager_name: str = 'parameter_manager', file_name: str = 'parameters.json') → Any

static load_table(path: str | Path) → DataFrame

make_figure(name: str, *arg: Any, fig: Figure | None = None, **kwargs: Any) → Figure

raise_on_earlier_analysis = None

save() → None

save_da(data: DataArray, name: str, folder: Path) → Path

save_df(data: DataFrame, name: str, folder: Path) → Path

save_dict_data(data: dict, name: str, folder: Path) → Path

save_ds(data: Dataset, name: str, folder: Path) → Path

save_hv_plot(plot: Dimensioned, name: str, folder: Path) → Path

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]

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 | int | float | complex, name: str, folder: Path) → Path

save_pickle(data: object, name: str, folder: Path) → Path

save_str(data: str, name: str, folder: Path) → Path

to_table(name: str, data: Dict[str, Any]) → None