Skip to content

Commit be310a5

Browse files
committed
fix load_h5jpk docstring
1 parent 1aa8960 commit be310a5

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

AFMReader/h5_jpk.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -286,12 +286,13 @@ def load_h5jpk(
286286
287287
Returns
288288
-------
289-
tuple of (np.ndarray, float, dict of str: float)
290-
A tuple containing:
291-
- 3D image stack (num_frames, height, width) in nanometres (if applicable),
292-
- Pixel-to-nanometre scaling factor (float),
293-
- Dictionary mapping "frame N" to timestamp in seconds.
294-
289+
image : np.ndarray
290+
3D array of shape (frames, height, width) with image data.
291+
pixel_to_nm_scaling : float
292+
Scaling factor converting pixels to nanometers.
293+
timestamps : dict[str, float]
294+
Dictionary mapping frame labels (e.g., "frame 0") to timestamp values in seconds.
295+
295296
Raises
296297
------
297298
FileNotFoundError

0 commit comments

Comments
 (0)