Skip to content

Commit 08d9976

Browse files
committed
feat(run_imarisconvert): enhance output folder handling
- Add notes on output folder behavior in docstring. - Specify that if no output folder is provided, the IMS file will be saved in the input file's directory. - Clarify output filename construction from input filename.
1 parent 6125595 commit 08d9976

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

src/imcflibs/imagej/misc.py

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -685,6 +685,16 @@ def run_imarisconvert(file_path, pixel_calibration=None, output_folder=""):
685685
conversion, by default None.
686686
output_folder : str, optional
687687
Folder where the newly created IMS file will be saved, by default None.
688+
689+
Notes
690+
-----
691+
- If `output_folder` is not provided (or is empty), the converted `.ims`
692+
file will be written to the same directory as the input file.
693+
- The output filename is constructed by taking the input filename and
694+
replacing its extension with `.ims` (for example,
695+
`/path/to/image.czi` -> `/path/to/image.ims`).
696+
- If the input has an `.ids` extension (part of an ICS-1 pair), the
697+
corresponding `.ics` file is used as the source before conversion.
688698
"""
689699
# in case the given file has the suffix `.ids` (meaning it is part of an
690700
# ICS-1 `.ics`+`.ids` pair), point ImarisConvert to the `.ics` file instead:

0 commit comments

Comments
 (0)