Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Added cspad.ConfigV2 description

...

Panel

Anchor
_pdsdata.cspad.ConfigV2
_pdsdata.cspad.ConfigV2

Class _pdsdata.cspad.ConfigV2

Python wrapper for pdsdata/cspad/ConfigV2 class.


Anchor
_pdsdata.cspad.ConfigV2.RunModes
_pdsdata.cspad.ConfigV2.RunModes

Enum RunModes

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

  • ConfigV2.RunModes.NoRunning
  • ConfigV2.RunModes.RunButDrop
  • ConfigV2.RunModes.RunAndSendToRCE
  • ConfigV2.RunModes.RunAndSendTriggeredByTTL
  • ConfigV2.RunModes.ExternalTriggerSendToRCE
  • ConfigV2.RunModes.ExternalTriggerDrop
  • ConfigV2.RunModes.NumberOfRunModes

Class constants

  • ConfigV2.MaxQuadsPerSensor = 4

Construction

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


Method quads()

Usage: val = config.quads()

Returns list of the objects of type _pdsdata.cspad.ConfigV1QuadReg.


Method numQuads()

Usage: val = config.numQuads()

Returns number of quadrants as integer number.


Method tdi()

Usage: val = config.tdi()

Returns integer number.


Method quadMask()

Usage: val = config.quadMask()

Returns integer number.


Method runDelay()

Usage: val = config.runDelay()

Returns integer number.


Method eventCode()

Usage: val = config.eventCode()

Returns integer number.


Method inactiveRunMode()

Usage: val = config.inactiveRunMode()

Returns RunModes enum value.


Method activeRunMode()

Usage: val = config.activeRunMode()

Returns RunModes enum value.


Method payloadSize()

Usage: val = config.payloadSize()

Returns integer number.


Method badAsicMask0()

Usage: val = config.badAsicMask0()

Returns integer number.


Method badAsicMask1()

Usage: val = config.badAsicMask1()

Returns integer number.


Method asicMask()

Usage: val = config.asicMask()

Returns integer number.


Method roiMask()

Usage: val = config.roiMask(quadrant)

Returns section mask (integer number) for given quadrant number.


Method numAsicsRead()

Usage: val = config.numAsicsRead()

Returns integer number.


Method numAsicsStored()

Usage: val = config.numAsicsStored(quadrant)

Returns number of ASICs (integer number) sored for given quadrant.


Method concentratorVersion()

Usage: val = config.concentratorVersion()

Returns integer number.


Method sections()

Usage: val = config.sections(quadrant)

Returns list of of section numbers for given quadrant.

...

Panel

Anchor
_pdsdata.cspad.ConfigV1QuadReg
_pdsdata.cspad.ConfigV1QuadReg

Class _pdsdata.cspad.ConfigV1QuadReg

Python wrapper for pdsdata/cspad/ConfigV1QuadReg class.


Anchor
_pdsdata.cspad.ConfigV1QuadReg.DataModes
_pdsdata.cspad.ConfigV1QuadReg.DataModes

Enum DataModes

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

  • ConfigV1QuadReg.DataModes.normal
  • ConfigV1QuadReg.DataModes.shiftTest
  • ConfigV1QuadReg.DataModes.testData
  • ConfigV1QuadReg.DataModes.reserved

Class constants

  • ConfigV1QuadReg.TwoByTwosPerQuad

Construction

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


Method shiftSelect()

Usage: val = config.shiftSelect()

Returns list of integer numbers.


Method edgeSelect()

Usage: val = config.edgeSelect()

Returns list of integer numbers.


Method readClkSet()

Usage: val = config.readClkSet()

Returns integer number.


Method readClkHold()

Usage: val = config.readClkHold()

Returns integer number.


Method dataMode()

Usage: val = config.dataMode()

Returns DataModes enum value.


Method prstSel()

Usage: val = config.prstSel()

Returns integer number.


Method acqDelay()

Usage: val = config.acqDelay()

Returns integer number.


Method intTime()

Usage: val = config.intTime()

Returns integer number.


Method digDelay()

Usage: val = config.digDelay()

Returns integer number.


Method ampIdle()

Usage: val = config.ampIdle()

Returns integer number.


Method injTotal()

Usage: val = config.injTotal()

Returns integer number.


Method rowColShiftPer()

Usage: val = config.rowColShiftPer()

Returns integer number.


Method readOnly()

Usage: val = config.readOnly()

Returns object of type _pdsdata.cspad.CsPadReadOnlyCfg.


Method ro()

Usage: val = config.ro()

Equivalent to config.readOnly().


Method dp()

Usage: val = config.dp()

Returns object of type _pdsdata.cspad.CsPadDigitalPotsCfg.


Method gm()

Usage: val = config.gm()

Returns object of type _pdsdata.cspad.CsPadGainMapCfg.

...

Panel

Anchor
_pdsdata.cspad.CsPadDigitalPotsCfg
_pdsdata.cspad.CsPadDigitalPotsCfg

Class _pdsdata.cspad.CsPadDigitalPotsCfg

Python wrapper for pdsdata/cspad/CsPadDigitalPotsCfg class.


Class constants

  • CsPadDigitalPotsCfg.PotsPerQuad

Construction

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


Method value()

Usage: val = config.value(index)

Returns integer number for a given index, index must be non-negative and less than CsPadDigitalPotsCfg.PotsPerQuad.


Property pots

Usage: val = config.pots

Returns the list of integer numbers of size CsPadDigitalPotsCfg.PotsPerQuad.

...

Panel

Anchor
_pdsdata.cspad.CsPadGainMapCfg
_pdsdata.cspad.CsPadGainMapCfg

Class _pdsdata.cspad.CsPadGainMapCfg

Python wrapper for pdsdata/cspad/CsPadGainMapCfg class.


Construction

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


Method map()

Usage: val = config.map()

