Versions Compared

Key

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

...

Panel

Anchor
_pdsdata.camera.TwoDGaussianV1
_pdsdata.camera.TwoDGaussianV1

Class TwoDGaussianV1

Python wrapper for pdsdata/camera/TwoDGaussianV1 class.


Construction

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


Method integral()

Usage: val = gauss.integral()

Returns integral statistics as integer number.


Method xmean()

Usage: val = gauss.xmean()

Returns mean X value as floating number.


Method ymean()

Usage: val = gauss.ymean()

Returns mean Y value as floating number.


Method major_axis_width()

Usage: val = gauss.major_axis_width()

Returns width of major axis as floating number.


Method minor_axis_width()

Usage: val = gauss.minor_axis_width()

Returns width of minor axis as floating number.


Method major_axis_tilt()

Usage: val = gauss.major_axis_tilt()

Returns tilt of major axis as floating number.

...

Module _pdsdata.control

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

Panel

Anchor
_pdsdata.control.ConfigV1
_pdsdata.control.ConfigV1

Class ConfigV1

Python wrapper for pdsdata/control/ConfigV1 class.


Construction

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


Method uses_duration()

Usage: val = config.uses_duration()

Returns Boolean value.


Method uses_events()

Usage: val = config.uses_events()

Returns Boolean value.


Method duration()

Usage: clock = config.duration()

Returns value of xtc.ClockTime type.


Method events()

Usage: val = config.events()

Returns number of events.


Method npvControls()

Usage: val = config.npvControls()

Returns number of PVControls.


Method npvMonitors()

Usage: val = config.npvMonitors()

Returns number of PVMonitors.


Method size()

Usage: val = config.size()

Returns total data size.


Method pvControl()

Usage: val = config.pvControl(index)

Returns PVControl for a given index.


Method pvMonitor()

Usage: val = config.pvMonitor(index)

Returns PVMonitor for a given index.

...

Panel

Anchor
_pdsdata.control.PVControl
_pdsdata.control.PVControl

Class PVControl

Python wrapper for pdsdata/control/PVControl 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 if the channel is an array.


Method index()

Usage: val = control.index()

Returns index in the array.


Method value()

Usage: val = control.value()

Returns value as floating number.

...

Panel

Anchor
_pdsdata.control.PVMonitor
_pdsdata.control.PVMonitor

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