Skip to content

Commit 6e7bdfe

Browse files
committed
docs(bdv): update usage examples for fuse_dataset_bdvp function
- Added typical usage examples in doctest style - Included two examples demonstrating basic and explicit options
1 parent ee68e96 commit 6e7bdfe

1 file changed

Lines changed: 29 additions & 1 deletion

File tree

src/imcflibs/imagej/bdv.py

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1656,7 +1656,35 @@ def fuse_dataset_bdvp(
16561656
16571657
Examples
16581658
--------
1659-
fuse_dataset_bdvp(xml_input, cs)
1659+
Typical usage examples (doctest-style):
1660+
1661+
Example 1 - basic export using a CommandService instance available as
1662+
``command``::
1663+
1664+
>>> #@ CommandService command
1665+
>>> xml_input = "/path/to/project.xml"
1666+
>>> # run with default options, output placed next to the input xml
1667+
>>> fuse_dataset_bdvp(xml_input, command)
1668+
1669+
Example 2 - explicit options (custom output path, specific channels,
1670+
no interpolation, override z ratio)::
1671+
1672+
>>> #@ CommandService command
1673+
>>> xml_input = "/path/to/project.xml"
1674+
>>> out_dir = "/path/to/output_dir"
1675+
>>> fuse_dataset_bdvp(
1676+
... xml_input,
1677+
... command,
1678+
... result_path=out_dir,
1679+
... fusion_method="SMOOTH AVERAGE",
1680+
... range_channels="0-1",
1681+
... n_resolution_levels=4,
1682+
... use_lzw_compression=False,
1683+
... split_channels=True,
1684+
... override_z_ratio=True,
1685+
... z_ratio=2.0,
1686+
... use_interpolation=False,
1687+
... )
16601688
"""
16611689

16621690
file_info = pathtools.parse_path(project_path)

0 commit comments

Comments
 (0)