em.hardware.v1

zen_api.em.hardware.v1

Classes:

• AcquisitionResponseType –

  Indicates the type of response returned by the camera live image acquisition stream.

• AcquisitionStatus –

  Acquisition states.

• BeamState –

  Possible beam operating states.

• CameraAcquisitionStatus –

  Acquisition states.

• CcdMode –

  The CCD mode enumeration.

• CommandId –
• VacuumMode –

  Possible vacuum modes supported by our tools.

• VacuumState –

  Possible states of the vacuum system.

• ValveState –

  Possible states of any valve.

• Valve –

  Enumeration of all possibles valves to control.

• AcquisitionSettings –

  Request object to set the simple acquisition settings.

• CameraAcquisitionSettings –
• CameraServiceGetAcquisitionStatusRequest –

  The CameraServiceGetAcquisitionStatusRequest class.

• CameraServiceGetAcquisitionStatusResponse –

  Response object for the get acquisition state.

• CameraServiceGetAvailableCamerasRequest –

  The CameraServiceGetAvailableCamerasRequest class.

• CameraServiceGetAvailableCamerasResponse –

  Response object representing a list of available cameras.

• CameraServiceGetBrightnessRequest –

  The CameraServiceGetBrightnessRequest class.

• CameraServiceGetBrightnessResponse –

  Response object for the get brightness.

• CameraServiceGetCcdModeRequest –

  The CameraServiceGetCcdModeRequest class.

• CameraServiceGetCcdModeResponse –

  Response object for the get CCD mode.

• CameraServiceGetContrastRequest –

  The CameraServiceGetContrastRequest class.

• CameraServiceGetContrastResponse –

  Response object for the get contrast.

• CameraServiceRegisterOnAcquisitionStatusChangedRequest –

  The CameraServiceRegisterOnAcquisitionStatusChangedRequest class.

• CameraServiceRegisterOnAcquisitionStatusChangedResponse –

  Response object for the get acquisition state.

• CameraServiceRegisterOnBrightnessChangedRequest –

  The CameraServiceRegisterOnBrightnessChangedRequest class.

• CameraServiceRegisterOnBrightnessChangedResponse –

  Response object for the get brightness.

• CameraServiceRegisterOnCcdModeChangedRequest –

  The CameraServiceRegisterOnCcdModeChangedRequest class.

• CameraServiceRegisterOnCcdModeChangedResponse –

  Response object for the get CCD mode.

• CameraServiceRegisterOnContrastChangedRequest –

  The CameraServiceRegisterOnContrastChangedRequest class.

• CameraServiceRegisterOnContrastChangedResponse –

  Response object for the get contrast.

• CameraServiceSetBrightnessRequest –

  The CameraServiceSetBrightnessRequest class.

• CameraServiceSetBrightnessResponse –

  Response object for the set brightness.

• CameraServiceSetCcdModeRequest –

  The CameraServiceSetCcdModeRequest class.

• CameraServiceSetCcdModeResponse –

  Response object for the set CCD mode.

• CameraServiceSetContrastRequest –

  The CameraServiceSetContrastRequest class.

• CameraServiceSetContrastResponse –

  Response object for the set contrast.

• CameraServiceStartLiveAcquisitionRequest –

  The CameraServiceStartLiveAcquisitionRequest class.

• CameraServiceStartLiveAcquisitionResponse –

  Response object of the camera live image acquisition.

• CameraServiceStartSingleAcquisitionRequest –

  The CameraServiceStartSingleAcquisitionRequest class.

• CameraServiceStartSingleAcquisitionResponse –

  Response object of the camera single image acquisition.

• CameraServiceStopLiveAcquisitionRequest –

  The CameraServiceStopLiveAcquisitionRequest class.

• CameraServiceStopLiveAcquisitionResponse –

  Response object of the camera stop acquisition.

• DetectorServiceGetAvailableDetectorsRequest –

  The DetectorServiceGetAvailableDetectorsRequest class.

• DetectorServiceGetAvailableDetectorsResponse –

  Response object representing a list of available detectors.

• DetectorServiceGetBrightnessRequest –

  The DetectorServiceGetBrightnessRequest class.

• DetectorServiceGetBrightnessResponse –

  Response object representing a detector brightness value.

• DetectorServiceGetContrastRequest –

  The DetectorServiceGetContrastRequest class.

• DetectorServiceGetContrastResponse –

  Response object representing a detector contrast value.

• DetectorServiceRegisterOnBrightnessChangedRequest –

  The DetectorServiceRegisterOnBrightnessChangedRequest class.

• DetectorServiceRegisterOnBrightnessChangedResponse –

  Response object representing a detector brightness value.

• DetectorServiceRegisterOnContrastChangedRequest –

  The DetectorServiceRegisterOnContrastChangedRequest class.

• DetectorServiceRegisterOnContrastChangedResponse –

  Response object representing a detector contrast value.

• DetectorServiceSetBrightnessRequest –

  The DetectorServiceSetBrightnessRequest class.

• DetectorServiceSetBrightnessResponse –

  Response object representing a detector brightness value.

• DetectorServiceSetContrastRequest –

  The DetectorServiceSetContrastRequest class.

• DetectorServiceSetContrastResponse –

  Response object representing a detector contrast value.

• ElectronColumnServiceGetActualVoltageRequest –

  The ElectronColumnServiceGetActualVoltageRequest class.

• ElectronColumnServiceGetActualVoltageResponse –

  Response object representing the eht/voltage.

• ElectronColumnServiceGetBeamShiftRequest –

  The ElectronColumnServiceGetBeamShiftRequest class.

• ElectronColumnServiceGetBeamShiftResponse –

  Response object describing the beam shift values.

• ElectronColumnServiceGetBeamStateRequest –

  The ElectronColumnServiceGetBeamStateRequest class.

• ElectronColumnServiceGetBeamStateResponse –

  BeamState enum wrapper.

• ElectronColumnServiceGetFocusLimitsRequest –

  The ElectronColumnServiceGetFocusLimitsRequest class.

• ElectronColumnServiceGetFocusLimitsResponse –

  Response object representing the column focus.

• ElectronColumnServiceGetFocusRequest –

  The ElectronColumnServiceGetFocusRequest class.

• ElectronColumnServiceGetFocusResponse –

  Response object representing the column focus.

• ElectronColumnServiceGetFovRequest –

  The ElectronColumnServiceGetFovRequest class.

• ElectronColumnServiceGetFovResponse –

  Response object representing the field of view expansion.

• ElectronColumnServiceGetFovRotationRequest –

  The ElectronColumnServiceGetFovRotationRequest class.

• ElectronColumnServiceGetFovRotationResponse –

  Response object representing the field of view rotation.

• ElectronColumnServiceGetProbeCurrentRequest –

  The ElectronColumnServiceGetProbeCurrentRequest class.

• ElectronColumnServiceGetProbeCurrentResponse –

  Response object representing the probe current.

• ElectronColumnServiceGetSemiAngleRequest –

  The ElectronColumnServiceGetSemiAngleRequest class.

• ElectronColumnServiceGetSemiAngleResponse –

  Response object describing the semi angle value.

• ElectronColumnServiceGetSpotSizeRequest –

  The ElectronColumnServiceGetSpotSizeRequest class.

• ElectronColumnServiceGetSpotSizeResponse –

  Response object representing the spot size.

• ElectronColumnServiceGetStigmatorRequest –

  The ElectronColumnServiceGetStigmatorRequest class.

• ElectronColumnServiceGetStigmatorResponse –

  Response object representing the stigmator value of the electron column.

• ElectronColumnServiceGetTargetVoltageRequest –

  The ElectronColumnServiceGetTargetVoltageRequest class.

• ElectronColumnServiceGetTargetVoltageResponse –

  Response object representing the eht/voltage.

• ElectronColumnServiceGoToStandbyRequest –

  The ElectronColumnServiceGoToStandbyRequest class.

• ElectronColumnServiceGoToStandbyResponse –

  BeamState enum wrapper.

• ElectronColumnServiceRegisterOnBeamShiftChangedRequest –

  The ElectronColumnServiceRegisterOnBeamShiftChangedRequest class.

• ElectronColumnServiceRegisterOnBeamShiftChangedResponse –

  Response object describing the beam shift values.

• ElectronColumnServiceRegisterOnBeamStateChangedRequest –

  The ElectronColumnServiceRegisterOnBeamStateChangedRequest class.

• ElectronColumnServiceRegisterOnBeamStateChangedResponse –

  BeamState enum wrapper.

• ElectronColumnServiceRegisterOnFocusChangedRequest –

  The ElectronColumnServiceRegisterOnFocusChangedRequest class.

• ElectronColumnServiceRegisterOnFocusChangedResponse –

  Response object representing the column focus.

• ElectronColumnServiceRegisterOnFovChangedRequest –

  The ElectronColumnServiceRegisterOnFovChangedRequest class.

• ElectronColumnServiceRegisterOnFovChangedResponse –

  Response object representing the field of view expansion.

• ElectronColumnServiceRegisterOnFovRotationChangedRequest –

  The ElectronColumnServiceRegisterOnFovRotationChangedRequest class.

• ElectronColumnServiceRegisterOnFovRotationChangedResponse –

  Response object representing the field of view rotation.

• ElectronColumnServiceRegisterOnProbeCurrentChangedRequest –

  The ElectronColumnServiceRegisterOnProbeCurrentChangedRequest class.

• ElectronColumnServiceRegisterOnProbeCurrentChangedResponse –

  Response object representing the probe current.

• ElectronColumnServiceRegisterOnSemiAngleChangedRequest –

  The ElectronColumnServiceRegisterOnSemiAngleChangedRequest class.

• ElectronColumnServiceRegisterOnSemiAngleChangedResponse –

  Response object describing the semi angle values.

• ElectronColumnServiceRegisterOnSpotSizeChangedRequest –

  The ElectronColumnServiceRegisterOnSpotSizeChangedRequest class.

• ElectronColumnServiceRegisterOnSpotSizeChangedResponse –

  Response object representing the spot size.

• ElectronColumnServiceRegisterOnStigmatorChangedRequest –

  The ElectronColumnServiceRegisterOnStigmatorChangedRequest class.

• ElectronColumnServiceRegisterOnStigmatorChangedResponse –

  Response object representing stigmator changes of the electron column.

• ElectronColumnServiceRegisterOnVoltageChangedRequest –

  The ElectronColumnServiceRegisterOnVoltageChangedRequest class.

• ElectronColumnServiceRegisterOnVoltageChangedResponse –

  Response object representing the eht/voltage.

• ElectronColumnServiceSetBeamShiftRequest –

  The ElectronColumnServiceSetBeamShiftRequest class.

• ElectronColumnServiceSetBeamShiftResponse –

  Response object describing the beam shift values.

• ElectronColumnServiceSetFocusRequest –

  The ElectronColumnServiceSetFocusRequest class.

• ElectronColumnServiceSetFocusResponse –

  Response object representing the column focus.

• ElectronColumnServiceSetFovRequest –

  The ElectronColumnServiceSetFovRequest class.

• ElectronColumnServiceSetFovResponse –

  Response object representing the field of view expansion.

• ElectronColumnServiceSetFovRotationRequest –

  The ElectronColumnServiceSetFovRotationRequest class.

• ElectronColumnServiceSetFovRotationResponse –

  Response object representing the field of view rotation.

• ElectronColumnServiceSetStigmatorRequest –

  The ElectronColumnServiceSetStigmatorRequest class.

• ElectronColumnServiceSetStigmatorResponse –

  Response object representing the stigmator set value.

• ElectronColumnServiceSetVoltageRequest –

  The ElectronColumnServiceSetVoltageRequest class.

• ElectronColumnServiceSetVoltageResponse –

  Response object representing the eht/voltage.

• ElectronColumnServiceTurnOffRequest –

  The ElectronColumnServiceTurnOffRequest class.

• ElectronColumnServiceTurnOffResponse –

  BeamState enum wrapper.

• ElectronColumnServiceTurnOnRequest –

  The ElectronColumnServiceTurnOnRequest class.

• ElectronColumnServiceTurnOnResponse –

  BeamState enum wrapper.

• ExtendedAcquisitionSettings –

  Request object to set the simple acquisition settings.

• ExternalProcedureServiceRegisterExternalProcedureRequest –

  The ExternalProcedureServiceRegisterExternalProcedureRequest class.

• ExternalProcedureServiceRegisterExternalProcedureResponse –

  transfer object definition used to send commands to external procedures

• ExternalProcedureServiceReportCommandFailureRequest –

  The ExternalProcedureServiceReportCommandFailureRequest class.

• ExternalProcedureServiceReportCommandFailureResponse –

  The ExternalProcedureServiceReportCommandFailureResponse class.

• ExternalProcedureServiceReportCommandSuccessRequest –

  The ExternalProcedureServiceReportCommandSuccessRequest class.

• ExternalProcedureServiceReportCommandSuccessResponse –

  The ExternalProcedureServiceReportCommandSuccessResponse class.

• ExternalProcedureServiceReportInitializationErrorRequest –

  The ExternalProcedureServiceReportInitializationErrorRequest class.

• ExternalProcedureServiceReportInitializationErrorResponse –

  The ExternalProcedureServiceReportInitializationErrorResponse class.

• ExternalProcedureServiceReportProgressRequest –

  The ExternalProcedureServiceReportProgressRequest class.

• ExternalProcedureServiceReportProgressResponse –

  The ExternalProcedureServiceReportProgressResponse class.

• ExternalProcedureServiceReportReadyRequest –

  The ExternalProcedureServiceReportReadyRequest class.

• ExternalProcedureServiceReportReadyResponse –

  The ExternalProcedureServiceReportReadyResponse class.

• ExternalProcedureServiceReportStatusRequest –

  The ExternalProcedureServiceReportStatusRequest class.

• ExternalProcedureServiceReportStatusResponse –

  The ExternalProcedureServiceReportStatusResponse class.

• IlluminationServiceGetIlluminationIrRequest –

  The IlluminationServiceGetIlluminationIRRequest class.

• IlluminationServiceGetIlluminationIrResponse –

  Response object for the illuminator get illumination IR.

• IlluminationServiceGetIlluminationWhiteRequest –

  The IlluminationServiceGetIlluminationWhiteRequest class.

• IlluminationServiceGetIlluminationWhiteResponse –

  Response object for the illuminator get illumination white.

• IlluminationServiceRegisterOnIlluminationIrChangedRequest –

  The IlluminationServiceRegisterOnIlluminationIRChangedRequest class.

• IlluminationServiceRegisterOnIlluminationIrChangedResponse –

  Response object for register on illumination IR changed.

• IlluminationServiceRegisterOnIlluminationWhiteChangedRequest –

  The IlluminationServiceRegisterOnIlluminationWhiteChangedRequest class.

• IlluminationServiceRegisterOnIlluminationWhiteChangedResponse –

  Response object for register on illumination white changed.

• IlluminationServiceSetIlluminationIrRequest –

  The IlluminationServiceSetIlluminationIRRequest class.

• IlluminationServiceSetIlluminationIrResponse –

  Response object for the illuminator set illumination IR.

• IlluminationServiceSetIlluminationWhiteRequest –

  The IlluminationServiceSetIlluminationWhiteRequest class.

• IlluminationServiceSetIlluminationWhiteResponse –

  Response object for the illuminator set illumination white.

• SimpleAcquisitionServiceAcquireExtendedSingleFrameRequest –

  The SimpleAcquisitionServiceAcquireExtendedSingleFrameRequest class.

