synApps sscan record#

see the synApps sscan module suppport: epics-modules/sscan

Ophyd support for the EPICS synApps sscan record

see: https://epics.anl.gov/bcda/synApps/sscan/SscanRecord.html

EXAMPLE:

import apstools.synApps
scans = apstools.synApps.SscanDevice("xxx:", name="scans")
scans.select_channels()     # only the channels configured in EPICS

Public Structures

`SscanRecord`(args, *kwargs)	EPICS synApps sscan record: used as `$(P):scan(N)`
`SscanDevice`(args, *kwargs)	EPICS synApps XXX IOC setup of sscan records: `$(P):scan$(N)`

Private Structures

`sscanPositioner`(args, *kwargs)	positioner of an EPICS sscan record
`sscanDetector`(args, *kwargs)	detector of an EPICS sscan record
`sscanTrigger`(args, *kwargs)	detector trigger of an EPICS sscan record

class apstools.synApps.sscan.SscanDevice(*args: Any, **kwargs: Any)[source]#

EPICS synApps XXX IOC setup of sscan records: $(P):scan$(N)

`reset`()	set all fields to default values
`select_channels`()	Select only the scans that are configured in EPICS

reset()[source]#: set all fields to default values

scan1#: alias of SscanRecord

scan2#: alias of SscanRecord

scan3#: alias of SscanRecord

scan4#: alias of SscanRecord

scanH#: alias of SscanRecord

select_channels()[source]#: Select only the scans that are configured in EPICS

class apstools.synApps.sscan.SscanRecord(*args: Any, **kwargs: Any)[source]#

EPICS synApps sscan record: used as $(P):scan(N)

`defined_in_EPICS`	True if will be used in EPICS
`reset`()	set all fields to default values
`select_channels`()	Select channels that are configured in EPICS

property defined_in_EPICS#: True if will be used in EPICS

reset()[source]#: set all fields to default values

select_channels()[source]#: Select channels that are configured in EPICS

set(value, **kwargs)[source]#: interface to use bps.mv()

class apstools.synApps.sscan.sscanDetector(*args: Any, **kwargs: Any)[source]#

detector of an EPICS sscan record

`defined_in_EPICS`	True if defined in EPICS
`reset`()	set all fields to default values

property defined_in_EPICS#: True if defined in EPICS

reset()[source]#: set all fields to default values

class apstools.synApps.sscan.sscanPositioner(*args: Any, **kwargs: Any)[source]#

positioner of an EPICS sscan record

`defined_in_EPICS`	True if defined in EPICS
`reset`()	set all fields to default values

property defined_in_EPICS#: True if defined in EPICS

reset()[source]#: set all fields to default values

class apstools.synApps.sscan.sscanTrigger(*args: Any, **kwargs: Any)[source]#

detector trigger of an EPICS sscan record

reset()

set all fields to default values

property defined_in_EPICS#: True if defined in EPICS

reset()[source]#: set all fields to default values