roboto.analytics.signal_similarity.match#

Module Contents#

class roboto.analytics.signal_similarity.match.Match#

A subsequence of a target signal that is similar to a query signal.

context: MatchContext#

Correlate a matched subsequence back to its source.

distance: float#

Unitless measure of similarity between a query signal and the subsequence of the target signal this Match represents. A smaller distance relative to a larger distance indicates a “closer” match.

end_idx: int#

The end index in the target signal of this match.

end_time: int#

The end time in the target signal of this match.

start_idx: int#

The start index in the target signal of this match.

start_time: int#

The start time in the target signal of this match.

subsequence: pandas.DataFrame#

The subsequence of the target signal this Match represents. It is equivalent to target[start_idx:end_idx].

to_event(name='Signal Similarity Match Result', caller_org_id=None, roboto_client=None)#

Create a Roboto Platform event out of this similarity match result.

Parameters:
Return type:

roboto.domain.events.Event

class roboto.analytics.signal_similarity.match.MatchContext#

Correlate a matched subsequence back to its source.

dataset_id: str | None = None#
file_id: str | None = None#
message_paths: collections.abc.Sequence[str]#
topic_id: str#
topic_name: str#