/
PIV_3D_test.py
251 lines (204 loc) · 9.79 KB
/
PIV_3D_test.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
# by Andreas Bauer, 19.06.2020
# This script contains a series of tests for 3D-PIV: The shift of a bar in one direction, the expansion of a 3D block
# and a real data set where we recorded two stacks of collagen fibres at the same field of view with confocal microscopy
# in reflection mode. One stack contains a NK cell that deforms the matrix and the other doe not.
# Please download the data at https://github.com/fabrylab/3D_piv_example_data.git (180 MB, unpacked) and provide the
# folder in the code below.
# We tested this on ubuntu 16 and 18, with Anaconda Python installation. The whole script
# takes about 5 minutes on my 4 core-intel i5 @2.5 GHz Laptop. You should have !!! 8 Gb ob Memory !!!! or take care not
# to open all matplotlib plots as interactive windows at once.
# For questions contact andreas.b.bauer@fau.de
from openpiv.pyprocess3D import *
from openpiv.PIV_3D_plotting import *
from openpiv.validation import sig2noise_val
from openpiv.filters import replace_nans_py, replace_outliers
import time
import glob as glob
import os
from natsort import natsorted
import matplotlib.animation as animation
# Make save_plots = True if you want to compare the
# visual results
save_plots = False
out_put_folder = "output_3D_test"
if save_plots:
if not os.path.exists(out_put_folder):
try:
os.mkdir(out_put_folder)
except:
print("could not generate output folder")
save_plots = False
############# a bar sifted by 1 pixel to the right the second frame #############
# takes ~4 seconds
size = (16, 16, 16)
shape1 = np.zeros(size)
shape2 = np.zeros(size)
shape1[5, 3:10, 5] = 1
shape2[5, 4:11, 5] = 1
window_size = (5, 5, 5)
overlap = (4, 4, 4)
search_area = (5, 5, 5)
u, v, w, sig2noise = extended_search_area_piv3D(shape1, shape2, window_size=window_size, overlap=overlap,
search_area_size=search_area, subpixel_method='gaussian',
sig2noise_method='peak2peak', corr_method="fft",
width=2)
# displaying the shapes with 3D scatter plot
fig1 = scatter_3D(shape1, control="size")
fig2 = scatter_3D(shape2, control="size")
# 3d plot of the signal-to-noise rations
fig3 = scatter_3D(sig2noise, control="size")
# 3d quiver plot of the displacement field
fig4 = quiver_3D(-u, v, w)
# saving the plots
if save_plots:
fig1.savefig(os.path.join(out_put_folder, "displaced_bar_frame1.png"))
fig2.savefig(os.path.join(out_put_folder, "displaced_bar_frame2.png"))
fig3.savefig(os.path.join(out_put_folder, "displaced_bar_sig2noise.png"))
fig4.savefig(os.path.join(out_put_folder, "displaced_bar_deformation_field.png"))
############# a square that is expanded by 2 pixels ################
# takes ~4 seconds
center = 16
size = (32, 32, 32)
d1 = 4
d2 = 6
shape1 = np.zeros(size)
shape1[center - d1:center + d1, center - d1:center + d1, center - d1:center + d1] = 1
shape2 = np.zeros(size)
shape2[center - d2:center + d2, center - d2:center + d2, center - d2:center + d2] = 1
window_size = (5, 5, 5)
overlap = (4, 4, 4)
search_area = (5, 5, 5)
u, v, w, sig2noise = extended_search_area_piv3D(shape1, shape2, window_size=window_size, overlap=overlap,
search_area_size=search_area, subpixel_method='gaussian',
sig2noise_method='peak2peak', corr_method="fft",
width=2)
# displaying the shapes with 3D scatter plot
fig5 = scatter_3D(shape1, control="size")
fig6 = scatter_3D(shape2, control="size")
# 3d plot of the signal-to-noise rations
fig7 = scatter_3D(sig2noise, control="size")
# 3d quiver plot of the displacement field
fig8 = quiver_3D(-u, v, w)
# saving the plots
if save_plots:
fig5.savefig(os.path.join(out_put_folder, "expanded_box_frame1.png"))
fig6.savefig(os.path.join(out_put_folder, "expanded_box_frame2.png"))
fig7.savefig(os.path.join(out_put_folder, "expanded_box_sig2noise.png"))
fig8.savefig(os.path.join(out_put_folder, "expanded_box_deformation_field.png"))
#################### test to check the replace_nans_function ######################
# takes ~4 seconds
# ball shape with a gap of nans in the middle
center = (5, 5, 5)
size = (10, 10, 10)
distance = np.linalg.norm(np.subtract(np.indices(size).T, np.asarray(center)), axis=len(center))
arr = np.ones(size) * (distance <= 5)
hide = arr == 0
arr[5:7] = np.nan
# displaying in 3d plots. Values outside of the original ball are hidden by setting to nan
arr_show = arr.copy()
arr_show[hide] = np.nan
fig9 = scatter_3D(arr_show, size=50, sca_args={"alpha": 0.6})
# replacing outliers
arr = replace_nans_py(arr, max_iter=2, tol=2, kernel_size=2, method='disk')
# displaying in 3d plots. Values outside of the original ball are hidden by setting to nan
arr_show = arr.copy()
arr_show[hide] = np.nan
fig10 = scatter_3D(arr_show, size=50, sca_args={"alpha": 0.6})
# saving the plots
if save_plots:
fig9.savefig(os.path.join(out_put_folder, "replace_nan_gap.png"))
fig10.savefig(os.path.join(out_put_folder, "replace_nan_filled.png"))
##################### real data example ############################
# we recorded stacks of collagen fibres with confocal microscopy in reflection mode
# "alive" stack contains a force generating NK-cell, marked by the red circle in the animation
# "relaxed" stack is the same field of view with out the cell
# download the data at https://github.com/fabrylab/3D_piv_example_data.git
# this calculation takes takes ~ 3-4 minutes on my 4-core Intel i5@2.5 GHz Laptop
### plese enter the path to the dataset provided at
folder = r"test_3d"
if not os.path.exists(folder):
import git
repo = git.Repo.clone_from("https://github.com/fabrylab/3D_piv_example_data.git", './test_3d', branch='master')
if not os.path.exists(folder):
raise FileNotFoundError("path to 3d piv data '%s' does not exists\n"
". Please download the data from https://github.com/fabrylab/3D_piv_example_data.git" % folder)
# stack properties
# factors for voxel size
du = 0.2407
dv = 0.2407
dw = 1.0071
# total image dimension for x y z
image_dim = (123.02, 123.02, 122.86)
# keep these values for our nk cells stacks
win_um = 12 # window size in µm
fac_overlap = 0.3 # overlap in percent of the window size
signoise_filter = 1.3
# window size for stacks in pixel
window_size = (int(win_um / du), int(win_um / dv), int(win_um / dw))
overlap = (int(fac_overlap * win_um / du), int(fac_overlap * win_um / dv), int(fac_overlap * win_um / dw))
search_area = (int(win_um / du), int(win_um / dv), int(win_um / dw))
# load tense stacks
images = natsorted(glob.glob(os.path.join(folder, "Series001_t22_z*_ch00.tif")))
im_shape = plt.imread(images[0]).shape
alive = np.zeros((im_shape[0], im_shape[1], len(images)))
for i, im in enumerate(images):
alive[:, :, i] = plt.imread(im)
# load relaxed stack
images = natsorted(glob.glob(os.path.join(folder, "Series003_t05_z*_ch00.tif")))
im_shape = plt.imread(images[0]).shape
relax = np.zeros((im_shape[0], im_shape[1], len(images)))
for i, im in enumerate(images):
relax[:, :, i] = plt.imread(im)
# 3D PIV
u, v, w, sig2noise = extended_search_area_piv3D(alive, relax, window_size=window_size, overlap=overlap,
search_area_size=search_area, dt=(1 / du, 1 / dv, 1 / dw),
subpixel_method='gaussian',
sig2noise_method='peak2peak',
width=2)
# correcting stage drift between the field of views
u -= np.nanmean(u)
v -= np.nanmean(v)
w -= np.nanmean(w)
# filtering
uf, vf, wf, mask = sig2noise_val(u, v, w=w, sig2noise=sig2noise, threshold=signoise_filter)
uf, vf, wf = replace_outliers(uf, vf, wf, max_iter=1, tol=100, kernel_size=2, method='disk')
# plotting
# representation of the image stacks by maximums projections. The red circle marks the position of the cell
def update_plot(i, ims, ax):
a1 = ax.imshow(ims[i])
a2 = ax.add_patch(plt.Circle((330, 140), 100, color="red", fill=False))
return [a1, a2]
ims = [np.max(relax[:, :, 60:], axis=2), np.max(alive[:, :, 60:], axis=2)]
fig = plt.figure()
ax = plt.gca()
ani = animation.FuncAnimation(fig, update_plot, 2, interval=50, blit=True, repeat_delay=0, fargs=(ims, ax))
# unfiltered 3d deformation field
fig11 = quiver_3D(-u, v, w, image_dim=image_dim, quiv_args={"length": 20, "alpha": 0.5, "linewidth": 2}, filter_def=0.1)
# filtered 3d deformation field
fig12 = quiver_3D(-uf, vf, wf, image_dim=image_dim, quiv_args={"length": 20, "alpha": 0.5, "linewidth": 2},
filter_def=0.1)
# saving the plots
if save_plots:
fig11.savefig(os.path.join(out_put_folder, "real_data_unfiltered.png"))
fig12.savefig(os.path.join(out_put_folder, "real_data_filtered.png"))
# This needs a working ImageMagick installation, and probably works only on linux
try:
import imageio
plt.ioff()
f1 = plt.figure()
plt.imshow(ims[0])
plt.gca().add_artist(plt.Circle((330, 140), 100, color="red", fill=False))
f1.savefig(os.path.join(out_put_folder,"tem1.png"))
f2 = plt.figure()
plt.imshow(ims[1])
plt.gca().add_artist(plt.Circle((330, 140), 100, color="red", fill=False))
f2.savefig(os.path.join(out_put_folder,"tem2.png"))
i1 = plt.imread(os.path.join(out_put_folder,"tem1.png"))
i2 = plt.imread(os.path.join(out_put_folder, "tem2.png"))
imageio.mimsave(os.path.join(out_put_folder, "reaL_data_max_proj.gif"),[i1,i2])
os.remove(os.path.join(out_put_folder,"tem1.png"))
os.remove(os.path.join(out_put_folder,"tem2.png"))
plt.ion()
except Exception as e:
print ("failed to write gif of collagen embedded cell:")
print(e)