Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Panel

Anchor
_pdsdata.xtc.DetInfo
_pdsdata.xtc.DetInfo

Class _pdsdata.xtc.DetInfo

Python wrapper for pdsdata/xtc/DetInfo class. Unlike C++ this class does not inherit from Src class (Src class does not exist in this module) but uses dynamic Python features to implement the same interface as in Src class. In addition to methods described here the class also defines __hash__ and __cmp__ methods based on the content of the object and can be used as a key in the dictionaries.


Anchor
_pdsdata.xtc.DetInfo.Detector
_pdsdata.xtc.DetInfo.Detector

Enum Detector

This enum is an embedded type of DetInfo class. Following enum members are defined currently:

  • DetInfo.Detector.NoDetector
  • DetInfo.Detector.AmoIms
  • DetInfo.Detector.AmoGasdet
  • DetInfo.Detector.AmoETof
  • DetInfo.Detector.AmoITof
  • DetInfo.Detector.AmoMbes
  • DetInfo.Detector.AmoVmi
  • DetInfo.Detector.AmoBps
  • DetInfo.Detector.Camp
  • DetInfo.Detector.EpicsArch
  • DetInfo.Detector.BldEb
  • DetInfo.Detector.SxrBeamline
  • DetInfo.Detector.SxrEndstation
  • DetInfo.Detector.XppSb1Ipm
  • DetInfo.Detector.XppSb1Pim
  • DetInfo.Detector.XppMonPim
  • DetInfo.Detector.XppSb2Ipm
  • DetInfo.Detector.XppSb3Ipm
  • DetInfo.Detector.XppSb3Pim
  • DetInfo.Detector.XppSb4Pim
  • DetInfo.Detector.NumDetector

Anchor
_pdsdata.xtc.DetInfo.Device
_pdsdata.xtc.DetInfo.Device

Enum Device

This enum is an embedded type of DetInfo class. Following enum members are defined currently:

  • DetInfo.Device.NoDevice
  • DetInfo.Device.Evr
  • DetInfo.Device.Acqiris
  • DetInfo.Device.Opal1000
  • DetInfo.Device.TM6740
  • DetInfo.Device.pnCCD
  • DetInfo.Device.Princeton
  • DetInfo.Device.Fccd
  • DetInfo.Device.Ipimb
  • DetInfo.Device.Encoder
  • DetInfo.Device.NumDevice

Construction

Usage: det = xtc.DetInfo(processId, detector, detId, device, devId)

Arguments:

  • processId – integer number
  • detector – one of the DetInfo.Detector enum values
  • detId – detector ID as integer number
  • device – one of the DetInfo.Device enum values
  • devId – device ID as integer number

Method level()

Usage: lvl = det.level()

Returns enum value of type xtc.Level which defines source level.


Method log()

Usage: log = det.log()

Returns logical address of data source as integer number.


Method phy()

Usage: phy = det.phy()

Returns physical address of data source as integer number.


Method processId()

Usage: processId = det.processId()

Returns process ID as integer number.


Method detector()

Usage: detector = det.detector()

Returns detector enum which is a value of DetInfo.Detector.


Method device()

Usage: device = det.device()

Returns device enum which is a value of DetInfo.Device.


Method detId()

Usage: detId = det.detId()

Returns detector ID as integer number.


Method devId()

Usage: devId = det.devId()

Returns device ID as integer number.

...

Panel

Anchor
_pdsdata.xtc.TypeId
_pdsdata.xtc.TypeId

Class _pdsdata.xtc.TypeId

Python wrapper for pdsdata/xtc/TypeId class. In addition to methods described here the class also defines __hash__ and __cmp__ methods based on the content of the object and can be used as a key in the dictionaries.


Anchor
_pdsdata.xtc.TypeId.Type
_pdsdata.xtc.TypeId.Type

Enum Type

This enum is an embedded type of TypeId class. Following enum members are defined currently:

  • TypeId.Type.Any
  • TypeId.Type.Id_Xtc
  • TypeId.Type.Id_Frame
  • TypeId.Type.Id_AcqWaveform
  • TypeId.Type.Id_AcqConfig
  • TypeId.Type.Id_TwoDGaussian
  • TypeId.Type.Id_Opal1kConfig
  • TypeId.Type.Id_FrameFexConfig
  • TypeId.Type.Id_EvrConfig
  • TypeId.Type.Id_TM6740Config
  • TypeId.Type.Id_ControlConfig
  • TypeId.Type.Id_pnCCDframe
  • TypeId.Type.Id_pnCCDconfig
  • TypeId.Type.Id_Epics
  • TypeId.Type.Id_FEEGasDetEnergy
  • TypeId.Type.Id_EBeam
  • TypeId.Type.Id_PhaseCavity
  • TypeId.Type.Id_PrincetonFrame
  • TypeId.Type.Id_PrincetonConfig
  • TypeId.Type.Id_EvrData
  • TypeId.Type.Id_FrameFccdConfig
  • TypeId.Type.Id_FccdConfig
  • TypeId.Type.Id_IpimbData
  • TypeId.Type.Id_IpimbConfig
  • TypeId.Type.Id_EncoderData
  • TypeId.Type.Id_EncoderConfig
  • TypeId.Type.Id_EvrIOConfig
  • TypeId.Type.NumberOf

Construction

Wiki Markup
Usage: {{typeId = xtc.TypeId(\[_type_, \[_version_\]\])}}

Arguments:

  • type – one of the ebove enum values, if missing then Any assumed
  • version – version number, if missing then assumed to be 0

Method value()

Usage: val = typeId.value()

Returns the whole type ID number including version as integer number.


Method id()

Usage: id = typeId.id()

Returns the type ID number without version as enum object of TypeId.Type type.


Method version()

Usage: vers = typeId.version()

Returns the type ID version number as integer number.

...

Panel

Anchor
_pdsdata.ipimb.DataV1
_pdsdata.ipimb.DataV1

Class _pdsdata.ipimb.DataV1

Python wrapper for pdsdata/ipimb/DataV1 class.


Construction

This class cannot be instantiated directly, methods of other classes return instances of this type.


Method triggerCounter()

Usage: val = config.triggerCounter()

Returns integer number.


Method config0()

Usage: val = config.config0()

Returns integer number.


Method config1()

Usage: val = config.config1()

Returns integer number.


Method config2()

Usage: val = config.config2()

Returns integer number.


Method channel0()

Usage: val = config.channel0()

Returns integer number.


Method channel1()

Usage: val = config.channel1()

Returns integer number.


Method channel2()

Usage: val = config.channel2()

Returns integer number.


Method channel3()

Usage: val = config.channel3()

Returns integer number.


Method channel0Volts()

Usage: val = config.channel0Volts()

Returns floating number.


Method channel1Volts()

Usage: val = config.channel1Volts()

Returns floating number.


Method channel2Volts()

Usage: val = config.channel2Volts()

Returns floating number.


Method channel3Volts()

Usage: val = config.channel3Volts()

Returns floating number.


Method checksum()

Usage: val = config.checksum()

Returns integer number.

...