Package specific_analyses :: Package relax_disp :: Module checks
[hide private]
[frames] | no frames]

Module checks

source code

Module for functions for checking different aspects of the dispersion setup.

These functions raise various RelaxErrors to help the user understand what went wrong. To avoid circular imports, these functions must be independent and not import anything from the specific_analyses.relax_disp package (the variables module is an exception).

Functions [hide private]
 
check_c_modules()
Check for the presence of the compiled C-modules.
source code
 
check_disp_points()
Check that the CPMG frequencies or spin-lock field strengths have been set up.
source code
 
check_exp_type(id=None)
Check if the experiment type have been set up for one or all IDs.
source code
 
check_exp_type_fixed_time()
Check that only fixed time experiment types have been set up.
source code
 
check_interpolate_offset_cpmg_model(interpolate=None) source code
 
check_mixed_curve_types()
Prevent both fixed time and exponential curves from being analysed simultaneously.
source code
 
check_model_type(model=None)
Check that the dispersion model has been set.
source code
 
check_pipe_type()
Check that the data pipe type is that of relaxation dispersion.
source code
bool
check_missing_r1(model=None)
Check if R1 data is missing for the model.
source code
 
check_relax_times()
Check if the spectrometer frequencies have been set up.
source code
 
check_spectra_id_setup()
Check that the data for each spectra ID is correctly set up.
source code
 
check_spectrometer_frq()
Check if the spectrometer frequencies have been set up.
source code
 
check_spectrum_ids()
Check if spectrum IDs exist.
source code
dict of float
get_times()
Create a per-experiment dictionary of relaxation times.
source code
Variables [hide private]
  __package__ = 'specific_analyses.relax_disp'

Imports: C_module_exp_fn, EXP_TYPE_LIST_CPMG, EXP_TYPE_LIST_R1RHO, MODEL_LIST_R1RHO_OFF_RES, MODEL_NOREX, RelaxError, RelaxFuncSetupError, RelaxNoPeakIntensityError, specific_analyses


Function Details [hide private]

check_c_modules()

source code 

Check for the presence of the compiled C-modules.

Raises:
  • RelaxError - If the compiled C-module is not present and exponential curves are required.

check_disp_points()

source code 

Check that the CPMG frequencies or spin-lock field strengths have been set up.

Raises:
  • RelaxError - If the dispersion point data is missing.

check_exp_type(id=None)

source code 

Check if the experiment type have been set up for one or all IDs.

Parameters:
  • id (None or str) - The experiment ID string. If not set, then all spectrum IDs will be checked.
Raises:
  • RelaxError - When the experiment type for the given ID is missing or, when not given, if the dispersion experiment type has not been set.

check_exp_type_fixed_time()

source code 

Check that only fixed time experiment types have been set up.

Raises:

check_mixed_curve_types()

source code 

Prevent both fixed time and exponential curves from being analysed simultaneously.

Raises:

check_model_type(model=None)

source code 

Check that the dispersion model has been set.

Parameters:
  • model (str) - The model which to select.
Raises:
  • RelaxError - If the dispersion model has not been specified.

check_pipe_type()

source code 

Check that the data pipe type is that of relaxation dispersion.

Raises:

check_missing_r1(model=None)

source code 

Check if R1 data is missing for the model.

Parameters:
  • model (str) - The model to test for.
Returns: bool
Return True if R1 data is not available for the model.

check_relax_times()

source code 

Check if the spectrometer frequencies have been set up.

Raises:
  • RelaxError - If the spectrometer frequencies have not been set.

check_spectra_id_setup()

source code 

Check that the data for each spectra ID is correctly set up.

This is an alias for the following checks:

  • check_spectrum_ids()
  • check_exp_type()
  • check_spectrometer_frq()
  • check_disp_points()
  • check_relax_times()
Raises:

check_spectrometer_frq()

source code 

Check if the spectrometer frequencies have been set up.

Raises:
  • RelaxError - If the spectrometer frequencies have not been set.

check_spectrum_ids()

source code 

Check if spectrum IDs exist.

Raises:

get_times()

source code 

Create a per-experiment dictionary of relaxation times.

Returns: dict of float
The dictionary of unique relaxation times.