Author: bugman
Date: Fri Jul 8 12:04:13 2011
New Revision: 13530
URL: http://svn.gna.org/viewcvs/relax?rev=13530&view=rev
Log:
Converted all of the relaxation curve fitting documentation used in the user
functions to the new design.
Modified:
branches/gui_testing/specific_fns/relax_fit.py
Modified: branches/gui_testing/specific_fns/relax_fit.py
URL:
http://svn.gna.org/viewcvs/relax/branches/gui_testing/specific_fns/relax_fit.py?rev=13530&r1=13529&r2=13530&view=diff
==============================================================================
--- branches/gui_testing/specific_fns/relax_fit.py (original)
+++ branches/gui_testing/specific_fns/relax_fit.py Fri Jul 8 12:04:13 2011
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2004-2009 Edward d'Auvergne
#
+# Copyright (C) 2004-2011 Edward d'Auvergne
#
#
#
# This file is part of the program relax.
#
#
#
@@ -630,12 +630,8 @@
return names
- default_value_doc = """
- Relaxation curve fitting default values
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
- These values are completely arbitrary as peak heights (or volumes)
are extremely variable
- and the Rx value is a compensation for both the R1 and R2 values.
+ default_value_doc = ["Relaxation curve fitting default values", """
+ These values are completely arbitrary as peak heights (or volumes)
are extremely variable and the Rx value is a compensation for both the R1 and
R2 values.
___________________________________________________________________
| | | |
| Data type | Object name | Value |
@@ -649,7 +645,7 @@
| | | |
|________________________|_______________|________________________|
- """
+ """]
def default_value(self, param):
"""Return the default relaxation curve-fitting parameter values.
@@ -924,10 +920,7 @@
return spin.intensities
- return_data_name_doc = """
- Relaxation curve fitting data type string matching patterns
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
+ return_data_name_doc = ["Relaxation curve fitting data type string
matching patterns", """
__________________________________________________________________________________________
| | |
|
| Data type | Object name |
Patterns |
@@ -944,7 +937,7 @@
| Relaxation period times (series) | 'relax_times' |
'^[Rr]elax[ -_][Tt]imes$' |
|___________________________________|______________________|_____________________________|
- """
+ """]
def return_data_name(self, param):
"""Return a unique identifying string for the relaxation
curve-fitting parameter.
@@ -1048,14 +1041,11 @@
return None
- set_doc = """
- Relaxation curve fitting set details
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
+ set_doc = ["Relaxation curve fitting set details", """
Only three parameters can be set, the relaxation rate (Rx), the
initial intensity (I0), and
the intensity at infinity (Iinf). Setting the parameter Iinf has no
effect if the chosen
model is that of the exponential curve which decays to zero.
- """
+ """]
def sim_pack_data(self, data_id, sim_data):
r13530 - /branches/gui_testing/specific_fns/relax_fit.py