/
functions_preprocessing.py
1000 lines (847 loc) · 39.9 KB
/
functions_preprocessing.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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
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
import numpy as np
from scipy.ndimage.measurements import label
import datetime
from scipy.signal import medfilt
from functions_misc import interp_trace
import cv2
import functions_plotting as fp
import functions_kinematic as fk
import matplotlib.pyplot as plt
from quicksect import IntervalNode, Interval
from functools import reduce
import pandas as pd
import csv
from json import loads
from sklearn.metrics.pairwise import euclidean_distances
def remove_nans(files, tar_columns):
"""Basic function for the removal of NaNs"""
# allocate memory for a per file list
perfile_array = np.zeros_like(files)
# for the mouse and the cricket columns
for idx, animal in enumerate([tar_columns[1]]):
# allocate a list to store the marked traces
marked_traces = []
col = animal[0]
# get the data
result = files[:, col].copy()
# remove the NaN regions
result[np.isnan(result) == 0] = 0
result[np.isnan(result)] = 1
# label the NaN positions
result, number_regions = label(result)
# run through the columns again
for idx2, col in enumerate(animal):
# copy the original vector
target_vector = files[:, col]
# for all the regions
for segment in range(2, number_regions + 1):
# get the edges of the labeled region
indexes = np.nonzero(result == segment)[0]
start = indexes[0] - 1
end = indexes[-1] + 1
# skip the segment if the end of the segment is also the end of the whole trace
if end == target_vector.shape:
continue
target_vector[result == segment] = np.interp(indexes, [start, end], target_vector[[start, end]])
perfile_array[:, idx * idx2 + idx2] = target_vector
return perfile_array
def trim_bounds(files, time, dates):
"""Based on rig specific heuristics, trim the trace"""
# # get the time
# time = [datetime.datetime.strptime(el[1][:-7], '%Y-%m-%dT%H:%M:%S.%f') for el in files]
# TODO: remove arbitrary thresholds
# define the arena left boundary (based on the date of the experiment to be retrocompatible)
if dates[0] > datetime.datetime(year=2019, month=11, day=10):
left_bound_mouse = 0
left_bound_cricket = 0
else:
left_bound_mouse = 110
left_bound_cricket = 100
# time = [(el - time[0]).total_seconds() for el in time] # print the frame rate
# print('Frame rate:' + str(1 / np.mean(np.diff(time))) + 'fps')
# # get just the coordinate data
# files = np.vstack(np.array([el[0] for el in files]))
# eliminate any pieces of the trace until the mouse track doesn't have NaNs
if sum(np.isnan(files[:, 0])) > 0:
nan_pointer = np.max(np.argwhere(np.isnan(files[:, 0])))
files = files[nan_pointer + 1:, :]
time = time[nan_pointer + 1:]
# eliminate any remaining pieces captured outside the arena
if sum(files[:, 0] < left_bound_mouse) > 0:
nan_pointer = np.max(np.argwhere(files[:, 0] < left_bound_mouse))
files = files[nan_pointer + 1:, :]
time = time[nan_pointer + 1:]
# same as above with the cricket
if sum(files[:, 2] < left_bound_cricket) > 0:
nan_pointer = np.max(np.argwhere(files[:, 2] < left_bound_cricket))
files = files[nan_pointer + 1:, :]
time = time[nan_pointer + 1:]
return files, time
def get_time(files):
"""Separate the Bonsai time and data"""
# get the time
dates = [datetime.datetime.strptime(el[1][:-7], '%Y-%m-%dT%H:%M:%S.%f') for el in files]
# convert to seconds
time = [(el - dates[0]).total_seconds() for el in dates]
# print the frame rate
print('Frame rate:' + str(1 / np.mean(np.diff(time))) + 'fps')
# get just the coordinate data
files = np.vstack(np.array([el[0] for el in files]))
return files, time, dates
def remove_discontinuities(files, tar_columns, max_step_euc):
"""Remove discontinuities in the trace via interpolation"""
# for the mouse and the cricket columns
for animal in tar_columns:
# allocate a list to store the marked traces
marked_traces = []
for idx, col in enumerate(animal):
# get the data
curr_data = files[:, col].copy()
# take the absolute derivative trace
result = np.absolute(np.diff(curr_data[:]))
result = np.hstack((0, result))
# append the result to the list
marked_traces.append(result)
# combine the marked traces and rebinarize
pre_result = []
for idx, el in enumerate(marked_traces[0]):
current_xy = np.array([el, marked_traces[1][idx]])
pre_result.append(np.sqrt(current_xy[0] ** 2 + current_xy[1] ** 2))
result = np.array(pre_result)
# kill the remaining NaNs
result[np.isnan(result)] = 0
result[result < max_step_euc] = 0
# label the relevant regions
result, number_regions = label(result)
# run through the columns again
for col in animal:
# copy the original vector
target_vector = files[:, col]
# for all the regions
for segment in range(2, number_regions + 1):
# get the edges of the labeled region
indexes = np.nonzero(result == segment)[0]
start = indexes[0] - 1
end = indexes[-1] + 1
# skip the segment if the end of the segment is also the end of the whole trace
if end == target_vector.shape:
continue
target_vector[result == segment] = np.interp(indexes, [start, end],
target_vector[[start, end]])
return target_vector
def median_discontinuities(files, tar_columns, kernel_size):
"""Use a median filter to remove discontinuities in the trace"""
# allocate memory for the output
filtered_traces = files.copy()
# for the mouse and the cricket columns
for column in tar_columns:
# # for the x or y coordinate
# for col in animal:
# filtered_traces[:, col] = medfilt(files[:, col], kernel_size=kernel_size)
filtered_traces[column] = medfilt(files[column], kernel_size=kernel_size)
return filtered_traces
def median_arima(files, tar_columns):
"""Use an ARIMA model to get rid of discontinuities"""
from statsmodels.tsa.arima_model import ARIMA
# # code to find parameters from
# # https://medium.com/swlh/a-brief-introduction-to-arima-and-sarima-modeling-in-python-87a58d375def
# import itertools
# # Grid Search
# p = d = q = range(0, 3) # p, d, and q can be either 0, 1, or 2
# pdq = list(itertools.product(p, d, q)) # gets all possible combinations of p, d, and q
# combs = {} # stores aic and order pairs
# aics = [] # stores aics
#
# # Grid Search continued
# for combination in pdq:
# try:
# model = ARIMA(files[tar_columns[0]], order=combination) # create all possible models
# model = model.fit()
# combs.update({model.aic: combination}) # store combinations
# aics.append(model.aic)
# except:
# continue
#
# best_aic = min(aics)
# parameters = combs[best_aic]
# TODO: finish? not sure if useful
# for all the involved columns
for col in tar_columns:
# get the data
data = files[col]
data_mean = np.nanmean(data)
data_std = np.nanstd(data)
# Model Creation and Forecasting
model = ARIMA(data, order=(1, 1, 2), missing='drop')
model = model.fit()
predicted_trace = model.predict()
files[col] = predicted_trace
# fp.plot_2d([[predicted_trace]])
# fp.show()
return files
def maintain_animals(in_traces, threshold, corners, ref_corners):
"""Prevent dissociation of the points within an animal"""
# copy the input
out_traces = in_traces.copy()
# if there is a cricket
if 'cricket_0_x' in in_traces.columns:
# get the distance between the cricket points
delta = fk.distance_calculation(in_traces.loc[:, ['cricket_0_x', 'cricket_0_y']].to_numpy(),
in_traces.loc[:, ['cricket_0_head_x', 'cricket_0_head_y']].to_numpy())
# convert the distance to cm
delta = delta*(np.abs(ref_corners[0][1] - ref_corners[1][1])/np.abs(corners[0][0] - corners[2][0]))
# # bring the vector to full length
# delta = np.concatenate(([0], delta), axis=0)
# turn nan into 0
delta[np.isnan(delta)] = 0
# get a vector with the threshold crossings
threshold_crossings = delta > threshold
# nan the points where the condition is not fullfilled
for col in ['cricket_0_x', 'cricket_0_y', 'cricket_0_head_x', 'cricket_0_head_y']:
out_traces.loc[threshold_crossings, col] = np.nan
# out_traces.loc[delta > threshold, 'cricket_0_head_x'] = np.nan
# out_traces.loc[delta > threshold, 'cricket_0_head_y'] = np.nan
# if there is a mouse
if 'mouse_x' in in_traces.columns:
# get a list of the columns with mouse in it that are not mouse_x
mouse_list = [el for el in in_traces.columns if ('x' in el) and ('mouse' in el)]
mouse_full_list = [el for el in in_traces.columns if ('mouse' in el)]
# allocate memory for the distances
distance_list = []
# for all the columns
for idx, col in enumerate(mouse_list[1:]):
# get the columns of interest
col_1 = in_traces.loc[:, [mouse_list[idx], mouse_list[idx].replace('_x', '_y')]].to_numpy()
col_2 = in_traces.loc[:, [col, col.replace('_x', '_y')]].to_numpy()
# get the distance between the consecutive columns
distance = fk.distance_calculation(col_1, col_2)
# convert to cm and store
distance_list.append(distance * (np.abs(ref_corners[0][1] - ref_corners[1][1]) /
np.abs(corners[0][0] - corners[2][0])))
# turn the list to array
distance_list = np.array(distance_list)
# turn the values over threshold into NaN
out_traces.loc[np.any(distance_list > threshold, axis=0), mouse_full_list] = np.nan
return out_traces
def infer_cricket_position(data_in, threshold, corners, ref_corners):
"""Place the cricket under the mouse when it's not visible and is near the mouse"""
# copy the input data
data_out = data_in.copy()
# get the cricket columns
cricket_columns = [el for el in data_in.columns if 'cricket' in el]
# get the cricket coordinates
cricket_coordinates = data_in.loc[:, cricket_columns]
# # get the distance to the mouse
# distance_mouse = \
# fk.distance_calculation(cricket_coordinates[['cricket_0_x', 'cricket_0_y']].to_numpy(),
# data_in[['mouse_x', 'mouse_y']].to_numpy())
# # convert the distance to cm
# distance_mouse = distance_mouse*(np.abs(ref_corners[0][1] -
# ref_corners[1][1])/np.abs(corners[0][0] - corners[2][0]))
# # allocate an empty array
# distance_new = np.zeros_like(distance_mouse)
# # find the first number
# first_number = distance_mouse[np.isnan(distance_mouse) == False][0]
# first_idx = np.argwhere(distance_mouse == first_number)[0][0]
# distance_new[:first_idx] = first_number
# # fill in the nan gaps with the latest distance
# for idx, el in enumerate(distance_mouse):
# if np.isnan(el):
# distance_new[idx] = first_number
# else:
# distance_new[idx] = el
# first_number = el
# # overwrite the distance array
# distance_mouse = distance_new
# identify the points that are within the threshold and are missing
# target_points = np.argwhere((distance_mouse < threshold) & np.isnan(cricket_coordinates['cricket_0_x'])).flatten()
target_points = np.argwhere(np.all(
np.isnan(cricket_coordinates.loc[:, cricket_columns]).to_numpy(), axis=1) &
np.all(~np.isnan(
data_in.loc[:, ['mouse_x', 'mouse_y', 'mouse_head_x', 'mouse_head_y']]).to_numpy(), axis=1)).flatten()
# if target points is empty, skip
if target_points.shape[0] > 0:
# assign the position of the mouse to those points
data_out.loc[target_points, ['cricket_0_x', 'cricket_0_y']] = \
data_in.loc[target_points, ['mouse_x', 'mouse_y']].to_numpy()
data_out.loc[target_points, ['cricket_0_head_x', 'cricket_0_head_y']] = \
data_in.loc[target_points, ['mouse_head_x', 'mouse_head_y']].to_numpy()
return data_out
def interpolate_segments(files, target_value):
"""Interpolate between the NaNs in a trace"""
# allocate memory for the output
interpolated_traces = files.copy()
# for all the columns
for col in np.arange(files.shape[1]):
# get the target trace
original_trace = files.iloc[:, col].to_numpy()
# if the target is nan then search for nans, otherwise search for the target value
if np.isnan(target_value):
# check if the target value is present, otherwise skip
if np.sum(np.isnan(original_trace)) == 0:
interpolated_traces.iloc[:, col] = original_trace
continue
x_known = np.squeeze(np.argwhere(~np.isnan(original_trace)))
else:
# check if the target value is present, otherwise skip
if np.sum(original_trace == target_value) == 0:
interpolated_traces.iloc[:, col] = original_trace
continue
x_known = np.squeeze(np.argwhere(original_trace != target_value))
# generate the x vectors as ranges
x_target = np.arange(original_trace.shape[0])
# get the known y vector
y_known = np.expand_dims(original_trace[x_known], 1)
# run the interpolation
interpolated_traces.iloc[:, col] = np.squeeze(interp_trace(y_known, x_known, x_target))
return interpolated_traces
def interpolate_animals(files, target_values, ref_corners, corners, untrimmed, distance_threshold=6):
"""Correct the cricket position"""
# extract the mouse coordinates
mouse_columns = [el for el in files.columns if 'mouse' in el]
mouse_coordinates = files[mouse_columns]
# get the cricket coordinates
cricket_columns = [el for el in files.columns if 'cricket' in el]
cricket_coordinates = files[cricket_columns].copy()
cricket_untrimmed = untrimmed[cricket_columns].copy()
# copy the data
cricket_interpolated = cricket_coordinates.copy()
# make rows that contain a nan entirely nan
nan_vector = np.any(np.isnan(cricket_coordinates.to_numpy()), axis=1)
cricket_coordinates.iloc[nan_vector, :] = np.nan
# if all the rows are nans, exit returning the original dataframe
if np.sum(nan_vector) == cricket_coordinates.shape[0]:
return files
distance_mouse = \
fk.distance_calculation(cricket_coordinates[['cricket_0_x', 'cricket_0_y']].to_numpy(),
mouse_coordinates[['mouse_x', 'mouse_y']].to_numpy())
# convert the distance to cm
distance_mouse = distance_mouse*(np.abs(ref_corners[0][1] -
ref_corners[1][1])/np.abs(corners[0][0] - corners[2][0]))
# add an offset at the beginning cause the starts of nan segments will always have nan distance
distance_mouse = np.hstack(([100], distance_mouse))
# if the first position is nan, copy the first not-nan position here
if np.isnan(cricket_coordinates.iloc[0, 0]):
# find the first not-nan
first_notnan = \
cricket_untrimmed.iloc[np.all(~np.isnan(cricket_untrimmed.to_numpy()), axis=1), :].to_numpy()[0, :]
cricket_coordinates.iloc[0, :] = first_notnan
# for all the columns
for col in cricket_coordinates.columns:
# get the data
data = cricket_coordinates[col].to_numpy()
# get the target column
if 'head' in col:
target_column = 'mouse_snout_' + col[-1]
else:
target_column = 'mouse_head_' + col[-1]
# find the target value
if np.isnan(target_values):
nan_locations, nan_numbers = label(np.isnan(data))
else:
nan_locations, nan_numbers = label(data == target_values)
# for all the segments
for segment in np.arange(1, nan_numbers+1):
# get the start of the segment
segment_start = np.argwhere(nan_locations == segment).flatten()[0]
# select the action depending on distance
if distance_mouse[segment_start] < distance_threshold:
# replace the segment by the position of the mouse
data[nan_locations == segment] = mouse_coordinates.loc[nan_locations == segment, target_column]
else:
# replace the segment by the last valid value
data[nan_locations == segment] = data[segment_start-1]
# add to the output frame
cricket_interpolated.loc[:, col] = data
return pd.concat([mouse_coordinates, cricket_interpolated, files[['time_vector', 'sync_frames']]], axis=1)
def eliminate_singles(files):
"""Eliminate points from each column that have no neighbors"""
# allocate memory for the output
filtered_traces = files.copy()
# for all the columns
for col in np.arange(files.shape[1]):
# get the target trace
original_trace = files.iloc[:, col]
# find the derivative of the nan trace
nan_positions = np.diff(np.isnan(original_trace).astype(np.int32), n=2)
# find the coordinates of the singles
single_positions = np.argwhere(nan_positions == 2) + 1
# single_positions = np.argwhere((nan_positions[:-1] == 1) & (nan_positions[1:] == -1))
# nan the singles
filtered_traces.iloc[single_positions, col] = np.nan
return filtered_traces
def nan_large_jumps(files, tar_columns, max_step, max_length):
"""NaN discontinuities in the trace (for later interpolation)"""
# allocate memory for the output
corrected_trace = files.copy()
# for the mouse and the cricket columns
for animal in tar_columns:
# for idx, col in enumerate(animal):
# get the data
curr_data = files[animal].copy()
# take the derivative trace
result = np.diff(curr_data[:])
result = np.hstack((0, result))
# find the places of threshold crossing
jumps = np.argwhere(np.abs(result) > max_step)
# get the distance between jumps
distance_between = np.diff(jumps, axis=0)
# go through each of the jumps
for index, jump in enumerate(distance_between):
# if the jump is smaller than the max_length allowed, NaN it (if bigger, that's a larger error in tracing
# than can be fixed with just interpolation)
if jump[0] < max_length:
curr_data[jumps[index, 0]:jumps[index+1, 0]] = np.nan
# ends = np.argwhere(result < -max_step)
# # if they're empty, skip the iteration
# if (starts.shape[0] == 0) | (ends.shape[0] == 0):
# continue
# else:
# starts = starts[:, 0]
# ends = ends[:, 0]
#
# # match their sizes and order
# if starts[0] > ends[0]:
# ends = ends[1:]
# if ends.shape[0] == 0:
# continue
# if starts[-1] > ends[-1]:
# starts = starts[:-1]
# # NaN the in-betweens
# # for all the starts
# for start, end in zip(starts, ends):
# curr_data[start:end] = np.nan
corrected_trace[animal] = curr_data
return corrected_trace
def find_frozen_tracking(files, margin=0.5, stretch_length=10):
"""Find places where the trajectory is too steady (i.e. no single pixel movement) and NaN them since it's probably
not actually tracking"""
# create a copy of the data
corrected_trace = files.copy()
# get the column names
column_names = corrected_trace.columns
# run through the columns
for column in column_names:
# skip the index column
if column == 'index':
continue
# get the derivative of the traces
delta_trace = abs(np.diff(corrected_trace[column], axis=0))
# find the places that don't pass the criterion
no_movement, number_no_movement = label(delta_trace < margin)
# add a zero at the beginning to match the size of corrected traces
no_movement = np.hstack([0, no_movement])
# go through the jumps
for jumps in np.arange(1, number_no_movement):
# if the jump passes the criterion
if np.sum(no_movement == jumps) >= stretch_length:
# nan them
corrected_trace.loc[no_movement == jumps, column] = np.nan
# no_movement = np.array([el[0] for el in np.argwhere(delta_trace < margin) + 1])
# # if it's not empty
# if no_movement.shape[0] > 0:
# # nan them
# corrected_trace.loc[no_movement, column] = np.nan
return corrected_trace
def nan_jumps_dlc(files, max_jump=200):
"""Nan stretches in between large jumps, assuming most of the trace is correct"""
# copy the data
corrected_trace = files.copy()
# get the column names
column_names = corrected_trace.columns
# run through the columns
for column in column_names:
# skip the index column if it's there
if column == 'index':
continue
# find the jumps
jump_length = np.diff(corrected_trace[column], axis=0)
jump_location = np.argwhere(abs(jump_length) > max_jump)
if jump_location.shape[0] == 0:
continue
jump_location = [el[0] for el in jump_location]
# initialize a flag
pair_flag = True
# go through pairs of jumps
for idx, jump in enumerate(jump_location[:-1]):
# if this is the second member of a pair, skip
if not pair_flag:
# reset the pair flag
pair_flag = True
continue
# if this jump and the next have the same sign, skip
if (jump_length[jump]*jump_length[jump_location[idx+1]]) > 0:
continue
# nan the segment in between
corrected_trace.loc[jump+1:jump_location[idx+1]+1, column] = np.nan
# set the pair flag
pair_flag = False
return corrected_trace
def rescale_pixels(traces, db_data, reference, manual_coordinates=None):
"""Use OpenCV to find corners in the image and rescale the data"""
# # set up the looping flag
# valid_corners = False
# set the crop flag
crop_flag = False if 'miniscope' in db_data['rig'] else True
# # loop until proper corners are found
# while not valid_corners:
# get the corners
if manual_coordinates is None:
try:
corner_coordinates = find_corners(db_data['avi_path'], num_frames=50, crop_flag=crop_flag)
except IndexError:
corner_coordinates = find_corners(db_data['avi_path'], num_frames=150, crop_flag=crop_flag)
else:
corner_coordinates = np.array(manual_coordinates)
# get the transformation between the reference and the real corners
perspective_matrix = cv2.getPerspectiveTransform(corner_coordinates.astype('float32'),
np.array(reference).astype('float32'))
# get the new corners
new_corners = np.concatenate((corner_coordinates, np.ones((corner_coordinates.shape[0], 1))), axis=1)
new_corners = np.matmul(new_corners, perspective_matrix.T)
new_corners = np.array([el[:2] / el[2] for el in new_corners])
# copy the traces
new_traces = traces.copy()
# transform the traces
# get the unique column names, excluding the letter at the end
column_names = np.unique([el[:-1] for el in traces.columns])
# for all the unique names
for column in column_names:
# if the name + x exists, transform
if column+'x' in traces.columns:
# get the x and y data
original_data = traces[[column + 'x', column + 'y']].to_numpy()
# add a vector of ones for the matrix multiplication
original_data = np.concatenate((original_data, np.ones((original_data.shape[0], 1))), axis=1)
# transform
new_data = np.matmul(original_data, perspective_matrix.T)
new_data = np.array([el[:2] / el[2] for el in new_data])
# # basic scaling for debugging
# new_data = original_data*(np.abs(reference[0][1] - reference[1][1]) /
# np.abs(corner_coordinates[0][0] - corner_coordinates[2][0]))
# replace the original data
new_traces[[column + 'x', column + 'y']] = new_data[:, :2]
# # turn the perspective matrix into a dataframe
# output_matrix = pd.DataFrame(perspective_matrix)
return new_traces, new_corners
def find_corners(video_path, num_frames=10, crop_flag=False):
"""Take the mode of a video to use the image to find corners"""
# create the video object
cap = cv2.VideoCapture(video_path)
# allocate memory for the corners
corners = []
# # define sigma for the edge detection parameters
# sigma = 0.2
# get the frames to mode
for frames in np.arange(num_frames):
# read the image
img = cap.read()[1]
# save the original image for plotting
img_ori = img.copy()
# if it's not a miniscope movie, crop the frame
if crop_flag:
img = img[300:750, 250:950, :]
# blur to remove noise
# img2 = cv2.medianBlur(img, 3)
img2 = cv2.equalizeHist(cv2.cvtColor(img, cv2.COLOR_RGB2GRAY))
# plt.imshow(img2)
im_median = np.median(img2)
# find edges
# img2 = cv2.Canny(img2, 30, 60)
# img2 = cv2.Canny(img2, 30, im_median/4)
img2 = cv2.Canny(img2, im_median, im_median*2)
plt.imshow(img2)
# find the corners
frame_corners = np.squeeze(np.int0(cv2.goodFeaturesToTrack(img2, 25, 0.0001, 100)))
# if the pic was cropped, correct the coordinates
if crop_flag:
frame_corners = np.array([el+[250, 300] for el in frame_corners])
# for c in frame_corners:
# x, y = c.ravel()
# cv2.circle(img_ori, (x, y), 10, 255, -1)
# plt.imshow(img_ori)
# if there aren't 4 corners, skip
if frame_corners.shape[0] > 4:
frame_corners = exclude_non_corners(frame_corners, np.array(img_ori.shape[:2]))
# if it comes out empty as not all 4 corners were found, skip
if len(frame_corners) == 0:
continue
elif frame_corners.shape[0] < 4:
continue
# sort the rows
sort_idx = np.argsort(frame_corners[:, 0], axis=0)
# append to the list
corners.append(frame_corners[sort_idx, :])
# release the video file
cap.release()
# take the mode of the corners
# corners, _ = mode(np.squeeze(corners), axis=0)
# turn the corners list into an array
corners = np.array(corners)
# allocate memory for the output list
corner_list = []
# for all corners
for corner in np.arange(4):
# get the unique and the counts
temp_corner, idx, inv, counts = np.unique(corners[:, corner, :],
axis=0, return_index=True, return_inverse=True, return_counts=True)
# store the one with the most counts
corner_list.append(temp_corner[np.argmax(counts)])
return np.array(corner_list)
def exclude_non_corners(frame_corners, im_size, center_percentage=0.1):
"""Use quadrants and euclidean distances to exclude the non-corner extra points"""
# allocate memory for the final set of points
real_points = []
# exclude points too close to the center of the image
# get the center of the image
image_center = im_size/2
frame_corners = np.array([el for el in frame_corners if
(np.abs(el[0] - image_center[0]) > im_size[0]*center_percentage) and
(np.abs(el[1] - image_center[1]) > im_size[1]*center_percentage)])
# calculate the middle of the image
middle = np.mean(frame_corners, axis=0)
# get the point angles
angles = np.rad2deg(np.arctan2(frame_corners[:, 0] - middle[0], frame_corners[:, 1] - middle[1]))
# determine the middle of the 4 corners via averaging
for quadrants in np.arange(4):
# get the points in this quadrant
if quadrants == 0:
low_bound = 0
high_bound = 90
elif quadrants == 1:
low_bound = 90.1
high_bound = 180
elif quadrants == 2:
low_bound = -90
high_bound = 0
else:
low_bound = -180
high_bound = -90.1
# get the locations of the points
point_locations = np.argwhere(np.logical_and(low_bound < angles, angles < high_bound))
# if a point is missing, skip the whole frame
if point_locations.shape[0] == 0:
return []
else:
# get the points
quadrant_points = point_locations[0]
# if there's only 1 point, add it to the list
if quadrant_points.shape[0] == 1:
real_points.append(frame_corners[quadrant_points[0], :])
# otherwise, get the euclidean distance
else:
target_points = frame_corners[quadrant_points, :]
distances = np.linalg.norm(target_points - middle)
# get the max distance as the point
real_points.append(target_points[np.argmax(distances), :])
# return the cleaned up corners
return np.array(real_points)
def timed_event_finder(dframe_in, parameter, threshold, function, window=5):
"""This function will generate a dataframe with all the encountered windows of traces that pass the threshold
in the target parameter"""
# calculate the frame rate
framerate = np.round(1 / np.mean(np.diff(dframe_in['time_vector']))).astype(int)
# get the frames per window
window_frames = int(window * framerate)
# get the event triggers
[event_labels, _] = label(function(dframe_in[parameter], threshold))
# get the event onsets (where the threshold is crossed)
event_onsets = np.argwhere(np.diff(event_labels) > 0) + 1
# create a matrix with all the interval indexes
event_matrix = [[el[0]-window_frames, el[0]+window_frames] for el in event_onsets
if ((el-window_frames) > 0) and ((el + window_frames) < event_labels.shape[0])]
# if no events were found, skip
if len(event_matrix) == 0:
return []
# filter the overlapping events
nonoverlap_matrix = maximize_nonoverlapping_count(event_matrix)
# get the output dataframe for each event
output_events = [dframe_in.iloc[el[0]:el[1], :].copy() for el in nonoverlap_matrix]
# for all events
for idx, event in enumerate(output_events):
# reset the index
event.reset_index(inplace=True, drop=True)
# reset the time
event.loc[:, 'time_vector'] -= event.loc[:, 'time_vector'].to_numpy()[0]
# add the event id
event.loc[:, 'event_id'] = idx
# concatenate and output
return pd.concat(output_events)
def read_motive_header(file_path):
""" Make variables to hold arena corner coordinates, obstacle coordinates, and
the dataframe itself. The header first contains information about the arena
corner coordinates and the position of objects in the arena, followed by a
blank line and then the main dataframe. """
arena_corners = []
obstacle_positions = {}
with open(file_path) as f:
# Read the file line by line
reader = csv.reader(f, delimiter=":")
for line_num, line in enumerate(reader):
if line:
# Read the lines related to arena and obstacle positions
if "arena_corners" in line[0]:
arena_corners = loads(line[-1])
arena_corners = np.array(arena_corners)
else:
obs_name = line[0]
obs_centroid = loads(line[-1])
obstacle_positions[str(obs_name)] = obs_centroid
else:
# We have reached the blank line delimiting the positions
break
return arena_corners, obstacle_positions, line_num
def flip_DLC_y(traces):
# copy the traces
new_traces = traces.copy()
# Get unique column names
column_names = np.unique([el[:-1] for el in traces.columns])
# for all the unique names
for column in column_names:
# if the name + x exists, transform
if column + 'y' in traces.columns:
# get the y data
original_data = traces[[column + 'y']].to_numpy()
# transform
new_data = original_data * -1
# replace the original data
new_traces[[column + 'y']] = new_data
return new_traces
# class and functions taken from https://stackoverflow.com/questions/16312871/python-removing-overlapping-lists
class IntervalSub(Interval, object):
def __init__(self, start, end):
self.start = start
self.end = end
self.removed = False
def maximize_nonoverlapping_count(intervals):
intervals = [IntervalSub(start, end) for start, end in intervals]
# sort by the end-point
intervals.sort(key=lambda x: (x.end, (x.end - x.start))) # O(n*log n)
tree = build_interval_tree(intervals) # O(n*log n)
result = []
for smallest in intervals: # O(n) (without the loop body)
# pop the interval with the smallest end-point, keep it in the result
if smallest.removed:
continue # skip removed nodes
smallest.removed = True
result.append([smallest.start, smallest.end]) # O(1)
# remove (mark) intervals that overlap with the popped interval
# tree.intersect(smallest.start, smallest.end, # O(log n + m)
# lambda x: setattr(x.other, 'removed', True))
intersection = tree.intersect(smallest.start, smallest.end)
[setattr(el, 'removed', True) for el in intersection]
return result
def build_interval_tree(intervals):
# root = IntervalNode(intervals[0].start, intervals[0].end,
# other=intervals[0])
root = IntervalNode(intervals[0])
return reduce(lambda tree, x: tree.insert(x),
intervals[1:], root)
def parse_bonsai(path_in):
"""Parse bonsai files"""
parsed_data = []
last_nan = 0
with open(path_in) as f:
for ex_line in f:
ex_list = ex_line.split(' ')
ex_list.remove('\n')
# TODO: check what happens with older data using the new line
# if (float(ex_list[0]) < 110 or ex_list[0] == 'NaN') and last_nan == 0:
if (ex_list[0] == 'NaN') and last_nan == 0:
continue
else:
last_nan = 1
timestamp = ex_list.pop()
ex_list = [float(el) for el in ex_list]
parsed_data.append([ex_list, timestamp])
return parsed_data
def trim_to_movement(result, data_in, ref_corners, corners, nan_threshold=150, speed_threshold=1):
"""Trim the successfull traces after cricket capture"""
# # allocate the output
# data_out = data_in.copy()
# allocate the trim frames
trim_frames = [0, data_in.shape[0], data_in.shape[0]]
# define the list of coordinates to look into for nans
target_coordinates = ['mouse', 'mouse_body2', 'mouse_body3']
# allocate memory for the combined speeds (assumption is speed should be about the same across body parts
speed_list = []
# for all the coordinate pairs
for el in target_coordinates:
# get the mouse coordinates
mouse_coord = data_in[[el+'_x', el+'_y']].to_numpy()
# roughly scale the mouse coordinates
mouse_coord = mouse_coord*(np.abs(ref_corners[0][1] - ref_corners[1][1])/np.abs(corners[0][0] - corners[2][0]))
# define the frame rate
frame_time = np.mean(np.diff(data_in['time_vector']))
# get a rough speed trace
temp_speed = np.concatenate(
([0], fk.distance_calculation(mouse_coord[1:, :], mouse_coord[:-1, :]) /
frame_time))
# store the speed
speed_list.append(temp_speed)
# average the speeds to generate a common trace with the minimum amount of gaps
temp_speed = np.nanmean(speed_list, axis=0)
# trim the beginning by finding the end of a nan stretch
nan_segments, nan_num = label(np.isnan(temp_speed))
# get the lengths
nan_lengths = np.array([np.sum(nan_segments == el) for el in np.arange(1, nan_num+1)])
# get the ends
nan_ends = [np.argwhere(np.diff((nan_segments == el).astype(int)) == -1) for el in np.arange(1, nan_num+1)]
nan_ends = np.array([el[0][0] if el.shape[0] > 0 else np.nan for el in nan_ends])
# remove the lengths with nan as the end
nan_vector = ~np.isnan(nan_ends)
nan_lengths = nan_lengths[nan_vector]
nan_ends = nan_ends[nan_vector].astype(int)
# if the first element is a nan, eliminate it first (check second due to adding a zero above)
if np.isnan(temp_speed[1]):
nan_lengths[0] = nan_threshold + 1
# get the trim frame
try:
trim_frames[0] = nan_ends[np.argwhere(nan_lengths > nan_threshold)[-1][0]]
except IndexError:
trim_frames[0] = 0
# trim the trace
data_out = data_in.iloc[trim_frames[0]:, :].reset_index(drop=True)
# TODO: is this legit? should the succ trials not be trimmed?
# # if it's a success, skip
# if result == 'succ':
#
# # find the last spot in the speed trace where the speed goes below threshold
# # slow_frames = np.array([el[0] for el in np.argwhere(medfilt(temp_speed, kernel_size=11) < speed_threshold)])
# slow_segments, slow_num = label(medfilt(temp_speed, kernel_size=11) < speed_threshold)
# # get the beginning of the last one
#
# # get the lengths
# slow_lengths = np.array([np.sum(slow_segments == el) for el in np.arange(1, slow_num + 1)])
# # get the starts
# slow_starts = [np.argwhere(np.diff((slow_segments == el).astype(int)) == 1) for el in np.arange(1, slow_num + 1)]
# slow_starts = np.array([el[0][0] if el.shape[0] > 0 else np.nan for el in slow_starts])
# # remove the lengths with nan as the start
# nan_vector = ~np.isnan(slow_starts)
# slow_lengths = slow_lengths[nan_vector]
# slow_starts = slow_starts[nan_vector].astype(int)
# try:
# trim_frames[1] = slow_starts[np.argwhere((slow_lengths > 1) & (slow_starts > trim_frames[0]))[-1][0]]
# # trim the trace
# data_out = data_out.iloc[:trim_frames[1] - trim_frames[0] - 1, :].reset_index(drop=True)
# except IndexError:
# print('End not trimmed for file')
# format the frame bounds as a dataframe
trim_frames = pd.DataFrame(np.array(trim_frames).reshape([1, 3]), columns=['start', 'end', 'original_length'])
# reset the time variable
time = data_out.loc[:, 'time_vector']
data_out.loc[:, 'time_vector'] = [el - time[0] for el in time]
return data_out, trim_frames
def process_corners(corner_frame):
"""Extract the corner coordinates from the trace"""
corner_processed = np.reshape(np.median(corner_frame, axis=0), (4, 2))
return corner_processed
def cricket_size(data_in, conversion_factor):
"""Calculate the approximate size of the cricket"""
# get the distance between the cricket points
delta = fk.distance_calculation(data_in.loc[:, ['cricket_0_x', 'cricket_0_y']].to_numpy(),
data_in.loc[:, ['cricket_0_head_x', 'cricket_0_head_y']].to_numpy())
# take the median of the first 50 not-nan points and convert
target_points = delta[~np.isnan(delta)]
cr_size = np.median(target_points[:50])*conversion_factor
return cr_size