r9187 - /branches/frame_order/prompt/frame_order.py -- July 04, 2009 - 23:21

Author: bugman
Date: Fri Jul  3 00:11:43 2009
New Revision: 9187

URL: http://svn.gna.org/viewcvs/relax?rev=9187&view=rev
Log:
Added the interface for the frame_order.n_state_model() user function.


Modified:
    branches/frame_order/prompt/frame_order.py

Modified: branches/frame_order/prompt/frame_order.py
URL: 
http://svn.gna.org/viewcvs/relax/branches/frame_order/prompt/frame_order.py?rev=9187&r1=9186&r2=9187&view=diff
==============================================================================
--- branches/frame_order/prompt/frame_order.py (original)
+++ branches/frame_order/prompt/frame_order.py Fri Jul  3 00:11:43 2009
@@ -159,6 +159,46 @@
         frame_order_obj.pivot(pivot=pivot)
 
 
+    def ref_domain(self, ref=None):
+        """Set the reference domain for the '2-domain' Frame Order theories.
+
+        Keyword Arguments
+        ~~~~~~~~~~~~~~~~~
+
+        ref:  The domain which will act as the frame of reference.  This is 
only valid for the
+        '2-domain' Frame Order theories.
+
+
+        Description
+        ~~~~~~~~~~~
+
+        Prior to optimisation of the '2-domain' Frame Order theories, which 
of the two domains will
+        act as the frame of reference must be specified.  This is important 
for the attachment of
+        cones to domains, etc.
+
+
+        Examples
+        ~~~~~~~~
+
+        To set up the isotropic cone frame order model with 'centre' domain 
being the frame of reference, type:
+
+        relax> frame_order.ref_domain(ref='centre')
+        """
+
+        # Function intro text.
+        if self.__relax__.interpreter.intro:
+            text = sys.ps3 + "frame_order.ref_domain("
+            text = text + "ref=" + `ref` + ")"
+            print text
+
+        # Ref frame argument.
+        if type(ref) != str:
+            raise RelaxStrError, ('reference frame', ref)
+
+        # Execute the functional code.
+        frame_order.ref_domain(ref=ref)
+
+
     def select_model(self, model=None):
         """Select and set up the Frame Order model.