forked from BCHSI/philter-ucsf
-
Notifications
You must be signed in to change notification settings - Fork 0
/
philter.py
2430 lines (1985 loc) · 110 KB
/
philter.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 re
import warnings
import json
import os
import nltk
import itertools
import chardet
import pickle
from chardet.universaldetector import UniversalDetector
from nltk.stem.wordnet import WordNetLemmatizer
from coordinate_map import CoordinateMap
from nltk.tag.stanford import StanfordNERTagger
import subprocess
import numpy
import random
import string
class Philter:
"""
General text filtering class,
can filter using whitelists, blacklists, regex's and POS
"""
def __init__(self, config):
if "verbose" in config:
self.verbose = config["verbose"]
if "run_eval" in config:
self.run_eval = config["run_eval"]
if "freq_table" in config:
self.freq_table = config["freq_table"]
if "initials" in config:
self.initials = config["initials"]
if "finpath" in config:
if not os.path.exists(config["finpath"]):
raise Exception("Filepath does not exist", config["finpath"])
self.finpath = config["finpath"]
if "foutpath" in config:
if not os.path.exists(config["foutpath"]):
raise Exception("Filepath does not exist", config["foutpath"])
self.foutpath = config["foutpath"]
if "anno_folder" in config:
if not os.path.exists(config["anno_folder"]):
raise Exception("Filepath does not exist", config["anno_folder"])
self.anno_folder = config["anno_folder"]
if "coords" in config:
self.coords = config["coords"]
if "eval_out" in config:
self.eval_outpath = config["eval_out"]
if "outformat" in config:
self.outformat = config["outformat"]
else:
self.outformat = "asterisk"
if "ucsfformat" in config:
self.ucsf_format = config["ucsfformat"]
if "filters" in config:
if not os.path.exists(config["filters"]):
raise Exception("Filepath does not exist", config["filters"])
self.patterns = json.loads(open(config["filters"], "r").read())
if "xml" in config:
if not os.path.exists(config["xml"]):
raise Exception("Filepath does not exist", config["xml"])
self.xml = json.loads(open(config["xml"], "r", encoding='utf-8').read())
if "stanford_ner_tagger" in config:
if not os.path.exists(config["stanford_ner_tagger"]["classifier"]) and config["stanford_ner_tagger"]["download"] == False:
raise Exception("Filepath does not exist", config["stanford_ner_tagger"]["classifier"])
else:
#download the ner data
process = subprocess.Popen("cd generate_dataset && ./download_ner.sh".split(), stdout=subprocess.PIPE)
output, error = process.communicate()
self.stanford_ner_tagger_classifier = config["stanford_ner_tagger"]["classifier"]
if not os.path.exists(config["stanford_ner_tagger"]["jar"]):
raise Exception("Filepath does not exist", config["stanford_ner_tagger"]["jar"])
self.stanford_ner_tagger_jar = config["stanford_ner_tagger"]["jar"]
#we lazy load our tagger only if there's a corresponding pattern
self.stanford_ner_tagger = None
if "cachepos" in config and config["cachepos"]:
self.cache_to_disk = True
self.pos_path = config["cachepos"]
if not os.path.isdir(self.pos_path):
os.makedirs(self.pos_path)
else:
self.cache_to_disk = False
self.pos_path = None
#All coordinate maps stored here
self.coordinate_maps = []
#create a memory for pos tags
self.pos_tags = {}
#create a memory for tokenized text
self.cleaned = {}
#create a memory for include coordinate map
self.include_map = CoordinateMap()
#create a memory for exclude coordinate map
self.exclude_map = CoordinateMap()
#create a memory for FULL exclude coordinate map (including non-whitelisted words)
self.full_exclude_map = {}
#create a memory for the list of known PHI types
self.phi_type_list = ['DATE','Patient_Social_Security_Number','Email','Provider_Address_or_Location','Age','Name','OTHER','ID','NAME','LOCATION','CONTACT','AGE']
#create a memory for the corrdinate maps of known PHI types
self.phi_type_dict = {}
for phi_type in self.phi_type_list:
self.phi_type_dict[phi_type] = [CoordinateMap()]
#create a memory for stored coordinate data
self.data_all_files = {}
#create a memory for pattern index, with titles
self.pattern_indexes = {}
#create a memory for clean words
#self.clean_words = {}
#create directory for pos data if it doesn't exist
#pos_path = "./data/pos_data/"
#self.pos_path = "./data/pos_data/" + self.random_string(10) + "/"
#initialize our patterns
self.init_patterns()
def get_pos(self, filename, cleaned):
if self.cache_to_disk:
pos_path = self.pos_path
filename = filename.split("/")[-1]
file_ = pos_path + filename
if filename not in self.pos_tags:
self.pos_tags = {}
if not os.path.isfile(file_):
with open(file_, 'wb') as f:
tags = nltk.pos_tag(cleaned)
pickle.dump(tags, f)
return tags
else:
with open(file_, 'rb') as f:
self.pos_tags[filename] = pickle.load(f)
else:
if filename not in self.pos_tags:
self.pos_tags = {}
self.pos_tags[filename] = nltk.pos_tag(cleaned)
return self.pos_tags[filename]
#self.pos_tags[filename] = nltk.pos_tag(cleaned)
return self.pos_tags[filename]
#def get_pos_original(self, filename, cleaned):
# if filename not in self.pos_tags:
# self.pos_tags = {}
# self.pos_tags[filename] = nltk.pos_tag(cleaned)
# return self.pos_tags[filename]
def get_clean(self, filename, text, pre_process= r"[^a-zA-Z0-9]"):
if filename not in self.cleaned:
self.cleaned = {}
# Use pre-process to split sentence by spaces AND symbols, while preserving spaces in the split list
lst = re.split("(\s+)", text)
cleaned = []
for item in lst:
if len(item) > 0:
if item.isspace() == False:
split_item = re.split("(\s+)", re.sub(pre_process, " ", item))
for elem in split_item:
if len(elem) > 0:
cleaned.append(elem)
else:
cleaned.append(item)
self.cleaned[filename] = cleaned
return self.cleaned[filename]
#def get_clean_word(self, filename, word):
# if filename not in self.cleaned:
# self.clean_words = {}
# self.clean_words[filename] = {}
# if word not in self.clean_words[filename]:
# self.clean_words[filename][word] = re.sub(r"[^a-zA-Z0-9]+", "", word.lower().strip())
# return self.clean_words[filename][word]
#def get_clean_word2(self, filename, word):
# return re.sub(r"[^a-zA-Z0-9]+", "", word.lower().strip())
# if word not in self.clean_words:
# self.clean_words[word] = re.sub(r"[^a-zA-Z0-9]+", "", word.lower().strip())
# return self.clean_words[word]
def init_patterns(self):
""" given our input pattern config will load our sets and pre-compile our regex"""
known_pattern_types = set(["regex", "set", "regex_context","stanford_ner", "pos_matcher", "match_all"])
require_files = set(["regex", "set"])
require_pos = set(["pos_matcher"])
set_filetypes = set(["pkl", "json"])
regex_filetypes = set(["txt"])
reserved_list = set(["data", "coordinate_map"])
#first check that data is formatted, can be loaded etc.
for i,pattern in enumerate(self.patterns):
self.pattern_indexes[pattern['title']] = i
if pattern["type"] in require_files and not os.path.exists(pattern["filepath"]):
raise Exception("Config filepath does not exist", pattern["filepath"])
for k in reserved_list:
if k in pattern:
raise Exception("Error, Keyword is reserved", k, pattern)
if pattern["type"] not in known_pattern_types:
raise Exception("Pattern type is unknown", pattern["type"])
if pattern["type"] == "set":
if pattern["filepath"].split(".")[-1] not in set_filetypes:
raise Exception("Invalid filteype", pattern["filepath"], "must be of", set_filetypes)
self.patterns[i]["data"] = self.init_set(pattern["filepath"])
if pattern["type"] == "regex":
if pattern["filepath"].split(".")[-1] not in regex_filetypes:
raise Exception("Invalid filteype", pattern["filepath"], "must be of", regex_filetypes)
self.patterns[i]["data"] = self.precompile(pattern["filepath"])
elif pattern["type"] == "regex_context":
if pattern["filepath"].split(".")[-1] not in regex_filetypes:
raise Exception("Invalid filteype", pattern["filepath"], "must be of", regex_filetypes)
self.patterns[i]["data"] = self.precompile(pattern["filepath"])
#print(self.precompile(pattern["filepath"]))
def precompile(self, filepath):
""" precompiles our regex to speed up pattern matching"""
regex = open(filepath,"r").read().strip()
re_compiled = None
with warnings.catch_warnings(): #NOTE: this is not thread safe! but we want to print a more detailed warning message
warnings.simplefilter(action="error", category=FutureWarning) # in order to print a detailed message
try:
re_compiled = re.compile(regex)
except FutureWarning as warn:
print("FutureWarning: {0} in file ".format(warn) + filepath)
warnings.simplefilter(action="ignore", category=FutureWarning)
re_compiled = re.compile(regex) # assign nevertheless
return re_compiled
def init_set(self, filepath):
""" loads a set of words, (must be a dictionary or set shape) returns result"""
map_set = {}
if filepath.endswith(".pkl"):
try:
with open(filepath, "rb") as pickle_file:
map_set = pickle.load(pickle_file)
except UnicodeDecodeError:
with open(filepath, "rb") as pickle_file:
map_set = pickle.load(pickle_file, encoding = 'latin1')
elif filepath.endswith(".json"):
map_set = json.loads(open(filepath, "r").read())
else:
raise Exception("Invalid filteype",filepath)
return map_set
def map_coordinates(self, allowed_filetypes=set(["txt", "ano"])):
""" Runs the set, or regex on the input data
generating a coordinate map of hits given
(this performs a dry run on the data and doesn't transform)
"""
in_path = self.finpath
if not os.path.exists(in_path):
raise Exception("Filepath does not exist", in_path)
#create coordinate maps for each pattern
for i,pat in enumerate(self.patterns):
self.patterns[i]["coordinate_map"] = CoordinateMap()
for root, dirs, files in os.walk(in_path):
for f in files:
filename = os.path.join(root, f)
if filename.split(".")[-1] not in allowed_filetypes:
if self.verbose:
print("Skipping: ", filename)
continue
#self.patterns[i]["coordinate_map"].add_file(filename)
encoding = self.detect_encoding(filename)
if __debug__: print("reading text from " + filename)
txt = open(filename,"r", encoding=encoding['encoding'], errors='surrogateescape').read()
# Get full self.include/exclude map before transform
self.data_all_files[filename] = {"text":txt, "phi":[],"non-phi":[]}
#create an intersection map of all coordinates we'll be removing
self.exclude_map.add_file(filename)
#create an interestion map of all coordinates we'll be keeping
self.include_map.add_file(filename)
# add file to phi_type_dict
for phi_type in self.phi_type_list:
self.phi_type_dict[phi_type][0].add_file(filename)
# initialize phi type
phi_type = "OTHER"
#### Create inital self.exclude/include for file
for i,pat in enumerate(self.patterns):
if pat["type"] == "regex":
self.map_regex(filename=filename, text=txt, pattern_index=i)
elif pat["type"] == "set":
self.map_set(filename=filename, text=txt, pattern_index=i)
elif pat["type"] == "regex_context":
self.map_regex_context(filename=filename, text=txt, pattern_index=i)
elif pat["type"] == "stanford_ner":
self.map_ner(filename=filename, text=txt, pattern_index=i)
elif pat["type"] == "pos_matcher":
self.map_pos(filename=filename, text=txt, pattern_index=i)
elif pat["type"] == "match_all":
self.match_all(filename=filename, text=txt, pattern_index=i)
else:
raise Exception("Error, pattern type not supported: ", pat["type"])
self.get_exclude_include_maps(filename, pat, txt)
#create intersection maps for all phi types and add them to a dictionary containing all maps
# get full exclude map (only updated either on-command by map_regex_context or at the very end of map_coordinates)
self.full_exclude_map[filename] = self.include_map.get_complement(filename, txt)
for phi_type in self.phi_type_list:
for start,stop in self.phi_type_dict[phi_type][0].filecoords(filename):
self.data_all_files[filename]["phi"].append({"start":start, "stop":stop, "word":txt[start:stop],"phi_type":phi_type, "filepath":""})
#clear out any data to save ram
for i,pat in enumerate(self .patterns):
if "data" in pat:
del self.patterns[i]["data"]
return self.full_exclude_map
def map_regex(self, filename="", text="", pattern_index=-1, pre_process= r"[^a-zA-Z0-9]"):
""" Creates a coordinate map from the pattern on this data
generating a coordinate map of hits given (dry run doesn't transform)
"""
if not os.path.exists(filename):
raise Exception("Filepath does not exist", filename)
if pattern_index < 0 or pattern_index >= len(self.patterns):
raise Exception("Invalid pattern index: ", pattern_index, "pattern length", len(patterns))
coord_map = self.patterns[pattern_index]["coordinate_map"]
regex = self.patterns[pattern_index]["data"]
# All regexes except matchall
if regex != re.compile('.'):
#if __debug__: print("map_regex(): searching for regex with index " + str(pattern_index))
#if __debug__ and pattern_index: print("map_regex(): regex is " + str(regex))
matches = regex.finditer(text)
for m in matches:
# print(m.group())
# print(self.patterns[pattern_index]['title'])
coord_map.add_extend(filename, m.start(), m.start()+len(m.group()))
self.patterns[pattern_index]["coordinate_map"] = coord_map
#### MATCHALL/CATCHALL ####
elif regex == re.compile('.'):
# Split note the same way we would split for set or POS matching
matchall_list = re.split("(\s+)", text)
matchall_list_cleaned = []
for item in matchall_list:
if len(item) > 0:
if item.isspace() == False:
split_item = re.split("(\s+)", re.sub(pre_process, " ", item))
for elem in split_item:
if len(elem) > 0:
matchall_list_cleaned.append(elem)
else:
matchall_list_cleaned.append(item)
start_coordinate = 0
for word in matchall_list_cleaned:
start = start_coordinate
stop = start_coordinate + len(word)
word_clean = re.sub(r"[^a-zA-Z0-9]+", "", word.lower().strip())
if len(word_clean) == 0:
#got a blank space or something without any characters or digits, move forward
start_coordinate += len(word)
continue
if regex.match(word_clean):
coord_map.add_extend(filename, start, stop)
#advance our start coordinate
start_coordinate += len(word)
self.patterns[pattern_index]["coordinate_map"] = coord_map
def map_regex_context(self, filename="", text="", pattern_index=-1, pre_process= r"[^a-zA-Z0-9]"):
""" map_regex_context creates a coordinate map from combined regex + PHI coordinates
of all previously mapped patterns
"""
punctuation_matcher = re.compile(r"[^a-zA-Z0-9*]")
if not os.path.exists(filename):
raise Exception("Filepath does not exist", filename)
if pattern_index < 0 or pattern_index >= len(self.patterns):
raise Exception("Invalid pattern index: ", pattern_index, "pattern length", len(patterns))
coord_map = self.patterns[pattern_index]["coordinate_map"]
regex = self.patterns[pattern_index]["data"]
context = self.patterns[pattern_index]["context"]
try:
context_filter = self.patterns[pattern_index]["context_filter"]
except KeyError:
warnings.warn("deprecated missing context_filter field in filter " + str(pattern_index) + " of type regex_context, assuming \'all\'", DeprecationWarning)
context_filter = 'all'
# Get PHI coordinates
if context_filter == 'all':
# current_include_map = self.get_full_include_map(filename)
current_include_map = self.include_map
# Create complement exclude map (also excludes punctuation)
full_exclude_map = current_include_map.get_complement(filename, text)
else:
context_filter_pattern_index = self.pattern_indexes[context_filter]
full_exclude_map_coordinates = self.patterns[context_filter_pattern_index]['coordinate_map']
full_exclude_map = {}
for start,stop in full_exclude_map_coordinates.filecoords(filename):
full_exclude_map[start] = stop
# 1. Get coordinates of all include and exclude mathches
punctuation_matcher = re.compile(r"[^a-zA-Z0-9*]")
# 2. Find all patterns expressions that match regular expression
matches = regex.finditer(text)
# print(full_exclud_map)
for m in matches:
# initialize phi_left and phi_right
phi_left = False
phi_right = False
match_start = m.span()[0]
match_end = m.span()[1]
# PHI context left and right
phi_starts = []
phi_ends = []
for start in full_exclude_map:
phi_starts.append(start)
phi_ends.append(full_exclude_map[start])
if match_start in phi_ends:
phi_left = True
if match_end in phi_starts:
phi_right = True
# Get index of m.group()first alphanumeric character in match
tokenized_matches = []
match_text = m.group()
split_match = re.split("(\s+)", re.sub(pre_process, " ", match_text))
# Get all spans of tokenized match (because remove() function requires tokenized start coordinates)
coord_tracker = 0
for element in split_match:
if element != '':
if not punctuation_matcher.match(element[0]):
current_start = match_start + coord_tracker
current_end = current_start + len(element)
tokenized_matches.append((current_start, current_end))
coord_tracker += len(element)
else:
coord_tracker += len(element)
## Check for context, and add to coordinate map
if (context == "left" and phi_left == True) or (context == "right" and phi_right == True) or (context == "left_or_right" and (phi_right == True or phi_left == True)) or (context == "left_and_right" and (phi_right == True and phi_left == True)):
for item in tokenized_matches:
coord_map.add_extend(filename, item[0], item[1])
self.patterns[pattern_index]["coordinate_map"] = coord_map
def match_all(self, filename="", text="", pattern_index=-1):
""" Simply maps to the entirety of the file """
if not os.path.exists(filename):
raise Exception("Filepath does not exist", filename)
if pattern_index < 0 or pattern_index >= len(self.patterns):
raise Exception("Invalid pattern index: ", pattern_index, "pattern length", len(patterns))
coord_map = self.patterns[pattern_index]["coordinate_map"]
#add the entire length of the file
coord_map.add(filename, 0, len(text))
print(0, len(text))
self.patterns[pattern_index]["coordinate_map"] = coord_map
def map_set(self, filename="", text="", pattern_index=-1, pre_process= r"[^a-zA-Z0-9]"):
""" Creates a coordinate mapping of words any words in this set"""
if not os.path.exists(filename):
raise Exception("Filepath does not exist", filename)
if pattern_index < 0 or pattern_index >= len(self.patterns):
raise Exception("Invalid pattern index: ", pattern_index, "pattern length", len(patterns))
map_set = self.patterns[pattern_index]["data"]
coord_map = self.patterns[pattern_index]["coordinate_map"]
#get part of speech we will be sending through this set
#note, if this is empty we will put all parts of speech through the set
check_pos = False
pos_set = set([])
if "pos" in self.patterns[pattern_index]:
pos_set = set(self.patterns[pattern_index]["pos"])
if len(pos_set) > 0:
check_pos = True
cleaned = self.get_clean(filename,text)
if check_pos:
pos_list = self.get_pos(filename, cleaned)# pos_list = nltk.pos_tag(cleaned)
else:
pos_list = zip(cleaned,range(len(cleaned)))
pos_list = nltk.pos_tag(cleaned)
# if filename == './data/i2b2_notes/160-03.txt':
# print(pos_list)
start_coordinate = 0
for tup in pos_list:
word = tup[0]
pos = tup[1]
start = start_coordinate
stop = start_coordinate + len(word)
# This converts spaces into empty strings, so we know to skip forward to the next real word
word_clean = re.sub(r"[^a-zA-Z0-9]+", "", word.lower().strip())
if len(word_clean) == 0:
#got a blank space or something without any characters or digits, move forward
start_coordinate += len(word)
continue
if check_pos == False or (check_pos == True and pos in pos_set):
# if word == 'exlap':
# print(pos)
# print(filename)
# print(pos_set)
# print(check_pos)
if word_clean in map_set or word in map_set:
coord_map.add_extend(filename, start, stop)
#print("FOUND: ",word, "COORD: ", text[start:stop])
else:
#print("not in set: ",word, "COORD: ", text[start:stop])
#print(word_clean)
pass
#advance our start coordinate
start_coordinate += len(word)
self.patterns[pattern_index]["coordinate_map"] = coord_map
def map_pos(self, filename="", text="", pattern_index=-1, pre_process= r"[^a-zA-Z0-9]"):
""" Creates a coordinate mapping of words which match this part of speech (POS)"""
if not os.path.exists(filename):
raise Exception("Filepath does not exist", filename)
if pattern_index < 0 or pattern_index >= len(self.patterns):
raise Exception("Invalid pattern index: ", pattern_index, "pattern length", len(patterns))
if "pos" not in self.patterns[pattern_index]:
raise Exception("Mapping POS must include parts of speech", pattern_index, "pattern length", len(patterns))
coord_map = self.patterns[pattern_index]["coordinate_map"]
pos_set = set(self.patterns[pattern_index]["pos"])
# Use pre-process to split sentence by spaces AND symbols, while preserving spaces in the split list
cleaned = self.get_clean(filename,text)
pos_list = self.get_pos(filename, cleaned)#pos_list = nltk.pos_tag(cleaned)
# if filename == './data/i2b2_notes/160-03.txt':
# print(pos_list)
start_coordinate = 0
for tup in pos_list:
word = tup[0]
pos = tup[1]
start = start_coordinate
stop = start_coordinate + len(word)
#word_clean = self.get_clean_word2(filename,word)
word_clean = re.sub(r"[^a-zA-Z0-9]+", "", word.lower().strip())
if len(word_clean) == 0:
#got a blank space or something without any characters or digits, move forward
start_coordinate += len(word)
continue
if pos in pos_set:
coord_map.add_extend(filename, start, stop)
#print("FOUND: ",word,"POS",pos, "COORD: ", text[start:stop])
#advance our start coordinate
start_coordinate += len(word)
self.patterns[pattern_index]["coordinate_map"] = coord_map
def map_ner(self, filename="", text="", pattern_index=-1, pre_process= r"[^a-zA-Z0-9]+"):
""" map NER tagging"""
if not os.path.exists(filename):
raise Exception("Filepath does not exist", filename)
if pattern_index < 0 or pattern_index >= len(self.patterns):
raise Exception("Invalid pattern index: ", pattern_index, "pattern length", len(patterns))
#load and create an NER tagger if it doesn't exist
if self.stanford_ner_tagger == None:
classifier_path = self.stanford_ner_tagger_classifier #'/usr/local/stanford-ner/classifiers/english.all.3class.distsim.crf.ser.gz'
jar_path = self.stanford_ner_tagger_jar #'/usr/local/stanford-ner/stanford-ner.jar'
self.stanford_ner_tagger = StanfordNERTagger(classifier_path,jar_path)
coord_map = self.patterns[pattern_index]["coordinate_map"]
pos_set = set([])
if "pos" in self.patterns[pattern_index]:
pos_set = set(self.patterns[pattern_index]["pos"])
if len(pos_set) > 0:
check_pos = True
lst = re.split("(\s+)", text)
cleaned = []
for item in lst:
if len(item) > 0:
cleaned.append(item)
ner_no_spaces = self.stanford_ner_tagger.tag(cleaned)
#get our ner tags
ner_set = {}
for tup in ner_no_spaces:
ner_set[tup[0]] = tup[1]
ner_set_with_locations = {}
start_coordinate = 0
for w in cleaned:
if w in ner_set:
ner_set_with_locations[w] = (ner_set[w], start_coordinate)
start_coordinate += len(w)
#for the text, break into words and mark POS
#with the parts of speech labeled, match any of these to our coordinate
#add these coordinates to our coordinate map
start_coordinate = 0
for word in cleaned:
word_clean = re.sub(pre_process, "", word.lower().strip())
if len(word_clean) == 0:
#got a blank space or something without any characters or digits, move forward
start_coordinate += len(word)
continue
if word in ner_set_with_locations:
ner_tag = ner_set_with_locations[word][0]
start = ner_set_with_locations[word][1]
if ner_tag in pos_set:
stop = start + len(word)
coord_map.add_extend(filename, start, stop)
print("FOUND: ",word, "NER: ", ner_tag, start, stop)
#advance our start coordinate
start_coordinate += len(word)
self.patterns[pattern_index]["coordinate_map"] = coord_map
def folder_walk(self, folder):
""" utility func will make a generator to walk a folder
returns root_directory,filename
for example:
foo/, bar001.txt
foo/, bar002.txt
"""
for root, dirs, files in os.walk(folder):
for filename in files:
yield root,filename
def get_exclude_include_maps(self, filename, pattern, txt):
coord_map = pattern["coordinate_map"]
exclude = pattern["exclude"]
try:
filter_path = pattern["filepath"]
except KeyError:
filter_path = pattern["title"]
if "phi_type" in pattern:
phi_type = pattern["phi_type"]
# self.patterns[pattern_index]["title"]
else:
phi_type = "OTHER"
for start,stop in coord_map.filecoords(filename):
if pattern['type'] != 'regex_context':
if exclude:
if not self.include_map.does_overlap(filename, start, stop):
self.exclude_map.add_extend(filename, start, stop)
self.phi_type_dict[phi_type][0].add_extend(filename, start, stop)
else:
if not self.exclude_map.does_overlap(filename, start, stop):
self.include_map.add_extend(filename, start, stop)
self.data_all_files[filename]["non-phi"].append({"start":start, "stop":stop, "word":txt[start:stop], "filepath":filter_path})
else:
pass
###########################
# Add regex_context to map separately
else:
if exclude:
self.exclude_map.add_extend(filename, start, stop)
self.include_map.remove(filename, start, stop)
self.phi_type_dict[phi_type][0].add_extend(filename, start, stop)
else:
self.include_map.add_extend(filename, start, stop)
self.exclude_map.remove(filename, start, stop)
self.data_all_files[filename]["non-phi"].append({"start":start, "stop":stop, "word":txt[start:stop], "filepath":filter_path})
###########################
# dont' need to loop through all PHi types -- just current one
# for start,stop in self.phi_type_dict[phi_type][0].filecoords(filename):
# self.data_all_files[filename]["phi"].append({"start":start, "stop":stop, "word":txt[start:stop],"phi_type":phi_type, "filepath":""})
def transform(self, allowed_filetypes=set(["txt", "ano"])):
""" transform
turns input files into output PHI files
protected health information will be replaced by the replacement character
transform the data
ORDER: Order is preserved prioritiy,
patterns at spot 0 will have priority over patterns at index 2
**Anything not caught in these passes will be assumed to be PHI
"""
in_path = self.finpath
out_path = self.foutpath
if self.verbose:
print("RUNNING TRANSFORM")
if not os.path.exists(in_path):
raise Exception("File input path does not exist", in_path)
if not os.path.exists(out_path):
raise Exception("File output path does not exist", out_path)
#create our final exclude and include maps, priority order
for root,f in self.folder_walk(in_path):
#keeps a record of all phi coordinates and text for a given file
# data = {}
filename = root+f
if filename.split(".")[-1] not in allowed_filetypes:
if self.verbose:
print("Skipping: ", filename)
continue
encoding = self.detect_encoding(filename)
txt = open(filename,"r", encoding=encoding['encoding']).read()
#now we transform the text
fbase, fext = os.path.splitext(f)
outpathfbase = out_path + fbase
if self.outformat == "asterisk":
with open(outpathfbase+".txt", "w", encoding='utf-8', errors='surrogateescape') as f:
contents = self.transform_text_asterisk(txt, filename)
f.write(contents)
elif self.outformat == "i2b2":
with open(outpathfbase+".xml", "w", errors='xmlcharrefreplace') as f: #TODO: should we have an explicit encoding?
contents = self.transform_text_i2b2(self.data_all_files[filename])
#print("writing contents to: " + outpathfbase+".xml")
f.write(contents)
else:
raise Exception("Outformat not supported: ",
self.outformat)
# print(data_all_files)
if self.run_eval: #output our data for eval
json.dump(self.data_all_files, open(self.coords, "w"), indent=4)
# infilename needed for addressing maps
def transform_text_asterisk(self, txt, infilename):
last_marker = 0
current_chunk = []
punctuation_matcher = re.compile(r"[^a-zA-Z0-9*]")
#read the text by character, any non-punc non-overlaps will be replaced
contents = []
for i in range(0, len(txt)):
if i < last_marker:
continue
if self.include_map.does_exist(infilename, i):
#add our preserved text
start,stop = self.include_map.get_coords(infilename, i)
contents.append(txt[start:stop])
last_marker = stop
elif punctuation_matcher.match(txt[i]):
contents.append(txt[i])
else:
contents.append("*")
return "".join(contents)
def transform_text_i2b2(self, tagdata):
"""creates a string in i2b2-XML format"""
root = "Philter"
contents = []
contents.append("<?xml version=\"1.0\" ?>\n")
contents.append("<"+root+">\n")
contents.append("<TEXT><![CDATA[")
contents.append(tagdata['text'])
contents.append("]]></TEXT>\n")
contents.append("<TAGS>\n")
for i in range(len(tagdata['phi'])):
phi_type = tagdata['phi'][i]['phi_type']
tagcategory = phi_type
contents.append("<")
contents.append(phi_type)
contents.append(" id=\"P")
contents.append(str(i))
contents.append("\" start=\"")
contents.append(str(tagdata['phi'][i]['start']))
contents.append("\" end=\"")
contents.append(str(tagdata['phi'][i]['stop']))
contents.append("\" text=\"")
contents.append(tagdata['phi'][i]['word'])
contents.append("\" TYPE=\"")
contents.append(phi_type)
contents.append("\" comment=\"\" />\n")
# for loop over complement - PHI, create additional tags (UNKNOWN)
contents.append("</TAGS>\n")
contents.append("</"+root+">\n")
return "".join(contents)
def detect_encoding(self, fp):
if not os.path.exists(fp):
raise Exception("Filepath does not exist", fp)
detector = UniversalDetector()
with open(fp, "rb") as f:
for line in f:
detector.feed(line)
if detector.done:
break
detector.close()
return detector.result
def phi_context(self, filename, word, word_index, words, context_window=10):
""" helper function, creates our phi data type with source file, and context window"""
if not os.path.exists(filename):
raise Exception("Filepath does not exist", filename)
left_index = word_index - context_window
if left_index < 0:
left_index = 0
right_index = word_index + context_window
if right_index >= len(words):
right_index = len(words) - 1
window = words[left_index:right_index]
#get which patterns matched this word
num_spaces = len(words[:word_index])
return {"filename":filename, "phi":word, "context":window}
def seq_eval(self,
note_lst,
anno_lst,
filename,
punctuation_matcher=re.compile(r"[^a-zA-Z0-9*]"),
text_matcher=re.compile(r"[a-zA-Z0-9]"),
phi_matcher=re.compile(r"\*+")):
"""
Compares two sequences item by item,
returns generator which yields:
classifcation, word
classifications can be TP, FP, FN, TN
corresponding to True Positive, False Positive, False Negative and True Negative
"""
# print(filename)
start_coordinate = 0
for note_word, anno_word in list(zip(note_lst, anno_lst)):
#print(note_word, anno_word)
##### Get coordinates ######
start = start_coordinate
stop = start_coordinate + len(note_word)
note_word_stripped = re.sub(r"[^a-zA-Z0-9\*]+", "", note_word.strip())
anno_word_stripped = re.sub(r"[^a-zA-Z0-9\*]+", "", anno_word.strip())
if len(note_word_stripped) == 0:
#got a blank space or something without any characters or digits, move forward
start_coordinate += len(note_word)
continue
if phi_matcher.search(anno_word):
#this contains phi
if note_word == anno_word:
# print(note_word, anno_word,'TP')
yield "TP", note_word, start_coordinate
else:
if text_matcher.search(anno_word):
#print("COMPLEX", note_word, anno_word)
#this is a complex edge case,
#the phi annotation has some characters *'ed, and some not,
#find the overlap and report any string of chars in anno as FP
#and any string of chars in note as FN
fn_words = []
fp_words = []
fn_chunk = []
fp_chunk = []
for n,a in list(zip(note_word, anno_word)):
if n == a:
#these characters match, clear our chunks
if len(fp_chunk) > 0:
fp_words.append("".join(fp_chunk))
fp_chunk = []
if len(fn_chunk) > 0:
fn_words.append("".join(fn_words))
fn_chunk = []
continue
if a == "*" and n != "*":
fn_chunk.append(n)
elif a != "*" and n == "*":
fp_chunk.append(a)
#clear any remaining chunks
if len(fp_chunk) > 0:
fp_words.append("".join(fp_chunk))
if len(fn_chunk) > 0:
fn_words.append("".join(fn_words))
#now drain the difference
for w in fn_words:
yield "FN", w, start_coordinate
for w in fp_words:
yield "FP", w, start_coordinate
else:
#simpler case, anno word is completely blocked out except punctuation
yield "FN", note_word, start_coordinate
else:
if note_word.isspace() == False:
#this isn't phi
if note_word == anno_word: