atomicds.results.rheed_video.RHEEDVideoResult

class atomicds.results.rheed_video.RHEEDVideoResult(data_id: UUID | str, timeseries_data: DataFrame, cluster_image_data: list[RHEEDImageResult] | None, snapshot_image_data: list[RHEEDImageResult] | None, rotating: bool)[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 timeseries data associated with the video. Includes cluster assignments, specular intensity, strain, etc…

  • cluster_image_data (list[RHEEDImageResult]) – List of RHEEDImageResult objects containing data for images associated with each identified cluster in the video.

  • snapshot_image_data (list[RHEEDImageResult]) – List of RHEEDImageResult objects containing data for images associated with each user extracted snapshot in the video.

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

__init__(data_id: UUID | str, timeseries_data: DataFrame, cluster_image_data: list[RHEEDImageResult] | None, snapshot_image_data: list[RHEEDImageResult] | None, rotating: bool)[source]

RHEED video result

Parameters:

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

  • timeseries_data (DataFrame) – Pandas DataFrame with timeseries data associated with the video. Includes cluster assignments, specular intensity, strain, etc…

  • cluster_image_data (list[RHEEDImageResult]) – List of RHEEDImageResult objects containing data for images associated with each identified cluster in the video.

  • snapshot_image_data (list[RHEEDImageResult]) – List of RHEEDImageResult objects containing data for images associated with each user extracted snapshot in the video.

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

Methods

__init__(data_id, timeseries_data, ...)

RHEED video result

as_dict()

A JSON serializable dict representation of an object.

from_dict(d)

get_partial_json([json_kwargs, pickle_kwargs])

get_plot()

Get plot of timeseries data associated with this RHEED video

load(file_path)

Loads a class from a provided json file.

save(json_path[, mkdir, json_kwargs, ...])

Utility that uses the standard tools of MSONable to convert the class to json format, but also save it to disk.

to_json()

Returns a json string representation of the MSONable object.

unsafe_hash()

Returns an hash of the current object.

validate_monty_v1(_MSONable__input_value)

Pydantic validator with correct signature for pydantic v1.x

validate_monty_v2(_MSONable__input_value, _)

Pydantic validator with correct signature for pydantic v2.x

Attributes

REDIRECT

get_plot() → Figure[source]

Get plot of timeseries data associated with this RHEED video

Returns:

Matplotlib Figure object containing plot data

Return type:

(Figure)

as_dict() → dict

A JSON serializable dict representation of an object.

classmethod from_dict(d)
Parameters:

d – Dict representation.

Returns:

MSONable class.

get_partial_json(json_kwargs=None, pickle_kwargs=None)
Parameters:

  • json_kwargs (dict) – Keyword arguments to pass to the serializer.

  • pickle_kwargs (dict) – Keyword arguments to pass to pickle.dump.

Returns:

The json encoding of the class and the name-object map if one is required, otherwise None.

Return type:

str, dict

classmethod load(file_path)

Loads a class from a provided json file.

Parameters:

file_path (os.PathLike) – The json file to load from.

Returns:

An instance of the class being reloaded.

Return type:

MSONable

save(json_path, mkdir=True, json_kwargs=None, pickle_kwargs=None, strict=True)

Utility that uses the standard tools of MSONable to convert the class to json format, but also save it to disk. In addition, this method intelligently uses pickle to individually pickle class objects that are not serializable, saving them separately. This maximizes the readability of the saved class information while allowing _any_ class to be at least partially serializable to disk.

For a fully MSONable class, only a class.json file will be saved to the location {save_dir}/class.json. For a partially MSONable class, additional information will be saved to the save directory at {save_dir}. This includes a pickled object for each attribute that e serialized.

Parameters:

  • file_path (os.PathLike) – The file to which to save the json object. A pickled object of the same name but different extension might also be saved if the class is not entirely MSONable.

  • mkdir (bool) – If True, makes the provided directory, including all parent directories.

  • json_kwargs (dict) – Keyword arguments to pass to the serializer.

  • pickle_kwargs (dict) – Keyword arguments to pass to pickle.dump.

  • strict (bool) – If True, will not allow you to overwrite existing files.

to_json() → str

Returns a json string representation of the MSONable object.

unsafe_hash()

Returns an hash of the current object. This uses a generic but low performance method of converting the object to a dictionary, flattening any nested keys, and then performing a hash on the resulting object

classmethod validate_monty_v1(_MSONable__input_value)

Pydantic validator with correct signature for pydantic v1.x

classmethod validate_monty_v2(_MSONable__input_value, _)

Pydantic validator with correct signature for pydantic v2.x