• SimpleAcquisitionServiceAcquireExtendedSingleFrameResponse –

  Response object of the AcquireExtendedSingleFrame method of the ZenApi.EM.Hardware.V1.ISimpleAcquisitionApi.

• SimpleAcquisitionServiceAcquireSingleFrameRequest –

  The SimpleAcquisitionServiceAcquireSingleFrameRequest class.

• SimpleAcquisitionServiceAcquireSingleFrameResponse –

  Response object of the AcquireSingleFrame method of the ZenApi.EM.Hardware.V1.ISimpleAcquisitionApi.

• SimpleAcquisitionServiceGetAcquisitionStatusRequest –

  The SimpleAcquisitionServiceGetAcquisitionStatusRequest class.

• SimpleAcquisitionServiceGetAcquisitionStatusResponse –

  Response object representing the current acquisition status.

• SimpleAcquisitionServiceGetBrightnessRequest –

  The SimpleAcquisitionServiceGetBrightnessRequest class.

• SimpleAcquisitionServiceGetBrightnessResponse –

  Response object representing a detector brightness value.

• SimpleAcquisitionServiceGetContrastRequest –

  The SimpleAcquisitionServiceGetContrastRequest class.

• SimpleAcquisitionServiceGetContrastResponse –

  Response object representing a detector contrast value.

• SimpleAcquisitionServiceRegisterOnAcquisitionStatusChangedRequest –

  The SimpleAcquisitionServiceRegisterOnAcquisitionStatusChangedRequest class.

• SimpleAcquisitionServiceRegisterOnAcquisitionStatusChangedResponse –

  Response object representing the current acquisition status.

• SimpleAcquisitionServiceSetBrightnessRequest –

  The SimpleAcquisitionServiceSetBrightnessRequest class.

• SimpleAcquisitionServiceSetBrightnessResponse –

  Response object representing a detector brightness value.

• SimpleAcquisitionServiceSetContrastRequest –

  The SimpleAcquisitionServiceSetContrastRequest class.

• SimpleAcquisitionServiceSetContrastResponse –

  Response object representing a detector contrast value.

• SimpleAcquisitionServiceStartExtendedLiveAcquisitionRequest –

  The SimpleAcquisitionServiceStartExtendedLiveAcquisitionRequest class.

• SimpleAcquisitionServiceStartExtendedLiveAcquisitionResponse –

  Response object of the StartExtendedLiveAcquisition method of the ZenApi.EM.Hardware.V1.ISimpleAcquisitionApi.

• SimpleAcquisitionServiceStartLiveAcquisitionRequest –

  The SimpleAcquisitionServiceStartLiveAcquisitionRequest class.

• SimpleAcquisitionServiceStartLiveAcquisitionResponse –

  Response object of the StartLiveAcquisition method of the ZenApi.EM.Hardware.V1.ISimpleAcquisitionApi.

• SimpleAcquisitionServiceStopLiveAcquisitionRequest –

  The SimpleAcquisitionServiceStopLiveAcquisitionRequest class.

• SimpleAcquisitionServiceStopLiveAcquisitionResponse –

  The SimpleAcquisitionServiceStopLiveAcquisitionResponse class.

• VacuumServiceCloseValveRequest –

  The VacuumServiceCloseValveRequest class.

• VacuumServiceCloseValveResponse –

  Response object of ZenApi.EM.Hardware.V1.IVacuumApi.CloseValve(ZenApi.EM.Hardware.V1.Valve,System.Threading.CancellationToken) method.

• VacuumServiceGetAvailableVacuumModesRequest –

  The VacuumServiceGetAvailableVacuumModesRequest class.

• VacuumServiceGetAvailableVacuumModesResponse –

  AvailableVacuumModes enum collection response.

• VacuumServiceGetAvailableValvesRequest –

  The VacuumServiceGetAvailableValvesRequest class.

• VacuumServiceGetAvailableValvesResponse –

  AvailableValves enum collection response.

• VacuumServiceGetChamberPressureRequest –

  The VacuumServiceGetChamberPressureRequest class.

• VacuumServiceGetChamberPressureResponse –

  Response to represent the chamber pressure.

• VacuumServiceGetTargetChamberPressureRequest –

  The VacuumServiceGetTargetChamberPressureRequest class.

• VacuumServiceGetTargetChamberPressureResponse –

  Response to represent the chamber pressure.

• VacuumServiceGetVacuumModeRequest –

  The VacuumServiceGetVacuumModeRequest class.

• VacuumServiceGetVacuumModeResponse –

  VacuumMode enum response.

• VacuumServiceGetVacuumStateRequest –

  The VacuumServiceGetVacuumStateRequest class.

• VacuumServiceGetVacuumStateResponse –

  VacuumState enum response.

• VacuumServiceGetValveStateRequest –

  The VacuumServiceGetValveStateRequest class.

• VacuumServiceGetValveStateResponse –

  ValveState enum response.

• VacuumServiceOpenValveRequest –

  The VacuumServiceOpenValveRequest class.

• VacuumServiceOpenValveResponse –

  Response object of ZenApi.EM.Hardware.V1.IVacuumApi.OpenValve(ZenApi.EM.Hardware.V1.Valve,System.Threading.CancellationToken) method.

• VacuumServicePumpRequest –

  The VacuumServicePumpRequest class.

• VacuumServicePumpResponse –

  Response object of the ZenApi.EM.Hardware.V1.IVacuumApi.Pump(System.Threading.CancellationToken) method.

• VacuumServiceRegisterOnChamberPressureChangedRequest –

  The VacuumServiceRegisterOnChamberPressureChangedRequest class.

• VacuumServiceRegisterOnChamberPressureChangedResponse –

  Response to represent the chamber pressure.

• VacuumServiceRegisterOnTargetChamberPressureChangedRequest –

  The VacuumServiceRegisterOnTargetChamberPressureChangedRequest class.

• VacuumServiceRegisterOnTargetChamberPressureChangedResponse –

  Response to represent the chamber pressure.

• VacuumServiceRegisterOnVacuumModeChangedRequest –

  The VacuumServiceRegisterOnVacuumModeChangedRequest class.

• VacuumServiceRegisterOnVacuumModeChangedResponse –

  VacuumMode enum response.

• VacuumServiceRegisterOnVacuumStateChangedRequest –

  The VacuumServiceRegisterOnVacuumStateChangedRequest class.

• VacuumServiceRegisterOnVacuumStateChangedResponse –

  VacuumState enum response.

• VacuumServiceRegisterOnValveStateChangedRequest –

  The VacuumServiceRegisterOnValveStateChangedRequest class.

• VacuumServiceRegisterOnValveStateChangedResponse –

  ValveState enum response.

• VacuumServiceSetTargetChamberPressureRequest –

  The VacuumServiceSetTargetChamberPressureRequest class.

• VacuumServiceSetTargetChamberPressureResponse –

  Response object of the ZenApi.EM.Hardware.V1.IVacuumApi.SetTargetChamberPressure(System.Double,System.Threading.CancellationToken) method.

• VacuumServiceSetVacuumModeRequest –

  The VacuumServiceSetVacuumModeRequest class.

• VacuumServiceSetVacuumModeResponse –

  Response object of the ZenApi.EM.Hardware.V1.IVacuumApi.SetVacuumMode(ZenApi.EM.Hardware.V1.VacuumMode,System.Threading.CancellationToken) method.

• VacuumServiceVentRequest –

  The VacuumServiceVentRequest class.

• VacuumServiceVentResponse –

  Response object of ZenApi.EM.Hardware.V1.IVacuumApi.Vent(System.Threading.CancellationToken) method.

AcquisitionResponseType

Bases: Enum

Indicates the type of response returned by the camera live image acquisition stream.

Attributes:

• UNSPECIFIED –

  Unspecified type.

• FRAME_START –

  The response is the first data buffer of a new frame. The response will include the image meta-data.

• FRAME_CONTINUATION –

  The response is a continuation of the previous frame. The response will not include the image meta-data.

UNSPECIFIED class-attribute instance-attribute

UNSPECIFIED = 0

Unspecified type.

FRAME_START class-attribute instance-attribute

FRAME_START = 1

The response is the first data buffer of a new frame. The response will include the image meta-data.

FRAME_CONTINUATION class-attribute instance-attribute

FRAME_CONTINUATION = 2

The response is a continuation of the previous frame. The response will not include the image meta-data.

AcquisitionStatus

Bases: Enum

Acquisition states.

Attributes:

• UNSPECIFIED –

  Default enum value.

• IDLE –

  No acquisition task is running, available for next acquisition.

• BUSY –

  Acquisition hardware is occupied by another task.

• LIVE_RUNNING –

  Live acquisition is currently running.

• ACQUISITION_RUNNING –

  Acquisition task is currently running.

UNSPECIFIED class-attribute instance-attribute

UNSPECIFIED = 0

Default enum value.

IDLE class-attribute instance-attribute

IDLE = 1

No acquisition task is running, available for next acquisition.

BUSY class-attribute instance-attribute

BUSY = 2

Acquisition hardware is occupied by another task. No acquisition possible at the moment.

LIVE_RUNNING class-attribute instance-attribute

LIVE_RUNNING = 3

Live acquisition is currently running.

ACQUISITION_RUNNING class-attribute instance-attribute

ACQUISITION_RUNNING = 4

Acquisition task is currently running.

BeamState

Bases: Enum

Possible beam operating states.

Attributes:

• UNSPECIFIED –

  Default enum value.

• UNKNOWN –

  Unknown indicates that this variable hasn't been assigned yet.

• ERROR –

  There is an error with the Gun or EHT and the beam cannot be used.

• OFF –

  EHT is off.

• TURNING_ON –

  The EHT (and gun for C-SEM) is turning on.

• ON –

  Gun is on.

• GOING_TO_STANDBY –

  The beam is going into the standby state.

• STANDBY –

  Not all devices support this mode.

• TURNING_OFF –

  The EHT is ramping down.

UNSPECIFIED class-attribute instance-attribute

UNSPECIFIED = 0

Default enum value.

UNKNOWN class-attribute instance-attribute

UNKNOWN = 1

Unknown indicates that this variable hasn't been assigned yet. This value should never occur. If you read this value, it's a bug.

ERROR class-attribute instance-attribute

ERROR = 2

There is an error with the Gun or EHT and the beam cannot be used.

OFF class-attribute instance-attribute

OFF = 3

EHT is off. On FE-SEMs, the gun may be on, gun interfaces must be checked to discover gun state. On C-SEMs the EHT and gun are off, and there is no current on the filament.

TURNING_ON class-attribute instance-attribute

TURNING_ON = 4

The EHT (and gun for C-SEM) is turning on.

ON class-attribute instance-attribute

ON = 5

Gun is on. Filament (if it exists) has full current. EHT is on. The beam can be used.

GOING_TO_STANDBY class-attribute instance-attribute

GOING_TO_STANDBY = 6

The beam is going into the standby state.

STANDBY class-attribute instance-attribute

STANDBY = 7

Not all devices support this mode. This represents an intermediate state. The EVO and the FIB have standby states.

TURNING_OFF class-attribute instance-attribute

TURNING_OFF = 8

The EHT is ramping down. On C-SEM, the gun and filament may also be shutting down.

CameraAcquisitionStatus

Bases: Enum

Acquisition states.

Attributes:

• UNSPECIFIED –

  Default enum value.

• UNKNOWN –

  Should not occur in an initialized system.

• ERROR –

  The image acquisition device is in an error state and cannot be used.

• IDLE –

  The image acquisition device is ready to perform a task.

• BUSY –

  The image acquisition device is busy with other tasks and cannot be used for image acquisition.

• LIVE_ACQUISITION –

  The system is performing a scan and will continue until explicitly asked to stop.

• SINGLE_ACQUISITION –

  The system is performing a scan that has a scheduled

UNSPECIFIED class-attribute instance-attribute

UNSPECIFIED = 0

Default enum value.

UNKNOWN class-attribute instance-attribute

UNKNOWN = 1

Should not occur in an initialized system.

ERROR class-attribute instance-attribute

ERROR = 2

The image acquisition device is in an error state and cannot be used.

IDLE class-attribute instance-attribute

IDLE = 3

The image acquisition device is ready to perform a task.

BUSY class-attribute instance-attribute

BUSY = 4

The image acquisition device is busy with other tasks and cannot be used for image acquisition.

LIVE_ACQUISITION class-attribute instance-attribute

LIVE_ACQUISITION = 5

The system is performing a scan and will continue until explicitly asked to stop. We use the term "Live" instead of "Continuous" because in ZIS, "Continuous" means "a time series of snaps with no delay between and no scheduled end".

SINGLE_ACQUISITION class-attribute instance-attribute

SINGLE_ACQUISITION = 6

The system is performing a scan that has a scheduled termination such as "at the end of the frame".

CcdMode

Bases: Enum

The CCD mode enumeration.

Attributes:

• UNSPECIFIED –

  Default enum value.

• OFF –

  Illumination is off.

• AUTO –

  Illumination mode is determined based on detector selection.

• GREYSCALE –

  Illumination is Infra-red, producing greyscale images.

• COLOR –

  Illumination is White light, producing color images.

UNSPECIFIED class-attribute instance-attribute

UNSPECIFIED = 0

Default enum value.

OFF class-attribute instance-attribute

OFF = 1

Illumination is off.

AUTO class-attribute instance-attribute

AUTO = 2

Illumination mode is determined based on detector selection.

GREYSCALE class-attribute instance-attribute

GREYSCALE = 3

Illumination is Infra-red, producing greyscale images.

COLOR class-attribute instance-attribute

COLOR = 4

Illumination is White light, producing color images.

CommandId

Bases: Enum

Attributes:

• UNSPECIFIED –

  framework required, not used for communication.

• EXECUTE –

  The external procedure is currently executing.

• STOP –

  The external procedure is about to stop it's execution.

• PAUSE –

  The external procedure is paused from execution.

• CONTINUE –

  The external procedure is continued from pause.

• CLOSE –

  The external procedure is about to close .

UNSPECIFIED class-attribute instance-attribute

UNSPECIFIED = 0

framework required, not used for communication.

EXECUTE class-attribute instance-attribute

EXECUTE = 1

The external procedure is currently executing.

STOP class-attribute instance-attribute

STOP = 2

The external procedure is about to stop it's execution.

PAUSE class-attribute instance-attribute

PAUSE = 3

The external procedure is paused from execution.

CONTINUE class-attribute instance-attribute

CONTINUE = 4

The external procedure is continued from pause.

CLOSE class-attribute instance-attribute

CLOSE = 5

The external procedure is about to close .

VacuumMode

Bases: Enum

Possible vacuum modes supported by our tools.

Attributes:

• UNSPECIFIED –

  Default enum value.

• HIGH_VACUUM –

  Standard vacuum mode is ZenApi.EM.Hardware.V1.VacuumMode.HighVacuum.

• VARIABLE_PRESSURE –

  The optional ZenApi.EM.Hardware.V1.VacuumMode.VariablePressure mode allows to specify a

UNSPECIFIED class-attribute instance-attribute

UNSPECIFIED = 0

Default enum value.

HIGH_VACUUM class-attribute instance-attribute

HIGH_VACUUM = 1

Standard vacuum mode is ZenApi.EM.Hardware.V1.VacuumMode.HighVacuum. Target chamber pressure can not be adjusted.

VARIABLE_PRESSURE class-attribute instance-attribute

