`aps_32id.txm`¶

Defines TXM classes for controlling the Transmission X-ray Microscope at Advanced Photon Source beamline 32-ID-C.

TXM: A nano-CT transmission X-ray microscope.
MicroCT: Similar to the nano-CT but for micro-CT.

Functions:

`NanoTXM`([has_permit, ioc_prefix, ...])	A class representing the Transmission X-ray Microscope at sector 32-ID-C.
`MicroTXM`([has_permit, ioc_prefix, ...])	TXM operating with the front micro-CT stage.

class aps_32id.txm.NanoTXM(has_permit=False, ioc_prefix='32idcPG3:', use_shutter_A=False, use_shutter_B=True)[source]¶

Bases: object

A class representing the Transmission X-ray Microscope at sector 32-ID-C.

is_attached¶: bool – Is this computer able to communicate with the instrument. If False, communication methods will be simulated.

has_permit¶: bool – Is the instrument authorized to open shutters and change the X-ray source. Could be false for any number of reasons, most likely the beamline is set for hutch B to operate.

ioc_prefix¶: str, optional – The prefix to use for the camera’s I/O controller when conneting certain PV’s. PV descriptor’s can then use “{ioc_prefix}” in their PV nam and have it format automatically.

use_shutter_A¶: bool, optional – Whether shutter A should be used when getting light.

use_shutter_B¶: bool, optional – Whether shutter B should be used when getting light.

zp_diameter¶: float, optional – The diameter (in nanometers) of the zone-plate currently installed in the instrument.

drn¶: float, optional – The width of the zoneplate’s outermost diffraction zone.

CAPTURE_DISABLED = 0¶

CAPTURE_ENABLED = 1¶

CCD_Motor¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete¶: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Cam1_Acquire¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Cam1_AcquirePeriod¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Cam1_AcquireTime¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Cam1_ArrayCallbacks¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Cam1_Display¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Cam1_FrameRateOnOff¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Cam1_FrameRate_on_off¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Cam1_FrameRate_val¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Cam1_FrameType¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Cam1_ImageMode¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Cam1_NumImages¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Cam1_SoftwareTrigger¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Cam1_Status¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Cam1_TriggerMode¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

DCMmvt¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

DCMputEnergy¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

DETECTOR_ACQUIRE = 1¶

DETECTOR_IDLE = 0¶

E_RANGE = (6.4, 30)¶

EnergyWait¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

ExternShutterDelay¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

ExternShutterExposure¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

ExternalShutter_Trigger¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

FRAME_DARK = 1¶

FRAME_DATA = 0¶

FRAME_WHITE = 2¶

Fast_Shutter_Uniblitz¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Fly_Calc_Projections¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Fly_EndPos¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Fly_Run¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Fly_ScanControl¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Fly_ScanDelta¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Fly_Set_Encoder_Pos¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Fly_SlewSpeed¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Fly_StartPos¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Fly_Taxi¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

GAPputEnergy¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

HDF1_ArrayPort¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

HDF1_AutoSave¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

HDF1_BlockingCallbacks¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

HDF1_Capture¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

HDF1_Capture_RBV¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

HDF1_DeleteDriverFile¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

HDF1_EnableCallbacks¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

HDF1_FileName¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

HDF1_FileTemplate¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

HDF1_FileWriteMode¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

HDF1_FullFileName_RBV¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

HDF1_NextFile¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

HDF1_NumCapture¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

HDF_IDLE = 0¶

HDF_WRITING = 1¶

Image1_Callbacks¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Interferometer¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Interferometer_Acquire¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Interferometer_Arr¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Interferometer_Cnt¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Interferometer_Mode¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Interferometer_Proc_Arr¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Interferometer_Reset¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Interferometer_Update¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Interferometer_Val¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Interlaced_Images_Per_Cycle¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Interlaced_Images_Per_Cycle_RBV¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Interlaced_Num_Cycles¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Interlaced_Num_Cycles_RBV¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Interlaced_Num_Sub_Cycles¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Interlaced_Num_Sub_Cycles_RBV¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Interlaced_PROC¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Interlaced_Theta_Arr¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Motor_SampleRot¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Motor_SampleX¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Motor_SampleY¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Motor_Sample_Top_X¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Motor_Sample_Top_Z¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

