<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>VisionEgg.Gratings.SinGrating2D</title>
<link rel="stylesheet" href="epydoc.css" type="text/css" />
<script type="text/javascript" src="epydoc.js"></script>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="VisionEgg-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.visionegg.org">Vision Egg</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
<a href="VisionEgg-module.html">Package VisionEgg</a> ::
<a href="VisionEgg.Gratings-module.html">Module Gratings</a> ::
Class SinGrating2D
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="VisionEgg.Gratings.SinGrating2D-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class SinGrating2D</h1><span class="codelink"><a href="VisionEgg.Gratings-pysrc.html#SinGrating2D">source code</a></span><br /><br />
<pre class="base-tree">
object --+
|
<a href="VisionEgg.ClassWithParameters-class.html">ClassWithParameters</a> --+
|
<a href="VisionEgg.Core.Stimulus-class.html">Core.Stimulus</a> --+
|
<a href="VisionEgg.Gratings.LuminanceGratingCommon-class.html">LuminanceGratingCommon</a> --+
|
<strong class="uidshort">SinGrating2D</strong>
</pre>
<hr />
<pre class="literalblock">
Sine wave grating stimulus
This is a general-purpose, realtime sine-wave luminace grating
generator. To acheive an arbitrary orientation, this class rotates
a textured quad. To draw a grating with sides that always remain
horizontal and vertical, draw a large grating in a small viewport.
(The viewport will clip anything beyond its edges.)
Parameters
==========
anchor -- specifies how position parameter is interpreted (String)
Default: center
bit_depth -- precision with which grating is calculated and sent to OpenGL (UnsignedInteger)
Inherited from LuminanceGratingCommon
Default: 8
color1 -- (AnyOf(Sequence3 of Real or Sequence4 of Real))
Default: (1.0, 1.0, 1.0)
color2 -- optional color with which to perform interpolation with color1 in RGB space (AnyOf(Sequence3 of Real or Sequence4 of Real))
Default: (determined at runtime)
contrast -- (Real)
Default: 1.0
depth -- (Real)
Default: (determined at runtime)
ignore_time -- (Boolean)
Default: False
mask -- optional masking function (Instance of <class 'VisionEgg.Textures.Mask2D'>)
Default: (determined at runtime)
max_alpha -- (Real)
Default: 1.0
num_samples -- (UnsignedInteger)
Default: 512
on -- draw stimulus? (Boolean)
Default: True
orientation -- (Real)
Default: 0.0
pedestal -- (Real)
Default: 0.5
phase_at_t0 -- (Real)
Default: 0.0
position -- (units: eye coordinates) (Sequence2 of Real)
Default: (320.0, 240.0)
recalculate_phase_tolerance -- (Real)
Default: (determined at runtime)
size -- defines coordinate size of grating (in eye coordinates) (Sequence2 of Real)
Default: (640.0, 480.0)
spatial_freq -- frequency defined relative to coordinates defined in size parameter (units: cycles/eye_coord_unit) (Real)
Default: 0.0078125
t0_time_sec_absolute -- (Real)
Default: (determined at runtime)
temporal_freq_hz -- (Real)
Default: 5.0
</pre><br /><br />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Instance Methods</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="VisionEgg.Gratings.SinGrating2D-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">**kw</span>)</span><br />
Instantiate and get ready to draw.</td>
<td align="right" valign="top">
<span class="codelink"><a href="VisionEgg.Gratings-pysrc.html#SinGrating2D.__init__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a name="__del__"></a><span class="summary-sig-name">__del__</span>(<span class="summary-sig-arg">self</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="VisionEgg.Gratings-pysrc.html#SinGrating2D.__del__">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr>
<td><span class="summary-sig"><a href="VisionEgg.Gratings.SinGrating2D-class.html#draw" class="summary-sig-name">draw</a>(<span class="summary-sig-arg">self</span>)</span><br />
Draw the stimulus.</td>
<td align="right" valign="top">
<span class="codelink"><a href="VisionEgg.Gratings-pysrc.html#SinGrating2D.draw">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="VisionEgg.Gratings.LuminanceGratingCommon-class.html">LuminanceGratingCommon</a></code></b>:
<code><a href="VisionEgg.Gratings.LuminanceGratingCommon-class.html#calculate_bit_depth_dependencies">calculate_bit_depth_dependencies</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="VisionEgg.ClassWithParameters-class.html">ClassWithParameters</a></code></b>:
<code><a href="VisionEgg.ClassWithParameters-class.html#__getstate__">__getstate__</a></code>,
<code><a href="VisionEgg.ClassWithParameters-class.html#__setstate__">__setstate__</a></code>,
<code><a href="VisionEgg.ClassWithParameters-class.html#get_specified_type">get_specified_type</a></code>,
<code><a href="VisionEgg.ClassWithParameters-class.html#is_constant_parameter">is_constant_parameter</a></code>,
<code><a href="VisionEgg.ClassWithParameters-class.html#set">set</a></code>,
<code><a href="VisionEgg.ClassWithParameters-class.html#verify_parameters">verify_parameters</a></code>
</p>
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__repr__</code>,
<code>__setattr__</code>,
<code>__str__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Class Variables</span></td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
<a href="VisionEgg.Gratings.SinGrating2D-class.html#parameters_and_defaults" class="summary-name">parameters_and_defaults</a> = <code title="VisionEgg.ParameterDefinition({'on':(True, ve_types.Boolean, "draw sti\
mulus?"), 'mask':(None, ve_types.Instance(VisionEgg.Textures.Mask2D), \
"optional masking function"), 'contrast':(1.0, ve_types.Real), 'pedest\
al':(0.5, ve_types.Real), 'position':((320.0, 240.0), ve_types.Sequenc\
e2(ve_types.Real), "(units: eye coordinates)"), 'anchor':('center', ve\
_types.String, "specifies how position parameter is interpreted"), 'de\
pth':(None, ve_types.Real), 'size':((640.0, 480.0), ve_types.Sequence2\
(ve_types.Real), "defines coordinate size of grating (in eye coordinat\
...">VisionEgg.ParameterDefinition({'on':<code class="variable-ellipsis">...</code></code>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code><a href="VisionEgg.ClassWithParameters-class.html">ClassWithParameters</a></code></b>:
<code><a href="VisionEgg.ClassWithParameters-class.html#__safe_for_unpickling__">__safe_for_unpickling__</a></code>,
<code><a href="VisionEgg.ClassWithParameters-class.html#constant_parameters_and_defaults">constant_parameters_and_defaults</a></code>
</p>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Properties</span></td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">**kw</span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="VisionEgg.Gratings-pysrc.html#SinGrating2D.__init__">source code</a></span>
</td>
</table>
<pre class="literalblock">
Instantiate and get ready to draw.
Set parameter values and create anything needed to draw the
stimulus including OpenGL state variables such display lists
and texture objects.
</pre>
<dl class="fields">
<dt>Overrides:
<a href="VisionEgg.Core.Stimulus-class.html#__init__">Core.Stimulus.__init__</a>
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<a name="draw"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<table width="100%" cellpadding="0" cellspacing="0" border="0">
<tr valign="top"><td>
<h3 class="epydoc"><span class="sig"><span class="sig-name">draw</span>(<span class="sig-arg">self</span>)</span>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="VisionEgg.Gratings-pysrc.html#SinGrating2D.draw">source code</a></span>
</td>
</table>
<pre class="literalblock">
Draw the stimulus. (Called by Viewport instance.)
This method is called every frame. This method actually
performs the OpenGL calls to draw the stimulus.
</pre>
<dl class="fields">
<dt>Overrides:
<a href="VisionEgg.Core.Stimulus-class.html#draw">Core.Stimulus.draw</a>
<dd><em class="note">(inherited documentation)</em></dd>
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
<a name="section-ClassVariableDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Class Variable Details</span></td>
</tr>
</table>
<a name="parameters_and_defaults"></a>
<div>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr><td>
<h3 class="epydoc">parameters_and_defaults</h3>
<dl class="fields">
</dl>
<dl class="fields">
<dt>Value:</dt>
<dd><table><tr><td><pre class="variable">
VisionEgg.ParameterDefinition({'on':(True, ve_types.Boolean, "draw sti<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
mulus?"), 'mask':(None, ve_types.Instance(VisionEgg.Textures.Mask2D), <span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
"optional masking function"), 'contrast':(1.0, ve_types.Real), 'pedest<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
al':(0.5, ve_types.Real), 'position':((320.0, 240.0), ve_types.Sequenc<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
e2(ve_types.Real), "(units: eye coordinates)"), 'anchor':('center', ve<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
_types.String, "specifies how position parameter is interpreted"), 'de<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
pth':(None, ve_types.Real), 'size':((640.0, 480.0), ve_types.Sequence2<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
(ve_types.Real), "defines coordinate size of grating (in eye coordinat<span class="variable-linewrap"><img src="crarr.png" alt="\" /></span>
<code class="variable-ellipsis">...</code>
</pre></td></tr></table>
</dd>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="VisionEgg-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.visionegg.org">Vision Egg</a></th>
</tr></table></th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
Generated by Epydoc 3.0beta1 on Sat Jun 7 15:40:10 2008
</td>
<td align="right" class="footer">
<a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
</td>
</tr>
</table>
<script type="text/javascript">
<!--
// Private objects are initially displayed (because if
// javascript is turned off then we want them to be
// visible); but by default, we want to hide them. So hide
// them unless we have a cookie that says to show them.
checkCookie()
// -->
</script>
</body>
</html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
b4347e6708d280a7ffb2b5b2ea3cdb9d
>
files
>
293