Returns 2-dimensional array of size ColumnsPerASIC x MaxRowsPerASIC (These constants are defined in _pdsdata.cspad.ElementV1 class).


Property gainMap

Usage: val = config.gainMap

Returns the same array as map() method above.

...

Panel

Anchor
_pdsdata.cspad.CsPadReadOnlyCfg
_pdsdata.cspad.CsPadReadOnlyCfg

Class _pdsdata.cspad.CsPadReadOnlyCfg

Python wrapper for pdsdata/cspad/CsPadReadOnlyCfg class.


Construction

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


Property shiftTest

Usage: val = config.shiftTest

Returns integer number.


Property version

Usage: val = config.version

Returns integer number.

...

Panel

Anchor
_pdsdata.cspad.ElementV1
_pdsdata.cspad.ElementV1

Class _pdsdata.cspad.ElementV1

Python wrapper for pdsdata/cspad/ElementV1 class.


Class constants

  • ElementV1.ColumnsPerASIC
  • ElementV1.MaxRowsPerASIC

Construction

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


Method virtual_channel()

Usage: val = elem.virtual_channel()

Returns integer number.


Method lane()

Usage: val = elem.lane()

Returns integer number.


Method tid()

Usage: val = elem.tid()

Returns integer number.


Method acq_count()

Usage: val = elem.acq_count()

Returns integer number.


Method op_code()

Usage: val = elem.op_code()

Returns integer number.


Method quad()

Usage: val = elem.quad()

Returns integer number.


Method seq_count()

Usage: val = elem.seq_count()

Returns integer number.


Method ticks()

Usage: val = elem.ticks()

Returns integer number.


Method fiducials()

Usage: val = elem.fiducials()

Returns integer number.


Method frame_type()

Usage: val = elem.frame_type()

Returns integer number.


Method sb_temp()

Usage: val = elem.sb_temp(index)

Returns integer number, index is a number from 0 to 3.


Method next()

Usage: val = elem.next(config)

Returns next element, config is an object of type _pdsdata.cspad.ConfigV1 type. Total number of elements is given by config object's numQuads() method.


Method data()

Usage: val = elem.data(config)

Returns data array, config is an object of type _pdsdata.cspad.ConfigV1 type. Dimensions of array are nAsic/2 x ColumnsPerASIC x MaxRowsPerASIC x 2, nAsic is the number returned by config object's numAsicsRead() method.


Method pixel()

Usage: val = elem.pixel(asic, column, row)

Returns value of a given pixel.

...

Panel

Anchor
_pdsdata.encoder.ConfigV1
_pdsdata.encoder.ConfigV1

Class _pdsdata.encoder.ConfigV1

Python wrapper for pdsdata/encoder/ConfigV1 class.


Enum count_mode

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

  • ConfigV1.count_mode.WRAP_FULL
  • ConfigV1.count_mode.LIMIT
  • ConfigV1.count_mode.HALT
  • ConfigV1.count_mode.WRAP_PRESET
  • ConfigV1.count_mode.END

Enum quad_mode

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

  • ConfigV1.quad_mode.CLOCK_DIR
  • ConfigV1.quad_mode.X1
  • ConfigV1.quad_mode.X2
  • ConfigV1.quad_mode.X4
  • ConfigV1.quad_mode.END

Construction

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


Property _chan_num

Usage: val = config._chan_num

Returns integer value.


Property _count_mode

Usage: val = config._count_mode

Returns value of enum type ConfigV1.count_mode.


Property _quadrature_mode

Usage: val = config._quadrature_mode

Returns value of enum type ConfigV1.quad_mode.


Property _input_num

Usage: val = config._input_num

Returns integer value.


Property _input_rising

Usage: val = config._input_rising

Returns boolean value.


Property _ticks_per_sec

Usage: val = config._ticks_per_sec

Returns integer value.

...

Panel

Anchor
_pdsdata.encoder.DataV1
_pdsdata.encoder.DataV1

Class _pdsdata.encoder.DataV1

Python wrapper for pdsdata/encoder/DataV1 class.


Construction

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


Property _33mhz_timestamp

Usage: val = data._33mhz_timestamp

Returns integer value.


Property _encoder_count

Usage: val = data._encoder_count

Returns integer value.


Method value()

Usage: val = data.value()

Returns integer value.

...

Panel

Anchor
_pdsdata.epics.EpicsPvCtrl
_pdsdata.epics.EpicsPvCtrl

Class _pdsdata.epics.EpicsPvCtrl

Python wrapper for pdsdata/epics/EpicsPvCtrl<T> classes.


Construction

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


Property iPvId

Usage: val = data.iPvId

Returns PV ID as integer number.


Property iDbrType

Usage: val = data.iDbrType

Returns one of the DBR_CTRL_<TYPE> constants.


Property iNumElements

Usage: val = data.iNumElements

Returns size of PV array.


Property sPvName

Usage: val = data.sPvName

Returns PV name.


Property status

Usage: val = data.status

Returns status as integer number. Value can be used as an index into epics.epicsAlarmConditionStrings list. Status 0 means success.


Property severity

Usage: val = data.severity

Returns severity as integer number. Value can be used as an index into epics.epicsAlarmSeverityStrings list. Severity 0 means success.


Property precision

Usage: val = data.precision

Returns precision of the floating point data as number of decimal digits. For non-floating types precision is None.


Property units

Usage: val = data.units

String describing physical units, None for ENUM and STRING PV types.


Property upper_disp_limit

Usage: val = data.upper_disp_limit

One of the EPICS data data limits, type is determined by PV type, None returned for ENUM and STRING PV types.


Property lower_disp_limit

Usage: val = data.lower_disp_limit

One of the EPICS data data limits, type is determined by PV type, None returned for ENUM and STRING PV types.


Property upper_alarm_limit

Usage: val = data.upper_alarm_limit

One of the EPICS data data limits, type is determined by PV type, None returned for ENUM and STRING PV types.


Property upper_warning_limit

