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 –
• StageBacklashMode –

  Stage backlash mode enumeration.

• 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.

• AcquisitionServiceGetExternalScanSourceRequest –

  The AcquisitionServiceGetExternalScanSourceRequest class.

• AcquisitionServiceGetExternalScanSourceResponse –

  Response object representing the external scan source identifier.

• AcquisitionServiceSetExternalScanSourceRequest –

  The AcquisitionServiceSetExternalScanSourceRequest class.

• AcquisitionServiceSetExternalScanSourceResponse –

  Response object representing the external scan source identifier after setting.

• 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.

• ElectronColumnServiceGetApertureAlignRequest –

  The ElectronColumnServiceGetApertureAlignRequest class.

• ElectronColumnServiceGetApertureAlignResponse –

  Response object describing the aperture align values.

• ElectronColumnServiceGetBeamBlankerStateRequest –

  The ElectronColumnServiceGetBeamBlankerStateRequest class.

• ElectronColumnServiceGetBeamBlankerStateResponse –

  Response object representing the beam blanker.

• ElectronColumnServiceGetBeamShiftLimitsRequest –

  The ElectronColumnServiceGetBeamShiftLimitsRequest class.

• ElectronColumnServiceGetBeamShiftLimitsResponse –

  Response object representing the beam shift limits.

• ElectronColumnServiceGetBeamShiftRequest –

  The ElectronColumnServiceGetBeamShiftRequest class.

• ElectronColumnServiceGetBeamShiftResponse –

  Response object describing the beam shift values.

• ElectronColumnServiceGetBeamStateRequest –

  The ElectronColumnServiceGetBeamStateRequest class.

• ElectronColumnServiceGetBeamStateResponse –

  BeamState enum wrapper.

• ElectronColumnServiceGetBoosterVoltageRequest –

  The ElectronColumnServiceGetBoosterVoltageRequest class.

• ElectronColumnServiceGetBoosterVoltageResponse –

  Response object representing the booster voltage.

• ElectronColumnServiceGetEhtOffsetLimitsRequest –

  The ElectronColumnServiceGetEhtOffsetLimitsRequest class.

• ElectronColumnServiceGetEhtOffsetLimitsResponse –

  Response object representing the eht offset response.

• ElectronColumnServiceGetEhtOffsetRequest –

  The ElectronColumnServiceGetEhtOffsetRequest class.

• ElectronColumnServiceGetEhtOffsetResponse –

  Response object representing the eht offset.

• ElectronColumnServiceGetFocusLimitsRequest –

  The ElectronColumnServiceGetFocusLimitsRequest class.

• ElectronColumnServiceGetFocusLimitsResponse –

  Response object representing the column focus.

• ElectronColumnServiceGetFocusRequest –

  The ElectronColumnServiceGetFocusRequest class.

• ElectronColumnServiceGetFocusResponse –

  Response object representing the column focus.

• ElectronColumnServiceGetFovLimitsRequest –

  The ElectronColumnServiceGetFovLimitsRequest class.

• ElectronColumnServiceGetFovLimitsResponse –

  Response object representing the field of view limits.

• ElectronColumnServiceGetFovRequest –

  The ElectronColumnServiceGetFovRequest class.

• ElectronColumnServiceGetFovResponse –

  Response object representing the field of view expansion.

• ElectronColumnServiceGetFovRotationLimitsRequest –

  The ElectronColumnServiceGetFovRotationLimitsRequest class.

• ElectronColumnServiceGetFovRotationLimitsResponse –

  Response object representing the field of view rotation limits.

• ElectronColumnServiceGetFovRotationRequest –

  The ElectronColumnServiceGetFovRotationRequest class.

• ElectronColumnServiceGetFovRotationResponse –

  Response object representing the field of view rotation.

• ElectronColumnServiceGetObjectiveCurrentRequest –

  The ElectronColumnServiceGetObjectiveCurrentRequest class.

• ElectronColumnServiceGetObjectiveCurrentResponse –

  Response object representing the objective current.

• 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.

• ElectronColumnServiceGetVoltageLimitsRequest –

  The ElectronColumnServiceGetVoltageLimitsRequest class.

• ElectronColumnServiceGetVoltageLimitsResponse –

  Response object representing the voltage limits.

• ElectronColumnServiceGoToStandbyRequest –

  The ElectronColumnServiceGoToStandbyRequest class.

• ElectronColumnServiceGoToStandbyResponse –

  BeamState enum wrapper.

• ElectronColumnServiceRegisterOnApertureAlignChangedRequest –

  The ElectronColumnServiceRegisterOnApertureAlignChangedRequest class.

• ElectronColumnServiceRegisterOnApertureAlignChangedResponse –

  Response object describing the aperture align values.

• ElectronColumnServiceRegisterOnBeamBlankerStateChangedRequest –

  The ElectronColumnServiceRegisterOnBeamBlankerStateChangedRequest class.

• ElectronColumnServiceRegisterOnBeamBlankerStateChangedResponse –

  Response object representing the beam blanker.

• 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.

• ElectronColumnServiceSetApertureAlignRequest –

  The ElectronColumnServiceSetApertureAlignRequest class.

• ElectronColumnServiceSetApertureAlignResponse –

  Response object describing the aperture align values.

• ElectronColumnServiceSetBeamBlankerStateRequest –

  The ElectronColumnServiceSetBeamBlankerStateRequest class.

• ElectronColumnServiceSetBeamBlankerStateResponse –

  Response object representing the electron column beam blanker.

• ElectronColumnServiceSetBeamShiftRequest –

  The ElectronColumnServiceSetBeamShiftRequest class.

• ElectronColumnServiceSetBeamShiftResponse –

  Response object describing the beam shift values.

• ElectronColumnServiceSetEhtOffsetRequest –

  The ElectronColumnServiceSetEhtOffsetRequest class.

• ElectronColumnServiceSetEhtOffsetResponse –

  Response object representing the eht offset response.

• 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.

• ElectronColumnServiceSetObjectiveCurrentRequest –

  The ElectronColumnServiceSetObjectiveCurrentRequest class.

• ElectronColumnServiceSetObjectiveCurrentResponse –

  Response object representing the objective current response.

• ElectronColumnServiceSetProbeCurrentRequest –

  The ElectronColumnServiceSetProbeCurrentRequest class.

• ElectronColumnServiceSetProbeCurrentResponse –

  Response object representing the probe current.

• 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.

• EmStageServiceGetAxisBacklashModeRequest –

  The EmStageServiceGetAxisBacklashModeRequest class.

• EmStageServiceGetAxisLimitsRequest –

  The EmStageServiceGetAxisLimitsRequest class.

• EmStageServiceGetAxisUserLimitsRequest –

  The EmStageServiceGetAxisUserLimitsRequest class.

• EmStageServiceGetAxisVelocityLimitsRequest –

  The EmStageServiceGetAxisVelocityLimitsRequest class.

• EmStageServiceGetStageBacklashModesRequest –

  The EmStageServiceGetStageBacklashModesRequest class.

• EmStageServiceGetStageFastRequest –

  The EmStageServiceGetStageFastRequest class.

• EmStageServiceGetStageLimitsRequest –

  The EmStageServiceGetStageLimitsRequest class.

• EmStageServiceGetStageUserLimitsRequest –

  The EmStageServiceGetStageUserLimitsRequest class.

• EmStageServiceGetStageVelocityLimitsRequest –

  The EmStageServiceGetStageVelocityLimitsRequest class.

• EmStageServiceSetAxisBacklashModeRequest –

  The EmStageServiceSetAxisBacklashModeRequest class.

• EmStageServiceSetAxisUserLimitsRequest –

  The EmStageServiceSetAxisUserLimitsRequest class.

• EmStageServiceSetAxisVelocityRequest –

  The EmStageServiceSetAxisVelocityRequest class.

• EmStageServiceSetStageBacklashModesRequest –

  The EmStageServiceSetStageBacklashModesRequest class.

• EmStageServiceSetStageFastRequest –

  The EmStageServiceSetStageFastRequest class.

• EmStageServiceSetStageUserLimitsRequest –

  The EmStageServiceSetStageUserLimitsRequest class.

• StageServiceAxisBacklashModeResponse –

  Request object for setting axis backlash mode.

• StageServiceAxisUserLimitsResponse –

  Request object for setting axis soft limits.

• StageServiceGetAxisBacklashModeResponse –

  Response object for axis backlash mode.

• StageServiceGetAxisLimitsResponse –

  Response object for axis position limits.

• StageServiceGetAxisUserLimitsResponse –

  Response object for axis soft limits.

• StageServiceGetAxisVelocityLimitsResponse –

  Response object for axis velocity limits.

• StageServiceGetStageBacklashModesResponse –

  Response object for stage backlash modes.

• StageServiceGetStageFastResponse –

  Response object representing the column focus.

• StageServiceGetStageLimitsResponse –

  Response object for stage position limits.

• StageServiceGetStageUserLimitsResponse –

  Response object for stage soft limits.

• StageServiceGetStageVelocityLimitsResponse –

  Response object for stage velocity limits.

• StageServiceSetAxisBacklashModeResponse –

  Response object for setting axis backlash mode.

• StageServiceSetAxisUserLimitsResponse –

  Response object for setting axis soft limits.

• StageServiceSetAxisVelocityResponse –

  Response object for setting axis velocity.

• StageServiceSetStageBacklashModesResponse –

  Response object for setting stage backlash modes.

• StageServiceSetStageFastResponse –

  Response object representing the column focus.

• StageServiceSetStageUserLimitsResponse –

  Response object for setting stage user limits.

• 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.

• SimpleAcquisitionServiceChangeDwellTimeRequest –

  The SimpleAcquisitionServiceChangeDwellTimeRequest class.

• SimpleAcquisitionServiceChangeDwellTimeResponse –

  Response object representing the current acquisition status.

• 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.

• SpecimenCurrentMonitorServiceGetSpecimenCurrentRequest –

  The SpecimenCurrentMonitorServiceGetSpecimenCurrentRequest class.

• SpecimenCurrentMonitorServiceGetSpecimenCurrentResponse –

  Response object for specimen current.

• SpecimenCurrentMonitorServiceRegisterOnSpecimenCurrentChangedRequest –

  The SpecimenCurrentMonitorServiceRegisterOnSpecimenCurrentChangedRequest class.

• SpecimenCurrentMonitorServiceRegisterOnSpecimenCurrentChangedResponse –

  Response object for specimen current changed notification.

• 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.

• AcquisitionServiceStub –
• CameraServiceStub –
• DetectorServiceStub –
• ElectronColumnServiceStub –
• EmStageServiceStub –
• ExternalProcedureServiceStub –
• IlluminationServiceStub –
• SimpleAcquisitionServiceStub –
• SpecimenCurrentMonitorServiceStub –
• VacuumServiceStub –
• AcquisitionServiceBase –
• CameraServiceBase –
• DetectorServiceBase –
• ElectronColumnServiceBase –
• EmStageServiceBase –
• ExternalProcedureServiceBase –
• IlluminationServiceBase –
• SimpleAcquisitionServiceBase –
• SpecimenCurrentMonitorServiceBase –
• VacuumServiceBase –

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 .

StageBacklashMode

Bases: Enum

Stage backlash mode enumeration.

Attributes:

• UNSPECIFIED –

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

• DISABLED –

  Stage backlash is disabled.

• POSITIVE –

  Stage backlash is enabled in the positive direction.

• NEGATIVE –

  Stage backlash is enabled in the negative direction.

• BOTH_DIRECTIONS_POSITIVE –

  Stage backlash is positive in both positive and negative directions.

• BOTH_DIRECTIONS_NEGATIVE –

  Stage backlash is negative in both directions.

UNSPECIFIED class-attribute instance-attribute

UNSPECIFIED = 0

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

DISABLED class-attribute instance-attribute

DISABLED = 1

Stage backlash is disabled.

POSITIVE class-attribute instance-attribute

POSITIVE = 2

Stage backlash is enabled in the positive direction.

NEGATIVE class-attribute instance-attribute

NEGATIVE = 3

Stage backlash is enabled in the negative direction.

BOTH_DIRECTIONS_POSITIVE class-attribute instance-attribute

BOTH_DIRECTIONS_POSITIVE = 4

Stage backlash is positive in both positive and negative directions.

BOTH_DIRECTIONS_NEGATIVE class-attribute instance-attribute

BOTH_DIRECTIONS_NEGATIVE = 5

Stage backlash is negative in both directions.

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.

AcquisitionServiceGetExternalScanSourceRequest dataclass

AcquisitionServiceGetExternalScanSourceRequest()

Bases: Message

The AcquisitionServiceGetExternalScanSourceRequest class.

AcquisitionServiceGetExternalScanSourceResponse dataclass

AcquisitionServiceGetExternalScanSourceResponse(source: int = betterproto.int64_field(1))

Bases: Message

Response object representing the external scan source identifier.

Attributes:

• source (int) –

  The external scan source identifier.

source class-attribute instance-attribute

source: int = betterproto.int64_field(1)

The external scan source identifier.

AcquisitionServiceSetExternalScanSourceRequest dataclass

AcquisitionServiceSetExternalScanSourceRequest(source: int = betterproto.int64_field(1))

Bases: Message

The AcquisitionServiceSetExternalScanSourceRequest class.

Attributes:

• source (int) –

  The external scan source identifier.

source class-attribute instance-attribute

source: int = betterproto.int64_field(1)

The external scan source identifier. Source = 0: Internal scan control Source = 1, 2, 3, 4: External scan configuration

AcquisitionServiceSetExternalScanSourceResponse dataclass

AcquisitionServiceSetExternalScanSourceResponse(source: int = betterproto.int64_field(1), success: bool = betterproto.bool_field(2))

Bases: Message

Response object representing the external scan source identifier after setting.

Attributes:

• source (int) –

  The external scan source identifier.

• success (bool) –

  A value indicating whether the operation succeeded.

source class-attribute instance-attribute

source: int = betterproto.int64_field(1)

The external scan source identifier.

success class-attribute instance-attribute

success: bool = betterproto.bool_field(2)

A value indicating whether the operation succeeded.

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 = betterproto.string_field(1)

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

width class-attribute instance-attribute

width: int = betterproto.int32_field(2)

The image width in pixels.

height class-attribute instance-attribute

height: int = betterproto.int32_field(3)

The image height in pixels.

dwell_time class-attribute instance-attribute

dwell_time: float = betterproto.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 = betterproto.int32_field(5)

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

line_averages class-attribute instance-attribute

line_averages: int = betterproto.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 = betterproto.string_field(1)

The camera to use.

width class-attribute instance-attribute

width: int = betterproto.int32_field(2)

The image width in pixels.

height class-attribute instance-attribute

height: int = betterproto.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 = betterproto.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 = betterproto.enum_field(1)

The acquisition status.

message class-attribute instance-attribute

message: str = betterproto.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] = betterproto.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 = betterproto.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 = betterproto.double_field(1)

The brightness.

message class-attribute instance-attribute

message: str = betterproto.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 = betterproto.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 = betterproto.enum_field(1)

The CCD mode.

message class-attribute instance-attribute

message: str = betterproto.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 = betterproto.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 = betterproto.double_field(1)

The contrast.

message class-attribute instance-attribute

message: str = betterproto.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 = betterproto.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 = betterproto.enum_field(1)

The acquisition status.

message class-attribute instance-attribute

message: str = betterproto.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 = betterproto.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 = betterproto.double_field(1)

The brightness.

message class-attribute instance-attribute

message: str = betterproto.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 = betterproto.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 = betterproto.enum_field(1)

The CCD mode.

message class-attribute instance-attribute

message: str = betterproto.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 = betterproto.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 = betterproto.double_field(1)

The contrast.

message class-attribute instance-attribute

message: str = betterproto.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 = betterproto.string_field(1)

The camera ID.

brightness class-attribute instance-attribute

brightness: float = betterproto.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 = betterproto.double_field(1)

The brightness.

success class-attribute instance-attribute

success: bool = betterproto.bool_field(2)

A value indicating whether setting the brightness was successful.

message class-attribute instance-attribute

message: str = betterproto.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 = betterproto.string_field(1)

The camera ID.

mode class-attribute instance-attribute

mode: CcdMode = betterproto.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 = betterproto.enum_field(1)

The CCD mode.

success class-attribute instance-attribute

success: bool = betterproto.bool_field(2)

A value indicating whether setting the CCD mode was successful.

message class-attribute instance-attribute

message: str = betterproto.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 = betterproto.string_field(1)

The camera ID.

contrast class-attribute instance-attribute

contrast: float = betterproto.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 = betterproto.double_field(1)

The contrast.

success class-attribute instance-attribute

success: bool = betterproto.bool_field(2)

A value indicating whether setting the contrast was successful.

message class-attribute instance-attribute

message: str = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.bool_field(1)

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

message class-attribute instance-attribute

message: str = betterproto.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] = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.double_field(1)

The eht/voltage in volts.

ElectronColumnServiceGetApertureAlignRequest dataclass

ElectronColumnServiceGetApertureAlignRequest()

Bases: Message

The ElectronColumnServiceGetApertureAlignRequest class.

ElectronColumnServiceGetApertureAlignResponse dataclass

ElectronColumnServiceGetApertureAlignResponse(x: float = betterproto.double_field(1), y: float = betterproto.double_field(2))

Bases: Message

Response object describing the aperture align values.

Attributes:

• x (float) –

  The x aperture align in percentage.

• y (float) –

  The y aperture align in percentage.

x class-attribute instance-attribute

x: float = betterproto.double_field(1)

The x aperture align in percentage.

y class-attribute instance-attribute

y: float = betterproto.double_field(2)

The y aperture align in percentage.

ElectronColumnServiceGetBeamBlankerStateRequest dataclass

ElectronColumnServiceGetBeamBlankerStateRequest()

Bases: Message

The ElectronColumnServiceGetBeamBlankerStateRequest class.

ElectronColumnServiceGetBeamBlankerStateResponse dataclass

ElectronColumnServiceGetBeamBlankerStateResponse(is_beam_blanked: bool = betterproto.bool_field(1))

Bases: Message

Response object representing the beam blanker.

Attributes:

• is_beam_blanked (bool) –

  A value indicating whether the beam is blanked.

is_beam_blanked class-attribute instance-attribute

is_beam_blanked: bool = betterproto.bool_field(1)

A value indicating whether the beam is blanked.

ElectronColumnServiceGetBeamShiftLimitsRequest dataclass

ElectronColumnServiceGetBeamShiftLimitsRequest()

Bases: Message

The ElectronColumnServiceGetBeamShiftLimitsRequest class.

ElectronColumnServiceGetBeamShiftLimitsResponse dataclass

