plot_kspace

Contents

plot_kspace#

pypulseqpp.plot.plot_kspace()[source]#

Plot the ADC sampling locations in k-space.

Parameters:
  • seq (Sequence) – The sequence to draw.

  • time_range (sequence, default=None) – The part of the sequence to draw; at most one. A time range is two times (s), a block range the first and last block and a repetition range the first and last repetition, both 1-based and inclusive. The whole sequence when none is given.

  • block_range (sequence, default=None) – The part of the sequence to draw; at most one. A time range is two times (s), a block range the first and last block and a repetition range the first and last repetition, both 1-based and inclusive. The whole sequence when none is given.

  • tr_range (sequence, default=None) – The part of the sequence to draw; at most one. A time range is two times (s), a block range the first and last block and a repetition range the first and last repetition, both 1-based and inclusive. The whole sequence when none is given.

  • plane (str, default=None) – Two of x, y, z and f (for example "xy") to project onto, where f is the transmit frequency offset (Hz) of each sample’s slice. When None, a trajectory confined to a plane is drawn in it and any other in 3D.

  • show_trajectory (bool, default=True) – Also draw the trajectory between samples. The axis limits are set from the sampling locations either way, so a prewinder or spoiler is clipped rather than setting the scale.

  • color_by ({"echo", "shot", "order"}, default=None) – Colour samples by echo index within the shot, by shot index, or by both in two panels ("order"). A panel whose index never varies is dropped.

  • plot_now (bool, default=True) – Show the figure before returning.

Returns:

The figure the sampling locations were drawn on.

Return type:

matplotlib.figure.Figure

Raises:

ValueError – If more than one range is given, a range is backwards or outside the sequence, color_by or plane is invalid, or the range holds no ADC samples.

Notes

Coordinates are k-space in 1/m, after each block’s rotation.