Usage: val = data.upper_warning_limit

One of the EPICS data data limits, type is determined by PV type, None returned for ENUM and STRING PV types.


Property lower_warning_limit

Usage: val = data.lower_warning_limit

One of the EPICS data data limits, type is determined by PV type, None returned for ENUM and STRING PV types.


Property lower_alarm_limit

Usage: val = data.lower_alarm_limit

One of the EPICS data data limits, type is determined by PV type, None returned for ENUM and STRING PV types.


Property upper_ctrl_limit

Usage: val = data.upper_ctrl_limit

One of the EPICS data data limits, type is determined by PV type, None returned for ENUM and STRING PV types.


Property lower_ctrl_limit

Usage: val = data.lower_ctrl_limit

One of the EPICS data data limits, type is determined by PV type, None returned for ENUM and STRING PV types.


Property no_str

Usage: val = data.no_str

Number of ENUM states, None for non-enum PV types.


Property strs

Usage: val = data.strs

List of ENUM states, None for non-enum PV types.


Property value

Usage: val = data.value

PV value, always a single value, for arrays it is first element. Type of the value is determined by PV type.


Property values

Usage: val = data.values

List of PV values of size data.iNumElements. Type of the values is determined by PV type.

...

Panel

Anchor
_pdsdata.epics.EpicsPvTime
_pdsdata.epics.EpicsPvTime

Class _pdsdata.epics.EpicsPvTime

Python wrapper for pdsdata/epics/EpicsPvTime<T> classes.


Construction

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


Property iPvId

Usage: val = data.iPvId

Returns PV ID as integer number.


Property iDbrType

Usage: val = data.iDbrType

Returns one of the DBR_CTRL_<TYPE> constants.


Property iNumElements

Usage: val = data.iNumElements

Returns size of PV array.


Property status

Usage: val = data.status

Returns status as integer number. Value can be used as an index into epics.epicsAlarmConditionStrings list. Status 0 means success.


Property severity

Usage: val = data.severity

Returns severity as integer number. Value can be used as an index into epics.epicsAlarmSeverityStrings list. Severity 0 means success.


Property stamp

Usage: val = data.stamp

EPICS timestamp value of type epics.epicsTimeStamp.


Property value

Usage: val = data.value

PV value, always a single value, for arrays it is first element. Type of the value is determined by PV type.


Property values

Usage: val = data.values

List of PV values of size data.iNumElements. Type of the values is determined by PV type.

...

Panel

Anchor
_pdsdata.epics.epicsTimeStamp
_pdsdata.epics.epicsTimeStamp

Class _pdsdata.epics.epicsTimeStamp

Python wrapper for pdsdata/epics/epicsTimeStamp 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.


Construction

Wiki Markup
Usage: {{ts = epics.epicsTimeStamp(\[_sec_, \[_nsec_\]\])}}

Arguments:

  • sec – number of seconds since Jan 1, 1990 00:00
  • nsec – nanoseconds within second

Property secPastEpoch

Usage: val = ts.secPastEpoch

Returns number of seconds since Jan 1, 1990 00:00.


Property nsec

Usage: val = ts.nsec

Returns nanoseconds within second.

...

Panel

Anchor
_pdsdata.evr.ConfigV1
_pdsdata.evr.ConfigV1

Class _pdsdata.evr.ConfigV1

Python wrapper for pdsdata/evr/ConfigV1 class.


Construction

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


Method npulses()

Usage: val = config.npulses()

Returns integer number.


Method pulse()

Usage: val = config.pulse(index)

Returns object of evr.PulseConfig type.


Method noutputs()

Usage: val = config.noutputs()

Returns integer number.


Method output_map()

Usage: val = config.output_map(index)

Returns object of evr.OutputMap type.


Method size()

Usage: val = config.size()

Returns total size of the object.

...

Panel

Anchor
_pdsdata.evr.ConfigV2
_pdsdata.evr.ConfigV2

Class _pdsdata.evr.ConfigV2

Python wrapper for pdsdata/evr/ConfigV2 class.


Enum RateCode

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

  • ConfigV2.RateCode.r120Hz
  • ConfigV2.RateCode.r60Hz
  • ConfigV2.RateCode.r30Hz
  • ConfigV2.RateCode.r10Hz
  • ConfigV2.RateCode.r5Hz
  • ConfigV2.RateCode.r1Hz
  • ConfigV2.RateCode.r0_5Hz
  • ConfigV2.RateCode.Single
  • ConfigV2.RateCode.NumberOfRates

Enum BeamCode

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

  • ConfigV2.BeamCode.Off
  • ConfigV2.BeamCode.On

Construction

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


Method beam()

Usage: val = config.beam()

Returns value of enum ConfigV2.BeamCode.


Method rate()

Usage: val = config.rate()

Returns value of enum ConfigV2.RateCode.


Method opcode()

Usage: val = config.opcode()

Returns integer number.


Method npulses()

Usage: val = config.npulses()

Returns integer number.


Method pulse()

Usage: val = config.pulse(index)

Returns object of evr.PulseConfig type.


Method noutputs()

Usage: val = config.noutputs()

Returns integer number.


Method output_map()

Usage: val = config.output_map(index)

Returns object of evr.OutputMap type.


Method size()

Usage: val = config.size()

Returns total size of the object.

...

Panel

Anchor
_pdsdata.evr.ConfigV3
_pdsdata.evr.ConfigV3

Class _pdsdata.evr.ConfigV3

Python wrapper for pdsdata/evr/ConfigV3 class.


Construction

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


Method neventcodes()

Usage: val = config.neventcodes()

Returns integer number.


Method eventcode()

Usage: val = config.eventcode(index)

Returns object of evr.EventCodeV3 type.


Method npulses()

Usage: val = config.npulses()

Returns integer number.


Method pulse()

Usage: val = config.pulse(index)

Returns object of evr.PulseConfigV3 type.


