Package topo :: Package patterns :: Module basic :: Class SquareGrating

Class SquareGrating

                                  object --+        
                                           |        
base.parameterizedobject.ParameterizedObject --+    
                                               |    
          base.patterngenerator.PatternGenerator --+
                                                   |
                                                  SquareGrating

2D squarewave grating pattern generator.

Nested Classes

[hide private]

Inherited from base.parameterizedobject.ParameterizedObject: __metaclass__

Instance Methods

[hide private]

function(self, params)
Return a square-wave grating (alternating black and white bars).

source code

Inherited from base.patterngenerator.PatternGenerator: __call__

Inherited from base.parameterizedobject.ParameterizedObject: __getstate__, __init__, __repr__, __setstate__, __str__, as_uninitialized, debug, defaults, force_new_dynamic_value, get_param_values, get_value_generator, inspect_value, message, print_param_values, script_repr, verbose, warning

Inherited from base.parameterizedobject.ParameterizedObject (private): _check_params, _instantiate_param, _set_name, _setup_params

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__

Class Methods

[hide private]

Inherited from base.parameterizedobject.ParameterizedObject: params, print_param_defaults

Class Variables

[hide private]

frequency = <topo.base.parameterclasses.Number object at 0x9da...
Frequency of the square grating.

phase = Number(default= 0.0, bounds= (0.0, None), softbounds= ...
Phase of the square grating.

Inherited from base.patterngenerator.PatternGenerator: bounds, mask, offset, orientation, output_fn, position, scale, size, x, xdensity, y, ydensity

Inherited from base.parameterizedobject.ParameterizedObject: name, print_level

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

function(self, params)

source code

Return a square-wave grating (alternating black and white bars).

Overrides: base.patterngenerator.PatternGenerator.function

Class Variable Details

[hide private]

frequency

Frequency of the square grating.

Value:

Number(default= 2.4, bounds= (0.0, None), softbounds= (0.0, 10.0), precedence= 0.5
0, doc= "Frequency of the square grating.")

phase

Phase of the square grating.

Value:

Number(default= 0.0, bounds= (0.0, None), softbounds= (0.0, 2* pi), precedence= 0.
51, doc= "Phase of the square grating.")