r22741 - in /trunk: specific_analyses/jw_mapping/parameter_object.py specific_analyses/jw_mapping/uf.py user_functions/value.py -- April 14, 2014 - 17:41

Author: bugman
Date: Mon Apr 14 17:41:04 2014
New Revision: 22741

URL: http://svn.gna.org/viewcvs/relax?rev=22741&view=rev
Log:
The J(w) mapping parameter setting documentation has been shifted into the 
parameter list object.

This has also been updated to reflect the current design of relax.


Modified:
    trunk/specific_analyses/jw_mapping/parameter_object.py
    trunk/specific_analyses/jw_mapping/uf.py
    trunk/user_functions/value.py

Modified: trunk/specific_analyses/jw_mapping/parameter_object.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/jw_mapping/parameter_object.py?rev=22741&r1=22740&r2=22741&view=diff
==============================================================================
--- trunk/specific_analyses/jw_mapping/parameter_object.py      (original)
+++ trunk/specific_analyses/jw_mapping/parameter_object.py      Mon Apr 14 
17:41:04 2014
@@ -54,3 +54,7 @@
         self._set_uf_title("Reduced spectral density mapping parameters")
         self._uf_param_table(label="table: J(w) parameters", 
caption="Reduced spectral density mapping parameters.")
         self._uf_param_table(label="table: J(w) parameter value setting", 
caption="Reduced spectral density mapping parameter value setting.", 
default=True)
+
+        # Value setting documentation.
+        for doc in self._uf_doc_loop(["table: J(w) parameters", "table: J(w) 
parameter value setting"]):
+            doc.add_paragraph("In reduced spectral density mapping, the CSA 
value must be set prior to the calculation of spectral density values.")

Modified: trunk/specific_analyses/jw_mapping/uf.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/specific_analyses/jw_mapping/uf.py?rev=22741&r1=22740&r2=22741&view=diff
==============================================================================
--- trunk/specific_analyses/jw_mapping/uf.py    (original)
+++ trunk/specific_analyses/jw_mapping/uf.py    Mon Apr 14 17:41:04 2014
@@ -31,11 +31,6 @@
 from user_functions.objects import Desc_container
 
 
-# Value setting documentation.
-set_doc = Desc_container("Reduced spectral density mapping set details")
-set_doc.add_paragraph("In reduced spectral density mapping, three values 
must be set prior to the calculation of spectral density values:  the bond 
length, CSA, and heteronucleus type.")
-
-
 def set_frq(frq=None):
     """Function for selecting which relaxation data to use in the J(w) 
mapping."""
 

Modified: trunk/user_functions/value.py
URL: 
http://svn.gna.org/viewcvs/relax/trunk/user_functions/value.py?rev=22741&r1=22740&r2=22741&view=diff
==============================================================================
--- trunk/user_functions/value.py       (original)
+++ trunk/user_functions/value.py       Mon Apr 14 17:41:04 2014
@@ -98,7 +98,6 @@
 # Prompt examples.
 uf.desc.append(regexp_doc)
 uf.desc.append(model_free_params.uf_doc(label="table: model-free 
parameters"))
-uf.desc.append(jw_mapping_uf.set_doc)
 uf.desc.append(jw_mapping_params.uf_doc(label="table: J(w) parameters"))
 uf.desc.append(consistency_tests_uf.set_doc)
 uf.desc.append(consistency_test_params.uf_doc(label="table: consistency 
testing parameters"))
@@ -288,7 +287,6 @@
 uf.desc[-1].add_paragraph("If this is used to change values of previously 
minimised parameters, then the minimisation statistics (chi-squared value, 
iteration count, function count, gradient count, and Hessian count) will be 
reset.")
 uf.desc.append(regexp_doc)
 uf.desc.append(model_free_params.uf_doc(label="table: model-free 
parameters"))
-uf.desc.append(jw_mapping_uf.set_doc)
 uf.desc.append(jw_mapping_params.uf_doc(label="table: J(w) parameters"))
 uf.desc.append(consistency_tests_uf.set_doc)
 uf.desc.append(consistency_test_params.uf_doc(label="table: consistency 
testing parameters"))
@@ -379,7 +377,6 @@
 uf.desc.append(regexp_doc)
 uf.desc.append(diffusion_tensor.__set_doc__)
 uf.desc.append(model_free_params.uf_doc(label="table: mf parameter value 
setting"))
-uf.desc.append(jw_mapping_uf.set_doc)
 uf.desc.append(jw_mapping_params.uf_doc(label="table: J(w) parameter value 
setting"))
 uf.desc.append(consistency_tests_uf.set_doc)
 uf.desc.append(consistency_test_params.uf_doc(label="table: consistency 
testing parameter value setting"))