Method noutputs()

Usage: val = config.noutputs()

Returns integer number.


Method output_map()

Usage: val = config.output_map(index)

Returns object of evr.OutputMap type.


Method size()

Usage: val = config.size()

Returns total size of the object.

...

Panel

Anchor
_pdsdata.evr.ConfigV4
_pdsdata.evr.ConfigV4

Class _pdsdata.evr.ConfigV4

Python wrapper for pdsdata/evr/ConfigV4 class.


Construction

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


Method neventcodes()

Usage: val = config.neventcodes()

Returns integer number.


Method eventcode()

Usage: val = config.eventcode(index)

Returns object of evr.EventCodeV4 type.


Method npulses()

Usage: val = config.npulses()

Returns integer number.


Method pulse()

Usage: val = config.pulse(index)

Returns object of evr.PulseConfigV3 type.


Method noutputs()

Usage: val = config.noutputs()

Returns integer number.


Method output_map()

Usage: val = config.output_map(index)

Returns object of evr.OutputMap type.


Method size()

Usage: val = config.size()

Returns total size of the object.

...

Panel

Anchor
_pdsdata.evr.DataV3
_pdsdata.evr.DataV3

Class _pdsdata.evr.DataV3

Python wrapper for pdsdata/evr/DataV3 class.


Construction

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


Method numFifoEvents()

Usage: val = config.numFifoEvents()

Returns integer number.


Method fifoEvent()

Usage: val = config.fifoEvent(index)

Returns object of evr.DataV3_FIFOEvent type.

...

Panel

Anchor
_pdsdata.evr.DataV3_FIFOEvent
_pdsdata.evr.DataV3_FIFOEvent

Class _pdsdata.evr.DataV3_FIFOEvent

Python wrapper for pdsdata/evr/DataV3::FIFOEvent class.


Construction

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


Property TimestampHigh

Usage: val = config.TimestampHigh

Returns integer number.


Property TimestampLow

Usage: val = config.TimestampLow

Returns integer number.


Property EventCode

Usage: val = config.EventCode

Returns integer number.

...

Panel

Anchor
_pdsdata.evr.EventCodeV3
_pdsdata.evr.EventCodeV3

Class _pdsdata.evr.EventCodeV3

Python wrapper for pdsdata/evr/EventCodeV3 class.


Construction

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


Method code()

Usage: val = evtcode.code()

Returns integer number.


Method isReadout()

Usage: val = evtcode.isReadout()

Returns Boolean value.


Method isTerminator()

Usage: val = evtcode.isTerminator()

Returns Boolean value.


Method maskTrigger()

Usage: val = evtcode.maskTrigger()

Returns integer value.


Method maskSet()

Usage: val = evtcode.maskSet()

Returns integer value.


Method maskClear()

Usage: val = evtcode.maskClear()

Returns integer value.

...

Panel

Anchor
_pdsdata.evr.EventCodeV4
_pdsdata.evr.EventCodeV4

Class _pdsdata.evr.EventCodeV4

Python wrapper for pdsdata/evr/EventCodeV4 class.


Construction

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


Method code()

Usage: val = evtcode.code()

Returns integer number.


Method isReadout()

Usage: val = evtcode.isReadout()

Returns Boolean value.


Method isTerminator()

Usage: val = evtcode.isTerminator()

Returns Boolean value.


Method reportDelay()

Usage: val = evtcode.reportDelay()

Returns integer value.


Method reportWidth()

Usage: val = evtcode.reportWidth()

Returns integer value.


Method maskTrigger()

Usage: val = evtcode.maskTrigger()

Returns integer value.


Method maskSet()

Usage: val = evtcode.maskSet()

Returns integer value.


Method maskClear()

Usage: val = evtcode.maskClear()

Returns integer value.

...

Panel

Anchor
_pdsdata.evr.IOChannel
_pdsdata.evr.IOChannel

Class _pdsdata.evr.IOChannel

Python wrapper for pdsdata/evr/IOChannel class.


Construction

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


Method name()

Usage: val = channel.name()

Returns string value.


Method ninfo()

Usage: val = channel.ninfo()

Returns integer value representing the number of info objects.


Method info()

Usage: val = channel.info(index)

Returns xtc.DetInfo object.

Arguments:

  • index – info object index, non-negative number below ninfo() value.

...

Panel

Anchor
_pdsdata.evr.IOConfigV1
_pdsdata.evr.IOConfigV1

Class _pdsdata.evr.IOConfigV1

Python wrapper for pdsdata/evr/IOConfigV1 class.


Construction

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


Method conn()

Usage: val = config.conn()

Returns evr.OutputMap.Conn enumeration value.


Method nchannels()

Usage: val = config.nchannels()

Returns integer value representing number of channels.


Method channel()

Usage: val = config.channel(index)

Returns evr.IOChannel object for given index.

Arguments:

  • index – channel index, non-negative number below nchannels() value.

...

Panel

Anchor
_pdsdata.evr.OutputMap
_pdsdata.evr.OutputMap

Class _pdsdata.evr.OutputMap

Python wrapper for pdsdata/evr/OutputMap class.


Enum Source

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

  • OutputMap.Source.Pulse
  • OutputMap.Source.DBus
  • OutputMap.Source.Prescaler
  • OutputMap.Source.Force_High
  • OutputMap.Source.Force_Low

Anchor
_pdsdata.evr.OutputMap.Conn
_pdsdata.evr.OutputMap.Conn

Enum Conn

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

  • OutputMap.Conn.FrontPanel
  • OutputMap.Conn.UnivIO

Construction

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


Method source()

Usage: val = map.source()

Returns value of enum OutputMap.Source.


Method source_id()

Usage: val = map.source_id()

Returns integer number.


Method conn()

Usage: val = map.conn()

Returns value of enum OutputMap.Conn.


Method conn_id()

Usage: val = map.conn_id()

Returns integer number.


Method map()