VARIABLE_PRESSURE = 2

The optional ZenApi.EM.Hardware.V1.VacuumMode.VariablePressure mode allows to specify a target chamber pressure.

VacuumState

Bases: Enum

Possible states of the vacuum system. TODO enum states must be reviewed by application, maybe Christian Hendrich what is really needed on customer side, keep it simple

Attributes:

• UNSPECIFIED –

  Default enum value.

• READY –

  Vacuum is ready.

• NOT_READY –

  Vacuum is not ready.

UNSPECIFIED class-attribute instance-attribute

UNSPECIFIED = 0

Default enum value.

READY class-attribute instance-attribute

READY = 1

Vacuum is ready.

NOT_READY class-attribute instance-attribute

NOT_READY = 2

Vacuum is not ready. Maybe vented, pumping, venting, ...

ValveState

Bases: Enum

Possible states of any valve. TODO enum states must be reviewed by application, maybe Christian Hendrich what is really needed on customer side, keep it simple

Attributes:

• UNSPECIFIED –

  Default enum value.

• OPEN –

  Valve is open.

• CLOSED –

  Valve is closed.

UNSPECIFIED class-attribute instance-attribute

UNSPECIFIED = 0

Default enum value.

OPEN class-attribute instance-attribute

OPEN = 1

Valve is open.

CLOSED class-attribute instance-attribute

CLOSED = 2

Valve is closed.

Valve

Bases: Enum

Enumeration of all possibles valves to control.

Attributes:

• UNSPECIFIED –

  The default enum value.

• SEM_ISOLATION_VALVE –

  SEM column chamber isolation valve.

• FIB_ISOLATION_VALVE –

  FIB column chamber isolation valve.

UNSPECIFIED class-attribute instance-attribute

UNSPECIFIED = 0

The default enum value.

SEM_ISOLATION_VALVE class-attribute instance-attribute

SEM_ISOLATION_VALVE = 1

SEM column chamber isolation valve.

FIB_ISOLATION_VALVE class-attribute instance-attribute

FIB_ISOLATION_VALVE = 2

FIB column chamber isolation valve.

AcquisitionSettings dataclass

AcquisitionSettings(detector_name: str = betterproto.string_field(1), width: int = betterproto.int32_field(2), height: int = betterproto.int32_field(3), dwell_time: float = betterproto.double_field(4), frame_averages: int = betterproto.int32_field(5), line_averages: int = betterproto.int32_field(6))

Bases: Message

Request object to set the simple acquisition settings.

Attributes:

• detector_name (str) –

  The detector to use.

• width (int) –

  The image width in pixels.

• height (int) –

  The image height in pixels.

• dwell_time (float) –

  The dwell time in seconds.

• frame_averages (int) –

  The number of frames to average.

• line_averages (int) –

  The number of lines to average.

detector_name class-attribute instance-attribute

detector_name: str = string_field(1)

The detector to use. Null will take the detector from the previous acquisition.

width class-attribute instance-attribute

width: int = int32_field(2)

The image width in pixels.

height class-attribute instance-attribute

height: int = int32_field(3)

The image height in pixels.

dwell_time class-attribute instance-attribute

dwell_time: float = double_field(4)

The dwell time in seconds. The closest dwell time to the selected one will be chosen.

frame_averages class-attribute instance-attribute

frame_averages: int = int32_field(5)

The number of frames to average. 1 means no averaging.

line_averages class-attribute instance-attribute

line_averages: int = int32_field(6)

The number of lines to average. 1 means no averaging.

CameraAcquisitionSettings dataclass

CameraAcquisitionSettings(camera_name: str = betterproto.string_field(1), width: int = betterproto.int32_field(2), height: int = betterproto.int32_field(3))

Bases: Message

Attributes:

• camera_name (str) –

  The camera to use.

• width (int) –

  The image width in pixels.

• height (int) –

  The image height in pixels.

camera_name class-attribute instance-attribute

camera_name: str = string_field(1)

The camera to use.

width class-attribute instance-attribute

width: int = int32_field(2)

The image width in pixels.

height class-attribute instance-attribute

height: int = int32_field(3)

The image height in pixels.

CameraServiceGetAcquisitionStatusRequest dataclass

CameraServiceGetAcquisitionStatusRequest(camera_id: str = betterproto.string_field(1))

Bases: Message

The CameraServiceGetAcquisitionStatusRequest class.

Attributes:

• camera_id (str) –

  The camera ID.

camera_id class-attribute instance-attribute

camera_id: str = string_field(1)

The camera ID.

CameraServiceGetAcquisitionStatusResponse dataclass

CameraServiceGetAcquisitionStatusResponse(status: CameraAcquisitionStatus = betterproto.enum_field(1), message: str = betterproto.string_field(2))

Bases: Message

Response object for the get acquisition state.

Attributes:

• status (CameraAcquisitionStatus) –

  The acquisition status.

• message (str) –

  A string message for display to the customer in failure case. This is only for display purpose and the message may change.

status class-attribute instance-attribute

status: CameraAcquisitionStatus = enum_field(1)

The acquisition status.

message class-attribute instance-attribute

message: str = string_field(2)

A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

CameraServiceGetAvailableCamerasRequest dataclass

CameraServiceGetAvailableCamerasRequest()

Bases: Message

The CameraServiceGetAvailableCamerasRequest class.

CameraServiceGetAvailableCamerasResponse dataclass

CameraServiceGetAvailableCamerasResponse(camera_names: List[str] = betterproto.string_field(1))

Bases: Message

Response object representing a list of available cameras.

Attributes:

• camera_names (List[str]) –

  The available cameras on the system.

camera_names class-attribute instance-attribute

camera_names: List[str] = string_field(1)

The available cameras on the system.

CameraServiceGetBrightnessRequest dataclass

CameraServiceGetBrightnessRequest(camera_id: str = betterproto.string_field(1))

Bases: Message

The CameraServiceGetBrightnessRequest class.

Attributes:

• camera_id (str) –

  The camera ID.

camera_id class-attribute instance-attribute

camera_id: str = string_field(1)

The camera ID.

CameraServiceGetBrightnessResponse dataclass

CameraServiceGetBrightnessResponse(brightness: float = betterproto.double_field(1), message: str = betterproto.string_field(2))

Bases: Message

Response object for the get brightness.

Attributes:

• brightness (float) –

  The brightness.

• message (str) –

  A string message for display to the customer in failure case. This is only for display purpose and the message may change.

brightness class-attribute instance-attribute

brightness: float = double_field(1)

The brightness.

message class-attribute instance-attribute

message: str = string_field(2)

A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

CameraServiceGetCcdModeRequest dataclass

CameraServiceGetCcdModeRequest(camera_id: str = betterproto.string_field(1))

Bases: Message

The CameraServiceGetCcdModeRequest class.

Attributes:

• camera_id (str) –

  The camera ID.

camera_id class-attribute instance-attribute

camera_id: str = string_field(1)

The camera ID.

CameraServiceGetCcdModeResponse dataclass

CameraServiceGetCcdModeResponse(mode: CcdMode = betterproto.enum_field(1), message: str = betterproto.string_field(2))

Bases: Message

Response object for the get CCD mode.

Attributes:

• mode (CcdMode) –

  The CCD mode.

• message (str) –

  A string message for display to the customer in failure case. This is only for display purpose and the message may change.

mode class-attribute instance-attribute

mode: CcdMode = enum_field(1)

The CCD mode.

message class-attribute instance-attribute

message: str = string_field(2)

A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

CameraServiceGetContrastRequest dataclass

CameraServiceGetContrastRequest(camera_id: str = betterproto.string_field(1))

Bases: Message

The CameraServiceGetContrastRequest class.

Attributes:

• camera_id (str) –

  The camera ID.

camera_id class-attribute instance-attribute

camera_id: str = string_field(1)

The camera ID.

CameraServiceGetContrastResponse dataclass

CameraServiceGetContrastResponse(contrast: float = betterproto.double_field(1), message: str = betterproto.string_field(2))

Bases: Message

Response object for the get contrast.

Attributes:

• contrast (float) –

  The contrast.

• message (str) –

  A string message for display to the customer in failure case. This is only for display purpose and the message may change.

contrast class-attribute instance-attribute

contrast: float = double_field(1)

The contrast.

message class-attribute instance-attribute

message: str = string_field(2)

A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

CameraServiceRegisterOnAcquisitionStatusChangedRequest dataclass

CameraServiceRegisterOnAcquisitionStatusChangedRequest(camera_id: str = betterproto.string_field(1))

Bases: Message

The CameraServiceRegisterOnAcquisitionStatusChangedRequest class.

Attributes:

• camera_id (str) –

  The camera ID.

camera_id class-attribute instance-attribute

camera_id: str = string_field(1)

The camera ID.

CameraServiceRegisterOnAcquisitionStatusChangedResponse dataclass

CameraServiceRegisterOnAcquisitionStatusChangedResponse(status: CameraAcquisitionStatus = betterproto.enum_field(1), message: str = betterproto.string_field(2))

Bases: Message

Response object for the get acquisition state.

Attributes:

• status (CameraAcquisitionStatus) –

  The acquisition status.

• message (str) –

  A string message for display to the customer in failure case. This is only for display purpose and the message may change.

status class-attribute instance-attribute

status: CameraAcquisitionStatus = enum_field(1)

The acquisition status.

message class-attribute instance-attribute

message: str = string_field(2)

A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

CameraServiceRegisterOnBrightnessChangedRequest dataclass

CameraServiceRegisterOnBrightnessChangedRequest(camera_id: str = betterproto.string_field(1))

Bases: Message

The CameraServiceRegisterOnBrightnessChangedRequest class.

Attributes:

• camera_id (str) –

  The camera ID.

camera_id class-attribute instance-attribute

camera_id: str = string_field(1)

The camera ID.

CameraServiceRegisterOnBrightnessChangedResponse dataclass

CameraServiceRegisterOnBrightnessChangedResponse(brightness: float = betterproto.double_field(1), message: str = betterproto.string_field(2))

Bases: Message

Response object for the get brightness.

Attributes:

• brightness (float) –

  The brightness.

• message (str) –

  A string message for display to the customer in failure case. This is only for display purpose and the message may change.

brightness class-attribute instance-attribute

brightness: float = double_field(1)

The brightness.

message class-attribute instance-attribute

message: str = string_field(2)

A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

CameraServiceRegisterOnCcdModeChangedRequest dataclass

CameraServiceRegisterOnCcdModeChangedRequest(camera_id: str = betterproto.string_field(1))

Bases: Message

The CameraServiceRegisterOnCcdModeChangedRequest class.

Attributes:

• camera_id (str) –

  The camera ID.

camera_id class-attribute instance-attribute

camera_id: str = string_field(1)

The camera ID.

CameraServiceRegisterOnCcdModeChangedResponse dataclass

CameraServiceRegisterOnCcdModeChangedResponse(mode: CcdMode = betterproto.enum_field(1), message: str = betterproto.string_field(2))

Bases: Message

Response object for the get CCD mode.

Attributes:

• mode (CcdMode) –

  The CCD mode.

• message (str) –

  A string message for display to the customer in failure case. This is only for display purpose and the message may change.

mode class-attribute instance-attribute

mode: CcdMode = enum_field(1)

The CCD mode.

message class-attribute instance-attribute

message: str = string_field(2)

A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

CameraServiceRegisterOnContrastChangedRequest dataclass

CameraServiceRegisterOnContrastChangedRequest(camera_id: str = betterproto.string_field(1))

Bases: Message

The CameraServiceRegisterOnContrastChangedRequest class.

Attributes:

• camera_id (str) –

  The camera ID.

camera_id class-attribute instance-attribute

camera_id: str = string_field(1)

The camera ID.

CameraServiceRegisterOnContrastChangedResponse dataclass

CameraServiceRegisterOnContrastChangedResponse(contrast: float = betterproto.double_field(1), message: str = betterproto.string_field(2))

Bases: Message

Response object for the get contrast.

Attributes:

• contrast (float) –

  The contrast.

• message (str) –

  A string message for display to the customer in failure case. This is only for display purpose and the message may change.

contrast class-attribute instance-attribute

contrast: float = double_field(1)

The contrast.

message class-attribute instance-attribute

message: str = string_field(2)

A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

CameraServiceSetBrightnessRequest dataclass

CameraServiceSetBrightnessRequest(camera_id: str = betterproto.string_field(1), brightness: float = betterproto.double_field(2))

Bases: Message

The CameraServiceSetBrightnessRequest class.

Attributes:

• camera_id (str) –

  The camera ID.

• brightness (float) –

  The brightness to set[0..100]%.

camera_id class-attribute instance-attribute

camera_id: str = string_field(1)

The camera ID.

brightness class-attribute instance-attribute

brightness: float = double_field(2)

The brightness to set[0..100]%.

CameraServiceSetBrightnessResponse dataclass

CameraServiceSetBrightnessResponse(brightness: float = betterproto.double_field(1), success: bool = betterproto.bool_field(2), message: str = betterproto.string_field(3))

Bases: Message

Response object for the set brightness.

Attributes:

• brightness (float) –

  The brightness.

• success (bool) –

  A value indicating whether setting the brightness was successful.

• message (str) –

  A string message for display to the customer in failure case. This is only for display purpose and the message may change.

brightness class-attribute instance-attribute

brightness: float = double_field(1)

The brightness.

success class-attribute instance-attribute

success: bool = bool_field(2)

A value indicating whether setting the brightness was successful.

message class-attribute instance-attribute

message: str = string_field(3)

A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

CameraServiceSetCcdModeRequest dataclass

CameraServiceSetCcdModeRequest(camera_id: str = betterproto.string_field(1), mode: CcdMode = betterproto.enum_field(2))

Bases: Message

The CameraServiceSetCcdModeRequest class.

Attributes:

• camera_id (str) –

  The camera ID.

• mode (CcdMode) –

  The CCD mode to set.

camera_id class-attribute instance-attribute

camera_id: str = string_field(1)

The camera ID.

mode class-attribute instance-attribute

mode: CcdMode = enum_field(2)

The CCD mode to set.

CameraServiceSetCcdModeResponse dataclass

CameraServiceSetCcdModeResponse(mode: CcdMode = betterproto.enum_field(1), success: bool = betterproto.bool_field(2), message: str = betterproto.string_field(3))

Bases: Message

Response object for the set CCD mode.

Attributes:

• mode (CcdMode) –

  The CCD mode.

• success (bool) –

  A value indicating whether setting the CCD mode was successful.

• message (str) –

  A string message for display to the customer in failure case. This is only for display purpose and the message may change.

mode class-attribute instance-attribute

mode: CcdMode = enum_field(1)

The CCD mode.

success class-attribute instance-attribute

success: bool = bool_field(2)

A value indicating whether setting the CCD mode was successful.

message class-attribute instance-attribute

message: str = string_field(3)

A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

CameraServiceSetContrastRequest dataclass

CameraServiceSetContrastRequest(camera_id: str = betterproto.string_field(1), contrast: float = betterproto.double_field(2))

Bases: Message

The CameraServiceSetContrastRequest class.

Attributes:

• camera_id (str) –

  The camera ID.

• contrast (float) –

  The contrast to set[0..100]%.

camera_id class-attribute instance-attribute

camera_id: str = string_field(1)

The camera ID.

contrast class-attribute instance-attribute

contrast: float = double_field(2)

The contrast to set[0..100]%.

