Author: bugman
Date: Wed Sep 24 20:27:38 2008
New Revision: 7278
URL: http://svn.gna.org/viewcvs/relax?rev=7278&view=rev
Log:
Converted the data_names() methods to the new design.
Modified:
1.3/specific_fns/consistency_tests.py
1.3/specific_fns/jw_mapping.py
Modified: 1.3/specific_fns/consistency_tests.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/specific_fns/consistency_tests.py?rev=7278&r1=7277&r2=7278&view=diff
==============================================================================
--- 1.3/specific_fns/consistency_tests.py (original)
+++ 1.3/specific_fns/consistency_tests.py Wed Sep 24 20:27:38 2008
@@ -196,29 +196,34 @@
setattr(data, name, None)
- def data_names(self):
- """Function for returning a list of names of data structures.
+ def data_names(self, set=None, error_names=False, sim_names=False):
+ """Return a list of all spin container specific consistency testing
object names.
Description
- ~~~~~~~~~~~
-
- r: Bond length.
-
- csa: CSA value.
-
- heteronuc_type: The heteronucleus type.
-
- orientation: Angle between the 15N-1H vector and the principal axis
of the 15N chemical
- shift tensor.
-
- tc: Correlation time.
-
- j0: Spectral density value at 0 MHz.
-
- f_eta: Eta-test (from Fushman D. et al. (1998) JACS, 120:
10947-10952).
-
- f_r2: R2-test (from Fushman D. et al. (1998) JACS, 120:
10947-10952).
-
+ ===========
+
+ The names are as follows:
+
+ r: Bond length.
+ csa: CSA value.
+ heteronuc_type: The heteronucleus type.
+ orientation: Angle between the 15N-1H vector and the principal
axis of the 15N chemical
+ shift tensor.
+ tc: Correlation time.
+ j0: Spectral density value at 0 MHz.
+ f_eta: Eta-test (from Fushman D. et al. (1998) JACS, 120:
10947-10952).
+ f_r2: R2-test (from Fushman D. et al. (1998) JACS, 120:
10947-10952).
+
+
+ @keyword set: An unused variable.
+ @type set: ignored
+ @keyword error_names: A flag which if True will add the error
object names as well.
+ @type error_names: bool
+ @keyword sim_names: A flag which if True will add the Monte
Carlo simulation object
+ names as well.
+ @type sim_names: bool
+ @return: The list of object names.
+ @rtype: list of str
"""
# Initialise.
@@ -236,6 +241,7 @@
names.append('f_eta')
names.append('f_r2')
+ # Return the names.
return names
Modified: 1.3/specific_fns/jw_mapping.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/specific_fns/jw_mapping.py?rev=7278&r1=7277&r2=7278&view=diff
==============================================================================
--- 1.3/specific_fns/jw_mapping.py (original)
+++ 1.3/specific_fns/jw_mapping.py Wed Sep 24 20:27:38 2008
@@ -188,23 +188,31 @@
setattr(data, name, None)
- def data_names(self):
- """Function for returning a list of names of data structures.
+ def data_names(self, set=None, error_names=False, sim_names=False):
+ """Return a list of all spin container specific J(w) mapping object
names.
Description
- ~~~~~~~~~~~
-
- r: Bond length.
-
- csa: CSA value.
-
- heteronuc_type: The heteronucleus type.
-
- j0: Spectral density value at 0 MHz.
-
- jwx: Spectral density value at the frequency of the heteronucleus.
-
- jwh: Spectral density value at the frequency of the heteronucleus.
+ ===========
+
+ The names are as follows:
+
+ r: Bond length.
+ csa: CSA value.
+ heteronuc_type: The heteronucleus type.
+ j0: Spectral density value at 0 MHz.
+ jwx: Spectral density value at the frequency of the
heteronucleus.
+ jwh: Spectral density value at the frequency of the
heteronucleus.
+
+
+ @keyword set: An unused variable.
+ @type set: ignored
+ @keyword error_names: A flag which if True will add the error
object names as well.
+ @type error_names: bool
+ @keyword sim_names: A flag which if True will add the Monte
Carlo simulation object
+ names as well.
+ @type sim_names: bool
+ @return: The list of object names.
+ @rtype: list of str
"""
# Initialise.
@@ -220,6 +228,7 @@
names.append('jwx')
names.append('jwh')
+ # Return the names.
return names
r7278 - in /1.3/specific_fns: consistency_tests.py jw_mapping.py