Types and exceptions¶

Public type literals (Motor, AI, DIO, Command), scan data structures, and domain exceptions.

type resonance.api.types.AI = Literal['TEY signal', 'Izero', 'Photodiode', 'AI 0', 'AI 3 Izero', 'AI 5', 'AI 6 BeamStop', 'AI 7', 'Deriv Photodiode', 'EPU Polarization', 'Coolstage Temp C', 'CCD Temperature', 'Beam Current', 'Temperature Controller', 'PZT Shutter', 'Pause Trigger', 'LV Memory', 'Time Stamp Error', 'Time Stamp Transmit Time', 'Time Stamp Server Time', 'Camera Temp Setpoint']¶

exception resonance.api.types.AcquisitionError[source]¶

Bases: RsoxsError

Data acquisition failed

type resonance.api.types.Command = Literal['None', 'Normal Move', 'Backlash Move', 'Velocity Move', 'Move to Home', 'Stop Motor', 'Set Position', 'Enable Motor', 'Disable Motor', 'Move to Index', 'Run Home Routine', 'Set Velocity', 'Set Acceleration', 'Set Deceleration', 'Enable and Move', 'Disable SW Limits', 'Enable SW Limits', 'Start Time Delay', 'Check Time Delay', 'Set Output Pulses', 'Backlash Jog', 'Normal Jog', 'Run Coord Program', 'Halt Coord Program', 'Gearing ON', 'Gearing OFF', 'Set Forward SW Limit', 'Set Reverse SW Limit', 'Revert Forward SW Limit', 'Revert Reverse SW Limit']¶

type resonance.api.types.DIO = Literal['Shutter Rev', 'Lightfiled Frame Loss', 'Nothing', 'Camera Scan', 'Shutter Output', 'Air Shutter Output', 'Light Output', 'Beam Dumped', 'PZT Shutter Status', 'Camera Shutter In', 'Do Pause Trigger', 'Trigger Pause Trigger', 'Shutter Inhibit', 'Trigger + Inhibit']¶

type resonance.api.types.Instrument = Literal['Axis Photonique']¶

type resonance.api.types.Motor = Literal['Sample Azimuthal Rotation', 'Piezo Vertical', 'Piezo Horiz', 'Sample X', 'Sample Y', 'Sample Z', 'Sample Theta', 'Sample Y Scaled', 'CCD Theta', 'Beam Stop', 'Pollux CCD X', 'Pollux CCD Y', 'CCD X', 'CCD Y', 'T-2T', 'Beamline Energy', 'Mono 101 Grating', 'Beamline Energy Goal', 'Entrance Slit width', 'Exit Slit Top', 'Exit Slit Bottom', 'Exit Slit Left', 'Exit Slit Right', 'Horizontal Exit Slit Size', 'Horizontal Exit Slit Position', 'Vertical Exit Slit Size', 'Vertical Exit Slit Position', 'EPU Gap', 'EPU Z', 'Mono Energy', 'EPU Polarization', 'M103 Yaw', 'M103 Bend Up', 'M103 Bend Down', 'M101 Feedback', 'M101 Horizontal Deflection', 'Entrance Slit Width', 'M101 Vertical Deflection', 'Vertical Slit Position', 'Vertical Slit Size', 'Horizontal Slit Position', 'Mono 101 Vessel', 'Horizontal Slit Size', 'Diag 106', 'M121 Translation', 'PiezoShutter Trans', 'PZT Shutter', 'Higher Order Suppressor', 'AO 0', 'AO 1', 'OSP Adjustment', 'CCD Shutter Control', 'Temperature Controller', 'Upstream JJ Vert Aperture', 'Upstream JJ Vert Trans', 'Upstream JJ Horz Aperture', 'Upstream JJ Horz Trans', 'Middle JJ Vert Aperture', 'Middle JJ Vert Trans', 'Middle JJ Horz Aperture', 'Middle JJ Horz Trans', 'In-Chamber JJ Vert Aperture', 'In-Chamber JJ Vert Trans', 'In-Chamber JJ Horz Aperture', 'In-Chamber JJ Horz Trans', 'Sample Number', 'Coolstage', 'MCS_axis0', 'MCS_axis1', 'MCS_axis2', 'MCS_axis3', 'MCS_axis4', 'Camera Temp Setpoint', 'CCD Camera Shutter Inhibit', 'Camera ROI X', 'Camera ROI Y', 'Camera ROI Width', 'Camera ROI Height', 'Camera ROI X Bin', 'Camera ROI Y Bin', 'SampleRot0', 'SampleRot1', 'SampleRot2', 'SampleRot3', 'SampleRot4']¶

exception resonance.api.types.MotorError[source]¶

Bases: RsoxsError

Motor operation failed

exception resonance.api.types.MotorTimeoutError[source]¶

Bases: MotorError

Motor move did not complete in time

exception resonance.api.types.RsoxsError[source]¶

Bases: Exception

Base exception for RSoXS operations

exception resonance.api.types.ScanAbortedError[source]¶

Bases: RsoxsError

Scan was aborted by user

class resonance.api.types.ScanPoint(index: int, motors: dict[str, float], exposure_time: float, ai_channels: list[str] | None = None, delay_after_move: float = 0.2)[source]¶

Bases: object

Single point in a scan trajectory

ai_channels: list[str] | None = None¶

delay_after_move: float = 0.2¶

exposure_time: float¶

index: int¶

motors: dict[str, float]¶

validate() → None[source]¶: Validate motor names and exposure time

class resonance.api.types.ScanResult(index: int, motors: dict[str, float], ai_data: dict[str, Variable], exposure_time: float, timestamp: float, raw_data: dict[str, list[float]], image: ndarray | None = None)[source]¶