Package prompt :: Module fix :: Class Fix
[hide private]
[frames] | no frames]

Class Fix

source code


Class containing the function for fixing or allowing parameter values to change.

Instance Methods [hide private]
 
fix(self, element=None, fixed=True)
Function for either fixing or allowing parameter values to change during optimisation.
source code

Inherited from base_class.Basic_class: __init__

Method Details [hide private]

fix(self, element=None, fixed=True)

source code 
Function for either fixing or allowing parameter values to change during optimisation.

Keyword Arguments
~~~~~~~~~~~~~~~~~

element:  Which element to fix.

fixed:  A flag specifying if the parameters should be fixed or allowed to change.


Description
~~~~~~~~~~~

The keyword argument 'element' can be any of the following:

'diff' - the diffusion tensor parameters.  This will allow all diffusion tensor parameters
to be toggled.

'all_spins' - using this keyword, all parameters from all spins will be toggled.

'all' - all parameter will be toggled.  This is equivalent to combining both 'diff' and
'all_spins'.


The flag 'fixed', if set to True, will fix parameters during optimisation whereas a value of
False will allow parameters to vary.