Image dipole_pair Image list-add-relax-blue


Define interatomic interactions between pairs of spins.


interatom.define(spin_id1=`@N', spin_id2=`@H', direct_bond=True, spin_selection=True, pipe=None)

Keyword arguments

spin_id1: The spin ID string for the first spin of the interatomic interaction.

spin_id2: The spin ID string for the second spin of the interatomic interaction.

direct_bond: This is a flag which if True means that the two spins are directly bonded. This flag is useful to simplify the set up of the main heteronuclear relaxation mechanism or one-bond residual dipolar couplings.

spin_selection: Define the interatomic data container selection based on the spin selection. If either spin is deselected, the interatomic container will also be deselected. Otherwise the container will be selected.

pipe: The data pipe to create the interatomic data container for. This defaults to the current data pipe if not supplied.


To analyse relaxation or residual dipolar coupling (RDC) data, for example, pairs of spins which are coupled need to be defined. This can be via the magnetic dipole-dipole interaction or scalar coupling interaction. This function will create an interatomic data object connecting two existing spins. This data container will be used to store all information about the interactomic interaction including interatomic vectors and distances.

For analyses which use relaxation data, simply defining the interatomic interaction will indicate that there is a dipolar relaxation mechanism operating between the two spins. Note that for model-free analyses or reduced spectral density mapping, only a single relaxation mechanism can be handled. For RDC dependent analyses, the presence of the interatomic interaction indicates that dipolar coupling is expected between the two spins.

If the spin selection flag is set, then the newly created interatomic data container will be selected based on the current selection status of the two spins defining the interaction. If either of the spins are deselected, then the new interatomic data container will also be deselected. If both spins are selected, then the interatomic data container will also be selected.

Prompt examples

To connect the spins `:1@N' to `:1@H', type one of:

relax> interatom.define(':1@N', ':1@H')

relax> interatom.define(spin_id1=':1@N', spin_id2=':1@H')

To define the protein 15N heteronuclear relaxation mechanism for a model-free analysis, type one of the following:

relax> interatom.define('@N', '@H', True)

relax> interatom.define(spin_id1='@N', spin_id2='@H', direct_bond=True)

The relax user manual (PDF), created 2016-10-28.