ElectronColumnServiceGetBeamShiftLimitsResponse(beam_shift_xmin: float = betterproto.double_field(1), beam_shift_xmax: float = betterproto.double_field(2), beam_shift_ymin: float = betterproto.double_field(3), beam_shift_ymax: float = betterproto.double_field(4))

Bases: Message

Response object representing the beam shift limits.

Attributes:

• beam_shift_xmin (float) –

  The minimum beam shift X in meters.

• beam_shift_xmax (float) –

  The maximum beam shift X in meters.

• beam_shift_ymin (float) –

  The minimum beam shift Y in meters.

• beam_shift_ymax (float) –

  The maximum beam shift Y in meters.

beam_shift_xmin class-attribute instance-attribute

beam_shift_xmin: float = betterproto.double_field(1)

The minimum beam shift X in meters.

beam_shift_xmax class-attribute instance-attribute

beam_shift_xmax: float = betterproto.double_field(2)

The maximum beam shift X in meters.

beam_shift_ymin class-attribute instance-attribute

beam_shift_ymin: float = betterproto.double_field(3)

The minimum beam shift Y in meters.

beam_shift_ymax class-attribute instance-attribute

beam_shift_ymax: float = betterproto.double_field(4)

The maximum beam shift Y in meters.

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 = betterproto.double_field(1)

The x beam shift in meters.

shift_y class-attribute instance-attribute

shift_y: float = betterproto.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 = betterproto.enum_field(1)

The beam state.

task_success class-attribute instance-attribute

task_success: bool = betterproto.bool_field(2)

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

ElectronColumnServiceGetBoosterVoltageRequest dataclass

ElectronColumnServiceGetBoosterVoltageRequest()

Bases: Message

The ElectronColumnServiceGetBoosterVoltageRequest class.

ElectronColumnServiceGetBoosterVoltageResponse dataclass

ElectronColumnServiceGetBoosterVoltageResponse(booster_voltage: float = betterproto.double_field(1), success: bool = betterproto.bool_field(2))

Bases: Message

Response object representing the booster voltage.

Attributes:

• booster_voltage (float) –

  The booster voltage in volts.

• success (bool) –

  A value indicating whether getting the booster voltage was successful.

booster_voltage class-attribute instance-attribute

booster_voltage: float = betterproto.double_field(1)

The booster voltage in volts.

success class-attribute instance-attribute

success: bool = betterproto.bool_field(2)

A value indicating whether getting the booster voltage was successful.

ElectronColumnServiceGetEhtOffsetLimitsRequest dataclass

ElectronColumnServiceGetEhtOffsetLimitsRequest()

Bases: Message

The ElectronColumnServiceGetEhtOffsetLimitsRequest class.

ElectronColumnServiceGetEhtOffsetLimitsResponse dataclass

ElectronColumnServiceGetEhtOffsetLimitsResponse(minimum: float = betterproto.double_field(1), maximum: float = betterproto.double_field(2), success: bool = betterproto.bool_field(3))

Bases: Message

Response object representing the eht offset response.

Attributes:

• minimum (float) –

  The minimum eht offset in volts.

• maximum (float) –

  The maximum eht offset in volts.

• success (bool) –

  A value indicating whether geetting the eht offset limits was successful.

minimum class-attribute instance-attribute

minimum: float = betterproto.double_field(1)

The minimum eht offset in volts.

maximum class-attribute instance-attribute

maximum: float = betterproto.double_field(2)

The maximum eht offset in volts.

success class-attribute instance-attribute

success: bool = betterproto.bool_field(3)

A value indicating whether geetting the eht offset limits was successful.

ElectronColumnServiceGetEhtOffsetRequest dataclass

ElectronColumnServiceGetEhtOffsetRequest()

Bases: Message

The ElectronColumnServiceGetEhtOffsetRequest class.

ElectronColumnServiceGetEhtOffsetResponse dataclass

ElectronColumnServiceGetEhtOffsetResponse(eht_offset: float = betterproto.double_field(1), success: bool = betterproto.bool_field(2))

Bases: Message

Response object representing the eht offset.

Attributes:

• eht_offset (float) –

  The eht offset in volts.

• success (bool) –

  A value indicating whether gets or sets of the eht offset was successful.

eht_offset class-attribute instance-attribute

eht_offset: float = betterproto.double_field(1)

The eht offset in volts.

success class-attribute instance-attribute

success: bool = betterproto.bool_field(2)

A value indicating whether gets or sets of the eht offset was successful.

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 = betterproto.double_field(1)

The minimum focus in meters.

focus_max class-attribute instance-attribute

focus_max: float = betterproto.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 = betterproto.double_field(1)

The focus in meters.

ElectronColumnServiceGetFovLimitsRequest dataclass

ElectronColumnServiceGetFovLimitsRequest()

Bases: Message

The ElectronColumnServiceGetFovLimitsRequest class.

ElectronColumnServiceGetFovLimitsResponse dataclass

ElectronColumnServiceGetFovLimitsResponse(minimum: float = betterproto.double_field(1), maximum: float = betterproto.double_field(2))

Bases: Message

Response object representing the field of view limits.

Attributes:

• minimum (float) –

  The minimum field of view in meters.

• maximum (float) –

  The maximum field of view in meters.

minimum class-attribute instance-attribute

minimum: float = betterproto.double_field(1)

The minimum field of view in meters.

maximum class-attribute instance-attribute

maximum: float = betterproto.double_field(2)

The maximum field of view 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 = betterproto.double_field(1)

The fov expansion in meters.

ElectronColumnServiceGetFovRotationLimitsRequest dataclass

ElectronColumnServiceGetFovRotationLimitsRequest()

Bases: Message

The ElectronColumnServiceGetFovRotationLimitsRequest class.

ElectronColumnServiceGetFovRotationLimitsResponse dataclass

ElectronColumnServiceGetFovRotationLimitsResponse(minimum: float = betterproto.double_field(1), maximum: float = betterproto.double_field(2))

Bases: Message

Response object representing the field of view rotation limits.

Attributes:

• minimum (float) –

  The minimum field of view rotation in radians.

• maximum (float) –

  The maximum field of view rotation in radians.

minimum class-attribute instance-attribute

minimum: float = betterproto.double_field(1)

The minimum field of view rotation in radians.

maximum class-attribute instance-attribute

maximum: float = betterproto.double_field(2)

The maximum field of view rotation in radians.

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 = betterproto.double_field(1)

The field of view rotation in radians.

ElectronColumnServiceGetObjectiveCurrentRequest dataclass

ElectronColumnServiceGetObjectiveCurrentRequest()

Bases: Message

The ElectronColumnServiceGetObjectiveCurrentRequest class.

ElectronColumnServiceGetObjectiveCurrentResponse dataclass

ElectronColumnServiceGetObjectiveCurrentResponse(objective_current: float = betterproto.double_field(1), success: bool = betterproto.bool_field(2))

Bases: Message

Response object representing the objective current.

Attributes:

• objective_current (float) –

  The objective current in amperes.

• success (bool) –

  A value indicating whether getting the objective current was successful.

objective_current class-attribute instance-attribute

objective_current: float = betterproto.double_field(1)

The objective current in amperes.

success class-attribute instance-attribute

success: bool = betterproto.bool_field(2)

A value indicating whether getting the objective current was successful.

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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.double_field(1)

The stigmator x in percent [0,1].

stigmator_y class-attribute instance-attribute

stigmator_y: float = betterproto.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 = betterproto.double_field(1)

The eht/voltage in volts.

ElectronColumnServiceGetVoltageLimitsRequest dataclass

ElectronColumnServiceGetVoltageLimitsRequest()

Bases: Message

The ElectronColumnServiceGetVoltageLimitsRequest class.

ElectronColumnServiceGetVoltageLimitsResponse dataclass

ElectronColumnServiceGetVoltageLimitsResponse(minimum: float = betterproto.double_field(1), maximum: float = betterproto.double_field(2))

Bases: Message

Response object representing the voltage limits.

Attributes:

• minimum (float) –

  The minimum voltage in volts.

• maximum (float) –

  The maximum voltage in volts.

minimum class-attribute instance-attribute

minimum: float = betterproto.double_field(1)

The minimum voltage in volts.

maximum class-attribute instance-attribute

maximum: float = betterproto.double_field(2)

The maximum 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 = betterproto.enum_field(1)

The beam state.

task_success class-attribute instance-attribute

task_success: bool = betterproto.bool_field(2)

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

ElectronColumnServiceRegisterOnApertureAlignChangedRequest dataclass

ElectronColumnServiceRegisterOnApertureAlignChangedRequest()

Bases: Message

The ElectronColumnServiceRegisterOnApertureAlignChangedRequest class.

ElectronColumnServiceRegisterOnApertureAlignChangedResponse dataclass

ElectronColumnServiceRegisterOnApertureAlignChangedResponse(x: float = betterproto.double_field(1), y: float = betterproto.double_field(2))

Bases: Message

Response object describing the aperture align values.

Attributes:

• x (float) –

  The x aperture align in percentage.

• y (float) –

  The y aperture align in percentage.

x class-attribute instance-attribute

x: float = betterproto.double_field(1)

The x aperture align in percentage.

y class-attribute instance-attribute

y: float = betterproto.double_field(2)

The y aperture align in percentage.

ElectronColumnServiceRegisterOnBeamBlankerStateChangedRequest dataclass

ElectronColumnServiceRegisterOnBeamBlankerStateChangedRequest()

Bases: Message

The ElectronColumnServiceRegisterOnBeamBlankerStateChangedRequest class.

ElectronColumnServiceRegisterOnBeamBlankerStateChangedResponse dataclass

ElectronColumnServiceRegisterOnBeamBlankerStateChangedResponse(is_beam_blanked: bool = betterproto.bool_field(1))

Bases: Message

Response object representing the beam blanker.

Attributes:

• is_beam_blanked (bool) –

  A value indicating whether the beam is blanked.

is_beam_blanked class-attribute instance-attribute

is_beam_blanked: bool = betterproto.bool_field(1)

A value indicating whether the beam is blanked.

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 = betterproto.double_field(1)

The x beam shift in meters.

shift_y class-attribute instance-attribute

shift_y: float = betterproto.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 = betterproto.enum_field(1)

The beam state.

task_success class-attribute instance-attribute

task_success: bool = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.double_field(1)

The stigmator x in percent [0,1].

stigmator_y class-attribute instance-attribute

stigmator_y: float = betterproto.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 = betterproto.double_field(1)

The eht/voltage in volts.

ElectronColumnServiceSetApertureAlignRequest dataclass

ElectronColumnServiceSetApertureAlignRequest(x: Optional[float] = betterproto.message_field(1, wraps=betterproto.TYPE_DOUBLE), y: Optional[float] = betterproto.message_field(2, wraps=betterproto.TYPE_DOUBLE))

Bases: Message

The ElectronColumnServiceSetApertureAlignRequest class.

Attributes:

• x (Optional[float]) –

  The new aperture align x in percentage. null if it should not be changed.

• y (Optional[float]) –

  The new aperture align y in percentage. null if it should not be changed.

x class-attribute instance-attribute

x: Optional[float] = betterproto.message_field(1, wraps=betterproto.TYPE_DOUBLE)

The new aperture align x in percentage. null if it should not be changed.

y class-attribute instance-attribute

y: Optional[float] = betterproto.message_field(2, wraps=betterproto.TYPE_DOUBLE)

The new aperture align y in percentage. null if it should not be changed.

ElectronColumnServiceSetApertureAlignResponse dataclass

ElectronColumnServiceSetApertureAlignResponse(x: float = betterproto.double_field(1), y: float = betterproto.double_field(2), success: bool = betterproto.bool_field(3))

Bases: Message

Response object describing the aperture align values.

Attributes:

• x (float) –

  The x aperture align in percentage.

• y (float) –

  The y aperture align in percentage.

• success (bool) –

  A value indicating whether setting of the aperture alignment was successful.

x class-attribute instance-attribute

x: float = betterproto.double_field(1)

The x aperture align in percentage.

y class-attribute instance-attribute

y: float = betterproto.double_field(2)

The y aperture align in percentage.

success class-attribute instance-attribute

success: bool = betterproto.bool_field(3)

A value indicating whether setting of the aperture alignment was successful.

ElectronColumnServiceSetBeamBlankerStateRequest dataclass

ElectronColumnServiceSetBeamBlankerStateRequest(blank_beam: bool = betterproto.bool_field(1))

Bases: Message

The ElectronColumnServiceSetBeamBlankerStateRequest class.

Attributes:

• blank_beam (bool) –

  True blanks beam, false unblanks beam.

blank_beam class-attribute instance-attribute

blank_beam: bool = betterproto.bool_field(1)

True blanks beam, false unblanks beam.

ElectronColumnServiceSetBeamBlankerStateResponse dataclass

ElectronColumnServiceSetBeamBlankerStateResponse(beam_blanked: bool = betterproto.bool_field(1))

Bases: Message

Response object representing the electron column beam blanker.

Attributes:

• beam_blanked (bool) –

  The beam blanker.

beam_blanked class-attribute instance-attribute

beam_blanked: bool = betterproto.bool_field(1)

The beam blanker.

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] = betterproto.message_field(1, wraps=betterproto.TYPE_DOUBLE)

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

yshift class-attribute instance-attribute

