Author: bugman
Date: Tue Oct 7 21:14:37 2008
New Revision: 7549
URL: http://svn.gna.org/viewcvs/relax?rev=7549&view=rev
Log:
Fixed the indentation of the prompt interface documentation.
Modified:
1.3/generic_fns/diffusion_tensor.py
Modified: 1.3/generic_fns/diffusion_tensor.py
URL:
http://svn.gna.org/viewcvs/relax/1.3/generic_fns/diffusion_tensor.py?rev=7549&r1=7548&r2=7549&view=diff
==============================================================================
--- 1.3/generic_fns/diffusion_tensor.py (original)
+++ 1.3/generic_fns/diffusion_tensor.py Tue Oct 7 21:14:37 2008
@@ -114,44 +114,44 @@
# User function documentation.
__default_value_prompt_doc__ = """
- Diffusion tensor parameter default values
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
- ________________________________________________________________________
- | | | |
- | Data type | Object name | Value |
- |________________________|____________________|________________________|
- | | | |
- | tm | 'tm' | 10 * 1e-9 |
- | | | |
- | Diso | 'Diso' | 1.666 * 1e7 |
- | | | |
- | Da | 'Da' | 0.0 |
- | | | |
- | Dr | 'Dr' | 0.0 |
- | | | |
- | Dx | 'Dx' | 1.666 * 1e7 |
- | | | |
- | Dy | 'Dy' | 1.666 * 1e7 |
- | | | |
- | Dz | 'Dz' | 1.666 * 1e7 |
- | | | |
- | Dpar | 'Dpar' | 1.666 * 1e7 |
- | | | |
- | Dper | 'Dper' | 1.666 * 1e7 |
- | | | |
- | Dratio | 'Dratio' | 1.0 |
- | | | |
- | alpha | 'alpha' | 0.0 |
- | | | |
- | beta | 'beta' | 0.0 |
- | | | |
- | gamma | 'gamma' | 0.0 |
- | | | |
- | theta | 'theta' | 0.0 |
- | | | |
- | phi | 'phi' | 0.0 |
- |________________________|____________________|________________________|
+ Diffusion tensor parameter default values
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
________________________________________________________________________
+ | | |
|
+ | Data type | Object name | Value
|
+
|________________________|____________________|________________________|
+ | | |
|
+ | tm | 'tm' | 10 * 1e-9
|
+ | | |
|
+ | Diso | 'Diso' | 1.666 * 1e7
|
+ | | |
|
+ | Da | 'Da' | 0.0
|
+ | | |
|
+ | Dr | 'Dr' | 0.0
|
+ | | |
|
+ | Dx | 'Dx' | 1.666 * 1e7
|
+ | | |
|
+ | Dy | 'Dy' | 1.666 * 1e7
|
+ | | |
|
+ | Dz | 'Dz' | 1.666 * 1e7
|
+ | | |
|
+ | Dpar | 'Dpar' | 1.666 * 1e7
|
+ | | |
|
+ | Dper | 'Dper' | 1.666 * 1e7
|
+ | | |
|
+ | Dratio | 'Dratio' | 1.0
|
+ | | |
|
+ | alpha | 'alpha' | 0.0
|
+ | | |
|
+ | beta | 'beta' | 0.0
|
+ | | |
|
+ | gamma | 'gamma' | 0.0
|
+ | | |
|
+ | theta | 'theta' | 0.0
|
+ | | |
|
+ | phi | 'phi' | 0.0
|
+
|________________________|____________________|________________________|
"""
@@ -810,55 +810,55 @@
# User function documentation.
__return_data_name_prompt_doc__ = """
- Diffusion tensor parameter string matching patterns
- ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-
____________________________________________________________________________________________
- | |
| |
- | Data type | Object name
| Patterns |
-
|________________________________________________________|______________|__________________|
- | |
| |
- | Global correlation time - tm | 'tm'
| '^tm$' |
- | |
| |
- | Isotropic component of the diffusion tensor - Diso | 'Diso'
| '[Dd]iso' |
- | |
| |
- | Anisotropic component of the diffusion tensor - Da | 'Da'
| '[Dd]a' |
- | |
| |
- | Rhombic component of the diffusion tensor - Dr | 'Dr'
| '[Dd]r$' |
- | |
| |
- | Eigenvalue associated with the x-axis of the diffusion | 'Dx'
| '[Dd]x' |
- | diffusion tensor - Dx |
| |
- | |
| |
- | Eigenvalue associated with the y-axis of the diffusion | 'Dy'
| '[Dd]y' |
- | diffusion tensor - Dy |
| |
- | |
| |
- | Eigenvalue associated with the z-axis of the diffusion | 'Dz'
| '[Dd]z' |
- | diffusion tensor - Dz |
| |
- | |
| |
- | Diffusion coefficient parallel to the major axis of | 'Dpar'
| '[Dd]par' |
- | the spheroid diffusion tensor - Dpar |
| |
- | |
| |
- | Diffusion coefficient perpendicular to the major axis | 'Dper'
| '[Dd]per' |
- | of the spheroid diffusion tensor - Dper |
| |
- | |
| |
- | Ratio of the parallel and perpendicular components of | 'Dratio'
| '[Dd]ratio' |
- | the spheroid diffusion tensor - Dratio |
| |
- | |
| |
- | The first Euler angle of the ellipsoid diffusion | 'alpha'
| '^a$' or 'alpha' |
- | tensor - alpha |
| |
- | |
| |
- | The second Euler angle of the ellipsoid diffusion | 'beta'
| '^b$' or 'beta' |
- | tensor - beta |
| |
- | |
| |
- | The third Euler angle of the ellipsoid diffusion | 'gamma'
| '^g$' or 'gamma' |
- | tensor - gamma |
| |
- | |
| |
- | The polar angle defining the major axis of the | 'theta'
| 'theta' |
- | spheroid diffusion tensor - theta |
| |
- | |
| |
- | The azimuthal angle defining the major axis of the | 'phi'
| 'phi' |
- | spheroid diffusion tensor - phi |
| |
-
|________________________________________________________|______________|__________________|
+ Diffusion tensor parameter string matching patterns
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+
____________________________________________________________________________________________
+ | |
| |
+ | Data type | Object
name | Patterns |
+
|________________________________________________________|______________|__________________|
+ | |
| |
+ | Global correlation time - tm | 'tm'
| '^tm$' |
+ | |
| |
+ | Isotropic component of the diffusion tensor - Diso | 'Diso'
| '[Dd]iso' |
+ | |
| |
+ | Anisotropic component of the diffusion tensor - Da | 'Da'
| '[Dd]a' |
+ | |
| |
+ | Rhombic component of the diffusion tensor - Dr | 'Dr'
| '[Dd]r$' |
+ | |
| |
+ | Eigenvalue associated with the x-axis of the diffusion | 'Dx'
| '[Dd]x' |
+ | diffusion tensor - Dx |
| |
+ | |
| |
+ | Eigenvalue associated with the y-axis of the diffusion | 'Dy'
| '[Dd]y' |
+ | diffusion tensor - Dy |
| |
+ | |
| |
+ | Eigenvalue associated with the z-axis of the diffusion | 'Dz'
| '[Dd]z' |
+ | diffusion tensor - Dz |
| |
+ | |
| |
+ | Diffusion coefficient parallel to the major axis of | 'Dpar'
| '[Dd]par' |
+ | the spheroid diffusion tensor - Dpar |
| |
+ | |
| |
+ | Diffusion coefficient perpendicular to the major axis | 'Dper'
| '[Dd]per' |
+ | of the spheroid diffusion tensor - Dper |
| |
+ | |
| |
+ | Ratio of the parallel and perpendicular components of | 'Dratio'
| '[Dd]ratio' |
+ | the spheroid diffusion tensor - Dratio |
| |
+ | |
| |
+ | The first Euler angle of the ellipsoid diffusion | 'alpha'
| '^a$' or 'alpha' |
+ | tensor - alpha |
| |
+ | |
| |
+ | The second Euler angle of the ellipsoid diffusion | 'beta'
| '^b$' or 'beta' |
+ | tensor - beta |
| |
+ | |
| |
+ | The third Euler angle of the ellipsoid diffusion | 'gamma'
| '^g$' or 'gamma' |
+ | tensor - gamma |
| |
+ | |
| |
+ | The polar angle defining the major axis of the | 'theta'
| 'theta' |
+ | spheroid diffusion tensor - theta |
| |
+ | |
| |
+ | The azimuthal angle defining the major axis of the | 'phi'
| 'phi' |
+ | spheroid diffusion tensor - phi |
| |
+
|________________________________________________________|______________|__________________|
"""
@@ -1332,45 +1332,45 @@
# 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.
-
- The units of the parameters are:
-
- Inverse seconds for tm.
- Seconds for Diso, Da, Dx, Dy, Dz, Dpar, Dper.
- 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
-
- {tm, Da},
- {Diso, Da},
- {tm, Dratio},
- {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
-
- {tm, Da, Dr},
- {Diso, Da, Dr},
- {Dx, Dy, Dz},
-
- where any number of the orientational parameters, alpha, beta, or gamma
can be additionally
- supplied.
+ 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:
+
+ Inverse seconds for tm.
+ Seconds for Diso, Da, Dx, Dy, Dz, Dpar, Dper.
+ 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
+
+ {tm, Da},
+ {Diso, Da},
+ {tm, Dratio},
+ {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
+
+ {tm, Da, Dr},
+ {Diso, Da, Dr},
+ {Dx, Dy, Dz},
+
+ where any number of the orientational parameters, alpha, beta, or
gamma can be additionally
+ supplied.
"""
r7549 - /1.3/generic_fns/diffusion_tensor.py