make_adc

Contents

make_adc#

pypulseqpp.make_adc()[source]#

Create an ADC readout event.

Parameters:

  • num_samples (int) – Number of readout samples.

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

  • dwell (float, default=0) – ADC dead time in seconds (s) after sampling.

  • duration (float, default=0) – Duration in seconds (s) of ADC readout event with num_samples number of samples.

  • delay (float, default=0) – Delay in seconds (s) of ADC readout event.

  • freq_offset (float, default=0) – Frequency offset of ADC readout event.

  • phase_offset (float, default=0) – Phase offset of ADC readout event.

  • freq_ppm (float, default=0) – PPM frequency offset of ADC readout event.

  • phase_ppm (float, default=0) – PPM phase offset of ADC readout event.

  • phase_modulation (Union[np.ndarray, None], default=None) – Phase modulation array for FOV shifting. If provided, it must have num_samples number of samples.

Returns:

adc – ADC readout event.

Return type:

SimpleNamespace

Raises:

ValueError – If neither dwell nor duration are defined.

Notes

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

Contents