yshift: Optional[float] = betterproto.message_field(2, wraps=betterproto.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 = betterproto.double_field(1)

The x beam shift in meters.

shift_y class-attribute instance-attribute

shift_y: float = betterproto.double_field(2)

The y beam shift in meters.

ElectronColumnServiceSetEhtOffsetRequest dataclass

ElectronColumnServiceSetEhtOffsetRequest(eht_offset: float = betterproto.double_field(1))

Bases: Message

The ElectronColumnServiceSetEhtOffsetRequest class.

Attributes:

• eht_offset (float) –

  The eht offset.

eht_offset class-attribute instance-attribute

eht_offset: float = betterproto.double_field(1)

The eht offset.

ElectronColumnServiceSetEhtOffsetResponse dataclass

ElectronColumnServiceSetEhtOffsetResponse(eht_offset: float = betterproto.double_field(1), success: bool = betterproto.bool_field(2))

Bases: Message

Response object representing the eht offset response.

Attributes:

• eht_offset (float) –

  The eht offset in volts.

• success (bool) –

  A value indicating whether gets or sets of the eht offset was successful.

eht_offset class-attribute instance-attribute

eht_offset: float = betterproto.double_field(1)

The eht offset in volts.

success class-attribute instance-attribute

success: bool = betterproto.bool_field(2)

A value indicating whether gets or sets of the eht offset was successful.

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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.double_field(1)

The field of view rotation in radians.

ElectronColumnServiceSetObjectiveCurrentRequest dataclass

ElectronColumnServiceSetObjectiveCurrentRequest(objective_current: float = betterproto.double_field(1))

Bases: Message

The ElectronColumnServiceSetObjectiveCurrentRequest class.

Attributes:

• objective_current (float) –

  The objective current in amperes.

objective_current class-attribute instance-attribute

objective_current: float = betterproto.double_field(1)

The objective current in amperes.

ElectronColumnServiceSetObjectiveCurrentResponse dataclass

ElectronColumnServiceSetObjectiveCurrentResponse(objective_current: float = betterproto.double_field(1), success: bool = betterproto.bool_field(2))

Bases: Message

Response object representing the objective current response.

Attributes:

• objective_current (float) –

  The ObjectiveCurrent in amperes.

• success (bool) –

  A value indicating whether setting the objective current was successful.

objective_current class-attribute instance-attribute

objective_current: float = betterproto.double_field(1)

The ObjectiveCurrent in amperes.

success class-attribute instance-attribute

success: bool = betterproto.bool_field(2)

A value indicating whether setting the objective current was successful.

ElectronColumnServiceSetProbeCurrentRequest dataclass

ElectronColumnServiceSetProbeCurrentRequest(current_amps: float = betterproto.double_field(1))

Bases: Message

The ElectronColumnServiceSetProbeCurrentRequest class.

Attributes:

• current_amps (float) –

  Probe current in Ampere.

current_amps class-attribute instance-attribute

current_amps: float = betterproto.double_field(1)

Probe current in Ampere.

ElectronColumnServiceSetProbeCurrentResponse dataclass

ElectronColumnServiceSetProbeCurrentResponse(success: bool = betterproto.bool_field(1), probe_current: float = betterproto.double_field(2))

Bases: Message

Response object representing the probe current.

Attributes:

• success (bool) –

  A value indicating whether setting the probe current was successful.

• probe_current (float) –

  The probe current value in Amps.

success class-attribute instance-attribute

success: bool = betterproto.bool_field(1)

A value indicating whether setting the probe current was successful.

probe_current class-attribute instance-attribute

probe_current: float = betterproto.double_field(2)

The probe current value in Amps.

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] = betterproto.message_field(1, wraps=betterproto.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] = betterproto.message_field(2, wraps=betterproto.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 = betterproto.double_field(1)

The stigmator x in percent [0,1].

stigmator_y class-attribute instance-attribute

stigmator_y: float = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.enum_field(1)

The beam state.

task_success class-attribute instance-attribute

task_success: bool = betterproto.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 = betterproto.enum_field(1)

The beam state.

task_success class-attribute instance-attribute

task_success: bool = betterproto.bool_field(2)

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

EmStageServiceGetAxisBacklashModeRequest dataclass

EmStageServiceGetAxisBacklashModeRequest(axis_id: AxisIdentifier = betterproto.enum_field(1))

Bases: Message

The EmStageServiceGetAxisBacklashModeRequest class.

Attributes:

• axis_id (AxisIdentifier) –

  The axis identifier.

axis_id class-attribute instance-attribute

axis_id: AxisIdentifier = betterproto.enum_field(1)

The axis identifier.

EmStageServiceGetAxisLimitsRequest dataclass

EmStageServiceGetAxisLimitsRequest(axis_id: AxisIdentifier = betterproto.enum_field(1))

Bases: Message

The EmStageServiceGetAxisLimitsRequest class.

Attributes:

• axis_id (AxisIdentifier) –

  The axis identifier.

axis_id class-attribute instance-attribute

axis_id: AxisIdentifier = betterproto.enum_field(1)

The axis identifier.

EmStageServiceGetAxisUserLimitsRequest dataclass

EmStageServiceGetAxisUserLimitsRequest(axis_id: AxisIdentifier = betterproto.enum_field(1))

Bases: Message

The EmStageServiceGetAxisUserLimitsRequest class.

Attributes:

• axis_id (AxisIdentifier) –

  The axis identifier.

axis_id class-attribute instance-attribute

axis_id: AxisIdentifier = betterproto.enum_field(1)

The axis identifier.

EmStageServiceGetAxisVelocityLimitsRequest dataclass

EmStageServiceGetAxisVelocityLimitsRequest(axis_id: AxisIdentifier = betterproto.enum_field(1))

Bases: Message

The EmStageServiceGetAxisVelocityLimitsRequest class.

Attributes:

• axis_id (AxisIdentifier) –

  The axis identifier.

axis_id class-attribute instance-attribute

axis_id: AxisIdentifier = betterproto.enum_field(1)

The axis identifier.

EmStageServiceGetStageBacklashModesRequest dataclass

EmStageServiceGetStageBacklashModesRequest()

Bases: Message

The EmStageServiceGetStageBacklashModesRequest class.

EmStageServiceGetStageFastRequest dataclass

EmStageServiceGetStageFastRequest()

Bases: Message

The EmStageServiceGetStageFastRequest class.

EmStageServiceGetStageLimitsRequest dataclass

EmStageServiceGetStageLimitsRequest()

Bases: Message

The EmStageServiceGetStageLimitsRequest class.

EmStageServiceGetStageUserLimitsRequest dataclass

EmStageServiceGetStageUserLimitsRequest()

Bases: Message

The EmStageServiceGetStageUserLimitsRequest class.

EmStageServiceGetStageVelocityLimitsRequest dataclass

EmStageServiceGetStageVelocityLimitsRequest()

Bases: Message

The EmStageServiceGetStageVelocityLimitsRequest class.

EmStageServiceSetAxisBacklashModeRequest dataclass

EmStageServiceSetAxisBacklashModeRequest(axis_id: AxisIdentifier = betterproto.enum_field(1), mode: StageBacklashMode = betterproto.enum_field(2))

Bases: Message

The EmStageServiceSetAxisBacklashModeRequest class.

Attributes:

• axis_id (AxisIdentifier) –

  The axis identifier.

• mode (StageBacklashMode) –

  The backlash mode to set.

axis_id class-attribute instance-attribute

axis_id: AxisIdentifier = betterproto.enum_field(1)

The axis identifier.

mode class-attribute instance-attribute

mode: StageBacklashMode = betterproto.enum_field(2)

The backlash mode to set.

EmStageServiceSetAxisUserLimitsRequest dataclass

EmStageServiceSetAxisUserLimitsRequest(axis_id: AxisIdentifier = betterproto.enum_field(1), lower_limit: float = betterproto.double_field(2), upper_limit: float = betterproto.double_field(3))

Bases: Message

The EmStageServiceSetAxisUserLimitsRequest class.

Attributes:

• axis_id (AxisIdentifier) –

  The axis identifier.

• lower_limit (float) –

  The lower User limit in meters. Range [-1.0 : 1.0 m]

• upper_limit (float) –

  The upper User limit in meters. Range [-1.0 : 1.0 m]

axis_id class-attribute instance-attribute

axis_id: AxisIdentifier = betterproto.enum_field(1)

The axis identifier.

lower_limit class-attribute instance-attribute

lower_limit: float = betterproto.double_field(2)

The lower User limit in meters. Range [-1.0 : 1.0 m]

upper_limit class-attribute instance-attribute

upper_limit: float = betterproto.double_field(3)

The upper User limit in meters. Range [-1.0 : 1.0 m]

EmStageServiceSetAxisVelocityRequest dataclass

EmStageServiceSetAxisVelocityRequest(axis_id: AxisIdentifier = betterproto.enum_field(1), velocity: float = betterproto.double_field(2))

Bases: Message

The EmStageServiceSetAxisVelocityRequest class.

Attributes:

• axis_id (AxisIdentifier) –

  The axis identifier.

• velocity (float) –

  The target velocity in meters per second or radians per second.

axis_id class-attribute instance-attribute

axis_id: AxisIdentifier = betterproto.enum_field(1)

The axis identifier.

velocity class-attribute instance-attribute

velocity: float = betterproto.double_field(2)

The target velocity in meters per second or radians per second.

EmStageServiceSetStageBacklashModesRequest dataclass

EmStageServiceSetStageBacklashModesRequest(axis_backlash_modes: List[StageServiceAxisBacklashModeResponse] = betterproto.message_field(1))

Bases: Message

The EmStageServiceSetStageBacklashModesRequest class.

Attributes:

• axis_backlash_modes (List[StageServiceAxisBacklashModeResponse]) –

  Array of axis backlash modes to set.

axis_backlash_modes class-attribute instance-attribute

axis_backlash_modes: List[StageServiceAxisBacklashModeResponse] = betterproto.message_field(1)

Array of axis backlash modes to set.

EmStageServiceSetStageFastRequest dataclass

EmStageServiceSetStageFastRequest(stage_fast: bool = betterproto.bool_field(1))

Bases: Message

The EmStageServiceSetStageFastRequest class.

Attributes:

• stage_fast (bool) –

  The new stage fast status.

stage_fast class-attribute instance-attribute

stage_fast: bool = betterproto.bool_field(1)

The new stage fast status.

EmStageServiceSetStageUserLimitsRequest dataclass

EmStageServiceSetStageUserLimitsRequest(axis_user_limits: List[StageServiceAxisUserLimitsResponse] = betterproto.message_field(1))

Bases: Message

The EmStageServiceSetStageUserLimitsRequest class.

Attributes:

• axis_user_limits (List[StageServiceAxisUserLimitsResponse]) –

  Array of axis User limits to set.

axis_user_limits class-attribute instance-attribute

axis_user_limits: List[StageServiceAxisUserLimitsResponse] = betterproto.message_field(1)

Array of axis User limits to set.

StageServiceAxisBacklashModeResponse dataclass

StageServiceAxisBacklashModeResponse(axis: AxisIdentifier = betterproto.enum_field(1), mode: StageBacklashMode = betterproto.enum_field(2))

Bases: Message

Request object for setting axis backlash mode.

Attributes:

• axis (AxisIdentifier) –

  The axis identifier.

• mode (StageBacklashMode) –

  The backlash mode.

axis class-attribute instance-attribute

axis: AxisIdentifier = betterproto.enum_field(1)

The axis identifier.

mode class-attribute instance-attribute

mode: StageBacklashMode = betterproto.enum_field(2)

The backlash mode.

StageServiceAxisUserLimitsResponse dataclass

StageServiceAxisUserLimitsResponse(axis: AxisIdentifier = betterproto.enum_field(1), lower_limit: float = betterproto.double_field(2), upper_limit: float = betterproto.double_field(3))

Bases: Message

Request object for setting axis soft limits.

Attributes:

• axis (AxisIdentifier) –

  The axis identifier.

• lower_limit (float) –

  The lower soft limit in meters or radians.

• upper_limit (float) –

  The upper soft limit in meters or radians.

axis class-attribute instance-attribute

axis: AxisIdentifier = betterproto.enum_field(1)

The axis identifier.

lower_limit class-attribute instance-attribute

lower_limit: float = betterproto.double_field(2)

The lower soft limit in meters or radians.

upper_limit class-attribute instance-attribute

upper_limit: float = betterproto.double_field(3)

The upper soft limit in meters or radians.

StageServiceGetAxisBacklashModeResponse dataclass

StageServiceGetAxisBacklashModeResponse(axis: AxisIdentifier = betterproto.enum_field(1), mode: StageBacklashMode = betterproto.enum_field(2))

Bases: Message

Response object for axis backlash mode.

Attributes:

• axis (AxisIdentifier) –

  The axis identifier.

• mode (StageBacklashMode) –

  The backlash mode.

axis class-attribute instance-attribute

axis: AxisIdentifier = betterproto.enum_field(1)

The axis identifier.

mode class-attribute instance-attribute

mode: StageBacklashMode = betterproto.enum_field(2)

The backlash mode.

StageServiceGetAxisLimitsResponse dataclass

StageServiceGetAxisLimitsResponse(axis: AxisIdentifier = betterproto.enum_field(1), minimum: float = betterproto.double_field(2), maximum: float = betterproto.double_field(3))

Bases: Message

Response object for axis position limits.

Attributes:

• axis (AxisIdentifier) –

  The axis identifier.

• minimum (float) –

  The minimum position in meters or radians.

• maximum (float) –

  The maximum position in meters or radians.

axis class-attribute instance-attribute

axis: AxisIdentifier = betterproto.enum_field(1)

The axis identifier.

minimum class-attribute instance-attribute

minimum: float = betterproto.double_field(2)

The minimum position in meters or radians.

maximum class-attribute instance-attribute

maximum: float = betterproto.double_field(3)

The maximum position in meters or radians.

StageServiceGetAxisUserLimitsResponse dataclass

StageServiceGetAxisUserLimitsResponse(axis: AxisIdentifier = betterproto.enum_field(1), lower_limit: float = betterproto.double_field(2), upper_limit: float = betterproto.double_field(3))

Bases: Message

Response object for axis soft limits.

Attributes:

• axis (AxisIdentifier) –

  The axis identifier.

• lower_limit (float) –

  The lower soft limit in meters or radians.

• upper_limit (float) –

  The upper soft limit in meters or radians.

axis class-attribute instance-attribute

axis: AxisIdentifier = betterproto.enum_field(1)

The axis identifier.

lower_limit class-attribute instance-attribute

lower_limit: float = betterproto.double_field(2)

The lower soft limit in meters or radians.

upper_limit class-attribute instance-attribute

upper_limit: float = betterproto.double_field(3)

The upper soft limit in meters or radians.

StageServiceGetAxisVelocityLimitsResponse dataclass

StageServiceGetAxisVelocityLimitsResponse(axis: AxisIdentifier = betterproto.enum_field(1), minimum: float = betterproto.double_field(2), maximum: float = betterproto.double_field(3))

Bases: Message

Response object for axis velocity limits.

Attributes:

• axis (AxisIdentifier) –

  The axis identifier.

• minimum (float) –

  The minimum velocity in meters per second or radians per second.

• maximum (float) –

  The maximum velocity in meters per second or radians per second.

axis class-attribute instance-attribute

axis: AxisIdentifier = betterproto.enum_field(1)

The axis identifier.

minimum class-attribute instance-attribute

minimum: float = betterproto.double_field(2)

The minimum velocity in meters per second or radians per second.

maximum class-attribute instance-attribute

maximum: float = betterproto.double_field(3)

The maximum velocity in meters per second or radians per second.

StageServiceGetStageBacklashModesResponse dataclass

StageServiceGetStageBacklashModesResponse(axis_backlash_modes: List[StageServiceGetAxisBacklashModeResponse] = betterproto.message_field(1))

Bases: Message

Response object for stage backlash modes.

Attributes:

• axis_backlash_modes (List[StageServiceGetAxisBacklashModeResponse]) –

  The available axes and their backlash modes.

axis_backlash_modes class-attribute instance-attribute

axis_backlash_modes: List[StageServiceGetAxisBacklashModeResponse] = betterproto.message_field(1)

The available axes and their backlash modes.

StageServiceGetStageFastResponse dataclass

StageServiceGetStageFastResponse(stage_fast: bool = betterproto.bool_field(1))

Bases: Message

Response object representing the column focus.

Attributes:

• stage_fast (bool) –

  A value indicating whether stage fast is enabled.

stage_fast class-attribute instance-attribute

stage_fast: bool = betterproto.bool_field(1)

A value indicating whether stage fast is enabled.

StageServiceGetStageLimitsResponse dataclass

StageServiceGetStageLimitsResponse(axis_limits: List[StageServiceGetAxisLimitsResponse] = betterproto.message_field(1))

Bases: Message

Response object for stage position limits.

Attributes:

• axis_limits (List[StageServiceGetAxisLimitsResponse]) –

  The available axes and their position limits.

axis_limits class-attribute instance-attribute

axis_limits: List[StageServiceGetAxisLimitsResponse] = betterproto.message_field(1)

The available axes and their position limits.

StageServiceGetStageUserLimitsResponse dataclass

StageServiceGetStageUserLimitsResponse(axis_soft_limits: List[StageServiceGetAxisUserLimitsResponse] = betterproto.message_field(1))

Bases: Message

Response object for stage soft limits.

Attributes:

• axis_soft_limits (List[StageServiceGetAxisUserLimitsResponse]) –

  The available axes and their soft limits.

axis_soft_limits class-attribute instance-attribute

axis_soft_limits: List[StageServiceGetAxisUserLimitsResponse] = betterproto.message_field(1)

The available axes and their soft limits.

StageServiceGetStageVelocityLimitsResponse dataclass

StageServiceGetStageVelocityLimitsResponse(axis_velocity_limits: List[StageServiceGetAxisVelocityLimitsResponse] = betterproto.message_field(1))

Bases: Message

Response object for stage velocity limits.

Attributes:

• axis_velocity_limits (List[StageServiceGetAxisVelocityLimitsResponse]) –

  The available axes and their velocity limits.

axis_velocity_limits class-attribute instance-attribute

axis_velocity_limits: List[StageServiceGetAxisVelocityLimitsResponse] = betterproto.message_field(1)

The available axes and their velocity limits.

StageServiceSetAxisBacklashModeResponse dataclass

StageServiceSetAxisBacklashModeResponse(success: bool = betterproto.bool_field(1))

Bases: Message

Response object for setting axis backlash mode.

Attributes:

• success (bool) –

  A value indicating whether the operation succeeded.

success class-attribute instance-attribute

success: bool = betterproto.bool_field(1)

A value indicating whether the operation succeeded.

StageServiceSetAxisUserLimitsResponse dataclass

StageServiceSetAxisUserLimitsResponse(success: bool = betterproto.bool_field(1))

Bases: Message

Response object for setting axis soft limits.

Attributes:

• success (bool) –

  A value indicating whether the operation succeeded.

success class-attribute instance-attribute

success: bool = betterproto.bool_field(1)

A value indicating whether the operation succeeded.

StageServiceSetAxisVelocityResponse dataclass

StageServiceSetAxisVelocityResponse(success: bool = betterproto.bool_field(1))

Bases: Message

Response object for setting axis velocity.

Attributes:

• success (bool) –

  A value indicating whether the operation succeeded.

success class-attribute instance-attribute

success: bool = betterproto.bool_field(1)

A value indicating whether the operation succeeded.

StageServiceSetStageBacklashModesResponse dataclass

StageServiceSetStageBacklashModesResponse(success: bool = betterproto.bool_field(1))

Bases: Message

Response object for setting stage backlash modes.

Attributes:

• success (bool) –

  A value indicating whether the operation succeeded.

success class-attribute instance-attribute

success: bool = betterproto.bool_field(1)

A value indicating whether the operation succeeded.

StageServiceSetStageFastResponse dataclass

StageServiceSetStageFastResponse(stage_fast: bool = betterproto.bool_field(1))

Bases: Message

Response object representing the column focus.

Attributes:

• stage_fast (bool) –

  A value indicating whether the stage fast status as a boolean.

stage_fast class-attribute instance-attribute

stage_fast: bool = betterproto.bool_field(1)

A value indicating whether the stage fast status as a boolean.

StageServiceSetStageUserLimitsResponse dataclass

StageServiceSetStageUserLimitsResponse(success: bool = betterproto.bool_field(1))

Bases: Message

Response object for setting stage user limits.

Attributes:

• success (bool) –

  A value indicating whether the operation succeeded.

success class-attribute instance-attribute

success: bool = betterproto.bool_field(1)

A value indicating whether the operation succeeded.

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 = betterproto.string_field(1)

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

width class-attribute instance-attribute

width: int = betterproto.int32_field(2)

The image width in pixels.

height class-attribute instance-attribute

height: int = betterproto.int32_field(3)

The image height in pixels.

dwell_time class-attribute instance-attribute

dwell_time: float = betterproto.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 = betterproto.int32_field(5)

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

line_averages class-attribute instance-attribute

line_averages: int = betterproto.int32_field(6)

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

scan_size_x class-attribute instance-attribute

scan_size_x: float = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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] = betterproto.string_field(1)

An array of string parameters, may be empty

id class-attribute instance-attribute

id: str = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.string_field(1)

the id as System.Guid of the external procedure.

error_message class-attribute instance-attribute

error_message: str = betterproto.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 = betterproto.string_field(1)

the id as System.Guid of the external procedure.

progress class-attribute instance-attribute

progress: float = betterproto.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 = betterproto.string_field(1)

the id as System.Guid of the external procedure.

error_message class-attribute instance-attribute

error_message: str = betterproto.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 = betterproto.string_field(1)

the id as System.Guid of the external procedure.

message class-attribute instance-attribute

message: str = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.double_field(1)

The illumination IR.

success class-attribute instance-attribute

success: bool = betterproto.bool_field(2)

A value indicating whether setting the brightness was successful.

message class-attribute instance-attribute

message: str = betterproto.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 = betterproto.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 = betterproto.double_field(1)

The illumination white.

success class-attribute instance-attribute

success: bool = betterproto.bool_field(2)

A value indicating whether setting the brightness was successful.

message class-attribute instance-attribute

message: str = betterproto.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 = betterproto.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 = betterproto.bool_field(1)

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

width class-attribute instance-attribute

width: int = betterproto.int32_field(2)

The width in pixels of the image.

height class-attribute instance-attribute

height: int = betterproto.int32_field(3)

The height in pixels of the image.

image_data class-attribute instance-attribute

image_data: bytes = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.bool_field(1)

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

width class-attribute instance-attribute

width: int = betterproto.int32_field(2)

The width in pixels of the image.

height class-attribute instance-attribute

height: int = betterproto.int32_field(3)

The height in pixels of the image.

image_data class-attribute instance-attribute

image_data: bytes = betterproto.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 = betterproto.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.

SimpleAcquisitionServiceChangeDwellTimeRequest dataclass

SimpleAcquisitionServiceChangeDwellTimeRequest(dwell_seconds: float = betterproto.double_field(1))

Bases: Message

The SimpleAcquisitionServiceChangeDwellTimeRequest class.

Attributes:

• dwell_seconds (float) –

  The new dwell time in seconds. Must be in [25e-9, 107] and only multiples of 25e-9s are supported.

dwell_seconds class-attribute instance-attribute

dwell_seconds: float = betterproto.double_field(1)

The new dwell time in seconds. Must be in [25e-9, 107] and only multiples of 25e-9s are supported.

SimpleAcquisitionServiceChangeDwellTimeResponse dataclass

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

Bases: Message

Response object representing the current acquisition status.

Attributes:

• task_success (bool) –

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

task_success class-attribute instance-attribute

task_success: bool = betterproto.bool_field(1)

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

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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.bool_field(1)

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

message class-attribute instance-attribute

message: str = betterproto.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 = betterproto.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 = betterproto.bool_field(1)

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