Usage: val = map.map()

Returns encoded source value as integer number.

...

Panel

Anchor
_pdsdata.evr.PulseConfig
_pdsdata.evr.PulseConfig

Class _pdsdata.evr.PulseConfig

Python wrapper for pdsdata/evr/PulseConfig class.


Construction

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


Method pulse()

Usage: val = config.pulse()

Returns internal pulse generation channel as integer number.


Method trigger()

Usage: val = config.trigger()

Returns integer number.


Method set()

Usage: val = config.set()

Returns integer number.


Method clear()

Usage: val = config.clear()

Returns integer number.


Method polarity()

Usage: val = config.polarity()

Returns Boolean value.


Method map_set_enable()

Usage: val = config.map_set_enable()

Returns Boolean value.


Method map_reset_enable()

Usage: val = config.map_reset_enable()

Returns Boolean value.


Method map_trigger_enable()

Usage: val = config.map_trigger_enable()

Returns Boolean value.


Method prescale()

Usage: val = config.prescale()

Returns integer number.


Method delay()

Usage: val = config.delay()

Returns integer number.


Method width()

Usage: val = config.width()

Returns integer number.

...

Panel

Anchor
_pdsdata.evr.PulseConfigV3
_pdsdata.evr.PulseConfigV3

Class _pdsdata.evr.PulseConfigV3

Python wrapper for pdsdata/evr/PulseConfigV3 class.


Construction

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


Method pulseId()

Usage: val = config.pulseId()

Returns integer number.


Method polarity()

Usage: val = config.polarity()

Returns Boolean value.


Method prescale()

Usage: val = config.prescale()

Returns integer number.


Method delay()

Usage: val = config.delay()

Returns integer number.


Method width()

Usage: val = config.width()

Returns integer number.

...

Panel

Anchor
_pdsdata.fccd.FccdConfigV1
_pdsdata.fccd.FccdConfigV1

Class _pdsdata.fccd.FccdConfigV1

Python wrapper for pdsdata/fccd/FccdConfigV1 class.


Enum Depth

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

  • ConfigV1.Depth.Sixteen_bit

Enum Output_Source

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

  • ConfigV1.Output_Source.Output_FIFO
  • ConfigV1.Output_Source.Output_Pattern4

Construction

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


Method width()

Usage: val = config.width()

Returns integer number.


Method height()

Usage: val = config.height()

Returns integer number.


Method trimmedWidth()

Usage: val = config.trimmedWidth()

Returns integer number.


Method trimmedHeight()

Usage: val = config.trimmedHeight()

Returns integer number.


Method outputMode()

Usage: val = config.outputMode()

Returns integer number.


Method size()

Usage: val = config.size()

Returns integer number.

...

Panel

Anchor
_pdsdata.fccd.FccdConfigV2
_pdsdata.fccd.FccdConfigV2

Class _pdsdata.fccd.FccdConfigV2

Python wrapper for pdsdata/fccd/FccdConfigV2 class.


Enum Depth

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

  • ConfigV2.Depth.Eight_bit
  • ConfigV2.Depth.Sixteen_bit

Enum Output_Source

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

  • ConfigV2.Output_Source.Output_FIFO
  • ConfigV2.Output_Source.Test_Pattern1
  • ConfigV2.Output_Source.Test_Pattern2
  • ConfigV2.Output_Source.Test_Pattern3
  • ConfigV2.Output_Source.Test_Pattern4

Construction

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


Method width()

Usage: val = config.width()

Returns integer number.


Method height()

Usage: val = config.height()

Returns integer number.


Method trimmedWidth()

Usage: val = config.trimmedWidth()

Returns integer number.


Method trimmedHeight()

Usage: val = config.trimmedHeight()

Returns integer number.


Method outputMode()

Usage: val = config.outputMode()

Returns integer number.


Method size()

Usage: val = config.size()

Returns integer number.


Method ccdEnable()

Usage: val = config.ccdEnable()

Returns Boolean value.


Method focusMode()

Usage: val = config.focusMode()

Returns Boolean value.


Method exposureTime()

Usage: val = config.exposureTime()

Returns integer number.


Methods dacVoltageXX()

Usage: val = config.dacVoltage1() to val = config.dacVoltage17()

Returns floating number.


Methods waveformXX()

Usage: val = config.waveform0() to val = config.waveform14()

Returns integer number.

...

Panel

Anchor
_pdsdata.ipimb.ConfigV1
_pdsdata.ipimb.ConfigV1

Class _pdsdata.ipimb.ConfigV1

Python wrapper for pdsdata/ipimb/ConfigV1 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 serialID()

Usage: val = config.serialID()

Returns integer number.


Method chargeAmpRange()

Usage: val = config.chargeAmpRange()

Returns integer number.


Method calibrationRange()

Usage: val = config.calibrationRange()

Returns integer number.


Method resetLength()

Usage: val = config.resetLength()

Returns integer number.


Method resetDelay()

Usage: val = config.resetDelay()

Returns integer number.


Method chargeAmpRefVoltage()

Usage: val = config.chargeAmpRefVoltage()

Returns floating number.


Method calibrationVoltage()

Usage: val = config.calibrationVoltage()

Returns floating number.


Method diodeBias()

Usage: val = config.diodeBias()

Returns floating number.


Method status()

Usage: val = config.status()

Returns integer number.


Method errors()

Usage: val = config.errors()

Returns integer number.


Method calStrobeLength()

Usage: val = config.calStrobeLength()

Returns integer number.


Method trigDelay()

Usage: val = config.trigDelay()

Returns 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.

...

Panel

Anchor
_pdsdata.lusi.DiodeFexConfigV1
_pdsdata.lusi.DiodeFexConfigV1

Class _pdsdata.lusi.DiodeFexConfigV1

Python wrapper for pdsdata/lusi/DiodeFexConfigV1 class.


Construction

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


Property base

Usage: val = config.base

