get_residue_starts#

biotite.structure.get_residue_starts(array, add_exclusive_stop=False)[source]#

Get indices for an atom array, each indicating the beginning of a residue.

A new residue starts, either when the chain ID, residue ID, insertion code or residue name changes from one to the next atom.

Parameters:
arrayAtomArray or AtomArrayStack

The atom array (stack) to get the residue starts from.

add_exclusive_stopbool, optional

If true, the exclusive stop of the input atom array, i.e. array.array_length(), is added to the returned array of start indices as last element.

Returns:
startsndarray, dtype=int

The start indices of residues in array.

Notes

This method is internally used by all other residue-related functions.

Examples

>>> print(get_residue_starts(atom_array))
[  0  16  35  56  75  92 116 135 157 169 176 183 197 208 219 226 250 264
 278 292]
>>> print(get_residue_starts(atom_array, add_exclusive_stop=True))
[  0  16  35  56  75  92 116 135 157 169 176 183 197 208 219 226 250 264
 278 292 304]