make_pclo_order

make_pclo_order#

pypulseqpp.make_pclo_order()[source]#

Assign radius-ranked bands to identical echo trains in PCLO order.

Rydén’s pivot-centre, linear-outer permutation places the innermost band at an arbitrary centre echo, interleaves the neighbouring inner bands, then acquires the outer bands sequentially [1]. Each band is sorted by polar angle across shots. At centre echo 0 this is radius-then-angle centric ordering, the basic Busse radial construction [2]. No parameter distance between shots enters this assignment.

Parameters:
  • coords (array_like) – Centred view coordinates, shape (N, 2) or (N,). Indices in the result refer to these rows. Distances use the supplied units; boolean masks are refused.

  • train_length (int) – Number of echoes per shot, at least 1. The number of shots is ceil(N / train_length).

  • center_echo (int | None, default=None) – Zero-based echo receiving the innermost radial band. None is 0.

  • pad (bool, default=False) – Retain None slots so every row has train_length entries. With False empty slots are removed.

Returns:

Row indices into coords, indexed by shot and then echo. Every selected view is assigned exactly once; the support is unchanged.

Return type:

list of list of int or None

Raises:
  • TypeError – If coordinates are boolean or not numeric.

  • ValueError – If counts, centre echo or coordinate shape are invalid.

Notes

PCLO changes echo-to-ring assignment, rather than cyclically shifting whole bands. It therefore avoids a large index wrap near k-space centre. It does not remove relaxation-related PSF broadening. Shot-dependent parameter transitions require a joint shot/echo ordering instead.

A centre echo in the second half of the train keeps the same rule: the echoes after it take the outer bands in order. Rydén et al. mirror the permutation from the end of the train for such a centre, which puts the earliest echoes at the edge of k-space; this function does not.

Examples

>>> import pypulseqpp as pp
>>> pp.make_pclo_order([0, 1, 2, 3, 4, 5], 6, center_echo=2, pad=True)
[[1, 2, 0, 3, 4, 5]]

References