Sequence

class Sequence
__init__(self, name, version='', author='', author_email='', license='', description='', long_description='')
parameter:
  • name (str) -- sequence name
  • version (str) -- version name
  • author (str) -- author
  • author_email (str) -- mail address of the author
  • license (str) -- license
  • description (str) -- short description of the sequence
  • long_description (str) -- long description of the sequence

Main

Main()

It can only be used within the “with syntax” of the Sequence class. Used with the “with syntax” to implement the main loop of the Sequence.

return value:Loop

Test

Test()

It can only be used within the “with syntax” of the Sequence class. Used with the “with syntax” to implement the test loop of the Sequence.

return value:Loop

Loop

class Loop
__init__(self, id, loop_size)
parameter:
  • id (str) -- identifier of the loop
  • loop_size (int) -- loop size
__init__(self, id, loop_size, begin, end, step=1)
parameter:
  • id (str) -- identifier of the loop
  • loop_size (int) -- loop size
  • begin (int) -- loop start index
  • end (int) -- loop final index
  • step (int) -- increment of the loop index

BlockRef

BlockRef(id)
It can only be used within the “with syntax” of the Loop class. Arrange the contents of the Block by referring to the Block defined in Sequence
parameter:id (str) -- Identifier of the Block to refer

WaitFor

WaitFor(duration)

It can only be used within the “with syntax” of the Loop class.

parameter:duration (float or tuple(list[float], list[str])) -- duration time[microsecond]

WaitUntil

WaitUntil(time)

It can only be used within the “with syntax” of the Loop class.

parameter:time (float or tuple(list[float], list[str])) -- relative time in the Loop[microsecond]

Block

class Block

Used with the with syntax in the Sequence class's with syntax, and used for Block declaration and implementation

__init__(self, id, duration)
parameter:
  • id (str) -- identifier of the Block
  • duration (float or tuple(list[float], list[str])) -- duration time[microsecond]

Grad

class Grad

Class for defining the axis of gradient magnetic field and generating gradient magnetic field events

__init__(self, id, gx_factor, gy_factor, gz_factor)
parameter:
  • id (str) -- identifier of Grad
  • gx_factor (float) -- coefficient of Gx[0-1]
  • gy_factor (float) -- coefficient of Gy[0-1]
  • gz_factor (float) -- coefficient of Gz[0-1]
__call__(self, time, value, risetime=0.0)

It can only be used within the “with syntax” of the Block class.

parameter:
  • time (float or tuple(list[float], list[str])) -- start time[microsecond]
  • value (float or tuple(list[float], list[str])) -- final value[mT/m]
  • risetime (float or tuple(list[float], list[str])) -- rise (or fall) time[microsecond]
waveform(self, time, waveform, pitch, risetime=0.0)
parameter:
  • time (float or tuple(lsit[float], list[str])) -- start time[microsecond]
  • waveform (list[float] or tuple(list[list[float]], list[str])) -- waveform[mT/m]
  • pitch (list[float] or tuple(list[float], list[str])) -- dwell time[microsecond]
  • risetime (float or tuple(list[float], list[str])) -- rise (or fall) time[microsecond]

GX

GX=Grad('Gx', 1.0, 0.0, 0.0)

Predefined Grad objects. Used for event generation of Gx gradient magnetic field.

GY

GY=Grad('Gy', 0.0, 1.0, 0.0)

Predefined Grad objects. Used for event generation of Gy gradient magnetic field.

GZ

GZ=Grad('Gz', 0.0, 0.0, 1.0)

Predefined Grad objects. Used for event generation of Gz gradient magnetic field.

RF

RF(time, waveform, pitch, factor=1.0, gain=0.0, phase=0.0, frequency=0.0, channels=None)

It can only be used within the “with syntax” of the Block class. Generate an event of radio frequency magnetic field

parameter:
  • time (float or tuple(list[float], list[str])) -- start time[microsecond]
  • waveform (list[float], list[complex], tuple(list[list[float]], list[str]) or tuple(list[list[complex]], list[str])) -- waveform[micro Tesla]
  • pitch (float or tuple(list[float], list[str])) -- dwell time[microsecond]
  • factor (float or tuple(list[float], list[str])) -- amplitude factor for the waveform
  • gain (float or tuple(list[float], list[str])) -- transmitter gain[dB]
  • phase (float or tuple(list[float], list[str])) -- transmission phase[rad]
  • frequency (float or tuple(list[float], list[str])) -- offset frequency[kHz]
  • channels (list[int] or None) -- channel for control. In case of None, all channels are controlled.