Package prompt :: Module paramag :: Class Paramag
[hide private]
[frames] | no frames]

Class Paramag

source code


Class for handling paramagnetic information.

Instance Methods [hide private]
 
centre(self, pos=None, atom_id=None, pipe=None, verbosity=1, fix=True, ave_pos=True, force=False)
Specify which atom is the paramagnetic centre.
source code

Inherited from base_class.User_fn_class: __init__

Method Details [hide private]

centre(self, pos=None, atom_id=None, pipe=None, verbosity=1, fix=True, ave_pos=True, force=False)

source code 
Specify which atom is the paramagnetic centre.

Keyword Arguments
~~~~~~~~~~~~~~~~~

pos:  The atomic position.

atom_id:  The atom ID string.

pipe:  The data pipe containing the structures to extract the centre from.

verbosity:  The amount of information to print out.

fix:  A flag specifying if the paramagnetic centre should be fixed during optimisation.

ave_pos:  A flag specifying if the position of the atom is to be averaged across all models.

force:  A flag which if True will cause the current paramagnetic centre to be overwritten.


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

This function is required for specifying where the paramagnetic centre is located in the
loaded structure file.  If no structure number is given, then the average atom position will
be calculated if multiple structures are loaded.

A different set of structures than those loaded into the current data pipe can also be used
to determine the position, or its average.  This can be achieved by loading the alternative
structures into another data pipe, and then specifying that pipe through the pipe argument.

If the ave_pos flag is set to True, the average position from all models will be used as the
position of the paramagnetic centre.  If False, then the positions from all structures will
be used.  If multiple positions are used, then a fast paramagnetic centre motion will be
assumed so that PCSs for a single tensor will be calculated for each position, and the PCS
values linearly averaged.


Examples
~~~~~~~~

If the paramagnetic centre is the lanthanide Dysprosium which is labelled as Dy in a loaded
PDB file, then type one of:

relax> paramag.centre('Dy')
relax> paramag.centre(atom_id='Dy')

If the carbon atom 'C1' of residue '4' in the PDB file is to be used as the paramagnetic
centre, then type:

relax> paramag.centre(':4@C1')

To state that the Dy3+ atomic position is [0.136, 12.543, 4.356], type one of:

relax> paramag.centre([0.136, 12.543, 4.356])
relax> paramag.centre(pos=[0.136, 12.543, 4.356])

To find an unknown paramagnetic centre, type:

relax> paramag.centre(fix=False)