Skip to content

Commit 98cfaff

Browse files
committed
Reformat dict in Returns section
Tries to address the issue discussed in #49 (comment)
1 parent 047d913 commit 98cfaff

1 file changed

Lines changed: 15 additions & 25 deletions

File tree

src/imcflibs/imagej/bioformats.py

Lines changed: 15 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -368,31 +368,21 @@ def get_stage_coords(source, filenames):
368368
Returns
369369
-------
370370
dict
371-
A dictionary containing the following metadata:
372-
- `dimensions` : int
373-
Number of dimensions (2D or 3D)
374-
- `stage_coordinates_x` : list
375-
The absolute stage x-coordinated
376-
- `stage_coordinates_y` : list
377-
The absolute stage y-coordinated
378-
- `stage_coordinates_z` : list
379-
The absolute stage z-coordinated
380-
- `relative_coordinates_x` : list
381-
The relative stage x-coordinates in px
382-
- `relative_coordinates_y` : list
383-
The relative stage y-coordinates in px
384-
- `relative_coordinates_z` : list
385-
The relative stage z-coordinates in px
386-
- `image_calibration` : list
387-
x,y,z image calibration in unit/px
388-
- `calibration_unit` : str
389-
Image calibration unit
390-
- `image_dimensions_czt` : list
391-
Number of images in dimensions c,z,t
392-
- `series_names` : list of str
393-
Names of all series contained in the files
394-
- `max_size` : list of int
395-
Maximum size across all files in dimensions x,y,z
371+
372+
{
373+
dimensions : int, # number of dimensions (2D or 3D)
374+
stage_coordinates_x : list, # absolute stage x-coordinated
375+
stage_coordinates_y : list, # absolute stage y-coordinated
376+
stage_coordinates_z : list, # absolute stage z-coordinated
377+
relative_coordinates_x : list, # relative stage x-coordinates in px
378+
relative_coordinates_y : list, # relative stage y-coordinates in px
379+
relative_coordinates_z : list, # relative stage z-coordinates in px
380+
image_calibration : list, # x,y,z image calibration in unit/px
381+
calibration_unit : str, # image calibration unit
382+
image_dimensions_czt : list, # number of images in dimensions c,z,t
383+
series_names : list of str, # names of all series in the files
384+
max_size : list of int, # max size (x/y/z) across all files
385+
}
396386
"""
397387

398388
# open an array to store the abosolute stage coordinates from metadata

0 commit comments

Comments
 (0)