Source

orange-textable / _textable / widgets / OWTextableMerge.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
#=============================================================================
# Class OWTextableMerge, v0.15
# Copyright 2012-2013 LangTech Sarl (info@langtech.ch)
#=============================================================================
# This file is part of the Textable (v1.3) extension to Orange Canvas.
#
# Textable v1.3 is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# Textable v1.3 is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Textable v1.3. If not, see <http://www.gnu.org/licenses/>.
#=============================================================================

"""
<name>Merge</name>
<description>Merge two or more segmentations</description>
<icon>icons/Merge.png</icon>
<priority>4001</priority>
"""


import uuid

from LTTL.Segmentation import Segmentation
from LTTL.Input        import Input
from LTTL.Segmenter    import Segmenter

from TextableUtils      import *

from Orange.OrangeWidgets.OWWidget import *
import OWGUI


class OWTextableMerge(OWWidget):

    """Orange widget for merging segmentations"""

    contextHandlers = {
        "": SegmentationListContextHandler(
            "", [ContextInputListField("texts"),
                 ContextListField("textLabels", selected="selectedTextLabels")
                 ],
        )
    }
    settingsList = [
            'autoSend',
            'copyAnnotations',
            'label',
            'importLabels',
            'labelKey',
            'autoNumber',
            'autoNumberKey',
            'sortSegments',
            'mergeDuplicates',
            'displayAdvancedSettings',
            'uuid',
    ]
    
    def __init__(self, parent=None, signalManager=None):

        OWWidget.__init__(
                self,
                parent,
                signalManager,
                'TextableMerge',
                wantMainArea=0,
        )
        
        # Input and output channels...
        self.inputs  = [('Segmentation', Segmentation, self.inputData, Multiple)]
        self.outputs = [('Merged data', Segmentation)]

        # Settings...
        self.autoSend                   = True
        self.label                      = u'merged_data'
        self.importLabels               = True
        self.labelKey                   = u'component_labels'
        self.autoNumber                 = False
        self.autoNumberKey              = u'num'
        self.copyAnnotations            = True
        self.sortSegments               = False
        self.mergeDuplicates            = False
        self.displayAdvancedSettings    = False
        self.uuid                       = None
        self.savedSenderUuidOrder       = []
        self.loadSettings()
        self.uuid = getWidgetUuid(self)

        # Other attributes...
        self.segmenter              = Segmenter();
        self.texts                  = [];
        self.textLabels             = [];
        self.selectedTextLabels     = [];
        self.settingsRestored       = False                                         
        self.infoBox                = InfoBox(widget=self.controlArea)
        self.sendButton             = SendButton(
                widget              = self.controlArea,
                master              = self,
                callback            = self.sendData,
                infoBoxAttribute    = 'infoBox',
                sendIfPreCallback   = self.updateGUI,
        )
        self.advancedSettings = AdvancedSettings(
                widget              = self.controlArea,
                master              = self,
                callback            = self.sendButton.settingsChanged,
        )

        # GUI...

        self.advancedSettings.draw()

        # Ordering box
        orderingBox = OWGUI.widgetBox(
                widget              = self.controlArea,
                box                 = u'Ordering',
                orientation         = 'vertical',
                addSpace            = True,
        )
        orderingBoxLine1 = OWGUI.widgetBox(
                widget              = orderingBox,
                orientation         = 'horizontal',
        )
        self.textListbox = OWGUI.listBox(
                widget              = orderingBoxLine1,
                master              = self,
                value               = 'selectedTextLabels',
                labels              = 'textLabels',
                callback            = self.sendButton.settingsChanged,
                tooltip             = (
                        u"List of segmentations that will be merged\n\n"
                        u"By default, segments of the input segmentations\n"
                        u"appear in the same order in the output segmentation"
                        u"\nas in the list (see 'Sort segments' below)."
                ),
        )
        orderingBoxCol2 = OWGUI.widgetBox(
                widget              = orderingBoxLine1,
                orientation         = 'vertical',
        )
        self.moveUpButton = OWGUI.button(
                widget              = orderingBoxCol2,
                master              = self,
                label               = u'Move Up',
                callback            = self.moveUp,
                tooltip             = (
                        u"Move the selected segmentation upward in the list."
                ),
        )
        self.moveDownButton = OWGUI.button(
                widget              = orderingBoxCol2,
                master              = self,
                label               = u'Move Down',
                callback            = self.moveDown,
                tooltip             = (
                       u"Move the selected segmentation downward in the list."
                ),
        )
        OWGUI.separator(
                widget              = orderingBox,
                height              = 3,
        )

        # Advanced Options box...
        optionsBox = OWGUI.widgetBox(
                widget              = self.controlArea,
                box                 = u'Options',
                orientation         = 'vertical',
        )
        OWGUI.lineEdit(
                widget              = optionsBox,
                master              = self,
                value               = 'label',
                orientation         = 'horizontal',
                label               = u'Output segmentation label:',
                labelWidth          = 160,
                callback            = self.sendButton.settingsChanged,
                tooltip             = (
                        u"Label of the output segmentation."
                ),
        )
        OWGUI.separator(
                widget              = optionsBox,
                height              = 3,
        )
        optionsBoxLine2 = OWGUI.widgetBox(
                widget              = optionsBox,
                box                 = False,
                orientation         = 'horizontal',
        )
        OWGUI.checkBox(
                widget              = optionsBoxLine2,
                master              = self,
                value               = 'importLabels',
                label               = u'Import labels with key:',
                labelWidth          = 160,
                callback            = self.sendButton.settingsChanged,
                tooltip             = (
                       u"Import labels of input segmentations as annotations."
                ),
        )
        self.labelKeyLineEdit = OWGUI.lineEdit(
                widget              = optionsBoxLine2,
                master              = self,
                value               = 'labelKey',
                orientation         = 'horizontal',
                callback            = self.sendButton.settingsChanged,
                tooltip             = (
                        u"Annotation key for importing input segmentation\n"
                        u"labels."
                ),
        )
        OWGUI.separator(
                widget              = optionsBox,
                height              = 3,
        )
        optionsBoxLine3 = OWGUI.widgetBox(
                widget              = optionsBox,
                box                 = False,
                orientation         = 'horizontal',
        )
        OWGUI.checkBox(
                widget              = optionsBoxLine3,
                master              = self,
                value               = 'autoNumber',
                label               = u'Auto-number with key:',
                labelWidth          = 160,
                callback            = self.sendButton.settingsChanged,
                tooltip             = (
                        u"Annotate input segments with increasing numeric\n"
                        u"indices\n\n"
                        u"Note that a distinct index will be assigned to\n"
                        u"each segment of each input segmentation."
                ),
        )
        self.autoNumberKeyLineEdit = OWGUI.lineEdit(
                widget              = optionsBoxLine3,
                master              = self,
                value               = 'autoNumberKey',
                orientation         = 'horizontal',
                callback            = self.sendButton.settingsChanged,
                tooltip             = (
                        u"Annotation key for input segment auto-numbering."
                ),
        )
        OWGUI.separator(
                widget              = optionsBox,
                height              = 3,
        )
        OWGUI.checkBox(
                widget              = optionsBox,
                master              = self,
                value               = 'copyAnnotations',
                label               = u'Copy annotations',
                callback            = self.sendButton.settingsChanged,
                tooltip             = (
                        u"Copy all annotations from input to output segments."
                ),
        )
        OWGUI.separator(
                widget              = optionsBox,
                height              = 3,
        )
        OWGUI.checkBox(
                widget              = optionsBox,
                master              = self,
                value               = 'sortSegments',
                label               = u'Sort segments',
                callback            = self.sendButton.settingsChanged,
                tooltip             = (
                        u"Re-order segments in the output segmentation.\n\n"
                        u"Output segments will be sorted by 'string_index',\n"
                        u"then by start position, and finally by end position."
                ),
        )
        OWGUI.separator(
                widget              = optionsBox,
                height              = 3,
        )
        OWGUI.checkBox(
                widget              = optionsBox,
                master              = self,
                value               = 'mergeDuplicates',
                label               = u'Merge duplicate segments',
                callback            = self.sendButton.settingsChanged,
                tooltip             = (
                        u"Merge segments that have the same address.\n\n"
                        u"The annotation of merged segments will be merged\n"
                        u"as well. In the case where merged segments have\n"
                        u"distinct values for the same annotation key, only\n"
                        u"the value of the last one (in the list order)\n"
                        u"will be kept."
                ),
        )
        OWGUI.separator(
                widget              = optionsBox,
                height              = 3,
        )
        self.advancedSettings.advancedWidgets.append(optionsBox)
        self.advancedSettings.advancedWidgetsAppendSeparator()

        # Basic Options box...
        basicOptionsBox = OWGUI.widgetBox(
                widget              = self.controlArea,
                box                 = u'Options',
                orientation         = 'vertical',
        )
        OWGUI.lineEdit(
                widget              = basicOptionsBox,
                master              = self,
                value               = 'label',
                orientation         = 'horizontal',
                label               = u'Output segmentation label:',
                labelWidth          = 160,
                callback            = self.sendButton.settingsChanged,
                tooltip             = (
                        u"Label of the output segmentation."
                ),
        )
        OWGUI.separator(
                widget              = basicOptionsBox,
                height              = 3,
        )
        basicOptionsBoxLine2 = OWGUI.widgetBox(
                widget              = basicOptionsBox,
                box                 = False,
                orientation         = 'horizontal',
        )
        OWGUI.checkBox(
                widget              = basicOptionsBoxLine2,
                master              = self,
                value               = 'importLabels',
                label               = u'Import labels with key:',
                labelWidth          = 160,
                callback            = self.sendButton.settingsChanged,
                tooltip             = (
                       u"Import labels of input segmentations as annotations."
                ),
        )
        self.labelKeyLineEdit = OWGUI.lineEdit(
                widget              = basicOptionsBoxLine2,
                master              = self,
                value               = 'labelKey',
                orientation         = 'horizontal',
                callback            = self.sendButton.settingsChanged,
                tooltip             = (
                        u"Annotation key for importing input segmentation\n"
                        u"labels."
                ),
        )
        OWGUI.separator(
                widget              = basicOptionsBox,
                height              = 3,
        )
        self.advancedSettings.basicWidgets.append(basicOptionsBox)
        self.advancedSettings.basicWidgetsAppendSeparator()

        # Info box...
        self.infoBox.draw()

        # Send button...
        self.sendButton.draw()

        self.updateGUI()

        self.sendButton.sendIf()


    def sendData(self):

        """Check inputs, build merged segmentation, then send it"""

        # Check that there's something on input...
        if not self.texts:
            self.infoBox.noDataSent(u'No input.')
            self.send('Merged data', None, self)
            return

        # Extract segmentations from self.texts and get number of segments...
        segmentations = [text[1] for text in self.texts]
        num_segments  = sum([len(s) for s in segmentations])

        # Check that label is not empty...
        if not self.label:
            self.infoBox.noDataSent(u'No label was provided.')
            self.send('Merged data', None, self)
            return

        # Check that labelKey is not empty (if necessary)...
        if self.importLabels:
            if self.labelKey:
                labelKey = self.labelKey
            else:
                self.infoBox.noDataSent(
                        u'No annotation key was provided for imported labels.'
                )
                self.send('Merged data', None, self)
                return
        else:
            labelKey = None

        # Check that autoNumberKey is not empty (if necessary)...
        if self.displayAdvancedSettings and self.autoNumber:
            if self.autoNumberKey:
                autoNumberKey = self.autoNumberKey
                num_iterations = num_segments * 2
            else:
                self.infoBox.noDataSent(
                        u'No annotation key was provided for auto-numbering.'
                )
                self.send('Merged data', None, self)
                return
        else:
            autoNumberKey = None
            num_iterations = num_segments

        # Basic settings...
        if self.displayAdvancedSettings:
            sortSegments    = self.sortSegments
            mergeDuplicates = self.mergeDuplicates
            copyAnnotations = self.copyAnnotations
        else:
            sortSegments    = False
            mergeDuplicates = False
            copyAnnotations = True

        # Initialize progress bar...
        if self.mergeDuplicates:
            num_iterations += num_segments
        progressBar = OWGUI.ProgressBar(
                self,
                iterations = num_iterations
        )

        # Perform concatenation.
        concatenation = self.segmenter.concatenate(
            segmentations,
            label               = self.label,
            copy_annotations    = copyAnnotations,
            import_labels_as    = labelKey,
            auto_numbering_as   = autoNumberKey,
            sort                = sortSegments,
            merge_duplicates    = mergeDuplicates,
            progress_callback   = progressBar.advance,
        )
        progressBar.finish()
        message = u'Data contains %i segment@p.' % len(concatenation)
        message = pluralize(message, len(concatenation))
        self.infoBox.dataSent(message)

        self.send('Merged data', concatenation, self)
        self.sendButton.resetSettingsChangedFlag()


    def inputData(self, newItem, newId=None):
        """Process incoming data."""
        self.closeContext()
        updateMultipleInputs(self.texts, newItem, newId)
        self.textLabels = [text[1].label for text in self.texts]
        self.infoBox.inputChanged()
        self.sendButton.sendIf()


    def updateGUI(self):
        """Update GUI state"""
        if self.importLabels:
            self.labelKeyLineEdit.setDisabled(False)
        else:
            self.labelKeyLineEdit.setDisabled(True)
        if self.autoNumber:
            self.autoNumberKeyLineEdit.setDisabled(False)
        else:
            self.autoNumberKeyLineEdit.setDisabled(True)
        if self.selectedTextLabels:
            if self.selectedTextLabels[0] > 0:
                self.moveUpButton.setDisabled(False)
            else:
                self.moveUpButton.setDisabled(True)
            if self.selectedTextLabels[0] < len(self.texts) - 1:
                self.moveDownButton.setDisabled(False)
            else:
                self.moveDownButton.setDisabled(True)
        else:
            self.moveUpButton.setDisabled(True)
            self.moveDownButton.setDisabled(True)

        if self.displayAdvancedSettings:
            self.advancedSettings.setVisible(True)
        else:
            self.advancedSettings.setVisible(False)


    def moveUp(self):
        """Move text upward in Ordering listbox"""
        if self.selectedTextLabels:
            index = self.selectedTextLabels[0]
            if index > 0:
                temp                = self.texts[index-1]
                self.texts[index-1] = self.texts[index]
                self.texts[index]   = temp
                self.textLabels     = [text[1].label for text in self.texts]
                self.selectedTextLabels.listBox.item(index-1).setSelected(1)
                self.sendButton.settingsChanged()


    def moveDown(self):
        """Move text downward in Ordering listbox"""
        if self.selectedTextLabels:
            index = self.selectedTextLabels[0]
            if index < len(self.texts)-1:
                temp                = self.texts[index+1]
                self.texts[index+1] = self.texts[index]
                self.texts[index]   = temp
                self.textLabels     = [text[1].label for text in self.texts]
                self.selectedTextLabels.listBox.item(index+1).setSelected(1)
                self.sendButton.settingsChanged()



    def handleNewSignals(self):
        """Overridden: called after multiple signals have been added"""
        self.openContext("", self.texts)
        self.updateGUI()
        self.sendButton.sendIf()

