Skip to content

Add 'parent' and 'children' properties to annotations and allow all tiers types with 'filter' #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
coxchristopher wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add 'parent' and 'children' properties to annotations and allow all tiers types with 'filter' #41

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 53 additions & 5 deletions speach/elan.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,6 +324,8 @@ def __init__(self, ID, value, cve_ref=None, xml_node=None, **kwargs):
self.__value = value
self.__cve_ref = cve_ref
self.__xml_node = xml_node
self.__parent = None
self.__children = []

@property
def ID(self):
Expand Down Expand Up @@ -362,6 +364,20 @@ def text(self):
def text(self, value):
self.value = value

@property
def children(self):
return self.__children

@property
def parent(self):
return self.__parent

def _register_parent(self, parent_ann):
""" [Internal] """
if parent_ann:
self.__parent = parent_ann
self.__parent.__children.append(self)

def __repr__(self):
return f"Annotation(ID={repr(self.ID)},value={repr(self.value)})"

Expand Down Expand Up @@ -434,6 +450,10 @@ def to_ts(self):
def duration(self):
return self.__ref.duration if self.ref is not None else None

@property
def parent(self):
return self.__ref

def resolve(self, elan_doc):
_ref_ann = elan_doc.annotation(self.__ref_id)
if _ref_ann is None:
Expand Down Expand Up @@ -615,14 +635,29 @@ def get_child(self, ID):
return child
return None

def filter(self, from_ts=None, to_ts=None):
def filter(self, from_ts=None, to_ts=None, use_parent_from_ts=False, use_parent_to_ts=False):
""" Filter utterances by from_ts or to_ts or both
If this tier is not a time-based tier everything will be returned
If this tier is not a time-based tier everything will be returned by default.
If use_parent_from_ts or use_parent_to_ts is True, then the start and end times for this annotation
are taken from the nearest time-aligned ancestor of this annotation (applies to non-time-aligned
annotations only; for time-aligned annotations, the annotation's own start and end times are always used).
"""
for ann in self.annotations:
if from_ts is not None and ann.from_ts is not None and ann.from_ts < from_ts:
ann_from_ts = ann.from_ts
if use_parent_from_ts:
while not ann_from_ts:
parent = ann.parent
ann_from_ts = parent.from_ts

ann_to_ts = ann.to_ts
if use_parent_to_ts:
while not ann_to_ts:
parent = ann.parent
ann_to_ts = parent.to_ts

if from_ts is not None and ann_from_ts is not None and ann_from_ts < from_ts:
continue
elif to_ts is not None and ann.to_ts is not None and ann.from_ts > to_ts:
elif to_ts is not None and ann_to_ts is not None and ann_to_ts > to_ts:
continue
else:
yield ann
Expand Down Expand Up @@ -668,7 +703,7 @@ def new_annotation(self, value, from_ts=None, to_ts=None, ann_ref_id=None, value
elan.ts2msec("00:00:01.600"),
ann_ref_id=a1.ID)

Annotations in Symbolic-Associtation tiers:
Annotations in Symbolic-Association tiers:

>>> eaf.new_linguistic_type('Translate', 'Symbolic_Association')
>>> tt = eaf.new_tier('Person1 (Translate)', 'Translate', 'Person1 (Utterance)')
Expand Down Expand Up @@ -720,6 +755,7 @@ def new_annotation(self, value, from_ts=None, to_ts=None, ann_ref_id=None, value
ann_info.set('ANNOTATION_ID', self.doc.new_annotation_id())
self.__xml_node.append(ann_node)
ann_obj = self._add_annotation_xml(ann_node)
ann_obj._register_parent(ann_ref)
self.doc._register_ann(ann_obj)
return ann_obj
elif self.stereotype in ('Time_Subdivision', 'Symbolic_Subdivision'):
Expand Down Expand Up @@ -759,6 +795,7 @@ def new_annotation(self, value, from_ts=None, to_ts=None, ann_ref_id=None, value
self.__xml_node.append(ann_node)
ann_obj = self._add_annotation_xml(ann_node)
ann_obj.resolve(self.doc)
ann_obj._register_parent(ann_ref)
self.doc._register_ann(ann_obj)
ann_objs.append(ann_obj)
return ann_objs
Expand Down Expand Up @@ -793,6 +830,7 @@ def new_annotation(self, value, from_ts=None, to_ts=None, ann_ref_id=None, value
ann_info.set('ANNOTATION_ID', self.doc.new_annotation_id())
self.__xml_node.append(ann_node)
ann_obj = self._add_annotation_xml(ann_node)
ann_obj._register_parent(ann_ref)
self.doc._register_ann(ann_obj)

ann_objs.append(ann_obj)
Expand All @@ -814,6 +852,7 @@ def new_annotation(self, value, from_ts=None, to_ts=None, ann_ref_id=None, value
self.__xml_node.append(ann_node)
ann_obj = self._add_annotation_xml(ann_node)
ann_obj.resolve(self.doc)
ann_obj._register_parent(ann_ref)
self.doc._register_ann(ann_obj)
return ann_obj
else:
Expand Down Expand Up @@ -1773,6 +1812,15 @@ def _resolve_structure(self):
for ann in self.__ann_map.values():
if ann.ref_id:
ann.resolve(self)
ann._register_parent(ann.ref)
# register parent-child relationships for non-reference annotations
aligned_child_tiers = [t for t in self if t.stereotype in ['Included_In', 'Time_Subdivision']]
for child_t in aligned_child_tiers:
parent_t = child_t.parent
for parent_ann in parent_t:
for child_ann in child_t.filter(parent_ann.from_ts, parent_ann.to_ts):
child_ann._register_parent(parent_ann)



@classmethod
Expand Down