de_twin.state.FrameMeta#

class de_twin.state.FrameMeta(frame_index, time_s, exposure_s, electrons_per_pixel, render_mode, blanked, scan_point=None, microscope=None, holder=None)[source]#

Bases: object

Metadata published alongside every simulated frame.

Parameters:

frame_index (int)
time_s (float)
exposure_s (float)
electrons_per_pixel (float)
render_mode (RenderMode)
blanked (bool)
scan_point (tuple[int, int] | None)
microscope (MicroscopeState | None)
holder (HolderState | None)

__init__(frame_index, time_s, exposure_s, electrons_per_pixel, render_mode, blanked, scan_point=None, microscope=None, holder=None)#

Parameters:

frame_index (int)
time_s (float)
exposure_s (float)
electrons_per_pixel (float)
render_mode (RenderMode)
blanked (bool)
scan_point (tuple[int, int] | None)
microscope (MicroscopeState | None)
holder (HolderState | None)

Return type:

None

Methods

__init__(frame_index, time_s, exposure_s, ...)

Attributes

`holder`
`microscope`
`scan_point`
`frame_index`
`time_s`
`exposure_s`
`electrons_per_pixel`
`render_mode`
`blanked`

frame_index: int#

time_s: float#

exposure_s: float#

electrons_per_pixel: float#

render_mode: RenderMode#

blanked: bool#

scan_point: tuple[int, int] | None = None#

microscope: MicroscopeState | None = None#

holder: HolderState | None = None#