poolpseudomotor

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

Classes

PoolPseudoMotor

PoolPseudoMotor

class PoolPseudoMotor(**kwargs)

Bases: PoolBaseGroup, PoolElement

A class representing a Pseudo Motor in the Sardana Device Pool

on_change(evt_src, evt_type, evt_value)

serialize(*args, **kwargs)

set_drift_correction(drift_correction)

get_drift_correction()

property drift_correction

drift correction

get_action_cache()

Returns the internal action cache object

set_action_cache(action_cache)

get_siblings()

property siblings

the siblings for this pseudo motor

on_element_changed(evt_src, evt_type, evt_value)

add_user_element(element, index=None)

calc_pseudo(physical_positions=None)

calc_physical(new_position)

calc_all_pseudo(physical_positions=None)

get_position_attribute()

get_low_level_physical_position_attribute_iterator()

get_physical_position_attribute_iterator()

get_physical_positions_attribute_sequence()

get_physical_positions_attribute_map()

get_physical_positions(cache=True, propagate=1)

Get positions for underlying elements.

Parameters:

• cache (bool) – if True (default) return value in cache, otherwise read value from hardware

• propagate (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)

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 instead

• write_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)

Returns the user position.

Parameters:

• cache (bool) – if True (default) return value in cache, otherwise read value from hardware

• propagate (int) – 0 for not propagating, 1 to propagate, 2 propagate with priority

Returns:

the user position

Return type:

SardanaAttribute

set_position(position)

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)

Sets a new write value for the user position.

Parameters:

• w_position (Number) – the new write value for user position

• propagate (int) – 0 for not propagating, 1 to propagate, 2 propagate with priority

property position

pseudo motor position

calculate_state_info(status_info=None)

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>

read_state_info(state_info=None)

get_default_attribute()

get_motion()

property motion

motion object

calculate_motion(new_position, items=None, calculated=None)

start_move(new_position)

stop()

abort()

get_operation()