poolpseudomotor
¶
This module is part of the Python Pool library. It defines the PoolPseudoMotor class
Classes
PoolPseudoMotor¶

-
class
PoolPseudoMotor
(**kwargs)[source]¶ Bases:
sardana.pool.poolbasegroup.PoolBaseGroup
,sardana.pool.poolelement.PoolElement
A class representing a Pseudo Motor in the Sardana Device Pool
-
property
drift_correction
¶ drift correction
-
property
siblings
¶ the siblings for this pseudo motor
-
get_physical_positions
(cache=True, propagate=1)[source]¶ Get positions for underlying elements.
- Parameters
cache (bool) – if
True
(default) return value in cache, otherwise read value from hardwarepropagate (int) – 0 for not propagating, 1 to propagate, 2 propagate with priority
- Returns
the physical positions
- Return type
dict <PoolElement,
SardanaAttribute
>
-
get_siblings_positions
(use=None, write_pos=True)[source]¶ Get the last positions for all siblings. If write_pos is True and a sibling has already been moved before, it’s last write position is used. Otherwise its read position is used instead.
- Parameters
use (dict <PoolElement,
SardanaValue
>) – the already calculated positions. If a sibling is in this dictionary, the position stored here is used insteadwrite_pos (bool) – determines if should try to use the last set point [default: True]
- Returns
a dictionary with siblings write positions
- Return type
dict <PoolElement, position(float?) >
-
get_position
(cache=True, propagate=1)[source]¶ Returns the user position.
- Parameters
cache (bool) – if
True
(default) return value in cache, otherwise read value from hardwarepropagate (int) – 0 for not propagating, 1 to propagate, 2 propagate with priority
- Returns
the user position
- Return type
-
set_position
(position)[source]¶ Moves the motor to the specified user position
- Parameters
position (
Number
) – the user position to move to
-
set_write_position
(w_position, timestamp=None, propagate=1)[source]¶ Sets a new write value for the user position.
- Parameters
w_position (
Number
) – the new write value for user positionpropagate (int) – 0 for not propagating, 1 to propagate, 2 propagate with priority
-
property
position
¶ pseudo motor position
-
calculate_state_info
(status_info=None)[source]¶ Transforms the given state information. This specific base implementation transforms the given state,status tuple into a state, new_status tuple where new_status is “self.name is state plus the given status. It is assumed that the given status comes directly from the controller status information.
- Parameters
status_info (tuple<State, str>) – given status information [default: None, meaning use current state status.
- Returns
a transformed state information
- Return type
tuple<State, str>
-
property
motion
¶ motion object
-
property