Skip to content

Commit 28d2184

Browse files
CellKaiehrenfeu
authored andcommitted
Increase docstring readability
1 parent 7a3a8f5 commit 28d2184

1 file changed

Lines changed: 11 additions & 7 deletions

File tree

src/imcflibs/imagej/projections.py

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -108,23 +108,27 @@ def create_and_save(imp, projections, path, filename, export_format):
108108

109109

110110
def project_stack(imp, projected_dimension, projection_type, ops, ds, cs):
111-
"""
112-
Project a multi-dimensional dataset along a specified axis using a specified projection type.
111+
"""Project along a defined axis using the given projection type.
113112
114113
Parameters
115114
----------
116115
imp : ImagePlus
117116
The input image to be projected.
118117
projected_dimension : str
119-
The dimension along which to project the data. Must be one of {"X", "Y", "Z", "TIME", "CHANNEL"}.
118+
The dimension along which to project the data. Must be one of {"X", "Y", "Z",
119+
"TIME", "CHANNEL"}.
120120
projection_type : str
121-
The type of projection to perform. Must be one of {"Max", "Mean", "Median", "Min", "StdDev", "Sum"}.
121+
The type of projection to perform. Must be one of {"Max", "Mean", "Median",
122+
"Min", "StdDev", "Sum"}.
122123
ops : OpService
123-
The service used to access image processing operations. Use e.g. from script parameter: #@ OpService ops
124+
The service used to access image processing operations. Use e.g. from script
125+
parameter: `#@ OpService ops`
124126
ds : DatasetService
125-
The service used to create new datasets. Use e.g. from script parameter: #@ DatasetService ds
127+
The service used to create new datasets. Use e.g. from script parameter:
128+
`#@ DatasetService ds`
126129
cs : ConvertService
127-
The service used to convert between formats. Use e.g. from script parameter: #@ ConvertService cs
130+
The service used to convert between formats. Use e.g. from script parameter:
131+
`#@ ConvertService cs`
128132
129133
Returns
130134
-------

0 commit comments

Comments
 (0)