message class-attribute instance-attribute

message: str = betterproto.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.

SpecimenCurrentMonitorServiceGetSpecimenCurrentRequest dataclass

SpecimenCurrentMonitorServiceGetSpecimenCurrentRequest()

Bases: Message

The SpecimenCurrentMonitorServiceGetSpecimenCurrentRequest class.

SpecimenCurrentMonitorServiceGetSpecimenCurrentResponse dataclass

SpecimenCurrentMonitorServiceGetSpecimenCurrentResponse(current: float = betterproto.double_field(1))

Bases: Message

Response object for specimen current.

Attributes:

• current (float) –

  The specimen current value in amperes.

current class-attribute instance-attribute

current: float = betterproto.double_field(1)

The specimen current value in amperes.

SpecimenCurrentMonitorServiceRegisterOnSpecimenCurrentChangedRequest dataclass

SpecimenCurrentMonitorServiceRegisterOnSpecimenCurrentChangedRequest()

Bases: Message

The SpecimenCurrentMonitorServiceRegisterOnSpecimenCurrentChangedRequest class.

SpecimenCurrentMonitorServiceRegisterOnSpecimenCurrentChangedResponse dataclass

SpecimenCurrentMonitorServiceRegisterOnSpecimenCurrentChangedResponse(current: float = betterproto.double_field(1))

Bases: Message

Response object for specimen current changed notification.

Attributes:

• current (float) –

  The specimen current value in amperes.

current class-attribute instance-attribute

current: float = betterproto.double_field(1)

The specimen current value in amperes.

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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.enum_field(1)

The valve identifier.

state class-attribute instance-attribute

state: ValveState = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.enum_field(1)

The valve identifier.

state class-attribute instance-attribute

state: ValveState = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.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 = betterproto.bool_field(1)

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

AcquisitionServiceStub

Bases: ServiceStub

Methods:

• get_external_scan_source –

  Gets the external scan source identifier.

• set_external_scan_source –

  Sets the external scan source identifier.

get_external_scan_source async

