.. _apiref:

Sequence
########

.. py:class:: Sequence
   
   .. py:method:: __init__(self, name, version='', author='', author_email='', license='', description='', long_description='')

      :param str name: シーケンス名
      :param str version: バージョン情報
      :param str author: 著者
      :param str author_email: 著者のメールアドレス
      :param str license: ライセンス
      :param str description: シーケンスの簡単な説明
      :param str long_description: シーケンスの詳細な説明

Main
####

.. py:function:: Main()

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

   :rtype: Loop

Test
####

.. py:function:: Test()

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

   :rtype: Loop

Loop
####

.. py:class:: Loop
   
   .. py:method:: __init__(self, id, loop_size)

      :param str id: ループの識別子
      :param int loop_size: ループサイズ

   .. py:method:: __init__(self, id, loop_size, begin, end, step=1)

      :param str id: ループの識別子
      :param int loop_size: ループサイズ
      :param int begin: ループ開始インデックス
      :param int end: ループ終了インデックス
      :param int step: ループインデックスの増分

BlockRef
########

.. py:function:: BlockRef(id)

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

WaitFor
#######

.. py:function:: WaitFor(duration)

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

    :param duration: 継続時間[us]
    :type duration: float or tuple(list[float], list[str])

WaitUntil
#########

.. py:function:: WaitUntil(time)

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

    :param time: ループ内時刻[us]
    :type time: float or tuple(list[float], list[str])

Block
#####

.. py:class:: Block

   Sequenceクラスのwith構文内で、with構文と共に使用し、Blockの宣言と実装に用いる。
   
   .. py:method:: __init__(self, id, duration)

      :param str id: Blockの識別子
      :param duration: 継続時間[us]
      :type duration: float or tuple(list[float], list[str])

Grad
####

.. py:class:: Grad

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

   .. py:method:: __init__(self, id, gx_factor, gy_factor, gz_factor)

      :param str id: Gradの識別子
      :param float gx_factor: Gxの係数[0-1]
      :param float gy_factor: Gyの係数[0-1]
      :param float gz_factor: Gzの係数[0-1]

   .. py:method:: __call__(self, time, value, risetime=0.0)
      
      Blockクラスのwith構文内でのみ使用できる。

      :param time: 開始時刻[us]
      :param value: 目標値[mT/m]
      :param risetime: 立ち上がり時間[us]
      :type time: float or tuple(list[float], list[str])
      :type value: float or tuple(list[float], list[str])
      :type risetime: float or tuple(list[float], list[str])

   .. py:method:: waveform(self, time, waveform, pitch, risetime=0.0)

      :param time: 開始時刻[us]
      :param waveform: 波形[mT/m]
      :param pitch: 制御時間刻み[us]
      :param risetime: 立ち上がり時間[us]
      :type time: float or tuple(lsit[float], list[str])
      :type waveform: list[float] or tuple(list[list[float]], list[str])
      :type pitch: list[float] or tuple(list[float], list[str])
      :type risetime: float or tuple(list[float], list[str])

GX
##
.. py:data:: GX=Grad('Gx', 1.0, 0.0, 0.0)
   
   事前定義済みのGradオブジェクト。Gx傾斜磁場のイベント生成に用いる。

GY
##

.. py:data:: GY=Grad('Gy', 0.0, 1.0, 0.0)
   
   事前定義済みのGradオブジェクト。Gy傾斜磁場のイベント生成に用いる。

GZ
##

.. py:data:: GZ=Grad('Gz', 0.0, 0.0, 1.0)
   
   事前定義済みのGradオブジェクト。Gz傾斜磁場のイベント生成に用いる。

RF
##

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

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

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

AD
##

.. py:function:: AD(time, points, pitch, factor=1.0, gain=0.0, phase=0.0, frequency=0.0, channels=None)

   Blockクラスのwith構文内でのみ使用できる。
   信号サンプリングイベントを生成する。

   :param time: 開始時刻[us]
   :param points: サンプリング点数
   :param pitch: 制御時間刻み[us]
   :param factor: 信号の係数
   :param gain: 受信のゲイン[dB]
   :param phase: 位相[rad]
   :param frequency: 相対周波数[kHz]
   :param channels: 制御対象のチャンネル。Noneの場合すべてのチャンネルが制御対象になる。
   :type time: float or tuple(list[float], list[str])
   :type points: int or tuple(list[int], list[str])
   :type pitch: float or tuple(list[float], list[str])
   :type factor: float or tuple(list[float], list[str])
   :type gain: float or tuple(list[float], list[str])
   :type phase: float or tuple(list[float], list[str])
   :type frequency: float or tuple(list[float], list[str])
   :type channels: list[int] or None