Package prompt :: Module relax_fit :: Class Relax_fit
[hide private]
[frames] | no frames]

Class Relax_fit

source code


Class for relaxation curve fitting.

Instance Methods [hide private]
 
relax_time(self, time=0.0, spectrum_id=None)
Set the relaxation delay time associated with each spectrum.
source code
 
select_model(self, model='exp')
Select the relaxation curve type.
source code

Inherited from base_class.User_fn_class: __init__

Method Details [hide private]

relax_time(self, time=0.0, spectrum_id=None)

source code 
Set the relaxation delay time associated with each spectrum.

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

time:  The time, in seconds, of the relaxation period.

spectrum_id:  The spectrum identification string.


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

Peak intensities should be loaded before calling this user function via the
spectrum.read_intensities user function.  The intensity values will then be associated with a
spectrum identifier.  To associate each spectrum identifier with a time point in the relaxation
curve prior to optimisation, this user function should be called.

select_model(self, model='exp')

source code 
Select the relaxation curve type.

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

model:  The type of relaxation curve to fit.


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

The supported relaxation experiments include the default two parameter exponential fit, selected by
setting the 'fit_type' argument to 'exp', and the three parameter inversion recovery experiment in
which the peak intensity limit is a non-zero value, selected by setting the argument to 'inv'.

The parameters of these two models are
    'exp': [Rx, I0],
    'inv': [Rx, I0, Iinf].