RfLayout

Contents

RfLayout#

class pulserver.design.RfLayout[source]#

Bases: object

The RF definitions a plugin plays and the instances of one TR.

An instance plays the RF amplitude amplitude * peak_hz * waveform of its definition, as pypulseqpp.Sequence.rf_instances() states. A control scales its instance with the protocol: a scanner that plays another value of the control multiplies the amplitude by the ratio of that value to the value in the evaluated protocol. An instance with control None plays at the amplitude it was evaluated at.

Attributes:

  • instances (pp.RfInstances) – The definitions, numbered by first play, and the instances of one TR in play order.

  • control (tuple[RfControl | None, …]) – One entry per instance: the control its amplitude is proportional to, or None.

  • period (float) – The TR in seconds.

Raises:

  • ValueError – If control does not hold one entry per instance, or period is not positive.

  • TypeError – If a control is neither None, FloatKey.FLIP nor a UserKey member. Other keys do not scale RF, and a plain string is not a member.

Methods

of

Return the layout of the RF instances of one TR.

Attributes

instances

control

period

Contents