Module uf

The relaxation dispersion API object.

Functions

cluster(cluster_id=None, spin_id=None)
Define spin clustering.

list of str cluster_ids()
Return the current list of cluster ID strings.

model_setup(model, params)
Update various model specific data structures.

r1_fit(fit=True)
Set the R1 optimisation flag.

select_model(model='R2eff')
Set up the model for the relaxation dispersion analysis.

Variables

api_relax_disp = Relax_disp()

__package__ = 'specific_analyses.relax_disp'

Imports: deepcopy, MODEL_DESC, MODEL_LIST_FULL, MODEL_PARAMS, MODEL_R2EFF, RelaxError, check_mol_res_spin_data, spin_loop, check_pipe, Relax_disp, check_c_modules, check_exp_type, check_pipe_type, get_curve_type

Function Details

cluster(cluster_id=None, spin_id=None)

Define spin clustering.

Parameters:

• cluster_id (str) - The cluster ID string.
• spin_id (str) - The spin ID string for the spin or group of spins to add to the cluster.

cluster_ids()

Return the current list of cluster ID strings.

Returns: list of str

The list of cluster IDs.

model_setup(model, params)

Update various model specific data structures.

Parameters:

• model (str) - The relaxation dispersion curve type.
• params (list of str) - A list consisting of the model parameters.

r1_fit(fit=True)

Set the R1 optimisation flag.

Parameters:

• fit (bool) - The R1 optimisation flag.

select_model(model='R2eff')

Set up the model for the relaxation dispersion analysis.

Parameters:

• model (str) - The relaxation dispersion analysis type.