Returns list of floating numbers.


Property scale

Usage: val = config.scale

Returns list of floating numbers.

...

Panel

Anchor
_pdsdata.lusi.DiodeFexV1
_pdsdata.lusi.DiodeFexV1

Class _pdsdata.lusi.DiodeFexV1

Python wrapper for pdsdata/lusi/DiodeFexV1 class.


Construction

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


Property value

Usage: val = obj.value

Returns floating number.

...

Panel

Anchor
_pdsdata.lusi.IpmFexConfigV1
_pdsdata.lusi.IpmFexConfigV1

Class _pdsdata.lusi.IpmFexConfigV1

Python wrapper for pdsdata/lusi/IpmFexConfigV1 class.


Construction

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


Property diode

Usage: val = obj.diode

Returns list of _pdsdata.lusi.DiodeFexConfigV1 objects.


Property xscale

Usage: val = obj.xscale

Returns floating number.


Property yscale

Usage: val = obj.yscale

Returns floating number.

...

Panel

Anchor
_pdsdata.lusi.IpmFexV1
_pdsdata.lusi.IpmFexV1

Class _pdsdata.lusi.IpmFexV1

Python wrapper for pdsdata/lusi/IpmFexV1 class.


Construction

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


Property channel

Usage: val = obj.channel

Returns list of floating numbers.


Property sum

Usage: val = obj.sum

Returns floating number.


Property xpos

Usage: val = obj.xpos

Returns floating number.


Property ypos

Usage: val = obj.ypos

Returns floating number.

...

Panel

Anchor
_pdsdata.lusi.PimImageConfigV1
_pdsdata.lusi.PimImageConfigV1

Class _pdsdata.lusi.PimImageConfigV1

Python wrapper for pdsdata/lusi/PimImageConfigV1 class.


Construction

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


Property xscale

Usage: val = obj.xscale

Returns floating number.


Property yscale

Usage: val = obj.yscale

Returns floating number.

...

Panel

Anchor
_pdsdata.opal1k.ConfigV1
_pdsdata.opal1k.ConfigV1

Class _pdsdata.opal1k.ConfigV1

Python wrapper for pdsdata/opal1k/ConfigV1 class.


Constants

  • LUT_Size
  • Row_Pixels
  • Column_Pixels

Enum Depth

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

  • ConfigV1.Depth.Eight_bit
  • ConfigV1.Depth.Ten_bit
  • ConfigV1.Depth.Twelve_bit

Enum Binning

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

  • ConfigV1.Binning.x1
  • ConfigV1.Binning.x2
  • ConfigV1.Binning.x4
  • ConfigV1.Binning.x8

Enum Mirroring

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

  • ConfigV1.Mirroring.None
  • ConfigV1.Mirroring.HFlip
  • ConfigV1.Mirroring.VFlip
  • ConfigV1.Mirroring.HVFlip

Construction

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


Method black_level()

Usage: val = config.black_level()

Returns offset/pedestal setting for camera (before gain) as integer number.


Method gain_percent()

Usage: val = config.gain_percent()

Wiki Markup
Returns camera gain setting in percentile (\[100-3200\] = \[1x-32x\]) as integer number.


Method output_offset()

Usage: val = config.output_offset()

Returns offset/pedestal value in pixel counts as integer number.


Method output_resolution()

Usage: val = config.output_resolution()

Returns bit-depth of pixel counts as enum ConfigV1.Depth.


Method output_resolution_bits()

Usage: val = config.output_resolution_bits()

Returns bit-depth of pixel counts (in actual bits).


Method vertical_binning()

Usage: val = config.vertical_binning()

Returns vertical re-binning of output (consecutive rows summed) as enum ConfigV1.Binning.


Method output_mirroring()

Usage: val = config.output_mirroring()

Returns geometric transformation of the image as enum ConfigV1.Mirroring.


Method vertical_remapping()

Usage: val = config.vertical_remapping()

Returns Boolean, true: remap the pixels to appear in natural geometric order (left->right, top->bottom), false: pixels appear on dual taps from different rows (left->right, top->bottom) alternated with (left->right, bottom->top) pixel by pixel.


Method defect_pixel_correction_enabled()

Usage: val = config.defect_pixel_correction_enabled()

Returns Boolean value.


Method output_lookup_table_enabled()

Usage: val = config.output_lookup_table_enabled()

Returns Boolean value.


Method output_lookup_table()

Usage: val = config.output_lookup_table()

Returns output lookup table as NumPy array, elements of array are unsigned numbers.


Method number_of_defect_pixels()

Usage: val = config.number_of_defect_pixels()

Returns defective pixel count.


Method defect_pixel_coordinates()

Usage: val = config.defect_pixel_coordinates()

Returns list of defective pixel coordinates, elements of the list have type camera.FrameCoord.


Method size()

Usage: val = config.size()

Returns total size of this structure.

...

Panel

Anchor
_pdsdata.pnccd.ConfigV1
_pdsdata.pnccd.ConfigV1

Class _pdsdata.pnccd.ConfigV1

Python wrapper for pdsdata/pnCCD/ConfigV1 class.


Construction

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


Method numLinks()

Usage: val = config.numLinks()

Returns number of links.


Method payloadSizePerLink()

Usage: val = config.payloadSizePerLink()

Returns data size per link.

...

Panel

Anchor
_pdsdata.pnccd.ConfigV2
_pdsdata.pnccd.ConfigV2

Class _pdsdata.pnccd.ConfigV2

Python wrapper for pdsdata/pnCCD/ConfigV2 class.


Construction

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


Method numLinks()

Usage: val = config.numLinks()

Returns number of links.


Method payloadSizePerLink()

Usage: val = config.payloadSizePerLink()

Returns data size per link.


Method numChannels()

Usage: val = config.numChannels()

Returns number of channels.


Method numRows()

Usage: val = config.numRows()

Returns number of rows.


Method numSubmoduleChannels()

