atomscale.similarity.provider.SimilarityTrajectoryProvider#

class atomscale.similarity.provider.SimilarityTrajectoryProvider[source]

Bases: TimeseriesProvider[SimilarityTrajectoryResult]

__init__()

Methods

__init__()

build_result(client, data_id, data_type, ...)

Build time series result object

fetch_raw(client, data_id, **kwargs)

Fetch similarity trajectory data from the API.

fetch_snapshot(client, req)

Resolve one snapshot request → domain-specific ImageResult (or None).

snapshot_image_uuids(frames_payload)

Extract requests from frames payload.

snapshot_url(data_id)

API endpoint that exposes extracted/snapshot frames.

to_dataframe(raw)

Convert raw payload to a tidy DataFrame with domain-specific renames/index.

Attributes

INDEX_COLS

RENAME_MAP

TYPE

fetch_raw(client: BaseClient, data_id: str, **kwargs: Any) → Any[source]

Fetch similarity trajectory data from the API.

Parameters:

  • client (BaseClient) – The API client.

  • data_id (str) – The source ID for the similarity query.

  • **kwargs (Any) – Must include ‘workflow’ (required). Optional parameters: window_span, reference_ids, softmax_mode, reference_n_values.

Return type:

Any

Returns:

Raw API response payload.

Raises:

KeyError – If ‘workflow’ is not provided in kwargs.

to_dataframe(raw: Any) → DataFrame[source]

Convert raw payload to a tidy DataFrame with domain-specific renames/index.

Parameters:

raw (Any)

Return type:

DataFrame

build_result(client: BaseClient, data_id: str, data_type: str, ts_df: DataFrame, *, workflow: str = '', window_span: float = 0.0, source_data_ids: Sequence[UUID | str] | None = None) → SimilarityTrajectoryResult[source]

Build time series result object

Parameters:

  • client (BaseClient)

  • data_id (str)

  • data_type (str)

  • ts_df (DataFrame)

  • workflow (str)

  • window_span (float)

  • source_data_ids (Sequence[UUID | str] | None)

Return type:

SimilarityTrajectoryResult

fetch_snapshot(client: BaseClient, req: dict) → Any | None

Resolve one snapshot request → domain-specific ImageResult (or None).

Parameters:

  • client (BaseClient)

  • req (dict)

Return type:

Any | None

snapshot_image_uuids(frames_payload: dict[str, Any]) → list[dict]

Extract requests from frames payload. Default: no snapshots.

Parameters:

frames_payload (dict[str, Any])

Return type:

list[dict]

snapshot_url(data_id: str) → str

API endpoint that exposes extracted/snapshot frames.

Parameters:

data_id (str)

Return type:

str