CameraServiceSetContrastResponse dataclass

CameraServiceSetContrastResponse(contrast: float = betterproto.double_field(1), success: bool = betterproto.bool_field(2), message: str = betterproto.string_field(3))

Bases: Message

Response object for the set contrast.

Attributes:

• contrast (float) –

  The contrast.

• success (bool) –

  A value indicating whether setting the contrast was successful.

• message (str) –

  A string message for display to the customer in failure case. This is only for display purpose and the message may change.

contrast class-attribute instance-attribute

contrast: float = double_field(1)

The contrast.

success class-attribute instance-attribute

success: bool = bool_field(2)

A value indicating whether setting the contrast was successful.

message class-attribute instance-attribute

message: str = string_field(3)

A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

CameraServiceStartLiveAcquisitionRequest dataclass

CameraServiceStartLiveAcquisitionRequest(settings: CameraAcquisitionSettings = betterproto.message_field(1))

Bases: Message

The CameraServiceStartLiveAcquisitionRequest class.

Attributes:

• settings (CameraAcquisitionSettings) –

  The imaging settings used to acquire multiple frames.

settings class-attribute instance-attribute

settings: CameraAcquisitionSettings = message_field(1)

The imaging settings used to acquire multiple frames.

CameraServiceStartLiveAcquisitionResponse dataclass

CameraServiceStartLiveAcquisitionResponse(result_type: AcquisitionResponseType = betterproto.enum_field(1), width: int = betterproto.int32_field(2), height: int = betterproto.int32_field(3), bytes_per_pixel: int = betterproto.uint32_field(4), total_image_size: int = betterproto.int32_field(5), image_data: bytes = betterproto.bytes_field(6))

Bases: Message

Response object of the camera live image acquisition.

Attributes:

• result_type (AcquisitionResponseType) –

  A value indicating the type of response returned by the camera live image acquisition stream.

• width (int) –

  The overall width of the image. This is only valid when the ResultType is FrameStart, otherwise it will be set to zero and not transmitted.

• height (int) –

  The overall height of the image. This is only valid when the ResultType is FrameStart, otherwise it will be set to zero and not transmitted.

• bytes_per_pixel (int) –

  The number of bytes per pixel. This is only valid when the ResultType is FrameStart, otherwise it will be set to zero and not transmitted.

• total_image_size (int) –

  The total size of the image. This is only valid when the ResultType is FrameStart, otherwise it will be set to zero and not transmitted.

• image_data (bytes) –

  The data buffer of this part of the image. This may be less than the total image size, in which case the client should expect more data to follow.

result_type class-attribute instance-attribute

result_type: AcquisitionResponseType = enum_field(1)

A value indicating the type of response returned by the camera live image acquisition stream.

width class-attribute instance-attribute

width: int = int32_field(2)

The overall width of the image. This is only valid when the ResultType is FrameStart, otherwise it will be set to zero and not transmitted.

height class-attribute instance-attribute

height: int = int32_field(3)

The overall height of the image. This is only valid when the ResultType is FrameStart, otherwise it will be set to zero and not transmitted.

bytes_per_pixel class-attribute instance-attribute

bytes_per_pixel: int = uint32_field(4)

The number of bytes per pixel. This is only valid when the ResultType is FrameStart, otherwise it will be set to zero and not transmitted.

total_image_size class-attribute instance-attribute

total_image_size: int = int32_field(5)

The total size of the image. This is only valid when the ResultType is FrameStart, otherwise it will be set to zero and not transmitted.

image_data class-attribute instance-attribute

image_data: bytes = bytes_field(6)

The data buffer of this part of the image. This may be less than the total image size, in which case the client should expect more data to follow.

CameraServiceStartSingleAcquisitionRequest dataclass

CameraServiceStartSingleAcquisitionRequest(settings: CameraAcquisitionSettings = betterproto.message_field(1))

Bases: Message

The CameraServiceStartSingleAcquisitionRequest class.

Attributes:

• settings (CameraAcquisitionSettings) –

  The imaging settings used to acquire a frame.

settings class-attribute instance-attribute

settings: CameraAcquisitionSettings = message_field(1)

The imaging settings used to acquire a frame.

CameraServiceStartSingleAcquisitionResponse dataclass

CameraServiceStartSingleAcquisitionResponse(result_type: AcquisitionResponseType = betterproto.enum_field(1), width: int = betterproto.int32_field(2), height: int = betterproto.int32_field(3), bytes_per_pixel: int = betterproto.uint32_field(4), total_image_size: int = betterproto.int32_field(5), image_data: bytes = betterproto.bytes_field(6))

Bases: Message

Response object of the camera single image acquisition.

Attributes:

• result_type (AcquisitionResponseType) –

  A value indicating the type of response returned by the camera live image acquisition stream.

• width (int) –

  The overall width of the image. This is only valid when the ResultType is FrameStart, otherwise it will be set to zero and not transmitted.

• height (int) –

  The overall height of the image. This is only valid when the ResultType is FrameStart, otherwise it will be set to zero and not transmitted.

• bytes_per_pixel (int) –

  The number of bytes per pixel. This is only valid when the ResultType is FrameStart, otherwise it will be set to zero and not transmitted.

• total_image_size (int) –

  The total size of the image. This is only valid when the ResultType is FrameStart, otherwise it will be set to zero and not transmitted.

• image_data (bytes) –

  The data buffer of this part of the image. This may be less than the total image size, in which case the client should expect more data to follow.

result_type class-attribute instance-attribute

result_type: AcquisitionResponseType = enum_field(1)

A value indicating the type of response returned by the camera live image acquisition stream.

width class-attribute instance-attribute

width: int = int32_field(2)

The overall width of the image. This is only valid when the ResultType is FrameStart, otherwise it will be set to zero and not transmitted.

height class-attribute instance-attribute

height: int = int32_field(3)

The overall height of the image. This is only valid when the ResultType is FrameStart, otherwise it will be set to zero and not transmitted.

bytes_per_pixel class-attribute instance-attribute

bytes_per_pixel: int = uint32_field(4)

The number of bytes per pixel. This is only valid when the ResultType is FrameStart, otherwise it will be set to zero and not transmitted.

total_image_size class-attribute instance-attribute

total_image_size: int = int32_field(5)

The total size of the image. This is only valid when the ResultType is FrameStart, otherwise it will be set to zero and not transmitted.

image_data class-attribute instance-attribute

image_data: bytes = bytes_field(6)

The data buffer of this part of the image. This may be less than the total image size, in which case the client should expect more data to follow.

CameraServiceStopLiveAcquisitionRequest dataclass

CameraServiceStopLiveAcquisitionRequest(camera_id: str = betterproto.string_field(1))

Bases: Message

The CameraServiceStopLiveAcquisitionRequest class.

Attributes:

• camera_id (str) –

  The camera ID.

camera_id class-attribute instance-attribute

camera_id: str = string_field(1)

The camera ID.

CameraServiceStopLiveAcquisitionResponse dataclass

CameraServiceStopLiveAcquisitionResponse(task_success: bool = betterproto.bool_field(1), message: str = betterproto.string_field(2))

Bases: Message

Response object of the camera stop acquisition.

Attributes:

• task_success (bool) –

  A value indicating whether the task to acquire an image succeeded or not.

• message (str) –

  A string message for display to the customer in failure case. This is only for display purpose and the message may change.

task_success class-attribute instance-attribute

task_success: bool = bool_field(1)

A value indicating whether the task to acquire an image succeeded or not.

message class-attribute instance-attribute

message: str = string_field(2)

A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

DetectorServiceGetAvailableDetectorsRequest dataclass

DetectorServiceGetAvailableDetectorsRequest()

Bases: Message

The DetectorServiceGetAvailableDetectorsRequest class.

DetectorServiceGetAvailableDetectorsResponse dataclass

DetectorServiceGetAvailableDetectorsResponse(detector_names: List[str] = betterproto.string_field(1))

Bases: Message

Response object representing a list of available detectors.

Attributes:

• detector_names (List[str]) –

  The available detectors on the system.

detector_names class-attribute instance-attribute

detector_names: List[str] = string_field(1)

The available detectors on the system.

DetectorServiceGetBrightnessRequest dataclass

DetectorServiceGetBrightnessRequest(detector_name: str = betterproto.string_field(1))

Bases: Message

The DetectorServiceGetBrightnessRequest class.

Attributes:

• detector_name (str) –

  The unique name of the detector to control as string. Must be part of ZenApi.EM.Hardware.V1.IDetectorApi.GetAvailableDetectors.

detector_name class-attribute instance-attribute

detector_name: str = string_field(1)

The unique name of the detector to control as string. Must be part of ZenApi.EM.Hardware.V1.IDetectorApi.GetAvailableDetectors.

DetectorServiceGetBrightnessResponse dataclass

DetectorServiceGetBrightnessResponse(brightness: float = betterproto.double_field(1))

Bases: Message

Response object representing a detector brightness value.

Attributes:

• brightness (float) –

  The brightness in percentage [0, 100].

brightness class-attribute instance-attribute

brightness: float = double_field(1)

The brightness in percentage [0, 100].

DetectorServiceGetContrastRequest dataclass

DetectorServiceGetContrastRequest(detector_name: str = betterproto.string_field(1))

Bases: Message

The DetectorServiceGetContrastRequest class.

Attributes:

• detector_name (str) –

  The unique name of the detector to control as string. Must be part of ZenApi.EM.Hardware.V1.IDetectorApi.GetAvailableDetectors.

detector_name class-attribute instance-attribute

detector_name: str = string_field(1)

The unique name of the detector to control as string. Must be part of ZenApi.EM.Hardware.V1.IDetectorApi.GetAvailableDetectors.

DetectorServiceGetContrastResponse dataclass

DetectorServiceGetContrastResponse(contrast: float = betterproto.double_field(1))

Bases: Message

Response object representing a detector contrast value.

Attributes:

• contrast (float) –

  The contrast in percentage [0, 100].

contrast class-attribute instance-attribute

contrast: float = double_field(1)

The contrast in percentage [0, 100].

DetectorServiceRegisterOnBrightnessChangedRequest dataclass

DetectorServiceRegisterOnBrightnessChangedRequest(detector_name: str = betterproto.string_field(1))

Bases: Message

The DetectorServiceRegisterOnBrightnessChangedRequest class.

Attributes:

• detector_name (str) –

  The unique name of the detector to control as string. Must be part of ZenApi.EM.Hardware.V1.IDetectorApi.GetAvailableDetectors.

detector_name class-attribute instance-attribute

detector_name: str = string_field(1)

The unique name of the detector to control as string. Must be part of ZenApi.EM.Hardware.V1.IDetectorApi.GetAvailableDetectors.

DetectorServiceRegisterOnBrightnessChangedResponse dataclass

DetectorServiceRegisterOnBrightnessChangedResponse(brightness: float = betterproto.double_field(1))

Bases: Message

Response object representing a detector brightness value.

Attributes:

• brightness (float) –

  The brightness in percentage [0, 100].

brightness class-attribute instance-attribute

brightness: float = double_field(1)

The brightness in percentage [0, 100].

DetectorServiceRegisterOnContrastChangedRequest dataclass

DetectorServiceRegisterOnContrastChangedRequest(detector_name: str = betterproto.string_field(1))

Bases: Message

The DetectorServiceRegisterOnContrastChangedRequest class.

Attributes:

• detector_name (str) –

  The unique name of the detector to control as string. Must be part of ZenApi.EM.Hardware.V1.IDetectorApi.GetAvailableDetectors.

detector_name class-attribute instance-attribute

detector_name: str = string_field(1)

The unique name of the detector to control as string. Must be part of ZenApi.EM.Hardware.V1.IDetectorApi.GetAvailableDetectors.

DetectorServiceRegisterOnContrastChangedResponse dataclass

DetectorServiceRegisterOnContrastChangedResponse(contrast: float = betterproto.double_field(1))

Bases: Message

Response object representing a detector contrast value.

Attributes:

• contrast (float) –

  The contrast in percentage [0, 100].

contrast class-attribute instance-attribute

contrast: float = double_field(1)

The contrast in percentage [0, 100].

DetectorServiceSetBrightnessRequest dataclass

DetectorServiceSetBrightnessRequest(detector_name: str = betterproto.string_field(1), brightness: float = betterproto.double_field(2))

Bases: Message

The DetectorServiceSetBrightnessRequest class.

Attributes:

• detector_name (str) –

  The unique name of the detector to control as string. Must be part of ZenApi.EM.Hardware.V1.IDetectorApi.GetAvailableDetectors.

• brightness (float) –

  The brightness value to apply in percentage [0, 1].

detector_name class-attribute instance-attribute

detector_name: str = string_field(1)

The unique name of the detector to control as string. Must be part of ZenApi.EM.Hardware.V1.IDetectorApi.GetAvailableDetectors.

brightness class-attribute instance-attribute

brightness: float = double_field(2)

The brightness value to apply in percentage [0, 1].

DetectorServiceSetBrightnessResponse dataclass

DetectorServiceSetBrightnessResponse(brightness: float = betterproto.double_field(1))

Bases: Message

Response object representing a detector brightness value.

Attributes:

• brightness (float) –

  The brightness in percentage [0, 100].

brightness class-attribute instance-attribute

brightness: float = double_field(1)

The brightness in percentage [0, 100].

DetectorServiceSetContrastRequest dataclass

DetectorServiceSetContrastRequest(detector_name: str = betterproto.string_field(1), contrast: float = betterproto.double_field(2))

Bases: Message

The DetectorServiceSetContrastRequest class.

Attributes:

• detector_name (str) –

  The unique name of the detector to control as string. Must be part of ZenApi.EM.Hardware.V1.IDetectorApi.GetAvailableDetectors.

• contrast (float) –

  The contrast value to apply in percentage [0, 1].

detector_name class-attribute instance-attribute

detector_name: str = string_field(1)

The unique name of the detector to control as string. Must be part of ZenApi.EM.Hardware.V1.IDetectorApi.GetAvailableDetectors.

contrast class-attribute instance-attribute

contrast: float = double_field(2)

The contrast value to apply in percentage [0, 1].

DetectorServiceSetContrastResponse dataclass

DetectorServiceSetContrastResponse(contrast: float = betterproto.double_field(1))

Bases: Message

Response object representing a detector contrast value.

Attributes:

• contrast (float) –

  The contrast in percentage [0, 100].

contrast class-attribute instance-attribute

contrast: float = double_field(1)

The contrast in percentage [0, 100].

ElectronColumnServiceGetActualVoltageRequest dataclass

ElectronColumnServiceGetActualVoltageRequest()

Bases: Message

The ElectronColumnServiceGetActualVoltageRequest class.

ElectronColumnServiceGetActualVoltageResponse dataclass

ElectronColumnServiceGetActualVoltageResponse(voltage: float = betterproto.double_field(1))

Bases: Message

Response object representing the eht/voltage.

Attributes:

• voltage (float) –

  The eht/voltage in volts.

voltage class-attribute instance-attribute

voltage: float = double_field(1)

The eht/voltage in volts.

ElectronColumnServiceGetBeamShiftRequest dataclass

ElectronColumnServiceGetBeamShiftRequest()

Bases: Message

The ElectronColumnServiceGetBeamShiftRequest class.

ElectronColumnServiceGetBeamShiftResponse dataclass

ElectronColumnServiceGetBeamShiftResponse(shift_x: float = betterproto.double_field(1), shift_y: float = betterproto.double_field(2))

Bases: Message

