Package generic_fns :: Module frq
[hide private]
[frames] | no frames]

Module frq

source code

Module for manipulating the spectrometer frequency of experiments.

Functions [hide private]
list of float
get_values()
Return a list of all the current frequencies.
source code
 
set(id=None, frq=None, units='Hz')
Set the spectrometer frequency of the experiment.
source code
Variables [hide private]
  __package__ = 'generic_fns'

Imports: warn, pipes, RelaxError, RelaxWarning


Function Details [hide private]

get_values()

source code 

Return a list of all the current frequencies.

Returns: list of float
The frequency list for the current data pipe.

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

source code 

Set the spectrometer frequency of the experiment.

Parameters:
  • id (str) - The experimental identification 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".