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

# Class Mask2D

source code

             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

Instance Methods
__init__(self, **kw) Create self.parameters and set values. | source code
draw_masked_quad_3d(self, lt, rt, bt, tt, v1, v2, v3, v4) | source code
draw_masked_quad(self, lt, rt, bt, tt, le, re, be, te, depth) | source code
Inherited from `ClassWithParameters`: `__getstate__`, `__setstate__`, `get_specified_type`, `is_constant_parameter`, `set`, `verify_parameters` Inherited from `object`: `__delattr__`, `__getattribute__`, `__hash__`, `__new__`, `__reduce__`, `__reduce_ex__`, `__repr__`, `__setattr__`, `__str__`

Class Variables
| constant_parameters_and_defaults = `{'function':('gaussian', ve`...``
Inherited from `ClassWithParameters`: `__safe_for_unpickling__`, `parameters_and_defaults`

Properties
Inherited from `object`: `__class__`

Method Details

### __init__(self, **kw) (Constructor) | source code
    Create self.parameters and set values.
Overrides: ClassWithParameters.__init__ (inherited documentation)

Class Variable Details

  ### constant_parameters_and_defaults Value:
      {'function':('gaussian', ve_types.String, "'gaussian' or 'circle'"), '
      radius_parameter':(25.0, ve_types.Real, "radius for circle, sigma for
      gaussian"), 'num_samples':((256, 256), ve_types.Sequence2(ve_types.Rea
      l), "size of mask texture data (units: number of texels)"),}