module__org.bibliome.alvisnlp.modules.RemoveOverlaps

#org.bibliome.alvisnlp.modules.RemoveOverlaps

Synopsis

Removes overlapping annotations from a given layer.

Description

org.bibliome.alvisnlp.modules.RemoveOverlaps removes overlapping annotations in the layer layerName.

org.bibliome.alvisnlp.modules.RemoveOverlaps scans each specified layer and finds clusters of overlapping annotations. org.bibliome.alvisnlp.modules.RemoveOverlaps distinguishes three overlapping situations:

1. equal: two annotations have exactly the same span;
2. included: one annotation includes the other completely;
3. overlapping: one annotation overlaps with the head or the tail of the other annotation.

removeEqual, removeIncluded and removeOverlapping specify the behavior for each situation. If the parameter is true, then org.bibliome.alvisnlp.modules.RemoveOverlaps will remove one of the annotations.

annotationComparator controls which annotation is removed.

  By default *org.bibliome.alvisnlp.modules.RemoveOverlaps* removes all kinds of annotations, keeping the longest one.

Parameters

layerName

Optional

Type: String

Name of the layer to clear.

annotationComparator

Default value: length

Type: AnnotationComparator

Comparator to use in order to choose between overlapping annotations.

documentFilter

Default value: true

Type: Expression

Only process document that satisfy this filter.

removeEqual

Default value: true

Type: Boolean

Either to remove annotations with equal spans.

removeIncluded

Default value: true

Type: Boolean

Either to remove annotations fully included in another annotation.

removeOverlapping

Default value: true

Type: Boolean

Either to remove strictly overlapping annotations.

sectionFilter

Default value: true

Type: Expression

Process only sections that satisfy this filter.