GratingStim
=============================

.. code-block:: python

    class psychopy.visual.GratingStim(win, tex='sin', mask='none',
        units='', pos=(0.0, 0.0), size=None, sf=None, ori=0.0,
        phase=(0.0, 0.0), texRes=128, rgb=None, dkl=None, lms=None,
        color=(1.0, 1.0, 1.0), colorSpace='rgb', contrast=1.0,
        opacity=1.0, depth=0, rgbPedestal=(0.0, 0.0, 0.0),
        interpolate=False, name=None, autoLog=None, autoDraw=False,
        maskParams=None)

任意のパターンのビットマップを縦方向、横方向に反復描画するオブジェクトである。PsychoPyの主要な視覚刺激の一つである。

形式的にはGratingStimは透明度マスク(アルファマスク)の背後にあるテクスチャである。テクスチャとマスクは任意のビットマップであり、その組み合わせによって非常に多様な視覚刺激をリアルタイムに描画することができる。以下に例を示す。

.. code-block:: python

    # 円形のグレーティングパッチ
    myGrat = GratingStim(win, tex='sin', mask='circle')
    
    # Gaborパッチ
    myGabor = GratingStim(win, tex='sin', mask='gauss')

.. Stimulus object for drawing arbitrary bitmaps that can repeat (cycle) in either dimension.

.. One of the main stimuli for PsychoPy.

.. Formally GratingStim is just a texture behind an optional transparency mask (an ‘alpha mask’). Both the texture and mask can be arbitrary bitmaps and their combination allows an enormous variety of stimuli to be drawn in realtime.

.. Examples:

..     myGrat = GratingStim(win, tex='sin', mask='circle')  # gives a circular patch of grating
..     myGabor = GratingStim(win, tex='sin', mask='gauss')  # gives a 'Gabor'


GratingStimは回転、拡大縮小、平行移動が可能である。テクスチャは(刺激に固定された座標系で)X方向及びY方向にドリフト可能であり、X方向よびY方向の空間周波数を独立に設定できる。二つのGratingStimの不透明度を調整することにより、プラッド刺激を作成することも可能である。

.. A GratingStim can be rotated scaled and shifted in position, its texture can be drifted in X and/or Y and it can have a spatial frequency in X and/or Y (for an image file that simply draws multiple copies in the patch).

.. Also since transparency can be controlled two GratingStims can combine e.g. to form a plaid.

画像ファイル(jpg, tif, png, ...)を読み込んでGratingStimで使用する場合、画像ファイルは一辺が2の冪の正方形(16x16, 128x128など)であることが望ましい。この条件に合致しない画像は、その画像に最も近い2の冪の正方形になるように拡大される。長方形の画像をアスペクト比を保ったまま描画したい場合は、単位(deg, pix, cm, ...)に注意して刺激の大きさを適切に設定しなければならない。

.. Using GratingStim with images from disk (jpg, tif, png, ...)

.. Ideally texture images to be rendered should be square with ‘power-of-2’ dimensions e.g. 16 x 16, 128 x 128. Any image that is not will be upscaled (with linear interpolation) to the nearest such texture by PsychoPy. The size of the stimulus should be specified in the normal way using the appropriate units (deg, pix, cm, ...). Be sure to get the aspect ratio the same as the image (if you don’t want it stretched!).

autoDraw
---------------

flipの度に自動的に刺激を描画するか否かを指定する。値はTrueかFalseである。一度設定すると再度設定するまで有効なので、flipの度にこの値を設定する必要はない。

.. Determines whether the stimulus should be automatically drawn on every frame flip.
.. Value should be: True or False. You do NOT need to set this on every frame flip!

autoLog
-----------------------

刺激の設定を変更する度に自動的にログへ出力するか否かを指定する。値はTrueかFalseである。

刺激の位置をフレーム毎に変更する場合のように、頻繁に設定を変更する場合はFalseにするとよい。

.. Whether every change in this stimulus should be auto logged.
.. Value should be: True or False. Set to False if your stimulus is updating frequently (e.g. updating its position every frame) and you want to avoid swamping the log file with messages that aren't likely to be useful.