Response object describing the beam shift values.

Attributes:

• shift_x (float) –

  The x beam shift in meters.

• shift_y (float) –

  The y beam shift in meters.

shift_x class-attribute instance-attribute

shift_x: float = double_field(1)

The x beam shift in meters.

shift_y class-attribute instance-attribute

shift_y: float = double_field(2)

The y beam shift in meters.

ElectronColumnServiceGetBeamStateRequest dataclass

ElectronColumnServiceGetBeamStateRequest()

Bases: Message

The ElectronColumnServiceGetBeamStateRequest class.

ElectronColumnServiceGetBeamStateResponse dataclass

ElectronColumnServiceGetBeamStateResponse(state: BeamState = betterproto.enum_field(1), task_success: bool = betterproto.bool_field(2))

Bases: Message

BeamState enum wrapper.

Attributes:

• state (BeamState) –

  The beam state.

• task_success (bool) –

  A value indicating whether the task to change beam state succeeded or not.

state class-attribute instance-attribute

state: BeamState = enum_field(1)

The beam state.

task_success class-attribute instance-attribute

task_success: bool = bool_field(2)

A value indicating whether the task to change beam state succeeded or not.

ElectronColumnServiceGetFocusLimitsRequest dataclass

ElectronColumnServiceGetFocusLimitsRequest()

Bases: Message

The ElectronColumnServiceGetFocusLimitsRequest class.

ElectronColumnServiceGetFocusLimitsResponse dataclass

ElectronColumnServiceGetFocusLimitsResponse(focus_min: float = betterproto.double_field(1), focus_max: float = betterproto.double_field(2))

Bases: Message

Response object representing the column focus.

Attributes:

• focus_min (float) –

  The minimum focus in meters.

• focus_max (float) –

  The maximum focus in meters.

focus_min class-attribute instance-attribute

focus_min: float = double_field(1)

The minimum focus in meters.

focus_max class-attribute instance-attribute

focus_max: float = double_field(2)

The maximum focus in meters.

ElectronColumnServiceGetFocusRequest dataclass

ElectronColumnServiceGetFocusRequest()

Bases: Message

The ElectronColumnServiceGetFocusRequest class.

ElectronColumnServiceGetFocusResponse dataclass

ElectronColumnServiceGetFocusResponse(focus: float = betterproto.double_field(1))

Bases: Message

Response object representing the column focus.

Attributes:

• focus (float) –

  The focus in meters.

focus class-attribute instance-attribute

focus: float = double_field(1)

The focus in meters.

ElectronColumnServiceGetFovRequest dataclass

ElectronColumnServiceGetFovRequest()

Bases: Message

The ElectronColumnServiceGetFovRequest class.

ElectronColumnServiceGetFovResponse dataclass

ElectronColumnServiceGetFovResponse(fov: float = betterproto.double_field(1))

Bases: Message

Response object representing the field of view expansion.

Attributes:

• fov (float) –

  The fov expansion in meters.

fov class-attribute instance-attribute

fov: float = double_field(1)

The fov expansion in meters.

ElectronColumnServiceGetFovRotationRequest dataclass

ElectronColumnServiceGetFovRotationRequest()

Bases: Message

The ElectronColumnServiceGetFovRotationRequest class.

ElectronColumnServiceGetFovRotationResponse dataclass

ElectronColumnServiceGetFovRotationResponse(rotation: float = betterproto.double_field(1))

Bases: Message

Response object representing the field of view rotation.

Attributes:

• rotation (float) –

  The field of view rotation in radians.

rotation class-attribute instance-attribute

rotation: float = double_field(1)

The field of view rotation in radians.

ElectronColumnServiceGetProbeCurrentRequest dataclass

ElectronColumnServiceGetProbeCurrentRequest()

Bases: Message

The ElectronColumnServiceGetProbeCurrentRequest class.

ElectronColumnServiceGetProbeCurrentResponse dataclass

ElectronColumnServiceGetProbeCurrentResponse(probe_current: float = betterproto.double_field(1))

Bases: Message

Response object representing the probe current.

Attributes:

• probe_current (float) –

  The probe current value in Amps.

probe_current class-attribute instance-attribute

probe_current: float = double_field(1)

The probe current value in Amps.

ElectronColumnServiceGetSemiAngleRequest dataclass

ElectronColumnServiceGetSemiAngleRequest()

Bases: Message

The ElectronColumnServiceGetSemiAngleRequest class.

ElectronColumnServiceGetSemiAngleResponse dataclass

ElectronColumnServiceGetSemiAngleResponse(angle: float = betterproto.double_field(1))

Bases: Message

Response object describing the semi angle value.

Attributes:

• angle (float) –

  The semi angle in radians.

angle class-attribute instance-attribute

angle: float = double_field(1)

The semi angle in radians.

ElectronColumnServiceGetSpotSizeRequest dataclass

ElectronColumnServiceGetSpotSizeRequest()

Bases: Message

The ElectronColumnServiceGetSpotSizeRequest class.

ElectronColumnServiceGetSpotSizeResponse dataclass

ElectronColumnServiceGetSpotSizeResponse(spot_size: float = betterproto.double_field(1))

Bases: Message

Response object representing the spot size.

Attributes:

• spot_size (float) –

  The spot size in meters.

spot_size class-attribute instance-attribute

spot_size: float = double_field(1)

The spot size in meters.

ElectronColumnServiceGetStigmatorRequest dataclass

ElectronColumnServiceGetStigmatorRequest()

Bases: Message

The ElectronColumnServiceGetStigmatorRequest class.

ElectronColumnServiceGetStigmatorResponse dataclass

ElectronColumnServiceGetStigmatorResponse(stigmator_x: float = betterproto.double_field(1), stigmator_y: float = betterproto.double_field(2))

Bases: Message

Response object representing the stigmator value of the electron column.

Attributes:

• stigmator_x (float) –

  The stigmator x in percent [0,1].

• stigmator_y (float) –

  The stigmator y in percent [0,1].

stigmator_x class-attribute instance-attribute

stigmator_x: float = double_field(1)

The stigmator x in percent [0,1].

stigmator_y class-attribute instance-attribute

stigmator_y: float = double_field(2)

The stigmator y in percent [0,1].

ElectronColumnServiceGetTargetVoltageRequest dataclass

ElectronColumnServiceGetTargetVoltageRequest()

Bases: Message

The ElectronColumnServiceGetTargetVoltageRequest class.

ElectronColumnServiceGetTargetVoltageResponse dataclass

ElectronColumnServiceGetTargetVoltageResponse(voltage: float = betterproto.double_field(1))

Bases: Message

Response object representing the eht/voltage.

Attributes:

• voltage (float) –

  The eht/voltage in volts.

voltage class-attribute instance-attribute

voltage: float = double_field(1)

The eht/voltage in volts.

ElectronColumnServiceGoToStandbyRequest dataclass

ElectronColumnServiceGoToStandbyRequest()

Bases: Message

The ElectronColumnServiceGoToStandbyRequest class.

ElectronColumnServiceGoToStandbyResponse dataclass

ElectronColumnServiceGoToStandbyResponse(state: BeamState = betterproto.enum_field(1), task_success: bool = betterproto.bool_field(2))

Bases: Message

BeamState enum wrapper.

Attributes:

• state (BeamState) –

  The beam state.

• task_success (bool) –

  A value indicating whether the task to change beam state succeeded or not.

state class-attribute instance-attribute

state: BeamState = enum_field(1)

The beam state.

task_success class-attribute instance-attribute

task_success: bool = bool_field(2)

A value indicating whether the task to change beam state succeeded or not.

ElectronColumnServiceRegisterOnBeamShiftChangedRequest dataclass

ElectronColumnServiceRegisterOnBeamShiftChangedRequest()

Bases: Message

The ElectronColumnServiceRegisterOnBeamShiftChangedRequest class.

ElectronColumnServiceRegisterOnBeamShiftChangedResponse dataclass

ElectronColumnServiceRegisterOnBeamShiftChangedResponse(shift_x: float = betterproto.double_field(1), shift_y: float = betterproto.double_field(2))

Bases: Message

Response object describing the beam shift values.

Attributes:

• shift_x (float) –

  The x beam shift in meters.

• shift_y (float) –

  The y beam shift in meters.

shift_x class-attribute instance-attribute

shift_x: float = double_field(1)

The x beam shift in meters.

shift_y class-attribute instance-attribute

shift_y: float = double_field(2)

The y beam shift in meters.

ElectronColumnServiceRegisterOnBeamStateChangedRequest dataclass

ElectronColumnServiceRegisterOnBeamStateChangedRequest()

Bases: Message

The ElectronColumnServiceRegisterOnBeamStateChangedRequest class.

ElectronColumnServiceRegisterOnBeamStateChangedResponse dataclass

ElectronColumnServiceRegisterOnBeamStateChangedResponse(state: BeamState = betterproto.enum_field(1), task_success: bool = betterproto.bool_field(2))

Bases: Message

BeamState enum wrapper.

Attributes:

• state (BeamState) –

  The beam state.

• task_success (bool) –

  A value indicating whether the task to change beam state succeeded or not.

state class-attribute instance-attribute

state: BeamState = enum_field(1)

The beam state.

task_success class-attribute instance-attribute

task_success: bool = bool_field(2)

A value indicating whether the task to change beam state succeeded or not.

ElectronColumnServiceRegisterOnFocusChangedRequest dataclass

ElectronColumnServiceRegisterOnFocusChangedRequest()

Bases: Message

The ElectronColumnServiceRegisterOnFocusChangedRequest class.

ElectronColumnServiceRegisterOnFocusChangedResponse dataclass

ElectronColumnServiceRegisterOnFocusChangedResponse(focus: float = betterproto.double_field(1))

Bases: Message

Response object representing the column focus.

Attributes:

• focus (float) –

  The focus in meters.

focus class-attribute instance-attribute

focus: float = double_field(1)

The focus in meters.

ElectronColumnServiceRegisterOnFovChangedRequest dataclass

ElectronColumnServiceRegisterOnFovChangedRequest()

Bases: Message

The ElectronColumnServiceRegisterOnFovChangedRequest class.

ElectronColumnServiceRegisterOnFovChangedResponse dataclass

ElectronColumnServiceRegisterOnFovChangedResponse(fov: float = betterproto.double_field(1))

Bases: Message

Response object representing the field of view expansion.

Attributes:

• fov (float) –

  The fov expansion in meters.

fov class-attribute instance-attribute

fov: float = double_field(1)

The fov expansion in meters.

ElectronColumnServiceRegisterOnFovRotationChangedRequest dataclass

ElectronColumnServiceRegisterOnFovRotationChangedRequest()

Bases: Message

The ElectronColumnServiceRegisterOnFovRotationChangedRequest class.

ElectronColumnServiceRegisterOnFovRotationChangedResponse dataclass

ElectronColumnServiceRegisterOnFovRotationChangedResponse(rotation: float = betterproto.double_field(1))

Bases: Message

Response object representing the field of view rotation.

Attributes:

• rotation (float) –

  The field of view rotation in radians.

rotation class-attribute instance-attribute

rotation: float = double_field(1)

The field of view rotation in radians.

ElectronColumnServiceRegisterOnProbeCurrentChangedRequest dataclass

ElectronColumnServiceRegisterOnProbeCurrentChangedRequest()

Bases: Message

The ElectronColumnServiceRegisterOnProbeCurrentChangedRequest class.

ElectronColumnServiceRegisterOnProbeCurrentChangedResponse dataclass

ElectronColumnServiceRegisterOnProbeCurrentChangedResponse(probe_current: float = betterproto.double_field(1))

Bases: Message

Response object representing the probe current.

Attributes:

• probe_current (float) –

  The probe current value in Amps.

probe_current class-attribute instance-attribute

probe_current: float = double_field(1)

The probe current value in Amps.

ElectronColumnServiceRegisterOnSemiAngleChangedRequest dataclass

ElectronColumnServiceRegisterOnSemiAngleChangedRequest()

Bases: Message

The ElectronColumnServiceRegisterOnSemiAngleChangedRequest class.

ElectronColumnServiceRegisterOnSemiAngleChangedResponse dataclass

ElectronColumnServiceRegisterOnSemiAngleChangedResponse(angle: float = betterproto.double_field(1))

Bases: Message

Response object describing the semi angle values.

Attributes:

• angle (float) –

  The semi angle in radians.

angle class-attribute instance-attribute

angle: float = double_field(1)

The semi angle in radians.

ElectronColumnServiceRegisterOnSpotSizeChangedRequest dataclass

ElectronColumnServiceRegisterOnSpotSizeChangedRequest()

Bases: Message

The ElectronColumnServiceRegisterOnSpotSizeChangedRequest class.

ElectronColumnServiceRegisterOnSpotSizeChangedResponse dataclass

ElectronColumnServiceRegisterOnSpotSizeChangedResponse(spot_size: float = betterproto.double_field(1))

Bases: Message

Response object representing the spot size.

Attributes:

• spot_size (float) –

  The spot size in meters.

spot_size class-attribute instance-attribute

spot_size: float = double_field(1)

The spot size in meters.

ElectronColumnServiceRegisterOnStigmatorChangedRequest dataclass

ElectronColumnServiceRegisterOnStigmatorChangedRequest()

Bases: Message

The ElectronColumnServiceRegisterOnStigmatorChangedRequest class.

ElectronColumnServiceRegisterOnStigmatorChangedResponse dataclass

ElectronColumnServiceRegisterOnStigmatorChangedResponse(stigmator_x: float = betterproto.double_field(1), stigmator_y: float = betterproto.double_field(2))

Bases: Message

Response object representing stigmator changes of the electron column.

Attributes:

• stigmator_x (float) –

  The stigmator x in percent [0,1].

• stigmator_y (float) –

  The stigmator y in percent [0,1].

stigmator_x class-attribute instance-attribute

stigmator_x: float = double_field(1)

The stigmator x in percent [0,1].

stigmator_y class-attribute instance-attribute

stigmator_y: float = double_field(2)

The stigmator y in percent [0,1].

ElectronColumnServiceRegisterOnVoltageChangedRequest dataclass

ElectronColumnServiceRegisterOnVoltageChangedRequest()

Bases: Message

The ElectronColumnServiceRegisterOnVoltageChangedRequest class.

ElectronColumnServiceRegisterOnVoltageChangedResponse dataclass

ElectronColumnServiceRegisterOnVoltageChangedResponse(voltage: float = betterproto.double_field(1))

Bases: Message

Response object representing the eht/voltage.

Attributes:

• voltage (float) –

  The eht/voltage in volts.

voltage class-attribute instance-attribute

voltage: float = double_field(1)

The eht/voltage in volts.

ElectronColumnServiceSetBeamShiftRequest dataclass

ElectronColumnServiceSetBeamShiftRequest(xshift: Optional[float] = betterproto.message_field(1, wraps=(betterproto.TYPE_DOUBLE)), yshift: Optional[float] = betterproto.message_field(2, wraps=(betterproto.TYPE_DOUBLE)))

Bases: Message

The ElectronColumnServiceSetBeamShiftRequest class.

Attributes:

• xshift (Optional[float]) –

  The new beam shift x in meters. null if it should not be changed.

• yshift (Optional[float]) –

  The new beam shift y in meters. null if it should not be changed.

xshift class-attribute instance-attribute

xshift: Optional[float] = message_field(1, wraps=TYPE_DOUBLE)

The new beam shift x in meters. null if it should not be changed.

