Skip to main content
Use client.get() to fetch analysis results for items in the catalogue. The method returns result objects with time series data, extracted frames, pattern graphs, and more.

Fetch analysed items

Each item in analysed is a result object depending on the source data type: RHEEDVideoResult, RHEEDImageResult, XPSResult, PhotoluminescenceResult, RamanResult, MetrologyResult, or OpticalResult.

Inspect time series data

For video results, access the timeseries_data attribute to get a DataFrame with per-frame metrics:
The timeseries frame contains specular intensity, strain metrics, cluster IDs, and other summary features for every frame in the video.

Work with extracted frames

Video results include snapshot images at key moments:
The pattern_graph exposes the detected diffraction network, while get_pattern_dataframe() returns positions, intensities, and labels for each spot.

Inspect spectroscopy results

For XPS, photoluminescence, and Raman results, access the spectral data and generate plots:

Inspect metrology and optical results

Metrology and optical results provide timeseries data from instrument sensors and optical imaging:

Download processed videos

Save annotated MP4 videos to disk:
The files mirror what you see in the web UI.

Download raw files

To download the original uploaded file instead of processed output:

Next steps

Stream RHEED

Push frames from your instrument in real time.

Poll Time Series

Monitor streaming analysis updates.