TEMClient

version: 2024.10.14

class simple_tem.TEMClient(host, port=3535, verbose=True)

GetAlpha() → int

Get alpha number. 0-8

GetAperatureSize(index)

index : int aperture kind. 1= CLA, 2= OLA, 3= HCA, 4= SAA, 5= ENTA, 6= EDS

returns: Selected aperture’s hole number. 0= Open, 1-4= hole index

GetBeamBlank() → int

blanking status. 0=OFF, 1=ON

GetCL3() → int

CL3 value(0-65535).

GetFunctionMode() → list

(index, name) [On TEM Observation] 0=MAG, 1=MAG2, 2= LowMAG, 3= SAMAG, 4= DIFF [On STEM Observation] 0= Align, 1= SM-LMAG, 2= SM-MAG, 3= AMAG, 4= uuDIFF, 5= Rocking

GetIL1() → int

IL1 value(0-65535).

GetIL3() → int

IL3 value(0-65535).

GetILs()

Get ILStig value. this returns I/O output value. (x : int, y : int) 0-65535

GetMagValue() → list

Get magnification or camera length or rocking angle. returns (value, unit, name)

GetMovementValueMeasurementMethod()

Get movement amount measurement method (for Z/Tx/Ty). method. 0= encoder, 1= potens

GetOLc() → int

GetOLc value(0-65535).

GetOLf() → int

GetOLf value(0-65535).

GetPLA()

Get PLAlign value. this returns I/O output value. (x : int, y : int) 0-65535

GetSpotSize() → int

Get spot size number. 0-7

GetStagePosition()

Get motor position. it depends on the drive mode. (x : float, y : float, z : float, tiltx : float, tilty : float)

GetStageStatus() → list

Get stage driving status. 0= Rest, 1= Moving, 2= Hardware limiter error (x : int, y : int, z : int, tiltx : int, tilty : int).

GetTiltXAngle() → float

Get the Tilt angle, alias for StagePos[3]

Getf1OverRateTxNum()

Get drive frequency f1 of TiltX. 0= 10(/sec), 1= 2(/sec), 2= 1(/sec), 3= 0.5(/sec), 4= 0.25(/sec), 5= 0.1(/sec)

SelectFunctionMode(mode: int) → None

[On TEM Observation] 0=MAG, 1=MAG2, 2= LowMAG, 3= SAMAG, 4= DIFF [On STEM Observation] 0= Align, 1= SM-LMAG, 2= SM-MAG, 3= AMAG, 4= uuDIFF, 5= Rocking

SetBeamBlank(val) → None

blanking status. 0=OFF, 1=ON

SetILFocus(value) → None

Set IL-focus value(without MAG link). IL-focus value.(0-65535)

SetILs(stig_x: int, stig_y: int)

Set ILStig value. The variable corresponds to I/O output value. (x_axis : int, y_axis : int) 0-65535

SetSelector(value: int) → None

(int) mag or camera length or rocking angle number value.

SetTXRel(val: float) → None

Relative tilt around X axis. tilt-x relative value. range is +-90.00.0(degree)

SetTiltXAngle(val) → None

Set TiltX axis absolute value. range is +-90.00(degree)

SetXRel(val: float) → None

Relative move along Z axis. Range:+-100000.0(nm)

SetYRel(val: float) → None

Relative move along Z axis. Range:+-100000.0(nm)

SetZRel(val: float) → None

Relative move along Z axis. Range:+-100000.0(nm)

Setf1OverRateTxNum(val) → None

Set drive frequency f1 of TiltX.

StopStage() → None

Stop all the drives.

UnknownFunction()

Calls an unknown function on the server side. Testing only

check_version()

property client_version: str

encoding = 'ascii'

exit_server() → None

Exit the server

property is_alive

property is_rotating

ping(timeout_ms=None) → bool

Check if the server is alive and accepts commands Default is a 1s timeout

property server_version: str

sleep() → None

property stage_is_rotating

property stage_position

wait_until_rotate_starts(max_time_s=2)