Image spin Image edit-rename


Name the spins.

Defaults, spin_id=None, force=False)

Keyword arguments

name: The new name.

spin_id: The spin identification string corresponding to one or more spins.

force: A flag which if True will cause the spin to be renamed.


This simply allows spins to be named (or renamed). Spin naming often essential. For example when reading Sparky peak list files, then the spin name must match that in the file.

Spin ID string documentation

The identification string is composed of three components: the molecule ID token beginning with the `#' character, the residue ID token beginning with the `:' character, and the atom or spin system ID token beginning with the `@' character. Each token can be composed of multiple elements - one per spin - separated by the `,' character and each individual element can either be a number (which must be an integer, in string format), a name, or a range of numbers separated by the `-' character. Negative numbers are supported. The full ID string specification is `#<mol_name> :<res_id>[, <res_id>[, <res_id>, ...]] @<atom_id>[, <atom_id>[, <atom_id>, ...]]', where the token elements are `<mol_name>', the name of the molecule, `<res_id>', the residue identifier which can be a number, name, or range of numbers, `<atom_id>', the atom or spin system identifier which can be a number, name, or range of numbers.

If one of the tokens is left out then all elements will be assumed to match. For example if the string does not contain the `#' character then all molecules will match the string. If only the molecule ID component is specified, then all spins of the molecule will match.

Regular expression can be used to select spins. For example the string `@H*' will select the protons `H', `H2', `H98'.

Prompt examples

The following sequence of commands will rename the sequence {1 C1, 2 C2, 3 C3} to {1 C11, 2 C12, 3 C13}:

relax>'@1', 'C11', force=True)

relax>'@2', 'C12', force=True)

relax>'@3', 'C13', force=True)

The relax user manual (PDF), created 2024-06-08.