Package specific_fns :: Package model_free :: Module results :: Class Results
[hide private]
[frames] | no frames]

Class Results

source code


Class containing methods specific to the model-free results files.

Instance Methods [hide private]
str
_determine_version(self, file_data, verbosity=1)
Determine which relax version the results file belongs to.
source code
 
_fix_params(self, spin_line, col, verbosity=1)
Fix certain parameters depending on the model type.
source code
 
_generate_sequence(self, spin_line, col, verbosity=1)
Generate the sequence.
source code
 
_get_spin_id(self, spin_line, col, verbosity=1)
Get the spin identification string corresponding to spin_line.
source code
 
_load_model_free_data(self, spin_line, col, data_set, spin, spin_id, verbosity=1)
Read the model-free data for the spin.
source code
 
_load_relax_data(self, spin_line, col, data_set, spin, verbosity=1)
Load the relaxation data.
source code
bool
_load_structure(self, spin_line, col, verbosity=1)
Load the structure back into the current data pipe.
source code
 
_read_1_2_results(self, file_data, verbosity=1)
Read the relax 1.2 model-free results file.
source code
dictionary of int
_read_col_numbers(self, header)
Determine the column indices from the header line.
source code
 
_set_diff_tensor(self, spin_line, col, data_set, verbosity=1)
Set up the diffusion tensor.
source code
 
_set_xh_vect(self, spin_line, col, spin, verbosity=1)
Set the XH unit vector and the attached proton name.
source code
 
read_columnar_results(self, file_data, verbosity=1)
Read the columnar formatted model-free results file.
source code
Method Details [hide private]

_determine_version(self, file_data, verbosity=1)

source code 

Determine which relax version the results file belongs to.

Parameters:
  • file_data (list of lists of str) - The processed results file data.
  • verbosity (int) - A variable specifying the amount of information to print. The higher the value, the greater the verbosity.
Returns: str
The relax version number.
Raises:
  • RelaxError - If the relax version the model-free results file belongs to cannot be determined.

_fix_params(self, spin_line, col, verbosity=1)

source code 

Fix certain parameters depending on the model type.

Parameters:
  • spin_line (list of str) - The line of data for a single spin.
  • col (dict of int) - The column indices.
  • verbosity (int) - A variable specifying the amount of information to print. The higher the value, the greater the verbosity.

_generate_sequence(self, spin_line, col, verbosity=1)

source code 

Generate the sequence.

Parameters:
  • spin_line (list of str) - The line of data for a single spin.
  • col (dict of int) - The column indices.
  • verbosity (int) - A variable specifying the amount of information to print. The higher the value, the greater the verbosity.

_get_spin_id(self, spin_line, col, verbosity=1)

source code 

Get the spin identification string corresponding to spin_line.

Parameters:
  • spin_line (list of str) - The line of data for a single spin.
  • col (dict of int) - The column indices.
  • verbosity (int) - A variable specifying the amount of information to print. The higher the value, the greater the verbosity.

_load_model_free_data(self, spin_line, col, data_set, spin, spin_id, verbosity=1)

source code 

Read the model-free data for the spin.

Parameters:
  • spin_line (list of str) - The line of data for a single spin.
  • col (dict of int) - The column indices.
  • data_set (str) - The data set type, one of 'value', 'error', or 'sim_xxx' (where xxx is a number).
  • spin (SpinContainer instance) - The spin container.
  • spin_id (str) - The spin identification string.
  • verbosity (int) - A variable specifying the amount of information to print. The higher the value, the greater the verbosity.

_load_relax_data(self, spin_line, col, data_set, spin, verbosity=1)

source code 

Load the relaxation data.

Parameters:
  • spin_line (list of str) - The line of data for a single spin.
  • col (dict of int) - The column indices.
  • data_set (str) - The data set type, one of 'value', 'error', or 'sim_xxx' (where xxx is a number).
  • spin (SpinContainer instance) - The spin container.
  • verbosity (int) - A variable specifying the amount of information to print. The higher the value, the greater the verbosity.

_load_structure(self, spin_line, col, verbosity=1)

source code 

Load the structure back into the current data pipe.

Parameters:
  • spin_line (list of str) - The line of data for a single spin.
  • col (dict of int) - The column indices.
  • verbosity (int) - A variable specifying the amount of information to print. The higher the value, the greater the verbosity.
Returns: bool
True if the structure was loaded, False otherwise.

_read_1_2_results(self, file_data, verbosity=1)

source code 

Read the relax 1.2 model-free results file.

Parameters:
  • file_data (list of lists of str) - The processed results file data.
  • verbosity (int) - A variable specifying the amount of information to print. The higher the value, the greater the verbosity.

_read_col_numbers(self, header)

source code 

Determine the column indices from the header line.

Parameters:
  • header (list of str) - The header line.
Returns: dictionary of int
The column indices.

_set_diff_tensor(self, spin_line, col, data_set, verbosity=1)

source code 

Set up the diffusion tensor.

Parameters:
  • spin_line (list of str) - The line of data for a single spin.
  • col (dict of int) - The column indices.
  • data_set (str) - The data set type, one of 'value', 'error', or 'sim_xxx' (where xxx is a number).
  • verbosity (int) - A variable specifying the amount of information to print. The higher the value, the greater the verbosity.

_set_xh_vect(self, spin_line, col, spin, verbosity=1)

source code 

Set the XH unit vector and the attached proton name.

Parameters:
  • spin_line (list of str) - The line of data for a single spin.
  • col (dict of int) - The column indices.
  • spin (SpinContainer instance) - The spin container.
  • verbosity (int) - A variable specifying the amount of information to print. The higher the value, the greater the verbosity.

read_columnar_results(self, file_data, verbosity=1)

source code 

Read the columnar formatted model-free results file.

Parameters:
  • file_data (list of lists of str) - The processed results file data.
  • verbosity (int) - A variable specifying the amount of information to print. The higher the value, the greater the verbosity.