Module data

source code

Module for handling the frame order data in the relax data store.

Functions

[hide private]

list of str

base_data_types()
Determine all the base data types.

source code

str

domain_moving()
Return the spin ID string corresponding to the moving domain.

source code

bool

pivot_fixed()
Determine if the pivot is fixed or not.

source code

(int, AlignTensorData instance)

tensor_loop(red=False)
Generator method for looping over the full or reduced tensors.

source code

bool

translation_fixed()
Is the translation of the average domain position fixed?

source code

Variables

[hide private]

__package__ = 'specific_analyses.frame_order'

Imports: RelaxError, interatomic_loop, spin_loop

Function Details

[hide private]

base_data_types()

source code

Determine all the base data types.

The base data types can include:

   - 'rdc', residual dipolar couplings.
   - 'pcs', pseudo-contact shifts.

Returns: list of str: A list of all the base data types.

domain_moving()

source code

Return the spin ID string corresponding to the moving domain.

Returns: str: The spin ID string defining the moving domain.

pivot_fixed()

source code

Determine if the pivot is fixed or not.

Returns: bool: The answer to the question.

tensor_loop(red=False)

source code

Generator method for looping over the full or reduced tensors.

Parameters:

red (bool) - A flag which if True causes the reduced tensors to be returned, and if False the full tensors are returned.

Returns: (int, AlignTensorData instance)

The tensor index and the tensor.

translation_fixed()

source code

Is the translation of the average domain position fixed?

Returns: bool: The answer to the question.