@@ -693,19 +693,18 @@ def run_imarisconvert(file_path, pixel_calibration=None, output_folder=""):
693693 file_path : str
694694 Absolute path to the input image file.
695695 pixel_calibration : tuple or list, optional
696- Sequence of 3 values (x, y, z) representing voxel dimensions to be set during
697- conversion, by default None.
696+ Sequence of 3 values (x, y, z) representing voxel dimensions to be set
697+ during conversion, by default None.
698698 output_folder : str, optional
699- Folder where the newly created IMS file will be saved, by default None
700- which will result in the output file being saved in the same directory as the input file.
699+ Folder where the newly created IMS file will be saved. If empty (or not
700+ supplied), the directory of the input file will be used .
701701
702702 Notes
703703 -----
704- - The output filename is constructed by taking the input filename and
705- replacing its extension with `.ims` (for example,
706- `/path/to/image.czi` -> `/path/to/image.ims`).
704+ - The output filename is constructed by replacing extension of the input
705+ filename with `.ims` (e.g. `/path/to/image.czi` -> `/path/to/image.ims`).
707706 - If the input has an `.ids` extension (part of an ICS-1 pair), the
708- corresponding `.ics` file is used as the source before conversion .
707+ corresponding `.ics` file is used instead .
709708 """
710709 # in case the given file has the suffix `.ids` (meaning it is part of an
711710 # ICS-1 `.ics`+`.ids` pair), point ImarisConvert to the `.ics` file instead:
0 commit comments