clearTextures()
-------------------------

刺激に割り当てられたテクスチャを全て消去する。

バージョン1.61.00以降ではこのメソッドはガベージコレクションの時に自動的に呼び出されるので、ユーザーが明示的にこのメソッドを呼び出す必要はなくなった。

.. Clear all textures associated with the stimulus.

.. As of v1.61.00 this is called automatically during garbage collection of your stimulus, so doesn’t need calling explicitly by the user.


color
-------------------------

刺激の色を指定する。値は以下のいずれかである。

- 色名を合わらず文字列。 standard html/X11 color names ( http://www.w3schools.com/html/html_colornames.asp ) の色名を使うことが出来る。
- 16進数表現。 #aaffe5 など。
- DKL、RGBなどの色空間上でのスカラーまたは3次元の数値。この場合は+=, -=などの複合的な演算代入子に対応している。

色が数値で指定された場合は、刺激の現在の色空間に基づいて解釈される。
値がスカラーで与えられた場合は、3次元全て同じ値を指定したものとみなされる。以下に例を示す。

.. code-block:: python

    # 色名による指定
    stim.color = 'white
    stim.color = 'RoyalBlue'
    
    # 16進数による指定 大文字小文字は区別されない
    stim.color = '#DDA0DD' # DDA0DDはプラムの16進数表現

    # RGB色空間で赤
    stim.color = [1.0, -1.0, -1.0]

    # DKL色空間でelev=0, azimuth=45
    stim.color = [0.0, 45.0, 1.0]

    # RGB255色空間で青
    stim.color = [0, 0, 255]

    # (255,255,255)と解釈される RGB255色空間では白である
    stim.color = 255

    # 演算代入子の使用例 すべての成分に1加える。
    stim.color += [1, 1, 1]
    # -1を乗ずる。色空間上で色を反転する
    stim.color *= -1
    # RGB255色空間で赤成分を減じ、緑成分を除いて青成分を保つ
    stim.color *= [0.5, 0, 1]

setColor()を用いると色と色空間を1つの文で変更できる。以下の二つは同一の処理である。

.. code-block:: python

    # その1 setColorを用いて1文で変更
    stim.setColor((0, 128, 255), 'rgb255')
    
    # その2 色空間と色をそれぞれ変更
    stim.colorSpace = 'rgb255'
    stim.color = (0, 128, 255)

.. Color of the stimulus

.. Value should be one of:

.. - string: to specify a Colors by name. Any of the standard html/X11 color names <http://www.w3schools.com/html/html_colornames.asp> can be used.
.. - Colors by hex value
.. - numerically: (scalar or triplet) for DKL, RGB or other Color spaces. For these, operations are supported.

.. When color is specified using numbers, it is interpreted with respect to the stimulus' current colorSpace. If color is given as a single value (scalar) then this will be applied to all 3 channels.

.. Examples

..     # ... for whatever stim you have: stim.color = 'white' stim.color = 'RoyalBlue' # (the case is actually ignored) stim.color = '#DDA0DD' # DDA0DD is hexadecimal for plum stim.color = [1.0, -1.0, -1.0] # if stim.colorSpace='rgb':

..         # a red color in rgb space

..     stim.color = [0.0, 45.0, 1.0] # if stim.colorSpace='dkl':
..         # DKL space with elev=0, azimuth=45
..     stim.color = [0, 0, 255] # if stim.colorSpace='rgb255':
..         # a blue stimulus using rgb255 space
..     stim.color = 255 # interpreted as (255, 255, 255)
..         # which is white in rgb255.

.. Operations work as normal for all numeric colorSpaces (e.g. 'rgb', 'hsv' and 'rgb255') but not for strings, like named and hex. For example, assuming that colorSpace='rgb':

..     stim.color += [1, 1, 1]  # increment all guns by 1 value
..     stim.color *= -1  # multiply the color by -1 (which in this
..                         # space inverts the contrast)
..     stim.color *= [0.5, 0, 1]  # decrease red, remove green, keep blue

.. You can use setColor if you want to set color and colorSpace in one line. These two are equivalent:

..     stim.setColor((0, 128, 255), 'rgb255')
..     # ... is equivalent to
..    stim.colorSpace = 'rgb255'
..     stim.color = (0, 128, 255)

colorSpace
-----------------------

使用する色空間を指定する。値は色空間を表す文字列かNoneである。

色を色名や16進数で指定する場合は色空間は設定不要である。Noneが指定された場合はPsychoPyの設定に従う。

色空間を変更しただけでは色のパラメータは変化しないため、画面に表示される色は変化する。表示される色を保ったまま色空間を変化させるには色空間変更後に色も変更する必要がある。以下に例を挙げる。

.. code-block:: python

        # RGB色空間でライトグリーンを設定
        stim = visual.TextStim(win, 'Color me!',
            color=(0, 1, 0), colorSpace='rgb')

        # 色空間をRGB255に変更すると、ほぼ黒色になってしまう
        stim.colorSpace = 'rgb255'

        # RGB255色空間でライトグリーンにする
        stim.color = (128, 255, 128)

.. The name of the color space currently being used

.. Value should be: a string or None

.. For strings and hex values this is not needed. If None the default colorSpace for the stimulus is used (defined during initialisation).

.. Please note that changing colorSpace does not change stimulus parameters. Thus you usually want to specify colorSpace before setting the color. Example:

..     # A light green text
..     stim = visual.TextStim(win, 'Color me!',
..                            color=(0, 1, 0), colorSpace='rgb')

..     # An almost-black text
..     stim.colorSpace = 'rgb255'

..     # Make it light green again
..     stim.color = (128, 255, 128)

contains(x, y=None, units=None)
------------------------------------

座標値が刺激の内部であればTrueを返す。
座標値は様々な方法で指定することが出来る。

- X座標とY座標を表す2つの数値を別々の引数として渡す。
- X座標とY座標をひとつにまとめたシーケンスを渡す。
- X座標とY座標を返すgetPos()メソッドを持つオブジェクト(マウスなど)を引数として渡す。

刺激オブジェクトのデータ属性borderを持つ場合はborder、持たない場合はデータ属性verticesの内部に座標値が含まれればTrueを返す。凹があったり輪郭と交差したりしているような複雑な図形でも扱うことが出来る。

刺激にマスク(Gaussianなど)を適用している場合、マスクはこのメソッドで考慮されない点に注意する事。刺激の範囲は純粋にデータ属性size、pos、ori (ShapeStim系のオブジェクトではverticesも)によって定義される。

参照：CoderのshapeContains.pyデモ

.. Returns True if a point x,y is inside the stimulus' border.

.. Can accept variety of input options:

.. - two separate args, x and y
.. - one arg (list, tuple or array) containing two vals (x,y)
.. - an object with a getPos() method that returns x,y, such as a Mouse.

.. Returns True if the point is within the area defined either by its border attribute (if one defined), or its vertices attribute if there is no .border. This method handles complex shapes, including concavities and self-crossings.

.. Note that, if your stimulus uses a mask (such as a Gaussian) then this is not accounted for by the contains method; the extent of the stimulus is determined purely by the size, position (pos), and orientation (ori) settings (and by the vertices for shape stimuli).

.. See Coder demos: shapeContains.py See Coder demos: shapeContains.py

contrast
------------------

色を決定する際にcolorの値に乗じられる。値は浮動小数点数で-1.0から1.0である。+=, -=などの複合的な演算代入子に対応している。

これによって刺激のコントラストを調節することが出来る。背景が灰色の場合はopacityを変更することによってもコントラストを調節することが可能だが、opacityを使う方法では負のコントラストを設定することは出来ない。以下に例を示す。

.. code-block:: python

    stim.contrast =  1.0  # 変化なし
    stim.contrast =  0.5  # コントラスト低下
    stim.contrast =  0.0  # 一様な灰色
    stim.contrast = -0.5  # コントラストが反転して低め
    stim.contrast = -1.0  # コントラストが完全に反転

この値を-1.0以下または1.0以上にすることも可能だが、colorの値と乗算した結果色空間の値域を超えてしまった場合は正常に描画されない。

.. code-block:: python

    stim.contrast =  1.2  # コントラスト増加
    stim.contrast = -1.2  # コントラストを反転させて増加

.. A value that is simply multiplied by the color

.. Value should be: a float between -1 (negative) and 1 (unchanged). Operations supported.

.. Set the contrast of the stimulus, i.e. scales how far the stimulus deviates from the middle grey. You can also use the stimulus opacity to control contrast, but that cannot be negative.

.. Examples:

..     stim.contrast =  1.0  # unchanged contrast
..     stim.contrast =  0.5  # decrease contrast
..     stim.contrast =  0.0  # uniform, no contrast
..     stim.contrast = -0.5  # slightly inverted
..     stim.contrast = -1.0  # totally inverted

.. Setting contrast outside range -1 to 1 is permitted, but may produce strange results if color values exceeds the monitor limits.:

..     stim.contrast =  1.2  # increases contrast
..     stim.contrast = -1.2  # inverts with increased contrast

depth
------------

このデータ属性は廃止された。刺激の重ね順は描画の順番で指定する。

.. DEPRECATED. Depth is now controlled simply by drawing order.

draw(win=None, keepMatrix=False)
-------------------------------------

刺激を描画する。

引数winが指定された場合はそのウィンドウに描画する。

.. Draw the stimulus in the relevant window. You must call this method after every win.flip() if you want the stimulus to appear on that frame and then update the screen again.


interpolate
-------------------------

刺激のテクスチャを拡大縮小する時に補間を行うか否かを指定する。Falseを指定すると最近傍のピクセルの色が用いられる。Trueの場合は補間がおこなわれる。

.. Whether to interpolate (linearly) the texture in the stimulus

.. If set to False then nearest neighbour will be used when needed, otherwise some form of interpolation will be used.


mask
----------------

アルファマスクを設定する。以下の形状のマスクを使用出来る。

--------------- ----------------------------------------------------
値              備考
--------------- ----------------------------------------------------
None            マスクなし
'circle'        円形の窓
'gauss'         ガウス関数に従って周辺に向かって透明度を増す窓
'raisedCos'     Raised Cosine窓
画像ファイル名  画像をマスクとして使用する
numpyのarray    1xNまたはNxNで値が-1.0から1.0のもの
--------------- ----------------------------------------------------

.. The alpha mask (forming the shape of the image)

.. This can be one of various options:

..     ‘circle’, ‘gauss’, ‘raisedCos’, ‘cross’
..     None (resets to default)
..     the name of an image file (most formats supported)
..     a numpy array (1xN or NxN) ranging -1:1

maskParams
------------------------

マスクのパラメータを指定する。デフォルト値はNoneである。

'gauss'の場合は、{'sd':5}という具合にガウス関数の標準偏差を辞書オブジェクトで指定する。

'raisedCos'の場合は、{'fringeWidth':0.2}という具合にフリンジ幅を指定する。
値域は0.0から1.0で、Raised Cosine窓のエッジによってぼかされる範囲が変化する。

.. Various types of input. Default to None.

.. This is used to pass additional parameters to the mask if those are needed.

..     For ‘gauss’ mask, pass dict {‘sd’: 5} to control standard deviation.

..     For the ‘raisedCos’ mask, pass a dict: {‘fringeWidth’:0.2}, where ‘fringeWidth’ is a parameter (float, 0-1), determining the proportion of the patch that will be blurred by the raised cosine edge.

name
--------------------

この刺激オブジェクトに関するログを出力す時の名前を設定する。デフォルト値はNoneである。実験で複数の刺激を使用する際にログファイルの可読性を高める。

名前がNoneの場合は"unnamed <type>"という名前でログに出力される。<type>にはクラス名が入る。例えばpsychopy.visual.TextStimならば"unnamed TextStim"と出力される。

.. String or None. The name of the object to be using during logged messages about this stim. If you have multiple stimuli in your experiment this really helps to make sense of log files!

.. If name = None your stimulus will be called “unnamed <type>”, e.g. visual.TextStim(win) will be called “unnamed TextStim” in the logs.

opacity
--------------------------

刺激の不透明度を設定する。値は0.0から1.0で0.0が完全な透明、1.0が完全な不透明である。+=, -=などの複合的な演算代入子に対応している。

透過処理の方法はWindowオブジェクトのBlendModeによって決定される。

..    Determines how visible the stimulus is relative to background

..     The value should be a single float ranging 1.0 (opaque) to 0.0 (transparent). Operations are supported. Precisely how this is used depends on the Blend Mode.

ori
---------------------------

刺激の回転角度を設定する。単位は度である。+=, -=などの複合的な演算代入子に対応している。

0度をアナログ時計の文字盤の12時の方向として、正の値が時計回りの回転である。0度未満および360度より大きい値は(370度→10度のように)丸められる。

.. The orientation of the stimulus (in degrees).

.. Should be a single value (scalar). Operations are supported.

.. Orientation convention is like a clock: 0 is vertical, and positive values rotate clockwise. Beyond 360 and below zero values wrap appropriately.

overlaps(polygon)
-------------------------

個の刺激が他の刺激と交差していればTrueを返す。

交差している対象がポリゴンであれば、その頂点の座標が判定に用いられる。一般的に交差の判定はうまくいくが、非常に尖った図形が剣を交差させたような配置では失敗することがある。

刺激にマスク(Gaussianなど)を適用している場合、マスクはこのメソッドで考慮されない点に注意する事。刺激の範囲は純粋にデータ属性size、pos、ori (ShapeStim系のオブジェクトではverticesも)によって定義される。

参照：CoderのshapeContains.pyデモ

.. Returns True if this stimulus intersects another one.

.. If polygon is another stimulus instance, then the vertices and location of that stimulus will be used as the polygon. Overlap detection is typically very good, but it can fail with very pointy shapes in a crossed-swords configuration.

.. Note that, if your stimulus uses a mask (such as a Gaussian blob) then this is not accounted for by the overlaps method; the extent of the stimulus is determined purely by the size, pos, and orientation settings (and by the vertices for shape stimuli).

.. See coder demo, shapeContains.py

phase
-----------------

テクスチャのX方向及びY方向の位相を指定する。値はX, Yの値を並べたシーケンスかスカラーである。

位相は(360や2 \* piではなく)1を法とする点に注意。これは一般的ではないが位相にt \* nを設定することによってn Hzのドリフトになるという利点がある。

(訳注：ここで「1を法とする」とは1で割った余りの値となるという意味だと考えておけばよい。すなわち1.78は0.78と同一である。また、ここでpsychopy.core.ClockのgetTime()の戻り値ように秒の単位で現在時刻を格納している変数である。)

.. Phase of the stimulus in each dimension of the texture.

.. Should be an x,y-pair or scalar

.. NB phase has modulus 1 (rather than 360 or 2*pi) This is a little unconventional but has the nice effect that setting phase=t*n drifts a stimulus at n Hz


pos
-----------------------

刺激の中心の座標を指定する。座標値の単位はunitsに従う。+=, -=などの複合的な演算代入子に対応している。以下に例を示す。

.. code-block:: python

    stim.pos = (0.5, 0)  # 中央やや右寄りに配置
    stim.pos += (0.5, -1)  # 刺激をやや右下に動かす
        # これによって(0.5, 0)から(1.0, -1.0)に移動する。
    stim.pos *= 0.2  # 座標値に0.2を乗ずる。
        # これによって(1.0, -1.0)から(0.2, -0.2)に移動する。

unitsがpix以外の時にpix単位の位置表現が必要な場合は以下のようにするとよい。

.. code-block:: python

    from psychopy.tools.monitorunittools import posToPix

    posPix = posToPix(stim)


.. The position of the center of the stimulus in the stimulus units

.. value should be an x,y-pair. Operations are also supported.

.. Example:

..     stim.pos = (0.5, 0)  # Set slightly to the right of center
..     stim.pos += (0.5, -1)  # Increment pos rightwards and upwards.
..         Is now (1.0, -1.0)
..     stim.pos *= 0.2  # Move stim towards the center.
..         Is now (0.2, -0.2)

.. Tip: If you need the position of stim in pixels, you can obtain it like this:

..     from psychopy.tools.monitorunittools import posToPix posPix = posToPix(stim)


setAutoDraw(value, log=None)
-------------------------------

autoDrawを設定する。

stim.autoDraw = valueと同一である。ログに出力したくない場合はこちらを用いると良い。

.. Sets autoDraw. Usually you can use 'stim.attribute = value' syntax instead, but use this method to suppress the log message.

setAutoLog(value=True, log=None)
----------------------------------

stim.autoLog = valueと同一である。ログに出力したくない場合はこちらを用いると良い。

setColor(color, colorSpace=None, operation='')
------------------------------------------------------

stim.color = colorと同一である。ログに出力したくない場合や色空間を同時に指定したい場合はこちらを用いると良い。


setContrast(newContrast, operation='', log=None)
-------------------------------------------------------

stim.contrast = newContrastと同一である。ログに出力したくない場合はこちらを用いると良い。

.. Usually you can use ‘stim.attribute = value’ syntax instead, but use this method if you need to suppress the log message

setDKL(newDKL, operation='')
---------------------------------------------------------

バージョン1.60.05にて廃止。colorを使用すること。

.. DEPRECATED since v1.60.05: Please use the color attribute

setDepth(newDepth, operation='', log=None)
---------------------------------------------------------

このメソッドは廃止された。現在のバージョンでは刺激の重ね順はdraw()の順番で制御される。

.. Usually you can use ‘stim.attribute = value’ syntax instead, but use this method if you need to suppress the log message

setLMS(newLMS, operation='')
---------------------------------------------------------

バージョン1.60.05にて廃止。colorを使用すること。

.. DEPRECATED since v1.60.05: Please use the color attribute

setMask(value, log=None)
--------------------------------------------------

stim.mask = valueと同一である。ログに出力したくない場合はこちらを用いると良い。

.. Usually you can use ‘stim.attribute = value’ syntax instead, but use this method if you need to suppress the log message.

setOpacity(newOpacity, operation='', log=None)
------------------------------------------------------

stim.opacity = newOpacityと同一である。ログに出力したくない場合はこちらを用いると良い。

.. Usually you can use ‘stim.attribute = value’ syntax instead, but use this method if you need to suppress the log message

setOri(newOri, operation='', log=None)
-------------------------------------------------------

stim.ori = newOriと同一である。ログに出力したくない場合はこちらを用いると良い。

.. Usually you can use ‘stim.attribute = value’ syntax instead, but use this method if you need to suppress the log message

setPhase(value, operation='', log=None)
--------------------------------------------

stim.phase = valueと同一である。ログに出力したくない場合はこちらを用いると良い。

(訳注：原文ではこのメソッドは「廃止」となっている)

.. DEPRECATED. Use ‘stim.parameter = value’ syntax instead

setPos(newPos, operation='', log=None)
----------------------------------------------

stim.pos = newPosと同一である。ログに出力したくない場合はこちらを用いると良い。

.. Usually you can use ‘stim.attribute = value’ syntax instead, but use this method if you need to suppress the log message.

setRGB(newRGB, operation='', log=None)
----------------------------------------------------

バージョン1.60.05にて廃止。colorを使用すること。

.. DEPRECATED since v1.60.05: Please use the color attribute

setSF(value, operation='', log=None)
-----------------------------------------------------------------------

stim.sf = valueと同一である。ログに出力したくない場合はこちらを用いると良い。

(訳注：原文ではこのメソッドは「廃止」となっている)

.. DEPRECATED. Use ‘stim.parameter = value’ syntax instead

setSize(newSize, operation='', units=None, log=None)
---------------------------------------------------------

stim.size = newSizeと同一である。ログに出力したくない場合はこちらを用いると良い。

.. Usually you can use ‘stim.attribute = value’ syntax instead, but use this method if you need to suppress the log message

setTex(value, log=None)
-----------------------------------------------------------------------

stim.tex = valueと同一である。ログに出力したくない場合はこちらを用いると良い。

(訳注：原文ではこのメソッドは「廃止」となっている)

.. DEPRECATED. Use ‘stim.parameter = value’ syntax instead

setUseShaders(value=True, log=None)
-------------------------------------------

stim.useShaders = valueと同一である。ログに出力したくない場合はこちらを用いると良い。

.. Usually you can use ‘stim.attribute = value’ syntax instead, but use this method if you need to suppress the log message

sf
-------------------------

X方向及びY方向の空間周波数を指定する。値はX, Yの値を並べたシーケンスかスカラー、あるいはNoneである。

unitsが'deg'ならばcycles/deg、'cm'ならばcycles/cmとなる。'norm'の場合は、刺激における繰り返し回数となる(すなわちsf=3ならばsizeに関わらず3回繰り返される)。texがファイルから読み込まれた画像の場合、sfにNoneを設定すると空間周波数は「1/刺激サイズ」に設定され、画像が1サイクル表示される。

.. Spatial frequency of the grating texture

.. Should be a x,y-pair or scalar or None. If units == ‘deg’ or ‘cm’ units are in cycles per deg or cm as appropriate.

.. If units == ‘norm’ then sf units are in cycles per stimulus
..     (and so SF scales with stimulus size).
.. If texture is an image loaded from a file then sf=None
..     defaults to 1/stimSize to give one cycle of the image.

size
-----------------------

刺激のサイズ(幅、高さ)を設定する。単位はunitsに従う。

値は幅、高さに設定する値を(x, y)のように並べたシーケンスか、2.0のようなスカラー値(幅、高さともこの値に設定される)か、None(デフォルト値にリセット)のいずれかである。
+=, -=などの複合的な演算代入子に対応している。

幅や高さは負の値を取ることが出来る(負の値は反転を意味する)。ウィンドウより大きな幅や高さを指定することも可能である。
以下に使用例を示す。

.. code-block:: python

    stim.size = 0.8  # サイズを(0.8, 0.8)に設定したのと同じ
    print(stim.size)  # array([0.8, 0.8])と出力される
    stim.size += (0.5, -0.5)  # より幅広く、平らになる。
                              # サイズの値は(1.3, 0.3)になる。

実際に画面に描画される際のピクセルでの高さ、幅が必要な場合はstim._sizeRenderedを見ると良い。

.. The size (width, height) of the stimulus in the stimulus units

.. Value should be x,y-pair, scalar (applies to both dimensions) or None (resets to default). Operations are supported.

.. Sizes can be negative (causing a mirror-image reversal) and can extend beyond the window.

.. Example:

.. stim.size = 0.8  # Set size to (xsize, ysize) = (0.8, 0.8)
.. print(stim.size)  # Outputs array([0.8, 0.8])
.. stim.size += (0.5, -0.5)  # make wider and flatter: (1.3, 0.3)

.. Tip: if you can see the actual pixel range this corresponds to by looking at stim._sizeRendered

tex
--------------------------

グレーティング刺激の描画に用いるテクスチャを指定する(キャリアとも呼ばれる)。さまざまなオプションを指定できる。

- 'sin': 正弦波
- 'sqr': 矩形波
- 'saw': 鋸波
- 'tri': 三角波
- None: なし(一様)
- ファイル名: PILで読み込めるフォーマットの画像
- NumPyのarrayオブジェクト: 1xNまたはNxNで値が-1.0から1.0のもの

画像やNumPyのarrayオブジェクトを用いる場合は、2の冪の正方形のもの(例えば256x256)を用いること。この条件に合致しない場合、最も近い2の冪の正方形になるように拡大される。

.. Texture to used on the stimulus as a grating (aka carrier)

.. This can be one of various options:

..     ‘sin’,’sqr’, ‘saw’, ‘tri’, None (resets to default)
..     the name of an image file (most formats supported)
..     a numpy array (1xN or NxN) ranging -1:1

.. If specifying your own texture using an image or numpy array you should ensure that the image has square power-of-two dimesnions (e.g. 256 x 256). If not then PsychoPy will upsample your stimulus to the next larger power of two.

texRes
----------------

マスクとテクスチャの解像度を設定する。値は2の冪の整数でなければならない。numpyのarrayや画像がマスクとして指定された場合はその解像度に上書きされる。+=, -=などの複合的な演算代入子に対応している。

.. Power-of-two int. Sets the resolution of the mask and texture. texRes is overridden if an array or image is provided as mask.

.. Operations supported.

units
-------------------------------

刺激のサイズ、位置などを指定する際の単位を設定する。None, 'norm', 'cm', 'deg', 'degFlat', 'degFlatPos', 'pix'のいずれかである。
Noneが指定された場合は、刺激を描画するウィンドウの設定に従う。

刺激のunitsを変化してもposやsizeなどの値は自動的に変化しないので、描画結果が変化する点に注意。以下に例を示す。


.. code-block:: python

    # この刺激はウィンドウ中心から枠までの幅の20%、高さの50%の大きさである。
    stim = visual.PatchStim(win, units='norm', size=(0.2, 0.5)

    # 単位をdegに変更すると、幅が視角0.2度、高さが0.5度になる。
    stim.units = 'deg'

.. None, ‘norm’, ‘cm’, ‘deg’, ‘degFlat’, ‘degFlatPos’, or ‘pix’

.. If None then the current units of the Window will be used. See Units for the window and stimuli for explanation of other options.

.. Note that when you change units, you don’t change the stimulus parameters and it is likely to change appearance. Example:

.. # This stimulus is 20% wide and 50% tall with respect to window
.. stim = visual.PatchStim(win, units='norm', size=(0.2, 0.5)

.. # This stimulus is 0.2 degrees wide and 0.5 degrees tall.
.. stim.units = 'deg'

useShaders
--------------------------

刺激のレンダリングにシェーダーを使用するか否かを指定する。Trueならば使用する。

もし使用しているPCがOpenGL シェーディング言語をサポートしているのならば、この値をTrueのままにしておくことを強く推奨する。シェーダーを使用しない/出来ない場合は刺激の色やコントラストの変更などの操作が遅くなる。

.. Should shaders be used to render the stimulus (typically leave as True)

.. If the system support the use of OpenGL shader language then leaving this set to True is highly recommended. If shaders cannot be used then various operations will be slower (notably, changes to stimulus color or contrast)

verticesPix
------------------------

刺激の各頂点の現在の座標値をsize、ori、pos、unitsに基づいてピクセルに計算した結果を保持している。

.. This determines the coordinates of the vertices for the current stimulus in pixels, accounting for size, ori, pos and units

win
-----------------------------------

この刺激が描画されるWindowオブジェクトを指定する。この引数は省略できない。

例として、同一の刺激を複数のウィンドウに同時に描画するコードを挙げる。二つのウィンドウに対応するWindowオブジェクトが変数win1、win2に格納されていて、刺激オブジェクトが変数stimに格納されているとする。

.. code-block:: python

   stim.win = win1  # stimの描画先をwin1に設定
   stim.draw()  # win1に描画
   stim.win = win2  # stimの描画先をwin2に設定
   stim.draw()  # win2に描画
   win1.flip(waitBlanking=False)  # win1をflip
                # 垂直同期を待たないのがポイント
   win2.flip()  # win2をflip 今度は垂直同期を待つ

このデータ属性はデフォルトで描画するウィンドウを指定するものである。draw()メソッドの引数にWindowオブジェクトを指定することによって、描画時に描画先を指定することが出来る。

.. code-block:: python

   stim.draw(win1)
   stim.draw(win2)

.. The Window object in which the
..     stimulus will be rendered by default. (required)

.. Example, drawing same stimulus in two different windows and display simultaneously. Assuming that you have two windows and a stimulus (win1, win2 and stim):

..    stim.win = win1  # stimulus will be drawn in win1
..    stim.draw()  # stimulus is now drawn to win1
..    stim.win = win2  # stimulus will be drawn in win2
..    stim.draw()  # it is now drawn in win2
..    win1.flip(waitBlanking=False)  # do not wait for next
..                 # monitor update
..    win2.flip()  # wait for vertical blanking.

.. Note that this just changes **default** window for stimulus.
.. You could also specify window-to-draw-to when drawing::

..    stim.draw(win1)
..    stim.draw(win2)