Abstract device classes

These classes are not for direct use as an instrument component, but for deriving custom device classes from them. They extend the base classes in nicos.core.device, which are also abstract, but are a little more concrete.

Axis-related classes

class nicos.abstract.Coder

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

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

class nicos.abstract.Axis

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

Detector-related classes

class nicos.abstract.ImageStorage

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

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