Table of Contents

Package psana

High-level wrapper module for psana.

Typical usage:

from psana import *

setConfigFile('config-file.cfg')   # optional, default is to use psana.cfg if present
setOption("psana.modules", "EventKeys")   # can set/change options from script

# define "data source" specifying experiment and run number
datasrc = DataSource("exp=cxi63112:run=111")

# specify source device for data   
cam_src = Source("CxiDg4.0:Tm6740.0")

# loop over all events in a data source
for evt in datasrc.events():
    frame = evt.get(Camera.FrameV1, cam_src)
    image = frame.data16()

This software was developed for the LCLS project. If you use all or part of it, please give an appropriate acknowledgment.

Version: $Id: __init__.py 12589 2016-09-08 20:16:55Z cpo@SLAC.STANFORD.EDU $

Author: Andy Salnikov

Class psana.AliasMap

class psana.AliasMap

Python wrapper for psana AliasMap class. Usually the instances of this class are created by the framework itself and returned to the client from framework methods. Clients can instantiate objects of this type directly, this may not be very useful in general but could be helpful during testing.

add(alias:string, source:Src)

Add one more alias to the map.

alias(source:Src)

Find matching alias name for given Src. If specified Src does not exist in the map then empty string will be returned.

clear()

Remove all aliases.

src(alias:string)

Find matching Src for given alias name. If specified alias name does not exist in the map then default-constructed instance of Src will be returned.

srcs()

return a tuple of Pds::Src

Class psana.BldInfo

class psana.BldInfo

Class which defines addresses for BLD devices. Constructor can take either one or two arguments, both of them should be integer numbers. With two arguments they are (process_id, type), one argument is just type.

class Type

Python class which emulates C++ enumeration. It defines class attributes whose values are integer numbers, so that you can use EnumType.EnumValue notation to access the values. Instances of this class are integer numbers which when converted to string give the name of the corresponding class attribute, e.g. str(Enum.SomeConst) => “Enum.SomeConst” (but repr(Enum.SomeConst) => 42)

This class defines following constants: AMO_AIN_01=61 CxiDg1_Imb01=27 CxiDg1_Pim=31 CxiDg2_Imb01=28 CxiDg2_Imb02=29 CxiDg2_Pim=32 CxiDg3_Imb01=30 CxiDg3_Pim=33 CxiDg3_Spec=44 EBeam=0 EOrbits=63 FEEGasDetEnergy=2 FEE_SPEC0=46 GMD=26 HX2_BEAMMON_01=67 MEC_HXM_IPM_01=25 MEC_LAS_EM_01=20 MEC_TCTR_DI_01=22 MEC_TCTR_PIP_01=21 MEC_XT2_IPM_02=23 MEC_XT2_IPM_03=24 MEC_XT2_PIM_02=42 MEC_XT2_PIM_03=43 MFX_BEAMMON_01=62 MfxDg1_Pim=64 MfxDg2_Pim=65 NH2_SB1_IPM_01=3 NH2_SB1_IPM_02=45 NumberOf=68 PhaseCavity=1 SXR_AIN_01=66 SXR_SPEC0=47 XCS_AIN_01=60 XCS_DEC_mono=19 XCS_DIO_01=5 XCS_DIO_02=7 XCS_DIO_03=9 XCS_DIO_03m=11 XCS_DIO_04=54 XCS_DIO_05=56 XCS_DIO_mono=18 XCS_IPM_01=4 XCS_IPM_02=6 XCS_IPM_03=8 XCS_IPM_03m=10 XCS_IPM_04=53 XCS_IPM_05=55 XCS_IPM_gon=57 XCS_IPM_ladm=58 XCS_IPM_mono=17 XCS_USR_IPM_01=49 XCS_USR_IPM_02=50 XCS_USR_IPM_03=51 XCS_USR_IPM_04=52 XCS_YAG_1=12 XCS_YAG_2=13 XCS_YAG_3=15 XCS_YAG_3m=14 XCS_YAG_mono=16 XPP_AIN_01=59 XPP_SPEC0=48 XppEnds_Ipm0=40 XppEnds_Ipm1=41 XppMon_Pim0=34 XppMon_Pim1=35 XppSb2_Ipm=36 XppSb3_Ipm=37 XppSb3_Pim=38 XppSb4_Pim=39

AMO_AIN_01 = 61
CxiDg1_Imb01 = 27
CxiDg1_Pim = 31
CxiDg2_Imb01 = 28
CxiDg2_Imb02 = 29
CxiDg2_Pim = 32
CxiDg3_Imb01 = 30
CxiDg3_Pim = 33
CxiDg3_Spec = 44
EBeam = 0
EOrbits = 63
FEEGasDetEnergy = 2
FEE_SPEC0 = 46
GMD = 26
HX2_BEAMMON_01 = 67
MEC_HXM_IPM_01 = 25
MEC_LAS_EM_01 = 20
MEC_TCTR_DI_01 = 22
MEC_TCTR_PIP_01 = 21
MEC_XT2_IPM_02 = 23
MEC_XT2_IPM_03 = 24
MEC_XT2_PIM_02 = 42
MEC_XT2_PIM_03 = 43
MFX_BEAMMON_01 = 62
MfxDg1_Pim = 64
MfxDg2_Pim = 65
NH2_SB1_IPM_01 = 3
NH2_SB1_IPM_02 = 45
NumberOf = 68
PhaseCavity = 1
SXR_AIN_01 = 66
SXR_SPEC0 = 47
XCS_AIN_01 = 60
XCS_DEC_mono = 19
XCS_DIO_01 = 5
XCS_DIO_02 = 7
XCS_DIO_03 = 9
XCS_DIO_03m = 11
XCS_DIO_04 = 54
XCS_DIO_05 = 56
XCS_DIO_mono = 18
XCS_IPM_01 = 4
XCS_IPM_02 = 6
XCS_IPM_03 = 8
XCS_IPM_03m = 10
XCS_IPM_04 = 53
XCS_IPM_05 = 55
XCS_IPM_gon = 57
XCS_IPM_ladm = 58
XCS_IPM_mono = 17
XCS_USR_IPM_01 = 49
XCS_USR_IPM_02 = 50
XCS_USR_IPM_03 = 51
XCS_USR_IPM_04 = 52
XCS_YAG_1 = 12
XCS_YAG_2 = 13
XCS_YAG_3 = 15
XCS_YAG_3m = 14
XCS_YAG_mono = 16
XPP_AIN_01 = 59
XPP_SPEC0 = 48
XppEnds_Ipm0 = 40
XppEnds_Ipm1 = 41
XppMon_Pim0 = 34
XppMon_Pim1 = 35
XppSb2_Ipm = 36
XppSb3_Ipm = 37
XppSb3_Pim = 38
XppSb4_Pim = 39
BldInfo.processId() → int

Returns process ID number.

BldInfo.type() → int

Returns detector type.

BldInfo.typeName() → string

Returns detector name.

Class psana.ClockTime

class psana.ClockTime

Class which defines clock time. Uses two 32 bit unsigned integers for seconds since Jan 1, 1970 and nanoseconds.

asDouble() → float

Returns time in seconds (since Jan 1, 1970)

isZero() → string

Returns true if time is 0.

nanoseconds() → int

Returns nanoseconds part of time.

seconds() → int

Returns seconds part of time (since Jan 1, 1970)

Class psana.DetInfo

class psana.DetInfo

Class which defines detector-level addresses. Constructor can take either four or five arguments, all of them should be integer numbers. With four arguments they are (detector, detector_id, device, device_id), five arguments are (process_id, detector, detector_id, device, device_id).

class Detector

Python class which emulates C++ enumeration. It defines class attributes whose values are integer numbers, so that you can use EnumType.EnumValue notation to access the values. Instances of this class are integer numbers which when converted to string give the name of the corresponding class attribute, e.g. str(Enum.SomeConst) => “Enum.SomeConst” (but repr(Enum.SomeConst) => 42)

This class defines following constants: AmoBPS=7 AmoETOF=3 AmoEndstation=23 AmoGD=2 AmoIMS=1 AmoITOF=4 AmoMBES=5 AmoVMI=6 BldEb=10 Camp=8 CxiDg1=27 CxiDg2=28 CxiDg3=29 CxiDg4=30 CxiDs1=32 CxiDs2=33 CxiDsd=36 CxiDsu=34 CxiEndstation=24 CxiKb1=31 CxiSc1=35 CxiSc2=38 EpicsArch=9 FeeHxSpectrometer=45 Lamp=47 MecEndstation=26 MecFdi=42 MecTargetChamber=44 MecTimeTool=43 MecXrtsBack=41 MecXrtsForw=40 MecXuvSpectrometer=39 MfxDg1=49 MfxDg2=50 MfxEndstation=48 NoDetector=0 NumDetector=52 SxrBeamline=11 SxrEndstation=12 XcsBeamline=37 XcsEndstation=25 XppEndstation=22 XppGon=20 XppLas=21 XppMonPim=15 XppSb1Ipm=13 XppSb1Pim=14 XppSb2Ipm=16 XppSb3Ipm=17 XppSb3Pim=18 XppSb4Pim=19 XrayTransportDiagnostic=46 XrtDiag=51

AmoBPS = 7
AmoETOF = 3
AmoEndstation = 23
AmoGD = 2
AmoIMS = 1
AmoITOF = 4
AmoMBES = 5
AmoVMI = 6
BldEb = 10
Camp = 8
CxiDg1 = 27
CxiDg2 = 28
CxiDg3 = 29
CxiDg4 = 30
CxiDs1 = 32
CxiDs2 = 33
CxiDsd = 36
CxiDsu = 34
CxiEndstation = 24
CxiKb1 = 31
CxiSc1 = 35
CxiSc2 = 38
EpicsArch = 9
FeeHxSpectrometer = 45
Lamp = 47
MecEndstation = 26
MecFdi = 42
MecTargetChamber = 44
MecTimeTool = 43
MecXrtsBack = 41
MecXrtsForw = 40
MecXuvSpectrometer = 39
MfxDg1 = 49
MfxDg2 = 50
MfxEndstation = 48
NoDetector = 0
NumDetector = 52
SxrBeamline = 11
SxrEndstation = 12
XcsBeamline = 37
XcsEndstation = 25
XppEndstation = 22
XppGon = 20
XppLas = 21
XppMonPim = 15
XppSb1Ipm = 13
XppSb1Pim = 14
XppSb2Ipm = 16
XppSb3Ipm = 17
XppSb3Pim = 18
XppSb4Pim = 19
XrayTransportDiagnostic = 46
XrtDiag = 51
class DetInfo.Device

Python class which emulates C++ enumeration. It defines class attributes whose values are integer numbers, so that you can use EnumType.EnumValue notation to access the values. Instances of this class are integer numbers which when converted to string give the name of the corresponding class attribute, e.g. str(Enum.SomeConst) => “Enum.SomeConst” (but repr(Enum.SomeConst) => 42)

This class defines following constants: AcqTDC=11 Acqiris=2 Andor=25 Archon=42 ControlsCamera=41 Cspad=10 Cspad2x2=13 DualAndor=38 Encoder=9 Epix=29 Epix100a=35 Epix10k=34 EpixS=36 EpixSampler=31 Evr=1 Fccd=7 Fccd960=33 Fexamp=14 Fli=23 Gotthard=37 Gsc16ai=15 Imp=28 Ipimb=8 Jungfrau=43 LeCroy=40 NoDevice=0 NumDevice=44 OceanOptics=20 Opal1000=3 Opal1600=21 Opal2000=18 Opal4000=19 Opal8000=22 OrcaFl40=27 Phasics=16 Pimax=32 Princeton=6 Quartz4A150=24 Rayonix=30 Timepix=17 Tm6740=4 USDUSB=26 Wave8=39 Xamps=12 pnCCD=5

AcqTDC = 11
Acqiris = 2
Andor = 25
Archon = 42
ControlsCamera = 41
Cspad = 10
Cspad2x2 = 13
DualAndor = 38
Encoder = 9
Epix = 29
Epix100a = 35
Epix10k = 34
EpixS = 36
EpixSampler = 31
Evr = 1
Fccd = 7
Fccd960 = 33
Fexamp = 14
Fli = 23
Gotthard = 37
Gsc16ai = 15
Imp = 28
Ipimb = 8
Jungfrau = 43
LeCroy = 40
NoDevice = 0
NumDevice = 44
OceanOptics = 20
Opal1000 = 3
Opal1600 = 21
Opal2000 = 18
Opal4000 = 19
Opal8000 = 22
OrcaFl40 = 27
Phasics = 16
Pimax = 32
Princeton = 6
Quartz4A150 = 24
Rayonix = 30
Timepix = 17
Tm6740 = 4
USDUSB = 26
Wave8 = 39
Xamps = 12
pnCCD = 5
DetInfo.detId() → int

Returns detector ID number.

DetInfo.detName() → string

Returns detector name.

DetInfo.detector() → int

Returns detector type.

DetInfo.devId() → int

Returns device ID number.

DetInfo.devName() → string

Returns device name.

DetInfo.device() → int

Returns device type.

DetInfo.processId() → int

Returns process ID number.

Class psana.DgramList

class psana.DgramList

Python wrapper for psana DgramList class. Usually the instances of this class are created by the framework itself and returned to the client from framework methods. This is a list of datagrams comprising an event. Exposed on the Python side are the list of filenames, and offsets into those files. Clients can instantiate objects of this type directly, this may not be very useful in general but could be helpful during testing.

getFileNames()

Get list of xtc filenames that are in this DgramList for a given event. Note .inprogress extensions typically indicate reading from live data.

getOffsets()

Get offsets into the xtc filenames of datagrams in this DgramList.

Class psana.Env

class psana.Env

Python wrapper for psana Env C++ class. Instances of this class are created by the framework itself and returned to the client from framework methods.

aliasMap() → object

Access to alias map (AliasMap) object, returns None if alias map is not defined.

calibDir() → str

Returns path the calibration directory for current instrument/experiment, typically “/reg/d/psdm/INSTR/exper/calib” but can be changed from in job configuration.

calibStore() → object

Access to Calibration Store (EnvObjectStore) object.

configStore() → object

Access to Configuration Store (EnvObjectStore) object.

epicsStore() → object

Access to EPICS Store (EpicsStore) object.

expNum() → int

Returns experiment number or 0.

experiment() → str

Returns experiment name.

fwkName() → str

Returns name of the framework. This method is supposed to be defined across different frameworks. It returns the name of the current framework, e.g. when client code runs inside pyana framework it will return string “pyana”, inside psana framework it will return “psana”. This method should be used as a primary mechanism for distinguishing between different frameworks in cases when client needs to execute framework-specific code.

getConfig(...) → object

Pyana compatibility method, shortcut for self.configStore().get(), deprecated.

hmgr() → object

Access to histogram manager.

instrument() → str

Returns instrument name.

jobName() → str

Returns job name.

jobNameSub() → str

Returns combination of job name and subprocess index as a string which is unique for all subprocesses in a job.

subprocess() → int

Returns sub-process number. In case of multi-processing job it will be a non-negative numberranging from 0 to a total number of sub-processes. In case of single-process job it will return -1.

Class psana.EnvObjectStore

class psana.EnvObjectStore

Python wrapper for psana EnvObjectStore class. Usually the instances of this class are created by the framework itself and returned to the client from framework methods. Clients can instantiate objects of this type directly, this may not be very useful in general but could be helpful during testing. The main method of this class are get() which allows you to retrieve data from the store.

get(...) → object
Finds and retrieves objects from a store. This is an overloaded method which can accept variable number of parameters:
  • get(type, src) - find object of specified type and source address
  • get(type, src, key:string) - find object of specified type and source address with the given key
pyana compatibility methods (deprecated):
  • get(int, addr:Source) - equivalent to get(type, addr) where type is deduced from integer assumed to be Pds::TypeId::Type value
  • get(int, addr:string) - equivalent to get(type, Source(addr)) where type is deduced from integer assumed to be Pds::TypeId::Type value
  • get(int) - equivalent to get(int, "")

In the first method type argument can be a type object or a list of type objects. If the list is given then object is returned whose type matches any one from the list. The src argument can be an instance of Source or Src types.

keys([src]) → list

Get the list of event keys (type EventKey) for objects in the store. Optional argument can be either Source instance or string. Without argument keys for all sources are returned.

put(...) → None
Store new object in the store. This is an overloaded method which can accept a variable number of parameters:
  • put(object,src)
  • put(object) - equivalent to put(type, Source(None), "")

The src argument can be an instance of Source or Src types. If Source instance is used for the src argument it must describe the source exactly (cannot contain wildcards).

Class psana.EpicsStore

class psana.EpicsStore

Wrapper for C++ class PSEnv::EpicsStore. This class stores state of all EPICS corresponding to current event.

alias(pvName:string) → string

Get alias name for specified PV name. If specified PV is not found or does not have an alias an empty string is returned.

aliases() → list of strings

Get the list of PV aliases, returned list includes the names of all alias names but no PV names.

getPV(name:string) → object

Find EPICS PV given its PV or alias name. Returns an instance of one of the PV types (one of subclasses of Epics.EpicsPvHeader). If PV name cannot be found None is returned.

names() → list of strings

Get the full list of PV names and aliases, returned list includes the names of all PVs and aliases.

pvName(alias:string) → string

Get PV name for specified alias name. If specified alias is not found an empty string is returned.

pvNames() → list of strings

Get the list of PV names, returned list includes the names of all PVs but no alias names.

status(name:string) → tuple

Get status information for a given PV or alias name. Returns triplet (status, severity, time) corresponding to the last stored measurement. Time is returned as a floating number specifying seconds since UNIX Epoch. If name is not found None is returned.

value(name:string[, index:int]) → number or string

Get current value of PV. Returned type depends on PV type, for numeric or enum types integer or float is returned, for string types string is returned. Optional index specifies array index for array PVs, if index is out of range None is returned. Missing index means the same as index 0. If name is not found then None is returned.

Class psana.Event

class psana.Event

Python wrapper for psana Event class. Usually the instances of this class are created by the framework itself and returned to the client from framework methods. Clients can instantiate objects of this type directly, this may not be very useful in general but could be helpful during testing. The main methods of this class are get() and put() which allow you to retrieve data from the event or add new data to the event.

get(...) → object
Finds and retrieves objects from event. This is an overloaded method which can accept variable number of parameters:
  • get(type, src, key:string)
  • get(type, src) - equivalent to get(type, src, "")
  • get(type, key:string) - equivalent to get(type, Source(None), key)
  • get(type) - equivalent to get(type, Source(None), "")
pyana compatibility methods (deprecated):
  • get(string) - gets any Python object stored with put(object, string)
  • get(int, addr:Source) - equivalent to get(type, addr, "") where type is deduced from integer assumed to be Pds::TypeId::Type value
  • get(int, addr:string) - equivalent to get(type, Source(addr), "") where type is deduced from integer assumed to be Pds::TypeId::Type value
  • get(int) - equivalent to get(int, "")

In the first four methods type argument can be a type object or a list of type objects. If the list is given then object is returned whose type matches any one from the list. The src argument can be an instance of Source or Src types.

keys([src]) → list

Get the list of event keys (type EventKey) for objects in the event. Optional argument can be either Source instance or string. Without argument keys for all sources are returned.

put(...) → None
Store new object in the event. This is an overloaded method which can accept variable number of parameters:
  • put(object, src, key:string)
  • put(object, src) - equivalent to put(object, src, "")
  • put(object, key:string) - equivalent to put(object, Source(None), key)
  • put(object) - equivalent to put(type, Source(None), "")

The src argument can be an instance of Source or Src types. If Source instance is used for the src argument it must describe the source exactly (cannot contain wildcards).

remove(...) → bool
Remove object of given type from the event. This is an overloaded method which can accept variable number of parameters:
  • remove(type, src, key:string)
  • remove(type, src) - equivalent to remove(type, src, "")
  • remove(type, key:string) - equivalent to remove(type, Source(None), key)
  • remove(type) - equivalent to remove(type, Source(None), "")

Returns false if object did not exist before this call, true if object existed and was removed.

run() → int

Get the run number form event. If run number is not known -1 is returned. This is a pyana compatibility method which is deprectated.

Class psana.EventId

class psana.EventId

Event ID should include enough information to uniquely identify an event (and possibly a location of the event in data file). Currently we include event timestamp and run number into Event ID.

fiducials() → int

Returns fiducials counter for the event. Note that MCC sends fiducials as 17-bit number which overflows frequently (fiducials clock runs at 360Hz) so this number is not unique. In some cases (e.g. when reading from old HDF5 files) fiducials is not know, 0 will be returned in this case.

idxtime() → EventTime

Return the time for event, in a class suitable for use with indexing.

run() → int

Return the run number for event. If run number is not known -1 will be returned.

ticks() → int

Returns 119MHz counter within the fiducial. Returns the value of 119MHz counter within the fiducial for the event code which initiated the readout. In some cases (e.g. when reading from old HDF5 files) ticks are not know, 0 will be returned in this case.

time() → tuple

Return the time for event, which is tuple containing seconds and nanoseconds.

vector() → int

Returns event counter since Configure. Note that counter is saved as 15-bits integer and will overflow frequently. In some cases (e.g. when reading from old HDF5 files) counter is not know, 0 will be returned in this case.

Class psana.EventIter

class psana.EventIter

Class which supports iteration over events contained in a particular DataSource, Run, or Step instance. Iterator returns event (Event) objects which contain all experimental data for particular event.

next

Class psana.EventKey

class psana.EventKey

Class describing a key of the data object in event.

alias() → string

Returns alias name for source or empty string if alias is not defined.

key() → string

Returns string key.

src() → object

Returns data source address (Src).

type() → type

Returns Python type (class) or None if type cannot be deduced.

Class psana.EventTime

class psana.EventTime

Python wrapper for psana EventTime type

fiducial() → int

Returns fiducial count for this timestamp

nanoseconds() → int

Returns nanoseconds count for this timestamp

seconds() → int

Returns seconds count for this timestamp

time() → int

Returns time count for this timestamp

Class psana.ndarray_float32_1

class psana.ndarray_float32_1

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_float32_2

class psana.ndarray_float32_2

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_float32_3

class psana.ndarray_float32_3

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_float32_4

class psana.ndarray_float32_4

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_float32_5

class psana.ndarray_float32_5

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_float32_6

class psana.ndarray_float32_6

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_float64_1

class psana.ndarray_float64_1

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_float64_2

class psana.ndarray_float64_2

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_float64_3

class psana.ndarray_float64_3

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_float64_4

class psana.ndarray_float64_4

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_float64_5

class psana.ndarray_float64_5

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_float64_6

class psana.ndarray_float64_6

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_int16_1

class psana.ndarray_int16_1

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_int16_2

class psana.ndarray_int16_2

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_int16_3

class psana.ndarray_int16_3

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_int16_4

class psana.ndarray_int16_4

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_int16_5

class psana.ndarray_int16_5

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_int16_6

class psana.ndarray_int16_6

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_int32_1

class psana.ndarray_int32_1

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_int32_2

class psana.ndarray_int32_2

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_int32_3

class psana.ndarray_int32_3

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_int32_4

class psana.ndarray_int32_4

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_int32_5

class psana.ndarray_int32_5

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_int32_6

class psana.ndarray_int32_6

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_int64_1

class psana.ndarray_int64_1

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_int64_2

class psana.ndarray_int64_2

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_int64_3

class psana.ndarray_int64_3

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_int64_4

class psana.ndarray_int64_4

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_int64_5

class psana.ndarray_int64_5

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_int64_6

class psana.ndarray_int64_6

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_int8_1

class psana.ndarray_int8_1

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_int8_2

class psana.ndarray_int8_2

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_int8_3

class psana.ndarray_int8_3

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_int8_4

class psana.ndarray_int8_4

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_int8_5

class psana.ndarray_int8_5

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_int8_6

class psana.ndarray_int8_6

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_uint16_1

class psana.ndarray_uint16_1

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_uint16_2

class psana.ndarray_uint16_2

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_uint16_3

class psana.ndarray_uint16_3

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_uint16_4

class psana.ndarray_uint16_4

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_uint16_5

class psana.ndarray_uint16_5

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_uint16_6

class psana.ndarray_uint16_6

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_uint32_1

class psana.ndarray_uint32_1

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_uint32_2

class psana.ndarray_uint32_2

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_uint32_3

class psana.ndarray_uint32_3

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_uint32_4

class psana.ndarray_uint32_4

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_uint32_5

class psana.ndarray_uint32_5

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_uint32_6

class psana.ndarray_uint32_6

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_uint64_1

class psana.ndarray_uint64_1

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_uint64_2

class psana.ndarray_uint64_2

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_uint64_3

class psana.ndarray_uint64_3

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_uint64_4

class psana.ndarray_uint64_4

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_uint64_5

class psana.ndarray_uint64_5

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_uint64_6

class psana.ndarray_uint64_6

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_uint8_1

class psana.ndarray_uint8_1

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_uint8_2

class psana.ndarray_uint8_2

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_uint8_3

class psana.ndarray_uint8_3

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_uint8_4

class psana.ndarray_uint8_4

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_uint8_5

class psana.ndarray_uint8_5

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ndarray_uint8_6

class psana.ndarray_uint8_6

Special Python type which wraps C++ ndarray. The instances of this type are not used directly, but the type itself is used as an argument for Event.get() method.

Class psana.ProcInfo

class psana.ProcInfo

Class which defines detector-level addresses. Constructor takes three arguments, all of them should be integer numbers: level, process ID, and IP address.

ipAddr() → int

Returns IP address as integer number.

processId() → int

Returns process ID number.

Class psana.PSAna

class psana.PSAna(configFile: str[, options: dict]) → instance

Python wrapper for psana framework class (PSAna). Constructor takes the name of the configuration file (typically “psana.cfg”) and optional dictionary of configuration options. Keys in the options dictionary are option names, name has format “section.option” where “section” is the name of the section in configuration file (such as “psana” or “psana_examples.DumpPrinceton”). Value can be any string, possibly empty, non-string values will be converted to strings using str() call. Options from a dictionary override corresponding options in configuration file.

Objects of this type cannot be directly instantiated in user code, users will typically use high-level wrappers for the framework (see psana).

dataSource(input, ...) → DataSource

Returns data source object (_DataSource), accepts a list of strings or any number of string arguments. Strings can be either names of files or datasets.

Class psana.Run

class psana.Run

Python wrapper for psana Run type. Run type represents data originating from a single run and it contains one or more steps (calib cycles) which in turn contain events. This class provides ways to iterate over individual steps in a run or over all events contained in all steps of this run. Actual iteration is implemented in StepIter and EventIter classes, this class serves as a factory for iterator instances.

end() -> forces endrun (for use with indexing)
env() → object

Returns environment object

event() → array

Returns a randomly accessed event using timestamp argument

events() → iterator

Returns iterator for contained events (EventIter)

nsteps() → int

Returns number of steps (a.k.a. calib-cycles) for a run. works only with random access (indexing).

run() → int

Returns run number, -1 if unknown

steps()

self.Steps() -> iterator

Returns iterator for contained steps (StepIter)

times() → array

Returns tuple of event timestamps for a run for random access with indexing

Class psana.RunIter

class psana.RunIter

Class which supports iteration over runs contained in a particular DataSource instance. Iterator returns instances of Run class.

next

Class psana.Source

class psana.Source
Class which defines matching criteria for source addresses returned from Event.get() method. This class provides several constructors:
  • Source() without arguments matches data from any source address
  • Source(None) will match data that do not have associated address (such as EventId data)
  • Source(Src) with argument of type psana.Src will match data that have the same address
  • Source(int) where argument should be one of the BldInfo.Type enum constants, will match data coming from that particular BLD source
  • Source(int, int, int, int) where argument should be (DetInfo.Detector, int, DetInfo.Device, int) will match data coming from that particular DAQ (DetInfo) source
  • Source(string) where string provides matching criteria, e.g. ‘DetInfo(CxiDg1.*:Cspad2x2.0)’

Main utility of this class consists entirely of being passed down to Event.get() method.

srcMatch([aliases:AliasMap]) → :py:class:`SrcMatch`

Returns object which can be used to match Src instances. If Source instance was constructed from a string then this method tries to resolve string as an alias. If alias is not found then it tries to parse the string according to the definitions above. If parsing fails then exception is thrown. Optional argument provides alias map instance which can be obtained from environment object (Env). If alias map is not provided then alias names are not resolved (aliases cannot be used in this case).

Class psana.Src

class psana.Src

Base class which defines generic XTC data source “address”. One cannot make instances of this class directly, instead use one of the classes DetInfo, BldInfo, or ProcInfo

Class psana.SrcMatch

class psana.SrcMatch

Helper class which provides logic for matching Source values to Src instances.

This is an abstraction of the set of addresses. Having this set one can askquestions like: - does a specific address (Src instance) belong to the set (match() method). - does other set (another SrcMatch instance) contains this set completely (so that for example one could ask question like “will this set match cspad-only devices”) - check if this is a special “no-source” match (matching only data that do not come from any device) - check if this is “exact” match (matching only one specific device, or no-source)

in_(match:SrcMatch) → bool

Returns true if set of addresses matched by this instance is contained entirely in the set of addresses matched by an argument. One can also use expression match1 in match2 which is equivalent to match1.in_(match2).

isExact() → bool

Returns true if it is exact match, no-source is also exact.

isNoSource() → bool

Returns true if it matches no-source only.

match(src:Src) → bool

Match source with Src object.

Class psana.Step

class psana.Step

Python wrapper for psana Step type. Step type represents data originating from a single step (calib cycle) which contains events. This class provides way to iterate over individual events contained in a Step. Actual iteration is implemented in EventIter class, this class serves as a factory for iterator instances.

env() → object

Returns environment object

events() → iterator

Returns iterator for contained events (EventIter)

Class psana.StepIter

class psana.StepIter

Class which supports iteration over steps (calib cycles) contained in a particular DataSource or Run instance. Iterator returns instances of Step class.

next

Module psana.Acqiris

The Python wrapper module for Acqiris types

Class psana.Acqiris.ConfigV1

class psana.Acqiris.ConfigV1

Class containing all Acqiris configuration data.

Raises an exception This class cannot be instantiated from Python

channelMask((ConfigV1)arg1) → int :

Bit mask for channels.

horiz((ConfigV1)arg1) → HorizV1 :

Configuration for horizontal axis

nbrBanks((ConfigV1)arg1) → int :

Total number of banks.

nbrChannels((ConfigV1)arg1) → int :

Number of channels calculated from channel bit mask.

nbrConvertersPerChannel((ConfigV1)arg1) → int :

Number of ADCs per channel.

trig((ConfigV1)arg1) → TrigV1 :

Trigger configuration.

vert((ConfigV1)arg1) → list :

Configuration for vertical axis (one per channel).

MaxChan = 20
TypeId = 4
Version = 1

Class psana.Acqiris.DataDescV1

class psana.Acqiris.DataDescV1

Class containing waveform data (DataDescV1Elem) for all channels.

Raises an exception This class cannot be instantiated from Python

data((DataDescV1)arg1, (int)arg2) → DataDescV1Elem :

Waveform data, one object per channel.

data_shape((DataDescV1)arg1) → object
TypeId = 3
Version = 1

Class psana.Acqiris.DataDescV1Elem

class psana.Acqiris.DataDescV1Elem

Class representing Acqiris waveforms from single channel.

Raises an exception This class cannot be instantiated from Python

indexFirstPoint((DataDescV1Elem)arg1) → int
nbrSamplesInSeg((DataDescV1Elem)arg1) → int :

Number of samples in one segment.

nbrSegments((DataDescV1Elem)arg1) → int :

Number of segments.

timestamp((DataDescV1Elem)arg1) → list :

Timestamps, one timestamp per segment.

waveforms((DataDescV1Elem)arg1) → numpy.ndarray :

Waveforms data, two-dimensional array [nbrSegments()]*[nbrSamplesInSeg()]. Note that unlike in pdsdata this already takes into account value of the indexFirstPoint so that client code does not need to correct for this offset.

BitShift = 6
NumberOfBits = 10
_extraSize = 32

Class psana.Acqiris.HorizV1

class psana.Acqiris.HorizV1

Class containing Acqiris configuration data for horizontal axis.

Raises an exception This class cannot be instantiated from Python

delayTime((HorizV1)arg1) → float :

Delay time.

nbrSamples((HorizV1)arg1) → int :

Number of samples.

nbrSegments((HorizV1)arg1) → int :

Number of segments.

sampInterval((HorizV1)arg1) → float :

Interval for single sample.

Class psana.Acqiris.TdcAuxIO

class psana.Acqiris.TdcAuxIO

configuration for auxiliary IO channel.

Raises an exception This class cannot be instantiated from Python

class Channel
IOAux1 = psana.Acqiris.Channel.IOAux1
IOAux2 = psana.Acqiris.Channel.IOAux2
names = {'IOAux1': psana.Acqiris.Channel.IOAux1, 'IOAux2': psana.Acqiris.Channel.IOAux2}
values = {1: psana.Acqiris.Channel.IOAux1, 2: psana.Acqiris.Channel.IOAux2}
class TdcAuxIO.Mode
BankSwitch = psana.Acqiris.Mode.BankSwitch
Marker = psana.Acqiris.Mode.Marker
OutputHi = psana.Acqiris.Mode.OutputHi
OutputLo = psana.Acqiris.Mode.OutputLo
names = {'BankSwitch': psana.Acqiris.Mode.BankSwitch, 'Marker': psana.Acqiris.Mode.Marker, 'OutputLo': psana.Acqiris.Mode.OutputLo, 'OutputHi': psana.Acqiris.Mode.OutputHi}
values = {32: psana.Acqiris.Mode.OutputLo, 1: psana.Acqiris.Mode.BankSwitch, 2: psana.Acqiris.Mode.Marker, 33: psana.Acqiris.Mode.OutputHi}
class TdcAuxIO.Termination
Z50 = psana.Acqiris.Termination.Z50
ZHigh = psana.Acqiris.Termination.ZHigh
names = {'Z50': psana.Acqiris.Termination.Z50, 'ZHigh': psana.Acqiris.Termination.ZHigh}
values = {0: psana.Acqiris.Termination.ZHigh, 1: psana.Acqiris.Termination.Z50}
TdcAuxIO.channel((TdcAuxIO)arg1) → Channel
TdcAuxIO.mode((TdcAuxIO)arg1) → Mode
TdcAuxIO.term((TdcAuxIO)arg1) → Termination

Class psana.Acqiris.TdcChannel

class psana.Acqiris.TdcChannel

Configuration for Acqiris TDC channel.

Raises an exception This class cannot be instantiated from Python

class Channel
Common = psana.Acqiris.Channel.Common
Input1 = psana.Acqiris.Channel.Input1
Input2 = psana.Acqiris.Channel.Input2
Input3 = psana.Acqiris.Channel.Input3
Input4 = psana.Acqiris.Channel.Input4
Input5 = psana.Acqiris.Channel.Input5
Input6 = psana.Acqiris.Channel.Input6
Veto = psana.Acqiris.Channel.Veto
names = {'Input2': psana.Acqiris.Channel.Input2, 'Input3': psana.Acqiris.Channel.Input3, 'Input1': psana.Acqiris.Channel.Input1, 'Input6': psana.Acqiris.Channel.Input6, 'Input4': psana.Acqiris.Channel.Input4, 'Input5': psana.Acqiris.Channel.Input5, 'Veto': psana.Acqiris.Channel.Veto, 'Common': psana.Acqiris.Channel.Common}
values = {1: psana.Acqiris.Channel.Input1, 2: psana.Acqiris.Channel.Input2, 3: psana.Acqiris.Channel.Input3, 4: psana.Acqiris.Channel.Input4, 5: psana.Acqiris.Channel.Input5, 6: psana.Acqiris.Channel.Input6, -2: psana.Acqiris.Channel.Veto, -1: psana.Acqiris.Channel.Common}
class TdcChannel.Mode
Active = psana.Acqiris.Mode.Active
Inactive = psana.Acqiris.Mode.Inactive
names = {'Active': psana.Acqiris.Mode.Active, 'Inactive': psana.Acqiris.Mode.Inactive}
values = {0: psana.Acqiris.Mode.Active, 1: psana.Acqiris.Mode.Inactive}
class TdcChannel.Slope
Negative = psana.Acqiris.Slope.Negative
Positive = psana.Acqiris.Slope.Positive
names = {'Positive': psana.Acqiris.Slope.Positive, 'Negative': psana.Acqiris.Slope.Negative}
values = {0: psana.Acqiris.Slope.Positive, 1: psana.Acqiris.Slope.Negative}
TdcChannel._mode_int((TdcChannel)arg1) → int :

Bitfield value, should not be used directly. Use mode() and slope() in the client code.

TdcChannel.channel((TdcChannel)arg1) → Channel :

Channel type as integer number, clients should use channel() method instead.

TdcChannel.level((TdcChannel)arg1) → float
TdcChannel.mode((TdcChannel)arg1) → Mode
TdcChannel.slope((TdcChannel)arg1) → Slope

Class psana.Acqiris.TdcConfigV1

class psana.Acqiris.TdcConfigV1

Class with complete Acqiris TDC configuration.

Raises an exception This class cannot be instantiated from Python

auxio((TdcConfigV1)arg1) → list :

Axiliary configurations, one object per channel.

channels((TdcConfigV1)arg1) → list :

Channel configurations, one object per channel.

veto((TdcConfigV1)arg1) → TdcVetoIO
NAuxIO = 2
NChannels = 8
TypeId = 36
Version = 1

Class psana.Acqiris.TdcDataV1

class psana.Acqiris.TdcDataV1

Acqiris TDS data object is a container for TdcDataV1_Item object (or their sub-types).

Raises an exception This class cannot be instantiated from Python

data((TdcDataV1)arg1) → list :

Access TDC data items.

TypeId = 37
Version = 1

Class psana.Acqiris.TdcDataV1Channel

class psana.Acqiris.TdcDataV1Channel

Class for the “channel” TDC data object.

Raises an exception This class cannot be instantiated from Python

overflow((TdcDataV1Channel)arg1) → int :

Returns overflow status.

ticks((TdcDataV1Channel)arg1) → int :

Returns number of ticks.

time((TdcDataV1Channel)arg1) → float :

Ticks converted to time, tick resolution is 50 picosecond.

Class psana.Acqiris.TdcDataV1Common

class psana.Acqiris.TdcDataV1Common

Class for the “common” TDC data object.

Raises an exception This class cannot be instantiated from Python

nhits((TdcDataV1Common)arg1) → int :

Returns number of hits.

overflow((TdcDataV1Common)arg1) → int :

Returns overflow status.

Class psana.Acqiris.TdcDataV1_Item

class psana.Acqiris.TdcDataV1_Item

Base class for all Acqiris TDC data objects.

Raises an exception This class cannot be instantiated from Python

class Source
AuxIO = psana.Acqiris.Source.AuxIO
Chan1 = psana.Acqiris.Source.Chan1
Chan2 = psana.Acqiris.Source.Chan2
Chan3 = psana.Acqiris.Source.Chan3
Chan4 = psana.Acqiris.Source.Chan4
Chan5 = psana.Acqiris.Source.Chan5
Chan6 = psana.Acqiris.Source.Chan6
Comm = psana.Acqiris.Source.Comm
names = {'Chan5': psana.Acqiris.Source.Chan5, 'Chan4': psana.Acqiris.Source.Chan4, 'Chan6': psana.Acqiris.Source.Chan6, 'Chan1': psana.Acqiris.Source.Chan1, 'Chan3': psana.Acqiris.Source.Chan3, 'Chan2': psana.Acqiris.Source.Chan2, 'Comm': psana.Acqiris.Source.Comm, 'AuxIO': psana.Acqiris.Source.AuxIO}
values = {0: psana.Acqiris.Source.Comm, 1: psana.Acqiris.Source.Chan1, 2: psana.Acqiris.Source.Chan2, 3: psana.Acqiris.Source.Chan3, 4: psana.Acqiris.Source.Chan4, 5: psana.Acqiris.Source.Chan5, 6: psana.Acqiris.Source.Chan6, 7: psana.Acqiris.Source.AuxIO}
TdcDataV1_Item.bf_ofv_((TdcDataV1_Item)arg1) → int
TdcDataV1_Item.bf_val_((TdcDataV1_Item)arg1) → int
TdcDataV1_Item.source((TdcDataV1_Item)arg1) → Source :

Source of this data object, use returned enum to distinguish between actual types of data objecs and cast appropriately.

TdcDataV1_Item.value((TdcDataV1_Item)arg1) → int :

Value as integer number whiis composed of several bit fields. Do not use value directly, instead cast this object to one of the actual types and use corresponding methods.

Class psana.Acqiris.TdcDataV1Marker

class psana.Acqiris.TdcDataV1Marker

Class for the “marker” TDC data object.

Raises an exception This class cannot be instantiated from Python

class Type
AuxIOMarker = psana.Acqiris.Type.AuxIOMarker
AuxIOSwitch = psana.Acqiris.Type.AuxIOSwitch
EventCntSwitch = psana.Acqiris.Type.EventCntSwitch
MemFullSwitch = psana.Acqiris.Type.MemFullSwitch
names = {'AuxIOSwitch': psana.Acqiris.Type.AuxIOSwitch, 'MemFullSwitch': psana.Acqiris.Type.MemFullSwitch, 'AuxIOMarker': psana.Acqiris.Type.AuxIOMarker, 'EventCntSwitch': psana.Acqiris.Type.EventCntSwitch}
values = {0: psana.Acqiris.Type.AuxIOSwitch, 1: psana.Acqiris.Type.EventCntSwitch, 2: psana.Acqiris.Type.MemFullSwitch, 16: psana.Acqiris.Type.AuxIOMarker}
TdcDataV1Marker.type((TdcDataV1Marker)arg1) → Type :

Returns type of the marker.

Class psana.Acqiris.TdcVetoIO

class psana.Acqiris.TdcVetoIO

Class with configuration data for Veto IO channel.

Raises an exception This class cannot be instantiated from Python

class Channel
ChVeto = psana.Acqiris.Channel.ChVeto
names = {'ChVeto': psana.Acqiris.Channel.ChVeto}
values = {13: psana.Acqiris.Channel.ChVeto}
class TdcVetoIO.Mode
InvertedSwitchVeto = psana.Acqiris.Mode.InvertedSwitchVeto
InvertedVeto = psana.Acqiris.Mode.InvertedVeto
SwitchVeto = psana.Acqiris.Mode.SwitchVeto
Veto = psana.Acqiris.Mode.Veto
names = {'Veto': psana.Acqiris.Mode.Veto, 'InvertedSwitchVeto': psana.Acqiris.Mode.InvertedSwitchVeto, 'SwitchVeto': psana.Acqiris.Mode.SwitchVeto, 'InvertedVeto': psana.Acqiris.Mode.InvertedVeto}
values = {1: psana.Acqiris.Mode.Veto, 2: psana.Acqiris.Mode.SwitchVeto, 3: psana.Acqiris.Mode.InvertedVeto, 4: psana.Acqiris.Mode.InvertedSwitchVeto}
class TdcVetoIO.Termination
Z50 = psana.Acqiris.Termination.Z50
ZHigh = psana.Acqiris.Termination.ZHigh
names = {'Z50': psana.Acqiris.Termination.Z50, 'ZHigh': psana.Acqiris.Termination.ZHigh}
values = {0: psana.Acqiris.Termination.ZHigh, 1: psana.Acqiris.Termination.Z50}
TdcVetoIO.channel((TdcVetoIO)arg1) → Channel
TdcVetoIO.mode((TdcVetoIO)arg1) → Mode
TdcVetoIO.term((TdcVetoIO)arg1) → Termination

Class psana.Acqiris.TimestampV1

class psana.Acqiris.TimestampV1

Class representing Acqiris timestamp value.

Raises an exception This class cannot be instantiated from Python

pos((TimestampV1)arg1) → float :

Horizontal position, for the segment, of the first (nominal) data point with respect to the origin of the nominal trigger delay in seconds.

timeStampHi((TimestampV1)arg1) → int
timeStampLo((TimestampV1)arg1) → int
value((TimestampV1)arg1) → int :

64-bit trigger timestamp, in units of picoseconds. The timestamp is the trigger time with respect to an arbitrary time origin.

Class psana.Acqiris.TrigV1

class psana.Acqiris.TrigV1

Class containing Acqiris configuration data for triggering.

Raises an exception This class cannot be instantiated from Python

class Coupling
AC = psana.Acqiris.Coupling.AC
AC50ohm = psana.Acqiris.Coupling.AC50ohm
DC = psana.Acqiris.Coupling.DC
DC50ohm = psana.Acqiris.Coupling.DC50ohm
HFreject = psana.Acqiris.Coupling.HFreject
names = {'AC50ohm': psana.Acqiris.Coupling.AC50ohm, 'AC': psana.Acqiris.Coupling.AC, 'HFreject': psana.Acqiris.Coupling.HFreject, 'DC': psana.Acqiris.Coupling.DC, 'DC50ohm': psana.Acqiris.Coupling.DC50ohm}
values = {0: psana.Acqiris.Coupling.DC, 1: psana.Acqiris.Coupling.AC, 2: psana.Acqiris.Coupling.HFreject, 3: psana.Acqiris.Coupling.DC50ohm, 4: psana.Acqiris.Coupling.AC50ohm}
class TrigV1.Slope
HFDivide = psana.Acqiris.Slope.HFDivide
IntoWindow = psana.Acqiris.Slope.IntoWindow
Negative = psana.Acqiris.Slope.Negative
OutOfWindow = psana.Acqiris.Slope.OutOfWindow
Positive = psana.Acqiris.Slope.Positive
SpikeStretcher = psana.Acqiris.Slope.SpikeStretcher
names = {'IntoWindow': psana.Acqiris.Slope.IntoWindow, 'Positive': psana.Acqiris.Slope.Positive, 'Negative': psana.Acqiris.Slope.Negative, 'OutOfWindow': psana.Acqiris.Slope.OutOfWindow, 'HFDivide': psana.Acqiris.Slope.HFDivide, 'SpikeStretcher': psana.Acqiris.Slope.SpikeStretcher}
values = {0: psana.Acqiris.Slope.Positive, 1: psana.Acqiris.Slope.Negative, 2: psana.Acqiris.Slope.OutOfWindow, 3: psana.Acqiris.Slope.IntoWindow, 4: psana.Acqiris.Slope.HFDivide, 5: psana.Acqiris.Slope.SpikeStretcher}
class TrigV1.Source
External = psana.Acqiris.Source.External
Internal = psana.Acqiris.Source.Internal
names = {'Internal': psana.Acqiris.Source.Internal, 'External': psana.Acqiris.Source.External}
values = {1: psana.Acqiris.Source.Internal, -1: psana.Acqiris.Source.External}
TrigV1.coupling((TrigV1)arg1) → int
TrigV1.input((TrigV1)arg1) → int :

Trigger source

TrigV1.level((TrigV1)arg1) → float :

Trigger level.

TrigV1.slope((TrigV1)arg1) → int :

Triggering slope.

Class psana.Acqiris.VertV1

class psana.Acqiris.VertV1

Class containing Acqiris configuration data for vertical axis.

Raises an exception This class cannot be instantiated from Python

class Bandwidth
MHz20 = psana.Acqiris.Bandwidth.MHz20
MHz200 = psana.Acqiris.Bandwidth.MHz200
MHz25 = psana.Acqiris.Bandwidth.MHz25
MHz35 = psana.Acqiris.Bandwidth.MHz35
MHz700 = psana.Acqiris.Bandwidth.MHz700
None = psana.Acqiris.Bandwidth.None
names = {'None': psana.Acqiris.Bandwidth.None, 'MHz700': psana.Acqiris.Bandwidth.MHz700, 'MHz200': psana.Acqiris.Bandwidth.MHz200, 'MHz20': psana.Acqiris.Bandwidth.MHz20, 'MHz35': psana.Acqiris.Bandwidth.MHz35, 'MHz25': psana.Acqiris.Bandwidth.MHz25}
values = {0: psana.Acqiris.Bandwidth.None, 1: psana.Acqiris.Bandwidth.MHz25, 2: psana.Acqiris.Bandwidth.MHz700, 3: psana.Acqiris.Bandwidth.MHz200, 4: psana.Acqiris.Bandwidth.MHz20, 5: psana.Acqiris.Bandwidth.MHz35}
class VertV1.Coupling
AC = psana.Acqiris.Coupling.AC
AC50ohm = psana.Acqiris.Coupling.AC50ohm
DC = psana.Acqiris.Coupling.DC
DC50ohm = psana.Acqiris.Coupling.DC50ohm
GND = psana.Acqiris.Coupling.GND
names = {'AC50ohm': psana.Acqiris.Coupling.AC50ohm, 'AC': psana.Acqiris.Coupling.AC, 'DC': psana.Acqiris.Coupling.DC, 'GND': psana.Acqiris.Coupling.GND, 'DC50ohm': psana.Acqiris.Coupling.DC50ohm}
values = {0: psana.Acqiris.Coupling.GND, 1: psana.Acqiris.Coupling.DC, 2: psana.Acqiris.Coupling.AC, 3: psana.Acqiris.Coupling.DC50ohm, 4: psana.Acqiris.Coupling.AC50ohm}
VertV1.bandwidth((VertV1)arg1) → int :

Bandwidth enumeration.

VertV1.coupling((VertV1)arg1) → int :

Coupling mode.

VertV1.fullScale((VertV1)arg1) → float :

Full vertical scale.

VertV1.offset((VertV1)arg1) → float :

Offset value.

VertV1.slope((VertV1)arg1) → float :

Calculated slope.

Module psana.Alias

The Python wrapper module for Alias types

Class psana.Alias.ConfigV1

class psana.Alias.ConfigV1

Raises an exception This class cannot be instantiated from Python

numSrcAlias((ConfigV1)arg1) → int :

Number of alias definitions

srcAlias((ConfigV1)arg1) → list :

SrcAlias configuration objects

TypeId = 69
Version = 1

Class psana.Alias.SrcAlias

class psana.Alias.SrcAlias

Raises an exception This class cannot be instantiated from Python

aliasName((SrcAlias)arg1) → str :

Alias name for src identifier

aliasName_shape((SrcAlias)arg1) → object
src((SrcAlias)arg1) → psana.Src :

The src identifier

AliasNameMax = 31

Module psana.Andor

The Python wrapper module for Andor types

Class psana.Andor.ConfigV1

class psana.Andor.ConfigV1

Raises an exception This class cannot be instantiated from Python

class EnumFanMode
ENUM_FAN_ACQOFF = psana.Andor.EnumFanMode.ENUM_FAN_ACQOFF
ENUM_FAN_FULL = psana.Andor.EnumFanMode.ENUM_FAN_FULL
ENUM_FAN_LOW = psana.Andor.EnumFanMode.ENUM_FAN_LOW
ENUM_FAN_NUM = psana.Andor.EnumFanMode.ENUM_FAN_NUM
ENUM_FAN_OFF = psana.Andor.EnumFanMode.ENUM_FAN_OFF
names = {'ENUM_FAN_FULL': psana.Andor.EnumFanMode.ENUM_FAN_FULL, 'ENUM_FAN_OFF': psana.Andor.EnumFanMode.ENUM_FAN_OFF, 'ENUM_FAN_NUM': psana.Andor.EnumFanMode.ENUM_FAN_NUM, 'ENUM_FAN_LOW': psana.Andor.EnumFanMode.ENUM_FAN_LOW, 'ENUM_FAN_ACQOFF': psana.Andor.EnumFanMode.ENUM_FAN_ACQOFF}
values = {0: psana.Andor.EnumFanMode.ENUM_FAN_FULL, 1: psana.Andor.EnumFanMode.ENUM_FAN_LOW, 2: psana.Andor.EnumFanMode.ENUM_FAN_OFF, 3: psana.Andor.EnumFanMode.ENUM_FAN_ACQOFF, 4: psana.Andor.EnumFanMode.ENUM_FAN_NUM}
ConfigV1.baselineClamp((ConfigV1)arg1) → int
ConfigV1.binX((ConfigV1)arg1) → int
ConfigV1.binY((ConfigV1)arg1) → int
ConfigV1.coolingTemp((ConfigV1)arg1) → float
ConfigV1.exposureEventCode((ConfigV1)arg1) → int
ConfigV1.exposureTime((ConfigV1)arg1) → float
ConfigV1.fanMode((ConfigV1)arg1) → EnumFanMode
ConfigV1.frameSize((ConfigV1)arg1) → int :

Total size in bytes of the Frame object

ConfigV1.gainIndex((ConfigV1)arg1) → int
ConfigV1.height((ConfigV1)arg1) → int
ConfigV1.highCapacity((ConfigV1)arg1) → int
ConfigV1.numDelayShots((ConfigV1)arg1) → int
ConfigV1.numPixels((ConfigV1)arg1) → int :

calculate total frame size in pixels based on the current ROI and binning settings

ConfigV1.numPixelsX((ConfigV1)arg1) → int :

calculate frame X size in pixels based on the current ROI and binning settings

ConfigV1.numPixelsY((ConfigV1)arg1) → int :

calculate frame Y size in pixels based on the current ROI and binning settings

ConfigV1.orgX((ConfigV1)arg1) → int
ConfigV1.orgY((ConfigV1)arg1) → int
ConfigV1.readoutSpeedIndex((ConfigV1)arg1) → int
ConfigV1.width((ConfigV1)arg1) → int
ConfigV1.TypeId = 60
ConfigV1.Version = 1

Class psana.Andor.ConfigV2

class psana.Andor.ConfigV2

Raises an exception This class cannot be instantiated from Python

class EnumCropMode
ENUM_CROP_EX = psana.Andor.EnumCropMode.ENUM_CROP_EX
ENUM_CROP_NUM = psana.Andor.EnumCropMode.ENUM_CROP_NUM
ENUM_CROP_OFF = psana.Andor.EnumCropMode.ENUM_CROP_OFF
ENUM_CROP_ON = psana.Andor.EnumCropMode.ENUM_CROP_ON
names = {'ENUM_CROP_EX': psana.Andor.EnumCropMode.ENUM_CROP_EX, 'ENUM_CROP_OFF': psana.Andor.EnumCropMode.ENUM_CROP_OFF, 'ENUM_CROP_ON': psana.Andor.EnumCropMode.ENUM_CROP_ON, 'ENUM_CROP_NUM': psana.Andor.EnumCropMode.ENUM_CROP_NUM}
values = {0: psana.Andor.EnumCropMode.ENUM_CROP_OFF, 1: psana.Andor.EnumCropMode.ENUM_CROP_ON, 2: psana.Andor.EnumCropMode.ENUM_CROP_EX, 3: psana.Andor.EnumCropMode.ENUM_CROP_NUM}
class ConfigV2.EnumFanMode
ENUM_FAN_ACQOFF = psana.Andor.EnumFanMode.ENUM_FAN_ACQOFF
ENUM_FAN_FULL = psana.Andor.EnumFanMode.ENUM_FAN_FULL
ENUM_FAN_LOW = psana.Andor.EnumFanMode.ENUM_FAN_LOW
ENUM_FAN_NUM = psana.Andor.EnumFanMode.ENUM_FAN_NUM
ENUM_FAN_OFF = psana.Andor.EnumFanMode.ENUM_FAN_OFF
names = {'ENUM_FAN_FULL': psana.Andor.EnumFanMode.ENUM_FAN_FULL, 'ENUM_FAN_OFF': psana.Andor.EnumFanMode.ENUM_FAN_OFF, 'ENUM_FAN_NUM': psana.Andor.EnumFanMode.ENUM_FAN_NUM, 'ENUM_FAN_LOW': psana.Andor.EnumFanMode.ENUM_FAN_LOW, 'ENUM_FAN_ACQOFF': psana.Andor.EnumFanMode.ENUM_FAN_ACQOFF}
values = {0: psana.Andor.EnumFanMode.ENUM_FAN_FULL, 1: psana.Andor.EnumFanMode.ENUM_FAN_LOW, 2: psana.Andor.EnumFanMode.ENUM_FAN_OFF, 3: psana.Andor.EnumFanMode.ENUM_FAN_ACQOFF, 4: psana.Andor.EnumFanMode.ENUM_FAN_NUM}
ConfigV2.baselineClamp((ConfigV2)arg1) → int
ConfigV2.binX((ConfigV2)arg1) → int
ConfigV2.binY((ConfigV2)arg1) → int
ConfigV2.coolingTemp((ConfigV2)arg1) → float
ConfigV2.cropMode((ConfigV2)arg1) → EnumCropMode
ConfigV2.exposureEventCode((ConfigV2)arg1) → int
ConfigV2.exposureTime((ConfigV2)arg1) → float
ConfigV2.fanMode((ConfigV2)arg1) → EnumFanMode
ConfigV2.frameSize((ConfigV2)arg1) → int :

Total size in bytes of the Frame object

ConfigV2.gainIndex((ConfigV2)arg1) → int
ConfigV2.height((ConfigV2)arg1) → int
ConfigV2.highCapacity((ConfigV2)arg1) → int
ConfigV2.numDelayShots((ConfigV2)arg1) → int
ConfigV2.numPixels((ConfigV2)arg1) → int :

calculate total frame size in pixels based on the current ROI and binning settings

ConfigV2.numPixelsX((ConfigV2)arg1) → int :

calculate frame X size in pixels based on the current ROI and binning settings

ConfigV2.numPixelsY((ConfigV2)arg1) → int :

calculate frame Y size in pixels based on the current ROI and binning settings

ConfigV2.orgX((ConfigV2)arg1) → int
ConfigV2.orgY((ConfigV2)arg1) → int
ConfigV2.readoutSpeedIndex((ConfigV2)arg1) → int
ConfigV2.width((ConfigV2)arg1) → int
ConfigV2.TypeId = 60
ConfigV2.Version = 2

Class psana.Andor.FrameV1

class psana.Andor.FrameV1

Raises an exception This class cannot be instantiated from Python

data((FrameV1)arg1) → numpy.ndarray
readoutTime((FrameV1)arg1) → float
shotIdStart((FrameV1)arg1) → int
temperature((FrameV1)arg1) → float
TypeId = 61
Version = 1

Module psana.Andor3d

The Python wrapper module for Andor3d types

Class psana.Andor3d.ConfigV1

class psana.Andor3d.ConfigV1

Raises an exception This class cannot be instantiated from Python

class EnumFanMode
ENUM_FAN_ACQOFF = psana.Andor3d.EnumFanMode.ENUM_FAN_ACQOFF
ENUM_FAN_FULL = psana.Andor3d.EnumFanMode.ENUM_FAN_FULL
ENUM_FAN_LOW = psana.Andor3d.EnumFanMode.ENUM_FAN_LOW
ENUM_FAN_NUM = psana.Andor3d.EnumFanMode.ENUM_FAN_NUM
ENUM_FAN_OFF = psana.Andor3d.EnumFanMode.ENUM_FAN_OFF
names = {'ENUM_FAN_FULL': psana.Andor3d.EnumFanMode.ENUM_FAN_FULL, 'ENUM_FAN_OFF': psana.Andor3d.EnumFanMode.ENUM_FAN_OFF, 'ENUM_FAN_NUM': psana.Andor3d.EnumFanMode.ENUM_FAN_NUM, 'ENUM_FAN_LOW': psana.Andor3d.EnumFanMode.ENUM_FAN_LOW, 'ENUM_FAN_ACQOFF': psana.Andor3d.EnumFanMode.ENUM_FAN_ACQOFF}
values = {0: psana.Andor3d.EnumFanMode.ENUM_FAN_FULL, 1: psana.Andor3d.EnumFanMode.ENUM_FAN_LOW, 2: psana.Andor3d.EnumFanMode.ENUM_FAN_OFF, 3: psana.Andor3d.EnumFanMode.ENUM_FAN_ACQOFF, 4: psana.Andor3d.EnumFanMode.ENUM_FAN_NUM}
ConfigV1.baselineClamp((ConfigV1)arg1) → int
ConfigV1.binX((ConfigV1)arg1) → int
ConfigV1.binY((ConfigV1)arg1) → int
ConfigV1.coolingTemp((ConfigV1)arg1) → float
ConfigV1.exposureEventCode((ConfigV1)arg1) → int
ConfigV1.exposureStartDelay((ConfigV1)arg1) → int
ConfigV1.exposureTime((ConfigV1)arg1) → float
ConfigV1.fanMode((ConfigV1)arg1) → EnumFanMode
ConfigV1.frameSize((ConfigV1)arg1) → int :

Total size in bytes of the Frame object

ConfigV1.gainIndex((ConfigV1)arg1) → int
ConfigV1.height((ConfigV1)arg1) → int
ConfigV1.highCapacity((ConfigV1)arg1) → int
ConfigV1.numDelayShots((ConfigV1)arg1) → int
ConfigV1.numPixels((ConfigV1)arg1) → int :

calculate total frame size in pixels based on the current ROI and binning settings

ConfigV1.numPixelsPerSensor((ConfigV1)arg1) → int :

calculate total frame size in pixels per sensor based on the current ROI and binning settings

ConfigV1.numPixelsX((ConfigV1)arg1) → int :

calculate frame X size in pixels per sensor based on the current ROI and binning settings

ConfigV1.numPixelsY((ConfigV1)arg1) → int :

calculate frame Y size in pixels per sensor based on the current ROI and binning settings

ConfigV1.numSensors((ConfigV1)arg1) → int
ConfigV1.orgX((ConfigV1)arg1) → int
ConfigV1.orgY((ConfigV1)arg1) → int
ConfigV1.readoutSpeedIndex((ConfigV1)arg1) → int
ConfigV1.width((ConfigV1)arg1) → int
ConfigV1.TypeId = 96
ConfigV1.Version = 1

Class psana.Andor3d.FrameV1

class psana.Andor3d.FrameV1

Raises an exception This class cannot be instantiated from Python

data((FrameV1)arg1) → numpy.ndarray
readoutTime((FrameV1)arg1) → float
shotIdStart((FrameV1)arg1) → int
temperature((FrameV1)arg1) → numpy.ndarray
TypeId = 97
Version = 1

Module psana.Arraychar

The Python wrapper module for Arraychar types

Class psana.Arraychar.DataV1

class psana.Arraychar.DataV1

Raises an exception This class cannot be instantiated from Python

data((DataV1)arg1) → numpy.ndarray
numChars((DataV1)arg1) → int
TypeId = 82
Version = 1

Module psana.Bld

The Python wrapper module for Bld types

Class psana.Bld.BldDataAcqADCV1

class psana.Bld.BldDataAcqADCV1

Combined structure which includes Acqiris.ConfigV1 and Acqiris.DataDescV1 objects.

Raises an exception This class cannot be instantiated from Python

config((BldDataAcqADCV1)arg1) → ConfigV1
data((BldDataAcqADCV1)arg1) → DataDescV1
TypeId = 65
Version = 1

Class psana.Bld.BldDataAnalogInputV1

class psana.Bld.BldDataAnalogInputV1

Structure which contains voltage data from an analog input device.

Raises an exception This class cannot be instantiated from Python

channelVoltages((BldDataAnalogInputV1)arg1) → numpy.ndarray :

Array of voltage values were each entry represents a channel of the analog input device.

numChannels((BldDataAnalogInputV1)arg1) → int :

The number of active channels on the analog input device.

TypeId = 94
Version = 1

Class psana.Bld.BldDataBeamMonitorV1

class psana.Bld.BldDataBeamMonitorV1

Intensity and Position Measurements

Raises an exception This class cannot be instantiated from Python

TotalIntensity((BldDataBeamMonitorV1)arg1) → float :

Value of Total Intensity, in J.

X_Position((BldDataBeamMonitorV1)arg1) → float :

Value of X Position, in m.

Y_Position((BldDataBeamMonitorV1)arg1) → float :

Value of Y Position, in m.

peakA((BldDataBeamMonitorV1)arg1) → numpy.ndarray :

Peak Amplitude of Channel

peakT((BldDataBeamMonitorV1)arg1) → numpy.ndarray :

Location of Peak Amplitude of Channel

NCHANNELS = 16
TypeId = 98
Version = 1

Class psana.Bld.BldDataEBeamV0

class psana.Bld.BldDataEBeamV0

Beam parameters.

Raises an exception This class cannot be instantiated from Python

class DamageMask
EbeamChargeDamage = psana.Bld.DamageMask.EbeamChargeDamage
EbeamL3EnergyDamage = psana.Bld.DamageMask.EbeamL3EnergyDamage
EbeamLTUAngXDamage = psana.Bld.DamageMask.EbeamLTUAngXDamage
EbeamLTUAngYDamage = psana.Bld.DamageMask.EbeamLTUAngYDamage
EbeamLTUPosXDamage = psana.Bld.DamageMask.EbeamLTUPosXDamage
EbeamLTUPosYDamage = psana.Bld.DamageMask.EbeamLTUPosYDamage
names = {'EbeamLTUAngYDamage': psana.Bld.DamageMask.EbeamLTUAngYDamage, 'EbeamLTUPosXDamage': psana.Bld.DamageMask.EbeamLTUPosXDamage, 'EbeamLTUPosYDamage': psana.Bld.DamageMask.EbeamLTUPosYDamage, 'EbeamLTUAngXDamage': psana.Bld.DamageMask.EbeamLTUAngXDamage, 'EbeamChargeDamage': psana.Bld.DamageMask.EbeamChargeDamage, 'EbeamL3EnergyDamage': psana.Bld.DamageMask.EbeamL3EnergyDamage}
values = {32: psana.Bld.DamageMask.EbeamLTUAngYDamage, 1: psana.Bld.DamageMask.EbeamChargeDamage, 2: psana.Bld.DamageMask.EbeamL3EnergyDamage, 4: psana.Bld.DamageMask.EbeamLTUPosXDamage, 8: psana.Bld.DamageMask.EbeamLTUPosYDamage, 16: psana.Bld.DamageMask.EbeamLTUAngXDamage}
BldDataEBeamV0.damageMask((BldDataEBeamV0)arg1) → int :

Damage mask.

BldDataEBeamV0.ebeamCharge((BldDataEBeamV0)arg1) → float :

Beam charge in nC.

BldDataEBeamV0.ebeamL3Energy((BldDataEBeamV0)arg1) → float :

Beam energy in MeV.

BldDataEBeamV0.ebeamLTUAngX((BldDataEBeamV0)arg1) → float :

LTU beam angle in mrad.

BldDataEBeamV0.ebeamLTUAngY((BldDataEBeamV0)arg1) → float :

LTU beam angle in mrad.

BldDataEBeamV0.ebeamLTUPosX((BldDataEBeamV0)arg1) → float :

LTU beam position in mm.

BldDataEBeamV0.ebeamLTUPosY((BldDataEBeamV0)arg1) → float :

LTU beam position in mm.

BldDataEBeamV0.TypeId = 15
BldDataEBeamV0.Version = 0

Class psana.Bld.BldDataEBeamV1

class psana.Bld.BldDataEBeamV1

Raises an exception This class cannot be instantiated from Python

class DamageMask
EbeamChargeDamage = psana.Bld.DamageMask.EbeamChargeDamage
EbeamL3EnergyDamage = psana.Bld.DamageMask.EbeamL3EnergyDamage
EbeamLTUAngXDamage = psana.Bld.DamageMask.EbeamLTUAngXDamage
EbeamLTUAngYDamage = psana.Bld.DamageMask.EbeamLTUAngYDamage
EbeamLTUPosXDamage = psana.Bld.DamageMask.EbeamLTUPosXDamage
EbeamLTUPosYDamage = psana.Bld.DamageMask.EbeamLTUPosYDamage
EbeamPkCurrBC2Damage = psana.Bld.DamageMask.EbeamPkCurrBC2Damage
names = {'EbeamPkCurrBC2Damage': psana.Bld.DamageMask.EbeamPkCurrBC2Damage, 'EbeamLTUAngYDamage': psana.Bld.DamageMask.EbeamLTUAngYDamage, 'EbeamLTUPosXDamage': psana.Bld.DamageMask.EbeamLTUPosXDamage, 'EbeamLTUPosYDamage': psana.Bld.DamageMask.EbeamLTUPosYDamage, 'EbeamLTUAngXDamage': psana.Bld.DamageMask.EbeamLTUAngXDamage, 'EbeamChargeDamage': psana.Bld.DamageMask.EbeamChargeDamage, 'EbeamL3EnergyDamage': psana.Bld.DamageMask.EbeamL3EnergyDamage}
values = {32: psana.Bld.DamageMask.EbeamLTUAngYDamage, 1: psana.Bld.DamageMask.EbeamChargeDamage, 2: psana.Bld.DamageMask.EbeamL3EnergyDamage, 4: psana.Bld.DamageMask.EbeamLTUPosXDamage, 8: psana.Bld.DamageMask.EbeamLTUPosYDamage, 64: psana.Bld.DamageMask.EbeamPkCurrBC2Damage, 16: psana.Bld.DamageMask.EbeamLTUAngXDamage}
BldDataEBeamV1.damageMask((BldDataEBeamV1)arg1) → int :

Damage mask.

BldDataEBeamV1.ebeamCharge((BldDataEBeamV1)arg1) → float :

Beam charge in nC.

BldDataEBeamV1.ebeamL3Energy((BldDataEBeamV1)arg1) → float :

Beam energy in MeV.

BldDataEBeamV1.ebeamLTUAngX((BldDataEBeamV1)arg1) → float :

LTU beam angle in mrad.

BldDataEBeamV1.ebeamLTUAngY((BldDataEBeamV1)arg1) → float :

LTU beam angle in mrad.

BldDataEBeamV1.ebeamLTUPosX((BldDataEBeamV1)arg1) → float :

LTU beam position in mm.

BldDataEBeamV1.ebeamLTUPosY((BldDataEBeamV1)arg1) → float :

LTU beam position in mm.

BldDataEBeamV1.ebeamPkCurrBC2((BldDataEBeamV1)arg1) → float :

Beam current in Amps.

BldDataEBeamV1.TypeId = 15
BldDataEBeamV1.Version = 1

Class psana.Bld.BldDataEBeamV2

class psana.Bld.BldDataEBeamV2

Raises an exception This class cannot be instantiated from Python

class DamageMask
EbeamChargeDamage = psana.Bld.DamageMask.EbeamChargeDamage
EbeamEnergyBC2Damage = psana.Bld.DamageMask.EbeamEnergyBC2Damage
EbeamL3EnergyDamage = psana.Bld.DamageMask.EbeamL3EnergyDamage
EbeamLTUAngXDamage = psana.Bld.DamageMask.EbeamLTUAngXDamage
EbeamLTUAngYDamage = psana.Bld.DamageMask.EbeamLTUAngYDamage
EbeamLTUPosXDamage = psana.Bld.DamageMask.EbeamLTUPosXDamage
EbeamLTUPosYDamage = psana.Bld.DamageMask.EbeamLTUPosYDamage
EbeamPkCurrBC2Damage = psana.Bld.DamageMask.EbeamPkCurrBC2Damage
names = {'EbeamPkCurrBC2Damage': psana.Bld.DamageMask.EbeamPkCurrBC2Damage, 'EbeamLTUAngYDamage': psana.Bld.DamageMask.EbeamLTUAngYDamage, 'EbeamLTUPosXDamage': psana.Bld.DamageMask.EbeamLTUPosXDamage, 'EbeamLTUPosYDamage': psana.Bld.DamageMask.EbeamLTUPosYDamage, 'EbeamLTUAngXDamage': psana.Bld.DamageMask.EbeamLTUAngXDamage, 'EbeamChargeDamage': psana.Bld.DamageMask.EbeamChargeDamage, 'EbeamEnergyBC2Damage': psana.Bld.DamageMask.EbeamEnergyBC2Damage, 'EbeamL3EnergyDamage': psana.Bld.DamageMask.EbeamL3EnergyDamage}
values = {32: psana.Bld.DamageMask.EbeamLTUAngYDamage, 1: psana.Bld.DamageMask.EbeamChargeDamage, 2: psana.Bld.DamageMask.EbeamL3EnergyDamage, 4: psana.Bld.DamageMask.EbeamLTUPosXDamage, 8: psana.Bld.DamageMask.EbeamLTUPosYDamage, 64: psana.Bld.DamageMask.EbeamPkCurrBC2Damage, 128: psana.Bld.DamageMask.EbeamEnergyBC2Damage, 16: psana.Bld.DamageMask.EbeamLTUAngXDamage}
BldDataEBeamV2.damageMask((BldDataEBeamV2)arg1) → int :

Damage mask.

BldDataEBeamV2.ebeamCharge((BldDataEBeamV2)arg1) → float :

Beam charge in nC.

BldDataEBeamV2.ebeamEnergyBC2((BldDataEBeamV2)arg1) → float :

Beam energy in MeV.

BldDataEBeamV2.ebeamL3Energy((BldDataEBeamV2)arg1) → float :

Beam energy in MeV.

BldDataEBeamV2.ebeamLTUAngX((BldDataEBeamV2)arg1) → float :

LTU beam angle in mrad.

BldDataEBeamV2.ebeamLTUAngY((BldDataEBeamV2)arg1) → float :

LTU beam angle in mrad.

BldDataEBeamV2.ebeamLTUPosX((BldDataEBeamV2)arg1) → float :

LTU beam position in mm.

BldDataEBeamV2.ebeamLTUPosY((BldDataEBeamV2)arg1) → float :

LTU beam position in mm.

BldDataEBeamV2.ebeamPkCurrBC2((BldDataEBeamV2)arg1) → float :

Beam current in Amps.

BldDataEBeamV2.TypeId = 15
BldDataEBeamV2.Version = 2

Class psana.Bld.BldDataEBeamV3

class psana.Bld.BldDataEBeamV3

Raises an exception This class cannot be instantiated from Python

class DamageMask
EbeamChargeDamage = psana.Bld.DamageMask.EbeamChargeDamage
EbeamEnergyBC1Damage = psana.Bld.DamageMask.EbeamEnergyBC1Damage
EbeamEnergyBC2Damage = psana.Bld.DamageMask.EbeamEnergyBC2Damage
EbeamL3EnergyDamage = psana.Bld.DamageMask.EbeamL3EnergyDamage
EbeamLTUAngXDamage = psana.Bld.DamageMask.EbeamLTUAngXDamage
EbeamLTUAngYDamage = psana.Bld.DamageMask.EbeamLTUAngYDamage
EbeamLTUPosXDamage = psana.Bld.DamageMask.EbeamLTUPosXDamage
EbeamLTUPosYDamage = psana.Bld.DamageMask.EbeamLTUPosYDamage
EbeamPkCurrBC1Damage = psana.Bld.DamageMask.EbeamPkCurrBC1Damage
EbeamPkCurrBC2Damage = psana.Bld.DamageMask.EbeamPkCurrBC2Damage
names = {'EbeamPkCurrBC2Damage': psana.Bld.DamageMask.EbeamPkCurrBC2Damage, 'EbeamLTUAngYDamage': psana.Bld.DamageMask.EbeamLTUAngYDamage, 'EbeamLTUPosXDamage': psana.Bld.DamageMask.EbeamLTUPosXDamage, 'EbeamPkCurrBC1Damage': psana.Bld.DamageMask.EbeamPkCurrBC1Damage, 'EbeamLTUPosYDamage': psana.Bld.DamageMask.EbeamLTUPosYDamage, 'EbeamLTUAngXDamage': psana.Bld.DamageMask.EbeamLTUAngXDamage, 'EbeamChargeDamage': psana.Bld.DamageMask.EbeamChargeDamage, 'EbeamEnergyBC2Damage': psana.Bld.DamageMask.EbeamEnergyBC2Damage, 'EbeamL3EnergyDamage': psana.Bld.DamageMask.EbeamL3EnergyDamage, 'EbeamEnergyBC1Damage': psana.Bld.DamageMask.EbeamEnergyBC1Damage}
values = {32: psana.Bld.DamageMask.EbeamLTUAngYDamage, 1: psana.Bld.DamageMask.EbeamChargeDamage, 2: psana.Bld.DamageMask.EbeamL3EnergyDamage, 4: psana.Bld.DamageMask.EbeamLTUPosXDamage, 8: psana.Bld.DamageMask.EbeamLTUPosYDamage, 64: psana.Bld.DamageMask.EbeamPkCurrBC2Damage, 128: psana.Bld.DamageMask.EbeamEnergyBC2Damage, 256: psana.Bld.DamageMask.EbeamPkCurrBC1Damage, 16: psana.Bld.DamageMask.EbeamLTUAngXDamage, 512: psana.Bld.DamageMask.EbeamEnergyBC1Damage}
BldDataEBeamV3.damageMask((BldDataEBeamV3)arg1) → int :

Damage mask.

BldDataEBeamV3.ebeamCharge((BldDataEBeamV3)arg1) → float :

Beam charge in nC.

BldDataEBeamV3.ebeamEnergyBC1((BldDataEBeamV3)arg1) → float :

Beam position in mm (related to beam energy).

BldDataEBeamV3.ebeamEnergyBC2((BldDataEBeamV3)arg1) → float :

Beam position in mm (related to beam energy).

BldDataEBeamV3.ebeamL3Energy((BldDataEBeamV3)arg1) → float :

Beam energy in MeV.

BldDataEBeamV3.ebeamLTUAngX((BldDataEBeamV3)arg1) → float :

LTU beam angle in mrad.

BldDataEBeamV3.ebeamLTUAngY((BldDataEBeamV3)arg1) → float :

LTU beam angle in mrad.

BldDataEBeamV3.ebeamLTUPosX((BldDataEBeamV3)arg1) → float :

LTU beam position in mm.

BldDataEBeamV3.ebeamLTUPosY((BldDataEBeamV3)arg1) → float :

LTU beam position in mm.

BldDataEBeamV3.ebeamPkCurrBC1((BldDataEBeamV3)arg1) → float :

Beam current in Amps.

BldDataEBeamV3.ebeamPkCurrBC2((BldDataEBeamV3)arg1) → float :

Beam current in Amps.

BldDataEBeamV3.TypeId = 15
BldDataEBeamV3.Version = 3

Class psana.Bld.BldDataEBeamV4

class psana.Bld.BldDataEBeamV4

Raises an exception This class cannot be instantiated from Python

class DamageMask
EbeamChargeDamage = psana.Bld.DamageMask.EbeamChargeDamage
EbeamEnergyBC1Damage = psana.Bld.DamageMask.EbeamEnergyBC1Damage
EbeamEnergyBC2Damage = psana.Bld.DamageMask.EbeamEnergyBC2Damage
EbeamL3EnergyDamage = psana.Bld.DamageMask.EbeamL3EnergyDamage
EbeamLTUAngXDamage = psana.Bld.DamageMask.EbeamLTUAngXDamage
EbeamLTUAngYDamage = psana.Bld.DamageMask.EbeamLTUAngYDamage
EbeamLTUPosXDamage = psana.Bld.DamageMask.EbeamLTUPosXDamage
EbeamLTUPosYDamage = psana.Bld.DamageMask.EbeamLTUPosYDamage
EbeamPkCurrBC1Damage = psana.Bld.DamageMask.EbeamPkCurrBC1Damage
EbeamPkCurrBC2Damage = psana.Bld.DamageMask.EbeamPkCurrBC2Damage
EbeamUndAngXDamage = psana.Bld.DamageMask.EbeamUndAngXDamage
EbeamUndAngYDamage = psana.Bld.DamageMask.EbeamUndAngYDamage
EbeamUndPosXDamage = psana.Bld.DamageMask.EbeamUndPosXDamage
EbeamUndPosYDamage = psana.Bld.DamageMask.EbeamUndPosYDamage
names = {'EbeamPkCurrBC2Damage': psana.Bld.DamageMask.EbeamPkCurrBC2Damage, 'EbeamLTUAngYDamage': psana.Bld.DamageMask.EbeamLTUAngYDamage, 'EbeamLTUPosXDamage': psana.Bld.DamageMask.EbeamLTUPosXDamage, 'EbeamPkCurrBC1Damage': psana.Bld.DamageMask.EbeamPkCurrBC1Damage, 'EbeamLTUPosYDamage': psana.Bld.DamageMask.EbeamLTUPosYDamage, 'EbeamUndPosYDamage': psana.Bld.DamageMask.EbeamUndPosYDamage, 'EbeamUndAngYDamage': psana.Bld.DamageMask.EbeamUndAngYDamage, 'EbeamLTUAngXDamage': psana.Bld.DamageMask.EbeamLTUAngXDamage, 'EbeamChargeDamage': psana.Bld.DamageMask.EbeamChargeDamage, 'EbeamEnergyBC2Damage': psana.Bld.DamageMask.EbeamEnergyBC2Damage, 'EbeamL3EnergyDamage': psana.Bld.DamageMask.EbeamL3EnergyDamage, 'EbeamUndPosXDamage': psana.Bld.DamageMask.EbeamUndPosXDamage, 'EbeamEnergyBC1Damage': psana.Bld.DamageMask.EbeamEnergyBC1Damage, 'EbeamUndAngXDamage': psana.Bld.DamageMask.EbeamUndAngXDamage}
values = {32: psana.Bld.DamageMask.EbeamLTUAngYDamage, 1: psana.Bld.DamageMask.EbeamChargeDamage, 2: psana.Bld.DamageMask.EbeamL3EnergyDamage, 4096: psana.Bld.DamageMask.EbeamUndAngXDamage, 4: psana.Bld.DamageMask.EbeamLTUPosXDamage, 1024: psana.Bld.DamageMask.EbeamUndPosXDamage, 8192: psana.Bld.DamageMask.EbeamUndAngYDamage, 8: psana.Bld.DamageMask.EbeamLTUPosYDamage, 64: psana.Bld.DamageMask.EbeamPkCurrBC2Damage, 128: psana.Bld.DamageMask.EbeamEnergyBC2Damage, 256: psana.Bld.DamageMask.EbeamPkCurrBC1Damage, 16: psana.Bld.DamageMask.EbeamLTUAngXDamage, 512: psana.Bld.DamageMask.EbeamEnergyBC1Damage, 2048: psana.Bld.DamageMask.EbeamUndPosYDamage}
BldDataEBeamV4.damageMask((BldDataEBeamV4)arg1) → int :

Damage mask.

BldDataEBeamV4.ebeamCharge((BldDataEBeamV4)arg1) → float :

Beam charge in nC.

BldDataEBeamV4.ebeamEnergyBC1((BldDataEBeamV4)arg1) → float :

Beam position in mm (related to beam energy).

BldDataEBeamV4.ebeamEnergyBC2((BldDataEBeamV4)arg1) → float :

Beam position in mm (related to beam energy).

BldDataEBeamV4.ebeamL3Energy((BldDataEBeamV4)arg1) → float :

Beam energy in MeV.

BldDataEBeamV4.ebeamLTUAngX((BldDataEBeamV4)arg1) → float :

LTU beam angle in mrad.

BldDataEBeamV4.ebeamLTUAngY((BldDataEBeamV4)arg1) → float :

LTU beam angle in mrad.

BldDataEBeamV4.ebeamLTUPosX((BldDataEBeamV4)arg1) → float :

LTU beam position (BPMS:LTU1:720 through 750) in mm.

BldDataEBeamV4.ebeamLTUPosY((BldDataEBeamV4)arg1) → float :

LTU beam position in mm.

BldDataEBeamV4.ebeamPkCurrBC1((BldDataEBeamV4)arg1) → float :

Beam current in Amps.

BldDataEBeamV4.ebeamPkCurrBC2((BldDataEBeamV4)arg1) → float :

Beam current in Amps.

BldDataEBeamV4.ebeamUndAngX((BldDataEBeamV4)arg1) → float :

Undulator launch feedback beam x-angle in mrad.

BldDataEBeamV4.ebeamUndAngY((BldDataEBeamV4)arg1) → float :

Undulator launch feedback beam y-angle in mrad.

BldDataEBeamV4.ebeamUndPosX((BldDataEBeamV4)arg1) → float :

Undulator launch feedback (BPMs U4 through U10) beam x-position in mm.

BldDataEBeamV4.ebeamUndPosY((BldDataEBeamV4)arg1) → float :

Undulator launch feedback beam y-position in mm.

BldDataEBeamV4.TypeId = 15
BldDataEBeamV4.Version = 4

Class psana.Bld.BldDataEBeamV5

class psana.Bld.BldDataEBeamV5

Raises an exception This class cannot be instantiated from Python

class DamageMask
EbeamChargeDamage = psana.Bld.DamageMask.EbeamChargeDamage
EbeamDumpChargeDamage = psana.Bld.DamageMask.EbeamDumpChargeDamage
EbeamEnergyBC1Damage = psana.Bld.DamageMask.EbeamEnergyBC1Damage
EbeamEnergyBC2Damage = psana.Bld.DamageMask.EbeamEnergyBC2Damage
EbeamL3EnergyDamage = psana.Bld.DamageMask.EbeamL3EnergyDamage
EbeamLTUAngXDamage = psana.Bld.DamageMask.EbeamLTUAngXDamage
EbeamLTUAngYDamage = psana.Bld.DamageMask.EbeamLTUAngYDamage
EbeamLTUPosXDamage = psana.Bld.DamageMask.EbeamLTUPosXDamage
EbeamLTUPosYDamage = psana.Bld.DamageMask.EbeamLTUPosYDamage
EbeamPkCurrBC1Damage = psana.Bld.DamageMask.EbeamPkCurrBC1Damage
EbeamPkCurrBC2Damage = psana.Bld.DamageMask.EbeamPkCurrBC2Damage
EbeamUndAngXDamage = psana.Bld.DamageMask.EbeamUndAngXDamage
EbeamUndAngYDamage = psana.Bld.DamageMask.EbeamUndAngYDamage
EbeamUndPosXDamage = psana.Bld.DamageMask.EbeamUndPosXDamage
EbeamUndPosYDamage = psana.Bld.DamageMask.EbeamUndPosYDamage
EbeamXTCAVAmplDamage = psana.Bld.DamageMask.EbeamXTCAVAmplDamage
EbeamXTCAVPhaseDamage = psana.Bld.DamageMask.EbeamXTCAVPhaseDamage
names = {'EbeamPkCurrBC2Damage': psana.Bld.DamageMask.EbeamPkCurrBC2Damage, 'EbeamDumpChargeDamage': psana.Bld.DamageMask.EbeamDumpChargeDamage, 'EbeamLTUAngYDamage': psana.Bld.DamageMask.EbeamLTUAngYDamage, 'EbeamLTUPosXDamage': psana.Bld.DamageMask.EbeamLTUPosXDamage, 'EbeamXTCAVAmplDamage': psana.Bld.DamageMask.EbeamXTCAVAmplDamage, 'EbeamPkCurrBC1Damage': psana.Bld.DamageMask.EbeamPkCurrBC1Damage, 'EbeamLTUPosYDamage': psana.Bld.DamageMask.EbeamLTUPosYDamage, 'EbeamUndPosYDamage': psana.Bld.DamageMask.EbeamUndPosYDamage, 'EbeamUndAngYDamage': psana.Bld.DamageMask.EbeamUndAngYDamage, 'EbeamLTUAngXDamage': psana.Bld.DamageMask.EbeamLTUAngXDamage, 'EbeamChargeDamage': psana.Bld.DamageMask.EbeamChargeDamage, 'EbeamXTCAVPhaseDamage': psana.Bld.DamageMask.EbeamXTCAVPhaseDamage, 'EbeamEnergyBC2Damage': psana.Bld.DamageMask.EbeamEnergyBC2Damage, 'EbeamL3EnergyDamage': psana.Bld.DamageMask.EbeamL3EnergyDamage, 'EbeamUndPosXDamage': psana.Bld.DamageMask.EbeamUndPosXDamage, 'EbeamEnergyBC1Damage': psana.Bld.DamageMask.EbeamEnergyBC1Damage, 'EbeamUndAngXDamage': psana.Bld.DamageMask.EbeamUndAngXDamage}
values = {32: psana.Bld.DamageMask.EbeamLTUAngYDamage, 1: psana.Bld.DamageMask.EbeamChargeDamage, 2: psana.Bld.DamageMask.EbeamL3EnergyDamage, 4096: psana.Bld.DamageMask.EbeamUndAngXDamage, 4: psana.Bld.DamageMask.EbeamLTUPosXDamage, 1024: psana.Bld.DamageMask.EbeamUndPosXDamage, 8192: psana.Bld.DamageMask.EbeamUndAngYDamage, 8: psana.Bld.DamageMask.EbeamLTUPosYDamage, 64: psana.Bld.DamageMask.EbeamPkCurrBC2Damage, 128: psana.Bld.DamageMask.EbeamEnergyBC2Damage, 256: psana.Bld.DamageMask.EbeamPkCurrBC1Damage, 16384: psana.Bld.DamageMask.EbeamXTCAVAmplDamage, 16: psana.Bld.DamageMask.EbeamLTUAngXDamage, 512: psana.Bld.DamageMask.EbeamEnergyBC1Damage, 32768: psana.Bld.DamageMask.EbeamXTCAVPhaseDamage, 65536: psana.Bld.DamageMask.EbeamDumpChargeDamage, 2048: psana.Bld.DamageMask.EbeamUndPosYDamage}
BldDataEBeamV5.damageMask((BldDataEBeamV5)arg1) → int :

Damage mask.

BldDataEBeamV5.ebeamCharge((BldDataEBeamV5)arg1) → float :

Beam charge in nC.

BldDataEBeamV5.ebeamDumpCharge((BldDataEBeamV5)arg1) → float :

Bunch charge at Dump in num. electrons

BldDataEBeamV5.ebeamEnergyBC1((BldDataEBeamV5)arg1) → float :

Beam position in mm (related to beam energy).

BldDataEBeamV5.ebeamEnergyBC2((BldDataEBeamV5)arg1) → float :

Beam position in mm (related to beam energy).

BldDataEBeamV5.ebeamL3Energy((BldDataEBeamV5)arg1) → float :

Beam energy in MeV.

BldDataEBeamV5.ebeamLTUAngX((BldDataEBeamV5)arg1) → float :

LTU beam angle in mrad.

BldDataEBeamV5.ebeamLTUAngY((BldDataEBeamV5)arg1) → float :

LTU beam angle in mrad.

BldDataEBeamV5.ebeamLTUPosX((BldDataEBeamV5)arg1) → float :

LTU beam position (BPMS:LTU1:720 through 750) in mm.

BldDataEBeamV5.ebeamLTUPosY((BldDataEBeamV5)arg1) → float :

LTU beam position in mm.

BldDataEBeamV5.ebeamPkCurrBC1((BldDataEBeamV5)arg1) → float :

Beam current in Amps.

BldDataEBeamV5.ebeamPkCurrBC2((BldDataEBeamV5)arg1) → float :

Beam current in Amps.

BldDataEBeamV5.ebeamUndAngX((BldDataEBeamV5)arg1) → float :

Undulator launch feedback beam x-angle in mrad.

BldDataEBeamV5.ebeamUndAngY((BldDataEBeamV5)arg1) → float :

Undulator launch feedback beam y-angle in mrad.

BldDataEBeamV5.ebeamUndPosX((BldDataEBeamV5)arg1) → float :

Undulator launch feedback (BPMs U4 through U10) beam x-position in mm.

BldDataEBeamV5.ebeamUndPosY((BldDataEBeamV5)arg1) → float :

Undulator launch feedback beam y-position in mm.

BldDataEBeamV5.ebeamXTCAVAmpl((BldDataEBeamV5)arg1) → float :

XTCAV Amplitude in MVolt.

BldDataEBeamV5.ebeamXTCAVPhase((BldDataEBeamV5)arg1) → float :

XTCAV Phase in degrees.

BldDataEBeamV5.TypeId = 15
BldDataEBeamV5.Version = 5

Class psana.Bld.BldDataEBeamV6

class psana.Bld.BldDataEBeamV6

Raises an exception This class cannot be instantiated from Python

class DamageMask
EbeamChargeDamage = psana.Bld.DamageMask.EbeamChargeDamage
EbeamDumpChargeDamage = psana.Bld.DamageMask.EbeamDumpChargeDamage
EbeamEnergyBC1Damage = psana.Bld.DamageMask.EbeamEnergyBC1Damage
EbeamEnergyBC2Damage = psana.Bld.DamageMask.EbeamEnergyBC2Damage
EbeamL3EnergyDamage = psana.Bld.DamageMask.EbeamL3EnergyDamage
EbeamLTUAngXDamage = psana.Bld.DamageMask.EbeamLTUAngXDamage
EbeamLTUAngYDamage = psana.Bld.DamageMask.EbeamLTUAngYDamage
EbeamLTUPosXDamage = psana.Bld.DamageMask.EbeamLTUPosXDamage
EbeamLTUPosYDamage = psana.Bld.DamageMask.EbeamLTUPosYDamage
EbeamPhotonEnergyDamage = psana.Bld.DamageMask.EbeamPhotonEnergyDamage
EbeamPkCurrBC1Damage = psana.Bld.DamageMask.EbeamPkCurrBC1Damage
EbeamPkCurrBC2Damage = psana.Bld.DamageMask.EbeamPkCurrBC2Damage
EbeamUndAngXDamage = psana.Bld.DamageMask.EbeamUndAngXDamage
EbeamUndAngYDamage = psana.Bld.DamageMask.EbeamUndAngYDamage
EbeamUndPosXDamage = psana.Bld.DamageMask.EbeamUndPosXDamage
EbeamUndPosYDamage = psana.Bld.DamageMask.EbeamUndPosYDamage
EbeamXTCAVAmplDamage = psana.Bld.DamageMask.EbeamXTCAVAmplDamage
EbeamXTCAVPhaseDamage = psana.Bld.DamageMask.EbeamXTCAVPhaseDamage
names = {'EbeamPkCurrBC2Damage': psana.Bld.DamageMask.EbeamPkCurrBC2Damage, 'EbeamDumpChargeDamage': psana.Bld.DamageMask.EbeamDumpChargeDamage, 'EbeamLTUAngYDamage': psana.Bld.DamageMask.EbeamLTUAngYDamage, 'EbeamLTUPosXDamage': psana.Bld.DamageMask.EbeamLTUPosXDamage, 'EbeamXTCAVAmplDamage': psana.Bld.DamageMask.EbeamXTCAVAmplDamage, 'EbeamPkCurrBC1Damage': psana.Bld.DamageMask.EbeamPkCurrBC1Damage, 'EbeamPhotonEnergyDamage': psana.Bld.DamageMask.EbeamPhotonEnergyDamage, 'EbeamLTUPosYDamage': psana.Bld.DamageMask.EbeamLTUPosYDamage, 'EbeamUndPosYDamage': psana.Bld.DamageMask.EbeamUndPosYDamage, 'EbeamUndAngYDamage': psana.Bld.DamageMask.EbeamUndAngYDamage, 'EbeamLTUAngXDamage': psana.Bld.DamageMask.EbeamLTUAngXDamage, 'EbeamChargeDamage': psana.Bld.DamageMask.EbeamChargeDamage, 'EbeamXTCAVPhaseDamage': psana.Bld.DamageMask.EbeamXTCAVPhaseDamage, 'EbeamEnergyBC2Damage': psana.Bld.DamageMask.EbeamEnergyBC2Damage, 'EbeamL3EnergyDamage': psana.Bld.DamageMask.EbeamL3EnergyDamage, 'EbeamUndPosXDamage': psana.Bld.DamageMask.EbeamUndPosXDamage, 'EbeamEnergyBC1Damage': psana.Bld.DamageMask.EbeamEnergyBC1Damage, 'EbeamUndAngXDamage': psana.Bld.DamageMask.EbeamUndAngXDamage}
values = {32: psana.Bld.DamageMask.EbeamLTUAngYDamage, 1: psana.Bld.DamageMask.EbeamChargeDamage, 2: psana.Bld.DamageMask.EbeamL3EnergyDamage, 4096: psana.Bld.DamageMask.EbeamUndAngXDamage, 4: psana.Bld.DamageMask.EbeamLTUPosXDamage, 1024: psana.Bld.DamageMask.EbeamUndPosXDamage, 8192: psana.Bld.DamageMask.EbeamUndAngYDamage, 8: psana.Bld.DamageMask.EbeamLTUPosYDamage, 64: psana.Bld.DamageMask.EbeamPkCurrBC2Damage, 128: psana.Bld.DamageMask.EbeamEnergyBC2Damage, 256: psana.Bld.DamageMask.EbeamPkCurrBC1Damage, 16384: psana.Bld.DamageMask.EbeamXTCAVAmplDamage, 16: psana.Bld.DamageMask.EbeamLTUAngXDamage, 512: psana.Bld.DamageMask.EbeamEnergyBC1Damage, 131072: psana.Bld.DamageMask.EbeamPhotonEnergyDamage, 32768: psana.Bld.DamageMask.EbeamXTCAVPhaseDamage, 65536: psana.Bld.DamageMask.EbeamDumpChargeDamage, 2048: psana.Bld.DamageMask.EbeamUndPosYDamage}
BldDataEBeamV6.damageMask((BldDataEBeamV6)arg1) → int :

Damage mask.

BldDataEBeamV6.ebeamCharge((BldDataEBeamV6)arg1) → float :

Beam charge in nC.

BldDataEBeamV6.ebeamDumpCharge((BldDataEBeamV6)arg1) → float :

Bunch charge at Dump in num. electrons

BldDataEBeamV6.ebeamEnergyBC1((BldDataEBeamV6)arg1) → float :

Beam position in mm (related to beam energy).

BldDataEBeamV6.ebeamEnergyBC2((BldDataEBeamV6)arg1) → float :

Beam position in mm (related to beam energy).

BldDataEBeamV6.ebeamL3Energy((BldDataEBeamV6)arg1) → float :

Beam energy in MeV.

BldDataEBeamV6.ebeamLTU250((BldDataEBeamV6)arg1) → float :

LTU250 BPM value in mm, used to compute photon energy. from BPMS:LTU1:250:X

BldDataEBeamV6.ebeamLTU450((BldDataEBeamV6)arg1) → float :

LTU450 BPM value in mm, used to compute photon energy. from BPMS:LTU1:450:X

BldDataEBeamV6.ebeamLTUAngX((BldDataEBeamV6)arg1) → float :

LTU beam angle in mrad.

BldDataEBeamV6.ebeamLTUAngY((BldDataEBeamV6)arg1) → float :

LTU beam angle in mrad.

BldDataEBeamV6.ebeamLTUPosX((BldDataEBeamV6)arg1) → float :

LTU beam position (BPMS:LTU1:720 through 750) in mm.

BldDataEBeamV6.ebeamLTUPosY((BldDataEBeamV6)arg1) → float :

LTU beam position in mm.

BldDataEBeamV6.ebeamPhotonEnergy((BldDataEBeamV6)arg1) → float :

computed photon energy, in eV

BldDataEBeamV6.ebeamPkCurrBC1((BldDataEBeamV6)arg1) → float :

Beam current in Amps.

BldDataEBeamV6.ebeamPkCurrBC2((BldDataEBeamV6)arg1) → float :

Beam current in Amps.

BldDataEBeamV6.ebeamUndAngX((BldDataEBeamV6)arg1) → float :

Undulator launch feedback beam x-angle in mrad.

BldDataEBeamV6.ebeamUndAngY((BldDataEBeamV6)arg1) → float :

Undulator launch feedback beam y-angle in mrad.

BldDataEBeamV6.ebeamUndPosX((BldDataEBeamV6)arg1) → float :

Undulator launch feedback (BPMs U4 through U10) beam x-position in mm.

BldDataEBeamV6.ebeamUndPosY((BldDataEBeamV6)arg1) → float :

Undulator launch feedback beam y-position in mm.

BldDataEBeamV6.ebeamXTCAVAmpl((BldDataEBeamV6)arg1) → float :

XTCAV Amplitude in MVolt.

BldDataEBeamV6.ebeamXTCAVPhase((BldDataEBeamV6)arg1) → float :

XTCAV Phase in degrees.

BldDataEBeamV6.TypeId = 15
BldDataEBeamV6.Version = 6

Class psana.Bld.BldDataEBeamV7

class psana.Bld.BldDataEBeamV7

BldDataEBeamV7 is the same as BldDataEBeamV6. A sign-error error was discovered in the calculation of the photon energy that goes into the ebeam bld. This is fixed on the accelerator side, but we will increment the ebeam bld version number to V7 so the data is clearly marked as changed.

Raises an exception This class cannot be instantiated from Python

class DamageMask
EbeamChargeDamage = psana.Bld.DamageMask.EbeamChargeDamage
EbeamDumpChargeDamage = psana.Bld.DamageMask.EbeamDumpChargeDamage
EbeamEnergyBC1Damage = psana.Bld.DamageMask.EbeamEnergyBC1Damage
EbeamEnergyBC2Damage = psana.Bld.DamageMask.EbeamEnergyBC2Damage
EbeamL3EnergyDamage = psana.Bld.DamageMask.EbeamL3EnergyDamage
EbeamLTUAngXDamage = psana.Bld.DamageMask.EbeamLTUAngXDamage
EbeamLTUAngYDamage = psana.Bld.DamageMask.EbeamLTUAngYDamage
EbeamLTUPosXDamage = psana.Bld.DamageMask.EbeamLTUPosXDamage
EbeamLTUPosYDamage = psana.Bld.DamageMask.EbeamLTUPosYDamage
EbeamPhotonEnergyDamage = psana.Bld.DamageMask.EbeamPhotonEnergyDamage
EbeamPkCurrBC1Damage = psana.Bld.DamageMask.EbeamPkCurrBC1Damage
EbeamPkCurrBC2Damage = psana.Bld.DamageMask.EbeamPkCurrBC2Damage
EbeamUndAngXDamage = psana.Bld.DamageMask.EbeamUndAngXDamage
EbeamUndAngYDamage = psana.Bld.DamageMask.EbeamUndAngYDamage
EbeamUndPosXDamage = psana.Bld.DamageMask.EbeamUndPosXDamage
EbeamUndPosYDamage = psana.Bld.DamageMask.EbeamUndPosYDamage
EbeamXTCAVAmplDamage = psana.Bld.DamageMask.EbeamXTCAVAmplDamage
EbeamXTCAVPhaseDamage = psana.Bld.DamageMask.EbeamXTCAVPhaseDamage
names = {'EbeamPkCurrBC2Damage': psana.Bld.DamageMask.EbeamPkCurrBC2Damage, 'EbeamDumpChargeDamage': psana.Bld.DamageMask.EbeamDumpChargeDamage, 'EbeamLTUAngYDamage': psana.Bld.DamageMask.EbeamLTUAngYDamage, 'EbeamLTUPosXDamage': psana.Bld.DamageMask.EbeamLTUPosXDamage, 'EbeamXTCAVAmplDamage': psana.Bld.DamageMask.EbeamXTCAVAmplDamage, 'EbeamPkCurrBC1Damage': psana.Bld.DamageMask.EbeamPkCurrBC1Damage, 'EbeamPhotonEnergyDamage': psana.Bld.DamageMask.EbeamPhotonEnergyDamage, 'EbeamLTUPosYDamage': psana.Bld.DamageMask.EbeamLTUPosYDamage, 'EbeamUndPosYDamage': psana.Bld.DamageMask.EbeamUndPosYDamage, 'EbeamUndAngYDamage': psana.Bld.DamageMask.EbeamUndAngYDamage, 'EbeamLTUAngXDamage': psana.Bld.DamageMask.EbeamLTUAngXDamage, 'EbeamChargeDamage': psana.Bld.DamageMask.EbeamChargeDamage, 'EbeamXTCAVPhaseDamage': psana.Bld.DamageMask.EbeamXTCAVPhaseDamage, 'EbeamEnergyBC2Damage': psana.Bld.DamageMask.EbeamEnergyBC2Damage, 'EbeamL3EnergyDamage': psana.Bld.DamageMask.EbeamL3EnergyDamage, 'EbeamUndPosXDamage': psana.Bld.DamageMask.EbeamUndPosXDamage, 'EbeamEnergyBC1Damage': psana.Bld.DamageMask.EbeamEnergyBC1Damage, 'EbeamUndAngXDamage': psana.Bld.DamageMask.EbeamUndAngXDamage}
values = {32: psana.Bld.DamageMask.EbeamLTUAngYDamage, 1: psana.Bld.DamageMask.EbeamChargeDamage, 2: psana.Bld.DamageMask.EbeamL3EnergyDamage, 4096: psana.Bld.DamageMask.EbeamUndAngXDamage, 4: psana.Bld.DamageMask.EbeamLTUPosXDamage, 1024: psana.Bld.DamageMask.EbeamUndPosXDamage, 8192: psana.Bld.DamageMask.EbeamUndAngYDamage, 8: psana.Bld.DamageMask.EbeamLTUPosYDamage, 64: psana.Bld.DamageMask.EbeamPkCurrBC2Damage, 128: psana.Bld.DamageMask.EbeamEnergyBC2Damage, 256: psana.Bld.DamageMask.EbeamPkCurrBC1Damage, 16384: psana.Bld.DamageMask.EbeamXTCAVAmplDamage, 16: psana.Bld.DamageMask.EbeamLTUAngXDamage, 512: psana.Bld.DamageMask.EbeamEnergyBC1Damage, 131072: psana.Bld.DamageMask.EbeamPhotonEnergyDamage, 32768: psana.Bld.DamageMask.EbeamXTCAVPhaseDamage, 65536: psana.Bld.DamageMask.EbeamDumpChargeDamage, 2048: psana.Bld.DamageMask.EbeamUndPosYDamage}
BldDataEBeamV7.damageMask((BldDataEBeamV7)arg1) → int :

Damage mask.

BldDataEBeamV7.ebeamCharge((BldDataEBeamV7)arg1) → float :

Beam charge in nC.

BldDataEBeamV7.ebeamDumpCharge((BldDataEBeamV7)arg1) → float :

Bunch charge at Dump in num. electrons

BldDataEBeamV7.ebeamEnergyBC1((BldDataEBeamV7)arg1) → float :

Beam position in mm (related to beam energy).

BldDataEBeamV7.ebeamEnergyBC2((BldDataEBeamV7)arg1) → float :

Beam position in mm (related to beam energy).

BldDataEBeamV7.ebeamL3Energy((BldDataEBeamV7)arg1) → float :

Beam energy in MeV.

BldDataEBeamV7.ebeamLTU250((BldDataEBeamV7)arg1) → float :

LTU250 BPM value in mm, used to compute photon energy. from BPMS:LTU1:250:X

BldDataEBeamV7.ebeamLTU450((BldDataEBeamV7)arg1) → float :

LTU450 BPM value in mm, used to compute photon energy. from BPMS:LTU1:450:X

BldDataEBeamV7.ebeamLTUAngX((BldDataEBeamV7)arg1) → float :

LTU beam angle in mrad.

BldDataEBeamV7.ebeamLTUAngY((BldDataEBeamV7)arg1) → float :

LTU beam angle in mrad.

BldDataEBeamV7.ebeamLTUPosX((BldDataEBeamV7)arg1) → float :

LTU beam position (BPMS:LTU1:720 through 750) in mm.

BldDataEBeamV7.ebeamLTUPosY((BldDataEBeamV7)arg1) → float :

LTU beam position in mm.

BldDataEBeamV7.ebeamPhotonEnergy((BldDataEBeamV7)arg1) → float :

computed photon energy, in eV

BldDataEBeamV7.ebeamPkCurrBC1((BldDataEBeamV7)arg1) → float :

Beam current in Amps.

BldDataEBeamV7.ebeamPkCurrBC2((BldDataEBeamV7)arg1) → float :

Beam current in Amps.

BldDataEBeamV7.ebeamUndAngX((BldDataEBeamV7)arg1) → float :

Undulator launch feedback beam x-angle in mrad.

BldDataEBeamV7.ebeamUndAngY((BldDataEBeamV7)arg1) → float :

Undulator launch feedback beam y-angle in mrad.

BldDataEBeamV7.ebeamUndPosX((BldDataEBeamV7)arg1) → float :

Undulator launch feedback (BPMs U4 through U10) beam x-position in mm.

BldDataEBeamV7.ebeamUndPosY((BldDataEBeamV7)arg1) → float :

Undulator launch feedback beam y-position in mm.

BldDataEBeamV7.ebeamXTCAVAmpl((BldDataEBeamV7)arg1) → float :

XTCAV Amplitude in MVolt.

BldDataEBeamV7.ebeamXTCAVPhase((BldDataEBeamV7)arg1) → float :

XTCAV Phase in degrees.

BldDataEBeamV7.TypeId = 15
BldDataEBeamV7.Version = 7

Class psana.Bld.BldDataEOrbitsV0

class psana.Bld.BldDataEOrbitsV0

Orbit parameters.

Raises an exception This class cannot be instantiated from Python

fBPM_TMIT((BldDataEOrbitsV0)arg1) → numpy.ndarray :

Array of BPM TMIT values (Nel)

fBPM_X((BldDataEOrbitsV0)arg1) → numpy.ndarray :

Array of BPM X values (mm)

fBPM_Y((BldDataEOrbitsV0)arg1) → numpy.ndarray :

Array of BPM Y values (mm)

nBPMS((BldDataEOrbitsV0)arg1) → int :

Number of BPM in each array

TypeId = 103
Version = 0

Class psana.Bld.BldDataFEEGasDetEnergy

class psana.Bld.BldDataFEEGasDetEnergy

Four energy measurements from Front End Enclosure Gas Detector. PV names: GDET:FEE1:11:ENRC, GDET:FEE1:12:ENRC, GDET:FEE1:21:ENRC, GDET:FEE1:22:ENRC.

Raises an exception This class cannot be instantiated from Python

f_11_ENRC((BldDataFEEGasDetEnergy)arg1) → float :

Value of GDET:FEE1:11:ENRC, in mJ.

f_12_ENRC((BldDataFEEGasDetEnergy)arg1) → float :

Value of GDET:FEE1:12:ENRC, in mJ.

f_21_ENRC((BldDataFEEGasDetEnergy)arg1) → float :

Value of GDET:FEE1:21:ENRC, in mJ.

f_22_ENRC((BldDataFEEGasDetEnergy)arg1) → float :

Value of GDET:FEE1:22:ENRC, in mJ.

TypeId = 14
Version = 0

Class psana.Bld.BldDataFEEGasDetEnergyV1

class psana.Bld.BldDataFEEGasDetEnergyV1

Six energy measurements from Front End Enclosure Gas Detector. PV names: GDET:FEE1:241:ENRC, GDET:FEE1:242:ENRC,

GDET:FEE1:361:ENRC, GDET:FEE1:362:ENRC, GDET:FEE1:363:ENRC, and GDET:FEE1:364:ENRC

Each pair of methods (e.g. f_11_ENRC(), f_12_ENRC() contains identical measurements using two different phototubes. “11” and “12” are before the gas attenuation. “21” and “22” are after gas attenuation. “63” and “64” are duplicate measurements of “21” and “22” respectively.

The difference is that they cover a smaller (10%) dynamic range. When the beam is weak, 361 and 362 don’t have good S/N, these 2 extra PVs should be used instead. Dehong Zhang suggests that the threshold for “weak” is around 0.5 mJ.

Raises an exception This class cannot be instantiated from Python

f_11_ENRC((BldDataFEEGasDetEnergyV1)arg1) → float :

First energy measurement (mJ) before attenuation. (pv name GDET:FEE1:241:ENRC)

f_12_ENRC((BldDataFEEGasDetEnergyV1)arg1) → float :

Second (duplicate!) energy measurement (mJ) after attenuation. (pv name GDET:FEE1:242:ENRC)

f_21_ENRC((BldDataFEEGasDetEnergyV1)arg1) → float :

First energy measurement (mJ) after attenuation. (pv name GDET:FEE1:361:ENRC)

f_22_ENRC((BldDataFEEGasDetEnergyV1)arg1) → float :

Second (duplicate!) energy measurement (mJ) after attenuation. (pv name GDET:FEE1:362:ENRC)

f_63_ENRC((BldDataFEEGasDetEnergyV1)arg1) → float :

First energy measurement (mJ) for small signals (<0.5 mJ), after attenuation. (pv name GDET:FEE1:363:ENRC)

f_64_ENRC((BldDataFEEGasDetEnergyV1)arg1) → float :

Second (duplicate!) energy measurement (mJ) for small signals (<0.5mJ), after attenutation. (pv name GDET:FEE1:364:ENRC)

TypeId = 14
Version = 1

Class psana.Bld.BldDataGMDV0

class psana.Bld.BldDataGMDV0

Gas Monitor Detector data.

Raises an exception This class cannot be instantiated from Python

chargeQ((BldDataGMDV0)arg1) → float :

Charge Q

current((BldDataGMDV0)arg1) → float :

Current from Keithley Electrometer

gasType((BldDataGMDV0)arg1) → str :

String describing gas type

hvMeshElectron((BldDataGMDV0)arg1) → float :

HV Mesh Electron

hvMeshIon((BldDataGMDV0)arg1) → float :

HV Mesh Ion

hvMultIon((BldDataGMDV0)arg1) → float :

HV Mult Ion

keithleyPulseIntensity((BldDataGMDV0)arg1) → float :

Pulse Intensity derived from ION cup current

multPulseIntensity((BldDataGMDV0)arg1) → float :

Pulse Intensity derived from Electron Multiplier

photonEnergy((BldDataGMDV0)arg1) → float :

Photon Energy

pressure((BldDataGMDV0)arg1) → float :

Pressure from Spinning Rotor Gauge

pulseEnergy((BldDataGMDV0)arg1) → float :

Pulse Energy derived from Electron Multiplier

pulseEnergyFEE((BldDataGMDV0)arg1) → float :

Pulse Energy from FEE Gas Detector

temperature((BldDataGMDV0)arg1) → float :

Temp from PT100

transmission((BldDataGMDV0)arg1) → float :

Transmission derived from Electron Multiplier

transmissionFEE((BldDataGMDV0)arg1) → float :

Transmission from FEE Gas Detector

TypeId = 64
Version = 0

Class psana.Bld.BldDataGMDV1

class psana.Bld.BldDataGMDV1

Gas Monitor Detector data.

Raises an exception This class cannot be instantiated from Python

bgValuePerSample((BldDataGMDV1)arg1) → float :

Avg background value per sample in raw A/D counts

correctedSumPerPulse((BldDataGMDV1)arg1) → float :

Bg corrected waveform integrated within limits in raw A/D counts

milliJoulesAverage((BldDataGMDV1)arg1) → float :

Average pulse energy from ION cup current (mJ)

milliJoulesPerPulse((BldDataGMDV1)arg1) → float :

Shot to shot pulse energy (mJ)

relativeEnergyPerPulse((BldDataGMDV1)arg1) → float :

Shot by shot pulse energy in arbitrary units

TypeId = 64
Version = 1

Class psana.Bld.BldDataGMDV2

class psana.Bld.BldDataGMDV2

Gas Monitor Detector data.

Raises an exception This class cannot be instantiated from Python

milliJoulesAverage((BldDataGMDV2)arg1) → float :

Average pulse energy from ION cup current (mJ). Not as robust as relativeEnergyPerPulse() method.

milliJoulesPerPulse((BldDataGMDV2)arg1) → float :

Shot to shot pulse energy (mJ). Not as robust as relativeEnergyPerPulse() method.

rawAvgBkgd((BldDataGMDV2)arg1) → float :

Avg background value per waveform in raw A/D counts. Not typically used by the user.

relativeEnergyPerPulse((BldDataGMDV2)arg1) → float :

Shot by shot pulse energy in arbitrary units. The most stable measurement. Most users should use this.

sumAllPeaksFiltBkgd((BldDataGMDV2)arg1) → float :

Sum of all peaks, normalized w/ filt bkgd level. Not typically used by the user.

sumAllPeaksRawBkgd((BldDataGMDV2)arg1) → float :

Sum of all peaks, normalized w/ raw avg bkgd level. Not typically used by the user.

TypeId = 64
Version = 2

Class psana.Bld.BldDataIpimbV0

class psana.Bld.BldDataIpimbV0

Combined structure which includes Ipimb.DataV1, Ipimb.ConfigV1, and Lusi.IpmFexV1 objects.

Raises an exception This class cannot be instantiated from Python

ipimbConfig((BldDataIpimbV0)arg1) → ConfigV1
ipimbData((BldDataIpimbV0)arg1) → DataV1
ipmFexData((BldDataIpimbV0)arg1) → IpmFexV1
TypeId = 35
Version = 0

Class psana.Bld.BldDataIpimbV1

class psana.Bld.BldDataIpimbV1

Combined structure which includes Ipimb.DataV2, Ipimb.ConfigV2, and Lusi.IpmFexV1 objects.

Raises an exception This class cannot be instantiated from Python

ipimbConfig((BldDataIpimbV1)arg1) → ConfigV2
ipimbData((BldDataIpimbV1)arg1) → DataV2
ipmFexData((BldDataIpimbV1)arg1) → IpmFexV1
TypeId = 35
Version = 1

Class psana.Bld.BldDataPhaseCavity

class psana.Bld.BldDataPhaseCavity

PV names: UND:R02:IOC:16:BAT:FitTime1, UND:R02:IOC:16:BAT:FitTime2, UND:R02:IOC:16:BAT:Charge1, UND:R02:IOC:16:BAT:Charge2

Raises an exception This class cannot be instantiated from Python

charge1((BldDataPhaseCavity)arg1) → float :

UND:R02:IOC:16:BAT:Charge1 value in pico-columbs.

charge2((BldDataPhaseCavity)arg1) → float :

UND:R02:IOC:16:BAT:Charge2 value in pico-columbs.

fitTime1((BldDataPhaseCavity)arg1) → float :

UND:R02:IOC:16:BAT:FitTime1 value in pico-seconds.

fitTime2((BldDataPhaseCavity)arg1) → float :

UND:R02:IOC:16:BAT:FitTime2 value in pico-seconds.

TypeId = 16
Version = 0

Class psana.Bld.BldDataPimV1

class psana.Bld.BldDataPimV1

Combined structure which includes Pulnix.TM6740ConfigV2, Lusi.PimImageConfigV1, and Camera.FrameV1 objects.

Raises an exception This class cannot be instantiated from Python

camConfig((BldDataPimV1)arg1) → TM6740ConfigV2
frame((BldDataPimV1)arg1) → FrameV1
pimConfig((BldDataPimV1)arg1) → PimImageConfigV1
TypeId = 42
Version = 1

Class psana.Bld.BldDataSpectrometerV0

class psana.Bld.BldDataSpectrometerV0

Structure which contains image projections for spectrometers.

Raises an exception This class cannot be instantiated from Python

hproj((BldDataSpectrometerV0)arg1) → numpy.ndarray
vproj((BldDataSpectrometerV0)arg1) → numpy.ndarray
TypeId = 72
Version = 0

Class psana.Bld.BldDataSpectrometerV1

class psana.Bld.BldDataSpectrometerV1

Structure which contains image projections and fit parameters for spectrometers. Changes from V0 include extending size of hproj, removal of vproj,

and addition of fit parameters.

Raises an exception This class cannot be instantiated from Python

FWHM((BldDataSpectrometerV1)arg1) → numpy.ndarray :

Peak FWHM array, length given by nPeaks PV: TBD

baseline((BldDataSpectrometerV1)arg1) → float :

Baseline level for calculated values PV: TBD

com((BldDataSpectrometerV1)arg1) → float :

Baseline-subtracted center of mass PV: TBD

comRaw((BldDataSpectrometerV1)arg1) → float :

Raw center of mass, no baseline subtraction PV: TBD

hproj((BldDataSpectrometerV1)arg1) → numpy.ndarray :

Projection of spectrum onto energy axis PV TBD

hproj_y1((BldDataSpectrometerV1)arg1) → int :

First row of pixels used in projection ROI PV TBD

hproj_y2((BldDataSpectrometerV1)arg1) → int :

Last row of pixels used in projection ROI PV: TBD

integral((BldDataSpectrometerV1)arg1) → float :

Integrated area under spectrum (no baseline subtraction) PV: TBD

nPeaks((BldDataSpectrometerV1)arg1) → int :

Number of peak fits performed PV: TBD

peakHeight((BldDataSpectrometerV1)arg1) → numpy.ndarray :

Peak height array, length given by nPeaks PV: TBD

peakPos((BldDataSpectrometerV1)arg1) → numpy.ndarray :

Peak position array, length given by nPeaks PV: TBD

width((BldDataSpectrometerV1)arg1) → int :

Width of camera frame and thus size of hproj array PV TBD

TypeId = 72
Version = 1

Class psana.Bld.BldDataUsdUsbV1

class psana.Bld.BldDataUsdUsbV1

Combined structure which includes UsdUsb.ConfigV1, UsdUsb.FexConfigV1, UsdUsb.DataV1, and UsdUsb.FexDataV1 objects.

Raises an exception This class cannot be instantiated from Python

config((BldDataUsdUsbV1)arg1) → ConfigV1
data((BldDataUsdUsbV1)arg1) → DataV1
fexConfig((BldDataUsdUsbV1)arg1) → FexConfigV1
fexData((BldDataUsdUsbV1)arg1) → FexDataV1
TypeId = 104
Version = 1

Module psana.Camera

The Python wrapper module for Camera types

Class psana.Camera.ControlsCameraConfigV1

class psana.Camera.ControlsCameraConfigV1

Class containing configuration data for cameras recorded by the controls recorder.

Raises an exception This class cannot be instantiated from Python

class ColorMode
Bayer = psana.Camera.ColorMode.Bayer
Mono = psana.Camera.ColorMode.Mono
RGB1 = psana.Camera.ColorMode.RGB1
names = {'Mono': psana.Camera.ColorMode.Mono, 'Bayer': psana.Camera.ColorMode.Bayer, 'RGB1': psana.Camera.ColorMode.RGB1}
values = {0: psana.Camera.ColorMode.Mono, 1: psana.Camera.ColorMode.Bayer, 2: psana.Camera.ColorMode.RGB1}
ControlsCameraConfigV1.color_mode((ControlsCameraConfigV1)arg1) → ColorMode :

The color mode of the camera.

ControlsCameraConfigV1.depth((ControlsCameraConfigV1)arg1) → int :

Number of bits per pixel.

ControlsCameraConfigV1.exposure_time((ControlsCameraConfigV1)arg1) → float :

The configured exposure time of the camera in seconds.

ControlsCameraConfigV1.gain((ControlsCameraConfigV1)arg1) → float :

Camera gain value.

ControlsCameraConfigV1.height((ControlsCameraConfigV1)arg1) → int :

Number of pixels in a column.

ControlsCameraConfigV1.manufacturer((ControlsCameraConfigV1)arg1) → str :

The manufacturer of the camera.

ControlsCameraConfigV1.model((ControlsCameraConfigV1)arg1) → str :

The model name of the camera.

ControlsCameraConfigV1.width((ControlsCameraConfigV1)arg1) → int :

Number of pixels in a row.

ControlsCameraConfigV1.DESC_CHAR_MAX = 48
ControlsCameraConfigV1.TypeId = 105
ControlsCameraConfigV1.Version = 1

Class psana.Camera.FrameCoord

class psana.Camera.FrameCoord

Class representing the coordinates of pixels inside the camera frame.

Raises an exception This class cannot be instantiated from Python

column((FrameCoord)arg1) → int :

Column index (x value).

row((FrameCoord)arg1) → int :

Row index (y value).

Class psana.Camera.FrameFccdConfigV1

class psana.Camera.FrameFccdConfigV1

This class was never defined/implemented.

Raises an exception This class cannot be instantiated from Python

TypeId = 20
Version = 1

Class psana.Camera.FrameFexConfigV1

class psana.Camera.FrameFexConfigV1

Class containing configuration data for online frame feature extraction process.

Raises an exception This class cannot be instantiated from Python

class Forwarding
FullFrame = psana.Camera.Forwarding.FullFrame
NoFrame = psana.Camera.Forwarding.NoFrame
RegionOfInterest = psana.Camera.Forwarding.RegionOfInterest
names = {'RegionOfInterest': psana.Camera.Forwarding.RegionOfInterest, 'FullFrame': psana.Camera.Forwarding.FullFrame, 'NoFrame': psana.Camera.Forwarding.NoFrame}
values = {0: psana.Camera.Forwarding.NoFrame, 1: psana.Camera.Forwarding.FullFrame, 2: psana.Camera.Forwarding.RegionOfInterest}
class FrameFexConfigV1.Processing
GssFullFrame = psana.Camera.Processing.GssFullFrame
GssRegionOfInterest = psana.Camera.Processing.GssRegionOfInterest
GssThreshold = psana.Camera.Processing.GssThreshold
NoProcessing = psana.Camera.Processing.NoProcessing
names = {'NoProcessing': psana.Camera.Processing.NoProcessing, 'GssFullFrame': psana.Camera.Processing.GssFullFrame, 'GssThreshold': psana.Camera.Processing.GssThreshold, 'GssRegionOfInterest': psana.Camera.Processing.GssRegionOfInterest}
values = {0: psana.Camera.Processing.NoProcessing, 1: psana.Camera.Processing.GssFullFrame, 2: psana.Camera.Processing.GssRegionOfInterest, 3: psana.Camera.Processing.GssThreshold}
FrameFexConfigV1.forward_prescale((FrameFexConfigV1)arg1) → int :

Prescale of events with forwarded frames

FrameFexConfigV1.forwarding((FrameFexConfigV1)arg1) → Forwarding :

frame forwarding policy

FrameFexConfigV1.masked_pixel_coordinates((FrameFexConfigV1)arg1) → list :

Location of masked pixel coordinates.

FrameFexConfigV1.number_of_masked_pixels((FrameFexConfigV1)arg1) → int :

Count of masked pixels to exclude from processing.

FrameFexConfigV1.processing((FrameFexConfigV1)arg1) → Processing :

algorithm to apply to frames to produce processed output

FrameFexConfigV1.roiBegin((FrameFexConfigV1)arg1) → FrameCoord :

Coordinate of start of rectangular region of interest (inclusive).

FrameFexConfigV1.roiEnd((FrameFexConfigV1)arg1) → FrameCoord :

Coordinate of finish of rectangular region of interest (exclusive).

FrameFexConfigV1.threshold((FrameFexConfigV1)arg1) → int :

Pixel data threshold value to apply in processing.

FrameFexConfigV1.TypeId = 7
FrameFexConfigV1.Version = 1

Class psana.Camera.FrameV1

class psana.Camera.FrameV1

Raises an exception This class cannot be instantiated from Python

_int_pixel_data((FrameV1)arg1) → numpy.ndarray :

Pixel data as array of bytes, method is for internal use only, use data8() or data16() for access to the data.

data16((FrameV1)arg1) → numpy.ndarray :

Returns pixel data array when stored data type is 16-bit (depth() is greater than 8). If data type is 8-bit then empty array is returned, use data8() method in this case.

data8((FrameV1)arg1) → numpy.ndarray :

Returns pixel data array when stored data type is 8-bit (depth() is less than 9). If data type is 16-bit then empty array is returned, use data16() method in this case.

depth((FrameV1)arg1) → int :

Number of bits per pixel.

depth_bytes((FrameV1)arg1) → int :

Number of bytes per pixel.

height((FrameV1)arg1) → int :

Number of pixels in a column.

offset((FrameV1)arg1) → int :

Fixed offset/pedestal value of pixel data.

width((FrameV1)arg1) → int :

Number of pixels in a row.

TypeId = 2
Version = 1

Class psana.Camera.TwoDGaussianV1

class psana.Camera.TwoDGaussianV1

Raises an exception This class cannot be instantiated from Python

integral((TwoDGaussianV1)arg1) → int
major_axis_tilt((TwoDGaussianV1)arg1) → float
major_axis_width((TwoDGaussianV1)arg1) → float
minor_axis_width((TwoDGaussianV1)arg1) → float
xmean((TwoDGaussianV1)arg1) → float
ymean((TwoDGaussianV1)arg1) → float
TypeId = 5
Version = 1

Module psana.ControlData

The Python wrapper module for ControlData types

Class psana.ControlData.ConfigV1

class psana.ControlData.ConfigV1

Raises an exception This class cannot be instantiated from Python

duration((ConfigV1)arg1) → psana.ClockTime :

Maximum duration of the scan.

events((ConfigV1)arg1) → int :

Maximum number of events per scan.

npvControls((ConfigV1)arg1) → int :

Number of PVControl objects in this configuration.

npvMonitors((ConfigV1)arg1) → int :

Number of PVMonitor objects in this configuration.

pvControls((ConfigV1)arg1) → list :

PVControl configuration objects

pvMonitors((ConfigV1)arg1) → list :

PVMonitor configuration objects

uses_duration((ConfigV1)arg1) → int :

returns true if the configuration uses duration control.

uses_events((ConfigV1)arg1) → int :

returns true if the configuration uses events limit.

TypeId = 10
Version = 1

Class psana.ControlData.ConfigV2

class psana.ControlData.ConfigV2

Raises an exception This class cannot be instantiated from Python

duration((ConfigV2)arg1) → psana.ClockTime :

Maximum duration of the scan.

events((ConfigV2)arg1) → int :

Maximum number of events per scan.

npvControls((ConfigV2)arg1) → int :

Number of PVControl objects in this configuration.

npvLabels((ConfigV2)arg1) → int :

Number of PVLabel objects in this configuration.

npvMonitors((ConfigV2)arg1) → int :

Number of PVMonitor objects in this configuration.

pvControls((ConfigV2)arg1) → list :

PVControl configuration objects

pvLabels((ConfigV2)arg1) → list :

PVLabel configuration objects

pvMonitors((ConfigV2)arg1) → list :

PVMonitor configuration objects

uses_duration((ConfigV2)arg1) → int :

returns true if the configuration uses duration control.

uses_events((ConfigV2)arg1) → int :

returns true if the configuration uses events limit.

TypeId = 10
Version = 2

Class psana.ControlData.ConfigV3

class psana.ControlData.ConfigV3

Raises an exception This class cannot be instantiated from Python

duration((ConfigV3)arg1) → psana.ClockTime :

Maximum duration of the scan.

events((ConfigV3)arg1) → int :

Maximum number of events per scan.

npvControls((ConfigV3)arg1) → int :

Number of PVControl objects in this configuration.

npvLabels((ConfigV3)arg1) → int :

Number of PVLabel objects in this configuration.

npvMonitors((ConfigV3)arg1) → int :

Number of PVMonitor objects in this configuration.

pvControls((ConfigV3)arg1) → list :

PVControl configuration objects

pvLabels((ConfigV3)arg1) → list :

PVLabel configuration objects

pvMonitors((ConfigV3)arg1) → list :

PVMonitor configuration objects

uses_duration((ConfigV3)arg1) → int :

returns true if the configuration uses duration control.

uses_events((ConfigV3)arg1) → int :

returns true if the configuration uses events limit.

uses_l3t_events((ConfigV3)arg1) → int :

returns true if the configuration uses l3trigger events limit.

TypeId = 10
Version = 3

Class psana.ControlData.PVControl

class psana.ControlData.PVControl

Raises an exception This class cannot be instantiated from Python

array((PVControl)arg1) → int :

Returns true if the control is an array.

index((PVControl)arg1) → int :

Index of the control PV (for arrays) or NoArray.

name((PVControl)arg1) → str :

Name of the control.

value((PVControl)arg1) → float :

Value for this control.

NameSize = 32
NoArray = 4294967295

Class psana.ControlData.PVLabel

class psana.ControlData.PVLabel

Raises an exception This class cannot be instantiated from Python

name((PVLabel)arg1) → str :

PV name.

value((PVLabel)arg1) → str :

Label value.

NameSize = 32
ValueSize = 64

Class psana.ControlData.PVMonitor

class psana.ControlData.PVMonitor

Raises an exception This class cannot be instantiated from Python

array((PVMonitor)arg1) → int :

Returns true if the monitor is an array.

hiValue((PVMonitor)arg1) → float :

Highest value for this monitor.

index((PVMonitor)arg1) → int :

Index of the control PV (for arrays) or NoArray.

loValue((PVMonitor)arg1) → float :

Lowest value for this monitor.

name((PVMonitor)arg1) → str :

Name of the control.

NameSize = 32
NoArray = 4294967295

Module psana.CsPad

The Python wrapper module for CsPad types

Class psana.CsPad.ConfigV1

class psana.CsPad.ConfigV1

Configuration data for complete CsPad device.

Raises an exception This class cannot be instantiated from Python

activeRunMode((ConfigV1)arg1) → int
asicMask((ConfigV1)arg1) → int
badAsicMask0((ConfigV1)arg1) → int
badAsicMask1((ConfigV1)arg1) → int
concentratorVersion((ConfigV1)arg1) → int
eventCode((ConfigV1)arg1) → int
inactiveRunMode((ConfigV1)arg1) → int
numAsicsRead((ConfigV1)arg1) → int
numQuads((ConfigV1)arg1) → int
numSect((ConfigV1)arg1) → int
payloadSize((ConfigV1)arg1) → int
quadMask((ConfigV1)arg1) → int
quads((ConfigV1)arg1, (int)arg2) → ConfigV1QuadReg
quads_shape((ConfigV1)arg1) → object
runDelay((ConfigV1)arg1) → int
tdi((ConfigV1)arg1) → int
TypeId = 29
Version = 1

Class psana.CsPad.ConfigV1QuadReg

class psana.CsPad.ConfigV1QuadReg

Configuration data for single quadrant.

Raises an exception This class cannot be instantiated from Python

acqDelay((ConfigV1QuadReg)arg1) → int
ampIdle((ConfigV1QuadReg)arg1) → int
dataMode((ConfigV1QuadReg)arg1) → int
digDelay((ConfigV1QuadReg)arg1) → int
dp((ConfigV1QuadReg)arg1) → CsPadDigitalPotsCfg
edgeSelect((ConfigV1QuadReg)arg1) → numpy.ndarray
gm((ConfigV1QuadReg)arg1) → CsPadGainMapCfg :

Gain map.

injTotal((ConfigV1QuadReg)arg1) → int
intTime((ConfigV1QuadReg)arg1) → int
prstSel((ConfigV1QuadReg)arg1) → int
readClkHold((ConfigV1QuadReg)arg1) → int
readClkSet((ConfigV1QuadReg)arg1) → int
ro((ConfigV1QuadReg)arg1) → CsPadReadOnlyCfg :

read-only configuration

rowColShiftPer((ConfigV1QuadReg)arg1) → int
shiftSelect((ConfigV1QuadReg)arg1) → numpy.ndarray

Class psana.CsPad.ConfigV2

class psana.CsPad.ConfigV2

Configuration data for complete CsPad device.

Raises an exception This class cannot be instantiated from Python

activeRunMode((ConfigV2)arg1) → int
asicMask((ConfigV2)arg1) → int
badAsicMask0((ConfigV2)arg1) → int
badAsicMask1((ConfigV2)arg1) → int
concentratorVersion((ConfigV2)arg1) → int
eventCode((ConfigV2)arg1) → int
inactiveRunMode((ConfigV2)arg1) → int
numAsicsRead((ConfigV2)arg1) → int
numAsicsStored((ConfigV2)arg1, (int)arg2) → int :

Number of ASICs in given quadrant

numQuads((ConfigV2)arg1) → int :

Total number of quadrants in setup

numSect((ConfigV2)arg1) → int :

Total number of sections (2x1) in all quadrants

payloadSize((ConfigV2)arg1) → int
quadMask((ConfigV2)arg1) → int
quads((ConfigV2)arg1, (int)arg2) → ConfigV1QuadReg
quads_shape((ConfigV2)arg1) → object
roiMask((ConfigV2)arg1, (int)arg2) → int :

ROI mask for given quadrant

roiMasks((ConfigV2)arg1) → int
runDelay((ConfigV2)arg1) → int
tdi((ConfigV2)arg1) → int
TypeId = 29
Version = 2

Class psana.CsPad.ConfigV2QuadReg

class psana.CsPad.ConfigV2QuadReg

Configuration data for single quadrant.

Raises an exception This class cannot be instantiated from Python

acqDelay((ConfigV2QuadReg)arg1) → int
ampIdle((ConfigV2QuadReg)arg1) → int
ampReset((ConfigV2QuadReg)arg1) → int
dataMode((ConfigV2QuadReg)arg1) → int
digCount((ConfigV2QuadReg)arg1) → int
digDelay((ConfigV2QuadReg)arg1) → int
digPeriod((ConfigV2QuadReg)arg1) → int
dp((ConfigV2QuadReg)arg1) → CsPadDigitalPotsCfg
edgeSelect((ConfigV2QuadReg)arg1) → numpy.ndarray
gm((ConfigV2QuadReg)arg1) → CsPadGainMapCfg :

Gain map.

injTotal((ConfigV2QuadReg)arg1) → int
intTime((ConfigV2QuadReg)arg1) → int
prstSel((ConfigV2QuadReg)arg1) → int
readClkHold((ConfigV2QuadReg)arg1) → int
readClkSet((ConfigV2QuadReg)arg1) → int
ro((ConfigV2QuadReg)arg1) → CsPadReadOnlyCfg :

read-only configuration

rowColShiftPer((ConfigV2QuadReg)arg1) → int
shiftSelect((ConfigV2QuadReg)arg1) → numpy.ndarray

Class psana.CsPad.ConfigV3

class psana.CsPad.ConfigV3

Configuration data for complete CsPad device.

Raises an exception This class cannot be instantiated from Python

activeRunMode((ConfigV3)arg1) → int
asicMask((ConfigV3)arg1) → int
badAsicMask0((ConfigV3)arg1) → int
badAsicMask1((ConfigV3)arg1) → int
concentratorVersion((ConfigV3)arg1) → int
eventCode((ConfigV3)arg1) → int
inactiveRunMode((ConfigV3)arg1) → int
numAsicsRead((ConfigV3)arg1) → int
numAsicsStored((ConfigV3)arg1, (int)arg2) → int :

Number of ASICs in given quadrant

numQuads((ConfigV3)arg1) → int :

Total number of quadrants in setup

numSect((ConfigV3)arg1) → int :

Total number of sections (2x1) in all quadrants

payloadSize((ConfigV3)arg1) → int
protectionEnable((ConfigV3)arg1) → int
protectionThresholds((ConfigV3)arg1) → list
quadMask((ConfigV3)arg1) → int
quads((ConfigV3)arg1, (int)arg2) → ConfigV1QuadReg
quads_shape((ConfigV3)arg1) → object
roiMask((ConfigV3)arg1, (int)arg2) → int :

ROI mask for given quadrant

roiMasks((ConfigV3)arg1) → int
runDelay((ConfigV3)arg1) → int
tdi((ConfigV3)arg1) → int
TypeId = 29
Version = 3

Class psana.CsPad.ConfigV3QuadReg

class psana.CsPad.ConfigV3QuadReg

Configuration data for single quadrant.

Raises an exception This class cannot be instantiated from Python

acqDelay((ConfigV3QuadReg)arg1) → int
ampIdle((ConfigV3QuadReg)arg1) → int
ampReset((ConfigV3QuadReg)arg1) → int
biasTuning((ConfigV3QuadReg)arg1) → int
dataMode((ConfigV3QuadReg)arg1) → int
digCount((ConfigV3QuadReg)arg1) → int
digDelay((ConfigV3QuadReg)arg1) → int
digPeriod((ConfigV3QuadReg)arg1) → int
dp((ConfigV3QuadReg)arg1) → CsPadDigitalPotsCfg
edgeSelect((ConfigV3QuadReg)arg1) → numpy.ndarray
gm((ConfigV3QuadReg)arg1) → CsPadGainMapCfg :

Gain map.

injTotal((ConfigV3QuadReg)arg1) → int
intTime((ConfigV3QuadReg)arg1) → int
pdpmndnmBalance((ConfigV3QuadReg)arg1) → int
prstSel((ConfigV3QuadReg)arg1) → int
readClkHold((ConfigV3QuadReg)arg1) → int
readClkSet((ConfigV3QuadReg)arg1) → int
ro((ConfigV3QuadReg)arg1) → CsPadReadOnlyCfg :

read-only configuration

rowColShiftPer((ConfigV3QuadReg)arg1) → int
shiftSelect((ConfigV3QuadReg)arg1) → numpy.ndarray

Class psana.CsPad.ConfigV4

class psana.CsPad.ConfigV4

Configuration data for complete CsPad device.

Raises an exception This class cannot be instantiated from Python

activeRunMode((ConfigV4)arg1) → int
asicMask((ConfigV4)arg1) → int
badAsicMask0((ConfigV4)arg1) → int
badAsicMask1((ConfigV4)arg1) → int
concentratorVersion((ConfigV4)arg1) → int
eventCode((ConfigV4)arg1) → int
inactiveRunMode((ConfigV4)arg1) → int
numAsicsRead((ConfigV4)arg1) → int
numAsicsStored((ConfigV4)arg1, (int)arg2) → int :

Number of ASICs in given quadrant

numQuads((ConfigV4)arg1) → int :

Total number of quadrants in setup

numSect((ConfigV4)arg1) → int :

Total number of sections (2x1) in all quadrants

payloadSize((ConfigV4)arg1) → int
protectionEnable((ConfigV4)arg1) → int
protectionThresholds((ConfigV4)arg1) → list
quadMask((ConfigV4)arg1) → int
quads((ConfigV4)arg1, (int)arg2) → ConfigV2QuadReg
quads_shape((ConfigV4)arg1) → object
roiMask((ConfigV4)arg1, (int)arg2) → int :

ROI mask for given quadrant

roiMasks((ConfigV4)arg1) → int
runDelay((ConfigV4)arg1) → int
tdi((ConfigV4)arg1) → int
TypeId = 29
Version = 4

Class psana.CsPad.ConfigV5

class psana.CsPad.ConfigV5

Configuration data for complete CsPad device.

Raises an exception This class cannot be instantiated from Python

activeRunMode((ConfigV5)arg1) → int
asicMask((ConfigV5)arg1) → int
badAsicMask0((ConfigV5)arg1) → int
badAsicMask1((ConfigV5)arg1) → int
concentratorVersion((ConfigV5)arg1) → int
eventCode((ConfigV5)arg1) → int
inactiveRunMode((ConfigV5)arg1) → int
internalTriggerDelay((ConfigV5)arg1) → int
numAsicsRead((ConfigV5)arg1) → int
numAsicsStored((ConfigV5)arg1, (int)arg2) → int :

Number of ASICs in given quadrant

numQuads((ConfigV5)arg1) → int :

Total number of quadrants in setup

numSect((ConfigV5)arg1) → int :

Total number of sections (2x1) in all quadrants

payloadSize((ConfigV5)arg1) → int
protectionEnable((ConfigV5)arg1) → int
protectionThresholds((ConfigV5)arg1) → list
quadMask((ConfigV5)arg1) → int
quads((ConfigV5)arg1, (int)arg2) → ConfigV3QuadReg
quads_shape((ConfigV5)arg1) → object
roiMask((ConfigV5)arg1, (int)arg2) → int :

ROI mask for given quadrant

roiMasks((ConfigV5)arg1) → int
runDelay((ConfigV5)arg1) → int
tdi((ConfigV5)arg1) → int
TypeId = 29
Version = 5

Class psana.CsPad.CsPadDigitalPotsCfg

class psana.CsPad.CsPadDigitalPotsCfg

Class defining configuration for CsPad POTs?

Raises an exception This class cannot be instantiated from Python

pots((CsPadDigitalPotsCfg)arg1) → numpy.ndarray

Class psana.CsPad.CsPadGainMapCfg

class psana.CsPad.CsPadGainMapCfg

Class defining ASIC gain map.

Raises an exception This class cannot be instantiated from Python

gainMap((CsPadGainMapCfg)arg1) → numpy.ndarray :

Array with the gain map for single ASIC.

Class psana.CsPad.CsPadReadOnlyCfg

class psana.CsPad.CsPadReadOnlyCfg

Class defining read-only configuration.

Raises an exception This class cannot be instantiated from Python

shiftTest((CsPadReadOnlyCfg)arg1) → int
version((CsPadReadOnlyCfg)arg1) → int

Class psana.CsPad.DataModes

class psana.CsPad.DataModes
names = {'shiftTest': psana.CsPad.DataModes.shiftTest, 'reserved': psana.CsPad.DataModes.reserved, 'testData': psana.CsPad.DataModes.testData, 'normal': psana.CsPad.DataModes.normal}
normal = psana.CsPad.DataModes.normal
reserved = psana.CsPad.DataModes.reserved
shiftTest = psana.CsPad.DataModes.shiftTest
testData = psana.CsPad.DataModes.testData
values = {0: psana.CsPad.DataModes.normal, 1: psana.CsPad.DataModes.shiftTest, 2: psana.CsPad.DataModes.testData, 3: psana.CsPad.DataModes.reserved}

Class psana.CsPad.DataV1

class psana.CsPad.DataV1

CsPad data from whole detector.

Raises an exception This class cannot be instantiated from Python

quads((DataV1)arg1, (int)arg2) → ElementV1 :

Data objects, one element per quadrant. The size of the array is determined by the numQuads() method of the configuration object.

quads_shape((DataV1)arg1) → object
TypeId = 28
Version = 1

Class psana.CsPad.DataV2

class psana.CsPad.DataV2

CsPad data from whole detector.

Raises an exception This class cannot be instantiated from Python

quads((DataV2)arg1, (int)arg2) → ElementV2 :

Data objects, one element per quadrant. The size of the array is determined by the numQuads() method of the configuration object.

quads_shape((DataV2)arg1) → object
TypeId = 28
Version = 2

Class psana.CsPad.ElementV1

class psana.CsPad.ElementV1

CsPad data from single CsPad quadrant.

Raises an exception This class cannot be instantiated from Python

acq_count((ElementV1)arg1) → int
common_mode((ElementV1)arg1, (int)arg2) → float :

Common mode value for a given section, section number can be 0 to config.numAsicsRead()/2. Will return 0 for data read from XTC, may be non-zero after calibration.

data((ElementV1)arg1) → numpy.ndarray
fiducials((ElementV1)arg1) → int
frame_type((ElementV1)arg1) → int
lane((ElementV1)arg1) → int :

Lane number.

op_code((ElementV1)arg1) → int
quad((ElementV1)arg1) → int :

Quadrant number.

sb_temp((ElementV1)arg1) → numpy.ndarray
sectionMask((ElementV1)arg1) → int :

Returns section mask for this quadrant. Mask can contain up to 8 bits in the lower byte, total bit count gives the number of sections active.

seq_count((ElementV1)arg1) → int :

Counter incremented on every event.

ticks((ElementV1)arg1) → int
tid((ElementV1)arg1) → int
virtual_channel((ElementV1)arg1) → int :

Virtual channel number.

Nsbtemp = 4

Class psana.CsPad.ElementV2

class psana.CsPad.ElementV2

CsPad data from single CsPad quadrant.

Raises an exception This class cannot be instantiated from Python

acq_count((ElementV2)arg1) → int
common_mode((ElementV2)arg1, (int)arg2) → float :

Common mode value for a given section, section number can be 0 to config.numSect(). Will return 0 for data read from XTC, may be non-zero after calibration.

data((ElementV2)arg1) → numpy.ndarray
fiducials((ElementV2)arg1) → int
frame_type((ElementV2)arg1) → int
lane((ElementV2)arg1) → int :

Lane number.

op_code((ElementV2)arg1) → int
quad((ElementV2)arg1) → int :

Quadrant number.

sb_temp((ElementV2)arg1) → numpy.ndarray
sectionMask((ElementV2)arg1) → int :

Returns section mask for this quadrant. Mask can contain up to 8 bits in the lower byte, total bit count gives the number of sections active.

seq_count((ElementV2)arg1) → int
ticks((ElementV2)arg1) → int
tid((ElementV2)arg1) → int
virtual_channel((ElementV2)arg1) → int :

Virtual channel number.

Nsbtemp = 4

Class psana.CsPad.ProtectionSystemThreshold

class psana.CsPad.ProtectionSystemThreshold

Raises an exception This class cannot be instantiated from Python

adcThreshold((ProtectionSystemThreshold)arg1) → int
pixelCountThreshold((ProtectionSystemThreshold)arg1) → int

Class psana.CsPad.RunModes

class psana.CsPad.RunModes
ExternalTriggerDrop = psana.CsPad.RunModes.ExternalTriggerDrop
ExternalTriggerSendToRCE = psana.CsPad.RunModes.ExternalTriggerSendToRCE
NoRunning = psana.CsPad.RunModes.NoRunning
NumberOfRunModes = psana.CsPad.RunModes.NumberOfRunModes
RunAndSendToRCE = psana.CsPad.RunModes.RunAndSendToRCE
RunAndSendTriggeredByTTL = psana.CsPad.RunModes.RunAndSendTriggeredByTTL
RunButDrop = psana.CsPad.RunModes.RunButDrop
names = {'ExternalTriggerSendToRCE': psana.CsPad.RunModes.ExternalTriggerSendToRCE, 'NoRunning': psana.CsPad.RunModes.NoRunning, 'RunButDrop': psana.CsPad.RunModes.RunButDrop, 'ExternalTriggerDrop': psana.CsPad.RunModes.ExternalTriggerDrop, 'RunAndSendToRCE': psana.CsPad.RunModes.RunAndSendToRCE, 'RunAndSendTriggeredByTTL': psana.CsPad.RunModes.RunAndSendTriggeredByTTL, 'NumberOfRunModes': psana.CsPad.RunModes.NumberOfRunModes}
values = {0: psana.CsPad.RunModes.NoRunning, 1: psana.CsPad.RunModes.RunButDrop, 2: psana.CsPad.RunModes.RunAndSendToRCE, 3: psana.CsPad.RunModes.RunAndSendTriggeredByTTL, 4: psana.CsPad.RunModes.ExternalTriggerSendToRCE, 5: psana.CsPad.RunModes.ExternalTriggerDrop, 6: psana.CsPad.RunModes.NumberOfRunModes}

Module psana.CsPad2x2

The Python wrapper module for CsPad2x2 types

Class psana.CsPad2x2.ConfigV1

class psana.CsPad2x2.ConfigV1

Configuration data for 2x2 CsPad device.

Raises an exception This class cannot be instantiated from Python

activeRunMode((ConfigV1)arg1) → int
asicMask((ConfigV1)arg1) → int
badAsicMask((ConfigV1)arg1) → int
concentratorVersion((ConfigV1)arg1) → int
inactiveRunMode((ConfigV1)arg1) → int
numAsicsRead((ConfigV1)arg1) → int
numAsicsStored((ConfigV1)arg1) → int :

Number of ASICs in given quadrant

payloadSize((ConfigV1)arg1) → int
protectionEnable((ConfigV1)arg1) → int
protectionThreshold((ConfigV1)arg1) → ProtectionSystemThreshold
quad((ConfigV1)arg1) → ConfigV1QuadReg
roiMask((ConfigV1)arg1) → int
tdi((ConfigV1)arg1) → int
TypeId = 43
Version = 1

Class psana.CsPad2x2.ConfigV1QuadReg

class psana.CsPad2x2.ConfigV1QuadReg

Configuration data for single “quadrant” which for 2x2 means a single 2x2.

Raises an exception This class cannot be instantiated from Python

PeltierEnable((ConfigV1QuadReg)arg1) → int
acqDelay((ConfigV1QuadReg)arg1) → int
ampIdle((ConfigV1QuadReg)arg1) → int
ampReset((ConfigV1QuadReg)arg1) → int
dataMode((ConfigV1QuadReg)arg1) → int
digCount((ConfigV1QuadReg)arg1) → int
digDelay((ConfigV1QuadReg)arg1) → int
digPeriod((ConfigV1QuadReg)arg1) → int
dp((ConfigV1QuadReg)arg1) → CsPad2x2DigitalPotsCfg
edgeSelect((ConfigV1QuadReg)arg1) → int
gm((ConfigV1QuadReg)arg1) → CsPad2x2GainMapCfg :

Gain map.

humidThold((ConfigV1QuadReg)arg1) → int
injTotal((ConfigV1QuadReg)arg1) → int
intTime((ConfigV1QuadReg)arg1) → int
kdConstant((ConfigV1QuadReg)arg1) → int
kiConstant((ConfigV1QuadReg)arg1) → int
kpConstant((ConfigV1QuadReg)arg1) → int
prstSel((ConfigV1QuadReg)arg1) → int
readClkHold((ConfigV1QuadReg)arg1) → int
readClkSet((ConfigV1QuadReg)arg1) → int
ro((ConfigV1QuadReg)arg1) → CsPad2x2ReadOnlyCfg :

read-only configuration

rowColShiftPer((ConfigV1QuadReg)arg1) → int
setPoint((ConfigV1QuadReg)arg1) → int
shiftSelect((ConfigV1QuadReg)arg1) → int

Class psana.CsPad2x2.ConfigV2

class psana.CsPad2x2.ConfigV2

Configuration data for 2x2 CsPad device.

Raises an exception This class cannot be instantiated from Python

activeRunMode((ConfigV2)arg1) → int
asicMask((ConfigV2)arg1) → int
badAsicMask((ConfigV2)arg1) → int
concentratorVersion((ConfigV2)arg1) → int
inactiveRunMode((ConfigV2)arg1) → int
numAsicsRead((ConfigV2)arg1) → int
numAsicsStored((ConfigV2)arg1) → int :

Number of ASICs in given quadrant

payloadSize((ConfigV2)arg1) → int
protectionEnable((ConfigV2)arg1) → int
protectionThreshold((ConfigV2)arg1) → ProtectionSystemThreshold
quad((ConfigV2)arg1) → ConfigV2QuadReg
roiMask((ConfigV2)arg1) → int
runTriggerDelay((ConfigV2)arg1) → int
tdi((ConfigV2)arg1) → int
TypeId = 43
Version = 2

Class psana.CsPad2x2.ConfigV2QuadReg

class psana.CsPad2x2.ConfigV2QuadReg

Configuration data for single “quadrant” which for 2x2 means a single 2x2.

Raises an exception This class cannot be instantiated from Python

PeltierEnable((ConfigV2QuadReg)arg1) → int
acqDelay((ConfigV2QuadReg)arg1) → int
ampIdle((ConfigV2QuadReg)arg1) → int
ampReset((ConfigV2QuadReg)arg1) → int
biasTuning((ConfigV2QuadReg)arg1) → int :

bias tuning is used, but not written; 2 bits per nibble, C2,C1,I5,I2; bit order rc00rc00rc00rc

dataMode((ConfigV2QuadReg)arg1) → int
digCount((ConfigV2QuadReg)arg1) → int
digDelay((ConfigV2QuadReg)arg1) → int
digPeriod((ConfigV2QuadReg)arg1) → int
dp((ConfigV2QuadReg)arg1) → CsPad2x2DigitalPotsCfg
edgeSelect((ConfigV2QuadReg)arg1) → int
gm((ConfigV2QuadReg)arg1) → CsPad2x2GainMapCfg :

Gain map.

humidThold((ConfigV2QuadReg)arg1) → int
injTotal((ConfigV2QuadReg)arg1) → int
intTime((ConfigV2QuadReg)arg1) → int
kdConstant((ConfigV2QuadReg)arg1) → int
kiConstant((ConfigV2QuadReg)arg1) → int
kpConstant((ConfigV2QuadReg)arg1) → int
pdpmndnmBalance((ConfigV2QuadReg)arg1) → int :

pMOS and nMOS Displacement and Main; used but not written and not in GUI yet; hard-wired to zero in GUI; 2 bits per nibble, bit order pd00pm00nd00nm

prstSel((ConfigV2QuadReg)arg1) → int
readClkHold((ConfigV2QuadReg)arg1) → int
readClkSet((ConfigV2QuadReg)arg1) → int
ro((ConfigV2QuadReg)arg1) → CsPad2x2ReadOnlyCfg :

read-only configuration

rowColShiftPer((ConfigV2QuadReg)arg1) → int
setPoint((ConfigV2QuadReg)arg1) → int
shiftSelect((ConfigV2QuadReg)arg1) → int

Class psana.CsPad2x2.CsPad2x2DigitalPotsCfg

class psana.CsPad2x2.CsPad2x2DigitalPotsCfg

Class defining configuration for CsPad POTs?

Raises an exception This class cannot be instantiated from Python

pots((CsPad2x2DigitalPotsCfg)arg1) → numpy.ndarray

Class psana.CsPad2x2.CsPad2x2GainMapCfg

class psana.CsPad2x2.CsPad2x2GainMapCfg

Class defining ASIC gain map.

Raises an exception This class cannot be instantiated from Python

gainMap((CsPad2x2GainMapCfg)arg1) → numpy.ndarray :

Array with the gain map for single ASIC.

Class psana.CsPad2x2.CsPad2x2ReadOnlyCfg

class psana.CsPad2x2.CsPad2x2ReadOnlyCfg

Class defining read-only configuration.

Raises an exception This class cannot be instantiated from Python

shiftTest((CsPad2x2ReadOnlyCfg)arg1) → int
version((CsPad2x2ReadOnlyCfg)arg1) → int

Class psana.CsPad2x2.DataModes

class psana.CsPad2x2.DataModes
names = {'shiftTest': psana.CsPad2x2.DataModes.shiftTest, 'reserved': psana.CsPad2x2.DataModes.reserved, 'testData': psana.CsPad2x2.DataModes.testData, 'normal': psana.CsPad2x2.DataModes.normal}
normal = psana.CsPad2x2.DataModes.normal
reserved = psana.CsPad2x2.DataModes.reserved
shiftTest = psana.CsPad2x2.DataModes.shiftTest
testData = psana.CsPad2x2.DataModes.testData
values = {0: psana.CsPad2x2.DataModes.normal, 1: psana.CsPad2x2.DataModes.shiftTest, 2: psana.CsPad2x2.DataModes.testData, 3: psana.CsPad2x2.DataModes.reserved}

Class psana.CsPad2x2.ElementV1

class psana.CsPad2x2.ElementV1

CsPad data from single 2x2 element.

Raises an exception This class cannot be instantiated from Python

acq_count((ElementV1)arg1) → int
common_mode((ElementV1)arg1, (int)arg2) → float :

Common mode value for a given section, section number can be 0 or 1. Will return 0 for data read from XTC, may be non-zero after calibration.

data((ElementV1)arg1) → numpy.ndarray
fiducials((ElementV1)arg1) → int
frame_type((ElementV1)arg1) → int
lane((ElementV1)arg1) → int :

Lane number.

op_code((ElementV1)arg1) → int
quad((ElementV1)arg1) → int :

Quadrant number.

sb_temp((ElementV1)arg1) → numpy.ndarray
seq_count((ElementV1)arg1) → int
ticks((ElementV1)arg1) → int
tid((ElementV1)arg1) → int
virtual_channel((ElementV1)arg1) → int :

Virtual channel number.

Nsbtemp = 4
TypeId = 41
Version = 1

Class psana.CsPad2x2.ProtectionSystemThreshold

class psana.CsPad2x2.ProtectionSystemThreshold

Raises an exception This class cannot be instantiated from Python

adcThreshold((ProtectionSystemThreshold)arg1) → int
pixelCountThreshold((ProtectionSystemThreshold)arg1) → int

Class psana.CsPad2x2.RunModes

class psana.CsPad2x2.RunModes
ExternalTriggerDrop = psana.CsPad2x2.RunModes.ExternalTriggerDrop
ExternalTriggerSendToRCE = psana.CsPad2x2.RunModes.ExternalTriggerSendToRCE
NoRunning = psana.CsPad2x2.RunModes.NoRunning
NumberOfRunModes = psana.CsPad2x2.RunModes.NumberOfRunModes
RunAndSendToRCE = psana.CsPad2x2.RunModes.RunAndSendToRCE
RunAndSendTriggeredByTTL = psana.CsPad2x2.RunModes.RunAndSendTriggeredByTTL
RunButDrop = psana.CsPad2x2.RunModes.RunButDrop
names = {'ExternalTriggerSendToRCE': psana.CsPad2x2.RunModes.ExternalTriggerSendToRCE, 'NoRunning': psana.CsPad2x2.RunModes.NoRunning, 'RunButDrop': psana.CsPad2x2.RunModes.RunButDrop, 'ExternalTriggerDrop': psana.CsPad2x2.RunModes.ExternalTriggerDrop, 'RunAndSendToRCE': psana.CsPad2x2.RunModes.RunAndSendToRCE, 'RunAndSendTriggeredByTTL': psana.CsPad2x2.RunModes.RunAndSendTriggeredByTTL, 'NumberOfRunModes': psana.CsPad2x2.RunModes.NumberOfRunModes}
values = {0: psana.CsPad2x2.RunModes.NoRunning, 1: psana.CsPad2x2.RunModes.RunButDrop, 2: psana.CsPad2x2.RunModes.RunAndSendToRCE, 3: psana.CsPad2x2.RunModes.RunAndSendTriggeredByTTL, 4: psana.CsPad2x2.RunModes.ExternalTriggerSendToRCE, 5: psana.CsPad2x2.RunModes.ExternalTriggerDrop, 6: psana.CsPad2x2.RunModes.NumberOfRunModes}

Module psana.datasource

Function psana.datasource.DataSource

psana.datasource.DataSource(*args, **kwargs)[source]

Makes an instance of the data source object (psana._DataSource). Arguments can be either a single list of strings or any number of strings, each string represents either an input file name or event collection.

Function psana.datasource.setConfigFile

psana.datasource.setConfigFile(name)[source]

Set the name of the psana configuration file, default configuration file name is psana.cfg. If you want to avoid reading any configuration file then set it to empty string.

Configuration file name set with setConfigFile() is used in a next call to DataSource().

Function psana.datasource.setOption

psana.datasource.setOption(name, value)[source]

Set the psana configuration option, this will override any configuration option in a file. Option name has format “section.option” where “section” is the name of the section in configuration file (such as “psana” or “psana_examples.DumpPrinceton”). Value can be any string, possibly empty, non-string values will be converted to strings using str() call.

Configuration options set with setOption() are used in a next call to DataSource().

Function psana.datasource.setOptions

psana.datasource.setOptions(mapping)[source]

Set the psana configuration option, this will override any configuration option in a file. Argument to this calls is a mapping (dictionary) whose keys are option names. Option name has format “section.option” where “section” is the name of the section in configuration file (such as “psana” or “psana_examples.DumpPrinceton”). Value can be any string, possibly empty, non-string values will be converted to strings using str() call.

Configuration options set with setOptions() are used in a next call to DataSource().

Module psana.det_interface

Function psana.det_interface.Detector

psana.det_interface.Detector(name, local_env=None, accept_missing=False)[source]

Create a python Detector from a string identifier.

source_string : str
A string identifying a piece of data to access, examples include:
  • ‘cspad’ # a DAQ detector alias
  • ‘XppGon.0:Cspad.0’ # a DAQ detector full-name
  • ‘DIAG:FEE1:202:241:Data’ # an EPICS variable name (or alias)
  • ‘EBeam’ # a BldInfo identifier

The idea is that you should be able to pass something that makes sense to you as a human here, and you automatically get the right detector object in return.

local_env : psana.Env
The psana environment object associated with the psana.DataSource you are interested in (from method DataSource.env()).
accept_missing : bool
If False, KeyError exception will be raised if “name” is not present in the current DataSource. If True, an object will be returned that returns None for all method calls. This allows software to not crash if a detector is missing from a run.

A psana-python detector object. Try detector(psana.Event) to access your data.

The Detector method returns an object that has methods that change depending on the detector type. To see help for a particular detector type execute commands similar to the following

env = DataSource(‘exp=xpptut15:run=54’).env() det = Detector(‘cspad’,env)

and then use the standard ipython “det?” command (and tab completion) to see the documentation for that particular detector type.

Function psana.det_interface.DetNames

psana.det_interface.DetNames(nametype='detectors', local_env=None)[source]

Return tuples of detector names. Nametype should be one of ‘detectors’,’epics’,’all’. ‘detectors’ returns the names of all standard detectors included in the data. ‘epics’ returns the names of all epics variables (epics variables are typically updated at 1Hz with information about slow quantities like temperatures, voltages, motor positions). ‘all’ returns both of the above.

Each detector can have 3 names: a “full name”, a simpler “daq alias”, or a “user alias”. The last two are optional.

This routine takes an optional “DataSource.Env” argument. If not provided the Env from the most recently created DataSource will be used. It typically only needs to be specified when using multiple DataSource instances simultaneously.

Module psana.Encoder

The Python wrapper module for Encoder types

Class psana.Encoder.ConfigV1

class psana.Encoder.ConfigV1

Raises an exception This class cannot be instantiated from Python

class count_mode_type
COUNT_END = psana.Encoder.count_mode_type.COUNT_END
HALT = psana.Encoder.count_mode_type.HALT
LIMIT = psana.Encoder.count_mode_type.LIMIT
WRAP_FULL = psana.Encoder.count_mode_type.WRAP_FULL
WRAP_PRESET = psana.Encoder.count_mode_type.WRAP_PRESET
names = {'WRAP_FULL': psana.Encoder.count_mode_type.WRAP_FULL, 'LIMIT': psana.Encoder.count_mode_type.LIMIT, 'HALT': psana.Encoder.count_mode_type.HALT, 'COUNT_END': psana.Encoder.count_mode_type.COUNT_END, 'WRAP_PRESET': psana.Encoder.count_mode_type.WRAP_PRESET}
values = {0: psana.Encoder.count_mode_type.WRAP_FULL, 1: psana.Encoder.count_mode_type.LIMIT, 2: psana.Encoder.count_mode_type.HALT, 3: psana.Encoder.count_mode_type.WRAP_PRESET, 4: psana.Encoder.count_mode_type.COUNT_END}
class ConfigV1.quad_mode
CLOCK_DIR = psana.Encoder.quad_mode.CLOCK_DIR
QUAD_END = psana.Encoder.quad_mode.QUAD_END
X1 = psana.Encoder.quad_mode.X1
X2 = psana.Encoder.quad_mode.X2
X4 = psana.Encoder.quad_mode.X4
names = {'X2': psana.Encoder.quad_mode.X2, 'X1': psana.Encoder.quad_mode.X1, 'QUAD_END': psana.Encoder.quad_mode.QUAD_END, 'X4': psana.Encoder.quad_mode.X4, 'CLOCK_DIR': psana.Encoder.quad_mode.CLOCK_DIR}
values = {0: psana.Encoder.quad_mode.CLOCK_DIR, 1: psana.Encoder.quad_mode.X1, 2: psana.Encoder.quad_mode.X2, 3: psana.Encoder.quad_mode.X4, 4: psana.Encoder.quad_mode.QUAD_END}
ConfigV1.chan_num((ConfigV1)arg1) → int
ConfigV1.count_mode((ConfigV1)arg1) → count_mode_type
ConfigV1.input_num((ConfigV1)arg1) → int
ConfigV1.input_rising((ConfigV1)arg1) → int
ConfigV1.quadrature_mode((ConfigV1)arg1) → quad_mode
ConfigV1.ticks_per_sec((ConfigV1)arg1) → int
ConfigV1.TypeId = 25
ConfigV1.Version = 1

Class psana.Encoder.ConfigV2

class psana.Encoder.ConfigV2

Raises an exception This class cannot be instantiated from Python

class count_mode_type
COUNT_END = psana.Encoder.count_mode_type.COUNT_END
HALT = psana.Encoder.count_mode_type.HALT
LIMIT = psana.Encoder.count_mode_type.LIMIT
WRAP_FULL = psana.Encoder.count_mode_type.WRAP_FULL
WRAP_PRESET = psana.Encoder.count_mode_type.WRAP_PRESET
names = {'WRAP_FULL': psana.Encoder.count_mode_type.WRAP_FULL, 'LIMIT': psana.Encoder.count_mode_type.LIMIT, 'HALT': psana.Encoder.count_mode_type.HALT, 'COUNT_END': psana.Encoder.count_mode_type.COUNT_END, 'WRAP_PRESET': psana.Encoder.count_mode_type.WRAP_PRESET}
values = {0: psana.Encoder.count_mode_type.WRAP_FULL, 1: psana.Encoder.count_mode_type.LIMIT, 2: psana.Encoder.count_mode_type.HALT, 3: psana.Encoder.count_mode_type.WRAP_PRESET, 4: psana.Encoder.count_mode_type.COUNT_END}
class ConfigV2.quad_mode
CLOCK_DIR = psana.Encoder.quad_mode.CLOCK_DIR
QUAD_END = psana.Encoder.quad_mode.QUAD_END
X1 = psana.Encoder.quad_mode.X1
X2 = psana.Encoder.quad_mode.X2
X4 = psana.Encoder.quad_mode.X4
names = {'X2': psana.Encoder.quad_mode.X2, 'X1': psana.Encoder.quad_mode.X1, 'QUAD_END': psana.Encoder.quad_mode.QUAD_END, 'X4': psana.Encoder.quad_mode.X4, 'CLOCK_DIR': psana.Encoder.quad_mode.CLOCK_DIR}
values = {0: psana.Encoder.quad_mode.CLOCK_DIR, 1: psana.Encoder.quad_mode.X1, 2: psana.Encoder.quad_mode.X2, 3: psana.Encoder.quad_mode.X4, 4: psana.Encoder.quad_mode.QUAD_END}
ConfigV2.chan_mask((ConfigV2)arg1) → int
ConfigV2.count_mode((ConfigV2)arg1) → count_mode_type
ConfigV2.input_num((ConfigV2)arg1) → int
ConfigV2.input_rising((ConfigV2)arg1) → int
ConfigV2.quadrature_mode((ConfigV2)arg1) → quad_mode
ConfigV2.ticks_per_sec((ConfigV2)arg1) → int
ConfigV2.TypeId = 25
ConfigV2.Version = 2

Class psana.Encoder.DataV1

class psana.Encoder.DataV1

Raises an exception This class cannot be instantiated from Python

encoder_count((DataV1)arg1) → int
timestamp((DataV1)arg1) → int
value((DataV1)arg1) → int :

Lower 24 bits of encoder_count as signed integer value.

TypeId = 24
Version = 1

Class psana.Encoder.DataV2

class psana.Encoder.DataV2

Raises an exception This class cannot be instantiated from Python

encoder_count((DataV2)arg1) → numpy.ndarray
timestamp((DataV2)arg1) → int
value((DataV2)arg1, (int)arg2) → int :

Lower 24 bits of encoder_count as signed integer value.

NEncoders = 3
TypeId = 24
Version = 2

Module psana.Epics

The Python wrapper module for Epics types

Class psana.Epics.ConfigV1

class psana.Epics.ConfigV1

Raises an exception This class cannot be instantiated from Python

getPvConfig((ConfigV1)arg1) → list
numPv((ConfigV1)arg1) → int
TypeId = 54
Version = 1

Class psana.Epics.dbr_ctrl_char

class psana.Epics.dbr_ctrl_char

Raises an exception This class cannot be instantiated from Python

lower_alarm_limit((dbr_ctrl_char)arg1) → int
lower_ctrl_limit((dbr_ctrl_char)arg1) → int
lower_disp_limit((dbr_ctrl_char)arg1) → int
lower_warning_limit((dbr_ctrl_char)arg1) → int
severity((dbr_ctrl_char)arg1) → int
status((dbr_ctrl_char)arg1) → int
units((dbr_ctrl_char)arg1) → str
units_shape((dbr_ctrl_char)arg1) → object
upper_alarm_limit((dbr_ctrl_char)arg1) → int
upper_ctrl_limit((dbr_ctrl_char)arg1) → int
upper_disp_limit((dbr_ctrl_char)arg1) → int
upper_warning_limit((dbr_ctrl_char)arg1) → int
DBR_TYPE_ID = psana.Epics.DbrTypes.DBR_CTRL_CHAR

Class psana.Epics.dbr_ctrl_double

class psana.Epics.dbr_ctrl_double

Raises an exception This class cannot be instantiated from Python

lower_alarm_limit((dbr_ctrl_double)arg1) → float
lower_ctrl_limit((dbr_ctrl_double)arg1) → float
lower_disp_limit((dbr_ctrl_double)arg1) → float
lower_warning_limit((dbr_ctrl_double)arg1) → float
precision((dbr_ctrl_double)arg1) → int
severity((dbr_ctrl_double)arg1) → int
status((dbr_ctrl_double)arg1) → int
units((dbr_ctrl_double)arg1) → str
units_shape((dbr_ctrl_double)arg1) → object
upper_alarm_limit((dbr_ctrl_double)arg1) → float
upper_ctrl_limit((dbr_ctrl_double)arg1) → float
upper_disp_limit((dbr_ctrl_double)arg1) → float
upper_warning_limit((dbr_ctrl_double)arg1) → float
DBR_TYPE_ID = psana.Epics.DbrTypes.DBR_CTRL_DOUBLE

Class psana.Epics.dbr_ctrl_enum

class psana.Epics.dbr_ctrl_enum

Raises an exception This class cannot be instantiated from Python

no_str((dbr_ctrl_enum)arg1) → int
severity((dbr_ctrl_enum)arg1) → int
status((dbr_ctrl_enum)arg1) → int
strings((dbr_ctrl_enum)arg1, (int)arg2) → str
strings_shape((dbr_ctrl_enum)arg1) → object
DBR_TYPE_ID = psana.Epics.DbrTypes.DBR_CTRL_ENUM

Class psana.Epics.dbr_ctrl_float

class psana.Epics.dbr_ctrl_float

Raises an exception This class cannot be instantiated from Python

lower_alarm_limit((dbr_ctrl_float)arg1) → float
lower_ctrl_limit((dbr_ctrl_float)arg1) → float
lower_disp_limit((dbr_ctrl_float)arg1) → float
lower_warning_limit((dbr_ctrl_float)arg1) → float
precision((dbr_ctrl_float)arg1) → int
severity((dbr_ctrl_float)arg1) → int
status((dbr_ctrl_float)arg1) → int
units((dbr_ctrl_float)arg1) → str
units_shape((dbr_ctrl_float)arg1) → object
upper_alarm_limit((dbr_ctrl_float)arg1) → float
upper_ctrl_limit((dbr_ctrl_float)arg1) → float
upper_disp_limit((dbr_ctrl_float)arg1) → float
upper_warning_limit((dbr_ctrl_float)arg1) → float
DBR_TYPE_ID = psana.Epics.DbrTypes.DBR_CTRL_FLOAT

Class psana.Epics.dbr_ctrl_long

class psana.Epics.dbr_ctrl_long

Raises an exception This class cannot be instantiated from Python

lower_alarm_limit((dbr_ctrl_long)arg1) → int
lower_ctrl_limit((dbr_ctrl_long)arg1) → int
lower_disp_limit((dbr_ctrl_long)arg1) → int
lower_warning_limit((dbr_ctrl_long)arg1) → int
severity((dbr_ctrl_long)arg1) → int
status((dbr_ctrl_long)arg1) → int
units((dbr_ctrl_long)arg1) → str
units_shape((dbr_ctrl_long)arg1) → object
upper_alarm_limit((dbr_ctrl_long)arg1) → int
upper_ctrl_limit((dbr_ctrl_long)arg1) → int
upper_disp_limit((dbr_ctrl_long)arg1) → int
upper_warning_limit((dbr_ctrl_long)arg1) → int
DBR_TYPE_ID = psana.Epics.DbrTypes.DBR_CTRL_LONG

Class psana.Epics.dbr_ctrl_short

class psana.Epics.dbr_ctrl_short

Raises an exception This class cannot be instantiated from Python

lower_alarm_limit((dbr_ctrl_short)arg1) → int
lower_ctrl_limit((dbr_ctrl_short)arg1) → int
lower_disp_limit((dbr_ctrl_short)arg1) → int
lower_warning_limit((dbr_ctrl_short)arg1) → int
severity((dbr_ctrl_short)arg1) → int
status((dbr_ctrl_short)arg1) → int
units((dbr_ctrl_short)arg1) → str
units_shape((dbr_ctrl_short)arg1) → object
upper_alarm_limit((dbr_ctrl_short)arg1) → int
upper_ctrl_limit((dbr_ctrl_short)arg1) → int
upper_disp_limit((dbr_ctrl_short)arg1) → int
upper_warning_limit((dbr_ctrl_short)arg1) → int
DBR_TYPE_ID = psana.Epics.DbrTypes.DBR_CTRL_SHORT

Class psana.Epics.dbr_sts_string

class psana.Epics.dbr_sts_string

Raises an exception This class cannot be instantiated from Python

severity((dbr_sts_string)arg1) → int
status((dbr_sts_string)arg1) → int
DBR_TYPE_ID = psana.Epics.DbrTypes.DBR_CTRL_STRING

Class psana.Epics.dbr_time_char

class psana.Epics.dbr_time_char

Raises an exception This class cannot be instantiated from Python

severity((dbr_time_char)arg1) → int
stamp((dbr_time_char)arg1) → epicsTimeStamp
status((dbr_time_char)arg1) → int
DBR_TYPE_ID = psana.Epics.DbrTypes.DBR_TIME_CHAR

Class psana.Epics.dbr_time_double

class psana.Epics.dbr_time_double

Raises an exception This class cannot be instantiated from Python

severity((dbr_time_double)arg1) → int
stamp((dbr_time_double)arg1) → epicsTimeStamp
status((dbr_time_double)arg1) → int
DBR_TYPE_ID = psana.Epics.DbrTypes.DBR_TIME_DOUBLE

Class psana.Epics.dbr_time_enum

class psana.Epics.dbr_time_enum

Raises an exception This class cannot be instantiated from Python

severity((dbr_time_enum)arg1) → int
stamp((dbr_time_enum)arg1) → epicsTimeStamp
status((dbr_time_enum)arg1) → int
DBR_TYPE_ID = psana.Epics.DbrTypes.DBR_TIME_ENUM

Class psana.Epics.dbr_time_float

class psana.Epics.dbr_time_float

Raises an exception This class cannot be instantiated from Python

severity((dbr_time_float)arg1) → int
stamp((dbr_time_float)arg1) → epicsTimeStamp
status((dbr_time_float)arg1) → int
DBR_TYPE_ID = psana.Epics.DbrTypes.DBR_TIME_FLOAT

Class psana.Epics.dbr_time_long

class psana.Epics.dbr_time_long

Raises an exception This class cannot be instantiated from Python

severity((dbr_time_long)arg1) → int
stamp((dbr_time_long)arg1) → epicsTimeStamp
status((dbr_time_long)arg1) → int
DBR_TYPE_ID = psana.Epics.DbrTypes.DBR_TIME_LONG

Class psana.Epics.dbr_time_short

class psana.Epics.dbr_time_short

Raises an exception This class cannot be instantiated from Python

severity((dbr_time_short)arg1) → int
stamp((dbr_time_short)arg1) → epicsTimeStamp
status((dbr_time_short)arg1) → int
DBR_TYPE_ID = psana.Epics.DbrTypes.DBR_TIME_SHORT

Class psana.Epics.dbr_time_string

class psana.Epics.dbr_time_string

Raises an exception This class cannot be instantiated from Python

severity((dbr_time_string)arg1) → int
stamp((dbr_time_string)arg1) → epicsTimeStamp
status((dbr_time_string)arg1) → int
DBR_TYPE_ID = psana.Epics.DbrTypes.DBR_TIME_STRING

Class psana.Epics.DbrTypes

class psana.Epics.DbrTypes
DBR_CHAR = psana.Epics.DbrTypes.DBR_CHAR
DBR_CTRL_CHAR = psana.Epics.DbrTypes.DBR_CTRL_CHAR
DBR_CTRL_DOUBLE = psana.Epics.DbrTypes.DBR_CTRL_DOUBLE
DBR_CTRL_ENUM = psana.Epics.DbrTypes.DBR_CTRL_ENUM
DBR_CTRL_FLOAT = psana.Epics.DbrTypes.DBR_CTRL_FLOAT
DBR_CTRL_LONG = psana.Epics.DbrTypes.DBR_CTRL_LONG
DBR_CTRL_SHORT = psana.Epics.DbrTypes.DBR_CTRL_SHORT
DBR_CTRL_STRING = psana.Epics.DbrTypes.DBR_CTRL_STRING
DBR_DOUBLE = psana.Epics.DbrTypes.DBR_DOUBLE
DBR_ENUM = psana.Epics.DbrTypes.DBR_ENUM
DBR_FLOAT = psana.Epics.DbrTypes.DBR_FLOAT
DBR_GR_CHAR = psana.Epics.DbrTypes.DBR_GR_CHAR
DBR_GR_DOUBLE = psana.Epics.DbrTypes.DBR_GR_DOUBLE
DBR_GR_ENUM = psana.Epics.DbrTypes.DBR_GR_ENUM
DBR_GR_FLOAT = psana.Epics.DbrTypes.DBR_GR_FLOAT
DBR_GR_LONG = psana.Epics.DbrTypes.DBR_GR_LONG
DBR_GR_SHORT = psana.Epics.DbrTypes.DBR_GR_SHORT
DBR_GR_STRING = psana.Epics.DbrTypes.DBR_GR_STRING
DBR_LONG = psana.Epics.DbrTypes.DBR_LONG
DBR_SHORT = psana.Epics.DbrTypes.DBR_SHORT
DBR_STRING = psana.Epics.DbrTypes.DBR_STRING
DBR_STS_CHAR = psana.Epics.DbrTypes.DBR_STS_CHAR
DBR_STS_DOUBLE = psana.Epics.DbrTypes.DBR_STS_DOUBLE
DBR_STS_ENUM = psana.Epics.DbrTypes.DBR_STS_ENUM
DBR_STS_FLOAT = psana.Epics.DbrTypes.DBR_STS_FLOAT
DBR_STS_LONG = psana.Epics.DbrTypes.DBR_STS_LONG
DBR_STS_SHORT = psana.Epics.DbrTypes.DBR_STS_SHORT
DBR_STS_STRING = psana.Epics.DbrTypes.DBR_STS_STRING
DBR_TIME_CHAR = psana.Epics.DbrTypes.DBR_TIME_CHAR
DBR_TIME_DOUBLE = psana.Epics.DbrTypes.DBR_TIME_DOUBLE
DBR_TIME_ENUM = psana.Epics.DbrTypes.DBR_TIME_ENUM
DBR_TIME_FLOAT = psana.Epics.DbrTypes.DBR_TIME_FLOAT
DBR_TIME_INT = psana.Epics.DbrTypes.DBR_TIME_INT
DBR_TIME_LONG = psana.Epics.DbrTypes.DBR_TIME_LONG
DBR_TIME_SHORT = psana.Epics.DbrTypes.DBR_TIME_SHORT
DBR_TIME_STRING = psana.Epics.DbrTypes.DBR_TIME_STRING
names = {'DBR_STRING': psana.Epics.DbrTypes.DBR_STRING, 'DBR_GR_ENUM': psana.Epics.DbrTypes.DBR_GR_ENUM, 'DBR_CTRL_ENUM': psana.Epics.DbrTypes.DBR_CTRL_ENUM, 'DBR_GR_SHORT': psana.Epics.DbrTypes.DBR_GR_SHORT, 'DBR_TIME_FLOAT': psana.Epics.DbrTypes.DBR_TIME_FLOAT, 'DBR_GR_CHAR': psana.Epics.DbrTypes.DBR_GR_CHAR, 'DBR_CTRL_LONG': psana.Epics.DbrTypes.DBR_CTRL_LONG, 'DBR_ENUM': psana.Epics.DbrTypes.DBR_ENUM, 'DBR_LONG': psana.Epics.DbrTypes.DBR_LONG, 'DBR_TIME_ENUM': psana.Epics.DbrTypes.DBR_TIME_ENUM, 'DBR_TIME_INT': psana.Epics.DbrTypes.DBR_TIME_INT, 'DBR_CTRL_STRING': psana.Epics.DbrTypes.DBR_CTRL_STRING, 'DBR_CTRL_FLOAT': psana.Epics.DbrTypes.DBR_CTRL_FLOAT, 'DBR_CTRL_CHAR': psana.Epics.DbrTypes.DBR_CTRL_CHAR, 'DBR_STS_FLOAT': psana.Epics.DbrTypes.DBR_STS_FLOAT, 'DBR_TIME_LONG': psana.Epics.DbrTypes.DBR_TIME_LONG, 'DBR_GR_STRING': psana.Epics.DbrTypes.DBR_GR_STRING, 'DBR_CTRL_DOUBLE': psana.Epics.DbrTypes.DBR_CTRL_DOUBLE, 'DBR_STS_SHORT': psana.Epics.DbrTypes.DBR_STS_SHORT, 'DBR_STS_LONG': psana.Epics.DbrTypes.DBR_STS_LONG, 'DBR_TIME_STRING': psana.Epics.DbrTypes.DBR_TIME_STRING, 'DBR_TIME_SHORT': psana.Epics.DbrTypes.DBR_TIME_SHORT, 'DBR_TIME_CHAR': psana.Epics.DbrTypes.DBR_TIME_CHAR, 'DBR_DOUBLE': psana.Epics.DbrTypes.DBR_DOUBLE, 'DBR_CHAR': psana.Epics.DbrTypes.DBR_CHAR, 'DBR_SHORT': psana.Epics.DbrTypes.DBR_SHORT, 'DBR_GR_LONG': psana.Epics.DbrTypes.DBR_GR_LONG, 'DBR_TIME_DOUBLE': psana.Epics.DbrTypes.DBR_TIME_DOUBLE, 'DBR_CTRL_SHORT': psana.Epics.DbrTypes.DBR_CTRL_SHORT, 'DBR_GR_FLOAT': psana.Epics.DbrTypes.DBR_GR_FLOAT, 'DBR_GR_DOUBLE': psana.Epics.DbrTypes.DBR_GR_DOUBLE, 'DBR_STS_ENUM': psana.Epics.DbrTypes.DBR_STS_ENUM, 'DBR_STS_STRING': psana.Epics.DbrTypes.DBR_STS_STRING, 'DBR_STS_CHAR': psana.Epics.DbrTypes.DBR_STS_CHAR, 'DBR_STS_DOUBLE': psana.Epics.DbrTypes.DBR_STS_DOUBLE, 'DBR_FLOAT': psana.Epics.DbrTypes.DBR_FLOAT}
values = {0: psana.Epics.DbrTypes.DBR_STRING, 1: psana.Epics.DbrTypes.DBR_SHORT, 2: psana.Epics.DbrTypes.DBR_FLOAT, 3: psana.Epics.DbrTypes.DBR_ENUM, 4: psana.Epics.DbrTypes.DBR_CHAR, 5: psana.Epics.DbrTypes.DBR_LONG, 6: psana.Epics.DbrTypes.DBR_DOUBLE, 7: psana.Epics.DbrTypes.DBR_STS_STRING, 8: psana.Epics.DbrTypes.DBR_STS_SHORT, 9: psana.Epics.DbrTypes.DBR_STS_FLOAT, 10: psana.Epics.DbrTypes.DBR_STS_ENUM, 11: psana.Epics.DbrTypes.DBR_STS_CHAR, 12: psana.Epics.DbrTypes.DBR_STS_LONG, 13: psana.Epics.DbrTypes.DBR_STS_DOUBLE, 14: psana.Epics.DbrTypes.DBR_TIME_STRING, 15: psana.Epics.DbrTypes.DBR_TIME_SHORT, 16: psana.Epics.DbrTypes.DBR_TIME_FLOAT, 17: psana.Epics.DbrTypes.DBR_TIME_ENUM, 18: psana.Epics.DbrTypes.DBR_TIME_CHAR, 19: psana.Epics.DbrTypes.DBR_TIME_LONG, 20: psana.Epics.DbrTypes.DBR_TIME_DOUBLE, 21: psana.Epics.DbrTypes.DBR_GR_STRING, 22: psana.Epics.DbrTypes.DBR_GR_SHORT, 23: psana.Epics.DbrTypes.DBR_GR_FLOAT, 24: psana.Epics.DbrTypes.DBR_GR_ENUM, 25: psana.Epics.DbrTypes.DBR_GR_CHAR, 26: psana.Epics.DbrTypes.DBR_GR_LONG, 27: psana.Epics.DbrTypes.DBR_GR_DOUBLE, 28: psana.Epics.DbrTypes.DBR_CTRL_STRING, 29: psana.Epics.DbrTypes.DBR_CTRL_SHORT, 30: psana.Epics.DbrTypes.DBR_CTRL_FLOAT, 31: psana.Epics.DbrTypes.DBR_CTRL_ENUM, 32: psana.Epics.DbrTypes.DBR_CTRL_CHAR, 33: psana.Epics.DbrTypes.DBR_CTRL_LONG, 34: psana.Epics.DbrTypes.DBR_CTRL_DOUBLE}

Class psana.Epics.EpicsPvCtrlChar

class psana.Epics.EpicsPvCtrlChar

Raises an exception This class cannot be instantiated from Python

data((EpicsPvCtrlChar)arg1) → numpy.ndarray
dbr((EpicsPvCtrlChar)arg1) → dbr_ctrl_char
value((EpicsPvCtrlChar)arg1, (int)arg2) → int

Class psana.Epics.EpicsPvCtrlDouble

class psana.Epics.EpicsPvCtrlDouble

Raises an exception This class cannot be instantiated from Python

data((EpicsPvCtrlDouble)arg1) → numpy.ndarray
dbr((EpicsPvCtrlDouble)arg1) → dbr_ctrl_double
value((EpicsPvCtrlDouble)arg1, (int)arg2) → float

Class psana.Epics.EpicsPvCtrlEnum

class psana.Epics.EpicsPvCtrlEnum

Raises an exception This class cannot be instantiated from Python

data((EpicsPvCtrlEnum)arg1) → numpy.ndarray
dbr((EpicsPvCtrlEnum)arg1) → dbr_ctrl_enum
value((EpicsPvCtrlEnum)arg1, (int)arg2) → int

Class psana.Epics.EpicsPvCtrlFloat

class psana.Epics.EpicsPvCtrlFloat

Raises an exception This class cannot be instantiated from Python

data((EpicsPvCtrlFloat)arg1) → numpy.ndarray
dbr((EpicsPvCtrlFloat)arg1) → dbr_ctrl_float
value((EpicsPvCtrlFloat)arg1, (int)arg2) → float

Class psana.Epics.EpicsPvCtrlHeader

class psana.Epics.EpicsPvCtrlHeader

Base class for all CTRL-type PV values.

Raises an exception This class cannot be instantiated from Python

pvName((EpicsPvCtrlHeader)arg1) → str :

PV name.

Class psana.Epics.EpicsPvCtrlLong

class psana.Epics.EpicsPvCtrlLong

Raises an exception This class cannot be instantiated from Python

data((EpicsPvCtrlLong)arg1) → numpy.ndarray
dbr((EpicsPvCtrlLong)arg1) → dbr_ctrl_long
value((EpicsPvCtrlLong)arg1, (int)arg2) → int

Class psana.Epics.EpicsPvCtrlShort

class psana.Epics.EpicsPvCtrlShort

Raises an exception This class cannot be instantiated from Python

data((EpicsPvCtrlShort)arg1) → numpy.ndarray
dbr((EpicsPvCtrlShort)arg1) → dbr_ctrl_short
value((EpicsPvCtrlShort)arg1, (int)arg2) → int

Class psana.Epics.EpicsPvCtrlString

class psana.Epics.EpicsPvCtrlString

Raises an exception This class cannot be instantiated from Python

data((EpicsPvCtrlString)arg1, (int)arg2) → str
data_shape((EpicsPvCtrlString)arg1) → object
dbr((EpicsPvCtrlString)arg1) → dbr_sts_string
value((EpicsPvCtrlString)arg1, (int)arg2) → str

Class psana.Epics.EpicsPvHeader

class psana.Epics.EpicsPvHeader

Base class for EPICS data types stored in XTC files.

Raises an exception This class cannot be instantiated from Python

dbrType((EpicsPvHeader)arg1) → int :

DBR structure type.

isCtrl((EpicsPvHeader)arg1) → int :

Returns 1 if PV is one of CTRL types, 0 otherwise.

isTime((EpicsPvHeader)arg1) → int :

Returns 1 if PV is one of TIME types, 0 otherwise.

numElements((EpicsPvHeader)arg1) → int :

Number of elements in EPICS DBR structure

pvId((EpicsPvHeader)arg1) → int :

PV ID number assigned by DAQ.

severity((EpicsPvHeader)arg1) → int :

Returns severity value for the PV.

status((EpicsPvHeader)arg1) → int :

Returns status value for the PV.

Class psana.Epics.EpicsPvTimeChar

class psana.Epics.EpicsPvTimeChar

Raises an exception This class cannot be instantiated from Python

data((EpicsPvTimeChar)arg1) → numpy.ndarray
dbr((EpicsPvTimeChar)arg1) → dbr_time_char
value((EpicsPvTimeChar)arg1, (int)arg2) → int

Class psana.Epics.EpicsPvTimeDouble

class psana.Epics.EpicsPvTimeDouble

Raises an exception This class cannot be instantiated from Python

data((EpicsPvTimeDouble)arg1) → numpy.ndarray
dbr((EpicsPvTimeDouble)arg1) → dbr_time_double
value((EpicsPvTimeDouble)arg1, (int)arg2) → float

Class psana.Epics.EpicsPvTimeEnum

class psana.Epics.EpicsPvTimeEnum

Raises an exception This class cannot be instantiated from Python

data((EpicsPvTimeEnum)arg1) → numpy.ndarray
dbr((EpicsPvTimeEnum)arg1) → dbr_time_enum
value((EpicsPvTimeEnum)arg1, (int)arg2) → int

Class psana.Epics.EpicsPvTimeFloat

class psana.Epics.EpicsPvTimeFloat

Raises an exception This class cannot be instantiated from Python

data((EpicsPvTimeFloat)arg1) → numpy.ndarray
dbr((EpicsPvTimeFloat)arg1) → dbr_time_float
value((EpicsPvTimeFloat)arg1, (int)arg2) → float

Class psana.Epics.EpicsPvTimeHeader

class psana.Epics.EpicsPvTimeHeader

Base class for all TIME-type PV values.

Raises an exception This class cannot be instantiated from Python

stamp((EpicsPvTimeHeader)arg1) → epicsTimeStamp :

EPICS timestamp value.

Class psana.Epics.EpicsPvTimeLong

class psana.Epics.EpicsPvTimeLong

Raises an exception This class cannot be instantiated from Python

data((EpicsPvTimeLong)arg1) → numpy.ndarray
dbr((EpicsPvTimeLong)arg1) → dbr_time_long
value((EpicsPvTimeLong)arg1, (int)arg2) → int

Class psana.Epics.EpicsPvTimeShort

class psana.Epics.EpicsPvTimeShort

Raises an exception This class cannot be instantiated from Python

data((EpicsPvTimeShort)arg1) → numpy.ndarray
dbr((EpicsPvTimeShort)arg1) → dbr_time_short
value((EpicsPvTimeShort)arg1, (int)arg2) → int

Class psana.Epics.EpicsPvTimeString

class psana.Epics.EpicsPvTimeString

Raises an exception This class cannot be instantiated from Python

data((EpicsPvTimeString)arg1, (int)arg2) → str
data_shape((EpicsPvTimeString)arg1) → object
dbr((EpicsPvTimeString)arg1) → dbr_time_string
value((EpicsPvTimeString)arg1, (int)arg2) → str

Class psana.Epics.epicsTimeStamp

class psana.Epics.epicsTimeStamp

EPICS timestamp type, includes seconds and nanoseconds. EPICS epoch corresponds to 1990-01-01 00:00:00Z.

Raises an exception This class cannot be instantiated from Python

nsec((epicsTimeStamp)arg1) → int :

Nanoseconds within second.

sec((epicsTimeStamp)arg1) → int :

Seconds since Jan 1, 1990 00:00 UTC

Class psana.Epics.PvConfigV1

class psana.Epics.PvConfigV1

Raises an exception This class cannot be instantiated from Python

description((PvConfigV1)arg1) → str
interval((PvConfigV1)arg1) → float
pvId((PvConfigV1)arg1) → int
iMaxPvDescLength = 64

Module psana.Epix

The Python wrapper module for Epix types

Class psana.Epix.Asic100aConfigV1

class psana.Epix.Asic100aConfigV1

Raises an exception This class cannot be instantiated from Python

CCK_RegDelayEnable((Asic100aConfigV1)arg1) → int
ColumnStartAddr((Asic100aConfigV1)arg1) → int
ColumnStopAddr((Asic100aConfigV1)arg1) → int
EXEC_DelayEnable((Asic100aConfigV1)arg1) → int
LVDS_ImpedenceMatchingEnable((Asic100aConfigV1)arg1) → int
RowStartAddr((Asic100aConfigV1)arg1) → int
RowStopAddr((Asic100aConfigV1)arg1) → int
VRefBaselineDac((Asic100aConfigV1)arg1) → int
automaticTestModeEnable((Asic100aConfigV1)arg1) → int
balconyDriverCurrent((Asic100aConfigV1)arg1) → int
balconyEnable((Asic100aConfigV1)arg1) → int
bandGapReferenceTemperatureCompensationBits((Asic100aConfigV1)arg1) → int
chipID((Asic100aConfigV1)arg1) → int
digitalMonitor1Enable((Asic100aConfigV1)arg1) → int
digitalMonitor2Enable((Asic100aConfigV1)arg1) → int
digitalMonitorMux1((Asic100aConfigV1)arg1) → int
digitalMonitorMux2((Asic100aConfigV1)arg1) → int
dummyMask((Asic100aConfigV1)arg1) → int
dummyTest((Asic100aConfigV1)arg1) → int
extraRowsLowReferenceValue((Asic100aConfigV1)arg1) → int
fastPowerPulsingEnable((Asic100aConfigV1)arg1) → int
fastPowerPulsingSpeed((Asic100aConfigV1)arg1) → int
highResolutionModeTest((Asic100aConfigV1)arg1) → int
interleavedReadOutEnable((Asic100aConfigV1)arg1) → int
outputDriverDacReferenceBias((Asic100aConfigV1)arg1) → int
outputDriverDrivingCapabilitiesAndStability((Asic100aConfigV1)arg1) → int
outputDriverInputCommonMode0((Asic100aConfigV1)arg1) → int
outputDriverInputCommonMode1((Asic100aConfigV1)arg1) → int
outputDriverInputCommonMode2((Asic100aConfigV1)arg1) → int
outputDriverInputCommonMode3((Asic100aConfigV1)arg1) → int
outputDriverOutputDynamicRange0((Asic100aConfigV1)arg1) → int
outputDriverOutputDynamicRange1((Asic100aConfigV1)arg1) → int
outputDriverOutputDynamicRange2((Asic100aConfigV1)arg1) → int
outputDriverOutputDynamicRange3((Asic100aConfigV1)arg1) → int
outputDriverTemperatureCompensationEnable((Asic100aConfigV1)arg1) → int
outputDriverTemperatureCompensationGain0((Asic100aConfigV1)arg1) → int
outputDriverTemperatureCompensationGain1((Asic100aConfigV1)arg1) → int
outputDriverTemperatureCompensationGain2((Asic100aConfigV1)arg1) → int
outputDriverTemperatureCompensationGain3((Asic100aConfigV1)arg1) → int
pixelBufferAndPreamplifierDrivingCapabilities((Asic100aConfigV1)arg1) → int
pixelFilterLevel((Asic100aConfigV1)arg1) → int
pixelOutputBufferCurrent((Asic100aConfigV1)arg1) → int
preamplifierCurrent((Asic100aConfigV1)arg1) → int
programmableReadoutDelay((Asic100aConfigV1)arg1) → int
pulserCounterDirection((Asic100aConfigV1)arg1) → int
pulserReset((Asic100aConfigV1)arg1) → int
pulserSync((Asic100aConfigV1)arg1) → int
pulserVsPixelOnDelay((Asic100aConfigV1)arg1) → int
syncPinEnable((Asic100aConfigV1)arg1) → int
testBackEnd((Asic100aConfigV1)arg1) → int
testMode((Asic100aConfigV1)arg1) → int
testModeWithDarkFrame((Asic100aConfigV1)arg1) → int
testPointSystemInputCommonMode((Asic100aConfigV1)arg1) → int
testPointSystemOutputDynamicRange((Asic100aConfigV1)arg1) → int
testPointSystemTemperatureCompensationEnable((Asic100aConfigV1)arg1) → int
testPointSystemTemperatureCompensationGain((Asic100aConfigV1)arg1) → int
testPointSytemInputSelect((Asic100aConfigV1)arg1) → int
testPulserCurrent((Asic100aConfigV1)arg1) → int
testPulserLevel((Asic100aConfigV1)arg1) → int

Class psana.Epix.Asic10kConfigV1

class psana.Epix.Asic10kConfigV1

Raises an exception This class cannot be instantiated from Python

ColStartAddr((Asic10kConfigV1)arg1) → int
ColStopAddr((Asic10kConfigV1)arg1) → int
CompEnOn((Asic10kConfigV1)arg1) → int
CompEn_0((Asic10kConfigV1)arg1) → int
CompEn_1((Asic10kConfigV1)arg1) → int
CompEn_2((Asic10kConfigV1)arg1) → int
CompTH_DAC((Asic10kConfigV1)arg1) → int
DelCckReg((Asic10kConfigV1)arg1) → int
DelExec((Asic10kConfigV1)arg1) → int
Dm1En((Asic10kConfigV1)arg1) → int
Dm2En((Asic10kConfigV1)arg1) → int
FELmode((Asic10kConfigV1)arg1) → int
FastppEnable((Asic10kConfigV1)arg1) → int
FilterDac((Asic10kConfigV1)arg1) → int
IsEn((Asic10kConfigV1)arg1) → int
Monost((Asic10kConfigV1)arg1) → int
Ocb((Asic10kConfigV1)arg1) → int
PixelCb((Asic10kConfigV1)arg1) → int
PpOcbS2d((Asic10kConfigV1)arg1) → int
Preamp((Asic10kConfigV1)arg1) → int
PulserSync((Asic10kConfigV1)arg1) → int
RO_rst_en((Asic10kConfigV1)arg1) → int
RoMonost((Asic10kConfigV1)arg1) → int
RowStartAddr((Asic10kConfigV1)arg1) → int
RowStopAddr((Asic10kConfigV1)arg1) → int
S2d((Asic10kConfigV1)arg1) → int
S2dDac((Asic10kConfigV1)arg1) → int
S2dDacBias((Asic10kConfigV1)arg1) → int
S2dGr((Asic10kConfigV1)arg1) → int
S2dTComp((Asic10kConfigV1)arg1) → int
S2dTcDac((Asic10kConfigV1)arg1) → int
TC((Asic10kConfigV1)arg1) → int
TestBe((Asic10kConfigV1)arg1) → int
TpsDac((Asic10kConfigV1)arg1) → int
TpsGr((Asic10kConfigV1)arg1) → int
TpsMux((Asic10kConfigV1)arg1) → int
TpsTComp((Asic10kConfigV1)arg1) → int
TpsTcDac((Asic10kConfigV1)arg1) → int
VRefDac((Asic10kConfigV1)arg1) → int
Vld1_b((Asic10kConfigV1)arg1) → int
atest((Asic10kConfigV1)arg1) → int
chipID((Asic10kConfigV1)arg1) → int
digMon1((Asic10kConfigV1)arg1) → int
digMon2((Asic10kConfigV1)arg1) → int
dummyG((Asic10kConfigV1)arg1) → int
dummyGA((Asic10kConfigV1)arg1) → int
dummyMask((Asic10kConfigV1)arg1) → int
dummyTest((Asic10kConfigV1)arg1) → int
dummyUpper12bits((Asic10kConfigV1)arg1) → int
emph_bc((Asic10kConfigV1)arg1) → int
emph_bd((Asic10kConfigV1)arg1) → int
hrTest((Asic10kConfigV1)arg1) → int
monostPulser((Asic10kConfigV1)arg1) → int
pbit((Asic10kConfigV1)arg1) → int
pulser((Asic10kConfigV1)arg1) → int
pulserDac((Asic10kConfigV1)arg1) → int
pulserR((Asic10kConfigV1)arg1) → int
sabTest((Asic10kConfigV1)arg1) → int
slvdSBit((Asic10kConfigV1)arg1) → int
test((Asic10kConfigV1)arg1) → int
testVDTransmitter((Asic10kConfigV1)arg1) → int
vrefLow((Asic10kConfigV1)arg1) → int

Class psana.Epix.AsicConfigV1

class psana.Epix.AsicConfigV1

Raises an exception This class cannot be instantiated from Python

ColStartAddr((AsicConfigV1)arg1) → int
ColStopAddr((AsicConfigV1)arg1) → int
DelCckReg((AsicConfigV1)arg1) → int
DelExec((AsicConfigV1)arg1) → int
Dm1En((AsicConfigV1)arg1) → int
Dm2En((AsicConfigV1)arg1) → int
FastppEnable((AsicConfigV1)arg1) → int
FilterDac((AsicConfigV1)arg1) → int
IsEn((AsicConfigV1)arg1) → int
Monost((AsicConfigV1)arg1) → int
Ocb((AsicConfigV1)arg1) → int
PixelCb((AsicConfigV1)arg1) → int
PpOcbS2d((AsicConfigV1)arg1) → int
Preamp((AsicConfigV1)arg1) → int
RoMonost((AsicConfigV1)arg1) → int
RowStartAddr((AsicConfigV1)arg1) → int
RowStopAddr((AsicConfigV1)arg1) → int
S2d((AsicConfigV1)arg1) → int
S2dDac((AsicConfigV1)arg1) → int
S2dDacBias((AsicConfigV1)arg1) → int
S2dGr((AsicConfigV1)arg1) → int
S2dTComp((AsicConfigV1)arg1) → int
S2dTcDac((AsicConfigV1)arg1) → int
TC((AsicConfigV1)arg1) → int
TestBe((AsicConfigV1)arg1) → int
TpsDac((AsicConfigV1)arg1) → int
TpsGr((AsicConfigV1)arg1) → int
TpsMux((AsicConfigV1)arg1) → int
TpsTComp((AsicConfigV1)arg1) → int
TpsTcDac((AsicConfigV1)arg1) → int
VRefDac((AsicConfigV1)arg1) → int
atest((AsicConfigV1)arg1) → int
chipID((AsicConfigV1)arg1) → int
digMon1((AsicConfigV1)arg1) → int
digMon2((AsicConfigV1)arg1) → int
dummyMask((AsicConfigV1)arg1) → int
dummyTest((AsicConfigV1)arg1) → int
hrTest((AsicConfigV1)arg1) → int
monostPulser((AsicConfigV1)arg1) → int
pbit((AsicConfigV1)arg1) → int
pulser((AsicConfigV1)arg1) → int
pulserDac((AsicConfigV1)arg1) → int
sabTest((AsicConfigV1)arg1) → int
slvdSBit((AsicConfigV1)arg1) → int
test((AsicConfigV1)arg1) → int

Class psana.Epix.Config100aV1

class psana.Epix.Config100aV1

Raises an exception This class cannot be instantiated from Python

R0Mode((Config100aV1)arg1) → int
SyncDelay((Config100aV1)arg1) → int
SyncMode((Config100aV1)arg1) → int
SyncWidth((Config100aV1)arg1) → int
acqToAsicR0Delay((Config100aV1)arg1) → int
adcClkHalfT((Config100aV1)arg1) → int
adcPipelineDelay((Config100aV1)arg1) → int
adcReadsPerPixel((Config100aV1)arg1) → int
adcStreamMode((Config100aV1)arg1) → int
analogCardId0((Config100aV1)arg1) → int
analogCardId1((Config100aV1)arg1) → int
asicAcq((Config100aV1)arg1) → int
asicAcqControl((Config100aV1)arg1) → int
asicAcqLToPPmatL((Config100aV1)arg1) → int
asicAcqWidth((Config100aV1)arg1) → int
asicGR((Config100aV1)arg1) → int
asicGRControl((Config100aV1)arg1) → int
asicMask((Config100aV1)arg1) → int
asicPPmatToReadout((Config100aV1)arg1) → int
asicPixelConfigArray((Config100aV1)arg1) → numpy.ndarray
asicPpbe((Config100aV1)arg1) → int
asicPpbeControl((Config100aV1)arg1) → int
asicPpmat((Config100aV1)arg1) → int
asicPpmatControl((Config100aV1)arg1) → int
asicR0((Config100aV1)arg1) → int
asicR0ClkControl((Config100aV1)arg1) → int
asicR0Control((Config100aV1)arg1) → int
asicR0ToAsicAcq((Config100aV1)arg1) → int
asicR0Width((Config100aV1)arg1) → int
asicRoClk((Config100aV1)arg1) → int
asicRoClkHalfT((Config100aV1)arg1) → int
asics((Config100aV1)arg1, (int)arg2) → Asic100aConfigV1
asics_shape((Config100aV1)arg1) → object
baseClockFrequency((Config100aV1)arg1) → int
calibPixelConfigArray((Config100aV1)arg1) → numpy.ndarray :

Calibration row config map is one row for every two calib rows

calibrationRowCountPerASIC((Config100aV1)arg1) → int :

for epix100a 96*4 = 384

dacSetting((Config100aV1)arg1) → int
daqTrigDelay((Config100aV1)arg1) → int
digitalCardId0((Config100aV1)arg1) → int
digitalCardId1((Config100aV1)arg1) → int
environmentalRowCountPerASIC((Config100aV1)arg1) → int
numberOfAsics((Config100aV1)arg1) → int :

Number of columns in a readout unit

numberOfAsicsPerColumn((Config100aV1)arg1) → int
numberOfAsicsPerRow((Config100aV1)arg1) → int
numberOfCalibrationRows((Config100aV1)arg1) → int :

Number of calibration rows in a readout unit

numberOfColumns((Config100aV1)arg1) → int :

Number of pixel columns in a readout unit

numberOfEnvironmentalRows((Config100aV1)arg1) → int :

Number of rows in a readout unit

numberOfPixelsPerAsicRow((Config100aV1)arg1) → int :

for epix100a 352

numberOfReadableRows((Config100aV1)arg1) → int :

Number of readable pixel rows in a readout unit

numberOfReadableRowsPerAsic((Config100aV1)arg1) → int
numberOfRows((Config100aV1)arg1) → int :

Number of pixel rows in a readout unit

numberOfRowsPerAsic((Config100aV1)arg1) → int
prepulseR0Delay((Config100aV1)arg1) → int
prepulseR0En((Config100aV1)arg1) → int
prepulseR0Width((Config100aV1)arg1) → int
runTrigDelay((Config100aV1)arg1) → int
scopeADCThreshold((Config100aV1)arg1) → int
scopeADCsameplesToSkip((Config100aV1)arg1) → int
scopeArmMode((Config100aV1)arg1) → int
scopeChanAwaveformSelect((Config100aV1)arg1) → int
scopeChanBwaveformSelect((Config100aV1)arg1) → int
scopeEnable((Config100aV1)arg1) → int
scopeTraceLength((Config100aV1)arg1) → int
scopeTrigChan((Config100aV1)arg1) → int
scopeTrigEdge((Config100aV1)arg1) → int
scopeTrigHoldoff((Config100aV1)arg1) → int
scopeTrigOffset((Config100aV1)arg1) → int
testPatternEnable((Config100aV1)arg1) → int
version((Config100aV1)arg1) → int
TypeId = 84
Version = 1

Class psana.Epix.Config100aV2

class psana.Epix.Config100aV2

Raises an exception This class cannot be instantiated from Python

R0Mode((Config100aV2)arg1) → int
SyncDelay((Config100aV2)arg1) → int
SyncMode((Config100aV2)arg1) → int
SyncWidth((Config100aV2)arg1) → int
acqToAsicR0Delay((Config100aV2)arg1) → int
adcClkHalfT((Config100aV2)arg1) → int
adcPipelineDelay((Config100aV2)arg1) → int
adcPipelineDelay0((Config100aV2)arg1) → int
adcPipelineDelay1((Config100aV2)arg1) → int
adcPipelineDelay2((Config100aV2)arg1) → int
adcPipelineDelay3((Config100aV2)arg1) → int
adcReadsPerPixel((Config100aV2)arg1) → int
adcStreamMode((Config100aV2)arg1) → int
analogCardId0((Config100aV2)arg1) → int
analogCardId1((Config100aV2)arg1) → int
asicAcq((Config100aV2)arg1) → int
asicAcqControl((Config100aV2)arg1) → int
asicAcqLToPPmatL((Config100aV2)arg1) → int
asicAcqWidth((Config100aV2)arg1) → int
asicGR((Config100aV2)arg1) → int
asicGRControl((Config100aV2)arg1) → int
asicMask((Config100aV2)arg1) → int
asicPPmatToReadout((Config100aV2)arg1) → int
asicPixelConfigArray((Config100aV2)arg1) → numpy.ndarray
asicPpbe((Config100aV2)arg1) → int
asicPpbeControl((Config100aV2)arg1) → int
asicPpmat((Config100aV2)arg1) → int
asicPpmatControl((Config100aV2)arg1) → int
asicR0((Config100aV2)arg1) → int
asicR0ClkControl((Config100aV2)arg1) → int
asicR0Control((Config100aV2)arg1) → int
asicR0ToAsicAcq((Config100aV2)arg1) → int
asicR0Width((Config100aV2)arg1) → int
asicRoClk((Config100aV2)arg1) → int
asicRoClkHalfT((Config100aV2)arg1) → int
asics((Config100aV2)arg1, (int)arg2) → Asic100aConfigV1
asics_shape((Config100aV2)arg1) → object
baseClockFrequency((Config100aV2)arg1) → int
calibPixelConfigArray((Config100aV2)arg1) → numpy.ndarray :

Calibration row config map is one row for every two calib rows

calibrationRowCountPerASIC((Config100aV2)arg1) → int :

for epix100a 96*4 = 384

carrierId0((Config100aV2)arg1) → int
carrierId1((Config100aV2)arg1) → int
dacSetting((Config100aV2)arg1) → int
digitalCardId0((Config100aV2)arg1) → int
digitalCardId1((Config100aV2)arg1) → int
enableAutomaticRunTrigger((Config100aV2)arg1) → int
environmentalRowCountPerASIC((Config100aV2)arg1) → int
epixRunTrigDelay((Config100aV2)arg1) → int
evrDaqCode((Config100aV2)arg1) → int
evrRunCode((Config100aV2)arg1) → int
evrRunTrigDelay((Config100aV2)arg1) → int
numberOf125MhzTicksPerRunTrigger((Config100aV2)arg1) → int
numberOfAsics((Config100aV2)arg1) → int :

Number of columns in a readout unit

numberOfAsicsPerColumn((Config100aV2)arg1) → int
numberOfAsicsPerRow((Config100aV2)arg1) → int
numberOfCalibrationRows((Config100aV2)arg1) → int :

Number of calibration rows in a readout unit

numberOfColumns((Config100aV2)arg1) → int :

Number of pixel columns in a readout unit

numberOfEnvironmentalRows((Config100aV2)arg1) → int :

Number of rows in a readout unit

numberOfPixelsPerAsicRow((Config100aV2)arg1) → int :

for epix100a 352

numberOfReadableRows((Config100aV2)arg1) → int :

Number of readable pixel rows in a readout unit

numberOfReadableRowsPerAsic((Config100aV2)arg1) → int
numberOfRows((Config100aV2)arg1) → int :

Number of pixel rows in a readout unit

numberOfRowsPerAsic((Config100aV2)arg1) → int
prepulseR0Delay((Config100aV2)arg1) → int
prepulseR0En((Config100aV2)arg1) → int
prepulseR0Width((Config100aV2)arg1) → int
scopeADCThreshold((Config100aV2)arg1) → int
scopeADCsameplesToSkip((Config100aV2)arg1) → int
scopeArmMode((Config100aV2)arg1) → int
scopeChanAwaveformSelect((Config100aV2)arg1) → int
scopeChanBwaveformSelect((Config100aV2)arg1) → int
scopeEnable((Config100aV2)arg1) → int
scopeTraceLength((Config100aV2)arg1) → int
scopeTrigChan((Config100aV2)arg1) → int
scopeTrigEdge((Config100aV2)arg1) → int
scopeTrigHoldoff((Config100aV2)arg1) → int
scopeTrigOffset((Config100aV2)arg1) → int
testPatternEnable((Config100aV2)arg1) → int
usePgpEvr((Config100aV2)arg1) → int
version((Config100aV2)arg1) → int
TypeId = 84
Version = 2

Class psana.Epix.Config10KV1

class psana.Epix.Config10KV1

Raises an exception This class cannot be instantiated from Python

DoutPipelineDelay((Config10KV1)arg1) → int :

new

R0Mode((Config10KV1)arg1) → int :

new

SyncDelay((Config10KV1)arg1) → int :

new

SyncMode((Config10KV1)arg1) → int :

new

SyncWidth((Config10KV1)arg1) → int :

new

acqToAsicR0Delay((Config10KV1)arg1) → int
adcClkHalfT((Config10KV1)arg1) → int
adcPipelineDelay((Config10KV1)arg1) → int
adcReadsPerPixel((Config10KV1)arg1) → int
adcStreamMode((Config10KV1)arg1) → int
analogCardId0((Config10KV1)arg1) → int
analogCardId1((Config10KV1)arg1) → int
asicAcq((Config10KV1)arg1) → int
asicAcqControl((Config10KV1)arg1) → int
asicAcqLToPPmatL((Config10KV1)arg1) → int
asicAcqWidth((Config10KV1)arg1) → int
asicGR((Config10KV1)arg1) → int
asicGRControl((Config10KV1)arg1) → int
asicMask((Config10KV1)arg1) → int
asicPixelConfigArray((Config10KV1)arg1) → numpy.ndarray
asicPpbe((Config10KV1)arg1) → int
asicPpbeControl((Config10KV1)arg1) → int
asicPpmat((Config10KV1)arg1) → int
asicPpmatControl((Config10KV1)arg1) → int
asicR0((Config10KV1)arg1) → int
asicR0ClkControl((Config10KV1)arg1) → int
asicR0Control((Config10KV1)arg1) → int
asicR0ToAsicAcq((Config10KV1)arg1) → int
asicR0Width((Config10KV1)arg1) → int
asicRoClk((Config10KV1)arg1) → int
asicRoClkHalfT((Config10KV1)arg1) → int
asics((Config10KV1)arg1, (int)arg2) → Asic10kConfigV1
asics_shape((Config10KV1)arg1) → object
baseClockFrequency((Config10KV1)arg1) → int :

for epix10k 48*4

dacSetting((Config10KV1)arg1) → int
daqTrigDelay((Config10KV1)arg1) → int
digitalCardId0((Config10KV1)arg1) → int
digitalCardId1((Config10KV1)arg1) → int
lastRowExclusions((Config10KV1)arg1) → int
numberOfAsics((Config10KV1)arg1) → int :

Number of columns in a readout unit

numberOfAsicsPerColumn((Config10KV1)arg1) → int
numberOfAsicsPerRow((Config10KV1)arg1) → int
numberOfColumns((Config10KV1)arg1) → int :

Number of columns in a readout unit

numberOfPixelsPerAsicRow((Config10KV1)arg1) → int :

for epix10k 176

numberOfRows((Config10KV1)arg1) → int :

Number of rows in a readout unit

numberOfRowsPerAsic((Config10KV1)arg1) → int
prepulseR0Delay((Config10KV1)arg1) → int
prepulseR0En((Config10KV1)arg1) → int
prepulseR0Width((Config10KV1)arg1) → int
runTrigDelay((Config10KV1)arg1) → int
scopeADCThreshold((Config10KV1)arg1) → int
scopeADCsameplesToSkip((Config10KV1)arg1) → int
scopeArmMode((Config10KV1)arg1) → int
scopeChanAwaveformSelect((Config10KV1)arg1) → int
scopeChanBwaveformSelect((Config10KV1)arg1) → int
scopeEnable((Config10KV1)arg1) → int
scopeTraceLength((Config10KV1)arg1) → int
scopeTrigChan((Config10KV1)arg1) → int
scopeTrigEdge((Config10KV1)arg1) → int
scopeTrigHoldoff((Config10KV1)arg1) → int
scopeTrigOffset((Config10KV1)arg1) → int
testPatternEnable((Config10KV1)arg1) → int
version((Config10KV1)arg1) → int
TypeId = 83
Version = 1

Class psana.Epix.ConfigV1

class psana.Epix.ConfigV1

Raises an exception This class cannot be instantiated from Python

acqToAsicR0Delay((ConfigV1)arg1) → int
adcClkHalfT((ConfigV1)arg1) → int
adcPipelineDelay((ConfigV1)arg1) → int
adcReadsPerPixel((ConfigV1)arg1) → int
adcStreamMode((ConfigV1)arg1) → int
analogCardId0((ConfigV1)arg1) → int
analogCardId1((ConfigV1)arg1) → int
asicAcq((ConfigV1)arg1) → int
asicAcqControl((ConfigV1)arg1) → int
asicAcqLToPPmatL((ConfigV1)arg1) → int
asicAcqWidth((ConfigV1)arg1) → int
asicGR((ConfigV1)arg1) → int
asicGRControl((ConfigV1)arg1) → int
asicMask((ConfigV1)arg1) → int
asicPixelMaskArray((ConfigV1)arg1) → numpy.ndarray
asicPixelTestArray((ConfigV1)arg1) → numpy.ndarray
asicPpbe((ConfigV1)arg1) → int
asicPpbeControl((ConfigV1)arg1) → int
asicPpmat((ConfigV1)arg1) → int
asicPpmatControl((ConfigV1)arg1) → int
asicR0((ConfigV1)arg1) → int
asicR0ClkControl((ConfigV1)arg1) → int
asicR0Control((ConfigV1)arg1) → int
asicR0ToAsicAcq((ConfigV1)arg1) → int
asicR0Width((ConfigV1)arg1) → int
asicRoClk((ConfigV1)arg1) → int
asicRoClkHalfT((ConfigV1)arg1) → int
asics((ConfigV1)arg1, (int)arg2) → AsicConfigV1
asics_shape((ConfigV1)arg1) → object
baseClockFrequency((ConfigV1)arg1) → int :

for epix100 96*4

dacSetting((ConfigV1)arg1) → int
daqTrigDelay((ConfigV1)arg1) → int
digitalCardId0((ConfigV1)arg1) → int
digitalCardId1((ConfigV1)arg1) → int
lastRowExclusions((ConfigV1)arg1) → int
numberOfAsics((ConfigV1)arg1) → int :

Number of columns in a readout unit

numberOfAsicsPerColumn((ConfigV1)arg1) → int
numberOfAsicsPerRow((ConfigV1)arg1) → int
numberOfColumns((ConfigV1)arg1) → int :

Number of columns in a readout unit

numberOfPixelsPerAsicRow((ConfigV1)arg1) → int :

for epix100 352

numberOfRows((ConfigV1)arg1) → int :

Number of rows in a readout unit

numberOfRowsPerAsic((ConfigV1)arg1) → int :

generally 2 x 2

prepulseR0Delay((ConfigV1)arg1) → int
prepulseR0En((ConfigV1)arg1) → int
prepulseR0Width((ConfigV1)arg1) → int
runTrigDelay((ConfigV1)arg1) → int
testPatternEnable((ConfigV1)arg1) → int
version((ConfigV1)arg1) → int
TypeId = 74
Version = 1

Class psana.Epix.ElementV1

class psana.Epix.ElementV1

Raises an exception This class cannot be instantiated from Python

acqCount((ElementV1)arg1) → int
excludedRows((ElementV1)arg1) → numpy.ndarray
fiducials((ElementV1)arg1) → int
frame((ElementV1)arg1) → numpy.ndarray
frameNumber((ElementV1)arg1) → int
lane((ElementV1)arg1) → int
lastWord((ElementV1)arg1) → int
temperatures((ElementV1)arg1) → numpy.ndarray
ticks((ElementV1)arg1) → int
vc((ElementV1)arg1) → int
TypeId = 75
Version = 1

Class psana.Epix.ElementV2

class psana.Epix.ElementV2

Raises an exception This class cannot be instantiated from Python

acqCount((ElementV2)arg1) → int
calibrationRows((ElementV2)arg1) → numpy.ndarray
environmentalRows((ElementV2)arg1) → numpy.ndarray
fiducials((ElementV2)arg1) → int
frame((ElementV2)arg1) → numpy.ndarray
frameNumber((ElementV2)arg1) → int
lane((ElementV2)arg1) → int
lastWord((ElementV2)arg1) → int
temperatures((ElementV2)arg1) → numpy.ndarray
ticks((ElementV2)arg1) → int
vc((ElementV2)arg1) → int
TypeId = 75
Version = 2

Class psana.Epix.ElementV3

class psana.Epix.ElementV3

Raises an exception This class cannot be instantiated from Python

acqCount((ElementV3)arg1) → int
calibrationRows((ElementV3)arg1) → numpy.ndarray
environmentalRows((ElementV3)arg1) → numpy.ndarray
fiducials((ElementV3)arg1) → int
frame((ElementV3)arg1) → numpy.ndarray
frameNumber((ElementV3)arg1) → int
lane((ElementV3)arg1) → int
lastWord((ElementV3)arg1) → int
temperatures((ElementV3)arg1) → numpy.ndarray
ticks((ElementV3)arg1) → int
vc((ElementV3)arg1) → int
TypeId = 75
Version = 3

Module psana.EpixSampler

The Python wrapper module for EpixSampler types

Class psana.EpixSampler.ConfigV1

class psana.EpixSampler.ConfigV1

Raises an exception This class cannot be instantiated from Python

adcClkHalfT((ConfigV1)arg1) → int
adcPipelineDelay((ConfigV1)arg1) → int
analogCardId0((ConfigV1)arg1) → int
analogCardId1((ConfigV1)arg1) → int
baseClockFrequency((ConfigV1)arg1) → int
daqSetting((ConfigV1)arg1) → int
daqTrigDelay((ConfigV1)arg1) → int
digitalCardId0((ConfigV1)arg1) → int
digitalCardId1((ConfigV1)arg1) → int
numberOfChannels((ConfigV1)arg1) → int
runTrigDelay((ConfigV1)arg1) → int
sampleInterval_sec((ConfigV1)arg1) → float
samplesPerChannel((ConfigV1)arg1) → int
testPatternEnable((ConfigV1)arg1) → int
version((ConfigV1)arg1) → int
TypeId = 76
Version = 1

Class psana.EpixSampler.ElementV1

class psana.EpixSampler.ElementV1

Raises an exception This class cannot be instantiated from Python

acqCount((ElementV1)arg1) → int
fiducials((ElementV1)arg1) → int
frame((ElementV1)arg1) → numpy.ndarray
frameNumber((ElementV1)arg1) → int
lane((ElementV1)arg1) → int
lastWord((ElementV1)arg1) → int
temperatures((ElementV1)arg1) → numpy.ndarray
ticks((ElementV1)arg1) → int
vc((ElementV1)arg1) → int
TypeId = 77
Version = 1

Module psana.EvrData

The Python wrapper module for EvrData types

Class psana.EvrData.ConfigV1

class psana.EvrData.ConfigV1

Raises an exception This class cannot be instantiated from Python

noutputs((ConfigV1)arg1) → int
npulses((ConfigV1)arg1) → int
output_maps((ConfigV1)arg1) → list
pulses((ConfigV1)arg1) → list
TypeId = 8
Version = 1

Class psana.EvrData.ConfigV2

class psana.EvrData.ConfigV2

Raises an exception This class cannot be instantiated from Python

class BeamCode
Off = psana.EvrData.BeamCode.Off
On = psana.EvrData.BeamCode.On
names = {'On': psana.EvrData.BeamCode.On, 'Off': psana.EvrData.BeamCode.Off}
values = {0: psana.EvrData.BeamCode.Off, 1: psana.EvrData.BeamCode.On}
class ConfigV2.RateCode
NumberOfRates = psana.EvrData.RateCode.NumberOfRates
Single = psana.EvrData.RateCode.Single
names = {'r30Hz': psana.EvrData.RateCode.r30Hz, 'r0_5Hz': psana.EvrData.RateCode.r0_5Hz, 'NumberOfRates': psana.EvrData.RateCode.NumberOfRates, 'r120Hz': psana.EvrData.RateCode.r120Hz, 'r10Hz': psana.EvrData.RateCode.r10Hz, 'r60Hz': psana.EvrData.RateCode.r60Hz, 'Single': psana.EvrData.RateCode.Single, 'r1Hz': psana.EvrData.RateCode.r1Hz, 'r5Hz': psana.EvrData.RateCode.r5Hz}
r0_5Hz = psana.EvrData.RateCode.r0_5Hz
r10Hz = psana.EvrData.RateCode.r10Hz
r120Hz = psana.EvrData.RateCode.r120Hz
r1Hz = psana.EvrData.RateCode.r1Hz
r30Hz = psana.EvrData.RateCode.r30Hz
r5Hz = psana.EvrData.RateCode.r5Hz
r60Hz = psana.EvrData.RateCode.r60Hz
values = {0: psana.EvrData.RateCode.r120Hz, 1: psana.EvrData.RateCode.r60Hz, 2: psana.EvrData.RateCode.r30Hz, 3: psana.EvrData.RateCode.r10Hz, 4: psana.EvrData.RateCode.r5Hz, 5: psana.EvrData.RateCode.r1Hz, 6: psana.EvrData.RateCode.r0_5Hz, 7: psana.EvrData.RateCode.Single, 8: psana.EvrData.RateCode.NumberOfRates}
ConfigV2.beam((ConfigV2)arg1) → BeamCode
ConfigV2.noutputs((ConfigV2)arg1) → int
ConfigV2.npulses((ConfigV2)arg1) → int
ConfigV2.opcode((ConfigV2)arg1) → int
ConfigV2.output_maps((ConfigV2)arg1) → list
ConfigV2.pulses((ConfigV2)arg1) → list
ConfigV2.rate((ConfigV2)arg1) → RateCode
ConfigV2.TypeId = 8
ConfigV2.Version = 2
ConfigV2.baseRate = 40
ConfigV2.beamOn = 100
ConfigV2.singleShot = 150

Class psana.EvrData.ConfigV3

class psana.EvrData.ConfigV3

Raises an exception This class cannot be instantiated from Python

eventcodes((ConfigV3)arg1) → list
neventcodes((ConfigV3)arg1) → int
noutputs((ConfigV3)arg1) → int
npulses((ConfigV3)arg1) → int
output_maps((ConfigV3)arg1) → list
pulses((ConfigV3)arg1) → list
TypeId = 8
Version = 3

Class psana.EvrData.ConfigV4

class psana.EvrData.ConfigV4

Raises an exception This class cannot be instantiated from Python

eventcodes((ConfigV4)arg1) → list
neventcodes((ConfigV4)arg1) → int
noutputs((ConfigV4)arg1) → int
npulses((ConfigV4)arg1) → int
output_maps((ConfigV4)arg1) → list
pulses((ConfigV4)arg1) → list
TypeId = 8
Version = 4

Class psana.EvrData.ConfigV5

class psana.EvrData.ConfigV5

Raises an exception This class cannot be instantiated from Python

eventcodes((ConfigV5)arg1) → list
neventcodes((ConfigV5)arg1) → int
noutputs((ConfigV5)arg1) → int
npulses((ConfigV5)arg1) → int
output_maps((ConfigV5)arg1) → list
pulses((ConfigV5)arg1) → list
seq_config((ConfigV5)arg1) → SequencerConfigV1
EvrOutputs = 10
MaxPulses = 32
TypeId = 8
Version = 5

Class psana.EvrData.ConfigV6

class psana.EvrData.ConfigV6

Raises an exception This class cannot be instantiated from Python

eventcodes((ConfigV6)arg1) → list
neventcodes((ConfigV6)arg1) → int
noutputs((ConfigV6)arg1) → int
npulses((ConfigV6)arg1) → int
output_maps((ConfigV6)arg1) → list
pulses((ConfigV6)arg1) → list
seq_config((ConfigV6)arg1) → SequencerConfigV1
MaxOutputs = 256
MaxPulses = 256
TypeId = 8
Version = 6

Class psana.EvrData.ConfigV7

class psana.EvrData.ConfigV7

Raises an exception This class cannot be instantiated from Python

eventcodes((ConfigV7)arg1) → list
neventcodes((ConfigV7)arg1) → int
noutputs((ConfigV7)arg1) → int
npulses((ConfigV7)arg1) → int
output_maps((ConfigV7)arg1) → list
pulses((ConfigV7)arg1) → list
seq_config((ConfigV7)arg1) → SequencerConfigV1
MaxOutputs = 256
MaxPulses = 256
TypeId = 8
Version = 7

Class psana.EvrData.DataV3

class psana.EvrData.DataV3

Raises an exception This class cannot be instantiated from Python

fifoEvents((DataV3)arg1) → list :

FIFOEvent list

numFifoEvents((DataV3)arg1) → int :

length of FIFOEvent list

TypeId = 19
Version = 3

Class psana.EvrData.DataV4

class psana.EvrData.DataV4

Raises an exception This class cannot be instantiated from Python

fifoEvents((DataV4)arg1) → list :

FIFOEvent list

numFifoEvents((DataV4)arg1) → int :

length of FIFOEvent list

present((DataV4)arg1, (int)arg2) → int :

Returns 1 if the opcode is present in the EVR FIFO, otherwise 0.

TypeId = 19
Version = 4

Class psana.EvrData.EventCodeV3

class psana.EvrData.EventCodeV3

Raises an exception This class cannot be instantiated from Python

code((EventCodeV3)arg1) → int
isReadout((EventCodeV3)arg1) → int
isTerminator((EventCodeV3)arg1) → int
maskClear((EventCodeV3)arg1) → int
maskSet((EventCodeV3)arg1) → int
maskTrigger((EventCodeV3)arg1) → int

Class psana.EvrData.EventCodeV4

class psana.EvrData.EventCodeV4

Raises an exception This class cannot be instantiated from Python

code((EventCodeV4)arg1) → int
isReadout((EventCodeV4)arg1) → int
isTerminator((EventCodeV4)arg1) → int
maskClear((EventCodeV4)arg1) → int
maskSet((EventCodeV4)arg1) → int
maskTrigger((EventCodeV4)arg1) → int
reportDelay((EventCodeV4)arg1) → int
reportWidth((EventCodeV4)arg1) → int

Class psana.EvrData.EventCodeV5

class psana.EvrData.EventCodeV5

Raises an exception This class cannot be instantiated from Python

code((EventCodeV5)arg1) → int
desc((EventCodeV5)arg1) → str
desc_shape((EventCodeV5)arg1) → object
isCommand((EventCodeV5)arg1) → int
isLatch((EventCodeV5)arg1) → int
isReadout((EventCodeV5)arg1) → int
maskClear((EventCodeV5)arg1) → int
maskSet((EventCodeV5)arg1) → int
maskTrigger((EventCodeV5)arg1) → int
releaseCode((EventCodeV5)arg1) → int
reportDelay((EventCodeV5)arg1) → int
reportWidth((EventCodeV5)arg1) → int
DescSize = 16

Class psana.EvrData.EventCodeV6

class psana.EvrData.EventCodeV6

Raises an exception This class cannot be instantiated from Python

code((EventCodeV6)arg1) → int
desc((EventCodeV6)arg1) → str
desc_shape((EventCodeV6)arg1) → object
isCommand((EventCodeV6)arg1) → int
isLatch((EventCodeV6)arg1) → int
isReadout((EventCodeV6)arg1) → int
maskClear((EventCodeV6)arg1) → int
maskSet((EventCodeV6)arg1) → int
maskTrigger((EventCodeV6)arg1) → int
readoutGroup((EventCodeV6)arg1) → int
releaseCode((EventCodeV6)arg1) → int
reportDelay((EventCodeV6)arg1) → int
reportWidth((EventCodeV6)arg1) → int
DescSize = 16
MaxReadoutGroup = 7

Class psana.EvrData.FIFOEvent

class psana.EvrData.FIFOEvent

Raises an exception This class cannot be instantiated from Python

eventCode((FIFOEvent)arg1) → int :

event code (range 0-255)

timestampHigh((FIFOEvent)arg1) → int :

119 MHz timestamp (fiducial)

timestampLow((FIFOEvent)arg1) → int :

360 Hz timestamp

Class psana.EvrData.IOChannel

class psana.EvrData.IOChannel

Raises an exception This class cannot be instantiated from Python

infos((IOChannel)arg1) → list
name((IOChannel)arg1) → str
name_shape((IOChannel)arg1) → object
ninfo((IOChannel)arg1) → int
MaxInfos = 8
NameLength = 12

Class psana.EvrData.IOChannelV2

class psana.EvrData.IOChannelV2

Raises an exception This class cannot be instantiated from Python

infos((IOChannelV2)arg1) → list :

List of Detectors connected

name((IOChannelV2)arg1) → str :

Name of channel

name_shape((IOChannelV2)arg1) → object
ninfo((IOChannelV2)arg1) → int :

Number of Detectors connected

output((IOChannelV2)arg1) → OutputMapV2 :

Output connector

MaxInfos = 16
NameLength = 64

Class psana.EvrData.IOConfigV1

class psana.EvrData.IOConfigV1

Raises an exception This class cannot be instantiated from Python

channels((IOConfigV1)arg1) → list
conn((IOConfigV1)arg1) → Conn
nchannels((IOConfigV1)arg1) → int
TypeId = 26
Version = 1

Class psana.EvrData.IOConfigV2

class psana.EvrData.IOConfigV2

Raises an exception This class cannot be instantiated from Python

channels((IOConfigV2)arg1) → list :

List of Configured output channels

nchannels((IOConfigV2)arg1) → int :

Number of Configured output channels

TypeId = 26
Version = 2

Class psana.EvrData.OutputMap

class psana.EvrData.OutputMap

Raises an exception This class cannot be instantiated from Python

class Conn
FrontPanel = psana.EvrData.Conn.FrontPanel
UnivIO = psana.EvrData.Conn.UnivIO
names = {'UnivIO': psana.EvrData.Conn.UnivIO, 'FrontPanel': psana.EvrData.Conn.FrontPanel}
values = {0: psana.EvrData.Conn.FrontPanel, 1: psana.EvrData.Conn.UnivIO}
class OutputMap.Source
DBus = psana.EvrData.Source.DBus
Force_High = psana.EvrData.Source.Force_High
Force_Low = psana.EvrData.Source.Force_Low
Prescaler = psana.EvrData.Source.Prescaler
Pulse = psana.EvrData.Source.Pulse
names = {'Force_Low': psana.EvrData.Source.Force_Low, 'DBus': psana.EvrData.Source.DBus, 'Force_High': psana.EvrData.Source.Force_High, 'Prescaler': psana.EvrData.Source.Prescaler, 'Pulse': psana.EvrData.Source.Pulse}
values = {0: psana.EvrData.Source.Pulse, 1: psana.EvrData.Source.DBus, 2: psana.EvrData.Source.Prescaler, 3: psana.EvrData.Source.Force_High, 4: psana.EvrData.Source.Force_Low}
OutputMap.conn((OutputMap)arg1) → Conn
OutputMap.conn_id((OutputMap)arg1) → int
OutputMap.map((OutputMap)arg1) → int :

Returns encoded source value.

OutputMap.source((OutputMap)arg1) → Source
OutputMap.source_id((OutputMap)arg1) → int
OutputMap.value((OutputMap)arg1) → int

Class psana.EvrData.OutputMapV2

class psana.EvrData.OutputMapV2

Raises an exception This class cannot be instantiated from Python

class Conn
FrontPanel = psana.EvrData.Conn.FrontPanel
UnivIO = psana.EvrData.Conn.UnivIO
names = {'UnivIO': psana.EvrData.Conn.UnivIO, 'FrontPanel': psana.EvrData.Conn.FrontPanel}
values = {0: psana.EvrData.Conn.FrontPanel, 1: psana.EvrData.Conn.UnivIO}
class OutputMapV2.Source
DBus = psana.EvrData.Source.DBus
Force_High = psana.EvrData.Source.Force_High
Force_Low = psana.EvrData.Source.Force_Low
Prescaler = psana.EvrData.Source.Prescaler
Pulse = psana.EvrData.Source.Pulse
names = {'Force_Low': psana.EvrData.Source.Force_Low, 'DBus': psana.EvrData.Source.DBus, 'Force_High': psana.EvrData.Source.Force_High, 'Prescaler': psana.EvrData.Source.Prescaler, 'Pulse': psana.EvrData.Source.Pulse}
values = {0: psana.EvrData.Source.Pulse, 1: psana.EvrData.Source.DBus, 2: psana.EvrData.Source.Prescaler, 3: psana.EvrData.Source.Force_High, 4: psana.EvrData.Source.Force_Low}
OutputMapV2.conn((OutputMapV2)arg1) → Conn
OutputMapV2.conn_id((OutputMapV2)arg1) → int
OutputMapV2.map((OutputMapV2)arg1) → int :

Returns encoded source value.

OutputMapV2.module((OutputMapV2)arg1) → int
OutputMapV2.source((OutputMapV2)arg1) → Source
OutputMapV2.source_id((OutputMapV2)arg1) → int
OutputMapV2.value((OutputMapV2)arg1) → int

Class psana.EvrData.PulseConfig

class psana.EvrData.PulseConfig

Raises an exception This class cannot be instantiated from Python

_input_control_value((PulseConfig)arg1) → int :

Pulse input control

_output_control_value((PulseConfig)arg1) → int :

Pulse output control

clear((PulseConfig)arg1) → int
delay((PulseConfig)arg1) → int :

delay in 119MHz clks

map_reset_enable((PulseConfig)arg1) → int
map_set_enable((PulseConfig)arg1) → int
map_trigger_enable((PulseConfig)arg1) → int
polarity((PulseConfig)arg1) → int
prescale((PulseConfig)arg1) → int :

pulse event prescale

pulse((PulseConfig)arg1) → int :

internal pulse generation channel

set((PulseConfig)arg1) → int
trigger((PulseConfig)arg1) → int
width((PulseConfig)arg1) → int :

width in 119MHz clks

Clear_Shift = 16
Map_Reset_Ena_Shift = 2
Map_Set_Ena_Shift = 1
Map_Trigger_Ena_Shift = 3
Polarity_Shift = 0
Set_Shift = 8
Trigger_Shift = 0

Class psana.EvrData.PulseConfigV3

class psana.EvrData.PulseConfigV3

Raises an exception This class cannot be instantiated from Python

delay((PulseConfigV3)arg1) → int :

Delay in 119MHz clks

polarity((PulseConfigV3)arg1) → int :

0 -> positive polarity , 1 -> negative polarity

prescale((PulseConfigV3)arg1) → int :

Clock divider

pulseId((PulseConfigV3)arg1) → int
width((PulseConfigV3)arg1) → int :

Width in 119MHz clks

Class psana.EvrData.SequencerConfigV1

class psana.EvrData.SequencerConfigV1

Raises an exception This class cannot be instantiated from Python

class Source
Disable = psana.EvrData.Source.Disable
names = {'r30Hz': psana.EvrData.Source.r30Hz, 'r0_5Hz': psana.EvrData.Source.r0_5Hz, 'r120Hz': psana.EvrData.Source.r120Hz, 'r10Hz': psana.EvrData.Source.r10Hz, 'r60Hz': psana.EvrData.Source.r60Hz, 'Disable': psana.EvrData.Source.Disable, 'r1Hz': psana.EvrData.Source.r1Hz, 'r5Hz': psana.EvrData.Source.r5Hz}
r0_5Hz = psana.EvrData.Source.r0_5Hz
r10Hz = psana.EvrData.Source.r10Hz
r120Hz = psana.EvrData.Source.r120Hz
r1Hz = psana.EvrData.Source.r1Hz
r30Hz = psana.EvrData.Source.r30Hz
r5Hz = psana.EvrData.Source.r5Hz
r60Hz = psana.EvrData.Source.r60Hz
values = {0: psana.EvrData.Source.r120Hz, 1: psana.EvrData.Source.r60Hz, 2: psana.EvrData.Source.r30Hz, 3: psana.EvrData.Source.r10Hz, 4: psana.EvrData.Source.r5Hz, 5: psana.EvrData.Source.r1Hz, 6: psana.EvrData.Source.r0_5Hz, 7: psana.EvrData.Source.Disable}
SequencerConfigV1.beam_source((SequencerConfigV1)arg1) → Source
SequencerConfigV1.cycles((SequencerConfigV1)arg1) → int
SequencerConfigV1.entries((SequencerConfigV1)arg1) → list
SequencerConfigV1.length((SequencerConfigV1)arg1) → int
SequencerConfigV1.sync_source((SequencerConfigV1)arg1) → Source

Class psana.EvrData.SequencerEntry

class psana.EvrData.SequencerEntry

Raises an exception This class cannot be instantiated from Python

delay((SequencerEntry)arg1) → int
eventcode((SequencerEntry)arg1) → int

Class psana.EvrData.SrcConfigV1

class psana.EvrData.SrcConfigV1

Describes configuration of self-contained event generator.

Raises an exception This class cannot be instantiated from Python

eventcodes((SrcConfigV1)arg1) → list
neventcodes((SrcConfigV1)arg1) → int
noutputs((SrcConfigV1)arg1) → int
npulses((SrcConfigV1)arg1) → int
output_maps((SrcConfigV1)arg1) → list
pulses((SrcConfigV1)arg1) → list
MaxOutputs = 12
MaxPulses = 12
TypeId = 78
Version = 1

Class psana.EvrData.SrcEventCode

class psana.EvrData.SrcEventCode

Describes configuration of self-contained event generator.

Raises an exception This class cannot be instantiated from Python

code((SrcEventCode)arg1) → int :

Assigned eventcode.

desc((SrcEventCode)arg1) → str :

Optional description.

desc_shape((SrcEventCode)arg1) → object
maskTriggerP((SrcEventCode)arg1) → int :

Bit mask of persistent pulse triggers.

maskTriggerR((SrcEventCode)arg1) → int :

Bit mask of running pulse triggers.

period((SrcEventCode)arg1) → int :

Repetition period in 119 MHz counts or 0 for external source.

readoutGroup((SrcEventCode)arg1) → int :

Assigned readout group.

DescSize = 16
MaxReadoutGroup = 7

Module psana.FCCD

The Python wrapper module for FCCD types

Class psana.FCCD.FccdConfigV1

class psana.FCCD.FccdConfigV1

Raises an exception This class cannot be instantiated from Python

class Depth
Sixteen_bit = psana.FCCD.Depth.Sixteen_bit
names = {'Sixteen_bit': psana.FCCD.Depth.Sixteen_bit}
values = {16: psana.FCCD.Depth.Sixteen_bit}
class FccdConfigV1.Output_Source
Output_FIFO = psana.FCCD.Output_Source.Output_FIFO
Output_Pattern4 = psana.FCCD.Output_Source.Output_Pattern4
names = {'Output_FIFO': psana.FCCD.Output_Source.Output_FIFO, 'Output_Pattern4': psana.FCCD.Output_Source.Output_Pattern4}
values = {0: psana.FCCD.Output_Source.Output_FIFO, 4: psana.FCCD.Output_Source.Output_Pattern4}
FccdConfigV1.height((FccdConfigV1)arg1) → int
FccdConfigV1.outputMode((FccdConfigV1)arg1) → int
FccdConfigV1.trimmedHeight((FccdConfigV1)arg1) → int
FccdConfigV1.trimmedWidth((FccdConfigV1)arg1) → int
FccdConfigV1.width((FccdConfigV1)arg1) → int
FccdConfigV1.Column_Pixels = 576
FccdConfigV1.Row_Pixels = 500
FccdConfigV1.Trimmed_Column_Pixels = 480
FccdConfigV1.Trimmed_Row_Pixels = 480
FccdConfigV1.TypeId = 21
FccdConfigV1.Version = 1

Class psana.FCCD.FccdConfigV2

class psana.FCCD.FccdConfigV2

Raises an exception This class cannot be instantiated from Python

class Depth
Eight_bit = psana.FCCD.Depth.Eight_bit
Sixteen_bit = psana.FCCD.Depth.Sixteen_bit
names = {'Eight_bit': psana.FCCD.Depth.Eight_bit, 'Sixteen_bit': psana.FCCD.Depth.Sixteen_bit}
values = {8: psana.FCCD.Depth.Eight_bit, 16: psana.FCCD.Depth.Sixteen_bit}
class FccdConfigV2.Output_Source
Output_FIFO = psana.FCCD.Output_Source.Output_FIFO
Test_Pattern1 = psana.FCCD.Output_Source.Test_Pattern1
Test_Pattern2 = psana.FCCD.Output_Source.Test_Pattern2
Test_Pattern3 = psana.FCCD.Output_Source.Test_Pattern3
Test_Pattern4 = psana.FCCD.Output_Source.Test_Pattern4
names = {'Test_Pattern3': psana.FCCD.Output_Source.Test_Pattern3, 'Test_Pattern1': psana.FCCD.Output_Source.Test_Pattern1, 'Test_Pattern2': psana.FCCD.Output_Source.Test_Pattern2, 'Output_FIFO': psana.FCCD.Output_Source.Output_FIFO, 'Test_Pattern4': psana.FCCD.Output_Source.Test_Pattern4}
values = {0: psana.FCCD.Output_Source.Output_FIFO, 1: psana.FCCD.Output_Source.Test_Pattern1, 2: psana.FCCD.Output_Source.Test_Pattern2, 3: psana.FCCD.Output_Source.Test_Pattern3, 4: psana.FCCD.Output_Source.Test_Pattern4}
FccdConfigV2.ccdEnable((FccdConfigV2)arg1) → int
FccdConfigV2.dacVoltages((FccdConfigV2)arg1) → numpy.ndarray
FccdConfigV2.exposureTime((FccdConfigV2)arg1) → int
FccdConfigV2.focusMode((FccdConfigV2)arg1) → int
FccdConfigV2.height((FccdConfigV2)arg1) → int
FccdConfigV2.outputMode((FccdConfigV2)arg1) → int
FccdConfigV2.trimmedHeight((FccdConfigV2)arg1) → int
FccdConfigV2.trimmedWidth((FccdConfigV2)arg1) → int
FccdConfigV2.waveforms((FccdConfigV2)arg1) → numpy.ndarray
FccdConfigV2.width((FccdConfigV2)arg1) → int
FccdConfigV2.Column_Pixels = 1152
FccdConfigV2.NVoltages = 17
FccdConfigV2.NWaveforms = 15
FccdConfigV2.Row_Pixels = 500
FccdConfigV2.Trimmed_Column_Pixels = 480
FccdConfigV2.Trimmed_Row_Pixels = 480
FccdConfigV2.TypeId = 21
FccdConfigV2.Version = 2

Module psana.Fli

The Python wrapper module for Fli types

Class psana.Fli.ConfigV1

class psana.Fli.ConfigV1

Raises an exception This class cannot be instantiated from Python

binX((ConfigV1)arg1) → int
binY((ConfigV1)arg1) → int
coolingTemp((ConfigV1)arg1) → float
exposureEventCode((ConfigV1)arg1) → int
exposureTime((ConfigV1)arg1) → float
frameSize((ConfigV1)arg1) → int :

Total size in bytes of the Frame object, including image and frame header.

gainIndex((ConfigV1)arg1) → int
height((ConfigV1)arg1) → int
numDelayShots((ConfigV1)arg1) → int
numPixels((ConfigV1)arg1) → int :

calculate total frame size in pixels based on the current ROI and binning settings

numPixelsX((ConfigV1)arg1) → int :

calculate frame X size in pixels based on the current ROI and binning settings

numPixelsY((ConfigV1)arg1) → int :

calculate frame Y size in pixels based on the current ROI and binning settings

orgX((ConfigV1)arg1) → int
orgY((ConfigV1)arg1) → int
readoutSpeedIndex((ConfigV1)arg1) → int
width((ConfigV1)arg1) → int
TypeId = 55
Version = 1

Class psana.Fli.FrameV1

class psana.Fli.FrameV1

Raises an exception This class cannot be instantiated from Python

data((FrameV1)arg1) → numpy.ndarray
readoutTime((FrameV1)arg1) → float
shotIdStart((FrameV1)arg1) → int
temperature((FrameV1)arg1) → float
TypeId = 56
Version = 1

Module psana.Generic1D

The Python wrapper module for Generic1D types

Class psana.Generic1D.ConfigV0

class psana.Generic1D.ConfigV0

Raises an exception This class cannot be instantiated from Python

class Sample_Type
FLOAT32 = psana.Generic1D.Sample_Type.FLOAT32
FLOAT64 = psana.Generic1D.Sample_Type.FLOAT64
UINT16 = psana.Generic1D.Sample_Type.UINT16
UINT32 = psana.Generic1D.Sample_Type.UINT32
UINT8 = psana.Generic1D.Sample_Type.UINT8
names = {'FLOAT64': psana.Generic1D.Sample_Type.FLOAT64, 'UINT16': psana.Generic1D.Sample_Type.UINT16, 'UINT8': psana.Generic1D.Sample_Type.UINT8, 'FLOAT32': psana.Generic1D.Sample_Type.FLOAT32, 'UINT32': psana.Generic1D.Sample_Type.UINT32}
values = {0: psana.Generic1D.Sample_Type.UINT8, 1: psana.Generic1D.Sample_Type.UINT16, 2: psana.Generic1D.Sample_Type.UINT32, 3: psana.Generic1D.Sample_Type.FLOAT32, 4: psana.Generic1D.Sample_Type.FLOAT64}
ConfigV0.Depth((ConfigV0)arg1, (int)arg2) → int
ConfigV0.Length((ConfigV0)arg1) → numpy.ndarray :

Waveform Length

ConfigV0.NChannels((ConfigV0)arg1) → int :

Number of channels

ConfigV0.Offset((ConfigV0)arg1) → numpy.ndarray :

Waveform Delay Samples

ConfigV0.Period((ConfigV0)arg1) → numpy.ndarray :

Waveform Sampling Period

ConfigV0.SampleType((ConfigV0)arg1) → numpy.ndarray :

Waveform Sample Type

ConfigV0.data_offset((ConfigV0)arg1, (int)arg2) → int
ConfigV0.TypeId = 99
ConfigV0.Version = 0

Class psana.Generic1D.DataV0

class psana.Generic1D.DataV0

Raises an exception This class cannot be instantiated from Python

_int_data((DataV0)arg1) → numpy.ndarray
data_f32((DataV0)arg1, (int)arg2) → numpy.ndarray
data_f64((DataV0)arg1, (int)arg2) → numpy.ndarray
data_size((DataV0)arg1) → int
data_u16((DataV0)arg1, (int)arg2) → numpy.ndarray
data_u32((DataV0)arg1, (int)arg2) → numpy.ndarray
data_u8((DataV0)arg1, (int)arg2) → numpy.ndarray
TypeId = 100
Version = 0

Module psana.GenericPgp

The Python wrapper module for GenericPgp types

Class psana.GenericPgp.CDimension

class psana.GenericPgp.CDimension

Raises an exception This class cannot be instantiated from Python

columns((CDimension)arg1) → int
rows((CDimension)arg1) → int

Class psana.GenericPgp.ConfigV1

class psana.GenericPgp.ConfigV1

Raises an exception This class cannot be instantiated from Python

aux_dim((ConfigV1)arg1) → CDimension :

Dimensions of the auxillary data from the array

env_dim((ConfigV1)arg1) → CDimension :

Dimensions of the environmental data from the array

frame_dim((ConfigV1)arg1) → CDimension :

Dimensions of the frame data from the array

id((ConfigV1)arg1) → int :

Serial number identifying the array

lastRowExclusions((ConfigV1)arg1) → int :

Number of rows in the auxillary data

numberOfAsics((ConfigV1)arg1) → int :

Number of elements in environmental data

numberOfColumns((ConfigV1)arg1) → int :

Number of columns in a readout unit

numberOfRows((ConfigV1)arg1) → int :

Number of rows in a readout unit

number_of_registers((ConfigV1)arg1) → int :

Number of registers in the sequence array

number_of_sequences((ConfigV1)arg1) → int :

Number of (sub)sequences of register operations in the array

number_of_streams((ConfigV1)arg1) → int
payload((ConfigV1)arg1) → numpy.ndarray :

Stream and Register Data

payload_size((ConfigV1)arg1) → int
pixel_settings((ConfigV1)arg1) → numpy.ndarray
sequence((ConfigV1)arg1) → list :

Register Operations

sequence_length((ConfigV1)arg1) → numpy.ndarray :

Lengths of (sub)sequence register operations in the array

stream((ConfigV1)arg1) → list :

Stream readout configuration

TypeId = 85
Version = 1

Class psana.GenericPgp.CRegister

class psana.GenericPgp.CRegister

Raises an exception This class cannot be instantiated from Python

class Action
Flush = psana.GenericPgp.Action.Flush
RegisterRead = psana.GenericPgp.Action.RegisterRead
RegisterVerify = psana.GenericPgp.Action.RegisterVerify
RegisterWrite = psana.GenericPgp.Action.RegisterWrite
RegisterWriteA = psana.GenericPgp.Action.RegisterWriteA
Spin = psana.GenericPgp.Action.Spin
Usleep = psana.GenericPgp.Action.Usleep
names = {'Usleep': psana.GenericPgp.Action.Usleep, 'RegisterVerify': psana.GenericPgp.Action.RegisterVerify, 'Flush': psana.GenericPgp.Action.Flush, 'RegisterRead': psana.GenericPgp.Action.RegisterRead, 'Spin': psana.GenericPgp.Action.Spin, 'RegisterWrite': psana.GenericPgp.Action.RegisterWrite, 'RegisterWriteA': psana.GenericPgp.Action.RegisterWriteA}
values = {0: psana.GenericPgp.Action.RegisterRead, 1: psana.GenericPgp.Action.RegisterWrite, 2: psana.GenericPgp.Action.RegisterWriteA, 3: psana.GenericPgp.Action.RegisterVerify, 4: psana.GenericPgp.Action.Spin, 5: psana.GenericPgp.Action.Usleep, 6: psana.GenericPgp.Action.Flush}
CRegister.action((CRegister)arg1) → Action :

Configuration action

CRegister.address((CRegister)arg1) → int :

Register access address

CRegister.datasize((CRegister)arg1) → int :

Size of register access (in uint32_t’s)

CRegister.mask((CRegister)arg1) → int :

Register value mask

CRegister.offset((CRegister)arg1) → int :

Payload offset

Class psana.GenericPgp.CStream

class psana.GenericPgp.CStream

Raises an exception This class cannot be instantiated from Python

config_offset((CStream)arg1) → int :

Location of configuration data

config_type((CStream)arg1) → int :

Configuration data type ID

data_type((CStream)arg1) → int :

Event data type ID

pgp_channel((CStream)arg1) → int :

PGP virtual channel ID

Module psana.Gsc16ai

The Python wrapper module for Gsc16ai types

Class psana.Gsc16ai.ConfigV1

class psana.Gsc16ai.ConfigV1

Raises an exception This class cannot be instantiated from Python

class DataFormat
DataFormat_OffsetBinary = psana.Gsc16ai.DataFormat.DataFormat_OffsetBinary
DataFormat_TwosComplement = psana.Gsc16ai.DataFormat.DataFormat_TwosComplement
names = {'DataFormat_TwosComplement': psana.Gsc16ai.DataFormat.DataFormat_TwosComplement, 'DataFormat_OffsetBinary': psana.Gsc16ai.DataFormat.DataFormat_OffsetBinary}
values = {0: psana.Gsc16ai.DataFormat.DataFormat_TwosComplement, 1: psana.Gsc16ai.DataFormat.DataFormat_OffsetBinary}
class ConfigV1.InputMode
InputMode_Differential = psana.Gsc16ai.InputMode.InputMode_Differential
InputMode_Vref = psana.Gsc16ai.InputMode.InputMode_Vref
InputMode_Zero = psana.Gsc16ai.InputMode.InputMode_Zero
names = {'InputMode_Zero': psana.Gsc16ai.InputMode.InputMode_Zero, 'InputMode_Differential': psana.Gsc16ai.InputMode.InputMode_Differential, 'InputMode_Vref': psana.Gsc16ai.InputMode.InputMode_Vref}
values = {0: psana.Gsc16ai.InputMode.InputMode_Differential, 1: psana.Gsc16ai.InputMode.InputMode_Zero, 2: psana.Gsc16ai.InputMode.InputMode_Vref}
class ConfigV1.TriggerMode
TriggerMode_ExtNeg = psana.Gsc16ai.TriggerMode.TriggerMode_ExtNeg
TriggerMode_ExtPos = psana.Gsc16ai.TriggerMode.TriggerMode_ExtPos
TriggerMode_IntClk = psana.Gsc16ai.TriggerMode.TriggerMode_IntClk
names = {'TriggerMode_ExtNeg': psana.Gsc16ai.TriggerMode.TriggerMode_ExtNeg, 'TriggerMode_ExtPos': psana.Gsc16ai.TriggerMode.TriggerMode_ExtPos, 'TriggerMode_IntClk': psana.Gsc16ai.TriggerMode.TriggerMode_IntClk}
values = {0: psana.Gsc16ai.TriggerMode.TriggerMode_ExtPos, 1: psana.Gsc16ai.TriggerMode.TriggerMode_ExtNeg, 2: psana.Gsc16ai.TriggerMode.TriggerMode_IntClk}
class ConfigV1.VoltageRange
VoltageRange_10V = psana.Gsc16ai.VoltageRange.VoltageRange_10V
VoltageRange_2_5V = psana.Gsc16ai.VoltageRange.VoltageRange_2_5V
VoltageRange_5V = psana.Gsc16ai.VoltageRange.VoltageRange_5V
names = {'VoltageRange_2_5V': psana.Gsc16ai.VoltageRange.VoltageRange_2_5V, 'VoltageRange_5V': psana.Gsc16ai.VoltageRange.VoltageRange_5V, 'VoltageRange_10V': psana.Gsc16ai.VoltageRange.VoltageRange_10V}
values = {0: psana.Gsc16ai.VoltageRange.VoltageRange_10V, 1: psana.Gsc16ai.VoltageRange.VoltageRange_5V, 2: psana.Gsc16ai.VoltageRange.VoltageRange_2_5V}
ConfigV1.autocalibEnable((ConfigV1)arg1) → int
ConfigV1.dataFormat((ConfigV1)arg1) → DataFormat
ConfigV1.firstChan((ConfigV1)arg1) → int
ConfigV1.fps((ConfigV1)arg1) → int
ConfigV1.inputMode((ConfigV1)arg1) → InputMode
ConfigV1.lastChan((ConfigV1)arg1) → int
ConfigV1.numChannels((ConfigV1)arg1) → int
ConfigV1.timeTagEnable((ConfigV1)arg1) → int
ConfigV1.triggerMode((ConfigV1)arg1) → TriggerMode
ConfigV1.voltageRange((ConfigV1)arg1) → VoltageRange
ConfigV1.HighestChannel = 15
ConfigV1.HighestFps = 120
ConfigV1.LowestChannel = 0
ConfigV1.LowestFps = 1
ConfigV1.TypeId = 46
ConfigV1.Version = 1

Class psana.Gsc16ai.DataV1

class psana.Gsc16ai.DataV1

Raises an exception This class cannot be instantiated from Python

channelValue((DataV1)arg1) → numpy.ndarray
timestamp((DataV1)arg1) → numpy.ndarray
TypeId = 47
Version = 1

Module psana.Imp

The Python wrapper module for Imp types

Class psana.Imp.ConfigV1

class psana.Imp.ConfigV1

Raises an exception This class cannot be instantiated from Python

class Registers
Adc_delay = psana.Imp.Registers.Adc_delay
BiasDac_data = psana.Imp.Registers.BiasDac_data
Bias_data = psana.Imp.Registers.Bias_data
Cal_data = psana.Imp.Registers.Cal_data
Cal_range = psana.Imp.Registers.Cal_range
Cal_strobe = psana.Imp.Registers.Cal_strobe
NumberOfRegisters = psana.Imp.Registers.NumberOfRegisters
NumberOfSamples = psana.Imp.Registers.NumberOfSamples
Range = psana.Imp.Registers.Range
Reset = psana.Imp.Registers.Reset
TrigDelay = psana.Imp.Registers.TrigDelay
names = {'Reset': psana.Imp.Registers.Reset, 'Cal_data': psana.Imp.Registers.Cal_data, 'BiasDac_data': psana.Imp.Registers.BiasDac_data, 'TrigDelay': psana.Imp.Registers.TrigDelay, 'Adc_delay': psana.Imp.Registers.Adc_delay, 'NumberOfSamples': psana.Imp.Registers.NumberOfSamples, 'NumberOfRegisters': psana.Imp.Registers.NumberOfRegisters, 'Range': psana.Imp.Registers.Range, 'Bias_data': psana.Imp.Registers.Bias_data, 'Cal_strobe': psana.Imp.Registers.Cal_strobe, 'Cal_range': psana.Imp.Registers.Cal_range}
values = {0: psana.Imp.Registers.Range, 1: psana.Imp.Registers.Cal_range, 2: psana.Imp.Registers.Reset, 3: psana.Imp.Registers.Bias_data, 4: psana.Imp.Registers.Cal_data, 5: psana.Imp.Registers.BiasDac_data, 6: psana.Imp.Registers.Cal_strobe, 7: psana.Imp.Registers.NumberOfSamples, 8: psana.Imp.Registers.TrigDelay, 9: psana.Imp.Registers.Adc_delay, 10: psana.Imp.Registers.NumberOfRegisters}
ConfigV1.adcDelay((ConfigV1)arg1) → int
ConfigV1.biasDacData((ConfigV1)arg1) → int
ConfigV1.biasData((ConfigV1)arg1) → int
ConfigV1.calData((ConfigV1)arg1) → int
ConfigV1.calRange((ConfigV1)arg1) → int
ConfigV1.calStrobe((ConfigV1)arg1) → int
ConfigV1.numberOfSamples((ConfigV1)arg1) → int
ConfigV1.range((ConfigV1)arg1) → int
ConfigV1.reset((ConfigV1)arg1) → int
ConfigV1.trigDelay((ConfigV1)arg1) → int
ConfigV1.MaxNumberOfSamples = 1023
ConfigV1.TypeId = 68
ConfigV1.Version = 1

Class psana.Imp.ElementV1

class psana.Imp.ElementV1

Raises an exception This class cannot be instantiated from Python

frameNumber((ElementV1)arg1) → int
lane((ElementV1)arg1) → int
laneStatus((ElementV1)arg1) → LaneStatus
range((ElementV1)arg1) → int
samples((ElementV1)arg1) → list
vc((ElementV1)arg1) → int
TypeId = 67
Version = 1

Class psana.Imp.LaneStatus

class psana.Imp.LaneStatus

Raises an exception This class cannot be instantiated from Python

cellErrCount((LaneStatus)arg1) → int
linkDownCount((LaneStatus)arg1) → int
linkErrCount((LaneStatus)arg1) → int
locLinked((LaneStatus)arg1) → int
powersOkay((LaneStatus)arg1) → int
remLinked((LaneStatus)arg1) → int
rxCount((LaneStatus)arg1) → int
zeros((LaneStatus)arg1) → int

Class psana.Imp.Sample

class psana.Imp.Sample

Raises an exception This class cannot be instantiated from Python

channels((Sample)arg1) → numpy.ndarray
channelsPerDevice = 4

Module psana.Ipimb

The Python wrapper module for Ipimb types

Class psana.Ipimb.ConfigV1

class psana.Ipimb.ConfigV1

Raises an exception This class cannot be instantiated from Python

class CapacitorValue
c_100pF = psana.Ipimb.CapacitorValue.c_100pF
c_10nF = psana.Ipimb.CapacitorValue.c_10nF
c_1pF = psana.Ipimb.CapacitorValue.c_1pF
names = {'c_1pF': psana.Ipimb.CapacitorValue.c_1pF, 'c_100pF': psana.Ipimb.CapacitorValue.c_100pF, 'c_10nF': psana.Ipimb.CapacitorValue.c_10nF}
values = {0: psana.Ipimb.CapacitorValue.c_1pF, 1: psana.Ipimb.CapacitorValue.c_100pF, 2: psana.Ipimb.CapacitorValue.c_10nF}
ConfigV1.calStrobeLength((ConfigV1)arg1) → int
ConfigV1.calibrationRange((ConfigV1)arg1) → int
ConfigV1.calibrationVoltage((ConfigV1)arg1) → float
ConfigV1.capacitorValue((ConfigV1)arg1, (int)arg2) → CapacitorValue :

Returns CapacitorValue enum for given channel number (0..3).

ConfigV1.capacitorValues((ConfigV1)arg1) → numpy.ndarray :

Returns array of CapacitorValue enums.

ConfigV1.chargeAmpRange((ConfigV1)arg1) → int
ConfigV1.chargeAmpRefVoltage((ConfigV1)arg1) → float
ConfigV1.diodeBias((ConfigV1)arg1) → float
ConfigV1.errors((ConfigV1)arg1) → int
ConfigV1.resetDelay((ConfigV1)arg1) → int
ConfigV1.resetLength((ConfigV1)arg1) → int
ConfigV1.serialID((ConfigV1)arg1) → int
ConfigV1.status((ConfigV1)arg1) → int
ConfigV1.trigDelay((ConfigV1)arg1) → int
ConfigV1.triggerCounter((ConfigV1)arg1) → int
ConfigV1.TypeId = 23
ConfigV1.Version = 1

Class psana.Ipimb.ConfigV2

class psana.Ipimb.ConfigV2

Raises an exception This class cannot be instantiated from Python

class CapacitorValue
c_10nF = psana.Ipimb.CapacitorValue.c_10nF
c_120pF = psana.Ipimb.CapacitorValue.c_120pF
c_1pF = psana.Ipimb.CapacitorValue.c_1pF
c_24pF = psana.Ipimb.CapacitorValue.c_24pF
c_3p3nF = psana.Ipimb.CapacitorValue.c_3p3nF
c_4p7pF = psana.Ipimb.CapacitorValue.c_4p7pF
c_620pF = psana.Ipimb.CapacitorValue.c_620pF
expert = psana.Ipimb.CapacitorValue.expert
names = {'c_3p3nF': psana.Ipimb.CapacitorValue.c_3p3nF, 'expert': psana.Ipimb.CapacitorValue.expert, 'c_120pF': psana.Ipimb.CapacitorValue.c_120pF, 'c_4p7pF': psana.Ipimb.CapacitorValue.c_4p7pF, 'c_24pF': psana.Ipimb.CapacitorValue.c_24pF, 'c_1pF': psana.Ipimb.CapacitorValue.c_1pF, 'c_620pF': psana.Ipimb.CapacitorValue.c_620pF, 'c_10nF': psana.Ipimb.CapacitorValue.c_10nF}
values = {0: psana.Ipimb.CapacitorValue.c_1pF, 1: psana.Ipimb.CapacitorValue.c_4p7pF, 2: psana.Ipimb.CapacitorValue.c_24pF, 3: psana.Ipimb.CapacitorValue.c_120pF, 4: psana.Ipimb.CapacitorValue.c_620pF, 5: psana.Ipimb.CapacitorValue.c_3p3nF, 6: psana.Ipimb.CapacitorValue.c_10nF, 7: psana.Ipimb.CapacitorValue.expert}
ConfigV2.adcDelay((ConfigV2)arg1) → int
ConfigV2.calStrobeLength((ConfigV2)arg1) → int
ConfigV2.calibrationRange((ConfigV2)arg1) → int
ConfigV2.calibrationVoltage((ConfigV2)arg1) → float
ConfigV2.capacitorValue((ConfigV2)arg1, (int)arg2) → CapacitorValue :

Returns CapacitorValue enum for given channel number (0..3).

ConfigV2.capacitorValues((ConfigV2)arg1) → numpy.ndarray :

Returns array of CapacitorValue enums.

ConfigV2.chargeAmpRange((ConfigV2)arg1) → int
ConfigV2.chargeAmpRefVoltage((ConfigV2)arg1) → float
ConfigV2.diodeBias((ConfigV2)arg1) → float
ConfigV2.errors((ConfigV2)arg1) → int
ConfigV2.resetDelay((ConfigV2)arg1) → int
ConfigV2.resetLength((ConfigV2)arg1) → int
ConfigV2.serialID((ConfigV2)arg1) → int
ConfigV2.status((ConfigV2)arg1) → int
ConfigV2.trigDelay((ConfigV2)arg1) → int
ConfigV2.trigPsDelay((ConfigV2)arg1) → int
ConfigV2.triggerCounter((ConfigV2)arg1) → int
ConfigV2.TypeId = 23
ConfigV2.Version = 2

Class psana.Ipimb.DataV1

class psana.Ipimb.DataV1

Raises an exception This class cannot be instantiated from Python

channel0((DataV1)arg1) → int :

Raw counts value returned from channel 0.

channel0Volts((DataV1)arg1) → float :

Value of of channel0() converted to Volts.

channel1((DataV1)arg1) → int :

Raw counts value returned from channel 1.

channel1Volts((DataV1)arg1) → float :

Value of of channel1() converted to Volts.

channel2((DataV1)arg1) → int :

Raw counts value returned from channel 2.

channel2Volts((DataV1)arg1) → float :

Value of of channel2() converted to Volts.

channel3((DataV1)arg1) → int :

Raw counts value returned from channel 3.

channel3Volts((DataV1)arg1) → float :

Value of of channel3() converted to Volts.

checksum((DataV1)arg1) → int
config0((DataV1)arg1) → int
config1((DataV1)arg1) → int
config2((DataV1)arg1) → int
triggerCounter((DataV1)arg1) → int
TypeId = 22
Version = 1

Class psana.Ipimb.DataV2

class psana.Ipimb.DataV2

Raises an exception This class cannot be instantiated from Python

channel0((DataV2)arg1) → int :

Raw counts value returned from channel 0.

channel0Volts((DataV2)arg1) → float :

Value of of channel0() converted to Volts.

channel0ps((DataV2)arg1) → int :

Raw counts value returned from channel 0.

channel0psVolts((DataV2)arg1) → float :

Value of of channel0ps() converted to Volts.

channel1((DataV2)arg1) → int :

Raw counts value returned from channel 1.

channel1Volts((DataV2)arg1) → float :

Value of of channel1() converted to Volts.

channel1ps((DataV2)arg1) → int :

Raw counts value returned from channel 1.

channel1psVolts((DataV2)arg1) → float :

Value of of channel1ps() converted to Volts.

channel2((DataV2)arg1) → int :

Raw counts value returned from channel 2.

channel2Volts((DataV2)arg1) → float :

Value of of channel2() converted to Volts.

channel2ps((DataV2)arg1) → int :

Raw counts value returned from channel 2.

channel2psVolts((DataV2)arg1) → float :

Value of of channel2ps() converted to Volts.

channel3((DataV2)arg1) → int :

Raw counts value returned from channel 3.

channel3Volts((DataV2)arg1) → float :

Value of of channel3() converted to Volts.

channel3ps((DataV2)arg1) → int :

Raw counts value returned from channel 3.

channel3psVolts((DataV2)arg1) → float :

Value of of channel3ps() converted to Volts.

checksum((DataV2)arg1) → int
config0((DataV2)arg1) → int
config1((DataV2)arg1) → int
config2((DataV2)arg1) → int
triggerCounter((DataV2)arg1) → int :

Trigger counter value.

TypeId = 22
Version = 2
ipimbAdcRange = 5
ipimbAdcSteps = 65536

Module psana.Jungfrau

The Python wrapper module for Jungfrau types

Class psana.Jungfrau.ConfigV1

class psana.Jungfrau.ConfigV1

Raises an exception This class cannot be instantiated from Python

class GainMode
FixedGain1 = psana.Jungfrau.GainMode.FixedGain1
FixedGain2 = psana.Jungfrau.GainMode.FixedGain2
ForcedGain1 = psana.Jungfrau.GainMode.ForcedGain1
ForcedGain2 = psana.Jungfrau.GainMode.ForcedGain2
HighGain0 = psana.Jungfrau.GainMode.HighGain0
Normal = psana.Jungfrau.GainMode.Normal
names = {'ForcedGain1': psana.Jungfrau.GainMode.ForcedGain1, 'FixedGain1': psana.Jungfrau.GainMode.FixedGain1, 'ForcedGain2': psana.Jungfrau.GainMode.ForcedGain2, 'Normal': psana.Jungfrau.GainMode.Normal, 'FixedGain2': psana.Jungfrau.GainMode.FixedGain2, 'HighGain0': psana.Jungfrau.GainMode.HighGain0}
values = {0: psana.Jungfrau.GainMode.Normal, 1: psana.Jungfrau.GainMode.FixedGain1, 2: psana.Jungfrau.GainMode.FixedGain2, 3: psana.Jungfrau.GainMode.ForcedGain1, 4: psana.Jungfrau.GainMode.ForcedGain2, 5: psana.Jungfrau.GainMode.HighGain0}
class ConfigV1.SpeedMode
Half = psana.Jungfrau.SpeedMode.Half
Quarter = psana.Jungfrau.SpeedMode.Quarter
names = {'Quarter': psana.Jungfrau.SpeedMode.Quarter, 'Half': psana.Jungfrau.SpeedMode.Half}
values = {0: psana.Jungfrau.SpeedMode.Quarter, 1: psana.Jungfrau.SpeedMode.Half}
ConfigV1.biasVoltage((ConfigV1)arg1) → int :

The bias applied to the sensor in volts.

ConfigV1.exposureTime((ConfigV1)arg1) → float :

The exposure time in seconds.

ConfigV1.frameSize((ConfigV1)arg1) → int :

Total size in bytes of the Frame object

ConfigV1.gainMode((ConfigV1)arg1) → GainMode :

The gain mode set for the camera.

ConfigV1.numPixels((ConfigV1)arg1) → int :

calculate total frame size in pixels based on the current ROI and binning settings

ConfigV1.numberOfColumnsPerModule((ConfigV1)arg1) → int :

The number of columns per module.

ConfigV1.numberOfModules((ConfigV1)arg1) → int :

The number of modules in a physical camera.

ConfigV1.numberOfRowsPerModule((ConfigV1)arg1) → int :

The number of rows per module.

ConfigV1.speedMode((ConfigV1)arg1) → SpeedMode :

The camera clock speed setting.

ConfigV1.triggerDelay((ConfigV1)arg1) → float :

Internal delay from receiving a trigger input until the start of an acquisiton in seconds.

ConfigV1.TypeId = 107
ConfigV1.Version = 1

Class psana.Jungfrau.ElementV1

class psana.Jungfrau.ElementV1

Raises an exception This class cannot be instantiated from Python

fiducials((ElementV1)arg1) → int :

The LCLS timing fiducial associated with the detector frame.

frame((ElementV1)arg1) → numpy.ndarray
frameNumber((ElementV1)arg1) → int :

The internal frame counter number of the detector.

ticks((ElementV1)arg1) → int :

The LCLS timing tick associated with the detector frame.

TypeId = 108
Version = 1

Module psana.L3T

The Python wrapper module for L3T types

Class psana.L3T.ConfigV1

class psana.L3T.ConfigV1

Raises an exception This class cannot be instantiated from Python

desc((ConfigV1)arg1) → str :

The description string

desc_len((ConfigV1)arg1) → int :

Length of the description string

desc_shape((ConfigV1)arg1) → object
module_id((ConfigV1)arg1) → str :

The module identification string

module_id_len((ConfigV1)arg1) → int :

Length of the module identification string

module_id_shape((ConfigV1)arg1) → object
TypeId = 70
Version = 1

Class psana.L3T.DataV1

class psana.L3T.DataV1

Raises an exception This class cannot be instantiated from Python

accept((DataV1)arg1) → int :

Module trigger decision

TypeId = 71
Version = 1

Class psana.L3T.DataV2

class psana.L3T.DataV2

Raises an exception This class cannot be instantiated from Python

class Bias
Biased = psana.L3T.Bias.Biased
Unbiased = psana.L3T.Bias.Unbiased
names = {'Unbiased': psana.L3T.Bias.Unbiased, 'Biased': psana.L3T.Bias.Biased}
values = {0: psana.L3T.Bias.Unbiased, 1: psana.L3T.Bias.Biased}
class DataV2.Result
Fail = psana.L3T.Result.Fail
None = psana.L3T.Result.None
Pass = psana.L3T.Result.Pass
names = {'Fail': psana.L3T.Result.Fail, 'None': psana.L3T.Result.None, 'Pass': psana.L3T.Result.Pass}
values = {0: psana.L3T.Result.Fail, 1: psana.L3T.Result.Pass, 2: psana.L3T.Result.None}
DataV2.accept((DataV2)arg1) → int
DataV2.bias((DataV2)arg1) → Bias :

Returns L3T Bias : Unbiased = recorded independent of decision

DataV2.result((DataV2)arg1) → Result :

Returns L3T Decision : None = insufficient information/resources

DataV2.TypeId = 71
DataV2.Version = 2

Module psana.Lusi

The Python wrapper module for Lusi types

Class psana.Lusi.DiodeFexConfigV1

class psana.Lusi.DiodeFexConfigV1

Raises an exception This class cannot be instantiated from Python

base((DiodeFexConfigV1)arg1) → numpy.ndarray
scale((DiodeFexConfigV1)arg1) → numpy.ndarray
NRANGES = 3
TypeId = 32
Version = 1

Class psana.Lusi.DiodeFexConfigV2

class psana.Lusi.DiodeFexConfigV2

Raises an exception This class cannot be instantiated from Python

base((DiodeFexConfigV2)arg1) → numpy.ndarray
scale((DiodeFexConfigV2)arg1) → numpy.ndarray
NRANGES = 16
TypeId = 32
Version = 2

Class psana.Lusi.DiodeFexV1

class psana.Lusi.DiodeFexV1

Raises an exception This class cannot be instantiated from Python

value((DiodeFexV1)arg1) → float
TypeId = 33
Version = 1

Class psana.Lusi.IpmFexConfigV1

class psana.Lusi.IpmFexConfigV1

Raises an exception This class cannot be instantiated from Python

diode((IpmFexConfigV1)arg1) → list
xscale((IpmFexConfigV1)arg1) → float
yscale((IpmFexConfigV1)arg1) → float
NCHANNELS = 4
TypeId = 30
Version = 1

Class psana.Lusi.IpmFexConfigV2

class psana.Lusi.IpmFexConfigV2

Raises an exception This class cannot be instantiated from Python

diode((IpmFexConfigV2)arg1) → list
xscale((IpmFexConfigV2)arg1) → float
yscale((IpmFexConfigV2)arg1) → float
NCHANNELS = 4
TypeId = 30
Version = 2

Class psana.Lusi.IpmFexV1

class psana.Lusi.IpmFexV1

Raises an exception This class cannot be instantiated from Python

channel((IpmFexV1)arg1) → numpy.ndarray
sum((IpmFexV1)arg1) → float
xpos((IpmFexV1)arg1) → float
ypos((IpmFexV1)arg1) → float
NCHANNELS = 4
TypeId = 31
Version = 1

Class psana.Lusi.PimImageConfigV1

class psana.Lusi.PimImageConfigV1

Raises an exception This class cannot be instantiated from Python

xscale((PimImageConfigV1)arg1) → float
yscale((PimImageConfigV1)arg1) → float
TypeId = 34
Version = 1

Module psana.mpi_datasource

Class psana.mpi_datasource.MPIDataSource

class psana.mpi_datasource.MPIDataSource(ds_string, **kwargs)[source]

A wrapper for psana.Datasource that maintains the same interface but hides distribution of events to many MPI cores to simplify user analysis code.

Create a wrapper for psana.Datasource that maintains the same interface but hides distribution of events to many MPI cores to simplify user analysis code.

ds_string : str
A DataSource string, e.g. “exp=xpptut15:run=54:smd” that specifies the experiment and run to access.
>>> ds = psana.MPIDataSource('exp=xpptut15:run=54:smd')
>>> smldata = ds.small_data('my.h5')
>>> cspad = psana.Detector('cspad')
>>> for evt in ds.events():
>>>     mu = np.mean( cspad.calib(evt)
>>>     smldata.append(cspad_mean=mu)
psana.DataSource
The serial data access method this class is based on
MPIDataSource.small_data
Method to create a SmallData object that can aggregate data in a parallel fashion.
_event_gen(psana_level)[source]

psana_level is a DataSource, Run, Step object with a .events() method

break_after(n_events)[source]

Limit the datasource to n_events (max global events).

Unfortunately, you CANNOT break safely out of an event iteration loop when running in parallel. Sometimes, one core will break, but his buddies will keep chugging. Then they get stuck waiting for him to catch up, with no idea that he’s given up!

Instead, use this function to stop iteration safely.

n_events : int
The GLOBAL number of events to include in the datasource (ie. break out of an event loop after this number of events have been processed)
detnames(which='detectors')[source]

List the detectors contained in this datasource.

which : str
One of: “detectors”, “epics”, “all”.
detnames : str
A list of detector names and aliases
env()[source]
events()[source]

Returns a python generator of events.

runs()[source]
small_data(filename=None, save_on_gather=False, gather_interval=100)[source]

Returns an object that manages small per-event data as well as non-event data (e.g. a sum of an image over a run)

filename : string, optional
A filename to use for saving the small data
save_on_gather: bool, optional (default False)
If true, save data to HDF5 file everytime results are gathered from all MPI cores
gather_interval: unsigned int, optional (default 100)
If set to unsigned integer “N”, gather results from all MPI cores every “N” events. Events are counted separately on each core. If not set, only gather results from all cores at end-run.
>>> ds = psana.MPIDataSource('exp=xpptut15:run=54:smd')
>>> smldata = ds.small_data('my.h5')
>>> cspad = psana.Detector('cspad')
>>> for evt in ds.events():
>>>     mu = np.mean( cspad.calib(evt)
>>>     smldata.append(cspad_mean=mu)
steps()[source]
master

Class psana.mpi_datasource.Step

class psana.mpi_datasource.Step(psana_step, ds_parent)[source]

An object that represents a set of events within a run taken under identical conditions (also known as a calib-cycle.

Create an MPIDataSource compatible Step object.

psana_step : psana.Step
An instance of psana.Step
ds_parent : psana.DataSoure
The DataSource object that created the Step
env()[source]
events()[source]

Returns a python generator of events.

Module psana.OceanOptics

The Python wrapper module for OceanOptics types

Class psana.OceanOptics.ConfigV1

class psana.OceanOptics.ConfigV1

Raises an exception This class cannot be instantiated from Python

exposureTime((ConfigV1)arg1) → float
nonlinCorrect((ConfigV1)arg1) → numpy.ndarray
strayLightConstant((ConfigV1)arg1) → float
waveLenCalib((ConfigV1)arg1) → numpy.ndarray
TypeId = 52
Version = 1

Class psana.OceanOptics.ConfigV2

class psana.OceanOptics.ConfigV2

Raises an exception This class cannot be instantiated from Python

deviceType((ConfigV2)arg1) → int
exposureTime((ConfigV2)arg1) → float
nonlinCorrect((ConfigV2)arg1) → numpy.ndarray
strayLightConstant((ConfigV2)arg1) → float
waveLenCalib((ConfigV2)arg1) → numpy.ndarray
TypeId = 52
Version = 2

Class psana.OceanOptics.DataV1

class psana.OceanOptics.DataV1

Raises an exception This class cannot be instantiated from Python

data((DataV1)arg1) → numpy.ndarray
durationOfFrame((DataV1)arg1) → float
frameCounter((DataV1)arg1) → int
nonlinerCorrected((DataV1)arg1, (int)arg2) → float
numDelayedFrames((DataV1)arg1) → int
numDiscardFrames((DataV1)arg1) → int
numSpectraInData((DataV1)arg1) → int
numSpectraInQueue((DataV1)arg1) → int
numSpectraUnused((DataV1)arg1) → int
timeFrameEnd((DataV1)arg1) → timespec64
timeFrameFirstData((DataV1)arg1) → timespec64
timeFrameStart((DataV1)arg1) → timespec64
TypeId = 53
Version = 1
iActivePixelIndex = 22
iDataReadSize = 8192
iNumPixels = 3840

Class psana.OceanOptics.DataV2

class psana.OceanOptics.DataV2

Raises an exception This class cannot be instantiated from Python

data((DataV2)arg1) → numpy.ndarray
durationOfFrame((DataV2)arg1) → float
frameCounter((DataV2)arg1) → int
nonlinerCorrected((DataV2)arg1, (int)arg2) → float
numDelayedFrames((DataV2)arg1) → int
numDiscardFrames((DataV2)arg1) → int
numSpectraInData((DataV2)arg1) → int
numSpectraInQueue((DataV2)arg1) → int
numSpectraUnused((DataV2)arg1) → int
timeFrameEnd((DataV2)arg1) → timespec64
timeFrameFirstData((DataV2)arg1) → timespec64
timeFrameStart((DataV2)arg1) → timespec64
TypeId = 53
Version = 2
iActivePixelIndex = 0
iDataReadSize = 4608
iNumPixels = 2048

Class psana.OceanOptics.DataV3

class psana.OceanOptics.DataV3

Raises an exception This class cannot be instantiated from Python

data((DataV3)arg1) → numpy.ndarray
durationOfFrame((DataV3)arg1) → float
frameCounter((DataV3)arg1) → int
nonlinerCorrected((DataV3)arg1, (int)arg2) → float
numDelayedFrames((DataV3)arg1) → int
numDiscardFrames((DataV3)arg1) → int
numSpectraInData((DataV3)arg1) → int
numSpectraInQueue((DataV3)arg1) → int
numSpectraUnused((DataV3)arg1) → int
timeFrameEnd((DataV3)arg1) → timespec64
timeFrameFirstData((DataV3)arg1) → timespec64
timeFrameStart((DataV3)arg1) → timespec64
TypeId = 53
Version = 3
iActivePixelIndex = 22
iDataReadSize = 8192
iNumPixels = 3840

Class psana.OceanOptics.timespec64

class psana.OceanOptics.timespec64

Raises an exception This class cannot be instantiated from Python

tv_nsec((timespec64)arg1) → int
tv_sec((timespec64)arg1) → int

Module psana.Opal1k

The Python wrapper module for Opal1k types

Class psana.Opal1k.ConfigV1

class psana.Opal1k.ConfigV1

Raises an exception This class cannot be instantiated from Python

class Binning
names = {'x2': psana.Opal1k.Binning.x2, 'x8': psana.Opal1k.Binning.x8, 'x1': psana.Opal1k.Binning.x1, 'x4': psana.Opal1k.Binning.x4}
values = {0: psana.Opal1k.Binning.x1, 1: psana.Opal1k.Binning.x2, 2: psana.Opal1k.Binning.x4, 3: psana.Opal1k.Binning.x8}
x1 = psana.Opal1k.Binning.x1
x2 = psana.Opal1k.Binning.x2
x4 = psana.Opal1k.Binning.x4
x8 = psana.Opal1k.Binning.x8
class ConfigV1.Depth
Eight_bit = psana.Opal1k.Depth.Eight_bit
Ten_bit = psana.Opal1k.Depth.Ten_bit
Twelve_bit = psana.Opal1k.Depth.Twelve_bit
names = {'Twelve_bit': psana.Opal1k.Depth.Twelve_bit, 'Eight_bit': psana.Opal1k.Depth.Eight_bit, 'Ten_bit': psana.Opal1k.Depth.Ten_bit}
values = {0: psana.Opal1k.Depth.Eight_bit, 1: psana.Opal1k.Depth.Ten_bit, 2: psana.Opal1k.Depth.Twelve_bit}
class ConfigV1.Mirroring
HFlip = psana.Opal1k.Mirroring.HFlip
HVFlip = psana.Opal1k.Mirroring.HVFlip
None = psana.Opal1k.Mirroring.None
VFlip = psana.Opal1k.Mirroring.VFlip
names = {'None': psana.Opal1k.Mirroring.None, 'HFlip': psana.Opal1k.Mirroring.HFlip, 'HVFlip': psana.Opal1k.Mirroring.HVFlip, 'VFlip': psana.Opal1k.Mirroring.VFlip}
values = {0: psana.Opal1k.Mirroring.None, 1: psana.Opal1k.Mirroring.HFlip, 2: psana.Opal1k.Mirroring.VFlip, 3: psana.Opal1k.Mirroring.HVFlip}
ConfigV1.black_level((ConfigV1)arg1) → int :

offset/pedestal setting for camera (before gain)

ConfigV1.defect_pixel_coordinates((ConfigV1)arg1) → list
ConfigV1.defect_pixel_correction_enabled((ConfigV1)arg1) → int :

correct defective pixels internally

ConfigV1.gain_percent((ConfigV1)arg1) → int :

camera gain setting in percentile [100-3200] = [1x-32x]

ConfigV1.number_of_defect_pixels((ConfigV1)arg1) → int
ConfigV1.output_lookup_table((ConfigV1)arg1) → numpy.ndarray
ConfigV1.output_lookup_table_enabled((ConfigV1)arg1) → int :

apply output lookup table corrections

ConfigV1.output_mirroring((ConfigV1)arg1) → Mirroring :

geometric transformation of the image

ConfigV1.output_offset((ConfigV1)arg1) → int :

offset/pedestal value in pixel counts

ConfigV1.output_resolution((ConfigV1)arg1) → Depth :

bit-depth of pixel counts

ConfigV1.output_resolution_bits((ConfigV1)arg1) → int :

bit-depth of pixel counts

ConfigV1.vertical_binning((ConfigV1)arg1) → Binning :

vertical re-binning of output (consecutive rows summed)

ConfigV1.vertical_remapping((ConfigV1)arg1) → int :
1: remap the pixels to appear in natural geometric order
(left->right, top->bottom);
0: pixels appear on dual taps from different rows
(left->right, top->bottom) alternated with (left->right, bottom->top) pixel by pixel
ConfigV1.Column_Pixels = 1024
ConfigV1.LUT_Size = 4096
ConfigV1.Output_LUT_Size = 4096
ConfigV1.Row_Pixels = 1024
ConfigV1.TypeId = 6
ConfigV1.Version = 1

Module psana.Orca

The Python wrapper module for Orca types

Class psana.Orca.ConfigV1

class psana.Orca.ConfigV1

Raises an exception This class cannot be instantiated from Python

class Cooling
Max = psana.Orca.Cooling.Max
Off = psana.Orca.Cooling.Off
On = psana.Orca.Cooling.On
names = {'On': psana.Orca.Cooling.On, 'Off': psana.Orca.Cooling.Off, 'Max': psana.Orca.Cooling.Max}
values = {0: psana.Orca.Cooling.Off, 1: psana.Orca.Cooling.On, 2: psana.Orca.Cooling.Max}
class ConfigV1.ReadoutMode
Subarray = psana.Orca.ReadoutMode.Subarray
names = {'x2': psana.Orca.ReadoutMode.x2, 'Subarray': psana.Orca.ReadoutMode.Subarray, 'x1': psana.Orca.ReadoutMode.x1, 'x4': psana.Orca.ReadoutMode.x4}
values = {0: psana.Orca.ReadoutMode.x1, 1: psana.Orca.ReadoutMode.x2, 2: psana.Orca.ReadoutMode.x4, 3: psana.Orca.ReadoutMode.Subarray}
x1 = psana.Orca.ReadoutMode.x1
x2 = psana.Orca.ReadoutMode.x2
x4 = psana.Orca.ReadoutMode.x4
ConfigV1.cooling((ConfigV1)arg1) → Cooling
ConfigV1.defect_pixel_correction_enabled((ConfigV1)arg1) → int
ConfigV1.mode((ConfigV1)arg1) → ReadoutMode
ConfigV1.rows((ConfigV1)arg1) → int
ConfigV1.Column_Pixels = 2048
ConfigV1.Row_Pixels = 2048
ConfigV1.TypeId = 66
ConfigV1.Version = 1

Module psana.Partition

The Python wrapper module for Partition types

Class psana.Partition.ConfigV1

class psana.Partition.ConfigV1

Raises an exception This class cannot be instantiated from Python

bldMask((ConfigV1)arg1) → int :

Mask of requested BLD

numSources((ConfigV1)arg1) → int :

Number of source definitions

sources((ConfigV1)arg1) → list :

Source configuration objects

TypeId = 79
Version = 1

Class psana.Partition.ConfigV2

class psana.Partition.ConfigV2

Raises an exception This class cannot be instantiated from Python

bldMask((ConfigV2)arg1) → numpy.ndarray :

Mask of requested BLD

bldMaskHasBitClear((ConfigV2)arg1, (int)arg2) → int :

Returns non-zero if the bit cooresponding to iBit in the word is unset, zero otherwise.

bldMaskHasBitSet((ConfigV2)arg1, (int)arg2) → int :

Returns non-zero if the bit cooresponding to iBit in the word is set, zero otherwise.

bldMaskIsNotZero((ConfigV2)arg1) → int :

Returns non-zero if any bits in the mask are set, zero otherwise.

bldMaskIsZero((ConfigV2)arg1) → int :

Returns non-zero if all bits in the mask are unset, zero otherwise.

numBldMaskBits((ConfigV2)arg1) → int :

Returns the total number of bits in the mask

numSources((ConfigV2)arg1) → int :

Number of source definitions

numWords((ConfigV2)arg1) → int :

Number of words for the bit mask

sources((ConfigV2)arg1) → list :

Source configuration objects

TypeId = 79
Version = 2

Class psana.Partition.Source

class psana.Partition.Source

Raises an exception This class cannot be instantiated from Python

group((Source)arg1) → int
src((Source)arg1) → psana.Src

Module psana.Pimax

The Python wrapper module for Pimax types

Class psana.Pimax.ConfigV1

class psana.Pimax.ConfigV1

Raises an exception This class cannot be instantiated from Python

binX((ConfigV1)arg1) → int
binY((ConfigV1)arg1) → int
coolingTemp((ConfigV1)arg1) → float
exposureEventCode((ConfigV1)arg1) → int
exposureTime((ConfigV1)arg1) → float
frameSize((ConfigV1)arg1) → int :

Total size in bytes of the Frame object

gainIndex((ConfigV1)arg1) → int
gateDelay((ConfigV1)arg1) → float
gateWidth((ConfigV1)arg1) → float
height((ConfigV1)arg1) → int
infoReportInterval((ConfigV1)arg1) → int
intensifierGain((ConfigV1)arg1) → int
kineticHeight((ConfigV1)arg1) → int
maskedHeight((ConfigV1)arg1) → int
numIntegrationShots((ConfigV1)arg1) → int
numPixels((ConfigV1)arg1) → int :

calculate total frame size in pixels based on the current ROI and binning settings

numPixelsX((ConfigV1)arg1) → int :

calculate frame X size in pixels based on the current ROI and binning settings

numPixelsY((ConfigV1)arg1) → int :

calculate frame Y size in pixels based on the current ROI and binning settings

orgX((ConfigV1)arg1) → int
orgY((ConfigV1)arg1) → int
readoutSpeed((ConfigV1)arg1) → float
vsSpeed((ConfigV1)arg1) → float
width((ConfigV1)arg1) → int
TypeId = 80
Version = 1

Class psana.Pimax.FrameV1

class psana.Pimax.FrameV1

Raises an exception This class cannot be instantiated from Python

data((FrameV1)arg1) → numpy.ndarray
readoutTime((FrameV1)arg1) → float
shotIdStart((FrameV1)arg1) → int
temperature((FrameV1)arg1) → float
TypeId = 81
Version = 1

Module psana.PNCCD

The Python wrapper module for PNCCD types

Class psana.PNCCD.ConfigV1

class psana.PNCCD.ConfigV1

pnCCD configuration class ConfigV1

Raises an exception This class cannot be instantiated from Python

Number of links in the pnCCD.

Size of the payload in bytes for single link

TypeId = 12
Version = 1

Class psana.PNCCD.ConfigV2

class psana.PNCCD.ConfigV2

pnCCD configuration class ConfigV2

Raises an exception This class cannot be instantiated from Python

camexMagic((ConfigV2)arg1) → int :

Magic word from CAMEX

info((ConfigV2)arg1) → str :

Information data string

info_shape((ConfigV2)arg1) → object
numChannels((ConfigV2)arg1) → int :

Number of channels

Number of links in the pnCCD.

numRows((ConfigV2)arg1) → int :

Number of rows

numSubmoduleChannels((ConfigV2)arg1) → int :

Number of submodule channels

numSubmoduleRows((ConfigV2)arg1) → int :

Number of submodule rows

numSubmodules((ConfigV2)arg1) → int :

Number of submodules

Size of the payload in bytes for single link

timingFName((ConfigV2)arg1) → str :

Timing file name string

timingFName_shape((ConfigV2)arg1) → object
TypeId = 12
Version = 2

Class psana.PNCCD.FramesV1

class psana.PNCCD.FramesV1

pnCCD class FramesV1 which is a collection of FrameV1 objects, number of frames in collection is determined by numLinks() method (which should return 4 in most cases). This class does not exist in original pdsdata, has been introduced to psana to help in organizing 4 small pnCCD frames together.

Raises an exception This class cannot be instantiated from Python

frame((FramesV1)arg1, (int)arg2) → FrameV1 :

Number of frames is determined by numLinks() method.

frame_shape((FramesV1)arg1) → object
TypeId = 11
Version = 1

Class psana.PNCCD.FrameV1

class psana.PNCCD.FrameV1

pnCCD class FrameV1, this is a class which is defined by origianl pdsdata package.

Raises an exception This class cannot be instantiated from Python

_data((FrameV1)arg1) → numpy.ndarray :

Frame data

data((FrameV1)arg1) → numpy.ndarray
frameNumber((FrameV1)arg1) → int :

Frame number

specialWord((FrameV1)arg1) → int :

Special values

timeStampHi((FrameV1)arg1) → int :

Most significant part of timestamp

timeStampLo((FrameV1)arg1) → int :

Least significant part of timestamp

Class psana.PNCCD.FullFrameV1

class psana.PNCCD.FullFrameV1

This is a “synthetic” pnCCD frame which is four original 512x512 frames glued together. This class does not exist in original pdsdata, it has been introduced to psana to simplify access to full frame data in the user code.

Raises an exception This class cannot be instantiated from Python

data((FullFrameV1)arg1) → numpy.ndarray :

Full frame data, image size is 1024x1024.

frameNumber((FullFrameV1)arg1) → int :

Frame number

specialWord((FullFrameV1)arg1) → int :

Special values

timeStampHi((FullFrameV1)arg1) → int :

Most significant part of timestamp

timeStampLo((FullFrameV1)arg1) → int :

Least significant part of timestamp

TypeId = 11
Version = 1

Module psana.Princeton

The Python wrapper module for Princeton types

Class psana.Princeton.ConfigV1

class psana.Princeton.ConfigV1

Raises an exception This class cannot be instantiated from Python

binX((ConfigV1)arg1) → int
binY((ConfigV1)arg1) → int
coolingTemp((ConfigV1)arg1) → float
delayMode((ConfigV1)arg1) → int
exposureTime((ConfigV1)arg1) → float
frameSize((ConfigV1)arg1) → int :

Total size in bytes of the Frame object including header and pixel data, this returns the size of FrameV1 object, do not use this config type with FrameV2

height((ConfigV1)arg1) → int
numPixels((ConfigV1)arg1) → int :

calculate total frame size in pixels based on the current ROI and binning settings

numPixelsX((ConfigV1)arg1) → int :

calculate frame X size in pixels based on the current ROI and binning settings

numPixelsY((ConfigV1)arg1) → int :

calculate frame Y size in pixels based on the current ROI and binning settings

orgX((ConfigV1)arg1) → int
orgY((ConfigV1)arg1) → int
readoutEventCode((ConfigV1)arg1) → int
readoutSpeedIndex((ConfigV1)arg1) → int
width((ConfigV1)arg1) → int
TypeId = 18
Version = 1

Class psana.Princeton.ConfigV2

class psana.Princeton.ConfigV2

Raises an exception This class cannot be instantiated from Python

binX((ConfigV2)arg1) → int
binY((ConfigV2)arg1) → int
coolingTemp((ConfigV2)arg1) → float
delayMode((ConfigV2)arg1) → int
exposureTime((ConfigV2)arg1) → float
frameSize((ConfigV2)arg1) → int :

Total size in bytes of the Frame object including header and pixel data, this returns the size of FrameV1 object, do not use this config type with FrameV2

gainIndex((ConfigV2)arg1) → int
height((ConfigV2)arg1) → int
numPixels((ConfigV2)arg1) → int :

calculate total frame size in pixels based on the current ROI and binning settings

numPixelsX((ConfigV2)arg1) → int :

calculate frame X size in pixels based on the current ROI and binning settings

numPixelsY((ConfigV2)arg1) → int :

calculate frame Y size in pixels based on the current ROI and binning settings

orgX((ConfigV2)arg1) → int
orgY((ConfigV2)arg1) → int
readoutEventCode((ConfigV2)arg1) → int
readoutSpeedIndex((ConfigV2)arg1) → int
width((ConfigV2)arg1) → int
TypeId = 18
Version = 2

Class psana.Princeton.ConfigV3

class psana.Princeton.ConfigV3

Raises an exception This class cannot be instantiated from Python

binX((ConfigV3)arg1) → int
binY((ConfigV3)arg1) → int
coolingTemp((ConfigV3)arg1) → float
exposureEventCode((ConfigV3)arg1) → int
exposureTime((ConfigV3)arg1) → float
frameSize((ConfigV3)arg1) → int :

Total size in bytes of the Frame object including header and pixel data, this returns the size of FrameV1 object, do not use this config type with FrameV2

gainIndex((ConfigV3)arg1) → int
height((ConfigV3)arg1) → int
numDelayShots((ConfigV3)arg1) → int
numPixels((ConfigV3)arg1) → int :

calculate total frame size in pixels based on the current ROI and binning settings

numPixelsX((ConfigV3)arg1) → int :

calculate frame X size in pixels based on the current ROI and binning settings

numPixelsY((ConfigV3)arg1) → int :

calculate frame Y size in pixels based on the current ROI and binning settings

orgX((ConfigV3)arg1) → int
orgY((ConfigV3)arg1) → int
readoutSpeedIndex((ConfigV3)arg1) → int
width((ConfigV3)arg1) → int
TypeId = 18
Version = 3

Class psana.Princeton.ConfigV4

class psana.Princeton.ConfigV4

Raises an exception This class cannot be instantiated from Python

binX((ConfigV4)arg1) → int
binY((ConfigV4)arg1) → int
coolingTemp((ConfigV4)arg1) → float
exposureEventCode((ConfigV4)arg1) → int
exposureTime((ConfigV4)arg1) → float
frameSize((ConfigV4)arg1) → int :

Total size in bytes of the Frame object including header and pixel data, this returns the size of FrameV1 object, do not use this config type with FrameV2

gainIndex((ConfigV4)arg1) → int
height((ConfigV4)arg1) → int
kineticHeight((ConfigV4)arg1) → int
maskedHeight((ConfigV4)arg1) → int
numDelayShots((ConfigV4)arg1) → int
numPixels((ConfigV4)arg1) → int :

calculate total frame size in pixels based on the current ROI and binning settings

numPixelsX((ConfigV4)arg1) → int :

calculate frame X size in pixels based on the current ROI and binning settings

numPixelsY((ConfigV4)arg1) → int :

calculate frame Y size in pixels based on the current ROI and binning settings

orgX((ConfigV4)arg1) → int
orgY((ConfigV4)arg1) → int
readoutSpeedIndex((ConfigV4)arg1) → int
vsSpeed((ConfigV4)arg1) → float
width((ConfigV4)arg1) → int
TypeId = 18
Version = 4

Class psana.Princeton.ConfigV5

class psana.Princeton.ConfigV5

Raises an exception This class cannot be instantiated from Python

binX((ConfigV5)arg1) → int
binY((ConfigV5)arg1) → int
coolingTemp((ConfigV5)arg1) → float
exposureEventCode((ConfigV5)arg1) → int
exposureTime((ConfigV5)arg1) → float
frameSize((ConfigV5)arg1) → int :

Total size in bytes of the Frame object including header and pixel data, this returns the size of FrameV2 object, do not use this config type with FrameV1

gainIndex((ConfigV5)arg1) → int
height((ConfigV5)arg1) → int
infoReportInterval((ConfigV5)arg1) → int
kineticHeight((ConfigV5)arg1) → int
maskedHeight((ConfigV5)arg1) → int
numDelayShots((ConfigV5)arg1) → int
numPixels((ConfigV5)arg1) → int :

calculate total frame size in pixels based on the current ROI and binning settings

numPixelsX((ConfigV5)arg1) → int :

calculate frame X size in pixels based on the current ROI and binning settings

numPixelsY((ConfigV5)arg1) → int :

calculate frame Y size in pixels based on the current ROI and binning settings

orgX((ConfigV5)arg1) → int
orgY((ConfigV5)arg1) → int
readoutSpeedIndex((ConfigV5)arg1) → int
vsSpeed((ConfigV5)arg1) → float
width((ConfigV5)arg1) → int
TypeId = 18
Version = 5

Class psana.Princeton.FrameV1

class psana.Princeton.FrameV1

Raises an exception This class cannot be instantiated from Python

data((FrameV1)arg1) → numpy.ndarray
readoutTime((FrameV1)arg1) → float
shotIdStart((FrameV1)arg1) → int
TypeId = 17
Version = 1

Class psana.Princeton.FrameV2

class psana.Princeton.FrameV2

Raises an exception This class cannot be instantiated from Python

data((FrameV2)arg1) → numpy.ndarray
readoutTime((FrameV2)arg1) → float
shotIdStart((FrameV2)arg1) → int
temperature((FrameV2)arg1) → float
TypeId = 17
Version = 2

Class psana.Princeton.InfoV1

class psana.Princeton.InfoV1

Raises an exception This class cannot be instantiated from Python

temperature((InfoV1)arg1) → float
TypeId = 27
Version = 1

Module psana.Pulnix

The Python wrapper module for Pulnix types

Class psana.Pulnix.TM6740ConfigV1

class psana.Pulnix.TM6740ConfigV1

Raises an exception This class cannot be instantiated from Python

class Binning
names = {'x2': psana.Pulnix.Binning.x2, 'x1': psana.Pulnix.Binning.x1, 'x4': psana.Pulnix.Binning.x4}
values = {0: psana.Pulnix.Binning.x1, 1: psana.Pulnix.Binning.x2, 2: psana.Pulnix.Binning.x4}
x1 = psana.Pulnix.Binning.x1
x2 = psana.Pulnix.Binning.x2
x4 = psana.Pulnix.Binning.x4
class TM6740ConfigV1.Depth
Eight_bit = psana.Pulnix.Depth.Eight_bit
Ten_bit = psana.Pulnix.Depth.Ten_bit
names = {'Eight_bit': psana.Pulnix.Depth.Eight_bit, 'Ten_bit': psana.Pulnix.Depth.Ten_bit}
values = {0: psana.Pulnix.Depth.Eight_bit, 1: psana.Pulnix.Depth.Ten_bit}
class TM6740ConfigV1.LookupTable
Gamma = psana.Pulnix.LookupTable.Gamma
Linear = psana.Pulnix.LookupTable.Linear
names = {'Linear': psana.Pulnix.LookupTable.Linear, 'Gamma': psana.Pulnix.LookupTable.Gamma}
values = {0: psana.Pulnix.LookupTable.Gamma, 1: psana.Pulnix.LookupTable.Linear}
TM6740ConfigV1.gain_a((TM6740ConfigV1)arg1) → int
TM6740ConfigV1.gain_b((TM6740ConfigV1)arg1) → int
TM6740ConfigV1.gain_balance((TM6740ConfigV1)arg1) → int
TM6740ConfigV1.horizontal_binning((TM6740ConfigV1)arg1) → Binning
TM6740ConfigV1.lookuptable_mode((TM6740ConfigV1)arg1) → LookupTable
TM6740ConfigV1.output_resolution((TM6740ConfigV1)arg1) → Depth
TM6740ConfigV1.output_resolution_bits((TM6740ConfigV1)arg1) → int :

bit-depth of pixel counts

TM6740ConfigV1.shutter_width((TM6740ConfigV1)arg1) → int
TM6740ConfigV1.vertical_binning((TM6740ConfigV1)arg1) → Binning
TM6740ConfigV1.vref((TM6740ConfigV1)arg1) → int
TM6740ConfigV1.Column_Pixels = 640
TM6740ConfigV1.Row_Pixels = 480
TM6740ConfigV1.TypeId = 9
TM6740ConfigV1.Version = 1

Class psana.Pulnix.TM6740ConfigV2

class psana.Pulnix.TM6740ConfigV2

Raises an exception This class cannot be instantiated from Python

class Binning
names = {'x2': psana.Pulnix.Binning.x2, 'x1': psana.Pulnix.Binning.x1, 'x4': psana.Pulnix.Binning.x4}
values = {0: psana.Pulnix.Binning.x1, 1: psana.Pulnix.Binning.x2, 2: psana.Pulnix.Binning.x4}
x1 = psana.Pulnix.Binning.x1
x2 = psana.Pulnix.Binning.x2
x4 = psana.Pulnix.Binning.x4
class TM6740ConfigV2.Depth
Eight_bit = psana.Pulnix.Depth.Eight_bit
Ten_bit = psana.Pulnix.Depth.Ten_bit
names = {'Eight_bit': psana.Pulnix.Depth.Eight_bit, 'Ten_bit': psana.Pulnix.Depth.Ten_bit}
values = {0: psana.Pulnix.Depth.Eight_bit, 1: psana.Pulnix.Depth.Ten_bit}
class TM6740ConfigV2.LookupTable
Gamma = psana.Pulnix.LookupTable.Gamma
Linear = psana.Pulnix.LookupTable.Linear
names = {'Linear': psana.Pulnix.LookupTable.Linear, 'Gamma': psana.Pulnix.LookupTable.Gamma}
values = {0: psana.Pulnix.LookupTable.Gamma, 1: psana.Pulnix.LookupTable.Linear}
TM6740ConfigV2.gain_a((TM6740ConfigV2)arg1) → int
TM6740ConfigV2.gain_b((TM6740ConfigV2)arg1) → int
TM6740ConfigV2.gain_balance((TM6740ConfigV2)arg1) → int
TM6740ConfigV2.horizontal_binning((TM6740ConfigV2)arg1) → Binning
TM6740ConfigV2.lookuptable_mode((TM6740ConfigV2)arg1) → LookupTable
TM6740ConfigV2.output_resolution((TM6740ConfigV2)arg1) → Depth
TM6740ConfigV2.output_resolution_bits((TM6740ConfigV2)arg1) → int :

bit-depth of pixel counts

TM6740ConfigV2.vertical_binning((TM6740ConfigV2)arg1) → Binning
TM6740ConfigV2.vref_a((TM6740ConfigV2)arg1) → int
TM6740ConfigV2.vref_b((TM6740ConfigV2)arg1) → int
TM6740ConfigV2.Column_Pixels = 640
TM6740ConfigV2.Row_Pixels = 480
TM6740ConfigV2.TypeId = 9
TM6740ConfigV2.Version = 2

Module psana.Quartz

The Python wrapper module for Quartz types

Class psana.Quartz.ConfigV1

class psana.Quartz.ConfigV1

Raises an exception This class cannot be instantiated from Python

class Binning
names = {'x2': psana.Quartz.Binning.x2, 'x1': psana.Quartz.Binning.x1, 'x4': psana.Quartz.Binning.x4}
values = {0: psana.Quartz.Binning.x1, 1: psana.Quartz.Binning.x2, 2: psana.Quartz.Binning.x4}
x1 = psana.Quartz.Binning.x1
x2 = psana.Quartz.Binning.x2
x4 = psana.Quartz.Binning.x4
class ConfigV1.Depth
Eight_bit = psana.Quartz.Depth.Eight_bit
Ten_bit = psana.Quartz.Depth.Ten_bit
names = {'Eight_bit': psana.Quartz.Depth.Eight_bit, 'Ten_bit': psana.Quartz.Depth.Ten_bit}
values = {0: psana.Quartz.Depth.Eight_bit, 1: psana.Quartz.Depth.Ten_bit}
class ConfigV1.Mirroring
HFlip = psana.Quartz.Mirroring.HFlip
HVFlip = psana.Quartz.Mirroring.HVFlip
None = psana.Quartz.Mirroring.None
VFlip = psana.Quartz.Mirroring.VFlip
names = {'None': psana.Quartz.Mirroring.None, 'HFlip': psana.Quartz.Mirroring.HFlip, 'HVFlip': psana.Quartz.Mirroring.HVFlip, 'VFlip': psana.Quartz.Mirroring.VFlip}
values = {0: psana.Quartz.Mirroring.None, 1: psana.Quartz.Mirroring.HFlip, 2: psana.Quartz.Mirroring.VFlip, 3: psana.Quartz.Mirroring.HVFlip}
ConfigV1.black_level((ConfigV1)arg1) → int :

offset/pedestal setting for camera (before gain)

ConfigV1.defect_pixel_coordinates((ConfigV1)arg1) → list
ConfigV1.defect_pixel_correction_enabled((ConfigV1)arg1) → int :

correct defective pixels internally

ConfigV1.gain_percent((ConfigV1)arg1) → int :

camera gain setting in percentile [100-3200] = [1x-32x]

ConfigV1.horizontal_binning((ConfigV1)arg1) → Binning :

horizontal re-binning of output (consecutive rows summed)

ConfigV1.number_of_defect_pixels((ConfigV1)arg1) → int
ConfigV1.output_lookup_table((ConfigV1)arg1) → numpy.ndarray
ConfigV1.output_lookup_table_enabled((ConfigV1)arg1) → int :

apply output lookup table corrections

ConfigV1.output_mirroring((ConfigV1)arg1) → Mirroring :

geometric transformation of the image

ConfigV1.output_offset((ConfigV1)arg1) → int :

offset/pedestal value in pixel counts

ConfigV1.output_resolution((ConfigV1)arg1) → Depth :

bit-depth of pixel counts

ConfigV1.output_resolution_bits((ConfigV1)arg1) → int :

bit-depth of pixel counts

ConfigV1.vertical_binning((ConfigV1)arg1) → Binning :

vertical re-binning of output (consecutive rows summed)

ConfigV1.Column_Pixels = 2048
ConfigV1.LUT_Size = 4096
ConfigV1.Output_LUT_Size = 4096
ConfigV1.Row_Pixels = 2048
ConfigV1.TypeId = 57
ConfigV1.Version = 1

Class psana.Quartz.ConfigV2

class psana.Quartz.ConfigV2

Raises an exception This class cannot be instantiated from Python

class Binning
names = {'x2': psana.Quartz.Binning.x2, 'x1': psana.Quartz.Binning.x1, 'x4': psana.Quartz.Binning.x4}
values = {0: psana.Quartz.Binning.x1, 1: psana.Quartz.Binning.x2, 2: psana.Quartz.Binning.x4}
x1 = psana.Quartz.Binning.x1
x2 = psana.Quartz.Binning.x2
x4 = psana.Quartz.Binning.x4
class ConfigV2.Depth
Eight_bit = psana.Quartz.Depth.Eight_bit
Ten_bit = psana.Quartz.Depth.Ten_bit
names = {'Eight_bit': psana.Quartz.Depth.Eight_bit, 'Ten_bit': psana.Quartz.Depth.Ten_bit}
values = {0: psana.Quartz.Depth.Eight_bit, 1: psana.Quartz.Depth.Ten_bit}
class ConfigV2.Mirroring
HFlip = psana.Quartz.Mirroring.HFlip
HVFlip = psana.Quartz.Mirroring.HVFlip
None = psana.Quartz.Mirroring.None
VFlip = psana.Quartz.Mirroring.VFlip
names = {'None': psana.Quartz.Mirroring.None, 'HFlip': psana.Quartz.Mirroring.HFlip, 'HVFlip': psana.Quartz.Mirroring.HVFlip, 'VFlip': psana.Quartz.Mirroring.VFlip}
values = {0: psana.Quartz.Mirroring.None, 1: psana.Quartz.Mirroring.HFlip, 2: psana.Quartz.Mirroring.VFlip, 3: psana.Quartz.Mirroring.HVFlip}
ConfigV2.black_level((ConfigV2)arg1) → int :

offset/pedestal setting for camera (before gain)

ConfigV2.defect_pixel_coordinates((ConfigV2)arg1) → list
ConfigV2.defect_pixel_correction_enabled((ConfigV2)arg1) → int :

correct defective pixels internally

ConfigV2.gain_percent((ConfigV2)arg1) → int :

camera gain setting in percentile [100-3200] = [1x-32x]

ConfigV2.horizontal_binning((ConfigV2)arg1) → Binning :

horizontal re-binning of output (consecutive rows summed)

ConfigV2.max_taps((ConfigV2)arg1) → int :

maximum taps in output driver

ConfigV2.number_of_defect_pixels((ConfigV2)arg1) → int
ConfigV2.output_lookup_table((ConfigV2)arg1) → numpy.ndarray
ConfigV2.output_lookup_table_enabled((ConfigV2)arg1) → int :

apply output lookup table corrections

ConfigV2.output_mirroring((ConfigV2)arg1) → Mirroring :

geometric transformation of the image

ConfigV2.output_offset((ConfigV2)arg1) → int :

offset/pedestal value in pixel counts

ConfigV2.output_resolution((ConfigV2)arg1) → Depth :

bit-depth of pixel counts

ConfigV2.output_resolution_bits((ConfigV2)arg1) → int :

bit-depth of pixel counts

ConfigV2.roi_hi((ConfigV2)arg1) → FrameCoord :

hardware ROI end

ConfigV2.roi_lo((ConfigV2)arg1) → FrameCoord :

hardware ROI begin

ConfigV2.use_hardware_roi((ConfigV2)arg1) → int :

enable hardware region of interest

ConfigV2.use_test_pattern((ConfigV2)arg1) → int :

enable the test pattern

ConfigV2.vertical_binning((ConfigV2)arg1) → Binning :

vertical re-binning of output (consecutive rows summed)

ConfigV2.Column_Pixels = 2048
ConfigV2.LUT_Size = 4096
ConfigV2.Output_LUT_Size = 4096
ConfigV2.Row_Pixels = 2048
ConfigV2.TypeId = 57
ConfigV2.Version = 2

Module psana.Rayonix

The Python wrapper module for Rayonix types

Class psana.Rayonix.ConfigV1

class psana.Rayonix.ConfigV1

Raises an exception This class cannot be instantiated from Python

class ReadoutMode
EDR = psana.Rayonix.ReadoutMode.EDR
HighGain = psana.Rayonix.ReadoutMode.HighGain
LowNoise = psana.Rayonix.ReadoutMode.LowNoise
Standard = psana.Rayonix.ReadoutMode.Standard
names = {'EDR': psana.Rayonix.ReadoutMode.EDR, 'LowNoise': psana.Rayonix.ReadoutMode.LowNoise, 'HighGain': psana.Rayonix.ReadoutMode.HighGain, 'Standard': psana.Rayonix.ReadoutMode.Standard}
values = {0: psana.Rayonix.ReadoutMode.Standard, 1: psana.Rayonix.ReadoutMode.HighGain, 2: psana.Rayonix.ReadoutMode.LowNoise, 3: psana.Rayonix.ReadoutMode.EDR}
ConfigV1.binning_f((ConfigV1)arg1) → int
ConfigV1.binning_s((ConfigV1)arg1) → int
ConfigV1.darkFlag((ConfigV1)arg1) → int
ConfigV1.deviceID((ConfigV1)arg1) → str
ConfigV1.exposure((ConfigV1)arg1) → int
ConfigV1.rawMode((ConfigV1)arg1) → int
ConfigV1.readoutMode((ConfigV1)arg1) → ReadoutMode
ConfigV1.trigger((ConfigV1)arg1) → int
ConfigV1.DeviceIDMax = 40
ConfigV1.TypeId = 73
ConfigV1.Version = 1

Class psana.Rayonix.ConfigV2

class psana.Rayonix.ConfigV2

Raises an exception This class cannot be instantiated from Python

class ReadoutMode
HDR = psana.Rayonix.ReadoutMode.HDR
HighGain = psana.Rayonix.ReadoutMode.HighGain
LowNoise = psana.Rayonix.ReadoutMode.LowNoise
Standard = psana.Rayonix.ReadoutMode.Standard
Unknown = psana.Rayonix.ReadoutMode.Unknown
names = {'HDR': psana.Rayonix.ReadoutMode.HDR, 'Unknown': psana.Rayonix.ReadoutMode.Unknown, 'LowNoise': psana.Rayonix.ReadoutMode.LowNoise, 'HighGain': psana.Rayonix.ReadoutMode.HighGain, 'Standard': psana.Rayonix.ReadoutMode.Standard}
values = {0: psana.Rayonix.ReadoutMode.Unknown, 1: psana.Rayonix.ReadoutMode.Standard, 2: psana.Rayonix.ReadoutMode.HighGain, 3: psana.Rayonix.ReadoutMode.LowNoise, 4: psana.Rayonix.ReadoutMode.HDR}
ConfigV2.binning_f((ConfigV2)arg1) → int
ConfigV2.binning_s((ConfigV2)arg1) → int
ConfigV2.darkFlag((ConfigV2)arg1) → int
ConfigV2.deviceID((ConfigV2)arg1) → str
ConfigV2.exposure((ConfigV2)arg1) → int
ConfigV2.rawMode((ConfigV2)arg1) → int
ConfigV2.readoutMode((ConfigV2)arg1) → ReadoutMode
ConfigV2.testPattern((ConfigV2)arg1) → int
ConfigV2.trigger((ConfigV2)arg1) → int
ConfigV2.DeviceIDMax = 40
ConfigV2.TypeId = 73
ConfigV2.Version = 2

Module psana.smalldata

existing issue to remember:

> How do people access _dlist_master for applications like psmon?

> user forgets to call save, they get a small but empty HDF5 – atexit – use a destructor: __del__ (prone to circular ref issues) – use “with” statement + __exit__ (may affect interface)

> metadata – docstrings for default values – user interface for adding attributes/info/units (e.g. smld.attribute(a=’a is great’)) – xarray compatability?

> chunking for performance?

>>> from Silke
- storing extra "attributes" or datasets with stuff like ROI (like summary/config field)
- think about cube problem
- user-controlled mode for event distribution (e.g. based on delay-time)
- always write detectors like phasecav
>>> xarray thoughts from Jason:
- coordinates/attributes for everything, using h5netcdf
- for analyzing the small-data: xarray makes it easy to select/filter,
  and will keep track of coordinates for you
- can use pandas for plotting and packages like seaborn (stat plotting)
  with these coordinate arrays
- the xarray coordinates will provide the time sorting
- wildcard to merge multiple files
- didn't support variable length data? (maybe can do this)
- treats NaNs correctly
- would merge fast and slow detectors (e.g. eventcode 40 and 42)
- handles dropped data
- not clear that xarray can write pieces while taking data?
- probably supports hierarchy of hdf5 groups in h5netcdf, but might
  make it more difficult to cut/merge/sort in xarray

Class psana.smalldata.SmallData

class psana.smalldata.SmallData(datasource_parent, filename=None, save_on_gather=False)[source]
On master,
  • numbers (int/float) are lists of arrays, representing workers (items in the list) and events (items in the array)
  • arrays are lists of lists (!) of arrays, representing workers (items in the outter list) and events (items in the inner list) and values of the original array (arrays)
gather_interval : int
The number of events a single process must see before the results get gathered for processing. If None, then only gather results when save is called.
save_on_gather : bool
Whether to save the results to disk periodically (after the results get gathered)
_backfill_client(target_events, dlist_element, key)[source]
static _backfill_master(target_events, dlist_element, fill_value)[source]
_dlist_append(dlist, key, value)[source]
_dlist_append_client(key, value)[source]
_event_default()[source]

Cherry-picked machine parameters we think will be useful for basically every experiment

_gather()[source]

Gather arrays and numbers from all MPI ranks.

_gather_arrays(array_list, key)[source]

Gather arrays from all workers and update the master’s dlist

_gather_numbers(num_list, key)[source]
_get_node(k)[source]

Retrieve or create (if necessary) the pytables node for a specific key.

_initialize_default_detectors()[source]
_mpi_reduce(value, function)[source]
static _num_or_array(obj)[source]
_save(*args, **kwargs)[source]
_sort(obj, sort_order)[source]

sort obj, an array or list, by sort_order in dim -1, IN PLACE

close()[source]

Close the HDF5 file used for writing.

event(*args, **kwargs)[source]

Save some data from this event for later use.

*args : dictionaries
Save HDF5 group heirarchies using nested dictionaries. Each level of the dictionary is a level in the HDF5 group heirarchy.
**kwargs : datasetname, dataset
Save an arbitrary piece of data from this run. The kwarg will give it an (HDF5 dataset) name that appears in the resulting HDF5 file.
>>> # save the status of a laser
>>> smldata.event(laser_on=laser_on)
>>> # save "data' at a special location "/base/next_group/data"
>>> smldata.event({'base': {'next_group' : data}})
max(value)[source]
min(value)[source]
missing(key)[source]

Use the send_list to figure out the correct types and fill values for missing data

save(*args, **kwargs)[source]

Save registered data to an HDF5 file.

There are 3 behaviors of the arguments to this function:

  1. Decide what ‘event data’ (declared by SmallData.event()) should be saved
  2. Add summary (ie. any non-event) data using key-value pairs (similar to SmallData.event())
  3. Add summary (ie. any non-event) data organized in a heirarchy using nested dictionaries (als similar to SmallData.event())

These data are then saved to the file specifed in the SmallData constructor.

*args : strings
A list of the event data names to save, if you want to save a subset. Otherwise save all data to disk. For example, imagine you had called SmallData.event(a=..., b=...). Then smldata.save(‘b’) would not save data labelled ‘a’. smldata.save() would save both ‘a’ and ‘b’.
*args : dictionaries
In direct analogy to the SmallData.event call, you can also pass HDF5 group heirarchies using nested dictionaries. Each level of the dictionary is a level in the HDF5 group heirarchy.
**kwargs : datasetname, dataset
Similar to SmallData.event, it is possible to save arbitrary singleton data (e.g. at the end of a run, to save an average over some quanitity).
event_data : bool
Special kwarg. If False, do not save the event data, just the run summary data. If True (default), do.
>>> # save all event data
>>> smldata.save()
>>> # save all event data AND "array_containing_sum"
>>> smldata.save(cspad_sum=array_containing_sum)
>>> # save 'b' event data, and no other
>>> smldata.save('b')
>>> # save all event data AND "/base/next_group/data"
>>> smldata.save({'base': {'next_group' : data}})
sum(value)[source]
_nevents
_nevents_on_disk
currevt
master

Class psana.smalldata.SynchDict

class psana.smalldata.SynchDict[source]

Class used to keep track of all arrays that need to be gathered (a.k.a. “send_list”). This dictionary is synched before every call to gather.

keys()[source]
synchronize()[source]

Function psana.smalldata.remove_values

psana.smalldata.remove_values(the_list, val)[source]

Module psana.SmlData

The Python wrapper module for SmlData types

Class psana.SmlData.ConfigV1

class psana.SmlData.ConfigV1

Raises an exception This class cannot be instantiated from Python

sizeThreshold((ConfigV1)arg1) → int
TypeId = 89
Version = 1

Class psana.SmlData.OrigDgramOffsetV1

class psana.SmlData.OrigDgramOffsetV1

Raises an exception This class cannot be instantiated from Python

extent((OrigDgramOffsetV1)arg1) → int
fileOffset((OrigDgramOffsetV1)arg1) → int
TypeId = 90
Version = 1

Class psana.SmlData.ProxyV1

class psana.SmlData.ProxyV1

Raises an exception This class cannot be instantiated from Python

extent((ProxyV1)arg1) → int
fileOffset((ProxyV1)arg1) → int
type((ProxyV1)arg1) → object
TypeId = 91
Version = 1

Module psana.Timepix

The Python wrapper module for Timepix types

Class psana.Timepix.ConfigV1

class psana.Timepix.ConfigV1

Raises an exception This class cannot be instantiated from Python

class ReadoutSpeed
ReadoutSpeed_Fast = psana.Timepix.ReadoutSpeed.ReadoutSpeed_Fast
ReadoutSpeed_Slow = psana.Timepix.ReadoutSpeed.ReadoutSpeed_Slow
names = {'ReadoutSpeed_Slow': psana.Timepix.ReadoutSpeed.ReadoutSpeed_Slow, 'ReadoutSpeed_Fast': psana.Timepix.ReadoutSpeed.ReadoutSpeed_Fast}
values = {0: psana.Timepix.ReadoutSpeed.ReadoutSpeed_Slow, 1: psana.Timepix.ReadoutSpeed.ReadoutSpeed_Fast}
class ConfigV1.TriggerMode
TriggerMode_ExtNeg = psana.Timepix.TriggerMode.TriggerMode_ExtNeg
TriggerMode_ExtPos = psana.Timepix.TriggerMode.TriggerMode_ExtPos
TriggerMode_Soft = psana.Timepix.TriggerMode.TriggerMode_Soft
names = {'TriggerMode_ExtNeg': psana.Timepix.TriggerMode.TriggerMode_ExtNeg, 'TriggerMode_Soft': psana.Timepix.TriggerMode.TriggerMode_Soft, 'TriggerMode_ExtPos': psana.Timepix.TriggerMode.TriggerMode_ExtPos}
values = {0: psana.Timepix.TriggerMode.TriggerMode_ExtPos, 1: psana.Timepix.TriggerMode.TriggerMode_ExtNeg, 2: psana.Timepix.TriggerMode.TriggerMode_Soft}
ConfigV1.dac0BiasLvds((ConfigV1)arg1) → int
ConfigV1.dac0BufAnalogA((ConfigV1)arg1) → int
ConfigV1.dac0BufAnalogB((ConfigV1)arg1) → int
ConfigV1.dac0Disc((ConfigV1)arg1) → int
ConfigV1.dac0Fbk((ConfigV1)arg1) → int
ConfigV1.dac0Gnd((ConfigV1)arg1) → int
ConfigV1.dac0Hist((ConfigV1)arg1) → int
ConfigV1.dac0Ikrum((ConfigV1)arg1) → int
ConfigV1.dac0Preamp((ConfigV1)arg1) → int
ConfigV1.dac0RefLvds((ConfigV1)arg1) → int
ConfigV1.dac0ThlCourse((ConfigV1)arg1) → int
ConfigV1.dac0ThlFine((ConfigV1)arg1) → int
ConfigV1.dac0Ths((ConfigV1)arg1) → int
ConfigV1.dac0Vcas((ConfigV1)arg1) → int
ConfigV1.dac1BiasLvds((ConfigV1)arg1) → int
ConfigV1.dac1BufAnalogA((ConfigV1)arg1) → int
ConfigV1.dac1BufAnalogB((ConfigV1)arg1) → int
ConfigV1.dac1Disc((ConfigV1)arg1) → int
ConfigV1.dac1Fbk((ConfigV1)arg1) → int
ConfigV1.dac1Gnd((ConfigV1)arg1) → int
ConfigV1.dac1Hist((ConfigV1)arg1) → int
ConfigV1.dac1Ikrum((ConfigV1)arg1) → int
ConfigV1.dac1Preamp((ConfigV1)arg1) → int
ConfigV1.dac1RefLvds((ConfigV1)arg1) → int
ConfigV1.dac1ThlCourse((ConfigV1)arg1) → int
ConfigV1.dac1ThlFine((ConfigV1)arg1) → int
ConfigV1.dac1Ths((ConfigV1)arg1) → int
ConfigV1.dac1Vcas((ConfigV1)arg1) → int
ConfigV1.dac2BiasLvds((ConfigV1)arg1) → int
ConfigV1.dac2BufAnalogA((ConfigV1)arg1) → int
ConfigV1.dac2BufAnalogB((ConfigV1)arg1) → int
ConfigV1.dac2Disc((ConfigV1)arg1) → int
ConfigV1.dac2Fbk((ConfigV1)arg1) → int
ConfigV1.dac2Gnd((ConfigV1)arg1) → int
ConfigV1.dac2Hist((ConfigV1)arg1) → int
ConfigV1.dac2Ikrum((ConfigV1)arg1) → int
ConfigV1.dac2Preamp((ConfigV1)arg1) → int
ConfigV1.dac2RefLvds((ConfigV1)arg1) → int
ConfigV1.dac2ThlCourse((ConfigV1)arg1) → int
ConfigV1.dac2ThlFine((ConfigV1)arg1) → int
ConfigV1.dac2Ths((ConfigV1)arg1) → int
ConfigV1.dac2Vcas((ConfigV1)arg1) → int
ConfigV1.dac3BiasLvds((ConfigV1)arg1) → int
ConfigV1.dac3BufAnalogA((ConfigV1)arg1) → int
ConfigV1.dac3BufAnalogB((ConfigV1)arg1) → int
ConfigV1.dac3Disc((ConfigV1)arg1) → int
ConfigV1.dac3Fbk((ConfigV1)arg1) → int
ConfigV1.dac3Gnd((ConfigV1)arg1) → int
ConfigV1.dac3Hist((ConfigV1)arg1) → int
ConfigV1.dac3Ikrum((ConfigV1)arg1) → int
ConfigV1.dac3Preamp((ConfigV1)arg1) → int
ConfigV1.dac3RefLvds((ConfigV1)arg1) → int
ConfigV1.dac3ThlCourse((ConfigV1)arg1) → int
ConfigV1.dac3ThlFine((ConfigV1)arg1) → int
ConfigV1.dac3Ths((ConfigV1)arg1) → int
ConfigV1.dac3Vcas((ConfigV1)arg1) → int
ConfigV1.readoutSpeed((ConfigV1)arg1) → ReadoutSpeed
ConfigV1.shutterTimeout((ConfigV1)arg1) → int
ConfigV1.triggerMode((ConfigV1)arg1) → TriggerMode
ConfigV1.ChipCount = 4
ConfigV1.TypeId = 49
ConfigV1.Version = 1

Class psana.Timepix.ConfigV2

class psana.Timepix.ConfigV2

Raises an exception This class cannot be instantiated from Python

class ReadoutSpeed
ReadoutSpeed_Fast = psana.Timepix.ReadoutSpeed.ReadoutSpeed_Fast
ReadoutSpeed_Slow = psana.Timepix.ReadoutSpeed.ReadoutSpeed_Slow
names = {'ReadoutSpeed_Slow': psana.Timepix.ReadoutSpeed.ReadoutSpeed_Slow, 'ReadoutSpeed_Fast': psana.Timepix.ReadoutSpeed.ReadoutSpeed_Fast}
values = {0: psana.Timepix.ReadoutSpeed.ReadoutSpeed_Slow, 1: psana.Timepix.ReadoutSpeed.ReadoutSpeed_Fast}
class ConfigV2.TriggerMode
TriggerMode_ExtNeg = psana.Timepix.TriggerMode.TriggerMode_ExtNeg
TriggerMode_ExtPos = psana.Timepix.TriggerMode.TriggerMode_ExtPos
TriggerMode_Soft = psana.Timepix.TriggerMode.TriggerMode_Soft
names = {'TriggerMode_ExtNeg': psana.Timepix.TriggerMode.TriggerMode_ExtNeg, 'TriggerMode_Soft': psana.Timepix.TriggerMode.TriggerMode_Soft, 'TriggerMode_ExtPos': psana.Timepix.TriggerMode.TriggerMode_ExtPos}
values = {0: psana.Timepix.TriggerMode.TriggerMode_ExtPos, 1: psana.Timepix.TriggerMode.TriggerMode_ExtNeg, 2: psana.Timepix.TriggerMode.TriggerMode_Soft}
ConfigV2.chip0ID((ConfigV2)arg1) → int
ConfigV2.chip0Name((ConfigV2)arg1) → str
ConfigV2.chip1ID((ConfigV2)arg1) → int
ConfigV2.chip1Name((ConfigV2)arg1) → str
ConfigV2.chip2ID((ConfigV2)arg1) → int
ConfigV2.chip2Name((ConfigV2)arg1) → str
ConfigV2.chip3ID((ConfigV2)arg1) → int
ConfigV2.chip3Name((ConfigV2)arg1) → str
ConfigV2.chipCount((ConfigV2)arg1) → int
ConfigV2.dac0BiasLvds((ConfigV2)arg1) → int
ConfigV2.dac0BufAnalogA((ConfigV2)arg1) → int
ConfigV2.dac0BufAnalogB((ConfigV2)arg1) → int
ConfigV2.dac0Disc((ConfigV2)arg1) → int
ConfigV2.dac0Fbk((ConfigV2)arg1) → int
ConfigV2.dac0Gnd((ConfigV2)arg1) → int
ConfigV2.dac0Hist((ConfigV2)arg1) → int
ConfigV2.dac0Ikrum((ConfigV2)arg1) → int
ConfigV2.dac0Preamp((ConfigV2)arg1) → int
ConfigV2.dac0RefLvds((ConfigV2)arg1) → int
ConfigV2.dac0ThlCourse((ConfigV2)arg1) → int
ConfigV2.dac0ThlFine((ConfigV2)arg1) → int
ConfigV2.dac0Ths((ConfigV2)arg1) → int
ConfigV2.dac0Vcas((ConfigV2)arg1) → int
ConfigV2.dac1BiasLvds((ConfigV2)arg1) → int
ConfigV2.dac1BufAnalogA((ConfigV2)arg1) → int
ConfigV2.dac1BufAnalogB((ConfigV2)arg1) → int
ConfigV2.dac1Disc((ConfigV2)arg1) → int
ConfigV2.dac1Fbk((ConfigV2)arg1) → int
ConfigV2.dac1Gnd((ConfigV2)arg1) → int
ConfigV2.dac1Hist((ConfigV2)arg1) → int
ConfigV2.dac1Ikrum((ConfigV2)arg1) → int
ConfigV2.dac1Preamp((ConfigV2)arg1) → int
ConfigV2.dac1RefLvds((ConfigV2)arg1) → int
ConfigV2.dac1ThlCourse((ConfigV2)arg1) → int
ConfigV2.dac1ThlFine((ConfigV2)arg1) → int
ConfigV2.dac1Ths((ConfigV2)arg1) → int
ConfigV2.dac1Vcas((ConfigV2)arg1) → int
ConfigV2.dac2BiasLvds((ConfigV2)arg1) → int
ConfigV2.dac2BufAnalogA((ConfigV2)arg1) → int
ConfigV2.dac2BufAnalogB((ConfigV2)arg1) → int
ConfigV2.dac2Disc((ConfigV2)arg1) → int
ConfigV2.dac2Fbk((ConfigV2)arg1) → int
ConfigV2.dac2Gnd((ConfigV2)arg1) → int
ConfigV2.dac2Hist((ConfigV2)arg1) → int
ConfigV2.dac2Ikrum((ConfigV2)arg1) → int
ConfigV2.dac2Preamp((ConfigV2)arg1) → int
ConfigV2.dac2RefLvds((ConfigV2)arg1) → int
ConfigV2.dac2ThlCourse((ConfigV2)arg1) → int
ConfigV2.dac2ThlFine((ConfigV2)arg1) → int
ConfigV2.dac2Ths((ConfigV2)arg1) → int
ConfigV2.dac2Vcas((ConfigV2)arg1) → int
ConfigV2.dac3BiasLvds((ConfigV2)arg1) → int
ConfigV2.dac3BufAnalogA((ConfigV2)arg1) → int
ConfigV2.dac3BufAnalogB((ConfigV2)arg1) → int
ConfigV2.dac3Disc((ConfigV2)arg1) → int
ConfigV2.dac3Fbk((ConfigV2)arg1) → int
ConfigV2.dac3Gnd((ConfigV2)arg1) → int
ConfigV2.dac3Hist((ConfigV2)arg1) → int
ConfigV2.dac3Ikrum((ConfigV2)arg1) → int
ConfigV2.dac3Preamp((ConfigV2)arg1) → int
ConfigV2.dac3RefLvds((ConfigV2)arg1) → int
ConfigV2.dac3ThlCourse((ConfigV2)arg1) → int
ConfigV2.dac3ThlFine((ConfigV2)arg1) → int
ConfigV2.dac3Ths((ConfigV2)arg1) → int
ConfigV2.dac3Vcas((ConfigV2)arg1) → int
ConfigV2.driverVersion((ConfigV2)arg1) → int
ConfigV2.firmwareVersion((ConfigV2)arg1) → int
ConfigV2.pixelThresh((ConfigV2)arg1) → numpy.ndarray
ConfigV2.pixelThreshSize((ConfigV2)arg1) → int
ConfigV2.readoutSpeed((ConfigV2)arg1) → ReadoutSpeed
ConfigV2.timepixSpeed((ConfigV2)arg1) → int
ConfigV2.triggerMode((ConfigV2)arg1) → TriggerMode
ConfigV2.ChipCount = 4
ConfigV2.ChipNameMax = 16
ConfigV2.PixelThreshMax = 262144
ConfigV2.TypeId = 49
ConfigV2.Version = 2

Class psana.Timepix.ConfigV3

class psana.Timepix.ConfigV3

Raises an exception This class cannot be instantiated from Python

class ReadoutSpeed
ReadoutSpeed_Fast = psana.Timepix.ReadoutSpeed.ReadoutSpeed_Fast
ReadoutSpeed_Slow = psana.Timepix.ReadoutSpeed.ReadoutSpeed_Slow
names = {'ReadoutSpeed_Slow': psana.Timepix.ReadoutSpeed.ReadoutSpeed_Slow, 'ReadoutSpeed_Fast': psana.Timepix.ReadoutSpeed.ReadoutSpeed_Fast}
values = {0: psana.Timepix.ReadoutSpeed.ReadoutSpeed_Slow, 1: psana.Timepix.ReadoutSpeed.ReadoutSpeed_Fast}
class ConfigV3.TimepixMode
TimepixMode_Counting = psana.Timepix.TimepixMode.TimepixMode_Counting
TimepixMode_TOT = psana.Timepix.TimepixMode.TimepixMode_TOT
names = {'TimepixMode_Counting': psana.Timepix.TimepixMode.TimepixMode_Counting, 'TimepixMode_TOT': psana.Timepix.TimepixMode.TimepixMode_TOT}
values = {0: psana.Timepix.TimepixMode.TimepixMode_Counting, 1: psana.Timepix.TimepixMode.TimepixMode_TOT}
ConfigV3.chip0ID((ConfigV3)arg1) → int
ConfigV3.chip0Name((ConfigV3)arg1) → str
ConfigV3.chip1ID((ConfigV3)arg1) → int
ConfigV3.chip1Name((ConfigV3)arg1) → str
ConfigV3.chip2ID((ConfigV3)arg1) → int
ConfigV3.chip2Name((ConfigV3)arg1) → str
ConfigV3.chip3ID((ConfigV3)arg1) → int
ConfigV3.chip3Name((ConfigV3)arg1) → str
ConfigV3.chipCount((ConfigV3)arg1) → int
ConfigV3.dac0BiasLvds((ConfigV3)arg1) → int
ConfigV3.dac0BufAnalogA((ConfigV3)arg1) → int
ConfigV3.dac0BufAnalogB((ConfigV3)arg1) → int
ConfigV3.dac0Disc((ConfigV3)arg1) → int
ConfigV3.dac0Fbk((ConfigV3)arg1) → int
ConfigV3.dac0Gnd((ConfigV3)arg1) → int
ConfigV3.dac0Hist((ConfigV3)arg1) → int
ConfigV3.dac0Ikrum((ConfigV3)arg1) → int
ConfigV3.dac0Preamp((ConfigV3)arg1) → int
ConfigV3.dac0RefLvds((ConfigV3)arg1) → int
ConfigV3.dac0ThlCourse((ConfigV3)arg1) → int
ConfigV3.dac0ThlFine((ConfigV3)arg1) → int
ConfigV3.dac0Ths((ConfigV3)arg1) → int
ConfigV3.dac0Vcas((ConfigV3)arg1) → int
ConfigV3.dac1BiasLvds((ConfigV3)arg1) → int
ConfigV3.dac1BufAnalogA((ConfigV3)arg1) → int
ConfigV3.dac1BufAnalogB((ConfigV3)arg1) → int
ConfigV3.dac1Disc((ConfigV3)arg1) → int
ConfigV3.dac1Fbk((ConfigV3)arg1) → int
ConfigV3.dac1Gnd((ConfigV3)arg1) → int
ConfigV3.dac1Hist((ConfigV3)arg1) → int
ConfigV3.dac1Ikrum((ConfigV3)arg1) → int
ConfigV3.dac1Preamp((ConfigV3)arg1) → int
ConfigV3.dac1RefLvds((ConfigV3)arg1) → int
ConfigV3.dac1ThlCourse((ConfigV3)arg1) → int
ConfigV3.dac1ThlFine((ConfigV3)arg1) → int
ConfigV3.dac1Ths((ConfigV3)arg1) → int
ConfigV3.dac1Vcas((ConfigV3)arg1) → int
ConfigV3.dac2BiasLvds((ConfigV3)arg1) → int
ConfigV3.dac2BufAnalogA((ConfigV3)arg1) → int
ConfigV3.dac2BufAnalogB((ConfigV3)arg1) → int
ConfigV3.dac2Disc((ConfigV3)arg1) → int
ConfigV3.dac2Fbk((ConfigV3)arg1) → int
ConfigV3.dac2Gnd((ConfigV3)arg1) → int
ConfigV3.dac2Hist((ConfigV3)arg1) → int
ConfigV3.dac2Ikrum((ConfigV3)arg1) → int
ConfigV3.dac2Preamp((ConfigV3)arg1) → int
ConfigV3.dac2RefLvds((ConfigV3)arg1) → int
ConfigV3.dac2ThlCourse((ConfigV3)arg1) → int
ConfigV3.dac2ThlFine((ConfigV3)arg1) → int
ConfigV3.dac2Ths((ConfigV3)arg1) → int
ConfigV3.dac2Vcas((ConfigV3)arg1) → int
ConfigV3.dac3BiasLvds((ConfigV3)arg1) → int
ConfigV3.dac3BufAnalogA((ConfigV3)arg1) → int
ConfigV3.dac3BufAnalogB((ConfigV3)arg1) → int
ConfigV3.dac3Disc((ConfigV3)arg1) → int
ConfigV3.dac3Fbk((ConfigV3)arg1) → int
ConfigV3.dac3Gnd((ConfigV3)arg1) → int
ConfigV3.dac3Hist((ConfigV3)arg1) → int
ConfigV3.dac3Ikrum((ConfigV3)arg1) → int
ConfigV3.dac3Preamp((ConfigV3)arg1) → int
ConfigV3.dac3RefLvds((ConfigV3)arg1) → int
ConfigV3.dac3ThlCourse((ConfigV3)arg1) → int
ConfigV3.dac3ThlFine((ConfigV3)arg1) → int
ConfigV3.dac3Ths((ConfigV3)arg1) → int
ConfigV3.dac3Vcas((ConfigV3)arg1) → int
ConfigV3.dacBias((ConfigV3)arg1) → int
ConfigV3.driverVersion((ConfigV3)arg1) → int
ConfigV3.firmwareVersion((ConfigV3)arg1) → int
ConfigV3.flags((ConfigV3)arg1) → int
ConfigV3.pixelThresh((ConfigV3)arg1) → numpy.ndarray
ConfigV3.pixelThreshSize((ConfigV3)arg1) → int
ConfigV3.readoutSpeed((ConfigV3)arg1) → ReadoutSpeed
ConfigV3.timepixMode((ConfigV3)arg1) → TimepixMode
ConfigV3.timepixSpeed((ConfigV3)arg1) → int
ConfigV3.ChipCount = 4
ConfigV3.ChipNameMax = 16
ConfigV3.PixelThreshMax = 262144
ConfigV3.TypeId = 49
ConfigV3.Version = 3

Class psana.Timepix.DataV1

class psana.Timepix.DataV1

Raises an exception This class cannot be instantiated from Python

data((DataV1)arg1) → numpy.ndarray
data_size((DataV1)arg1) → int :

Size of the image data in bytes.

depth((DataV1)arg1) → int
depth_bytes((DataV1)arg1) → int
frameCounter((DataV1)arg1) → int
height((DataV1)arg1) → int
lostRows((DataV1)arg1) → int
timestamp((DataV1)arg1) → int
width((DataV1)arg1) → int
Depth = 14
DepthBytes = 2
Height = 512
MaxPixelValue = 11810
TypeId = 50
Version = 1
Width = 512

Class psana.Timepix.DataV2

class psana.Timepix.DataV2

Raises an exception This class cannot be instantiated from Python

data((DataV2)arg1) → numpy.ndarray
data_size((DataV2)arg1) → int :

Size of the image data in bytes.

depth((DataV2)arg1) → int
depth_bytes((DataV2)arg1) → int
frameCounter((DataV2)arg1) → int :

hardware frame counter

height((DataV2)arg1) → int :

Pixels per column

lostRows((DataV2)arg1) → int :

lost row count

timestamp((DataV2)arg1) → int :

hardware timestamp

width((DataV2)arg1) → int :

Pixels per row

Depth = 14
MaxPixelValue = 11810
TypeId = 50
Version = 2

Module psana.TimeTool

The Python wrapper module for TimeTool types

Class psana.TimeTool.ConfigV1

class psana.TimeTool.ConfigV1

Raises an exception This class cannot be instantiated from Python

class Axis
X = psana.TimeTool.Axis.X
Y = psana.TimeTool.Axis.Y
names = {'Y': psana.TimeTool.Axis.Y, 'X': psana.TimeTool.Axis.X}
values = {0: psana.TimeTool.Axis.X, 1: psana.TimeTool.Axis.Y}
ConfigV1.base_name((ConfigV1)arg1) → str :

EPICS PV base name

ConfigV1.base_name_length((ConfigV1)arg1) → int :

Length of EPICS PV base name

ConfigV1.base_name_shape((ConfigV1)arg1) → object
ConfigV1.beam_logic((ConfigV1)arg1) → list :

Beam Logic Event Codes

ConfigV1.calib_poly((ConfigV1)arg1) → numpy.ndarray :

Pixel to Time Calibration Polynomial

ConfigV1.calib_poly_dim((ConfigV1)arg1) → int :

Pixel to Time Calibration Polynomial Dimension

ConfigV1.laser_logic((ConfigV1)arg1) → list :

Laser Logic Event Codes

ConfigV1.number_of_beam_event_codes((ConfigV1)arg1) → int :

Number of Beam Logic Event Codes

ConfigV1.number_of_laser_event_codes((ConfigV1)arg1) → int :

Number of Laser Logic Event Codes

ConfigV1.number_of_weights((ConfigV1)arg1) → int :

Number of Digital Filter Weights

ConfigV1.project_axis((ConfigV1)arg1) → Axis :

Time Axis of Image

ConfigV1.ref_convergence((ConfigV1)arg1) → float :

Reference Rolling Average Factor (1/NFrames)

ConfigV1.sb_convergence((ConfigV1)arg1) → float :

Sideband Rolling Average Factor (1/NFrames)

ConfigV1.sb_roi_hi((ConfigV1)arg1) → FrameCoord :

Sideband Region Coordinates End

ConfigV1.sb_roi_lo((ConfigV1)arg1) → FrameCoord :

Sideband Region Coordinates Start

ConfigV1.sideband_projection_size((ConfigV1)arg1) → int
ConfigV1.sig_roi_hi((ConfigV1)arg1) → FrameCoord :

Signal Region Coordinates End

ConfigV1.sig_roi_lo((ConfigV1)arg1) → FrameCoord :

Signal Region Coordinates Start

ConfigV1.signal_cut((ConfigV1)arg1) → int :

Projection Minimum Value for Validation

ConfigV1.signal_projection_size((ConfigV1)arg1) → int :

Size of projections

ConfigV1.subtract_sideband((ConfigV1)arg1) → int :

Subtract Sideband Region

ConfigV1.weights((ConfigV1)arg1) → numpy.ndarray :

Digital Filter Weights

ConfigV1.write_image((ConfigV1)arg1) → int :

Record Raw Image into Event

ConfigV1.write_projections((ConfigV1)arg1) → int :

Record Time Axis Projections into Event

ConfigV1.TypeId = 86
ConfigV1.Version = 1

Class psana.TimeTool.ConfigV2

class psana.TimeTool.ConfigV2

Raises an exception This class cannot be instantiated from Python

class Axis
X = psana.TimeTool.Axis.X
Y = psana.TimeTool.Axis.Y
names = {'Y': psana.TimeTool.Axis.Y, 'X': psana.TimeTool.Axis.X}
values = {0: psana.TimeTool.Axis.X, 1: psana.TimeTool.Axis.Y}
ConfigV2.base_name((ConfigV2)arg1) → str :

EPICS PV base name

ConfigV2.base_name_length((ConfigV2)arg1) → int :

Length of EPICS PV base name

ConfigV2.base_name_shape((ConfigV2)arg1) → object
ConfigV2.beam_logic((ConfigV2)arg1) → list :

Beam Logic Event Codes

ConfigV2.calib_poly((ConfigV2)arg1) → numpy.ndarray :

Pixel to Time Calibration Polynomial

ConfigV2.calib_poly_dim((ConfigV2)arg1) → int :

Pixel to Time Calibration Polynomial Dimension

ConfigV2.laser_logic((ConfigV2)arg1) → list :

Laser Logic Event Codes

ConfigV2.number_of_beam_event_codes((ConfigV2)arg1) → int :

Number of Beam Logic Event Codes

ConfigV2.number_of_laser_event_codes((ConfigV2)arg1) → int :

Number of Laser Logic Event Codes

ConfigV2.number_of_weights((ConfigV2)arg1) → int :

Number of Digital Filter Weights

ConfigV2.project_axis((ConfigV2)arg1) → Axis :

Time Axis of Image

ConfigV2.ref_convergence((ConfigV2)arg1) → float :

Reference Rolling Average Factor (1/NFrames)

ConfigV2.ref_roi_hi((ConfigV2)arg1) → FrameCoord :

Sideband Region Coordinates End

ConfigV2.ref_roi_lo((ConfigV2)arg1) → FrameCoord :

Reference Region Coordinates Start

ConfigV2.reference_projection_size((ConfigV2)arg1) → int
ConfigV2.sb_convergence((ConfigV2)arg1) → float :

Sideband Rolling Average Factor (1/NFrames)

ConfigV2.sb_roi_hi((ConfigV2)arg1) → FrameCoord :

Sideband Region Coordinates End

ConfigV2.sb_roi_lo((ConfigV2)arg1) → FrameCoord :

Sideband Region Coordinates Start

ConfigV2.sideband_projection_size((ConfigV2)arg1) → int
ConfigV2.sig_roi_hi((ConfigV2)arg1) → FrameCoord :

Signal Region Coordinates End

ConfigV2.sig_roi_lo((ConfigV2)arg1) → FrameCoord :

Signal Region Coordinates Start

ConfigV2.signal_cut((ConfigV2)arg1) → int :

Projection Minimum Value for Validation

ConfigV2.signal_projection_size((ConfigV2)arg1) → int :

Size of projections

ConfigV2.subtract_sideband((ConfigV2)arg1) → int :

Subtract Sideband Region

ConfigV2.use_reference_roi((ConfigV2)arg1) → int :

Use Separate Reference Region

ConfigV2.weights((ConfigV2)arg1) → numpy.ndarray :

Digital Filter Weights

ConfigV2.write_image((ConfigV2)arg1) → int :

Record Raw Image into Event

ConfigV2.write_projections((ConfigV2)arg1) → int :

Record Time Axis Projections into Event

ConfigV2.TypeId = 86
ConfigV2.Version = 2

Class psana.TimeTool.DataV1

class psana.TimeTool.DataV1

Raises an exception This class cannot be instantiated from Python

class EventType
Dark = psana.TimeTool.EventType.Dark
Reference = psana.TimeTool.EventType.Reference
Signal = psana.TimeTool.EventType.Signal
names = {'Dark': psana.TimeTool.EventType.Dark, 'Signal': psana.TimeTool.EventType.Signal, 'Reference': psana.TimeTool.EventType.Reference}
values = {0: psana.TimeTool.EventType.Dark, 1: psana.TimeTool.EventType.Reference, 2: psana.TimeTool.EventType.Signal}
DataV1.amplitude((DataV1)arg1) → float :

Amplitude of the edge

DataV1.event_type((DataV1)arg1) → EventType :

Event designation

DataV1.nxt_amplitude((DataV1)arg1) → float :

Amplitude of the next largest edge

DataV1.position_fwhm((DataV1)arg1) → float :

Full-width half maximum of filtered edge (in pixels)

DataV1.position_pixel((DataV1)arg1) → float :

Filtered pixel position of the edge

DataV1.position_time((DataV1)arg1) → float :

Filtered time position of the edge

DataV1.projected_sideband((DataV1)arg1) → numpy.ndarray :

Projected reference

DataV1.projected_signal((DataV1)arg1) → numpy.ndarray :

Projected signal

DataV1.ref_amplitude((DataV1)arg1) → float :

Amplitude of reference at the edge

DataV1.TypeId = 87
DataV1.Version = 1

Class psana.TimeTool.DataV2

class psana.TimeTool.DataV2

Raises an exception This class cannot be instantiated from Python

class EventType
Dark = psana.TimeTool.EventType.Dark
Reference = psana.TimeTool.EventType.Reference
Signal = psana.TimeTool.EventType.Signal
names = {'Dark': psana.TimeTool.EventType.Dark, 'Signal': psana.TimeTool.EventType.Signal, 'Reference': psana.TimeTool.EventType.Reference}
values = {0: psana.TimeTool.EventType.Dark, 1: psana.TimeTool.EventType.Reference, 2: psana.TimeTool.EventType.Signal}
DataV2.amplitude((DataV2)arg1) → float :

Amplitude of the edge

DataV2.event_type((DataV2)arg1) → EventType :

Event designation

DataV2.nxt_amplitude((DataV2)arg1) → float :

Amplitude of the next largest edge

DataV2.position_fwhm((DataV2)arg1) → float :

Full-width half maximum of filtered edge (in pixels)

DataV2.position_pixel((DataV2)arg1) → float :

Filtered pixel position of the edge

DataV2.position_time((DataV2)arg1) → float :

Filtered time position of the edge

DataV2.projected_reference((DataV2)arg1) → numpy.ndarray :

Projected reference

DataV2.projected_sideband((DataV2)arg1) → numpy.ndarray :

Projected sideband

DataV2.projected_signal((DataV2)arg1) → numpy.ndarray :

Projected signal

DataV2.ref_amplitude((DataV2)arg1) → float :

Amplitude of reference at the edge

DataV2.TypeId = 87
DataV2.Version = 2

Class psana.TimeTool.EventLogic

class psana.TimeTool.EventLogic

Raises an exception This class cannot be instantiated from Python

class LogicOp
L_AND = psana.TimeTool.LogicOp.L_AND
L_AND_NOT = psana.TimeTool.LogicOp.L_AND_NOT
L_OR = psana.TimeTool.LogicOp.L_OR
L_OR_NOT = psana.TimeTool.LogicOp.L_OR_NOT
names = {'L_AND_NOT': psana.TimeTool.LogicOp.L_AND_NOT, 'L_AND': psana.TimeTool.LogicOp.L_AND, 'L_OR': psana.TimeTool.LogicOp.L_OR, 'L_OR_NOT': psana.TimeTool.LogicOp.L_OR_NOT}
values = {0: psana.TimeTool.LogicOp.L_OR, 1: psana.TimeTool.LogicOp.L_AND, 2: psana.TimeTool.LogicOp.L_OR_NOT, 3: psana.TimeTool.LogicOp.L_AND_NOT}
EventLogic.event_code((EventLogic)arg1) → int :

Event Code

EventLogic.logic_op((EventLogic)arg1) → LogicOp :

Logic Operation

Module psana.UsdUsb

The Python wrapper module for UsdUsb types

Class psana.UsdUsb.ConfigV1

class psana.UsdUsb.ConfigV1

Raises an exception This class cannot be instantiated from Python

class Count_Mode
HALT = psana.UsdUsb.Count_Mode.HALT
LIMIT = psana.UsdUsb.Count_Mode.LIMIT
WRAP_FULL = psana.UsdUsb.Count_Mode.WRAP_FULL
WRAP_PRESET = psana.UsdUsb.Count_Mode.WRAP_PRESET
names = {'WRAP_FULL': psana.UsdUsb.Count_Mode.WRAP_FULL, 'LIMIT': psana.UsdUsb.Count_Mode.LIMIT, 'HALT': psana.UsdUsb.Count_Mode.HALT, 'WRAP_PRESET': psana.UsdUsb.Count_Mode.WRAP_PRESET}
values = {0: psana.UsdUsb.Count_Mode.WRAP_FULL, 1: psana.UsdUsb.Count_Mode.LIMIT, 2: psana.UsdUsb.Count_Mode.HALT, 3: psana.UsdUsb.Count_Mode.WRAP_PRESET}
class ConfigV1.Quad_Mode
CLOCK_DIR = psana.UsdUsb.Quad_Mode.CLOCK_DIR
X1 = psana.UsdUsb.Quad_Mode.X1
X2 = psana.UsdUsb.Quad_Mode.X2
X4 = psana.UsdUsb.Quad_Mode.X4
names = {'X2': psana.UsdUsb.Quad_Mode.X2, 'X1': psana.UsdUsb.Quad_Mode.X1, 'X4': psana.UsdUsb.Quad_Mode.X4, 'CLOCK_DIR': psana.UsdUsb.Quad_Mode.CLOCK_DIR}
values = {0: psana.UsdUsb.Quad_Mode.CLOCK_DIR, 1: psana.UsdUsb.Quad_Mode.X1, 2: psana.UsdUsb.Quad_Mode.X2, 3: psana.UsdUsb.Quad_Mode.X4}
ConfigV1.counting_mode((ConfigV1)arg1) → numpy.ndarray
ConfigV1.quadrature_mode((ConfigV1)arg1) → numpy.ndarray
ConfigV1.NCHANNELS = 4
ConfigV1.TypeId = 63
ConfigV1.Version = 1

Class psana.UsdUsb.DataV1

class psana.UsdUsb.DataV1

Raises an exception This class cannot be instantiated from Python

analog_in((DataV1)arg1) → numpy.ndarray
digital_in((DataV1)arg1) → int
encoder_count((DataV1)arg1) → numpy.ndarray :

Return lower 24 bits of _count array as signed integer values.

status((DataV1)arg1) → numpy.ndarray
timestamp((DataV1)arg1) → int
Analog_Inputs = 4
Digital_Inputs = 8
Encoder_Inputs = 4
TypeId = 62
Version = 1

Class psana.UsdUsb.FexConfigV1

class psana.UsdUsb.FexConfigV1

Class for creating a FexData for an encoder - takes an offset and scale.

Raises an exception This class cannot be instantiated from Python

name((FexConfigV1)arg1, (int)arg2) → str :

Descriptive name for each channel

name_shape((FexConfigV1)arg1) → object
offset((FexConfigV1)arg1) → numpy.ndarray :

Offset (in counts) to apply to raw encoder counts

scale((FexConfigV1)arg1) → numpy.ndarray :

Scale factor for converting encoder counts to units

NAME_CHAR_MAX = 48
NCHANNELS = 4
TypeId = 101
Version = 1

Class psana.UsdUsb.FexDataV1

class psana.UsdUsb.FexDataV1

Class for holding the encoder value after application of an offset and scale.

Raises an exception This class cannot be instantiated from Python

encoder_values((FexDataV1)arg1) → numpy.ndarray :

Corrected encoder value = (raw_count + offset) * scale

Encoder_Inputs = 4
TypeId = 102
Version = 1