PyJEM.TEM3.__stage

Created on Wed Apr 9 13:32:36 2025

@author: dmaekawa

class PyJEM.TEM3.__stage.Stage3(*args, **kw)

Bases: _DummyTEM3Accessor

GetAccelAndDclrRate(axis)

Get acceleration / decelerateion rate during keystone control (for Z/Tx/ Ty).

Parameters:

axis (int) –

Axis index.

index

Axis

2

Z

3

Tilt-X

4

Tilt-Y

Returns:

(accel, decel) tuple.

  • accel (int): Acceleration rate (64-65535)

  • decel (int): Deceleration rate (64-65535)

Return type:

list

Example

>>> TEM3.Stage3().GetAccelAndDclrRate(2)
[100, 100]
GetDirection()

Get driving direction.

Returns:

(x, y, z, tiltx, tilty) tuple. Direction index (0= minus, 1= plus).

  • x (int): X axis direction

  • y (int): Y axis direction

  • z (int): Z axis direction

  • tiltx (int): Tilt-X axis direction

  • tilty (int): Tilt-Y axis direction

index

Description

0

Minus

1

Plus

Return type:

list

Example

>>> TEM3.Stage3().GetDirection()
[0, 0, 0, 0, 0]
GetDrvMode()

Get selection on motor/piezo.

Returns:

Drive mode index.

index

Description

0

Motor

1

Piezo

Return type:

int

Example

>>> TEM3.Stage3().GetDrvMode()
0
GetHolderStts()

Get holder status(In/Out)

Returns:

Holder In/Out status index.

index

Description

0

Out

1

In

Return type:

int

Example

>>> TEM3.Stage3().GetHolderStts()
0
GetMovementValueMeasurementMethod()

Get movement amount measurement method (for Z/Tx/Ty).

Returns:

Measurement method index.

index

Description

0

Encoder

1

Potentiometer

Return type:

int

Example

>>> TEM3.Stage3().GetMovementValueMeasurementMethod()
0
GetPiezoPosi()

Get piezo position.

Returns:

(x, y). Range is +-100000.0(nm)

  • x (float) : x axis

  • y (float) : y axis

Return type:

list

Note

Units may vary depending on the model.

Example

>>> TEM3.Stage3().GetPiezoPosi()
[-1750.0, -1263.888916015625]
GetPos()

Get motor position. it depends on the drive mode.

Returns:

(x, y, z, tiltx, tilty)

  • x (float): x axis value

  • y (float): y axis value

  • z (float): z axis value

  • tiltx (float): tilt-x axis value

  • tilty (float): tilt-y axis value

Return type:

list

Example

>>> TEM3.Stage3().GetPos()
[0.0, 0.0, 0.0, 0.0, 0.0]
GetPosEx()

Get motor positiont

Returns:

(x, y, z, tiltx, tilty, rot)

  • x (float): x axis value

  • y (float): y axis value

  • z (float): z axis value

  • tiltx (float): tilt-x axis value

  • tilty (float): tilt-y axis value

  • rot (float): rotation

Return type:

list

Note

This function work on ARM200F or laterd. only 6-axis compatible.

Example

>>> TEM3.Stage3().GetPosEx()
[0.0, 0.0, 0.0, 0.0, 0.0, 0.0]
GetSpeedMode(mode)

Get selection on motor/piezo.

Parameters:

mode (int) –

Drive mode.

index

Description

0

Motor

1

Piezo

Returns:

(xy, z, tiltxy) tuple. Speed index (0= slow, 1= normal, 2= fast).

  • xy (int): X-Y axis speed

  • z (int): Z axis speed

  • tiltxy (int): Tilt X-Y axis speed

Return type:

list

Example

>>> TEM3.Stage3().GetSpeedMode(0)
(0,0,0)
GetSpeedModeEx(mode)

Get selection on motor/piezo.

Parameters:

mode (int) –

index

Description

0

Motor

1

Piezo

Returns:

(xy, z, tiltxy, rot) tuple. Speed index (0= slow, 1= normal, 2= fast).

index

Description

0

Slow

1

Normal

2

Fast

  • xy (int): X-Y axis speed

  • z (int): Z axis speed

  • tiltxy (int): Tilt X-Y axis speed

  • rot (int): Rotation speed

Return type:

list

Example

>>> TEM3.Stage3().GetSpeedModeEx(0)
(0,0,0,0)
GetStatus()

Get driving status.

Returns:

(x, y, z, tiltx, tilty) tuple with status values from the following table:

index

Description

0

Rest

1

Moving

2