POLL_INTERVAL = 0.01¶

Proc1_ArrayPort¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Proc1_AutoReset_Filter¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Proc1_Callbacks¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Proc1_Filter_Callbacks¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Proc1_Filter_Enable¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Proc1_Filter_Type¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Proc1_Num_Filter¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Proc1_Reset_Filter¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Proc_Theta¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

RECURSIVE_FILTER_TYPE = 'RecursiveAve'¶

Reset_Theta¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

SHUTTER_CLOSED = 1¶

SHUTTER_OPEN = 0¶

SetSoftGlueForStep¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

ShutterA_Close¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

ShutterA_Move_Status¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

ShutterA_Open¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

ShutterB_Close¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

ShutterB_Move_Status¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

ShutterB_Open¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Smaract_mode¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

TIFF1_ArrayPort¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

TIFF1_AutoSave¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

TIFF1_BlockingCallbacks¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

TIFF1_Capture¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

TIFF1_Capture_RBV¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

TIFF1_DeleteDriverFile¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

TIFF1_EnableCallbacks¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

TIFF1_FileName¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

TIFF1_FileTemplate¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

TIFF1_FileWriteMode¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

TIFF1_FullFileName_RBV¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

TIFF1_NumCapture¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Theta_Array¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Theta_Cnt¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

capture_dark_field(num_projections=1)[source]¶

Trigger the capturing of projection images from the detector with the shutters closed.

The shutter should be closed before calling this method.

Parameters:	num_projections (int, optional) – How many projections to acquire. exposure (float, optional) – Exposure time for each frame in seconds.

capture_projections(num_projections=1)[source]¶

Trigger the capturing of projection images from the detector.

Parameters:	num_projections (int, optional) – How many projections to acquire.

capture_tomogram(angles, num_projections=1, stabilize_sleep=10)[source]¶

Collect data frames over a range of angles.

Parameters:	angles (np.ndarray) – An array of angles (in degrees) to use for collecting projections. num_projections (int, optional) – Number of projections to average at each angle. stablize_sleep (int, optional) – How long (in milliseconds) to wait after moving the rotation stage.

capture_white_field(num_projections=1)[source]¶

Trigger the capturing of projection images from the detector with the shutters open and no sample present.

Parameters:	num_projections (int, optional) – How many projections to acquire. exposure (float, optional) – Exposure time for each frame in seconds.

close_shutters(obj, *args, **kwargs)¶

drn = 60

energy()[source]¶

Get the current beam energy.

Returns:	energy (float) – Current X-ray energy in keV

epics_PV(pv_name)[source]¶

Retrieve the epics process variable (PV) object for the given attribute name.

Parameters:	pv_name (str) – The name of the PV object. Should match the attribute on this TXM() object.

exposure_time¶: Exposure time for the CCD in seconds.

gap_offset = 0.17¶

hdf_file(timeout=10, *args, **kwargs)[source]¶

hdf_filename¶

hdf_writer_ready = False¶

move_energy(obj, *args, **kwargs)¶

move_sample(x=None, y=None, z=None, theta=None)[source]¶

Move the sample to the given (x, y, z) position.

Parameters:	x, y, z (float, optional) – The new position to move the sample to. theta (float, optional) – Rotation axis angle to set to.

open_shutters(obj, *args, **kwargs)¶

pg_external_trigger = True¶

pv_get(pv_name, *args, **kwargs)[source]¶

Retrieve the current process variable value.

Parameters:	args, *kwargs – Extra arguments that get passed to :py:meth:`epics.PV.get`

pv_put(pv_name, value, wait, *args, **kwargs)[source]¶

Set the current process variable value.

When wait=True, this method becomes closely linked with the concept of deferred PVs. Normally, this method will block until the PV has been set. When inside a :py:meth:TXM.wait_pvs context, this method adds a promise to the queue so the :py:meth:TXM.wait_pvs manager can handle the blocking. When wait=False, this method returns immediately once the value has been sent and does not alter the PV queue.