Usage: val = config.numSubmoduleChannels()

Returns integer number.


Method numSubmoduleRows()

Usage: val = config.numSubmoduleRows()

Returns integer number.


Method numSubmodules()

Usage: val = config.numSubmodules()

Returns integer number.


Method camexMagic()

Usage: val = config.camexMagic()

Returns integer number.


Method info()

Usage: val = config.info()

Returns string.


Method timingFName()

Usage: val = config.timingFName()

Returns string.


Method size()

Usage: val = config.size()

Returns size of the object.

...

Panel

Anchor
_pdsdata.pnccd.FrameV1
_pdsdata.pnccd.FrameV1

Class _pdsdata.pnccd.FrameV1

Python wrapper for pdsdata/pnCCD/FrameV1 class.


Construction

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


Method specialWord()

Usage: val = frame.specialWord()

Returns integer number.


Method frameNumber()

Usage: val = frame.frameNumber()

Returns integer number.


Method timeStampHi()

Usage: val = frame.timeStampHi()

Returns integer number.


Method timeStampLo()

Usage: val = frame.timeStampLo()

Returns integer number.


Method next()

Usage: val = frame.next(config)

Returns next frame object or None.

Arguments:


Method data()

Usage: val = frame.data(config)

Returns frame data as NumPy 2-dimensional array of integers of size 512x512.

Arguments:


Method sizeofData()

Usage: val = frame.sizeofData(config)

Returns integer number.

Arguments:

...

Panel

Anchor
_pdsdata.princeton.ConfigV1
_pdsdata.princeton.ConfigV1

Class _pdsdata.princeton.ConfigV1

Python wrapper for pdsdata/princeton/ConfigV1 class.


Construction

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


Method width()

Usage: val = config.width()

Returns integer number.


Method height()

Usage: val = config.height()

Returns integer number.


Method orgX()

Usage: val = config.orgX()

Returns integer number.


Method orgY()

Usage: val = config.orgY()

Returns integer number.


Method binX()

Usage: val = config.binX()

Returns integer number.


Method binY()

Usage: val = config.binY()

Returns integer number.


Method exposureTime()

Usage: val = config.exposureTime()

Returns floating number.


Method coolingTemp()

Usage: val = config.coolingTemp()

Returns floating number.


Method readoutSpeedIndex()

Usage: val = config.readoutSpeedIndex()

Returns integer number.


Method readoutEventCode()

Usage: val = config.readoutEventCode()

Returns integer number.


Method delayMode()

Usage: val = config.delayMode()

Returns integer number.


Method size()

Usage: val = config.size()

Returns integer number.


Method frameSize()

Usage: val = config.frameSize()

Returns calculated frame size based on the current ROI and binning settings.

...

Panel

Anchor
_pdsdata.princeton.FrameV1
_pdsdata.princeton.FrameV1

Class _pdsdata.princeton.FrameV1

Python wrapper for pdsdata/princeton/FrameV1 class.


Construction

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


Method shotIdStart()

Usage: val = config.shotIdStart()

Returns integer number.


Method readoutTime()

Usage: val = config.readoutTime()

Returns floating number.


Method data()

Usage: val = config.data(config)

Returns frame data as NumPy 2-dimensional array of integers, size is determined by the configuration object.

Arguments:

...

Panel

Anchor
_pdsdata.princeton.InfoV1
_pdsdata.princeton.InfoV1

Class _pdsdata.princeton.InfoV1

Python wrapper for pdsdata/princeton/InfoV1 class.


Construction

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


Method temperature()

Usage: val = info.temperature()

Returns floating number.

...

Panel

Anchor
_pdsdata.pulnix.TM6740ConfigV1
_pdsdata.pulnix.TM6740ConfigV1

Class _pdsdata.pulnix.TM6740ConfigV1

Python wrapper for pdsdata/pulnix/TM6740ConfigV1 class.


Constants

  • Row_Pixels
  • Column_Pixels

Enum Depth

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

  • TM6740ConfigV1.Depth.Eight_bit
  • TM6740ConfigV1.Depth.Ten_bit

Enum Binning

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

  • TM6740ConfigV1.Binning.x1
  • TM6740ConfigV1.Binning.x2
  • TM6740ConfigV1.Binning.x4

Enum LookupTable

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

  • TM6740ConfigV1.LookupTable.Gamma
  • TM6740ConfigV1.LookupTable.Linear

Construction

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


Method vref()

Usage: val = config.vref()

Returns integer number.


Method gain_a()

Usage: val = config.gain_a()

Returns integer number.


Method gain_b()

Usage: val = config.gain_b()

Returns integer number.


Method gain_balance()

Usage: val = config.gain_balance()

Returns Boolean value.


Method shutter_width()

Usage: val = config.shutter_width()

Returns integer number.


Method output_resolution()

Usage: val = config.output_resolution()

Returns bit-depth of pixel counts as enum TM6740ConfigV1.Depth.


Method output_resolution_bits()

Usage: val = config.output_resolution_bits()

Returns bit-depth of pixel counts (in actual bits).


Method horizontal_binning()

Usage: val = config.horizontal_binning()

Returns horizontal re-binning of output (consecutive columns summed) as enum TM6740ConfigV1.Binning.


Method vertical_binning()

Usage: val = config.vertical_binning()

Returns vertical re-binning of output (consecutive rows summed) as enum TM6740ConfigV1.Binning.


Method lookuptable_mode()

Usage: val = config.lookuptable_mode()

Returns output lookup table corrections as enum TM6740ConfigV1.LookupTable.

...

Panel

Anchor
_pdsdata.pulnix.TM6740ConfigV2
_pdsdata.pulnix.TM6740ConfigV2

Class _pdsdata.pulnix.TM6740ConfigV2

Python wrapper for pdsdata/pulnix/TM6740ConfigV2 class.


Constants

  • Row_Pixels
  • Column_Pixels

