Author: bugman
Date: Fri Jul 8 12:09:23 2011
New Revision: 13533
URL: http://svn.gna.org/viewcvs/relax?rev=13533&view=rev
Log:
Converted all of the diffusion tensor documentation used in the user
functions to the new design.
Modified:
branches/gui_testing/generic_fns/diffusion_tensor.py
Modified: branches/gui_testing/generic_fns/diffusion_tensor.py
URL:
http://svn.gna.org/viewcvs/relax/branches/gui_testing/generic_fns/diffusion_tensor.py?rev=13533&r1=13532&r2=13533&view=diff
==============================================================================
--- branches/gui_testing/generic_fns/diffusion_tensor.py (original)
+++ branches/gui_testing/generic_fns/diffusion_tensor.py Fri Jul 8 12:09:23
2011
@@ -1,6 +1,6 @@
###############################################################################
#
#
-# Copyright (C) 2003-2010 Edward d'Auvergne
#
+# Copyright (C) 2003-2011 Edward d'Auvergne
#
#
#
# This file is part of the program relax.
#
#
#
@@ -336,10 +336,7 @@
return 0.0
# User function documentation.
-__default_value_prompt_doc__ = """
- Diffusion tensor parameter default values
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
+__default_value_prompt_doc__ = ["Diffusion tensor parameter default values",
"""
________________________________________________________________________
| | |
|
| Data type | Object name | Value
|
@@ -375,8 +372,7 @@
| | |
|
| phi | 'phi' | 0.0
|
|________________________|____________________|________________________|
-
-"""
+"""]
def delete():
@@ -1044,10 +1040,7 @@
return 'phi'
# User function documentation.
-__return_data_name_prompt_doc__ = """
- Diffusion tensor parameter string matching patterns
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
+__return_data_name_prompt_doc__ = ["Diffusion tensor parameter string
matching patterns", """
____________________________________________________________________________________________
| |
| |
| Data type | Object
name | Patterns |
@@ -1094,7 +1087,7 @@
| The azimuthal angle defining the major axis of the | 'phi'
| 'phi' |
| spheroid diffusion tensor - phi |
| |
|________________________________________________________|______________|__________________|
-"""
+"""]
def return_eigenvalues():
@@ -1563,13 +1556,8 @@
fold_angles()
# User function documentation.
-__set_prompt_doc__ = """
- Diffusion tensor set details
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
- If the diffusion tensor has not been setup, use the more powerful
function
- 'diffusion_tensor.init' to initialise the tensor parameters. This
function cannot be used
- to initialise a diffusion tensor.
+__set_prompt_doc__ = ["Diffusion tensor set details", """
+ If the diffusion tensor has not been setup, use the more powerful
function 'diffusion_tensor.init' to initialise the tensor parameters. This
function cannot be used to initialise a diffusion tensor.
The units of the parameters are:
@@ -1578,14 +1566,7 @@
Unitless for Dratio and Dr.
Radians for all angles (alpha, beta, gamma, theta, phi).
- When setting a diffusion tensor parameter, the residue number has no
effect. As the
- internal parameters of spherical diffusion are {tm}, spheroidal
diffusion are {tm, Da,
- theta, phi}, and ellipsoidal diffusion are {tm, Da, Dr, alpha, beta,
gamma}, supplying
- geometric parameters must be done in the following way. If a single
geometric parameter is
- supplied, it must be one of tm, Diso, Da, Dr, or Dratio. For the
parameters Dpar, Dper, Dx,
- Dy, and Dx, it is not possible to determine how to use the currently
set values together
- with the supplied value to calculate the new internal parameters.
For spheroidal diffusion,
- when supplying multiple geometric parameters, the set must belong to
one of
+ When setting a diffusion tensor parameter, the residue number has no
effect. As the internal parameters of spherical diffusion are {tm},
spheroidal diffusion are {tm, Da, theta, phi}, and ellipsoidal diffusion are
{tm, Da, Dr, alpha, beta, gamma}, supplying geometric parameters must be done
in the following way. If a single geometric parameter is supplied, it must
be one of tm, Diso, Da, Dr, or Dratio. For the parameters Dpar, Dper, Dx,
Dy, and Dx, it is not possible to determine how to use the currently set
values together with the supplied value to calculate the new internal
parameters. For spheroidal diffusion, when supplying multiple geometric
parameters, the set must belong to one of
{tm, Da},
{Diso, Da},
@@ -1593,17 +1574,14 @@
{Dpar, Dper},
{Diso, Dratio},
- where either theta, phi, or both orientational parameters can be
additionally supplied. For
- ellipsoidal diffusion, again when supplying multiple geometric
parameters, the set must
- belong to one of
+ where either theta, phi, or both orientational parameters can be
additionally supplied. For ellipsoidal diffusion, again when supplying
multiple geometric parameters, the set must belong to one of
{tm, Da, Dr},
{Diso, Da, Dr},
{Dx, Dy, Dz},
- where any number of the orientational parameters, alpha, beta, or
gamma can be additionally
- supplied.
-"""
+ where any number of the orientational parameters, alpha, beta, or
gamma can be additionally supplied.
+"""]
def sphere(params=None, time_scale=None, param_types=None):
r13533 - /branches/gui_testing/generic_fns/diffusion_tensor.py