Module spectrometer

Module for manipulating the spectrometer experimental information.

Functions

None or RelaxError instance check_frequency_func(id=None)
Check that the frequency for the given ID has been set.

None or RelaxError instance check_spectrometer_setup_func()
Check that spectrometer frequencies have been set up.

copy_frequencies(pipe_from=None, pipe_to=None, id=None)
Copy the frequency information from one data pipe to another.

delete_frequencies(id=None)
Delete the spectrometer frequency corresponding to the experiment ID.

frequency_checks(frq)
Perform a number of checks on the given proton frequency.

float get_frequency(id=None)
Return the frequency corresponding to the given ID.

list of float get_frequencies(units='Hz')
Return a list of all the current spectrometer frequencies.

float loop_frequencies()
Generator function for looping over the spectrometer frequencies.

set_frequency(id=None, frq=None, units='Hz')
Set the spectrometer frequency of the experiment.

set_temperature(id=None, temp=None)
Set the experimental temperature.

Variables

check_frequency = <lib.checks.Check instance at 0x35f1128>

check_spectrometer_setup = <lib.checks.Check instance at 0x35f...

__package__ = 'pipe_control'

Imports: modf, pi, warn, Check, RelaxError, RelaxNoFrqError, periodic_table, RelaxWarning, pipes, check_pipe

Function Details

check_frequency_func(id=None)

Check that the frequency for the given ID has been set.

Parameters:

• id (str) - The experiment ID string.

Returns: None or RelaxError instance

The initialised RelaxError object or nothing.

check_spectrometer_setup_func()

Check that spectrometer frequencies have been set up.

Returns: None or RelaxError instance

The initialised RelaxError object or nothing.

copy_frequencies(pipe_from=None, pipe_to=None, id=None)

Copy the frequency information from one data pipe to another.

Parameters:

• pipe_from (str) - The data pipe to copy the frequency information from. This defaults to the current data pipe.
• pipe_to (str) - The data pipe to copy the frequency information to. This defaults to the current data pipe.
• id (str) - The experiment ID string.

delete_frequencies(id=None)

Delete the spectrometer frequency corresponding to the experiment ID.

Parameters:

• id (str) - The experiment ID string.

frequency_checks(frq)

Perform a number of checks on the given proton frequency.

Parameters:

• frq (float or None) - The proton frequency value in Hertz.

get_frequency(id=None)

Return the frequency corresponding to the given ID.

Parameters:

• id (str) - The experiment ID string.

Returns: float

The spectrometer proton frequency in Hertz for the given ID.

get_frequencies(units='Hz')

Return a list of all the current spectrometer frequencies.

The returned values can be changed with the units argument which can have the following values:

• 'Hz' will return the proton frequency (wH),
• 'MHz' will return the proton frequency in megahertz,
• 'T' will return the B0 field in Tesla.

Parameters:

• units (str) - The magnetic field units to return. This can be one of 'Hz', 'MHz', or 'T'.

Returns: list of float

The frequency list for the current data pipe.

loop_frequencies()

Generator function for looping over the spectrometer frequencies.

Returns: float

The frequency.

set_frequency(id=None, frq=None, units='Hz')

Set the spectrometer frequency of the experiment.

Parameters:

• id (str) - The experiment ID string (allowing for multiple experiments per data pipe).
• frq (float) - The spectrometer frequency in Hertz.
• units (str) - The units of frequency. This can be one of "Hz", "kHz", "MHz", or "GHz".

set_temperature(id=None, temp=None)

Set the experimental temperature.

Parameters:

• id (str) - The experiment ID string (allowing for multiple experiments per data pipe).
• temp (float) - The temperature in Kelvin.

Variables Details

check_spectrometer_setup

Value:

<lib.checks.Check instance at 0x35f1b90>