utils¶

get_actor(identifier)¶

Return the actor identifier from a given identifier (the first if tuple).

Parameters:: identifier (str | int | tuple[str | int, str | int]) – The identifier to extract the actor from.
Return type:: str | int
Returns:: The actor identifier.

interval_contained(intervals_1, intervals_2, element_wise=False)¶

Check if intervals in intervals_1 are contained within intervals in intervals_2.

Parameters:

intervals_1 (ndarray) – The first set of intervals.
intervals_2 (ndarray) – The second set of intervals.
element_wise (bool, default: False) – Whether to calculate containment element-wise.

Returns:

Whether intervals in intervals_1 are contained in intervals_2.

interval_overlap(intervals_1, intervals_2, clip_negative=True, element_wise=False, mask_diagonal=True)¶

Calculate the overlap between two sets of intervals.

Parameters:

intervals_1 (ndarray) – The first set of intervals.
intervals_2 (ndarray) – The second set of intervals.
clip_negative (bool, default: True) – Whether to clip negative overlaps to zero.
element_wise (bool, default: False) – Whether to calculate element-wise overlap.
mask_diagonal (bool, default: True) – Whether to mask the diagonal results with zero. Only applies when element_wise=True.

Return type:

ndarray

Returns:

The overlap between the two sets of intervals.