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).
|
|
|
|
|
|
|
|
|
check_interpolate_offset_cpmg_model(interpolate=None) |
source code
|
|
|
|
|
|
|
|
bool
|
|
|
|
|
|
|
|
|
|
dict of float
|
|
|
__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
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 that the CPMG frequencies or spin-lock field strengths have been
set up.
- Raises:
RelaxError - If the dispersion point data is missing.
|
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 that only fixed time experiment types have been set up.
- Raises:
|
Prevent both fixed time and exponential curves from being analysed
simultaneously.
- Raises:
|
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 that the data pipe type is that of relaxation dispersion.
- Raises:
|
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 if the spectrometer frequencies have been set up.
- Raises:
RelaxError - If the spectrometer frequencies have not been set.
|
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 if the spectrometer frequencies have been set up.
- Raises:
RelaxError - If the spectrometer frequencies have not been set.
|
Check if spectrum IDs exist.
- Raises:
|
Create a per-experiment dictionary of relaxation times.
- Returns: dict of float
- The dictionary of unique relaxation times.
|