Versions Compared

Key

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

...

This package is a user-level interface to lower-level _pdsdata package. It repeats the module structure of _pdsdata and defines the same classes but shields user from unnecessary details present in _pdsdata. In many cases pypdsdata imports the class from _pdsdata without any changes. Documentation below only describes cases when pypdsdata changes or extends the corresponding _pdsdata types, for unchanged types consult corresponding _pdsdata} documentation.

Module pypdsdata.acqiris

Panel

Anchor
pypdsdata.acqiris.DataDescV1
pypdsdata.acqiris.DataDescV1

Class DataDescV1

This class overrides several methods in the corresponding [_pdsdata.acqiris.DataDescV1|#_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 FrameV1

This class overrides several methods in the corresponding [_pdsdata.pnccd.FrameV1|#_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.