make_sinc_pulse

make_sinc_pulse#

pypulseqpp.make_sinc_pulse()[source]#

Creates a radio-frequency sinc pulse event and optionally accompanying slice select and slice select rephasing trapezoidal gradient events.

Parameters:

  • flip_angle (float) – Flip angle in radians.

  • apodization (float, default=0) – Apodization.

  • center_pos (float, default=0.5) – Position of peak.5 (midway).

  • delay (float, default=0) – Delay in seconds (s).

  • duration (float, default=4e-3) – Duration in seconds (s).

  • dwell (float, default=0)

  • freq_offset (float, default=0) – Frequency offset in Hertz (Hz).

  • max_grad (float, default=0) – Maximum gradient strength of accompanying slice select trapezoidal event.

  • max_slew (float, default=0) – Maximum slew rate of accompanying slice select trapezoidal event.

  • phase_offset (float, default=0) – Phase offset in Hertz (Hz).

  • return_gz (bool, default=False) – Boolean flag to indicate if slice-selective gradient has to be returned.

  • slice_thickness (float, default=0) – Slice thickness of accompanying slice select trapezoidal event. The slice thickness determines the area of the slice select event.

  • system (Opts, default=Opts()) – System limits. Default is a system limits object initialized to default values.

  • time_bw_product (float, default=4) – Time-bandwidth product.

  • use (str, default='undefined') – Use of radio-frequency sinc pulse event. Must be one of ‘excitation’, ‘refocusing’, ‘inversion’, ‘saturation’, ‘preparation’, ‘other’, ‘undefined’.

  • freq_ppm (float, default=0) – PPM frequency offset.

  • phase_ppm (float, default=0) – PPM phase offset.

  • pypulseq.Sequence.sequence.Sequence.add_block(). (See also)

Returns:

  • rf (SimpleNamespace) – Radio-frequency sinc pulse event.

  • gz (SimpleNamespace, optional) – Accompanying slice select trapezoidal gradient event. Returned only if slice_thickness is provided.

  • gzr (SimpleNamespace, optional) – Accompanying slice select rephasing trapezoidal gradient event. Returned only if slice_thickness is provided.

Raises:

ValueError – If invalid use parameter was passed. If return_gz=True and slice_thickness was not provided.

Notes

This is PyPulseq’s factory; the event it builds is returned with its fields in slots.