get_external_scan_source(acquisition_service_get_external_scan_source_request: AcquisitionServiceGetExternalScanSourceRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AcquisitionServiceGetExternalScanSourceResponse

Gets the external scan source identifier. Specifies which external source is used for scan control when external scan is enabled.

set_external_scan_source async

set_external_scan_source(acquisition_service_set_external_scan_source_request: AcquisitionServiceSetExternalScanSourceRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AcquisitionServiceSetExternalScanSourceResponse

Sets the external scan source identifier. Specifies which external source to use for scan control when external scan is enabled.

CameraServiceStub

Bases: ServiceStub

Methods:

• get_acquisition_status –

  Gets the acquisition status for the specified camera.

• get_available_cameras –

  Gets the available cameras/

• get_brightness –

  Gets the brightness for the specified camera.

• get_ccd_mode –

  Gets the CCD mode for the specified camera.

• get_contrast –

  Gets the contrast for the specified camera.

• register_on_acquisition_status_changed –

  Registers a subscriber on acquisition status changes for the specified camera.

• register_on_brightness_changed –

  Registers a subscriber on brightness changes for the specified camera.

• register_on_ccd_mode_changed –

  Registers a subscriber on CCD mode changes for the specified camera.

• register_on_contrast_changed –

  Registers a subscriber on contrast changes for the specified camera.

• set_brightness –

  Sets the brightness for the specified camera.

• set_ccd_mode –

  Sets the CCD mode for the specified camera.

• set_contrast –

  Sets the contrast for the specified camera.

• start_live_acquisition –

  Starts a live acquisition with the given settings.

• start_single_acquisition –

  Starts a single frame acquisition for the specified camera. The image is streamed to the same destination as live acquisition.

• stop_live_acquisition –

  Stops any ongoing live acquisition.

get_acquisition_status async

get_acquisition_status(camera_service_get_acquisition_status_request: CameraServiceGetAcquisitionStatusRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CameraServiceGetAcquisitionStatusResponse

Gets the acquisition status for the specified camera.

get_available_cameras async

get_available_cameras(camera_service_get_available_cameras_request: CameraServiceGetAvailableCamerasRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CameraServiceGetAvailableCamerasResponse

Gets the available cameras/

get_brightness async

get_brightness(camera_service_get_brightness_request: CameraServiceGetBrightnessRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CameraServiceGetBrightnessResponse

Gets the brightness for the specified camera.

get_ccd_mode async

get_ccd_mode(camera_service_get_ccd_mode_request: CameraServiceGetCcdModeRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CameraServiceGetCcdModeResponse

Gets the CCD mode for the specified camera.

get_contrast async

get_contrast(camera_service_get_contrast_request: CameraServiceGetContrastRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CameraServiceGetContrastResponse

Gets the contrast for the specified camera.

register_on_acquisition_status_changed async

register_on_acquisition_status_changed(camera_service_register_on_acquisition_status_changed_request: CameraServiceRegisterOnAcquisitionStatusChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[CameraServiceRegisterOnAcquisitionStatusChangedResponse]

Registers a subscriber on acquisition status changes for the specified camera.

register_on_brightness_changed async

register_on_brightness_changed(camera_service_register_on_brightness_changed_request: CameraServiceRegisterOnBrightnessChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[CameraServiceRegisterOnBrightnessChangedResponse]

Registers a subscriber on brightness changes for the specified camera.

register_on_ccd_mode_changed async

register_on_ccd_mode_changed(camera_service_register_on_ccd_mode_changed_request: CameraServiceRegisterOnCcdModeChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[CameraServiceRegisterOnCcdModeChangedResponse]

Registers a subscriber on CCD mode changes for the specified camera.

register_on_contrast_changed async

register_on_contrast_changed(camera_service_register_on_contrast_changed_request: CameraServiceRegisterOnContrastChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[CameraServiceRegisterOnContrastChangedResponse]

Registers a subscriber on contrast changes for the specified camera.

set_brightness async

set_brightness(camera_service_set_brightness_request: CameraServiceSetBrightnessRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CameraServiceSetBrightnessResponse

Sets the brightness for the specified camera.

set_ccd_mode async

set_ccd_mode(camera_service_set_ccd_mode_request: CameraServiceSetCcdModeRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CameraServiceSetCcdModeResponse

Sets the CCD mode for the specified camera.

set_contrast async

set_contrast(camera_service_set_contrast_request: CameraServiceSetContrastRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CameraServiceSetContrastResponse

Sets the contrast for the specified camera.

start_live_acquisition async

start_live_acquisition(camera_service_start_live_acquisition_request: CameraServiceStartLiveAcquisitionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[CameraServiceStartLiveAcquisitionResponse]

Starts a live acquisition with the given settings.

start_single_acquisition async

start_single_acquisition(camera_service_start_single_acquisition_request: CameraServiceStartSingleAcquisitionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[CameraServiceStartSingleAcquisitionResponse]

Starts a single frame acquisition for the specified camera. The image is streamed to the same destination as live acquisition.

stop_live_acquisition async

stop_live_acquisition(camera_service_stop_live_acquisition_request: CameraServiceStopLiveAcquisitionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> CameraServiceStopLiveAcquisitionResponse

Stops any ongoing live acquisition. Only has an effect if ZenApi.EM.Hardware.V1.ICameraApi.GetAcquisitionStatus(System.String) returns ZenApi.EM.Hardware.V1.AcquisitionStatus.LiveRunning.

DetectorServiceStub

Bases: ServiceStub

Methods:

• get_available_detectors –

  Retrieves a list of all available detectors of the system.

• get_brightness –

  Retrieves the brightness value applied to a specific detector in percentage.

• get_contrast –

  Retrieves the contrast value applied to a specific detector in percentage.

• register_on_brightness_changed –

  Registers a subscriber on brightness changes of a specific detector.

• register_on_contrast_changed –

  Registers a subscriber on contrast changes of a specific detector.

• set_brightness –

  Applies a brightness value to a specified detector.

• set_contrast –

  Applies a contrast value to a specified detector.

get_available_detectors async

get_available_detectors(detector_service_get_available_detectors_request: DetectorServiceGetAvailableDetectorsRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> DetectorServiceGetAvailableDetectorsResponse

Retrieves a list of all available detectors of the system. Their name serves as an identifier for this API service.

get_brightness async

get_brightness(detector_service_get_brightness_request: DetectorServiceGetBrightnessRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> DetectorServiceGetBrightnessResponse

Retrieves the brightness value applied to a specific detector in percentage.

get_contrast async

get_contrast(detector_service_get_contrast_request: DetectorServiceGetContrastRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> DetectorServiceGetContrastResponse

Retrieves the contrast value applied to a specific detector in percentage.

register_on_brightness_changed async

register_on_brightness_changed(detector_service_register_on_brightness_changed_request: DetectorServiceRegisterOnBrightnessChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[DetectorServiceRegisterOnBrightnessChangedResponse]

Registers a subscriber on brightness changes of a specific detector.

register_on_contrast_changed async

register_on_contrast_changed(detector_service_register_on_contrast_changed_request: DetectorServiceRegisterOnContrastChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[DetectorServiceRegisterOnContrastChangedResponse]

Registers a subscriber on contrast changes of a specific detector.

set_brightness async

set_brightness(detector_service_set_brightness_request: DetectorServiceSetBrightnessRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> DetectorServiceSetBrightnessResponse

Applies a brightness value to a specified detector. The brightness value is applied immediately and has to be in [0, 1].

set_contrast async

set_contrast(detector_service_set_contrast_request: DetectorServiceSetContrastRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> DetectorServiceSetContrastResponse

Applies a contrast value to a specified detector. The contrast value is applied immediately and has to be in [0, 1].

ElectronColumnServiceStub

Bases: ServiceStub

Methods:

• get_actual_voltage –

  Retrieves the current eht/voltage.

• get_aperture_align –

  Gets the aperture align in percentage.

• get_beam_blanker_state –

  Gets the beam blanker state.

• get_beam_shift –

  Gets the current beam shift in meters.

• get_beam_shift_limits –

  Gets the limits of the beam shiftin meters.

• get_beam_state –

  Retrieves the current beam working state.

• get_booster_voltage –

  Gets the booster voltage in volts.

• get_eht_offset –

  Gets the eht offset in volts.

• get_eht_offset_limits –

  Gets the limits of the eht offset in volts.

• get_focus –

  Gets the current focus (working distance) in meters.

• get_focus_limits –

  Gets the limits of the current focus (working distance) in meters.

• get_fov –

  Retrieves the current Field Of View.

• get_fov_limits –

  Gets the limits of the Field Of View in meters.

• get_fov_rotation –

  Gets the rotation of the Field Of View.

• get_fov_rotation_limits –

  Gets the limits of the Field Of View rotation in radians.

• get_objective_current –

  Gets the objective current in amperes. The objective current controls the strength of the magnetic field of the lens.

• get_probe_current –

  Get the probe current.

• get_semi_angle –

  Gets the current semi angle in radians.

• get_spot_size –

  Gets the spot size in meters.

• get_stigmator –

  Gets the current stigmator x and y values in percent [0, 1].

• get_target_voltage –

  Retrieves the target eht/voltage.

• get_voltage_limits –

  Gets the limits of the voltage (EHT) in volts.

• go_to_standby –

  Bring the column into standby mode.

• register_on_aperture_align_changed –

  Register on aperture align changed events.

• register_on_beam_blanker_state_changed –

  Register on the beam blanker state changed events.

• register_on_beam_shift_changed –

  Register on column beam shift changed events.

• register_on_beam_state_changed –

  Register on beam state changed events.

• register_on_focus_changed –

  Register on column focus (working distance) changed events.

• register_on_fov_changed –

  Register on column FOV changed events.

• register_on_fov_rotation_changed –

  Register on FOV rotation changed events.

• register_on_probe_current_changed –

  Register on column probe current changed events.

• register_on_semi_angle_changed –

  Register on column semi angle changed events.

• register_on_spot_size_changed –

  Register on beam spot size changed events.

• register_on_stigmator_changed –

  Register on stigmator x and y changed events.

• register_on_voltage_changed –

  Register on column (current/actual) eht/voltage changed events.

• set_aperture_align –

  Sets the eht offset.

• set_beam_blanker_state –

  Sets the beam blanker state.

• set_beam_shift –

  Set the beam shift of this column.

• set_eht_offset –

  Sets the eht offset.

• set_focus –

  Applies a new focus (working distance) to the column.

• set_fov –

  Applies a new FOV.

• set_fov_rotation –

  Rotates the Field Of View.

• set_objective_current –

  Sets the objective current, that controlls the strength of the magnetic field of the lens.

• set_probe_current –

  Set the probe current.

• set_stigmator –

  Applies a new stigmator x and / or y value to the column.

• set_voltage –

  Applies a new target eht/voltage to the column.

• turn_off –

  Turns the column off.

• turn_on –

  Bring the column into working mode.

get_actual_voltage async

get_actual_voltage(electron_column_service_get_actual_voltage_request: ElectronColumnServiceGetActualVoltageRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceGetActualVoltageResponse

Retrieves the current eht/voltage.

get_aperture_align async

get_aperture_align(electron_column_service_get_aperture_align_request: ElectronColumnServiceGetApertureAlignRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceGetApertureAlignResponse

Gets the aperture align in percentage.

get_beam_blanker_state async

get_beam_blanker_state(electron_column_service_get_beam_blanker_state_request: ElectronColumnServiceGetBeamBlankerStateRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceGetBeamBlankerStateResponse

Gets the beam blanker state.

get_beam_shift async

get_beam_shift(electron_column_service_get_beam_shift_request: ElectronColumnServiceGetBeamShiftRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceGetBeamShiftResponse

Gets the current beam shift in meters.

get_beam_shift_limits async

get_beam_shift_limits(electron_column_service_get_beam_shift_limits_request: ElectronColumnServiceGetBeamShiftLimitsRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceGetBeamShiftLimitsResponse

Gets the limits of the beam shiftin meters.

get_beam_state async

get_beam_state(electron_column_service_get_beam_state_request: ElectronColumnServiceGetBeamStateRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceGetBeamStateResponse

Retrieves the current beam working state.

get_booster_voltage async

get_booster_voltage(electron_column_service_get_booster_voltage_request: ElectronColumnServiceGetBoosterVoltageRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceGetBoosterVoltageResponse

Gets the booster voltage in volts.

get_eht_offset async

get_eht_offset(electron_column_service_get_eht_offset_request: ElectronColumnServiceGetEhtOffsetRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceGetEhtOffsetResponse

Gets the eht offset in volts.

get_eht_offset_limits async

get_eht_offset_limits(electron_column_service_get_eht_offset_limits_request: ElectronColumnServiceGetEhtOffsetLimitsRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceGetEhtOffsetLimitsResponse

Gets the limits of the eht offset in volts.

get_focus async

get_focus(electron_column_service_get_focus_request: ElectronColumnServiceGetFocusRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceGetFocusResponse

Gets the current focus (working distance) in meters.

get_focus_limits async

get_focus_limits(electron_column_service_get_focus_limits_request: ElectronColumnServiceGetFocusLimitsRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceGetFocusLimitsResponse

Gets the limits of the current focus (working distance) in meters.

get_fov async

get_fov(electron_column_service_get_fov_request: ElectronColumnServiceGetFovRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceGetFovResponse

Retrieves the current Field Of View.

get_fov_limits async

get_fov_limits(electron_column_service_get_fov_limits_request: ElectronColumnServiceGetFovLimitsRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceGetFovLimitsResponse

Gets the limits of the Field Of View in meters.

get_fov_rotation async

get_fov_rotation(electron_column_service_get_fov_rotation_request: ElectronColumnServiceGetFovRotationRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceGetFovRotationResponse

Gets the rotation of the Field Of View.

get_fov_rotation_limits async

get_fov_rotation_limits(electron_column_service_get_fov_rotation_limits_request: ElectronColumnServiceGetFovRotationLimitsRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceGetFovRotationLimitsResponse

Gets the limits of the Field Of View rotation in radians.

get_objective_current async

get_objective_current(electron_column_service_get_objective_current_request: ElectronColumnServiceGetObjectiveCurrentRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceGetObjectiveCurrentResponse

Gets the objective current in amperes. The objective current controls the strength of the magnetic field of the lens.

get_probe_current async

get_probe_current(electron_column_service_get_probe_current_request: ElectronColumnServiceGetProbeCurrentRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceGetProbeCurrentResponse

Get the probe current.

get_semi_angle async

get_semi_angle(electron_column_service_get_semi_angle_request: ElectronColumnServiceGetSemiAngleRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceGetSemiAngleResponse

Gets the current semi angle in radians.

get_spot_size async

get_spot_size(electron_column_service_get_spot_size_request: ElectronColumnServiceGetSpotSizeRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceGetSpotSizeResponse

Gets the spot size in meters.

get_stigmator async

get_stigmator(electron_column_service_get_stigmator_request: ElectronColumnServiceGetStigmatorRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceGetStigmatorResponse

Gets the current stigmator x and y values in percent [0, 1].

get_target_voltage async

get_target_voltage(electron_column_service_get_target_voltage_request: ElectronColumnServiceGetTargetVoltageRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceGetTargetVoltageResponse

Retrieves the target eht/voltage.

get_voltage_limits async

get_voltage_limits(electron_column_service_get_voltage_limits_request: ElectronColumnServiceGetVoltageLimitsRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceGetVoltageLimitsResponse

Gets the limits of the voltage (EHT) in volts.

go_to_standby async

go_to_standby(electron_column_service_go_to_standby_request: ElectronColumnServiceGoToStandbyRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceGoToStandbyResponse

Bring the column into standby mode. This call triggers the column to go into standby mode. Emission will still be on.

register_on_aperture_align_changed async

register_on_aperture_align_changed(electron_column_service_register_on_aperture_align_changed_request: ElectronColumnServiceRegisterOnApertureAlignChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[ElectronColumnServiceRegisterOnApertureAlignChangedResponse]

Register on aperture align changed events.

register_on_beam_blanker_state_changed async

register_on_beam_blanker_state_changed(electron_column_service_register_on_beam_blanker_state_changed_request: ElectronColumnServiceRegisterOnBeamBlankerStateChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[ElectronColumnServiceRegisterOnBeamBlankerStateChangedResponse]

Register on the beam blanker state changed events.

register_on_beam_shift_changed async

register_on_beam_shift_changed(electron_column_service_register_on_beam_shift_changed_request: ElectronColumnServiceRegisterOnBeamShiftChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[ElectronColumnServiceRegisterOnBeamShiftChangedResponse]

Register on column beam shift changed events.

register_on_beam_state_changed async

register_on_beam_state_changed(electron_column_service_register_on_beam_state_changed_request: ElectronColumnServiceRegisterOnBeamStateChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[ElectronColumnServiceRegisterOnBeamStateChangedResponse]

Register on beam state changed events.

register_on_focus_changed async

register_on_focus_changed(electron_column_service_register_on_focus_changed_request: ElectronColumnServiceRegisterOnFocusChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[ElectronColumnServiceRegisterOnFocusChangedResponse]

Register on column focus (working distance) changed events.

register_on_fov_changed async

register_on_fov_changed(electron_column_service_register_on_fov_changed_request: ElectronColumnServiceRegisterOnFovChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[ElectronColumnServiceRegisterOnFovChangedResponse]

Register on column FOV changed events.

register_on_fov_rotation_changed async

register_on_fov_rotation_changed(electron_column_service_register_on_fov_rotation_changed_request: ElectronColumnServiceRegisterOnFovRotationChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[ElectronColumnServiceRegisterOnFovRotationChangedResponse]

Register on FOV rotation changed events.

register_on_probe_current_changed async

register_on_probe_current_changed(electron_column_service_register_on_probe_current_changed_request: ElectronColumnServiceRegisterOnProbeCurrentChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[ElectronColumnServiceRegisterOnProbeCurrentChangedResponse]

Register on column probe current changed events.

register_on_semi_angle_changed async

register_on_semi_angle_changed(electron_column_service_register_on_semi_angle_changed_request: ElectronColumnServiceRegisterOnSemiAngleChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[ElectronColumnServiceRegisterOnSemiAngleChangedResponse]

Register on column semi angle changed events.

register_on_spot_size_changed async

register_on_spot_size_changed(electron_column_service_register_on_spot_size_changed_request: ElectronColumnServiceRegisterOnSpotSizeChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[ElectronColumnServiceRegisterOnSpotSizeChangedResponse]

Register on beam spot size changed events.

register_on_stigmator_changed async

register_on_stigmator_changed(electron_column_service_register_on_stigmator_changed_request: ElectronColumnServiceRegisterOnStigmatorChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[ElectronColumnServiceRegisterOnStigmatorChangedResponse]

Register on stigmator x and y changed events.

register_on_voltage_changed async

register_on_voltage_changed(electron_column_service_register_on_voltage_changed_request: ElectronColumnServiceRegisterOnVoltageChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[ElectronColumnServiceRegisterOnVoltageChangedResponse]

Register on column (current/actual) eht/voltage changed events.

set_aperture_align async

set_aperture_align(electron_column_service_set_aperture_align_request: ElectronColumnServiceSetApertureAlignRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceSetApertureAlignResponse

Sets the eht offset.

set_beam_blanker_state async

set_beam_blanker_state(electron_column_service_set_beam_blanker_state_request: ElectronColumnServiceSetBeamBlankerStateRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceSetBeamBlankerStateResponse

Sets the beam blanker state.

set_beam_shift async

set_beam_shift(electron_column_service_set_beam_shift_request: ElectronColumnServiceSetBeamShiftRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceSetBeamShiftResponse

Set the beam shift of this column. Values can be null if they should not be updated.

set_eht_offset async

set_eht_offset(electron_column_service_set_eht_offset_request: ElectronColumnServiceSetEhtOffsetRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceSetEhtOffsetResponse

Sets the eht offset.

set_focus async

set_focus(electron_column_service_set_focus_request: ElectronColumnServiceSetFocusRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceSetFocusResponse

Applies a new focus (working distance) to the column.

set_fov async

set_fov(electron_column_service_set_fov_request: ElectronColumnServiceSetFovRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceSetFovResponse

Applies a new FOV.

set_fov_rotation async

set_fov_rotation(electron_column_service_set_fov_rotation_request: ElectronColumnServiceSetFovRotationRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceSetFovRotationResponse

Rotates the Field Of View. If scan rotation is not enabled, it would be enabled.

set_objective_current async

set_objective_current(electron_column_service_set_objective_current_request: ElectronColumnServiceSetObjectiveCurrentRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceSetObjectiveCurrentResponse

Sets the objective current, that controlls the strength of the magnetic field of the lens.

set_probe_current async

set_probe_current(electron_column_service_set_probe_current_request: ElectronColumnServiceSetProbeCurrentRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceSetProbeCurrentResponse

Set the probe current.

set_stigmator async

set_stigmator(electron_column_service_set_stigmator_request: ElectronColumnServiceSetStigmatorRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceSetStigmatorResponse

Applies a new stigmator x and / or y value to the column.

set_voltage async

set_voltage(electron_column_service_set_voltage_request: ElectronColumnServiceSetVoltageRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceSetVoltageResponse

Applies a new target eht/voltage to the column.

turn_off async

turn_off(electron_column_service_turn_off_request: ElectronColumnServiceTurnOffRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceTurnOffResponse

Turns the column off. This call initiates ramping down of emission and brings the column into off state.

turn_on async

turn_on(electron_column_service_turn_on_request: ElectronColumnServiceTurnOnRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ElectronColumnServiceTurnOnResponse

Bring the column into working mode. This call initiates ramping of emission and brings the column into working condition.

EmStageServiceStub

Bases: ServiceStub

Methods:

• get_axis_backlash_mode –

  Gets the backlash mode for a specific stage axis.

• get_axis_limits –

  Gets the position limits (minimum and maximum) for a specific stage axis.

• get_axis_user_limits –

  Gets the User limits (upper and lower) for a specific stage axis.

• get_axis_velocity_limits –

  Gets the velocity limits (minimum and maximum) for a specific stage axis.

• get_stage_backlash_modes –

  Gets the backlash modes for all available stage axes.

• get_stage_fast –

  Gets the stage fast status.

• get_stage_limits –

  Gets the position limits for all available stage axes.

• get_stage_user_limits –

  Gets the User limits for all available stage axes.

• get_stage_velocity_limits –

  Gets the velocity limits for all available stage axes.

• set_axis_backlash_mode –

  Sets the backlash mode for a specific stage axis.

• set_axis_user_limits –

  Sets the User limits for a specific stage axis.

• set_axis_velocity –

  Sets the target velocity for a specific stage axis.

• set_stage_backlash_modes –

  Sets the backlash modes for multiple stage axes.

• set_stage_fast –

  Applies a new stage fast status.

• set_stage_user_limits –

  Sets the User limits for multiple stage axes.

get_axis_backlash_mode async

get_axis_backlash_mode(em_stage_service_get_axis_backlash_mode_request: EmStageServiceGetAxisBacklashModeRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceGetAxisBacklashModeResponse

Gets the backlash mode for a specific stage axis.

get_axis_limits async

get_axis_limits(em_stage_service_get_axis_limits_request: EmStageServiceGetAxisLimitsRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceGetAxisLimitsResponse

Gets the position limits (minimum and maximum) for a specific stage axis.

get_axis_user_limits async

get_axis_user_limits(em_stage_service_get_axis_user_limits_request: EmStageServiceGetAxisUserLimitsRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceGetAxisUserLimitsResponse

Gets the User limits (upper and lower) for a specific stage axis.

get_axis_velocity_limits async

get_axis_velocity_limits(em_stage_service_get_axis_velocity_limits_request: EmStageServiceGetAxisVelocityLimitsRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceGetAxisVelocityLimitsResponse

Gets the velocity limits (minimum and maximum) for a specific stage axis.

get_stage_backlash_modes async

get_stage_backlash_modes(em_stage_service_get_stage_backlash_modes_request: EmStageServiceGetStageBacklashModesRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceGetStageBacklashModesResponse

Gets the backlash modes for all available stage axes.

get_stage_fast async

get_stage_fast(em_stage_service_get_stage_fast_request: EmStageServiceGetStageFastRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceGetStageFastResponse

Gets the stage fast status.

get_stage_limits async

get_stage_limits(em_stage_service_get_stage_limits_request: EmStageServiceGetStageLimitsRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceGetStageLimitsResponse

Gets the position limits for all available stage axes.

get_stage_user_limits async

get_stage_user_limits(em_stage_service_get_stage_user_limits_request: EmStageServiceGetStageUserLimitsRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceGetStageUserLimitsResponse

Gets the User limits for all available stage axes.

get_stage_velocity_limits async

get_stage_velocity_limits(em_stage_service_get_stage_velocity_limits_request: EmStageServiceGetStageVelocityLimitsRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceGetStageVelocityLimitsResponse

Gets the velocity limits for all available stage axes.

set_axis_backlash_mode async

set_axis_backlash_mode(em_stage_service_set_axis_backlash_mode_request: EmStageServiceSetAxisBacklashModeRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceSetAxisBacklashModeResponse

Sets the backlash mode for a specific stage axis.

set_axis_user_limits async

set_axis_user_limits(em_stage_service_set_axis_user_limits_request: EmStageServiceSetAxisUserLimitsRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceSetAxisUserLimitsResponse

Sets the User limits for a specific stage axis.

set_axis_velocity async

set_axis_velocity(em_stage_service_set_axis_velocity_request: EmStageServiceSetAxisVelocityRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceSetAxisVelocityResponse

Sets the target velocity for a specific stage axis.

set_stage_backlash_modes async

set_stage_backlash_modes(em_stage_service_set_stage_backlash_modes_request: EmStageServiceSetStageBacklashModesRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceSetStageBacklashModesResponse

Sets the backlash modes for multiple stage axes.

set_stage_fast async

set_stage_fast(em_stage_service_set_stage_fast_request: EmStageServiceSetStageFastRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceSetStageFastResponse

Applies a new stage fast status.

set_stage_user_limits async

set_stage_user_limits(em_stage_service_set_stage_user_limits_request: EmStageServiceSetStageUserLimitsRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> StageServiceSetStageUserLimitsResponse

Sets the User limits for multiple stage axes.

ExternalProcedureServiceStub

Bases: ServiceStub

Methods:

• register_external_procedure –

  Registers the caller to get notified about ZenApi.EM.Hardware.V1.ExternalProcedureServiceRegisterExternalProcedureResponse's

• report_command_failure –

  Reports the failure of execution of the given ZenApi.EM.Hardware.V1.ExternalProcedureServiceRegisterExternalProcedureResponse.

• report_command_success –

  Reports the successful execution of the given ZenApi.EM.Hardware.V1.ExternalProcedureServiceRegisterExternalProcedureResponse.

• report_initialization_error –

  Reports an error that has occurred during the initialization of an external procedure, leads to error state.

• report_progress –

  reports the progress of the external procedure with the given id.

• report_ready –

  Reports, that the external procedure with the given id is ready to be executed.

• report_status –

  reports a status message to zen.

register_external_procedure async

register_external_procedure(external_procedure_service_register_external_procedure_request: ExternalProcedureServiceRegisterExternalProcedureRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[ExternalProcedureServiceRegisterExternalProcedureResponse]

Registers the caller to get notified about ZenApi.EM.Hardware.V1.ExternalProcedureServiceRegisterExternalProcedureResponse's (for all external procedures; filtering must be done by the caller).

report_command_failure async

report_command_failure(external_procedure_service_report_command_failure_request: ExternalProcedureServiceReportCommandFailureRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ExternalProcedureServiceReportCommandFailureResponse

Reports the failure of execution of the given ZenApi.EM.Hardware.V1.ExternalProcedureServiceRegisterExternalProcedureResponse.

report_command_success async

report_command_success(external_procedure_service_report_command_success_request: ExternalProcedureServiceReportCommandSuccessRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ExternalProcedureServiceReportCommandSuccessResponse

Reports the successful execution of the given ZenApi.EM.Hardware.V1.ExternalProcedureServiceRegisterExternalProcedureResponse.

report_initialization_error async

report_initialization_error(external_procedure_service_report_initialization_error_request: ExternalProcedureServiceReportInitializationErrorRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ExternalProcedureServiceReportInitializationErrorResponse

Reports an error that has occurred during the initialization of an external procedure, leads to error state.

report_progress async

report_progress(external_procedure_service_report_progress_request: ExternalProcedureServiceReportProgressRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ExternalProcedureServiceReportProgressResponse

reports the progress of the external procedure with the given id.

report_ready async

report_ready(external_procedure_service_report_ready_request: ExternalProcedureServiceReportReadyRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ExternalProcedureServiceReportReadyResponse

Reports, that the external procedure with the given id is ready to be executed.

report_status async

report_status(external_procedure_service_report_status_request: ExternalProcedureServiceReportStatusRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> ExternalProcedureServiceReportStatusResponse

reports a status message to zen.

IlluminationServiceStub

Bases: ServiceStub

Methods:

• get_illumination_ir –

  Gets the illumination IR value. Returns the current illumination IR value [0..100]%.

• get_illumination_white –

  Gets the illumination white value. Returns the current illumination white value [0..100]%.

• register_on_illumination_ir_changed –

  Registers a subscriber on illumination IR changes. returns the current illumination IR value [0..100]%.

• register_on_illumination_white_changed –

  Registers a subscriber on illumination white changes. Returns the current illumination white value [0..100]%.

• set_illumination_ir –

  Sets the illumination IR value. Returns the current illumination IR value [0..100]%.

• set_illumination_white –

  Sets the illumination white value. Returns the current illumination white value [0..100]%.

get_illumination_ir async

get_illumination_ir(illumination_service_get_illumination_ir_request: IlluminationServiceGetIlluminationIrRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> IlluminationServiceGetIlluminationIrResponse

Gets the illumination IR value. Returns the current illumination IR value [0..100]%.

get_illumination_white async

get_illumination_white(illumination_service_get_illumination_white_request: IlluminationServiceGetIlluminationWhiteRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> IlluminationServiceGetIlluminationWhiteResponse

Gets the illumination white value. Returns the current illumination white value [0..100]%.

register_on_illumination_ir_changed async

register_on_illumination_ir_changed(illumination_service_register_on_illumination_ir_changed_request: IlluminationServiceRegisterOnIlluminationIrChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[IlluminationServiceRegisterOnIlluminationIrChangedResponse]

Registers a subscriber on illumination IR changes. returns the current illumination IR value [0..100]%.

register_on_illumination_white_changed async

register_on_illumination_white_changed(illumination_service_register_on_illumination_white_changed_request: IlluminationServiceRegisterOnIlluminationWhiteChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[IlluminationServiceRegisterOnIlluminationWhiteChangedResponse]

Registers a subscriber on illumination white changes. Returns the current illumination white value [0..100]%.

set_illumination_ir async

set_illumination_ir(illumination_service_set_illumination_ir_request: IlluminationServiceSetIlluminationIrRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> IlluminationServiceSetIlluminationIrResponse

Sets the illumination IR value. Returns the current illumination IR value [0..100]%.

set_illumination_white async

set_illumination_white(illumination_service_set_illumination_white_request: IlluminationServiceSetIlluminationWhiteRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> IlluminationServiceSetIlluminationWhiteResponse

Sets the illumination white value. Returns the current illumination white value [0..100]%.

SimpleAcquisitionServiceStub

Bases: ServiceStub

Methods:

• acquire_extended_single_frame –

  Call to start single channel acquisition of a single frame with given settings.

• acquire_single_frame –

  Call to start single channel acquisition of a single frame with given settings.

• change_dwell_time –

  Changes the dwell time for any ongoing acquisition task.

• get_acquisition_status –

  Retrieves the current state of the acquisition hardware.

• get_brightness –

  Retrieves the brightness value applied to a specific detector in percentage.

• get_contrast –

  Retrieves the contrast value applied to a specific detector in percentage.

• register_on_acquisition_status_changed –

  Subscribes to acquisition status changed events.

• set_brightness –

  Applies a brightness value to a specified detector.

• set_contrast –

  Applies a contrast value to a specified detector.

• start_extended_live_acquisition –

  This starts a live single channel acquisition with the given settings.

• start_live_acquisition –

  This starts a live single channel acquisition with the given settings.

• stop_live_acquisition –

  Stops any ongoing live acquisition.

acquire_extended_single_frame async

acquire_extended_single_frame(simple_acquisition_service_acquire_extended_single_frame_request: SimpleAcquisitionServiceAcquireExtendedSingleFrameRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SimpleAcquisitionServiceAcquireExtendedSingleFrameResponse

Call to start single channel acquisition of a single frame with given settings. The task returned represents the ongoing acquisition. The resulting image is send once the acquisition completed.

acquire_single_frame async

acquire_single_frame(simple_acquisition_service_acquire_single_frame_request: SimpleAcquisitionServiceAcquireSingleFrameRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SimpleAcquisitionServiceAcquireSingleFrameResponse

Call to start single channel acquisition of a single frame with given settings. The task returned represents the ongoing acquisition. The resulting image is send once the acquisition completed.

change_dwell_time async

change_dwell_time(simple_acquisition_service_change_dwell_time_request: SimpleAcquisitionServiceChangeDwellTimeRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SimpleAcquisitionServiceChangeDwellTimeResponse

Changes the dwell time for any ongoing acquisition task.

get_acquisition_status async

get_acquisition_status(simple_acquisition_service_get_acquisition_status_request: SimpleAcquisitionServiceGetAcquisitionStatusRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SimpleAcquisitionServiceGetAcquisitionStatusResponse

Retrieves the current state of the acquisition hardware. Allows to deduce if the hardware is available for a new acquisition, is blocked by some other task, or acquires currently images.

get_brightness async

get_brightness(simple_acquisition_service_get_brightness_request: SimpleAcquisitionServiceGetBrightnessRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SimpleAcquisitionServiceGetBrightnessResponse

Retrieves the brightness value applied to a specific detector in percentage.

get_contrast async

get_contrast(simple_acquisition_service_get_contrast_request: SimpleAcquisitionServiceGetContrastRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SimpleAcquisitionServiceGetContrastResponse

Retrieves the contrast value applied to a specific detector in percentage.

register_on_acquisition_status_changed async

register_on_acquisition_status_changed(simple_acquisition_service_register_on_acquisition_status_changed_request: SimpleAcquisitionServiceRegisterOnAcquisitionStatusChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[SimpleAcquisitionServiceRegisterOnAcquisitionStatusChangedResponse]

Subscribes to acquisition status changed events.

set_brightness async

set_brightness(simple_acquisition_service_set_brightness_request: SimpleAcquisitionServiceSetBrightnessRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SimpleAcquisitionServiceSetBrightnessResponse

Applies a brightness value to a specified detector. The brightness value is applied immediately and has to be in [0, 1].

set_contrast async

set_contrast(simple_acquisition_service_set_contrast_request: SimpleAcquisitionServiceSetContrastRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SimpleAcquisitionServiceSetContrastResponse

Applies a contrast value to a specified detector. The contrast value is applied immediately and has to be in [0, 1].

start_extended_live_acquisition async

start_extended_live_acquisition(simple_acquisition_service_start_extended_live_acquisition_request: SimpleAcquisitionServiceStartExtendedLiveAcquisitionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SimpleAcquisitionServiceStartExtendedLiveAcquisitionResponse

This starts a live single channel acquisition with the given settings.

start_live_acquisition async

start_live_acquisition(simple_acquisition_service_start_live_acquisition_request: SimpleAcquisitionServiceStartLiveAcquisitionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SimpleAcquisitionServiceStartLiveAcquisitionResponse

This starts a live single channel acquisition with the given settings.

stop_live_acquisition async

stop_live_acquisition(simple_acquisition_service_stop_live_acquisition_request: SimpleAcquisitionServiceStopLiveAcquisitionRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SimpleAcquisitionServiceStopLiveAcquisitionResponse

Stops any ongoing live acquisition. Has only an effect if ZenApi.EM.Hardware.V1.ISimpleAcquisitionApi.GetAcquisitionStatus returns ZenApi.EM.Hardware.V1.AcquisitionStatus.LiveRunning.

SpecimenCurrentMonitorServiceStub

Bases: ServiceStub

Methods:

• get_specimen_current –

  Gets the current specimen current in amperes.

• register_on_specimen_current_changed –

  Register on specimen current changed events.

get_specimen_current async

get_specimen_current(specimen_current_monitor_service_get_specimen_current_request: SpecimenCurrentMonitorServiceGetSpecimenCurrentRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> SpecimenCurrentMonitorServiceGetSpecimenCurrentResponse

Gets the current specimen current in amperes.

register_on_specimen_current_changed async

register_on_specimen_current_changed(specimen_current_monitor_service_register_on_specimen_current_changed_request: SpecimenCurrentMonitorServiceRegisterOnSpecimenCurrentChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[SpecimenCurrentMonitorServiceRegisterOnSpecimenCurrentChangedResponse]

Register on specimen current changed events.

VacuumServiceStub

Bases: ServiceStub

Methods:

• close_valve –

  Closes a valve on the system.

• get_available_vacuum_modes –

  Retrieves a collection of available vacuum modes, like HV and VP.

• get_available_valves –

  Retrieves all available valves of the system that can be controlled.

• get_chamber_pressure –

  Retrieves the current chamber pressure in [pascal].

• get_target_chamber_pressure –

  Retrieves the target chamber pressure for ZenApi.EM.Hardware.V1.VacuumMode.VariablePressure mode.

• get_vacuum_mode –

  Retrieves the currently active Vacuum Mode.

• get_vacuum_state –

  Retrieves the current vacuum state.

• get_valve_state –

  Retrieves the current state of a valve.

• open_valve –

  Opens a valve on the system.

• pump –

  Starts the pumping process to evacuate the chamber and install a stable vacuum.

• register_on_chamber_pressure_changed –

  Notifications on chamber pressure. Events are fired every time the current chamber pressure changes.

• register_on_target_chamber_pressure_changed –

  Notifications about changes to the target chamber pressure value.

• register_on_vacuum_mode_changed –

  Notification about changes of the active vacuum mode.

• register_on_vacuum_state_changed –

  Notification about changes of the vacuum system state.

• register_on_valve_state_changed –

  Notifications about any valves state changes.

• set_target_chamber_pressure –

  Sets and if in ZenApi.EM.Hardware.V1.VacuumMode.VariablePressure also applies a new

• set_vacuum_mode –

  Sets the active vacuum mode.

• vent –

  Starts the venting process to vent the chamber and allow the chamber door to be opened.

close_valve async

close_valve(vacuum_service_close_valve_request: VacuumServiceCloseValveRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> VacuumServiceCloseValveResponse

Closes a valve on the system.

get_available_vacuum_modes async

get_available_vacuum_modes(vacuum_service_get_available_vacuum_modes_request: VacuumServiceGetAvailableVacuumModesRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> VacuumServiceGetAvailableVacuumModesResponse

Retrieves a collection of available vacuum modes, like HV and VP. Available modes depend on the tool configuration and don't change during runtime. Note: TargetChamberPressure functionality is only working for VP mode.

get_available_valves async

get_available_valves(vacuum_service_get_available_valves_request: VacuumServiceGetAvailableValvesRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> VacuumServiceGetAvailableValvesResponse

Retrieves all available valves of the system that can be controlled. Possible values are listed in ZenApi.EM.Hardware.V1.Valve enumeration.

get_chamber_pressure async

get_chamber_pressure(vacuum_service_get_chamber_pressure_request: VacuumServiceGetChamberPressureRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> VacuumServiceGetChamberPressureResponse

Retrieves the current chamber pressure in [pascal].

get_target_chamber_pressure async

get_target_chamber_pressure(vacuum_service_get_target_chamber_pressure_request: VacuumServiceGetTargetChamberPressureRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> VacuumServiceGetTargetChamberPressureResponse

Retrieves the target chamber pressure for ZenApi.EM.Hardware.V1.VacuumMode.VariablePressure mode. Unspecified return value on non VP configurations.

get_vacuum_mode async

get_vacuum_mode(vacuum_service_get_vacuum_mode_request: VacuumServiceGetVacuumModeRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> VacuumServiceGetVacuumModeResponse

Retrieves the currently active Vacuum Mode.

get_vacuum_state async

get_vacuum_state(vacuum_service_get_vacuum_state_request: VacuumServiceGetVacuumStateRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> VacuumServiceGetVacuumStateResponse

Retrieves the current vacuum state.

get_valve_state async

get_valve_state(vacuum_service_get_valve_state_request: VacuumServiceGetValveStateRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> VacuumServiceGetValveStateResponse

Retrieves the current state of a valve. Only states of available valves are defined. See ZenApi.EM.Hardware.V1.IVacuumApi.GetAvailableValves.

open_valve async

open_valve(vacuum_service_open_valve_request: VacuumServiceOpenValveRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> VacuumServiceOpenValveResponse

Opens a valve on the system.

pump async

pump(vacuum_service_pump_request: VacuumServicePumpRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> VacuumServicePumpResponse

Starts the pumping process to evacuate the chamber and install a stable vacuum.

register_on_chamber_pressure_changed async

register_on_chamber_pressure_changed(vacuum_service_register_on_chamber_pressure_changed_request: VacuumServiceRegisterOnChamberPressureChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[VacuumServiceRegisterOnChamberPressureChangedResponse]

Notifications on chamber pressure. Events are fired every time the current chamber pressure changes.

register_on_target_chamber_pressure_changed async

register_on_target_chamber_pressure_changed(vacuum_service_register_on_target_chamber_pressure_changed_request: VacuumServiceRegisterOnTargetChamberPressureChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[VacuumServiceRegisterOnTargetChamberPressureChangedResponse]

Notifications about changes to the target chamber pressure value. Only enabled on systems supporting ZenApi.EM.Hardware.V1.VacuumMode.VariablePressure mode.

register_on_vacuum_mode_changed async

register_on_vacuum_mode_changed(vacuum_service_register_on_vacuum_mode_changed_request: VacuumServiceRegisterOnVacuumModeChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[VacuumServiceRegisterOnVacuumModeChangedResponse]

Notification about changes of the active vacuum mode. See ZenApi.EM.Hardware.V1.VacuumMode.

register_on_vacuum_state_changed async

register_on_vacuum_state_changed(vacuum_service_register_on_vacuum_state_changed_request: VacuumServiceRegisterOnVacuumStateChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[VacuumServiceRegisterOnVacuumStateChangedResponse]

Notification about changes of the vacuum system state. See ZenApi.EM.Hardware.V1.VacuumState.

register_on_valve_state_changed async

register_on_valve_state_changed(vacuum_service_register_on_valve_state_changed_request: VacuumServiceRegisterOnValveStateChangedRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> AsyncIterator[VacuumServiceRegisterOnValveStateChangedResponse]

Notifications about any valves state changes.

set_target_chamber_pressure async

set_target_chamber_pressure(vacuum_service_set_target_chamber_pressure_request: VacuumServiceSetTargetChamberPressureRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> VacuumServiceSetTargetChamberPressureResponse

Sets and if in ZenApi.EM.Hardware.V1.VacuumMode.VariablePressure also applies a new chamber pressure.

set_vacuum_mode async

set_vacuum_mode(vacuum_service_set_vacuum_mode_request: VacuumServiceSetVacuumModeRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> VacuumServiceSetVacuumModeResponse

Sets the active vacuum mode. No op if the vacuum mode does not change, otherwise the process to switch to the other vacuum mode is initiated.

vent async

vent(vacuum_service_vent_request: VacuumServiceVentRequest, *, timeout: Optional[float] = None, deadline: Optional[Deadline] = None, metadata: Optional[MetadataLike] = None) -> VacuumServiceVentResponse

Starts the venting process to vent the chamber and allow the chamber door to be opened.

AcquisitionServiceBase

Bases: ServiceBase

Methods:

• get_external_scan_source –

  Gets the external scan source identifier.

• set_external_scan_source –

  Sets the external scan source identifier.

get_external_scan_source async

get_external_scan_source(acquisition_service_get_external_scan_source_request: AcquisitionServiceGetExternalScanSourceRequest) -> AcquisitionServiceGetExternalScanSourceResponse

Gets the external scan source identifier. Specifies which external source is used for scan control when external scan is enabled.

set_external_scan_source async

set_external_scan_source(acquisition_service_set_external_scan_source_request: AcquisitionServiceSetExternalScanSourceRequest) -> AcquisitionServiceSetExternalScanSourceResponse

Sets the external scan source identifier. Specifies which external source to use for scan control when external scan is enabled.

CameraServiceBase

Bases: ServiceBase

Methods:

• get_acquisition_status –

  Gets the acquisition status for the specified camera.

• get_available_cameras –

  Gets the available cameras/

• get_brightness –

  Gets the brightness for the specified camera.

• get_ccd_mode –

  Gets the CCD mode for the specified camera.

• get_contrast –

  Gets the contrast for the specified camera.

• register_on_acquisition_status_changed –

  Registers a subscriber on acquisition status changes for the specified camera.

• register_on_brightness_changed –

  Registers a subscriber on brightness changes for the specified camera.

• register_on_ccd_mode_changed –

  Registers a subscriber on CCD mode changes for the specified camera.

• register_on_contrast_changed –

  Registers a subscriber on contrast changes for the specified camera.

• set_brightness –

  Sets the brightness for the specified camera.

• set_ccd_mode –

  Sets the CCD mode for the specified camera.

• set_contrast –

  Sets the contrast for the specified camera.

• start_live_acquisition –

  Starts a live acquisition with the given settings.

• start_single_acquisition –

  Starts a single frame acquisition for the specified camera. The image is streamed to the same destination as live acquisition.

• stop_live_acquisition –

  Stops any ongoing live acquisition.

get_acquisition_status async

get_acquisition_status(camera_service_get_acquisition_status_request: CameraServiceGetAcquisitionStatusRequest) -> CameraServiceGetAcquisitionStatusResponse

Gets the acquisition status for the specified camera.

get_available_cameras async

get_available_cameras(camera_service_get_available_cameras_request: CameraServiceGetAvailableCamerasRequest) -> CameraServiceGetAvailableCamerasResponse

Gets the available cameras/

get_brightness async

get_brightness(camera_service_get_brightness_request: CameraServiceGetBrightnessRequest) -> CameraServiceGetBrightnessResponse

Gets the brightness for the specified camera.

get_ccd_mode async

get_ccd_mode(camera_service_get_ccd_mode_request: CameraServiceGetCcdModeRequest) -> CameraServiceGetCcdModeResponse

Gets the CCD mode for the specified camera.

get_contrast async

get_contrast(camera_service_get_contrast_request: CameraServiceGetContrastRequest) -> CameraServiceGetContrastResponse

Gets the contrast for the specified camera.

register_on_acquisition_status_changed async

register_on_acquisition_status_changed(camera_service_register_on_acquisition_status_changed_request: CameraServiceRegisterOnAcquisitionStatusChangedRequest) -> AsyncIterator[CameraServiceRegisterOnAcquisitionStatusChangedResponse]

Registers a subscriber on acquisition status changes for the specified camera.

register_on_brightness_changed async

register_on_brightness_changed(camera_service_register_on_brightness_changed_request: CameraServiceRegisterOnBrightnessChangedRequest) -> AsyncIterator[CameraServiceRegisterOnBrightnessChangedResponse]

Registers a subscriber on brightness changes for the specified camera.

register_on_ccd_mode_changed async

register_on_ccd_mode_changed(camera_service_register_on_ccd_mode_changed_request: CameraServiceRegisterOnCcdModeChangedRequest) -> AsyncIterator[CameraServiceRegisterOnCcdModeChangedResponse]

Registers a subscriber on CCD mode changes for the specified camera.

register_on_contrast_changed async

register_on_contrast_changed(camera_service_register_on_contrast_changed_request: CameraServiceRegisterOnContrastChangedRequest) -> AsyncIterator[CameraServiceRegisterOnContrastChangedResponse]

Registers a subscriber on contrast changes for the specified camera.

set_brightness async

set_brightness(camera_service_set_brightness_request: CameraServiceSetBrightnessRequest) -> CameraServiceSetBrightnessResponse

Sets the brightness for the specified camera.

set_ccd_mode async

set_ccd_mode(camera_service_set_ccd_mode_request: CameraServiceSetCcdModeRequest) -> CameraServiceSetCcdModeResponse

Sets the CCD mode for the specified camera.

set_contrast async

set_contrast(camera_service_set_contrast_request: CameraServiceSetContrastRequest) -> CameraServiceSetContrastResponse

Sets the contrast for the specified camera.

start_live_acquisition async

start_live_acquisition(camera_service_start_live_acquisition_request: CameraServiceStartLiveAcquisitionRequest) -> AsyncIterator[CameraServiceStartLiveAcquisitionResponse]

Starts a live acquisition with the given settings.

start_single_acquisition async

start_single_acquisition(camera_service_start_single_acquisition_request: CameraServiceStartSingleAcquisitionRequest) -> AsyncIterator[CameraServiceStartSingleAcquisitionResponse]

Starts a single frame acquisition for the specified camera. The image is streamed to the same destination as live acquisition.

stop_live_acquisition async

stop_live_acquisition(camera_service_stop_live_acquisition_request: CameraServiceStopLiveAcquisitionRequest) -> CameraServiceStopLiveAcquisitionResponse

Stops any ongoing live acquisition. Only has an effect if ZenApi.EM.Hardware.V1.ICameraApi.GetAcquisitionStatus(System.String) returns ZenApi.EM.Hardware.V1.AcquisitionStatus.LiveRunning.

DetectorServiceBase

Bases: ServiceBase

Methods:

• get_available_detectors –

  Retrieves a list of all available detectors of the system.

• get_brightness –

  Retrieves the brightness value applied to a specific detector in percentage.

• get_contrast –

  Retrieves the contrast value applied to a specific detector in percentage.

• register_on_brightness_changed –

  Registers a subscriber on brightness changes of a specific detector.

• register_on_contrast_changed –

  Registers a subscriber on contrast changes of a specific detector.

• set_brightness –

  Applies a brightness value to a specified detector.

• set_contrast –

  Applies a contrast value to a specified detector.

get_available_detectors async

get_available_detectors(detector_service_get_available_detectors_request: DetectorServiceGetAvailableDetectorsRequest) -> DetectorServiceGetAvailableDetectorsResponse

Retrieves a list of all available detectors of the system. Their name serves as an identifier for this API service.

get_brightness async

get_brightness(detector_service_get_brightness_request: DetectorServiceGetBrightnessRequest) -> DetectorServiceGetBrightnessResponse

Retrieves the brightness value applied to a specific detector in percentage.

get_contrast async

get_contrast(detector_service_get_contrast_request: DetectorServiceGetContrastRequest) -> DetectorServiceGetContrastResponse

Retrieves the contrast value applied to a specific detector in percentage.

register_on_brightness_changed async

register_on_brightness_changed(detector_service_register_on_brightness_changed_request: DetectorServiceRegisterOnBrightnessChangedRequest) -> AsyncIterator[DetectorServiceRegisterOnBrightnessChangedResponse]

Registers a subscriber on brightness changes of a specific detector.

register_on_contrast_changed async

register_on_contrast_changed(detector_service_register_on_contrast_changed_request: DetectorServiceRegisterOnContrastChangedRequest) -> AsyncIterator[DetectorServiceRegisterOnContrastChangedResponse]

Registers a subscriber on contrast changes of a specific detector.

set_brightness async

set_brightness(detector_service_set_brightness_request: DetectorServiceSetBrightnessRequest) -> DetectorServiceSetBrightnessResponse

Applies a brightness value to a specified detector. The brightness value is applied immediately and has to be in [0, 1].

set_contrast async

set_contrast(detector_service_set_contrast_request: DetectorServiceSetContrastRequest) -> DetectorServiceSetContrastResponse

Applies a contrast value to a specified detector. The contrast value is applied immediately and has to be in [0, 1].

ElectronColumnServiceBase

Bases: ServiceBase

Methods:

• get_actual_voltage –

  Retrieves the current eht/voltage.

• get_aperture_align –

  Gets the aperture align in percentage.

• get_beam_blanker_state –

  Gets the beam blanker state.

• get_beam_shift –

  Gets the current beam shift in meters.

• get_beam_shift_limits –

  Gets the limits of the beam shiftin meters.

• get_beam_state –

  Retrieves the current beam working state.

• get_booster_voltage –

  Gets the booster voltage in volts.

• get_eht_offset –

  Gets the eht offset in volts.

• get_eht_offset_limits –

  Gets the limits of the eht offset in volts.

• get_focus –

  Gets the current focus (working distance) in meters.

• get_focus_limits –

  Gets the limits of the current focus (working distance) in meters.

• get_fov –

  Retrieves the current Field Of View.

• get_fov_limits –

  Gets the limits of the Field Of View in meters.

• get_fov_rotation –

  Gets the rotation of the Field Of View.

• get_fov_rotation_limits –

  Gets the limits of the Field Of View rotation in radians.

• get_objective_current –

  Gets the objective current in amperes. The objective current controls the strength of the magnetic field of the lens.

• get_probe_current –

  Get the probe current.

• get_semi_angle –

  Gets the current semi angle in radians.

• get_spot_size –

  Gets the spot size in meters.

• get_stigmator –

  Gets the current stigmator x and y values in percent [0, 1].

• get_target_voltage –

  Retrieves the target eht/voltage.

• get_voltage_limits –

  Gets the limits of the voltage (EHT) in volts.

• go_to_standby –

  Bring the column into standby mode.

• register_on_aperture_align_changed –

  Register on aperture align changed events.

• register_on_beam_blanker_state_changed –

  Register on the beam blanker state changed events.

• register_on_beam_shift_changed –

  Register on column beam shift changed events.

• register_on_beam_state_changed –

  Register on beam state changed events.

• register_on_focus_changed –

  Register on column focus (working distance) changed events.

• register_on_fov_changed –

  Register on column FOV changed events.

• register_on_fov_rotation_changed –

  Register on FOV rotation changed events.

• register_on_probe_current_changed –

  Register on column probe current changed events.

• register_on_semi_angle_changed –

  Register on column semi angle changed events.

• register_on_spot_size_changed –

  Register on beam spot size changed events.

• register_on_stigmator_changed –

  Register on stigmator x and y changed events.

• register_on_voltage_changed –

  Register on column (current/actual) eht/voltage changed events.

• set_aperture_align –

  Sets the eht offset.

• set_beam_blanker_state –

  Sets the beam blanker state.

• set_beam_shift –

  Set the beam shift of this column.

• set_eht_offset –

  Sets the eht offset.

• set_focus –

  Applies a new focus (working distance) to the column.

• set_fov –

  Applies a new FOV.

• set_fov_rotation –

  Rotates the Field Of View.

• set_objective_current –

  Sets the objective current, that controlls the strength of the magnetic field of the lens.

• set_probe_current –

  Set the probe current.

• set_stigmator –

  Applies a new stigmator x and / or y value to the column.

• set_voltage –

  Applies a new target eht/voltage to the column.

• turn_off –

  Turns the column off.

• turn_on –

  Bring the column into working mode.

get_actual_voltage async

get_actual_voltage(electron_column_service_get_actual_voltage_request: ElectronColumnServiceGetActualVoltageRequest) -> ElectronColumnServiceGetActualVoltageResponse

Retrieves the current eht/voltage.

get_aperture_align async

get_aperture_align(electron_column_service_get_aperture_align_request: ElectronColumnServiceGetApertureAlignRequest) -> ElectronColumnServiceGetApertureAlignResponse

Gets the aperture align in percentage.

get_beam_blanker_state async

get_beam_blanker_state(electron_column_service_get_beam_blanker_state_request: ElectronColumnServiceGetBeamBlankerStateRequest) -> ElectronColumnServiceGetBeamBlankerStateResponse

Gets the beam blanker state.

get_beam_shift async

get_beam_shift(electron_column_service_get_beam_shift_request: ElectronColumnServiceGetBeamShiftRequest) -> ElectronColumnServiceGetBeamShiftResponse

Gets the current beam shift in meters.

get_beam_shift_limits async

get_beam_shift_limits(electron_column_service_get_beam_shift_limits_request: ElectronColumnServiceGetBeamShiftLimitsRequest) -> ElectronColumnServiceGetBeamShiftLimitsResponse

Gets the limits of the beam shiftin meters.

get_beam_state async

get_beam_state(electron_column_service_get_beam_state_request: ElectronColumnServiceGetBeamStateRequest) -> ElectronColumnServiceGetBeamStateResponse

Retrieves the current beam working state.

get_booster_voltage async

get_booster_voltage(electron_column_service_get_booster_voltage_request: ElectronColumnServiceGetBoosterVoltageRequest) -> ElectronColumnServiceGetBoosterVoltageResponse

Gets the booster voltage in volts.

get_eht_offset async

get_eht_offset(electron_column_service_get_eht_offset_request: ElectronColumnServiceGetEhtOffsetRequest) -> ElectronColumnServiceGetEhtOffsetResponse

Gets the eht offset in volts.

get_eht_offset_limits async

get_eht_offset_limits(electron_column_service_get_eht_offset_limits_request: ElectronColumnServiceGetEhtOffsetLimitsRequest) -> ElectronColumnServiceGetEhtOffsetLimitsResponse

Gets the limits of the eht offset in volts.

get_focus async

get_focus(electron_column_service_get_focus_request: ElectronColumnServiceGetFocusRequest) -> ElectronColumnServiceGetFocusResponse

Gets the current focus (working distance) in meters.

get_focus_limits async

get_focus_limits(electron_column_service_get_focus_limits_request: ElectronColumnServiceGetFocusLimitsRequest) -> ElectronColumnServiceGetFocusLimitsResponse

Gets the limits of the current focus (working distance) in meters.

get_fov async

get_fov(electron_column_service_get_fov_request: ElectronColumnServiceGetFovRequest) -> ElectronColumnServiceGetFovResponse

Retrieves the current Field Of View.

get_fov_limits async

get_fov_limits(electron_column_service_get_fov_limits_request: ElectronColumnServiceGetFovLimitsRequest) -> ElectronColumnServiceGetFovLimitsResponse

Gets the limits of the Field Of View in meters.

get_fov_rotation async

get_fov_rotation(electron_column_service_get_fov_rotation_request: ElectronColumnServiceGetFovRotationRequest) -> ElectronColumnServiceGetFovRotationResponse

Gets the rotation of the Field Of View.

get_fov_rotation_limits async

get_fov_rotation_limits(electron_column_service_get_fov_rotation_limits_request: ElectronColumnServiceGetFovRotationLimitsRequest) -> ElectronColumnServiceGetFovRotationLimitsResponse

Gets the limits of the Field Of View rotation in radians.

get_objective_current async

get_objective_current(electron_column_service_get_objective_current_request: ElectronColumnServiceGetObjectiveCurrentRequest) -> ElectronColumnServiceGetObjectiveCurrentResponse

Gets the objective current in amperes. The objective current controls the strength of the magnetic field of the lens.

get_probe_current async

get_probe_current(electron_column_service_get_probe_current_request: ElectronColumnServiceGetProbeCurrentRequest) -> ElectronColumnServiceGetProbeCurrentResponse

Get the probe current.

get_semi_angle async

get_semi_angle(electron_column_service_get_semi_angle_request: ElectronColumnServiceGetSemiAngleRequest) -> ElectronColumnServiceGetSemiAngleResponse

Gets the current semi angle in radians.

get_spot_size async

get_spot_size(electron_column_service_get_spot_size_request: ElectronColumnServiceGetSpotSizeRequest) -> ElectronColumnServiceGetSpotSizeResponse

Gets the spot size in meters.

get_stigmator async

get_stigmator(electron_column_service_get_stigmator_request: ElectronColumnServiceGetStigmatorRequest) -> ElectronColumnServiceGetStigmatorResponse

Gets the current stigmator x and y values in percent [0, 1].

get_target_voltage async

get_target_voltage(electron_column_service_get_target_voltage_request: ElectronColumnServiceGetTargetVoltageRequest) -> ElectronColumnServiceGetTargetVoltageResponse

Retrieves the target eht/voltage.

get_voltage_limits async

get_voltage_limits(electron_column_service_get_voltage_limits_request: ElectronColumnServiceGetVoltageLimitsRequest) -> ElectronColumnServiceGetVoltageLimitsResponse

Gets the limits of the voltage (EHT) in volts.

go_to_standby async

go_to_standby(electron_column_service_go_to_standby_request: ElectronColumnServiceGoToStandbyRequest) -> ElectronColumnServiceGoToStandbyResponse

Bring the column into standby mode. This call triggers the column to go into standby mode. Emission will still be on.

register_on_aperture_align_changed async

register_on_aperture_align_changed(electron_column_service_register_on_aperture_align_changed_request: ElectronColumnServiceRegisterOnApertureAlignChangedRequest) -> AsyncIterator[ElectronColumnServiceRegisterOnApertureAlignChangedResponse]

Register on aperture align changed events.

register_on_beam_blanker_state_changed async

register_on_beam_blanker_state_changed(electron_column_service_register_on_beam_blanker_state_changed_request: ElectronColumnServiceRegisterOnBeamBlankerStateChangedRequest) -> AsyncIterator[ElectronColumnServiceRegisterOnBeamBlankerStateChangedResponse]

Register on the beam blanker state changed events.

register_on_beam_shift_changed async

register_on_beam_shift_changed(electron_column_service_register_on_beam_shift_changed_request: ElectronColumnServiceRegisterOnBeamShiftChangedRequest) -> AsyncIterator[ElectronColumnServiceRegisterOnBeamShiftChangedResponse]

Register on column beam shift changed events.

register_on_beam_state_changed async

register_on_beam_state_changed(electron_column_service_register_on_beam_state_changed_request: ElectronColumnServiceRegisterOnBeamStateChangedRequest) -> AsyncIterator[ElectronColumnServiceRegisterOnBeamStateChangedResponse]

Register on beam state changed events.

register_on_focus_changed async

register_on_focus_changed(electron_column_service_register_on_focus_changed_request: ElectronColumnServiceRegisterOnFocusChangedRequest) -> AsyncIterator[ElectronColumnServiceRegisterOnFocusChangedResponse]

Register on column focus (working distance) changed events.

register_on_fov_changed async

register_on_fov_changed(electron_column_service_register_on_fov_changed_request: ElectronColumnServiceRegisterOnFovChangedRequest) -> AsyncIterator[ElectronColumnServiceRegisterOnFovChangedResponse]

Register on column FOV changed events.

register_on_fov_rotation_changed async

register_on_fov_rotation_changed(electron_column_service_register_on_fov_rotation_changed_request: ElectronColumnServiceRegisterOnFovRotationChangedRequest) -> AsyncIterator[ElectronColumnServiceRegisterOnFovRotationChangedResponse]

Register on FOV rotation changed events.

register_on_probe_current_changed async

register_on_probe_current_changed(electron_column_service_register_on_probe_current_changed_request: ElectronColumnServiceRegisterOnProbeCurrentChangedRequest) -> AsyncIterator[ElectronColumnServiceRegisterOnProbeCurrentChangedResponse]

Register on column probe current changed events.

register_on_semi_angle_changed async

register_on_semi_angle_changed(electron_column_service_register_on_semi_angle_changed_request: ElectronColumnServiceRegisterOnSemiAngleChangedRequest) -> AsyncIterator[ElectronColumnServiceRegisterOnSemiAngleChangedResponse]

Register on column semi angle changed events.

register_on_spot_size_changed async

register_on_spot_size_changed(electron_column_service_register_on_spot_size_changed_request: ElectronColumnServiceRegisterOnSpotSizeChangedRequest) -> AsyncIterator[ElectronColumnServiceRegisterOnSpotSizeChangedResponse]

Register on beam spot size changed events.

register_on_stigmator_changed async

register_on_stigmator_changed(electron_column_service_register_on_stigmator_changed_request: ElectronColumnServiceRegisterOnStigmatorChangedRequest) -> AsyncIterator[ElectronColumnServiceRegisterOnStigmatorChangedResponse]

Register on stigmator x and y changed events.

register_on_voltage_changed async

register_on_voltage_changed(electron_column_service_register_on_voltage_changed_request: ElectronColumnServiceRegisterOnVoltageChangedRequest) -> AsyncIterator[ElectronColumnServiceRegisterOnVoltageChangedResponse]

Register on column (current/actual) eht/voltage changed events.

set_aperture_align async

set_aperture_align(electron_column_service_set_aperture_align_request: ElectronColumnServiceSetApertureAlignRequest) -> ElectronColumnServiceSetApertureAlignResponse

Sets the eht offset.

set_beam_blanker_state async

set_beam_blanker_state(electron_column_service_set_beam_blanker_state_request: ElectronColumnServiceSetBeamBlankerStateRequest) -> ElectronColumnServiceSetBeamBlankerStateResponse

Sets the beam blanker state.

set_beam_shift async

set_beam_shift(electron_column_service_set_beam_shift_request: ElectronColumnServiceSetBeamShiftRequest) -> ElectronColumnServiceSetBeamShiftResponse

Set the beam shift of this column. Values can be null if they should not be updated.

set_eht_offset async

set_eht_offset(electron_column_service_set_eht_offset_request: ElectronColumnServiceSetEhtOffsetRequest) -> ElectronColumnServiceSetEhtOffsetResponse

Sets the eht offset.

set_focus async

set_focus(electron_column_service_set_focus_request: ElectronColumnServiceSetFocusRequest) -> ElectronColumnServiceSetFocusResponse

Applies a new focus (working distance) to the column.

set_fov async

set_fov(electron_column_service_set_fov_request: ElectronColumnServiceSetFovRequest) -> ElectronColumnServiceSetFovResponse

Applies a new FOV.

set_fov_rotation async

set_fov_rotation(electron_column_service_set_fov_rotation_request: ElectronColumnServiceSetFovRotationRequest) -> ElectronColumnServiceSetFovRotationResponse

Rotates the Field Of View. If scan rotation is not enabled, it would be enabled.

set_objective_current async

set_objective_current(electron_column_service_set_objective_current_request: ElectronColumnServiceSetObjectiveCurrentRequest) -> ElectronColumnServiceSetObjectiveCurrentResponse

Sets the objective current, that controlls the strength of the magnetic field of the lens.

set_probe_current async

set_probe_current(electron_column_service_set_probe_current_request: ElectronColumnServiceSetProbeCurrentRequest) -> ElectronColumnServiceSetProbeCurrentResponse

Set the probe current.

set_stigmator async

set_stigmator(electron_column_service_set_stigmator_request: ElectronColumnServiceSetStigmatorRequest) -> ElectronColumnServiceSetStigmatorResponse

Applies a new stigmator x and / or y value to the column.

set_voltage async

set_voltage(electron_column_service_set_voltage_request: ElectronColumnServiceSetVoltageRequest) -> ElectronColumnServiceSetVoltageResponse

Applies a new target eht/voltage to the column.

turn_off async

turn_off(electron_column_service_turn_off_request: ElectronColumnServiceTurnOffRequest) -> ElectronColumnServiceTurnOffResponse

Turns the column off. This call initiates ramping down of emission and brings the column into off state.

turn_on async

turn_on(electron_column_service_turn_on_request: ElectronColumnServiceTurnOnRequest) -> ElectronColumnServiceTurnOnResponse

Bring the column into working mode. This call initiates ramping of emission and brings the column into working condition.

EmStageServiceBase

Bases: ServiceBase

Methods:

• get_axis_backlash_mode –

  Gets the backlash mode for a specific stage axis.

• get_axis_limits –

  Gets the position limits (minimum and maximum) for a specific stage axis.

• get_axis_user_limits –

  Gets the User limits (upper and lower) for a specific stage axis.

• get_axis_velocity_limits –

  Gets the velocity limits (minimum and maximum) for a specific stage axis.

• get_stage_backlash_modes –

  Gets the backlash modes for all available stage axes.

• get_stage_fast –

  Gets the stage fast status.

• get_stage_limits –

  Gets the position limits for all available stage axes.

• get_stage_user_limits –

  Gets the User limits for all available stage axes.

• get_stage_velocity_limits –

  Gets the velocity limits for all available stage axes.

• set_axis_backlash_mode –

  Sets the backlash mode for a specific stage axis.

• set_axis_user_limits –

  Sets the User limits for a specific stage axis.

• set_axis_velocity –

  Sets the target velocity for a specific stage axis.

• set_stage_backlash_modes –

  Sets the backlash modes for multiple stage axes.

• set_stage_fast –

  Applies a new stage fast status.

• set_stage_user_limits –

  Sets the User limits for multiple stage axes.

get_axis_backlash_mode async

get_axis_backlash_mode(em_stage_service_get_axis_backlash_mode_request: EmStageServiceGetAxisBacklashModeRequest) -> StageServiceGetAxisBacklashModeResponse

Gets the backlash mode for a specific stage axis.

get_axis_limits async

get_axis_limits(em_stage_service_get_axis_limits_request: EmStageServiceGetAxisLimitsRequest) -> StageServiceGetAxisLimitsResponse

Gets the position limits (minimum and maximum) for a specific stage axis.

get_axis_user_limits async

get_axis_user_limits(em_stage_service_get_axis_user_limits_request: EmStageServiceGetAxisUserLimitsRequest) -> StageServiceGetAxisUserLimitsResponse

Gets the User limits (upper and lower) for a specific stage axis.

get_axis_velocity_limits async

get_axis_velocity_limits(em_stage_service_get_axis_velocity_limits_request: EmStageServiceGetAxisVelocityLimitsRequest) -> StageServiceGetAxisVelocityLimitsResponse

Gets the velocity limits (minimum and maximum) for a specific stage axis.

get_stage_backlash_modes async

get_stage_backlash_modes(em_stage_service_get_stage_backlash_modes_request: EmStageServiceGetStageBacklashModesRequest) -> StageServiceGetStageBacklashModesResponse

Gets the backlash modes for all available stage axes.

get_stage_fast async

get_stage_fast(em_stage_service_get_stage_fast_request: EmStageServiceGetStageFastRequest) -> StageServiceGetStageFastResponse

Gets the stage fast status.

get_stage_limits async

get_stage_limits(em_stage_service_get_stage_limits_request: EmStageServiceGetStageLimitsRequest) -> StageServiceGetStageLimitsResponse

Gets the position limits for all available stage axes.

get_stage_user_limits async

get_stage_user_limits(em_stage_service_get_stage_user_limits_request: EmStageServiceGetStageUserLimitsRequest) -> StageServiceGetStageUserLimitsResponse

Gets the User limits for all available stage axes.

get_stage_velocity_limits async

get_stage_velocity_limits(em_stage_service_get_stage_velocity_limits_request: EmStageServiceGetStageVelocityLimitsRequest) -> StageServiceGetStageVelocityLimitsResponse

Gets the velocity limits for all available stage axes.

set_axis_backlash_mode async

set_axis_backlash_mode(em_stage_service_set_axis_backlash_mode_request: EmStageServiceSetAxisBacklashModeRequest) -> StageServiceSetAxisBacklashModeResponse

Sets the backlash mode for a specific stage axis.

set_axis_user_limits async

set_axis_user_limits(em_stage_service_set_axis_user_limits_request: EmStageServiceSetAxisUserLimitsRequest) -> StageServiceSetAxisUserLimitsResponse

Sets the User limits for a specific stage axis.

set_axis_velocity async

set_axis_velocity(em_stage_service_set_axis_velocity_request: EmStageServiceSetAxisVelocityRequest) -> StageServiceSetAxisVelocityResponse

Sets the target velocity for a specific stage axis.

set_stage_backlash_modes async

set_stage_backlash_modes(em_stage_service_set_stage_backlash_modes_request: EmStageServiceSetStageBacklashModesRequest) -> StageServiceSetStageBacklashModesResponse

Sets the backlash modes for multiple stage axes.

set_stage_fast async

set_stage_fast(em_stage_service_set_stage_fast_request: EmStageServiceSetStageFastRequest) -> StageServiceSetStageFastResponse

Applies a new stage fast status.

set_stage_user_limits async

set_stage_user_limits(em_stage_service_set_stage_user_limits_request: EmStageServiceSetStageUserLimitsRequest) -> StageServiceSetStageUserLimitsResponse

Sets the User limits for multiple stage axes.

ExternalProcedureServiceBase

Bases: ServiceBase

Methods:

• register_external_procedure –

  Registers the caller to get notified about ZenApi.EM.Hardware.V1.ExternalProcedureServiceRegisterExternalProcedureResponse's

• report_command_failure –

  Reports the failure of execution of the given ZenApi.EM.Hardware.V1.ExternalProcedureServiceRegisterExternalProcedureResponse.

• report_command_success –

  Reports the successful execution of the given ZenApi.EM.Hardware.V1.ExternalProcedureServiceRegisterExternalProcedureResponse.

• report_initialization_error –

  Reports an error that has occurred during the initialization of an external procedure, leads to error state.

• report_progress –

  reports the progress of the external procedure with the given id.

• report_ready –

  Reports, that the external procedure with the given id is ready to be executed.

• report_status –

  reports a status message to zen.

register_external_procedure async

register_external_procedure(external_procedure_service_register_external_procedure_request: ExternalProcedureServiceRegisterExternalProcedureRequest) -> AsyncIterator[ExternalProcedureServiceRegisterExternalProcedureResponse]

Registers the caller to get notified about ZenApi.EM.Hardware.V1.ExternalProcedureServiceRegisterExternalProcedureResponse's (for all external procedures; filtering must be done by the caller).

report_command_failure async

report_command_failure(external_procedure_service_report_command_failure_request: ExternalProcedureServiceReportCommandFailureRequest) -> ExternalProcedureServiceReportCommandFailureResponse

Reports the failure of execution of the given ZenApi.EM.Hardware.V1.ExternalProcedureServiceRegisterExternalProcedureResponse.

report_command_success async

report_command_success(external_procedure_service_report_command_success_request: ExternalProcedureServiceReportCommandSuccessRequest) -> ExternalProcedureServiceReportCommandSuccessResponse

Reports the successful execution of the given ZenApi.EM.Hardware.V1.ExternalProcedureServiceRegisterExternalProcedureResponse.

report_initialization_error async

report_initialization_error(external_procedure_service_report_initialization_error_request: ExternalProcedureServiceReportInitializationErrorRequest) -> ExternalProcedureServiceReportInitializationErrorResponse

Reports an error that has occurred during the initialization of an external procedure, leads to error state.

report_progress async

report_progress(external_procedure_service_report_progress_request: ExternalProcedureServiceReportProgressRequest) -> ExternalProcedureServiceReportProgressResponse

reports the progress of the external procedure with the given id.

report_ready async

report_ready(external_procedure_service_report_ready_request: ExternalProcedureServiceReportReadyRequest) -> ExternalProcedureServiceReportReadyResponse

Reports, that the external procedure with the given id is ready to be executed.

report_status async

report_status(external_procedure_service_report_status_request: ExternalProcedureServiceReportStatusRequest) -> ExternalProcedureServiceReportStatusResponse

reports a status message to zen.

IlluminationServiceBase

Bases: ServiceBase

Methods:

• get_illumination_ir –

  Gets the illumination IR value. Returns the current illumination IR value [0..100]%.

• get_illumination_white –

  Gets the illumination white value. Returns the current illumination white value [0..100]%.

• register_on_illumination_ir_changed –

  Registers a subscriber on illumination IR changes. returns the current illumination IR value [0..100]%.

• register_on_illumination_white_changed –

  Registers a subscriber on illumination white changes. Returns the current illumination white value [0..100]%.

• set_illumination_ir –

  Sets the illumination IR value. Returns the current illumination IR value [0..100]%.

• set_illumination_white –

  Sets the illumination white value. Returns the current illumination white value [0..100]%.

get_illumination_ir async

get_illumination_ir(illumination_service_get_illumination_ir_request: IlluminationServiceGetIlluminationIrRequest) -> IlluminationServiceGetIlluminationIrResponse

Gets the illumination IR value. Returns the current illumination IR value [0..100]%.

get_illumination_white async

get_illumination_white(illumination_service_get_illumination_white_request: IlluminationServiceGetIlluminationWhiteRequest) -> IlluminationServiceGetIlluminationWhiteResponse

Gets the illumination white value. Returns the current illumination white value [0..100]%.

register_on_illumination_ir_changed async

register_on_illumination_ir_changed(illumination_service_register_on_illumination_ir_changed_request: IlluminationServiceRegisterOnIlluminationIrChangedRequest) -> AsyncIterator[IlluminationServiceRegisterOnIlluminationIrChangedResponse]

Registers a subscriber on illumination IR changes. returns the current illumination IR value [0..100]%.

register_on_illumination_white_changed async

register_on_illumination_white_changed(illumination_service_register_on_illumination_white_changed_request: IlluminationServiceRegisterOnIlluminationWhiteChangedRequest) -> AsyncIterator[IlluminationServiceRegisterOnIlluminationWhiteChangedResponse]

Registers a subscriber on illumination white changes. Returns the current illumination white value [0..100]%.

set_illumination_ir async

set_illumination_ir(illumination_service_set_illumination_ir_request: IlluminationServiceSetIlluminationIrRequest) -> IlluminationServiceSetIlluminationIrResponse

Sets the illumination IR value. Returns the current illumination IR value [0..100]%.

set_illumination_white async

set_illumination_white(illumination_service_set_illumination_white_request: IlluminationServiceSetIlluminationWhiteRequest) -> IlluminationServiceSetIlluminationWhiteResponse

Sets the illumination white value. Returns the current illumination white value [0..100]%.

SimpleAcquisitionServiceBase

Bases: ServiceBase

Methods:

• acquire_extended_single_frame –

  Call to start single channel acquisition of a single frame with given settings.

• acquire_single_frame –

  Call to start single channel acquisition of a single frame with given settings.

• change_dwell_time –

  Changes the dwell time for any ongoing acquisition task.

• get_acquisition_status –

  Retrieves the current state of the acquisition hardware.

• get_brightness –

  Retrieves the brightness value applied to a specific detector in percentage.

• get_contrast –

  Retrieves the contrast value applied to a specific detector in percentage.

• register_on_acquisition_status_changed –

  Subscribes to acquisition status changed events.

• set_brightness –

  Applies a brightness value to a specified detector.

• set_contrast –

  Applies a contrast value to a specified detector.

• start_extended_live_acquisition –

  This starts a live single channel acquisition with the given settings.

• start_live_acquisition –

  This starts a live single channel acquisition with the given settings.

• stop_live_acquisition –

  Stops any ongoing live acquisition.

acquire_extended_single_frame async

acquire_extended_single_frame(simple_acquisition_service_acquire_extended_single_frame_request: SimpleAcquisitionServiceAcquireExtendedSingleFrameRequest) -> SimpleAcquisitionServiceAcquireExtendedSingleFrameResponse

Call to start single channel acquisition of a single frame with given settings. The task returned represents the ongoing acquisition. The resulting image is send once the acquisition completed.

acquire_single_frame async

acquire_single_frame(simple_acquisition_service_acquire_single_frame_request: SimpleAcquisitionServiceAcquireSingleFrameRequest) -> SimpleAcquisitionServiceAcquireSingleFrameResponse

Call to start single channel acquisition of a single frame with given settings. The task returned represents the ongoing acquisition. The resulting image is send once the acquisition completed.

change_dwell_time async

change_dwell_time(simple_acquisition_service_change_dwell_time_request: SimpleAcquisitionServiceChangeDwellTimeRequest) -> SimpleAcquisitionServiceChangeDwellTimeResponse

Changes the dwell time for any ongoing acquisition task.

get_acquisition_status async

get_acquisition_status(simple_acquisition_service_get_acquisition_status_request: SimpleAcquisitionServiceGetAcquisitionStatusRequest) -> SimpleAcquisitionServiceGetAcquisitionStatusResponse

Retrieves the current state of the acquisition hardware. Allows to deduce if the hardware is available for a new acquisition, is blocked by some other task, or acquires currently images.

get_brightness async

get_brightness(simple_acquisition_service_get_brightness_request: SimpleAcquisitionServiceGetBrightnessRequest) -> SimpleAcquisitionServiceGetBrightnessResponse

Retrieves the brightness value applied to a specific detector in percentage.

get_contrast async

get_contrast(simple_acquisition_service_get_contrast_request: SimpleAcquisitionServiceGetContrastRequest) -> SimpleAcquisitionServiceGetContrastResponse

Retrieves the contrast value applied to a specific detector in percentage.

register_on_acquisition_status_changed async

register_on_acquisition_status_changed(simple_acquisition_service_register_on_acquisition_status_changed_request: SimpleAcquisitionServiceRegisterOnAcquisitionStatusChangedRequest) -> AsyncIterator[SimpleAcquisitionServiceRegisterOnAcquisitionStatusChangedResponse]

Subscribes to acquisition status changed events.

set_brightness async

set_brightness(simple_acquisition_service_set_brightness_request: SimpleAcquisitionServiceSetBrightnessRequest) -> SimpleAcquisitionServiceSetBrightnessResponse

Applies a brightness value to a specified detector. The brightness value is applied immediately and has to be in [0, 1].

set_contrast async

set_contrast(simple_acquisition_service_set_contrast_request: SimpleAcquisitionServiceSetContrastRequest) -> SimpleAcquisitionServiceSetContrastResponse

Applies a contrast value to a specified detector. The contrast value is applied immediately and has to be in [0, 1].

start_extended_live_acquisition async

start_extended_live_acquisition(simple_acquisition_service_start_extended_live_acquisition_request: SimpleAcquisitionServiceStartExtendedLiveAcquisitionRequest) -> SimpleAcquisitionServiceStartExtendedLiveAcquisitionResponse

This starts a live single channel acquisition with the given settings.

start_live_acquisition async

start_live_acquisition(simple_acquisition_service_start_live_acquisition_request: SimpleAcquisitionServiceStartLiveAcquisitionRequest) -> SimpleAcquisitionServiceStartLiveAcquisitionResponse

This starts a live single channel acquisition with the given settings.

stop_live_acquisition async

stop_live_acquisition(simple_acquisition_service_stop_live_acquisition_request: SimpleAcquisitionServiceStopLiveAcquisitionRequest) -> SimpleAcquisitionServiceStopLiveAcquisitionResponse

Stops any ongoing live acquisition. Has only an effect if ZenApi.EM.Hardware.V1.ISimpleAcquisitionApi.GetAcquisitionStatus returns ZenApi.EM.Hardware.V1.AcquisitionStatus.LiveRunning.

SpecimenCurrentMonitorServiceBase

Bases: ServiceBase

Methods:

• get_specimen_current –

  Gets the current specimen current in amperes.

• register_on_specimen_current_changed –

  Register on specimen current changed events.

get_specimen_current async

get_specimen_current(specimen_current_monitor_service_get_specimen_current_request: SpecimenCurrentMonitorServiceGetSpecimenCurrentRequest) -> SpecimenCurrentMonitorServiceGetSpecimenCurrentResponse

Gets the current specimen current in amperes.

register_on_specimen_current_changed async

register_on_specimen_current_changed(specimen_current_monitor_service_register_on_specimen_current_changed_request: SpecimenCurrentMonitorServiceRegisterOnSpecimenCurrentChangedRequest) -> AsyncIterator[SpecimenCurrentMonitorServiceRegisterOnSpecimenCurrentChangedResponse]

Register on specimen current changed events.

VacuumServiceBase

Bases: ServiceBase

Methods:

• close_valve –

  Closes a valve on the system.

• get_available_vacuum_modes –

  Retrieves a collection of available vacuum modes, like HV and VP.

• get_available_valves –

  Retrieves all available valves of the system that can be controlled.

• get_chamber_pressure –

  Retrieves the current chamber pressure in [pascal].

• get_target_chamber_pressure –

  Retrieves the target chamber pressure for ZenApi.EM.Hardware.V1.VacuumMode.VariablePressure mode.

• get_vacuum_mode –

  Retrieves the currently active Vacuum Mode.

• get_vacuum_state –

  Retrieves the current vacuum state.

• get_valve_state –

  Retrieves the current state of a valve.

• open_valve –

  Opens a valve on the system.

• pump –

  Starts the pumping process to evacuate the chamber and install a stable vacuum.

• register_on_chamber_pressure_changed –

  Notifications on chamber pressure. Events are fired every time the current chamber pressure changes.

• register_on_target_chamber_pressure_changed –

  Notifications about changes to the target chamber pressure value.

• register_on_vacuum_mode_changed –

  Notification about changes of the active vacuum mode.

• register_on_vacuum_state_changed –

  Notification about changes of the vacuum system state.

• register_on_valve_state_changed –

  Notifications about any valves state changes.

• set_target_chamber_pressure –

  Sets and if in ZenApi.EM.Hardware.V1.VacuumMode.VariablePressure also applies a new

• set_vacuum_mode –

  Sets the active vacuum mode.

• vent –

  Starts the venting process to vent the chamber and allow the chamber door to be opened.

close_valve async

close_valve(vacuum_service_close_valve_request: VacuumServiceCloseValveRequest) -> VacuumServiceCloseValveResponse

Closes a valve on the system.

get_available_vacuum_modes async

get_available_vacuum_modes(vacuum_service_get_available_vacuum_modes_request: VacuumServiceGetAvailableVacuumModesRequest) -> VacuumServiceGetAvailableVacuumModesResponse

Retrieves a collection of available vacuum modes, like HV and VP. Available modes depend on the tool configuration and don't change during runtime. Note: TargetChamberPressure functionality is only working for VP mode.

get_available_valves async

get_available_valves(vacuum_service_get_available_valves_request: VacuumServiceGetAvailableValvesRequest) -> VacuumServiceGetAvailableValvesResponse

Retrieves all available valves of the system that can be controlled. Possible values are listed in ZenApi.EM.Hardware.V1.Valve enumeration.

get_chamber_pressure async

get_chamber_pressure(vacuum_service_get_chamber_pressure_request: VacuumServiceGetChamberPressureRequest) -> VacuumServiceGetChamberPressureResponse

Retrieves the current chamber pressure in [pascal].

get_target_chamber_pressure async

get_target_chamber_pressure(vacuum_service_get_target_chamber_pressure_request: VacuumServiceGetTargetChamberPressureRequest) -> VacuumServiceGetTargetChamberPressureResponse

Retrieves the target chamber pressure for ZenApi.EM.Hardware.V1.VacuumMode.VariablePressure mode. Unspecified return value on non VP configurations.

get_vacuum_mode async

get_vacuum_mode(vacuum_service_get_vacuum_mode_request: VacuumServiceGetVacuumModeRequest) -> VacuumServiceGetVacuumModeResponse

Retrieves the currently active Vacuum Mode.

get_vacuum_state async

get_vacuum_state(vacuum_service_get_vacuum_state_request: VacuumServiceGetVacuumStateRequest) -> VacuumServiceGetVacuumStateResponse

Retrieves the current vacuum state.

get_valve_state async

get_valve_state(vacuum_service_get_valve_state_request: VacuumServiceGetValveStateRequest) -> VacuumServiceGetValveStateResponse

Retrieves the current state of a valve. Only states of available valves are defined. See ZenApi.EM.Hardware.V1.IVacuumApi.GetAvailableValves.

open_valve async

open_valve(vacuum_service_open_valve_request: VacuumServiceOpenValveRequest) -> VacuumServiceOpenValveResponse

Opens a valve on the system.

pump async

pump(vacuum_service_pump_request: VacuumServicePumpRequest) -> VacuumServicePumpResponse

Starts the pumping process to evacuate the chamber and install a stable vacuum.

register_on_chamber_pressure_changed async

register_on_chamber_pressure_changed(vacuum_service_register_on_chamber_pressure_changed_request: VacuumServiceRegisterOnChamberPressureChangedRequest) -> AsyncIterator[VacuumServiceRegisterOnChamberPressureChangedResponse]

Notifications on chamber pressure. Events are fired every time the current chamber pressure changes.

register_on_target_chamber_pressure_changed async

register_on_target_chamber_pressure_changed(vacuum_service_register_on_target_chamber_pressure_changed_request: VacuumServiceRegisterOnTargetChamberPressureChangedRequest) -> AsyncIterator[VacuumServiceRegisterOnTargetChamberPressureChangedResponse]

Notifications about changes to the target chamber pressure value. Only enabled on systems supporting ZenApi.EM.Hardware.V1.VacuumMode.VariablePressure mode.

register_on_vacuum_mode_changed async

register_on_vacuum_mode_changed(vacuum_service_register_on_vacuum_mode_changed_request: VacuumServiceRegisterOnVacuumModeChangedRequest) -> AsyncIterator[VacuumServiceRegisterOnVacuumModeChangedResponse]

Notification about changes of the active vacuum mode. See ZenApi.EM.Hardware.V1.VacuumMode.

register_on_vacuum_state_changed async

register_on_vacuum_state_changed(vacuum_service_register_on_vacuum_state_changed_request: VacuumServiceRegisterOnVacuumStateChangedRequest) -> AsyncIterator[VacuumServiceRegisterOnVacuumStateChangedResponse]

Notification about changes of the vacuum system state. See ZenApi.EM.Hardware.V1.VacuumState.

register_on_valve_state_changed async

register_on_valve_state_changed(vacuum_service_register_on_valve_state_changed_request: VacuumServiceRegisterOnValveStateChangedRequest) -> AsyncIterator[VacuumServiceRegisterOnValveStateChangedResponse]

Notifications about any valves state changes.

set_target_chamber_pressure async

set_target_chamber_pressure(vacuum_service_set_target_chamber_pressure_request: VacuumServiceSetTargetChamberPressureRequest) -> VacuumServiceSetTargetChamberPressureResponse

Sets and if in ZenApi.EM.Hardware.V1.VacuumMode.VariablePressure also applies a new chamber pressure.

set_vacuum_mode async

set_vacuum_mode(vacuum_service_set_vacuum_mode_request: VacuumServiceSetVacuumModeRequest) -> VacuumServiceSetVacuumModeResponse

Sets the active vacuum mode. No op if the vacuum mode does not change, otherwise the process to switch to the other vacuum mode is initiated.

vent async

vent(vacuum_service_vent_request: VacuumServiceVentRequest) -> VacuumServiceVentResponse

Starts the venting process to vent the chamber and allow the chamber door to be opened.