yshift class-attribute instance-attribute

yshift: Optional[float] = message_field(2, wraps=TYPE_DOUBLE)

The new beam shift y in meters. null if it should not be changed.

ElectronColumnServiceSetBeamShiftResponse dataclass

ElectronColumnServiceSetBeamShiftResponse(shift_x: float = betterproto.double_field(1), shift_y: float = betterproto.double_field(2))

Bases: Message

Response object describing the beam shift values.

Attributes:

• shift_x (float) –

  The x beam shift in meters.

• shift_y (float) –

  The y beam shift in meters.

shift_x class-attribute instance-attribute

shift_x: float = double_field(1)

The x beam shift in meters.

shift_y class-attribute instance-attribute

shift_y: float = double_field(2)

The y beam shift in meters.

ElectronColumnServiceSetFocusRequest dataclass

ElectronColumnServiceSetFocusRequest(focus: float = betterproto.double_field(1))

Bases: Message

The ElectronColumnServiceSetFocusRequest class.

Attributes:

• focus (float) –

  The new focus in meters.

focus class-attribute instance-attribute

focus: float = double_field(1)

The new focus in meters.

ElectronColumnServiceSetFocusResponse dataclass

ElectronColumnServiceSetFocusResponse(focus: float = betterproto.double_field(1))

Bases: Message

Response object representing the column focus.

Attributes:

• focus (float) –

  The focus in meters.

focus class-attribute instance-attribute

focus: float = double_field(1)

The focus in meters.

ElectronColumnServiceSetFovRequest dataclass

ElectronColumnServiceSetFovRequest(fov: float = betterproto.double_field(1))

Bases: Message

The ElectronColumnServiceSetFovRequest class.

Attributes:

• fov (float) –

  The size of the new FOV in meters.

fov class-attribute instance-attribute

fov: float = double_field(1)

The size of the new FOV in meters.

ElectronColumnServiceSetFovResponse dataclass

ElectronColumnServiceSetFovResponse(fov: float = betterproto.double_field(1))

Bases: Message

Response object representing the field of view expansion.

Attributes:

• fov (float) –

  The fov expansion in meters.

fov class-attribute instance-attribute

fov: float = double_field(1)

The fov expansion in meters.

ElectronColumnServiceSetFovRotationRequest dataclass

ElectronColumnServiceSetFovRotationRequest(fov_rotation: float = betterproto.double_field(1))

Bases: Message

The ElectronColumnServiceSetFovRotationRequest class.

Attributes:

• fov_rotation (float) –

  The rotation in radians, clockwise.

fov_rotation class-attribute instance-attribute

fov_rotation: float = double_field(1)

The rotation in radians, clockwise.

ElectronColumnServiceSetFovRotationResponse dataclass

ElectronColumnServiceSetFovRotationResponse(rotation: float = betterproto.double_field(1))

Bases: Message

Response object representing the field of view rotation.

Attributes:

• rotation (float) –

  The field of view rotation in radians.

rotation class-attribute instance-attribute

rotation: float = double_field(1)

The field of view rotation in radians.

ElectronColumnServiceSetStigmatorRequest dataclass

ElectronColumnServiceSetStigmatorRequest(stigmator_x: Optional[float] = betterproto.message_field(1, wraps=(betterproto.TYPE_DOUBLE)), stigmator_y: Optional[float] = betterproto.message_field(2, wraps=(betterproto.TYPE_DOUBLE)))

Bases: Message

The ElectronColumnServiceSetStigmatorRequest class.

Attributes:

• stigmator_x (Optional[float]) –

  The stigmator x value in percent [0, 1] or null if is not supposed to change.

• stigmator_y (Optional[float]) –

  The stigmator y value in percent [0, 1] or null if is not supposed to change.

stigmator_x class-attribute instance-attribute

stigmator_x: Optional[float] = message_field(1, wraps=TYPE_DOUBLE)

The stigmator x value in percent [0, 1] or null if is not supposed to change.

stigmator_y class-attribute instance-attribute

stigmator_y: Optional[float] = message_field(2, wraps=TYPE_DOUBLE)

The stigmator y value in percent [0, 1] or null if is not supposed to change.

ElectronColumnServiceSetStigmatorResponse dataclass

ElectronColumnServiceSetStigmatorResponse(stigmator_x: float = betterproto.double_field(1), stigmator_y: float = betterproto.double_field(2))

Bases: Message

Response object representing the stigmator set value.

Attributes:

• stigmator_x (float) –

  The stigmator x in percent [0,1].

• stigmator_y (float) –

  The stigmator y in percent [0,1].

stigmator_x class-attribute instance-attribute

stigmator_x: float = double_field(1)

The stigmator x in percent [0,1].

stigmator_y class-attribute instance-attribute

stigmator_y: float = double_field(2)

The stigmator y in percent [0,1].

ElectronColumnServiceSetVoltageRequest dataclass

ElectronColumnServiceSetVoltageRequest(voltage: float = betterproto.double_field(1))

Bases: Message

The ElectronColumnServiceSetVoltageRequest class.

Attributes:

• voltage (float) –

  The new eht/voltage in volts.

voltage class-attribute instance-attribute

voltage: float = double_field(1)

The new eht/voltage in volts.

ElectronColumnServiceSetVoltageResponse dataclass

ElectronColumnServiceSetVoltageResponse(voltage: float = betterproto.double_field(1))

Bases: Message

Response object representing the eht/voltage.

Attributes:

• voltage (float) –

  The eht/voltage in volts.

voltage class-attribute instance-attribute

voltage: float = double_field(1)

The eht/voltage in volts.

ElectronColumnServiceTurnOffRequest dataclass

ElectronColumnServiceTurnOffRequest()

Bases: Message

The ElectronColumnServiceTurnOffRequest class.

ElectronColumnServiceTurnOffResponse dataclass

ElectronColumnServiceTurnOffResponse(state: BeamState = betterproto.enum_field(1), task_success: bool = betterproto.bool_field(2))

Bases: Message

BeamState enum wrapper.

Attributes:

• state (BeamState) –

  The beam state.

• task_success (bool) –

  A value indicating whether the task to change beam state succeeded or not.

state class-attribute instance-attribute

state: BeamState = enum_field(1)

The beam state.

task_success class-attribute instance-attribute

task_success: bool = bool_field(2)

A value indicating whether the task to change beam state succeeded or not.

ElectronColumnServiceTurnOnRequest dataclass

ElectronColumnServiceTurnOnRequest()

Bases: Message

The ElectronColumnServiceTurnOnRequest class.

ElectronColumnServiceTurnOnResponse dataclass

ElectronColumnServiceTurnOnResponse(state: BeamState = betterproto.enum_field(1), task_success: bool = betterproto.bool_field(2))

Bases: Message

BeamState enum wrapper.

Attributes:

• state (BeamState) –

  The beam state.

• task_success (bool) –

  A value indicating whether the task to change beam state succeeded or not.

state class-attribute instance-attribute

state: BeamState = enum_field(1)

The beam state.

task_success class-attribute instance-attribute

task_success: bool = bool_field(2)

A value indicating whether the task to change beam state succeeded or not.

ExtendedAcquisitionSettings dataclass

ExtendedAcquisitionSettings(detector_name: str = betterproto.string_field(1), width: int = betterproto.int32_field(2), height: int = betterproto.int32_field(3), dwell_time: float = betterproto.double_field(4), frame_averages: int = betterproto.int32_field(5), line_averages: int = betterproto.int32_field(6), scan_size_x: float = betterproto.double_field(7), scan_size_y: float = betterproto.double_field(8), scan_center_x: float = betterproto.double_field(9), scan_center_y: float = betterproto.double_field(10))

Bases: Message

Request object to set the simple acquisition settings.

Attributes:

• detector_name (str) –

  The detector to use.

• width (int) –

  The image width in pixels.

• height (int) –

  The image height in pixels.

• dwell_time (float) –

  The dwell time in seconds.

• frame_averages (int) –

  The number of frames to average.

• line_averages (int) –

  The number of lines to average.

• scan_size_x (float) –

  The relative size of the scan field in x direction

• scan_size_y (float) –

  The relative size of the scan field in y direction

• scan_center_x (float) –

  The relative position of the scan field in x direction

• scan_center_y (float) –

  The relative position of the scan field in y direction

detector_name class-attribute instance-attribute

detector_name: str = string_field(1)

The detector to use. Null will take the detector from the previous acquisition.

width class-attribute instance-attribute

width: int = int32_field(2)

The image width in pixels.

height class-attribute instance-attribute

height: int = int32_field(3)

The image height in pixels.

dwell_time class-attribute instance-attribute

dwell_time: float = double_field(4)

The dwell time in seconds. The closest dwell time to the selected one will be chosen.

frame_averages class-attribute instance-attribute

frame_averages: int = int32_field(5)

The number of frames to average. 1 means no averaging.

line_averages class-attribute instance-attribute

line_averages: int = int32_field(6)

The number of lines to average. 1 means no averaging.

scan_size_x class-attribute instance-attribute

scan_size_x: float = double_field(7)

The relative size of the scan field in x direction proportional to the full field of view, where the FOV equals 1. Range (0, 1].

scan_size_y class-attribute instance-attribute

scan_size_y: float = double_field(8)

The relative size of the scan field in y direction proportional to the full field of view, where the FOV equals 1. Range (0, 1].

scan_center_x class-attribute instance-attribute

scan_center_x: float = double_field(9)

The relative position of the scan field in x direction proportional to the full field of view, where the optical axis is at (0,0) and the FOV ranges from -0.5 to 0.5. Range (-0.5, 0.5).

scan_center_y class-attribute instance-attribute

scan_center_y: float = double_field(10)

The relative position of the scan field in y direction proportional to the full field of view, where the optical axis is at (0,0) and the FOV ranges from -0.5 to 0.5. Range (-0.5, 0.5).

ExternalProcedureServiceRegisterExternalProcedureRequest dataclass

ExternalProcedureServiceRegisterExternalProcedureRequest()

Bases: Message

The ExternalProcedureServiceRegisterExternalProcedureRequest class.

ExternalProcedureServiceRegisterExternalProcedureResponse dataclass

ExternalProcedureServiceRegisterExternalProcedureResponse(parameters: List[str] = betterproto.string_field(1), id: str = betterproto.string_field(2), command_id: CommandId = betterproto.enum_field(3))

Bases: Message

transfer object definition used to send commands to external procedures

Attributes:

• parameters (List[str]) –

  An array of string parameters, may be empty

• id (str) –

  The System.Guid of the external procedure the command is for, needs to be filtered by external procedures, as all procedures use the same channel to listen for commands

• command_id (CommandId) –

  The ZenApi.EM.Hardware.V1.ExternalProcedureServiceRegisterExternalProcedureResponse.CommandId telling the external procedure what to do

parameters class-attribute instance-attribute

parameters: List[str] = string_field(1)

An array of string parameters, may be empty

id class-attribute instance-attribute

id: str = string_field(2)

The System.Guid of the external procedure the command is for, needs to be filtered by external procedures, as all procedures use the same channel to listen for commands

command_id class-attribute instance-attribute

command_id: CommandId = enum_field(3)

The ZenApi.EM.Hardware.V1.ExternalProcedureServiceRegisterExternalProcedureResponse.CommandId telling the external procedure what to do

ExternalProcedureServiceReportCommandFailureRequest dataclass

ExternalProcedureServiceReportCommandFailureRequest(id: str = betterproto.string_field(1), command_id: CommandId = betterproto.enum_field(2))

Bases: Message

The ExternalProcedureServiceReportCommandFailureRequest class.

Attributes:

• id (str) –

  the System.Guid of a given running script a command has been send to.

• command_id (CommandId) –

  the ZenApi.EM.Hardware.V1.CommandId of a given command.

id class-attribute instance-attribute

id: str = string_field(1)

the System.Guid of a given running script a command has been send to.

command_id class-attribute instance-attribute

command_id: CommandId = enum_field(2)

the ZenApi.EM.Hardware.V1.CommandId of a given command.

ExternalProcedureServiceReportCommandFailureResponse dataclass

ExternalProcedureServiceReportCommandFailureResponse()

Bases: Message

The ExternalProcedureServiceReportCommandFailureResponse class.

ExternalProcedureServiceReportCommandSuccessRequest dataclass

ExternalProcedureServiceReportCommandSuccessRequest(id: str = betterproto.string_field(1), command_id: CommandId = betterproto.enum_field(2))

Bases: Message

The ExternalProcedureServiceReportCommandSuccessRequest class.

Attributes:

• id (str) –

  the System.Guid of a given running script a command has been send to.

• command_id (CommandId) –

  the ZenApi.EM.Hardware.V1.CommandId of a given command.

id class-attribute instance-attribute

id: str = string_field(1)

the System.Guid of a given running script a command has been send to.

command_id class-attribute instance-attribute

command_id: CommandId = enum_field(2)

the ZenApi.EM.Hardware.V1.CommandId of a given command.

ExternalProcedureServiceReportCommandSuccessResponse dataclass

ExternalProcedureServiceReportCommandSuccessResponse()

Bases: Message

The ExternalProcedureServiceReportCommandSuccessResponse class.

ExternalProcedureServiceReportInitializationErrorRequest dataclass

ExternalProcedureServiceReportInitializationErrorRequest(id: str = betterproto.string_field(1), error_message: str = betterproto.string_field(2))

Bases: Message

The ExternalProcedureServiceReportInitializationErrorRequest class.

Attributes:

• id (str) –

  the id as System.Guid of the external procedure.

• error_message (str) –

  a System.String error message.

id class-attribute instance-attribute

id: str = string_field(1)

the id as System.Guid of the external procedure.

error_message class-attribute instance-attribute

error_message: str = string_field(2)

a System.String error message.

ExternalProcedureServiceReportInitializationErrorResponse dataclass

ExternalProcedureServiceReportInitializationErrorResponse()

Bases: Message

The ExternalProcedureServiceReportInitializationErrorResponse class.

ExternalProcedureServiceReportProgressRequest dataclass

ExternalProcedureServiceReportProgressRequest(id: str = betterproto.string_field(1), progress: float = betterproto.double_field(2))

Bases: Message

The ExternalProcedureServiceReportProgressRequest class.

Attributes:

• id (str) –

  the id as System.Guid of the external procedure.

• progress (float) –

  The progress to be reported i the range [0, 1]. Alternatively, -1 for undetermined progress.

id class-attribute instance-attribute

id: str = string_field(1)

the id as System.Guid of the external procedure.

progress class-attribute instance-attribute

progress: float = double_field(2)

The progress to be reported i the range [0, 1]. Alternatively, -1 for undetermined progress.

ExternalProcedureServiceReportProgressResponse dataclass

ExternalProcedureServiceReportProgressResponse()

Bases: Message

The ExternalProcedureServiceReportProgressResponse class.

ExternalProcedureServiceReportReadyRequest dataclass

ExternalProcedureServiceReportReadyRequest(id: str = betterproto.string_field(1), error_message: str = betterproto.string_field(2))

Bases: Message

The ExternalProcedureServiceReportReadyRequest class.

Attributes:

• id (str) –

  the id as System.Guid of the external procedure.

• error_message (str) –

  a nullable System.String to report an error during the execution of the last run.

id class-attribute instance-attribute

id: str = string_field(1)

the id as System.Guid of the external procedure.

error_message class-attribute instance-attribute

error_message: str = string_field(2)

a nullable System.String to report an error during the execution of the last run.

