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

Class Fix

source code

Instance Methods [hide private]
 
__init__(self, relax)
Class containing the function for fixing or allowing parameter values to change.
source code
 
fix(self, run=None, element=None, fixed=1)
Function for either fixing or allowing parameter values to change.
source code
Method Details [hide private]

fix(self, run=None, element=None, fixed=1)

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

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

run:  The name of the run.

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.

an integer - if an integer number is given, then all parameters for the residue
corresponding to that number will be toggled.

'all_res' - using this keyword, all parameters from all residues will be toggled.

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


The flag 'fixed', if set to 1, will fix parameters, while a value of 0 will allow parameters
to vary.


Only parameters corresponding to the given run will be affected.