Sequence

class Sequence
__init__(self, name, version='', author='', author_email='', license='', description='', long_description='')
パラメータ:
  • name (str) -- シーケンス名
  • version (str) -- バージョン情報
  • author (str) -- 著者
  • author_email (str) -- 著者のメールアドレス
  • license (str) -- ライセンス
  • description (str) -- シーケンスの簡単な説明
  • long_description (str) -- シーケンスの詳細な説明

Main

Main()

Sequenceクラスのwith構文内でのみ使用できる。 with構文と共に使用して、Sequenceのメインループの実装に用いる。

戻り値の型:Loop

Test

Test()

Sequenceクラスのwith構文内でのみ使用できる。 with構文と共に使用して、Sequenceのテストループの実装に用いる。

戻り値の型:Loop

Loop

class Loop
__init__(self, id, loop_size)
パラメータ:
  • id (str) -- ループの識別子
  • loop_size (int) -- ループサイズ
__init__(self, id, loop_size, begin, end, step=1)
パラメータ:
  • id (str) -- ループの識別子
  • loop_size (int) -- ループサイズ
  • begin (int) -- ループ開始インデックス
  • end (int) -- ループ終了インデックス
  • step (int) -- ループインデックスの増分

BlockRef

BlockRef(id)
Loopクラスのwith構文内でのみ使用できる。 Sequence内で定義されたBlockを参照して、配置する。
パラメータ:id (str) -- 参照先のBlockの識別子

WaitFor

WaitFor(duration)

Loopクラスのwith構文内でのみ使用できる。

パラメータ:duration (float or tuple(list[float], list[str])) -- 継続時間[us]

WaitUntil

WaitUntil(time)

Loopクラスのwith構文内でのみ使用できる。

パラメータ:time (float or tuple(list[float], list[str])) -- ループ内時刻[us]

Block

class Block

Sequenceクラスのwith構文内で、with構文と共に使用し、Blockの宣言と実装に用いる。

__init__(self, id, duration)
パラメータ:
  • id (str) -- Blockの識別子
  • duration (float or tuple(list[float], list[str])) -- 継続時間[us]

Grad

class Grad

傾斜磁場の軸を定義し、傾斜磁場のイベントを生成するためのクラス

__init__(self, id, gx_factor, gy_factor, gz_factor)
パラメータ:
  • id (str) -- Gradの識別子
  • gx_factor (float) -- Gxの係数[0-1]
  • gy_factor (float) -- Gyの係数[0-1]
  • gz_factor (float) -- Gzの係数[0-1]
__call__(self, time, value, risetime=0.0)

Blockクラスのwith構文内でのみ使用できる。

パラメータ:
  • time (float or tuple(list[float], list[str])) -- 開始時刻[us]
  • value (float or tuple(list[float], list[str])) -- 目標値[mT/m]
  • risetime (float or tuple(list[float], list[str])) -- 立ち上がり時間[us]
waveform(self, time, waveform, pitch, risetime=0.0)
パラメータ:
  • time (float or tuple(lsit[float], list[str])) -- 開始時刻[us]
  • waveform (list[float] or tuple(list[list[float]], list[str])) -- 波形[mT/m]
  • pitch (list[float] or tuple(list[float], list[str])) -- 制御時間刻み[us]
  • risetime (float or tuple(list[float], list[str])) -- 立ち上がり時間[us]

GX

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

事前定義済みのGradオブジェクト。Gx傾斜磁場のイベント生成に用いる。

GY

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

事前定義済みのGradオブジェクト。Gy傾斜磁場のイベント生成に用いる。

GZ

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

事前定義済みのGradオブジェクト。Gz傾斜磁場のイベント生成に用いる。

RF

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

Blockクラスのwith構文内でのみ使用できる。 高周波磁場のイベントを生成する

パラメータ:
  • time (float or tuple(list[float], list[str])) -- 開始時刻[us]
  • waveform (list[float], list[complex], tuple(list[list[float]], list[str]) or tuple(list[list[complex]], list[str])) -- 波形[uT]
  • pitch (float or tuple(list[float], list[str])) -- 制御時間刻み[us]
  • factor (float or tuple(list[float], list[str])) -- 波形の係数
  • gain (float or tuple(list[float], list[str])) -- 送信のゲイン[dB]
  • phase (float or tuple(list[float], list[str])) -- 位相[rad]
  • frequency (float or tuple(list[float], list[str])) -- 相対周波数[kHz]
  • channels (list[int] or None) -- 制御対象のチャンネル。Noneの場合すべてのチャンネルが制御対象になる。