Hardware limiter error

  • x (int): X axis

  • y (int): Y axis

  • z (int): Z axis

  • tiltx (int): Tilt-X axis

  • tilty (int): Tilt-Y axis

Return type:

list

Example

>>> TEM3.Stage3().GetStatus()
[0, 0, 0, 0, 0]
GetStatusEx()

Get driving status

Returns:

(x, y, z, tiltx, tilty, rot) tuple with status values from the following table:

index

Description

0

Rest

1

Moving

2

Hardware limiter error

  • x (int): X axis

  • y (int): Y axis

  • z (int): Z axis

  • tiltx (int): Tilt-X axis

  • tilty (int): Tilt-Y axis

  • rot (int): Rotation

Return type:

list

Note

This function work on ARM200F or laterd. only 6-axis compatible.

Example

>>> TEM3.Stage3().GetStatusEx()
[0, 0, 0, 0, 0, 0]
Getf1OverRate(kind, mode)

Get drive frequency f1.

Parameters:

  • kind (int) –

    index

    Description

    0

    Trackbaul

    1

    Switch

    2

    Command

  • mode (int) –

    index

    Description

    0

    Motor

    1

    Piezo

Returns:

(x, y, z, tiltx, tilty) tuple.

  • x (int): X axis

  • y (int): Y axis

  • z (int): Z axis

  • tiltx (int): Tilt-X axis

  • tilty (int): Tilt-Y axis

Return type:

list

Example

>>> TEM3.Stage3().Getf1OverRate()
(0,0,0,0,0)
Getf1OverRateTxNum()

Get drive frequency f1 of TiltX.

Returns:

f1 value index with the following values:

index

Value (/sec)

0

10

1

2

2

1

3

0.5

4

0.25

5

0.1

Return type:

int

Note

This function only work on Cryo-ARM. Only when electron beam 3D crystallography kit is enabled.

Example

>>> TEM3.Stage3().Getf1OverRateTxNum()
0
SelDrvMode(mode)

Change the motor/piezo mode.

Parameters:

mode (int) –

index

Description

0

Motor

1

Piezo

Return type:

None

Example

>>> TEM3.Stage3().SelDrvMode(0)
SetAccelAndDclrRate(axis, accelrate, decelrate)

Acceleration / decelerateion rate setting during keystone control (for Z/Tx/Ty).

Parameters:

  • axis (int) –

    index

    Description

    2

    Z

    3

    Tilt-X

    4

    Tilt-Y

  • accelrate (int) – (64-65535)

  • decelrate (int) – (64-65535)

Return type:

None

Example

>>> TEM3.Stage3().SetAccelAndDclrRate(2,100,100)
SetMovementValueMeasurementMethod(method)

Movement amount measurement method setting(for Z/Tx/Ty).

Parameters:

method (int) –

index

Description

0

Encoder

1

Potentiometer

Return type:

None

Example

>>> TEM3.Stage3().SetMovementValueMeasurementMethod(0)
SetOrg()

Move to origin position for x, y, z, tilt-x, tilt-y axis.

Example

>>> TEM3.Stage3().SetOrg()
Return type:

None

SetPosition(x, y)

Set X-Y axis drive(with rotation compensation).

Parameters:

  • x (float) – relative value. range is +-100000.0 (nm)

  • y (float) – relative value. range is +-100000.0 (nm)

Return type:

None

Note

Units may vary depending on the model.

Example

>>> TEM3.Stage3().SetPosition(100,100)
SetRotation(angle)

Set rotation drive

Parameters:

angle (float) – rotation absolute value. range is +-180(degree). unit is 1(deg)

Returns:

DESCRIPTION.

Return type:

None

Note

This function work on ARM200F or laterd. only 6-axis compatible.

Example

>>> TEM3.Stage3().SetRotation(10.0)
SetRotationRel(angle)

Set relative move rotation axis. unit is 1(deg)

Parameters:

angle (float) – relative value.

Return type:

None

Note

This function work on ARM200F or laterd. only 6-axis compatible.

Example

>>> TEM3.Stage3().SetRotationRel(10.0)
SetSpeedMode(mode, xy, z, txy)

Select motor/piezo mode.

Parameters:

  • mode (int) –

    index

    Description

    0

    Motor

    1

    Piezo

  • xy (int) – Speed. Refer to speed definitions below.

  • z (int) – Speed. Refer to speed definitions below.

  • txy (int) –

    Speed. Refer to speed definitions below.

    index

    Description

    0

    Slow

    1

    Normal

    2

    Fast

Return type:

None

Example

