Skip to content

Commit 3a13825

Browse files
committed
added description to volume_reader
1 parent 3569d4f commit 3a13825

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

synaptic_reconstruction/tools/volume_reader.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,13 @@ def read_image_volume(path: PathOrPaths) -> List[LayerData]:
7575

7676

7777
def read_voxel_size(input_path: str, layer_attributes: dict) -> None:
78-
"""_summary_
78+
"""Read voxel size from mrc/rec file and store it in layer_attributes.
79+
The original unit of voxel size is Angstrom and we convert it to nanometers
80+
by dividing it by ten.
7981
8082
Args:
81-
input_path (str): _description_
82-
layer_attributes (dict): _description_
83+
input_path (str): path to mrc/rec file
84+
layer_attributes (dict): napari layer attributes to store voxel size to
8385
"""
8486
with mrcfile.open(input_path, permissive=True) as mrc:
8587
try:

0 commit comments

Comments
 (0)