The heliox module
A software representation of the Oxford Heliox 3He insert.
Classes
Heliox
-
class src.instruments.heliox.Heliox(experiment, name='Heliox', spec=None)[source]
A Heliox 3He insert.
Methods
-
directGetField()[source]
Read the magnetic field from the power supply.
| Returns : | float :
The magnetic field in Tesla.
|
|---|
-
directGetFieldRampRate()[source]
Read the magnetic field sweep rate directly from the power supply.
| Returns : | float :
The magnetic field ramp rate in Tesla/min.
|
|---|
-
directGetFieldSetpoint()[source]
Read the field setpoint from the power supply.
| Returns : | float :
The magnetic field setpoint in Tesla.
|
|---|
-
directGetPID()[source]
Read the PID values from the temperature controller.
| Returns : | tuple of float :
The proportional, integral, and derivative constants for the
temperature controller as floats in a tuple.
|
|---|
-
directGetSampleTemperatures()[source]
Read the sample temperatures from the temperature controller.
| Returns : | tuple of float :
A 2-tuple consisting of the low and high sample temperatures (i.e.
all temperatures except that of the sorb).
|
|---|
-
directGetTemperatureHigh()[source]
Read the sample-high temperature from the temperature controller.
| Returns : | float :
The sample-high temperature in Kelvin.
|
|---|
-
directGetTemperatureLow()[source]
Read the sample-low temperature from the temperature controller.
| Returns : | float :
The sample-low temperature in Kelvin.
|
|---|
-
directGetTemperatureSorb()[source]
Read the sorb temperature from the temperature controller.
| Returns : | float :
The sorb temperature in Kelvin.
|
|---|
-
directGetTemperatures()[source]
Read the temperatures measured on all three sensors.
| Returns : | tuple of float :
A tuple consisting of the sorb temperature, the sample-low
temperature, and the sample-high temperature expressed as floats.
|
|---|
-
finalize()[source]
Finalize the Oxford Heliox.
-
getActions()[source]
Return the list of supported actions.
-
getField()[source]
Get the magnetic field.
| Returns : | float :
The magnetic field in Tesla.
|
|---|
-
getFieldRampRate()[source]
Get the magnetic field sweep rate.
| Returns : | float :
The magnetic field ramp rate in Tesla/min.
|
|---|
-
getFieldSetpoint()[source]
Get the magnetic field setpoint.
| Returns : | float :
The magnetic field setpoint in Tesla.
|
|---|
-
getInformation()[source]
Return the Heliox’s information string.
-
getPID()[source]
Get the PID values.
| Returns : | tuple of float :
The proportional, integral, and derivative constants for the
temperature controller as floats in a tuple.
|
|---|
-
getSampleTemperatures()[source]
Get the sample temperatures.
| Returns : | tuple of float :
A 2-tuple consisting of the low and high sample temperatures (i.e.
all temperatures except that of the sorb).
|
|---|
-
getTemperature()[source]
Get the temperature (a weighted average of the sample temperatures).
-
getTemperatureHigh()[source]
Get the sample-high temperature.
| Returns : | float :
The sample-high temperature in Kelvin.
|
|---|
-
getTemperatureLow()[source]
Get the sample-low temperature.
| Returns : | float :
The sorb temperature in Kelvin.
|
|---|
-
getTemperatureSorb()[source]
Get the sorb temperature.
| Returns : | float :
The sorb temperature in Kelvin.
|
|---|
-
getTemperatures()[source]
Read the temperatures measured on all three sensors.
| Returns : | tuple of float :
A tuple consisting of the sorb temperature, the sample-low
temperature, and the sample-high temperature expressed as floats.
|
|---|
-
initialize()[source]
Initialize the Oxford Heliox.
-
classmethod isSingleton()[source]
Return whether at most one instance of the instrument may exist.
| Returns : | bool :
Whether only zero or one instance of the instrument may exist.
|
|---|
-
setField(field, block='yes')[source]
Set the magnetic field.
| Parameters : | field : float
The magnetic field in Tesla.
wait : str
A string of either ‘wait’ or ‘proceed’ to determine whether to
wait for the field to reach the target.
|
|---|
-
setFieldNoWait(field)[source]
Set the target magnetic field and return.
| Parameters : | field : float
The target magnetic field in Tesla.
|
|---|
-
setFieldRampRate(rampRate)[source]
Set the magnetic field ramp rate.
| Parameters : | rampRate : float
The desired magnetic field ramp rate in Tesla/min.
|
|---|
-
setMode(newMode)[source]
Set the Heliox reading mode.
| Parameters : | newMode : int
An integer (MODE_DIRECT or MODE_THROUGH_MONITOR) to specify the
reading mode. If it is MODE_DIRECT, all data come directly from
the temperature controller. If it is MODE_THROUGH_MONITOR, only
the temperature monitor triggers direct readings from the
controller, and other requests from data receive the most recent
readings so triggered.
|
|---|
-
setPID(newP, newI, newD=0.0)[source]
Set the PID values for the temperature controller.
| Parameters : | newP : float
The proportional band in Kelvin, to a resolution of 0.001 K.
newI : float
The integral action time in minutes. Values between 0 and
140 minutes (inclusive), in steps of 0.1 minutes, are accepted.
newD : float
The derivative action time in minutes. The allowed range is
0 to 273 minutes. The default is 0.0.
|
|---|
-
setTemperature(target)[source]
Set the temperature intelligently.
| Parameters : | target : float
The temperature setpoint.
|
|---|
-
setTemperatureHigh(temperature)[source]
Set the target for the high-temperature sensor.
| Parameters : | temperature : float
The target temperature in Kelvin.
|
|---|
-
setTemperatureLow(temperature)[source]
Set the target for the low-temperature sensor.
| Parameters : | temperature : float
The target temperature in Kelvin.
|
|---|
-
setTemperatureSorb(temperature)[source]
Set the target for the sorb-temperature sensor.
| Parameters : | temperature : float
The target temperature in Kelvin.
|
|---|
HelioxDummy
-
class src.instruments.heliox.HelioxDummy[source]
A dummy class for testing Heliox updating
Methods
-
directGetField()[source]
Dummy...read field from file.
-
directGetTemperatures()[source]
Dummy...read temperature from file.
-
getFieldRampRate()[source]
Dummy...read ramp rate from file.
-
getFieldSetpoint()[source]
Dummy...read field setpoint from file.
-
getPID()[source]
Dummy...read PID from file.
-
getTemperature()[source]
Get the temperature.
-
setField(field, action='wait')[source]
Set the magnetic field.
-
setFieldRampRate(rampRate)[source]
Set the magnetic field ramp rate.
-
setPID(newP, newI, newD)[source]
Set the PID values for the temperature controller.
-
setTemperature(temperature)[source]
Set the sample temperature using the automatic algorithm.
-
setTemperatureSampleHigh(temperature)[source]
Set the sample-high temperature.
-
setTemperatureSampleLow(temperature)[source]
Set the sample-low temperature.
-
setTemperatureSorb(temperature)[source]
Set the sorb temperature.