ExternalProcedureServiceReportReadyResponse dataclass

ExternalProcedureServiceReportReadyResponse()

Bases: Message

The ExternalProcedureServiceReportReadyResponse class.

ExternalProcedureServiceReportStatusRequest dataclass

ExternalProcedureServiceReportStatusRequest(id: str = betterproto.string_field(1), message: str = betterproto.string_field(2))

Bases: Message

The ExternalProcedureServiceReportStatusRequest class.

Attributes:

• id (str) –

  the id as System.Guid of the external procedure.

• message (str) –

  the System.String to be reported.

id class-attribute instance-attribute

id: str = string_field(1)

the id as System.Guid of the external procedure.

message class-attribute instance-attribute

message: str = string_field(2)

the System.String to be reported.

ExternalProcedureServiceReportStatusResponse dataclass

ExternalProcedureServiceReportStatusResponse()

Bases: Message

The ExternalProcedureServiceReportStatusResponse class.

IlluminationServiceGetIlluminationIrRequest dataclass

IlluminationServiceGetIlluminationIrRequest()

Bases: Message

The IlluminationServiceGetIlluminationIRRequest class.

IlluminationServiceGetIlluminationIrResponse dataclass

IlluminationServiceGetIlluminationIrResponse(illumination_ir: float = betterproto.double_field(1))

Bases: Message

Response object for the illuminator get illumination IR.

Attributes:

• illumination_ir (float) –

  The illumination IR.

illumination_ir class-attribute instance-attribute

illumination_ir: float = double_field(1)

The illumination IR.

IlluminationServiceGetIlluminationWhiteRequest dataclass

IlluminationServiceGetIlluminationWhiteRequest()

Bases: Message

The IlluminationServiceGetIlluminationWhiteRequest class.

IlluminationServiceGetIlluminationWhiteResponse dataclass

IlluminationServiceGetIlluminationWhiteResponse(illumination_white: float = betterproto.double_field(1))

Bases: Message

Response object for the illuminator get illumination white.

Attributes:

• illumination_white (float) –

  The illumination white.

illumination_white class-attribute instance-attribute

illumination_white: float = double_field(1)

The illumination white.

IlluminationServiceRegisterOnIlluminationIrChangedRequest dataclass

IlluminationServiceRegisterOnIlluminationIrChangedRequest()

Bases: Message

The IlluminationServiceRegisterOnIlluminationIRChangedRequest class.

IlluminationServiceRegisterOnIlluminationIrChangedResponse dataclass

IlluminationServiceRegisterOnIlluminationIrChangedResponse(illumination_ir: float = betterproto.double_field(1))

Bases: Message

Response object for register on illumination IR changed.

Attributes:

• illumination_ir (float) –

  The illumination IR.

illumination_ir class-attribute instance-attribute

illumination_ir: float = double_field(1)

The illumination IR.

IlluminationServiceRegisterOnIlluminationWhiteChangedRequest dataclass

IlluminationServiceRegisterOnIlluminationWhiteChangedRequest()

Bases: Message

The IlluminationServiceRegisterOnIlluminationWhiteChangedRequest class.

IlluminationServiceRegisterOnIlluminationWhiteChangedResponse dataclass

IlluminationServiceRegisterOnIlluminationWhiteChangedResponse(illumination_white: float = betterproto.double_field(1))

Bases: Message

Response object for register on illumination white changed.

Attributes:

• illumination_white (float) –

  The illumination white.

illumination_white class-attribute instance-attribute

illumination_white: float = double_field(1)

The illumination white.

IlluminationServiceSetIlluminationIrRequest dataclass

IlluminationServiceSetIlluminationIrRequest(illumination_ir: float = betterproto.double_field(1))

Bases: Message

The IlluminationServiceSetIlluminationIRRequest class.

Attributes:

• illumination_ir (float) –

  The illumination IR value to set [0..100]%.

illumination_ir class-attribute instance-attribute

illumination_ir: float = double_field(1)

The illumination IR value to set [0..100]%.

IlluminationServiceSetIlluminationIrResponse dataclass

IlluminationServiceSetIlluminationIrResponse(illumination_ir: float = betterproto.double_field(1), success: bool = betterproto.bool_field(2), message: str = betterproto.string_field(3))

Bases: Message

Response object for the illuminator set illumination IR.

Attributes:

• illumination_ir (float) –

  The illumination IR.

• success (bool) –

  A value indicating whether setting the brightness was successful.

• message (str) –

  A string message for display to the customer in failure case. This is only for display purpose and the message may change.

illumination_ir class-attribute instance-attribute

illumination_ir: float = double_field(1)

The illumination IR.

success class-attribute instance-attribute

success: bool = bool_field(2)

A value indicating whether setting the brightness was successful.

message class-attribute instance-attribute

message: str = string_field(3)

A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

IlluminationServiceSetIlluminationWhiteRequest dataclass

IlluminationServiceSetIlluminationWhiteRequest(illumination_white: float = betterproto.double_field(1))

Bases: Message

The IlluminationServiceSetIlluminationWhiteRequest class.

Attributes:

• illumination_white (float) –

  The illumination white value to set [0..100]%.

illumination_white class-attribute instance-attribute

illumination_white: float = double_field(1)

The illumination white value to set [0..100]%.

IlluminationServiceSetIlluminationWhiteResponse dataclass

IlluminationServiceSetIlluminationWhiteResponse(illumination_white: float = betterproto.double_field(1), success: bool = betterproto.bool_field(2), message: str = betterproto.string_field(3))

Bases: Message

Response object for the illuminator set illumination white.

Attributes:

• illumination_white (float) –

  The illumination white.

• success (bool) –

  A value indicating whether setting the brightness was successful.

• message (str) –

  A string message for display to the customer in failure case. This is only for display purpose and the message may change.

illumination_white class-attribute instance-attribute

illumination_white: float = double_field(1)

The illumination white.

success class-attribute instance-attribute

success: bool = bool_field(2)

A value indicating whether setting the brightness was successful.

message class-attribute instance-attribute

message: str = string_field(3)

A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

SimpleAcquisitionServiceAcquireExtendedSingleFrameRequest dataclass

SimpleAcquisitionServiceAcquireExtendedSingleFrameRequest(settings: ExtendedAcquisitionSettings = betterproto.message_field(1))

Bases: Message

The SimpleAcquisitionServiceAcquireExtendedSingleFrameRequest class.

Attributes:

• settings (ExtendedAcquisitionSettings) –

  The imaging settings used to acquire a frame.

settings class-attribute instance-attribute

settings: ExtendedAcquisitionSettings = message_field(1)

The imaging settings used to acquire a frame.

SimpleAcquisitionServiceAcquireExtendedSingleFrameResponse dataclass

SimpleAcquisitionServiceAcquireExtendedSingleFrameResponse(task_success: bool = betterproto.bool_field(1), width: int = betterproto.int32_field(2), height: int = betterproto.int32_field(3), image_data: bytes = betterproto.bytes_field(4), message: str = betterproto.string_field(5))

Bases: Message

Response object of the AcquireExtendedSingleFrame method of the ZenApi.EM.Hardware.V1.ISimpleAcquisitionApi.

Attributes:

• task_success (bool) –

  A value indicating whether the task to initialize the stage succeeded or not.

• width (int) –

  The width in pixels of the image.

• height (int) –

  The height in pixels of the image.

• image_data (bytes) –

  The image raw data, 1 frame.

• message (str) –

  A string message for display to the customer in failure case. This is only for display purpose and the message may change.

task_success class-attribute instance-attribute

task_success: bool = bool_field(1)

A value indicating whether the task to initialize the stage succeeded or not.

width class-attribute instance-attribute

width: int = int32_field(2)

The width in pixels of the image.

height class-attribute instance-attribute

height: int = int32_field(3)

The height in pixels of the image.

image_data class-attribute instance-attribute

image_data: bytes = bytes_field(4)

The image raw data, 1 frame. Frame data as 16 bit per pixel, #pixels = ZenApi.EM.Hardware.V1.SimpleAcquisitionServiceAcquireExtendedSingleFrameResponse.Width * ZenApi.EM.Hardware.V1.SimpleAcquisitionServiceAcquireExtendedSingleFrameResponse.Height. Total length in byte = #pixels * 2.

message class-attribute instance-attribute

message: str = string_field(5)

A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

SimpleAcquisitionServiceAcquireSingleFrameRequest dataclass

SimpleAcquisitionServiceAcquireSingleFrameRequest(settings: AcquisitionSettings = betterproto.message_field(1))

Bases: Message

The SimpleAcquisitionServiceAcquireSingleFrameRequest class.

Attributes:

• settings (AcquisitionSettings) –

  The imaging settings used to acquire a frame.

settings class-attribute instance-attribute

settings: AcquisitionSettings = message_field(1)

The imaging settings used to acquire a frame.

SimpleAcquisitionServiceAcquireSingleFrameResponse dataclass

SimpleAcquisitionServiceAcquireSingleFrameResponse(task_success: bool = betterproto.bool_field(1), width: int = betterproto.int32_field(2), height: int = betterproto.int32_field(3), image_data: bytes = betterproto.bytes_field(4), message: str = betterproto.string_field(5))

Bases: Message

Response object of the AcquireSingleFrame method of the ZenApi.EM.Hardware.V1.ISimpleAcquisitionApi.

Attributes:

• task_success (bool) –

  A value indicating whether the task to initialize the stage succeeded or not.

• width (int) –

  The width in pixels of the image.

• height (int) –

  The height in pixels of the image.

• image_data (bytes) –

  The image raw data, 1 frame.

• message (str) –

  A string message for display to the customer in failure case. This is only for display purpose and the message may change.

task_success class-attribute instance-attribute

task_success: bool = bool_field(1)

A value indicating whether the task to initialize the stage succeeded or not.

width class-attribute instance-attribute

width: int = int32_field(2)

The width in pixels of the image.

height class-attribute instance-attribute

height: int = int32_field(3)

The height in pixels of the image.

image_data class-attribute instance-attribute

image_data: bytes = bytes_field(4)

The image raw data, 1 frame. Frame data as 16 bit per pixel, #pixels = ZenApi.EM.Hardware.V1.SimpleAcquisitionServiceAcquireSingleFrameResponse.Width * ZenApi.EM.Hardware.V1.SimpleAcquisitionServiceAcquireSingleFrameResponse.Height. Total length in byte = #pixels * 2.

message class-attribute instance-attribute

message: str = string_field(5)

A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

SimpleAcquisitionServiceGetAcquisitionStatusRequest dataclass

SimpleAcquisitionServiceGetAcquisitionStatusRequest()

Bases: Message

The SimpleAcquisitionServiceGetAcquisitionStatusRequest class.

SimpleAcquisitionServiceGetAcquisitionStatusResponse dataclass

SimpleAcquisitionServiceGetAcquisitionStatusResponse(status: AcquisitionStatus = betterproto.enum_field(1))

Bases: Message

Response object representing the current acquisition status.

Attributes:

• status (AcquisitionStatus) –

  A value indicating whether the task to initialize the stage succeeded or not.

status class-attribute instance-attribute

status: AcquisitionStatus = enum_field(1)

A value indicating whether the task to initialize the stage succeeded or not.

SimpleAcquisitionServiceGetBrightnessRequest dataclass

SimpleAcquisitionServiceGetBrightnessRequest()

Bases: Message

The SimpleAcquisitionServiceGetBrightnessRequest class.

SimpleAcquisitionServiceGetBrightnessResponse dataclass

SimpleAcquisitionServiceGetBrightnessResponse(brightness: float = betterproto.double_field(1))

Bases: Message

Response object representing a detector brightness value.

Attributes:

• brightness (float) –

  The brightness in percentage [0, 100].

brightness class-attribute instance-attribute

brightness: float = double_field(1)

The brightness in percentage [0, 100].

SimpleAcquisitionServiceGetContrastRequest dataclass

SimpleAcquisitionServiceGetContrastRequest()

Bases: Message

The SimpleAcquisitionServiceGetContrastRequest class.

SimpleAcquisitionServiceGetContrastResponse dataclass

SimpleAcquisitionServiceGetContrastResponse(contrast: float = betterproto.double_field(1))

Bases: Message

Response object representing a detector contrast value.

Attributes:

• contrast (float) –

  The contrast in percentage [0, 100].

contrast class-attribute instance-attribute

contrast: float = double_field(1)

The contrast in percentage [0, 100].

SimpleAcquisitionServiceRegisterOnAcquisitionStatusChangedRequest dataclass

SimpleAcquisitionServiceRegisterOnAcquisitionStatusChangedRequest()

Bases: Message

The SimpleAcquisitionServiceRegisterOnAcquisitionStatusChangedRequest class.

SimpleAcquisitionServiceRegisterOnAcquisitionStatusChangedResponse dataclass

SimpleAcquisitionServiceRegisterOnAcquisitionStatusChangedResponse(status: AcquisitionStatus = betterproto.enum_field(1))

Bases: Message

Response object representing the current acquisition status.

Attributes:

• status (AcquisitionStatus) –

  A value indicating whether the task to initialize the stage succeeded or not.

status class-attribute instance-attribute

status: AcquisitionStatus = enum_field(1)

A value indicating whether the task to initialize the stage succeeded or not.

SimpleAcquisitionServiceSetBrightnessRequest dataclass

SimpleAcquisitionServiceSetBrightnessRequest(brightness: float = betterproto.double_field(1))

Bases: Message

The SimpleAcquisitionServiceSetBrightnessRequest class.

Attributes:

• brightness (float) –

  The brightness value to apply in percentage [0, 1].

brightness class-attribute instance-attribute

brightness: float = double_field(1)

The brightness value to apply in percentage [0, 1].

SimpleAcquisitionServiceSetBrightnessResponse dataclass

SimpleAcquisitionServiceSetBrightnessResponse(brightness: float = betterproto.double_field(1))

Bases: Message

Response object representing a detector brightness value.

Attributes:

• brightness (float) –

  The brightness in percentage [0, 100].

brightness class-attribute instance-attribute

brightness: float = double_field(1)

The brightness in percentage [0, 100].

SimpleAcquisitionServiceSetContrastRequest dataclass

SimpleAcquisitionServiceSetContrastRequest(contrast: float = betterproto.double_field(1))

Bases: Message

The SimpleAcquisitionServiceSetContrastRequest class.

Attributes:

• contrast (float) –

  The contrast value to apply in percentage [0, 1].

contrast class-attribute instance-attribute

contrast: float = double_field(1)

The contrast value to apply in percentage [0, 1].

SimpleAcquisitionServiceSetContrastResponse dataclass

SimpleAcquisitionServiceSetContrastResponse(contrast: float = betterproto.double_field(1))

Bases: Message

Response object representing a detector contrast value.

Attributes:

• contrast (float) –

  The contrast in percentage [0, 100].

contrast class-attribute instance-attribute

contrast: float = double_field(1)

The contrast in percentage [0, 100].

SimpleAcquisitionServiceStartExtendedLiveAcquisitionRequest dataclass

SimpleAcquisitionServiceStartExtendedLiveAcquisitionRequest(settings: ExtendedAcquisitionSettings = betterproto.message_field(1))

Bases: Message

The SimpleAcquisitionServiceStartExtendedLiveAcquisitionRequest class.

Attributes:

• settings (ExtendedAcquisitionSettings) –

  The imaging settings used to acquire multiple frames.

settings class-attribute instance-attribute