#     def getSettings(self, alsoContexts = True, globalContexts=False):
#         """Overridden: called when a file is saved (among other situations)"""
#         try:
#             self.storeSettings()
#         except AttributeError:
#             pass
#         return super(type(self), self).getSettings(
#                 alsoContexts=alsoContexts, globalContexts=globalContexts
#         )
#
#     def restoreSettings(self):
#         """When a sheme file is opened, restore those settings that depend
#         on the particular segmentations that enter this widget.
#         """
#         if not self.settingsRestored:
#             self.settingsRestored = True
#             oldTexts = self.texts[:]
#             for senderUuidIndex in xrange(len(self.savedSenderUuidOrder)):
#                 for text in oldTexts:
#                     senderUuid = self.savedSenderUuidOrder[senderUuidIndex]
#                     if text[0][2].uuid == senderUuid:
#                         self.texts[senderUuidIndex] = text
#                         break
#             self.textLabels = [text[1].label for text in self.texts]
#             self.sendButton.sendIf()
#
#     def storeSettings(self):
#         """When a scheme file is saved, store those settings that depend
#         on the particular segmentations that enter this widget.
#         """
#         if self.settingsRestored:
#             self.savedSenderUuidOrder = [t[0][2].uuid for t in self.texts]


if __name__ == '__main__':
    from LTTL.Segmenter import Segmenter
    from LTTL.Input     import Input
    appl = QApplication(sys.argv)
    ow   = OWTextableMerge()
    seg1 = Input(u'hello world', label=u'text1')
    seg2 = Input(u'cruel world', label=u'text2')
    segmenter = Segmenter()
    seg3 = segmenter.concatenate([seg1, seg2], label=u'corpus')
    seg4 = segmenter.tokenize(seg3, [(r'\w+(?u)',u'tokenize',{'type':'mot'})], label=u'words')
    ow.inputData(seg3, 1)
    ow.inputData(seg4, 2)
    ow.show()
    appl.exec_()
    ow.saveSettings()
    QMessageBox()