Package topo :: Package patterns :: Module basic :: Class Sweeper
[hide private]
[frames] | no frames]

Class Sweeper

source code

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

PatternGenerator that sweeps a supplied PatternGenerator in a direction perpendicular to its orientation.

Nested Classes [hide private]

Inherited from base.parameterizedobject.ParameterizedObject: __metaclass__

Instance Methods [hide private]
 
function(self, params)
Selects and returns one of the patterns in the list.
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 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]
  generator = <topo.base.parameterizedobject.Parameter object at...
Pattern to sweep.
  speed = Number(default= 0.25, bounds= (0.0, None), doc= ...
Sweep speed: number of sheet coordinate units per unit time.
  step = Number(default= 1, doc= ...
Number of steps at the given speed to move in the sweep direction.

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 
Selects and returns one of the patterns in the list.
Overrides: base.patterngenerator.PatternGenerator.function

Class Variable Details [hide private]

generator

Pattern to sweep.
Value:
Parameter(default= Gaussian(), precedence= 0.97, doc= "Pattern to sweep.")

speed

Sweep speed: number of sheet coordinate units per unit time.
Value:
Number(default= 0.25, bounds= (0.0, None), doc= """
        Sweep speed: number of sheet coordinate units per unit time.""")

step

Number of steps at the given speed to move in the sweep direction. The distance moved is speed*step.
Value:
Number(default= 1, doc= """
        Number of steps at the given speed to move in the sweep direction.
        The distance moved is speed*step.""")