Versions Compared

Key

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

...

Panel

Anchor
_pdsdata.control.PVMonitor
_pdsdata.control.PVMonitor

Class _pdsdata.control.PVMonitor

Python wrapper for pdsdata/control/PVMonitor class.


Construction

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


Method name()

Usage: val = control.name()

Returns name of the monitoring channel.


Method array()

Usage: val = control.array()

Returns true for array.


Method index()

Usage: val = control.index()

Returns index in the array.


Method loValue()

Usage: val = control.loValue()

Returns low value as floating number.


Method hiValue()

Usage: val = control.hiValue()

Returns high value as floating number.

...

Anchor
_pdsdata.encoder
_pdsdata.encoder

Module _pdsdata.encoder

This module contains classes corresponding to those in C++ pdsdata/encoder package.

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.

...

Anchor
_pdsdata.epics
_pdsdata.epics

Module _pdsdata.epics

...

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

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