Enum Depth

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

  • TM6740ConfigV2.Depth.Eight_bit
  • TM6740ConfigV2.Depth.Ten_bit

Enum Binning

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

  • TM6740ConfigV2.Binning.x1
  • TM6740ConfigV2.Binning.x2
  • TM6740ConfigV2.Binning.x4

Enum LookupTable

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

  • TM6740ConfigV2.LookupTable.Gamma
  • TM6740ConfigV2.LookupTable.Linear

Construction

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


Method vref_a()

Usage: val = config.vref_a()

Returns integer number.


Method vref_b()

Usage: val = config.vref_b()

Returns integer number.


Method gain_a()

Usage: val = config.gain_a()

Returns integer number.


Method gain_b()

Usage: val = config.gain_b()

Returns integer number.


Method gain_balance()

Usage: val = config.gain_balance()

Returns Boolean value.


Method output_resolution()

Usage: val = config.output_resolution()

Returns bit-depth of pixel counts as enum TM6740ConfigV2.Depth.


Method output_resolution_bits()

Usage: val = config.output_resolution_bits()

Returns bit-depth of pixel counts (in actual bits).


Method horizontal_binning()

Usage: val = config.horizontal_binning()

Returns horizontal re-binning of output (consecutive columns summed) as enum TM6740ConfigV2.Binning.


Method vertical_binning()

Usage: val = config.vertical_binning()

Returns vertical re-binning of output (consecutive rows summed) as enum TM6740ConfigV2.Binning.


Method lookuptable_mode()

Usage: val = config.lookuptable_mode()

Returns output lookup table corrections as enum TM6740ConfigV2.LookupTable.

...

Panel

Anchor
pypdsdata.acqiris.DataDescV1
pypdsdata.acqiris.DataDescV1

Class pypdsdata.acqiris.DataDescV1

This class overrides several methods in the corresponding _pdsdata.acqiris.DataDescV1 class to simplify user API.


Construction

Usage: dd = DataDescV1(orig, hcfg, vcfg)

Arguments:


Method nbrSamplesInSeg()

Usage: nsampl = dd.nbrSamplesInSeg()

Returns integer number.


Method nbrSegments()

Usage: nseg = dd.nbrSegments()

Returns integer number.


Method timestamp()

Usage: ts = dd.timestamp(segment)

Returns object of acqiris.TimestampV1 type.

Arguments:

  • segment - segment number

Method waveform()

Usage: wf = dd.waveform()

Returns waveform array of numpy.ndarray type.


Method timestamps()

Usage: ts = dd.timestamps()

Returns NumPy array of timestamps (floating numbers). First element of array is always 0, other elements are equidistant with the distance and number of intervals determined by acqiris.HorizV1 object.

...

Panel

Anchor
pypdsdata.cspad.ElementV1
pypdsdata.cspad.ElementV1

Class pypdsdata.cspad.ElementV1

This class overrides several methods in the corresponding _pdsdata.cspad.ElementV1 class to simplify user API. It also changes shape of the data array returned from data() method.


Class constants

  • ElementV1.ColumnsPerASIC
  • ElementV1.MaxRowsPerASIC

Construction

Usage: elem = ElementV1(quad, config)

Arguments:


Method virtual_channel()

Usage: val = elem.virtual_channel()

Returns integer number.


Method lane()

Usage: val = elem.lane()

Returns integer number.


Method tid()

Usage: val = elem.tid()

Returns integer number.


Method acq_count()

Usage: val = elem.acq_count()

Returns integer number.


Method op_code()

Usage: val = elem.op_code()

Returns integer number.


Method quad()

Usage: val = elem.quad()

Returns integer number.


Method seq_count()

Usage: val = elem.seq_count()

Returns integer number.


Method ticks()

Usage: val = elem.ticks()

Returns integer number.


Method fiducials()

Usage: val = elem.fiducials()

Returns integer number.


Method frame_type()

Usage: val = elem.frame_type()

Returns integer number.


Method sb_temp()

Usage: val = elem.sb_temp(index)

Returns integer number, index is a number from 0 to 3.


Method data()

Usage: val = elem.data()

Returns data array. Dimensions of array are nAsic x MaxRowsPerASIC x ColumnsPerASIC, nAsic is the number returned by config object's numAsicsRead() method.


Method pixel()

Usage: val = elem.pixel(asic, column, row)

Returns value of a given pixel.

...

Panel

Anchor
pypdsdata.pnccd.FrameV1
pypdsdata.pnccd.FrameV1

Class pypdsdata.pnccd.FrameV1

This class overrides several methods in the corresponding _pdsdata.pnccd.FrameV1 class to simplify user API. In particular it merges four images from PnCCD into one larger image.


Construction

Usage: frame = FrameV1(frames, config)

Arguments:


Method specialWord()

Usage: val = frame.specialWord()

Returns integer number.


Method frameNumber()

Usage: val = frame.frameNumber()

Returns integer number.


Method timeStampHi()

Usage: val = frame.timeStampHi()

Returns integer number.


Method timeStampLo()

Usage: val = frame.timeStampLo()

Returns integer number.


Method data()

Usage: val = frame.data()

Returns frame data as NumPy 2-dimensional array of integers of size 1024x1024.


Method sizeofData()

Usage: val = frame.sizeofData()

Returns integer number.

...

Panel

Anchor
pypdsdata.princeton.FrameV1
pypdsdata.princeton.FrameV1

Class pypdsdata.princeton.FrameV1

This class overrides several methods in the corresponding _pdsdata.princeton.FrameV1 class to simplify user API.


Construction

Usage: frame = FrameV1(frames, config)

Arguments:


Method shotIdStart()

Usage: val = frame.shotIdStart()

Returns integer number.


Method readoutTime()

Usage: val = frame.readoutTime()

Returns floating number.


Method data()

Usage: val = frame.data()

Returns frame data as NumPy 2-dimensional array of integers.