Versions Compared

Key

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

...

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.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.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.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 checksum()

Usage: val = config.checksum()

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

...

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.