avid.linkers.proximityLinker.TimePointProximityLinker

class avid.linkers.proximityLinker.TimePointProximityLinker(allow_only_full_linkage=True)

Bases: ProximityLinker

Links data on the basis of the artefactProps.TIMEPOINT entry.

__init__(allow_only_full_linkage=True)

:param key Indicating the property of the artefact that will be used to measure the proximity. :param proximity_delegate Function that takes to property values and computes an proximity score. The proximity score should be a positive number. 0 indicates perfect match. Lower scores are better than higher ones. :param allow_only_full_linkage see documentation of InnerLinkerBase.

Methods

__init__([allow_only_full_linkage])	:param key Indicating the property of the artefact that will be used to measure the proximity.
getLinkedSelection(primaryIndex, ...)	Get the subset (splits) of secondary selections that has a meaningful semantic link to the primary selection/index.
proximity_measure(val2)

getLinkedSelection(primaryIndex, primarySelections, secondarySelections)

Get the subset (splits) of secondary selections that has a meaningful semantic link to the primary selection/index. To change the behavior reimplement self._getLinkedSelection(). The default implementation just passes through the secondarySelections (so everything gets linked). Linker might alter a secondary selections before they are passed back as linked selections (e.g. change the order of the artefact in the selection or its content) @result List of all valid selections (list) of linked artefacts. Therefore all selections of artefacts from secondarySelections that fullfill the link criterion in respect to the primary selection. @param primaryIndex index of the entry in the primarySelections that is defining for the link. @param primarySelections the list of all selections that contain sets of primary artefacts @param secondarySelections the list that is used to generate/pick the linked selections from.