settings: ExtendedAcquisitionSettings = message_field(1)

The imaging settings used to acquire multiple frames.

SimpleAcquisitionServiceStartExtendedLiveAcquisitionResponse dataclass

SimpleAcquisitionServiceStartExtendedLiveAcquisitionResponse(task_success: bool = betterproto.bool_field(1), message: str = betterproto.string_field(2))

Bases: Message

Response object of the StartExtendedLiveAcquisition method of the ZenApi.EM.Hardware.V1.ISimpleAcquisitionApi.

Attributes:

• task_success (bool) –

  A value indicating whether the task to acquire an image succeeded or not.

• message (str) –

  A string message for display to the customer in failure case. This is only for display purpose and the message may change.

task_success class-attribute instance-attribute

task_success: bool = bool_field(1)

A value indicating whether the task to acquire an image succeeded or not.

message class-attribute instance-attribute

message: str = string_field(2)

A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

SimpleAcquisitionServiceStartLiveAcquisitionRequest dataclass

SimpleAcquisitionServiceStartLiveAcquisitionRequest(settings: AcquisitionSettings = betterproto.message_field(1))

Bases: Message

The SimpleAcquisitionServiceStartLiveAcquisitionRequest class.

Attributes:

• settings (AcquisitionSettings) –

  The imaging settings used to acquire multiple frames.

settings class-attribute instance-attribute

settings: AcquisitionSettings = message_field(1)

The imaging settings used to acquire multiple frames.

SimpleAcquisitionServiceStartLiveAcquisitionResponse dataclass

SimpleAcquisitionServiceStartLiveAcquisitionResponse(task_success: bool = betterproto.bool_field(1), message: str = betterproto.string_field(2))

Bases: Message

Response object of the StartLiveAcquisition method of the ZenApi.EM.Hardware.V1.ISimpleAcquisitionApi.

Attributes:

• task_success (bool) –

  A value indicating whether the task to acquire an image succeeded or not.

• message (str) –

  A string message for display to the customer in failure case. This is only for display purpose and the message may change.

task_success class-attribute instance-attribute

task_success: bool = bool_field(1)

A value indicating whether the task to acquire an image succeeded or not.

message class-attribute instance-attribute

message: str = string_field(2)

A string message for display to the customer in failure case. This is only for display purpose and the message may change. Empty string on success.

SimpleAcquisitionServiceStopLiveAcquisitionRequest dataclass

SimpleAcquisitionServiceStopLiveAcquisitionRequest()

Bases: Message

The SimpleAcquisitionServiceStopLiveAcquisitionRequest class.

SimpleAcquisitionServiceStopLiveAcquisitionResponse dataclass

SimpleAcquisitionServiceStopLiveAcquisitionResponse()

Bases: Message

The SimpleAcquisitionServiceStopLiveAcquisitionResponse class.

VacuumServiceCloseValveRequest dataclass

VacuumServiceCloseValveRequest(valve: Valve = betterproto.enum_field(1))

Bases: Message

The VacuumServiceCloseValveRequest class.

Attributes:

• valve (Valve) –

  The valve identifier of the valve to close.

valve class-attribute instance-attribute

valve: Valve = enum_field(1)

The valve identifier of the valve to close.

VacuumServiceCloseValveResponse dataclass

VacuumServiceCloseValveResponse(task_success: bool = betterproto.bool_field(1))

Bases: Message

Response object of ZenApi.EM.Hardware.V1.IVacuumApi.CloseValve(ZenApi.EM.Hardware.V1.Valve,System.Threading.CancellationToken) method.

Attributes:

• task_success (bool) –

  A value indicating whether the task to close a valve succeeded or not.

task_success class-attribute instance-attribute

task_success: bool = bool_field(1)

A value indicating whether the task to close a valve succeeded or not.

VacuumServiceGetAvailableVacuumModesRequest dataclass

VacuumServiceGetAvailableVacuumModesRequest()

Bases: Message

The VacuumServiceGetAvailableVacuumModesRequest class.

VacuumServiceGetAvailableVacuumModesResponse dataclass

VacuumServiceGetAvailableVacuumModesResponse(available_modes: List[VacuumMode] = betterproto.enum_field(1))

Bases: Message

AvailableVacuumModes enum collection response.

VacuumServiceGetAvailableValvesRequest dataclass

VacuumServiceGetAvailableValvesRequest()

Bases: Message

The VacuumServiceGetAvailableValvesRequest class.

VacuumServiceGetAvailableValvesResponse dataclass

VacuumServiceGetAvailableValvesResponse(available_valves: List[Valve] = betterproto.enum_field(1))

Bases: Message

AvailableValves enum collection response.

VacuumServiceGetChamberPressureRequest dataclass

VacuumServiceGetChamberPressureRequest()

Bases: Message

The VacuumServiceGetChamberPressureRequest class.

VacuumServiceGetChamberPressureResponse dataclass

VacuumServiceGetChamberPressureResponse(pressure: float = betterproto.double_field(1))

Bases: Message

Response to represent the chamber pressure.

Attributes:

• pressure (float) –

  The chamber pressure in [pascal].

pressure class-attribute instance-attribute

pressure: float = double_field(1)

The chamber pressure in [pascal].

VacuumServiceGetTargetChamberPressureRequest dataclass

VacuumServiceGetTargetChamberPressureRequest()

Bases: Message

The VacuumServiceGetTargetChamberPressureRequest class.

VacuumServiceGetTargetChamberPressureResponse dataclass

VacuumServiceGetTargetChamberPressureResponse(pressure: float = betterproto.double_field(1))

Bases: Message

Response to represent the chamber pressure.

Attributes:

• pressure (float) –

  The chamber pressure in [pascal].

pressure class-attribute instance-attribute

pressure: float = double_field(1)

The chamber pressure in [pascal].

VacuumServiceGetVacuumModeRequest dataclass

VacuumServiceGetVacuumModeRequest()

Bases: Message

The VacuumServiceGetVacuumModeRequest class.

VacuumServiceGetVacuumModeResponse dataclass

VacuumServiceGetVacuumModeResponse(mode: VacuumMode = betterproto.enum_field(1))

Bases: Message

VacuumMode enum response.

Attributes:

• mode (VacuumMode) –

  The vacuum mode.

mode class-attribute instance-attribute

mode: VacuumMode = enum_field(1)

The vacuum mode.

VacuumServiceGetVacuumStateRequest dataclass

VacuumServiceGetVacuumStateRequest()

Bases: Message

The VacuumServiceGetVacuumStateRequest class.

VacuumServiceGetVacuumStateResponse dataclass

VacuumServiceGetVacuumStateResponse(state: VacuumState = betterproto.enum_field(1))

Bases: Message

VacuumState enum response.

Attributes:

• state (VacuumState) –

  The vacuum state.

state class-attribute instance-attribute

state: VacuumState = enum_field(1)

The vacuum state.

VacuumServiceGetValveStateRequest dataclass

VacuumServiceGetValveStateRequest(valve: Valve = betterproto.enum_field(1))

Bases: Message

The VacuumServiceGetValveStateRequest class.

Attributes:

• valve (Valve) –

  The valve to get the status of.

valve class-attribute instance-attribute

valve: Valve = enum_field(1)

The valve to get the status of.

VacuumServiceGetValveStateResponse dataclass

VacuumServiceGetValveStateResponse(valve: Valve = betterproto.enum_field(1), state: ValveState = betterproto.enum_field(2))

Bases: Message

ValveState enum response.

Attributes:

• valve (Valve) –

  The valve identifier.

• state (ValveState) –

  The valves state.

valve class-attribute instance-attribute

valve: Valve = enum_field(1)

The valve identifier.

state class-attribute instance-attribute

state: ValveState = enum_field(2)

The valves state.

VacuumServiceOpenValveRequest dataclass

VacuumServiceOpenValveRequest(valve: Valve = betterproto.enum_field(1))

Bases: Message

The VacuumServiceOpenValveRequest class.

Attributes:

• valve (Valve) –

  The valve identifier of the valve to open.

valve class-attribute instance-attribute

valve: Valve = enum_field(1)

The valve identifier of the valve to open.

VacuumServiceOpenValveResponse dataclass

VacuumServiceOpenValveResponse(task_success: bool = betterproto.bool_field(1))

Bases: Message

Response object of ZenApi.EM.Hardware.V1.IVacuumApi.OpenValve(ZenApi.EM.Hardware.V1.Valve,System.Threading.CancellationToken) method.

Attributes:

• task_success (bool) –

  A value indicating whether the task to open a valve succeeded or not.

task_success class-attribute instance-attribute

task_success: bool = bool_field(1)

A value indicating whether the task to open a valve succeeded or not.

VacuumServicePumpRequest dataclass

VacuumServicePumpRequest()

Bases: Message

The VacuumServicePumpRequest class.

VacuumServicePumpResponse dataclass

VacuumServicePumpResponse(task_success: bool = betterproto.bool_field(1))

Bases: Message

Response object of the ZenApi.EM.Hardware.V1.IVacuumApi.Pump(System.Threading.CancellationToken) method.

Attributes:

• task_success (bool) –

  A value indicating whether the task to pump the chamber succeeded or not.

task_success class-attribute instance-attribute

task_success: bool = bool_field(1)

A value indicating whether the task to pump the chamber succeeded or not.

VacuumServiceRegisterOnChamberPressureChangedRequest dataclass

VacuumServiceRegisterOnChamberPressureChangedRequest()

Bases: Message

The VacuumServiceRegisterOnChamberPressureChangedRequest class.

VacuumServiceRegisterOnChamberPressureChangedResponse dataclass

VacuumServiceRegisterOnChamberPressureChangedResponse(pressure: float = betterproto.double_field(1))

Bases: Message

Response to represent the chamber pressure.

Attributes:

• pressure (float) –

  The chamber pressure in [pascal].

pressure class-attribute instance-attribute

pressure: float = double_field(1)

The chamber pressure in [pascal].

VacuumServiceRegisterOnTargetChamberPressureChangedRequest dataclass

VacuumServiceRegisterOnTargetChamberPressureChangedRequest()

Bases: Message

The VacuumServiceRegisterOnTargetChamberPressureChangedRequest class.

VacuumServiceRegisterOnTargetChamberPressureChangedResponse dataclass

VacuumServiceRegisterOnTargetChamberPressureChangedResponse(pressure: float = betterproto.double_field(1))

Bases: Message

Response to represent the chamber pressure.

Attributes:

• pressure (float) –

  The chamber pressure in [pascal].

pressure class-attribute instance-attribute

pressure: float = double_field(1)

The chamber pressure in [pascal].

VacuumServiceRegisterOnVacuumModeChangedRequest dataclass

VacuumServiceRegisterOnVacuumModeChangedRequest()

Bases: Message

The VacuumServiceRegisterOnVacuumModeChangedRequest class.

VacuumServiceRegisterOnVacuumModeChangedResponse dataclass

VacuumServiceRegisterOnVacuumModeChangedResponse(mode: VacuumMode = betterproto.enum_field(1))

Bases: Message

VacuumMode enum response.

Attributes:

• mode (VacuumMode) –

  The vacuum mode.

mode class-attribute instance-attribute

mode: VacuumMode = enum_field(1)

The vacuum mode.

VacuumServiceRegisterOnVacuumStateChangedRequest dataclass

VacuumServiceRegisterOnVacuumStateChangedRequest()

Bases: Message

The VacuumServiceRegisterOnVacuumStateChangedRequest class.

VacuumServiceRegisterOnVacuumStateChangedResponse dataclass

VacuumServiceRegisterOnVacuumStateChangedResponse(state: VacuumState = betterproto.enum_field(1))

Bases: Message

VacuumState enum response.

Attributes:

• state (VacuumState) –

  The vacuum state.

state class-attribute instance-attribute

state: VacuumState = enum_field(1)

The vacuum state.

VacuumServiceRegisterOnValveStateChangedRequest dataclass

VacuumServiceRegisterOnValveStateChangedRequest()

Bases: Message

The VacuumServiceRegisterOnValveStateChangedRequest class.

VacuumServiceRegisterOnValveStateChangedResponse dataclass

VacuumServiceRegisterOnValveStateChangedResponse(valve: Valve = betterproto.enum_field(1), state: ValveState = betterproto.enum_field(2))

Bases: Message

ValveState enum response.

Attributes:

• valve (Valve) –

  The valve identifier.

• state (ValveState) –

  The valves state.

valve class-attribute instance-attribute

valve: Valve = enum_field(1)

The valve identifier.

state class-attribute instance-attribute

state: ValveState = enum_field(2)

The valves state.

VacuumServiceSetTargetChamberPressureRequest dataclass

VacuumServiceSetTargetChamberPressureRequest(target_pressure: float = betterproto.double_field(1))

Bases: Message

The VacuumServiceSetTargetChamberPressureRequest class.

Attributes:

• target_pressure (float) –

  The target chamber pressure if in ZenApi.EM.Hardware.V1.VacuumMode.VariablePressure mode in [pascal].

target_pressure class-attribute instance-attribute

target_pressure: float = double_field(1)

The target chamber pressure if in ZenApi.EM.Hardware.V1.VacuumMode.VariablePressure mode in [pascal].

VacuumServiceSetTargetChamberPressureResponse dataclass

VacuumServiceSetTargetChamberPressureResponse(task_success: bool = betterproto.bool_field(1))

Bases: Message

Response object of the ZenApi.EM.Hardware.V1.IVacuumApi.SetTargetChamberPressure(System.Double,System.Threading.CancellationToken) method.

Attributes:

• task_success (bool) –

  A value indicating whether the task to set the chamber pressure succeeded or not.

task_success class-attribute instance-attribute

task_success: bool = bool_field(1)

A value indicating whether the task to set the chamber pressure succeeded or not.

VacuumServiceSetVacuumModeRequest dataclass

VacuumServiceSetVacuumModeRequest(mode: VacuumMode = betterproto.enum_field(1))

Bases: Message

The VacuumServiceSetVacuumModeRequest class.

Attributes:

• mode (VacuumMode) –

  The ZenApi.EM.Hardware.V1.VacuumMode to apply.

mode class-attribute instance-attribute

mode: VacuumMode = enum_field(1)

The ZenApi.EM.Hardware.V1.VacuumMode to apply.

VacuumServiceSetVacuumModeResponse dataclass

VacuumServiceSetVacuumModeResponse(task_success: bool = betterproto.bool_field(1))

Bases: Message

Response object of the ZenApi.EM.Hardware.V1.IVacuumApi.SetVacuumMode(ZenApi.EM.Hardware.V1.VacuumMode,System.Threading.CancellationToken) method.

Attributes:

• task_success (bool) –

  A value indicating whether the task to set the vacuum mode succeeded or not.

task_success class-attribute instance-attribute

task_success: bool = bool_field(1)

A value indicating whether the task to set the vacuum mode succeeded or not.

VacuumServiceVentRequest dataclass

VacuumServiceVentRequest()

Bases: Message

The VacuumServiceVentRequest class.

VacuumServiceVentResponse dataclass

VacuumServiceVentResponse(task_success: bool = betterproto.bool_field(1))

Bases: Message

Response object of ZenApi.EM.Hardware.V1.IVacuumApi.Vent(System.Threading.CancellationToken) method.

Attributes:

• task_success (bool) –

  A value indicating whether the task to vent the chamber succeeded or not.

task_success class-attribute instance-attribute

task_success: bool = bool_field(1)

A value indicating whether the task to vent the chamber succeeded or not.