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

Module parameter_object

source code

The module for the relaxation dispersion parameter list object.

Classes [hide private]
Relax_disp_params
The relaxation dispersion parameter list singleton.
Functions [hide private]
float
dw_lower(incs=None, model_info=None)
Determine the lower grid bound for the dw parameters.
source code
float
dwH_lower(incs=None, model_info=None)
Determine the lower grid bound for the dwH parameters.
source code
float
pA_lower(incs=None, model_info=None)
Determine the lower grid bound for the pA parameter.
source code
float
i0_upper(incs=None, model_info=None)
Find the maximum peak intensity for the cluster.
source code
Variables [hide private]
  __package__ = 'specific_analyses.relax_disp'

Imports: MODEL_LIST_MMQ, MODEL_M61B, round_to_next_order, return_spin, Param_list


Function Details [hide private]

dw_lower(incs=None, model_info=None)

source code 

Determine the lower grid bound for the dw parameters.

Parameters:
  • incs (int) - The number of grid search increments.
  • model_info (list of str) - The spin ID strings from the model_loop() specific API method.
Returns: float
The lower grid search bound for the dw parameters.

dwH_lower(incs=None, model_info=None)

source code 

Determine the lower grid bound for the dwH parameters.

Parameters:
  • incs (int) - The number of grid search increments.
  • model_info (list of str) - The spin ID strings from the model_loop() specific API method.
Returns: float
The lower grid search bound for the dwH parameters.

pA_lower(incs=None, model_info=None)

source code 

Determine the lower grid bound for the pA parameter.

Parameters:
  • incs (int) - The number of grid search increments.
  • model_info (list of SpinContainer instances, list of str) - The spin containers and the spin ID strings from the model_loop() specific API method.
Returns: float
The lower grid search bound for the pA parameter.

i0_upper(incs=None, model_info=None)

source code 

Find the maximum peak intensity for the cluster.

This is for the grid search upper bound for the I0 parameter.

Parameters:
  • incs (int) - The number of grid search increments.
  • model_info (list of SpinContainer instances, list of str) - The spin containers and the spin ID strings from the model_loop() specific API method.
Returns: float
The maximum peak intensity of all spins and time points.