Package specific_fns :: Module jw_mapping :: Class Jw_mapping
[hide private]
[frames] | no frames]

Class Jw_mapping

source code


Instance Methods [hide private]
 
__init__(self, relax)
Class containing functions specific to reduced spectral density mapping.
source code
 
calculate(self, run=None, print_flag=1, sim_index=None)
Calculation of the spectral density values.
source code
 
data_init(self, data, sim=0)
Function for initialising the data structures.
source code
 
data_names(self)
Function for returning a list of names of data structures.
source code
 
default_value(self, param)
Reduced spectral density mapping default values ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
source code
 
num_instances(self, run=None)
Function for returning the number of instances.
source code
 
return_conversion_factor(self, stat_type)
Dummy function for returning 1.0.
source code
 
return_data_name(self, name)
Reduced spectral density mapping data type string matching patterns ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
source code
 
return_grace_string(self, data_type)
Function for returning the Grace string representing the data type for axis labelling.
source code
 
return_units(self, data_type)
Function for returning a string representing the parameters units.
source code
 
return_value(self, run, i, data_type)
Function for returning the value and error corresponding to 'data_type'.
source code
 
set(self, run=None, value=None, error=None, data_type=None, index=None)
Reduced spectral density mapping set details ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
source code
 
set_frq(self, run=None, frq=None)
Function for selecting which relaxation data to use in the J(w) mapping.
source code
 
set_error(self, run, instance, index, error)
Function for setting parameter errors.
source code
 
sim_return_param(self, run, instance, index)
Function for returning the array of simulation parameter values.
source code
 
write_columnar_line(self, file=None, num=None, name=None, select=None, data_set=None, nucleus=None, wH=None, j0=None, jwx=None, jwh=None, r=None, csa=None, ri_labels=None, remap_table=None, frq_labels=None, frq=None, ri=None, ri_error=None)
Function for printing a single line of the columnar formatted results.
source code
 
write_columnar_results(self, file, run)
Function for printing the results into a file.
source code

Inherited from base_class.Common_functions: return_data, return_error, sim_pack_data

Method Details [hide private]

__init__(self, relax)
(Constructor)

source code 

Class containing functions specific to reduced spectral density mapping.

Overrides: base_class.Common_functions.__init__

data_names(self)

source code 
Function for returning a list of names of data structures.

Description
~~~~~~~~~~~

r:  Bond length.

csa:  CSA value.

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.

default_value(self, param)

source code 

Reduced spectral density mapping default values
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

_______________________________________________________________________________________
|                                       |              |                              |
| Data type                             | Object name  | Value                        |
|_______________________________________|______________|______________________________|
|                                       |              |                              |
| Bond length                           | 'r'          | 1.02 * 1e-10                 |
|                                       |              |                              |
| CSA                                   | 'csa'        | -170 * 1e-6                  |
|_______________________________________|______________|______________________________|

return_data_name(self, name)

source code 

Reduced spectral density mapping data type string matching patterns
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

____________________________________________________________________________________________
|                        |              |                                                  |
| Data type              | Object name  | Patterns                                         |
|________________________|______________|__________________________________________________|
|                        |              |                                                  |
| J(0)                   | 'j0'         | '^[Jj]0$' or '[Jj](0)'                           |
|                        |              |                                                  |
| J(wX)                  | 'jwx'        | '^[Jj]w[Xx]$' or '[Jj](w[Xx])'                   |
|                        |              |                                                  |
| J(wH)                  | 'jwh'        | '^[Jj]w[Hh]$' or '[Jj](w[Hh])'                   |
|                        |              |                                                  |
| Bond length            | 'r'          | '^r$' or '[Bb]ond[ -_][Ll]ength'                 |
|                        |              |                                                  |
| CSA                    | 'csa'        | '^[Cc][Ss][Aa]$'                                 |
|________________________|______________|__________________________________________________|

return_units(self, data_type)

source code 

Function for returning a string representing the parameters units.

For example, the internal representation of te is in seconds, whereas the external representation is in picoseconds, therefore this function will return the string 'picoseconds' for te.

set(self, run=None, value=None, error=None, data_type=None, index=None)

source code 

Reduced spectral density mapping set details
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In reduced spectral density mapping, only two values can be set, the bond length and CSA
value.  These must be set prior to the calculation of spectral density values.