Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: added pypdsdata.cspad.ElementV1 class

...

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.

...

Anchor
pypdsdata.cspad
pypdsdata.cspad

Module pypdsdata.cspad

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.

...

Anchor
pypdsdata.pnccd
pypdsdata.pnccd

Module pypdsdata.pnccd

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.