tile_process
patchworks.tile_process(image: Union[da.Array, str, Path], fn: Callable[[np.ndarray], np.ndarray], *, tile_shape: Union[tuple[int, ...], Callable[[tuple, Any], tuple], str, None] = None, overlap: int = 16, channel: int | None = 0, level: int = 0, use_gpu: bool = False, max_workers: int | None = None, progress: bool = True, write_to: Union[str, Path, None] = None, output_component: str = 'labels', pyramid_levels: int = 5, pyramid_downscale: int = 2, sequential_labels: bool = False, skip_empty: bool = False, empty_threshold: float | None = None, stage_dir: Union[str, Path, None] = None, keep_stage: bool = False, log_file: Union[str, Path, bool, None] = None, verbose: bool = False, stitch: str = 'touch', iou_threshold: float = 0.5, resume: bool = False, gpus: 'int | Sequence[int | str] | None' = None, dry_run: bool = False, plan_sample: int = 0) -> Any
Apply fn to every tile of image and merge labels globally.
The core workhorse of patchworks. fn can be any callable that takes a
NumPy array and returns an integer label array of the same shape — Cellpose,
StarDist, Otsu threshold, your own model, anything.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
image
|
Array or str or Path
|
Dask array or path to an OME-ZARR store. |
required |
fn
|
Callable[[ndarray], ndarray]
|
|
required |
tile_shape
|
tuple of int, callable or str
|
Controls tiling before calling fn. Accepted values:
.. code-block:: python |
None
|
overlap
|
int
|
Voxels of overlap (halo) added to each tile before fn is called, so
objects near tile boundaries have enough spatial context to be
segmented correctly (Cellpose, StarDist, …). The halo is trimmed off
before merging — the output has the original shape. Defaults to Merging is always touching-label based: after the halo is trimmed, labels that touch across a tile boundary are merged into one object. |
16
|
channel
|
int
|
Channel index when image is a path. Ignored for arrays. |
0
|
level
|
int
|
Pyramid level when image is a path (0 = full resolution). |
0
|
use_gpu
|
bool
|
When |
False
|
max_workers
|
int
|
Cap the worker threads/processes used for staging and merging. |
None
|
progress
|
bool
|
Show progress bars for staging, the label write and the pyramid
(default |
True
|
write_to
|
str or Path
|
Explicit output zarr store path. Overrides the default behaviour: the
merged labels are written here as a single-resolution array named
|
None
|
output_component
|
str
|
Label name. The array inside |
'labels'
|
pyramid_levels
|
int
|
Number of resolution levels for the in-store label pyramid (only when
writing into the input |
5
|
pyramid_downscale
|
int
|
Per-level X/Y downsampling factor for that pyramid (Z is kept at full resolution). Default 2. |
2
|
sequential_labels
|
bool
|
Renumber merged labels to a contiguous |
False
|
skip_empty
|
bool
|
Skip fn on background tiles. A tile whose max signal is <=
|
False
|
empty_threshold
|
float
|
Intensity at or below which a tile is empty ( |
None
|
stage_dir
|
str or Path
|
Where to put the temporary stage store. |
None
|
keep_stage
|
bool
|
Keep the temp stage store after merging (default: delete it, also when the run fails). Its path is logged. Useful for debugging. |
False
|
log_file
|
str or Path or bool
|
Where to tee the |
None
|
verbose
|
bool
|
Log each tile's location and shape as it is processed. |
False
|
stitch
|
str
|
How labels are joined across tile boundaries. |
'touch'
|
iou_threshold
|
float
|
Minimum IoU for |
0.5
|
resume
|
bool
|
Make an interrupted run resumable: tiles are staged into a store
named after this run's inputs (image, tiling, overlap, |
False
|
dry_run
|
bool
|
Only plan: return a dict describing the run -- tile count and grid,
tiles with signal ( |
False
|
plan_sample
|
int
|
With |
0
|
gpus
|
int or sequence of int or str
|
Segment on several GPUs at once: an int (the first N devices, of
|
None
|
Returns:
| Type | Description |
|---|---|
Array
|
Globally relabeled array (int32) backed by the output zarr (the input
store's |
Examples:
Any threshold function:
>>> from skimage.filters import threshold_otsu
>>> from skimage.measure import label
>>>
>>> def my_fn(tile):
... return label(tile > threshold_otsu(tile)).astype("int32")
>>>
>>> result = tile_process("image.zarr", my_fn, write_to="labels.zarr")
Cellpose (via the plugin):
>>> from patchworks.plugins.cellpose import cellpose_fn
>>>
>>> fn = cellpose_fn("cyto3", gpu=True, diameter=30)
>>> result = tile_process(
... "image.zarr", fn,
... tile_shape=(1, 2048, 2048),
... overlap=20,
... write_to="labels.zarr",
... progress=True,
... )
StarDist:
>>> from stardist.models import StarDist2D
>>> model = StarDist2D.from_pretrained("2D_versatile_fluo")
>>>
>>> def stardist_fn(tile):
... norm = tile.astype("float32") / tile.max()
... labels, _ = model.predict_instances(norm)
... return labels.astype("int32")
>>>
>>> result = tile_process("image.zarr", stardist_fn,
... tile_shape=(1, 1024, 1024), overlap=32)
Write directly to zarr (no RAM accumulation):
Source code in src/patchworks/_core.py
818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 | |