Package VisionEgg :: Module Textures :: Class Mask2D
[frames | no frames]

Class Mask2D

         object --+    
                  |    
ClassWithParameters --+
                      |
                     Mask2D


A mask for windowing a portion of a texture.

Thanks to the author, Jon Peirce, of the AlphaStim class from the
PsychoPy package from which the idea to do this came.

Constant Parameters
===================
function         -- 'gaussian' or 'circle' (String)
                    Default: gaussian
num_samples      -- size of mask texture data (units: number of texels) (Sequence2 of Real)
                    Default: (256, 256)
radius_parameter -- radius for circle, sigma for gaussian (Real)
                    Default: 25.0

Method Summary
  __init__(self, **kw)
Create self.parameters and set values.
  draw_masked_quad(self, lt, rt, bt, tt, le, re, be, te, depth)
    Inherited from ClassWithParameters
  get_specified_type(self, parameter_name)
  is_constant_parameter(self, parameter_name)
  set(self, **kw)
Set a parameter with type-checked value This is the slow but safe way to set parameters.
  verify_parameters(self)
Perform type check on all parameters...
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name...
  __getattribute__(...)
x.__getattribute__('name') <==> x.name...
  __hash__(x)
x.__hash__() <==> hash(x)...
  __reduce__(...)
helper for pickle...
  __reduce_ex__(...)
helper for pickle...
  __repr__(x)
x.__repr__() <==> repr(x)...
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value...
  __str__(x)
x.__str__() <==> str(x)...
    Inherited from type
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T...

Class Variable Summary
dict constant_parameters_and_defaults = {'function': ('gaussi...
    Inherited from ClassWithParameters
tuple __slots__ = ('parameters', 'constant_parameters')
member_descriptor constant_parameters = <member 'constant_parameters' of '...
member_descriptor parameters = <member 'parameters' of 'ClassWithParameter...
ParameterDefinition parameters_and_defaults = {}

Method Details

__init__(self, **kw)
(Constructor)

Create self.parameters and set values.
Overrides:
VisionEgg.ClassWithParameters.__init__ (inherited documentation)

Class Variable Details

constant_parameters_and_defaults

Type:
dict
Value:
{'function': ('gaussian',
              <class 'VisionEgg.ParameterTypes.String'>,
              "'gaussian' or 'circle'"),
 'num_samples': ((256, 256),
                 <VisionEgg.ParameterTypes.Sequence2 object at 0x40f1f\
70c>,
                 'size of mask texture data (units: number of texels)'\
),
...                                                                    

Generated by Epydoc 2.0 on Fri Sep 19 18:29:39 2003 http://epydoc.sf.net