Author: bugman
Date: Tue Nov 24 13:05:29 2009
New Revision: 9913
URL: http://svn.gna.org/viewcvs/relax?rev=9913&view=rev
Log:
Clean up of the create_mc_data() API method across the board.
The spin_id keyword is now accepted by all, and is a keyword.
Modified:
1.3/specific_fns/api_base.py
1.3/specific_fns/consistency_tests.py
1.3/specific_fns/frame_order.py
1.3/specific_fns/jw_mapping.py
1.3/specific_fns/model_free/main.py
1.3/specific_fns/relax_fit.py
Modified: 1.3/specific_fns/api_base.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/specific_fns/api_base.py?rev=9913&r1=9912&r2=9913&view=diff
==============================================================================
--- 1.3/specific_fns/api_base.py (original)
+++ 1.3/specific_fns/api_base.py Tue Nov 24 13:05:29 2009
@@ -73,10 +73,10 @@
def create_mc_data(self, spin_id=None):
"""Prototype method for creating the Monte Carlo data.
- @param spin_id: The spin identification string, as yielded by the
base_data_loop() generator method.
- @type spin_id: str
- @return: The Monte Carlo data.
- @rtype: list of floats
+ @keyword spin_id: The spin identification string, as yielded by
the base_data_loop() generator method.
+ @type spin_id: str
+ @return: The Monte Carlo simulation data.
+ @rtype: list of floats
"""
# Not implemented.
Modified: 1.3/specific_fns/consistency_tests.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/specific_fns/consistency_tests.py?rev=9913&r1=9912&r2=9913&view=diff
==============================================================================
--- 1.3/specific_fns/consistency_tests.py (original)
+++ 1.3/specific_fns/consistency_tests.py Tue Nov 24 13:05:29 2009
@@ -154,14 +154,13 @@
spin.f_r2_sim.append(f_r2)
- def create_mc_data(self, spin_id):
- """Return the Ri data structure for the corresponding spin.
-
- @param spin_id: The spin identification string, as yielded by the
base_data_loop() generator
- method.
- @type spin_id: str
- @return: The Monte Carlo simulation data.
- @rtype: list of floats
+ def create_mc_data(self, spin_id=None):
+ """Return the Monte Carlo Ri data structure for the corresponding
spin.
+
+ @keyword spin_id: The spin identification string, as yielded by
the base_data_loop() generator method.
+ @type spin_id: str
+ @return: The Monte Carlo simulation data.
+ @rtype: list of floats
"""
# Get the spin container.
Modified: 1.3/specific_fns/frame_order.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/specific_fns/frame_order.py?rev=9913&r1=9912&r2=9913&view=diff
==============================================================================
--- 1.3/specific_fns/frame_order.py (original)
+++ 1.3/specific_fns/frame_order.py Tue Nov 24 13:05:29 2009
@@ -511,13 +511,13 @@
pdb_file.close()
- def create_mc_data(self, index):
+ def create_mc_data(self, spin_id=None):
"""Create the Monte Carlo data by back calculating the reduced
tensor data.
- @keyword index: Not used.
- @type index: None
- @return: The Monte Carlo simulation data.
- @rtype: list of floats
+ @keyword spin_id: The spin identification string (unused).
+ @type spin_id: None
+ @return: The Monte Carlo simulation data.
+ @rtype: list of floats
"""
# Back calculate the tensors.
Modified: 1.3/specific_fns/jw_mapping.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/specific_fns/jw_mapping.py?rev=9913&r1=9912&r2=9913&view=diff
==============================================================================
--- 1.3/specific_fns/jw_mapping.py (original)
+++ 1.3/specific_fns/jw_mapping.py Tue Nov 24 13:05:29 2009
@@ -146,14 +146,13 @@
spin.jwh_sim.append(jwh)
- def create_mc_data(self, spin_id):
- """Return the Ri data structure for the corresponding spin.
-
- @param spin_id: The spin identification string, as yielded by the
base_data_loop() generator
- method.
- @type spin_id: str
- @return: The Monte Carlo simulation data.
- @rtype: list of floats
+ def create_mc_data(self, spin_id=None):
+ """Return the Monte Carlo Ri data structure for the corresponding
spin.
+
+ @keyword spin_id: The spin identification string, as yielded by
the base_data_loop() generator method.
+ @type spin_id: str
+ @return: The Monte Carlo simulation data.
+ @rtype: list of floats
"""
# Get the spin container.
Modified: 1.3/specific_fns/model_free/main.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/specific_fns/model_free/main.py?rev=9913&r1=9912&r2=9913&view=diff
==============================================================================
--- 1.3/specific_fns/model_free/main.py (original)
+++ 1.3/specific_fns/model_free/main.py Tue Nov 24 13:05:29 2009
@@ -490,14 +490,13 @@
return value
- def create_mc_data(self, spin_id):
+ def create_mc_data(self, spin_id=None):
"""Create the Monte Carlo Ri data.
- @param spin_id: The spin identification string, as yielded by the
base_data_loop() generator
- method.
- @type spin_id: str
- @return: The Monte Carlo simulation data.
- @rtype: list of floats
+ @keyword spin_id: The spin identification string, as yielded by
the base_data_loop() generator method.
+ @type spin_id: str
+ @return: The Monte Carlo simulation data.
+ @rtype: list of floats
"""
# Initialise the MC data structure.
Modified: 1.3/specific_fns/relax_fit.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/specific_fns/relax_fit.py?rev=9913&r1=9912&r2=9913&view=diff
==============================================================================
--- 1.3/specific_fns/relax_fit.py (original)
+++ 1.3/specific_fns/relax_fit.py Tue Nov 24 13:05:29 2009
@@ -162,14 +162,13 @@
return results[relax_time_index]
- def create_mc_data(self, spin_id):
+ def create_mc_data(self, spin_id=None):
"""Create the Monte Carlo peak intensity data.
- @param spin_id: The spin identification string, as yielded by the
base_data_loop() generator
- method.
- @type spin_id: str
- @return: The Monte Carlo simulation data.
- @rtype: list of floats
+ @keyword spin_id: The spin identification string, as yielded by
the base_data_loop() generator method.
+ @type spin_id: str
+ @return: The Monte Carlo simulation data.
+ @rtype: list of floats
"""
# Initialise the MC data data structure.
r9913 - in /1.3/specific_fns: api_base.py consistency_tests.py frame_order.py jw_mapping.py model_free/main.py relax_fit.py