diff --git a/src/f3dasm/_src/experimentdata/experimentsample.py b/src/f3dasm/_src/experimentdata/experimentsample.py index 3f8ba0be..c7973272 100644 --- a/src/f3dasm/_src/experimentdata/experimentsample.py +++ b/src/f3dasm/_src/experimentdata/experimentsample.py @@ -288,6 +288,18 @@ def _store_to_experimentdata(self, object: Any, name: str) -> None: def _experimentsample_factory( experiment_sample: np.ndarray | ExperimentSample | Dict) \ -> ExperimentSample: + """Factory function for the ExperimentSample class. + + Parameters + ---------- + experiment_sample : np.ndarray | ExperimentSample | Dict + The experiment sample to convert to an ExperimentSample. + + Returns + ------- + ExperimentSample + The converted experiment sample. + """ if isinstance(experiment_sample, np.ndarray): return ExperimentSample.from_numpy(experiment_sample)