Similarity trajectory polling tracks how the RHEED pattern evolves over time relative to reference frames. It follows the same patterns as time series polling but uses dedicated functions fromDocumentation Index
Fetch the complete documentation index at: https://docs.atomscale.ai/llms.txt
Use this file to discover all available pages before exploring further.
atomscale.similarity.
| Function | Use case |
|---|---|
iter_poll_trajectory | Synchronous loop that blocks between polls |
start_polling_trajectory_thread | Background thread for GUI or acquisition loops |
aiter_poll_trajectory | Async iterator for asyncio applications |
start_polling_trajectory_task | Fire-and-forget asyncio task |
When to use trajectory polling
Use trajectory polling when you need to:- Track how the diffraction pattern changes during growth
- Detect when the pattern stabilizes or diverges from a reference
- Implement automatic stop conditions based on similarity thresholds
Setup
The
source_id parameter accepts either a data ID or a physical sample ID.Synchronous polling
Auto-stop on threshold
Use theuntil parameter to stop polling when a condition is met. By default, trajectory polling stops automatically when no trajectory is active.
Background thread polling
For integration with instrument control software:Async polling
Error handling
Pass anon_error handler to continue polling through transient failures:
Result structure
Each poll yields a DataFrame with a multi-level index and the following columns:| Column | Description |
|---|---|
Reference ID (index) | ID of the reference trajectory |
Time (index) | Real time in seconds |
Similarity | Similarity score (float) |
Reference Name | Display name of the reference |
UNIX Timestamp | Unix epoch timestamp |
Active | Whether the trajectory is currently active |
Averaged Count | Number of data points averaged |
Next steps
Poll Time Series
Monitor raw time series updates.
Stream RHEED
Set up RHEED streaming from your instrument.