atomscale.results.rheed_video#

Result objects for RHEED video analysis.

Classes

RHEEDVideoResult(data_id, timeseries_data, ...)

RHEED video result
class atomscale.results.rheed_video.RHEEDVideoResult(data_id: UUID | str, timeseries_data: DataFrame, snapshot_image_data: list[RHEEDImageResult] | None, rotating: bool, collected_datetime: str | None = None)[source]

Bases: MSONable

RHEED video result

Parameters:

  • data_id (UUID | str) – Data ID for the entry in the data catalogue.

  • timeseries_data (DataFrame) – Pandas DataFrame with per-frame RHEED features, indexed against a “Time” column. Columns are capitalized labels such as “Cluster ID”, “Specular Intensity”, “Strain”, “Cumulative Strain”, “Oscillation Period”, “Diffraction Spot Count”, and “Lattice Spacing”.

  • snapshot_image_data (list[atomscale.results.rheed_image.RHEEDImageResult] | None) – One atomscale.results.rheed_image.RHEEDImageResult per snapshot extracted from the video, or None if no snapshots were extracted.

  • rotating (bool) – Whether the video was taken of a rotating stage.

  • collected_datetime (str | None) – Datetime when the data was collected.