Parameters:	wait (bool, optional) – If true, the method will keep track of when PV has been set. args, *kwargs – Extra arguments that get passed to :py:meth:`epics.PV.get`

pv_queue = None¶

reset_ccd()[source]¶

run_scan¶

sample_position()[source]¶

Retrieve the x, y, z and theta positions of the sample stage.

Returns:	position (4-tuple) – (x, y, z, θ) tuple that is suitable for giving to `move_sample()`.

setup_detector(exposure=0.5, live_display=True)[source]¶

setup_hdf_writer(num_projections=1, write_mode='Stream', num_recursive_images=1)[source]¶

Prepare the HDF file writer to accept data.

Parameters:	num_projections (int) – Total number of projections to collect at one time. write_mode (str, optional) – What mode to use for the HDF writer. Gets passed to a PV. num_recursive_images (int, optional) – How many images to use in the recursive filter. If 1 (default), recursive filtering will be disabled.

setup_tiff_writer(filename, num_projections=1, write_mode='Stream', num_recursive_images=1)[source]¶

Prepare the TIFF file writer to accept data.

Parameters:	filename (str) – The name of the HDF file to save data to. num_projections (int) – Total number of projections to collect at one time. write_mode (str, optional) – What mode to use for the HDF writer. Gets passed to a PV. num_recursive_images (int, optional) – How many images to use in the recursive filter. If 1 (default), recursive filtering will be disabled.

shutters_are_open = False¶

stop_scan()[source]¶

tiff_writer_ready = False¶

wait_pv(pv_name, target_val, timeout=20)[source]¶

Wait for a process variable to reach given value.

This function polls the process variable (PV) and blocks until the PV reaches the target value or the max timeout, whichever comes first. This function immediately returns True if self.is_attached is False.

Parameters:	pv (str) – The process variable to be monitored, as defined by the pyepics system. target_val – The value the PV should acquire before returning. timeout (int, optional) – How long to wait, in seconds, before giving up. Negative values cause the function to wait forever.
Returns:	val (bool) – True if value was set properly, False if the timeout expired before the target value was reached.

wait_pvs¶

zone_plate_2_x¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

zone_plate_2_y¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

zone_plate_2_z¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

zone_plate_x¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

zone_plate_y¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

zone_plate_z¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

zp_diameter = 180

class aps_32id.txm.MicroTXM(has_permit=False, ioc_prefix='32idcPG3:', use_shutter_A=False, use_shutter_B=True)[source]¶

Bases: aps_32id.txm.NanoTXM

TXM operating with the front micro-CT stage.

Fly_Calc_Projections¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete¶: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Fly_EndPos¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Fly_Run¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Fly_ScanControl¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Fly_ScanDelta¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Fly_Set_Encoder_Pos¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Fly_SlewSpeed¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Fly_StartPos¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Fly_Taxi¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Motor_SampleRot¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Motor_SampleX¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Motor_SampleY¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Motor_SampleZ¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Motor_Sample_Top_X¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Motor_Sample_Top_Z¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Motor_X_Tile¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Motor_Y_Tile¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

Theta_Array¶

A descriptor representing a process variable in the EPICS system.

This allows accessing process variables as if they were object attributes. If the descriptor owner (ie. TXM) is not attached, this descriptor performs like a regular attribute. Optionally, this can also be done for objects that have no shutter permit.

put_complete: bool – If False, there is a pending put operation.

Parameters:

pv_name (str) – The name of the process variable to connect to as defined in the EPICS system.
dtype (optional) – If given, the values returned by PV.get will be typecast. Example: dtype=int will return int(PV[pv].get()).
permit_required (bool, optional) – If truthy, data will only be sent if the owner has_permit attribute is true. Reading of process variable is still enabled either way.
wait (bool, optional) – If truthy, setting this descriptor will block until the operation succeeds.
as_string (bool, optional) – If truthy, the string representation of the process variable will be given, otherwise the raw bytes will be returned for character array variables.

aps_32id.txm¶

`aps_32id.txm`¶