abstract Package

abstract Package

Definition of abstract base device classes.

class nicos.abstract.AsyncDetector(name, **config)

Bases: nicos.core.device.Measurable

Bases: Measurable

Base class for a detector that needs to execute code during measurement.

Parameters inherited from the base classes: description, fmtstr, loglevel, lowlevel, maxage, pollinterval, unit

class nicos.abstract.Axis(name, **config)

Bases: nicos.core.device.HasLimits, nicos.core.device.HasOffset, nicos.core.device.HasPrecision, nicos.core.device.Moveable

Bases: HasLimits, HasOffset, HasPrecision, Moveable

Base class for all axes.

Parameters

backlash (float, settable at runtime)

The maximum allowed backlash. Default value: 0.0. Unit: same as device value.

dragerror (float, settable at runtime)

The so called ‘Schleppfehler’ of the axis. Default value: 1. Unit: same as device value.

loopdelay (float, settable at runtime)

The sleep time when checking the movement. Default value: 0.29999999999999999. Unit: s.

maxtries (int, settable at runtime)

Number of tries to reach the target. Default value: 3.

Parameters inherited from the base classes: abslimits, description, fixed, fmtstr, loglevel, lowlevel, maxage, offset, pollinterval, precision, target, unit, userlimits

class nicos.abstract.Coder(name, **config)

Bases: nicos.core.device.HasPrecision, nicos.core.device.Readable

Bases: HasPrecision, Readable

Base class for all coders.

User methods

setPosition(pos)

Sets the current position of the controller to the target.

Parameters inherited from the base classes: description, fmtstr, loglevel, lowlevel, maxage, pollinterval, precision, unit

class nicos.abstract.ImageStorage(name, **config)

Bases: nicos.core.device.Device, nicos.data.NeedsDatapath

Bases: Device, NeedsDatapath

Mixin for detectors that store images in their own directory.

Parameters

lastfilename (str, settable at runtime)

File name of the last measurement. Default value: ''.

lastfilenumber (int, settable at runtime)

File number of the last measurement. Default value: 0.

nametemplate (str, settable at runtime)

Template for data file names. Default value: '%08d.dat'.

subdir (str, mandatory in setup)

Subdirectory name for the image files.

Parameters inherited from the base classes: datapath, description, loglevel, lowlevel

class nicos.abstract.Motor(name, **config)

Bases: nicos.core.device.HasLimits, nicos.core.device.Moveable, nicos.abstract.Coder, nicos.core.device.HasPrecision

Bases: HasLimits, Moveable, Coder, HasPrecision

Base class for all motors.

This class inherits from Coder since a Motor can be used instead of a true encoder to supply the current position to an Axis.

Parameters

speed (float, settable at runtime)

The motor speed. Default value: 0.0. Unit: main/s.

Parameters inherited from the base classes: abslimits, description, fixed, fmtstr, loglevel, lowlevel, maxage, pollinterval, precision, target, unit, userlimits