>>> TEM3.Stage3().SetSpeedMode(0,0,0,0)
SetSpeedModeEx(mode, xy, z, txy, rot)

Select speed. motor/piezo.

Parameters:

  • mode (int) –

    index

    Description

    0

    Motor

    1

    Piezo

  • xy (int) – Speed. Refer to speed definitions below.

  • z (int) – Speed. Refer to speed definitions below.

  • txy (int) – Speed. Refer to speed definitions below.

  • rot (int) –

    Speed. Refer to speed definitions below.

    index

    Description

    0

    Slow

    1

    Normal

    2

    Fast

Return type:

None

Note

This function work on ARM200F or laterd. only 6-axis compatible.

Example

>>> TEM3.Stage3().SetSpeedModeEx(0,0,0,0,0)
SetTXRel(value)

Relative tilt around X axis.)

Parameters:

value (float) – relative value. range is +-90.00.0(degree)

Return type:

None

Note

Units may vary depending on the holder.

Example

>>> TEM3.Stage3().SetTXRel(10)
SetTYRel(value)

Relative tilt around Y axis.)

Parameters:

value (float) – relative value. range is +-90.00.0(degree)

Return type:

None

Note

Units may vary depending on the holder.

Example

>>> TEM3.Stage3().SetTYRel(10)
SetTiltXAngle(value)

Set TiltX axis absolute value.

Parameters:

value (float) – absolute value. range is +-90.00(degree)

Return type:

None

Note

Units may vary depending on the holder.

Example

>>> TEM3.Stage3().SetTiltXAngle(10)
SetTiltYAngle(value)

Set TiltY axis absolute value.

Parameters:

value (float) – absolute value. range is +-90.00(degree)

Return type:

None

Note

Units may vary depending on the holder.

Example

>>> TEM3.Stage3().SetTiltYAngle(10)
SetX(value)

Set X axis absolute value.

Parameters:

value (float) –

absolute value.

  • Motor : +-100000.0(nm)

  • Piezo : +-10000.00(nm)

Return type:

None

Note

Units may vary depending on the holder.

Example

>>> TEM3.Stage3().SetX(1000)
SetXRel(value)

Set Relative move along X axis.

Parameters:

value (float) –

relative value.

  • Motor : +-100000.0(nm)

  • Piezo : +-10000.00(nm)

Return type:

None

Note

Units may vary depending on the holder.

Example

>>> TEM3.Stage3().SetXRel(1000)
SetY(value)

Set Y axis absolute value.

Parameters:

value (float) –

absolute value.

  • Motor : +-100000.0(nm)

  • Piezo : +-10000.00(nm)

Return type:

None

Note

Units may vary depending on the holder.

Example

>>> TEM3.Stage3().SetY(1000)
SetYRel(value)

Set Relative move along Y axis.

Parameters:

value (float) –

relative value.

  • Motor : +-100000.0(nm)

  • Piezo : +-10000.00(nm)

Return type:

None

Note

Units may vary depending on the holder.

Example

>>> TEM3.Stage3().SetYRel(1000)
SetZ(value)

Set Z axis absolute value.

Parameters:

value (float) – absolute value. +-100000.0(nm)

Return type:

None

Note

Units may vary depending on the holder.

Example

>>> TEM3.Stage3().SetZ(1000)
SetZRel(value)

Set Relative move along Z axis.

Parameters:

value (float) – relative value. +-100000.0(nm)

Return type:

None

Note

Units may vary depending on the holder.

Example

>>> TEM3.Stage3().SetZRel(1000)
Setf1OverRate(kind, mode, x, y, z, tx, ty)

Drive frequency f1 setting.

Parameters:

  • kind (int) –

    index

    Description

    0

    Trackbaul

    1

    Switch

    2

    Command

  • mode (int) –

    index

    Description

    0

    Motor

    1

    Piezo

  • x (int) – f1 value

  • y (int) – f1 value

  • z (int) – f1 value

  • tx (int) – f1 value

  • ty (int) – f1 value

Return type:

None

Example

>>> TEM3.Stage3().Setf1OverRate(0,0,0,0,0,0,0)
Setf1OverRateTxNum(index)

Drive frequency f1 setting of TiltX.

Parameters:

index (int) –

index

Value (/sec)

0

10

1

2

2

1

3

0.5

4

0.25

5

0.1

Return type:

None

Note

This function only work on Cryo-ARM. Only when electron beam 3D crystallography kit is enabled.

Example

>>> TEM3.Stage3().Setf1OverRateTxNum(2)
Stop()

Stop all the drives.

Example

>>> TEM3.Stage3().Stop()
Return type:

None