2.3.3.3.140. NXpositioner_spm¶
Status:
base class (contribution), extends NXpositioner
Description:
Extending positioner from NXpositioner to maintain a measurement signal through ...
Extending positioner from NXpositioner to maintain a measurement signal through a feedback loop, specialized for scanning probe microscopy applications.
Symbols:
No symbol table
- Groups cited:
Structure:
z_offset: (optional) NX_NUMBER {units=NX_LENGTH}
Offset added to the initial averaged position tip on Z-axis before starting to ...
Offset added to the initial averaged position tip on Z-axis before starting to scan.
controller_label: (optional) NX_CHAR
Controller label. This label which will be displayed at places where you can s ...
Controller label. This label which will be displayed at places where you can select a controller. Such label may also interpret from type of the signal used for feedback loop.
z_controller: (optional) NXpid_controller
This controller's task is to continuously adjust the Z position of the STM/STS ...
This controller’s task is to continuously adjust the Z position of the STM/STS tip in order to keep the selected control signal as close as possible to the Set Point. Different control signals lead to different controller’s behavior.
The second PID feedback loop intends to position the tip in the Z direction.
p_gain (proportional gain) from z_controller is the same as K_p value from PID controller. i_gain (integral gain) from z_controller is the same as K_i value from PID controller. setpoint from z_controller is the same as setpoint from PID controller.
D_t: (optional) NX_NUMBER {units=NX_TIME}
The derivative time constant of the derivative part of the PID controller. P ...
The derivative time constant of the derivative part of the PID controller. Proportional Derivative constant K_d can be expressed as K_d = gain / D_t.
I_t: (optional) NX_NUMBER {units=NX_TIME}
The integral time constant of the integral part of the PID controller. Propo ...
The integral time constant of the integral part of the PID controller. Proportional Integral constant K_i can be expressed as K_i = gain / I_t.
z: (optional) NX_NUMBER {units=NX_LENGTH}
To indicate the relative tip position z between tip and sample. The tip posi ...
To indicate the relative tip position z between tip and sample. The tip position can also be varied when the z_controller is not running.
set_point: (optional) NX_NUMBER {units=NX_ANY}
The set point for the z-controller to be fixed and the target value could be ...
The set point for the z-controller to be fixed and the target value could be height or current.
controller_status: (recommended) NX_BOOLEAN
The status of the controller to say was PID has been used or not.
tip_lift: (optional) NX_NUMBER {units=NX_LENGTH}
If the tip is lifted from the stable point.
switch_off_delay: (optional) NX_CHAR_OR_NUMBER {units=NX_TIME}
The switch-off delay of the controller from its stable point.
Hypertext Anchors¶
List of hypertext anchors for all groups, fields, attributes, and links defined in this class.
