Package topo :: Package pattern :: Module basic :: Class Gaussian

Class Gaussian

                        object --+        
                                 |        
 param.parameterized.Parameterized --+    
                                     |    
base.patterngenerator.PatternGenerator --+
                                         |
                                        Gaussian

2D Gaussian pattern generator.

The sigmas of the Gaussian are calculated from the size and aspect_ratio parameters:

ysigma=size/2 xsigma=ysigma*aspect_ratio

The Gaussian is then computed for the given (x,y) values as:

exp(-x^2/(2*xsigma^2) - y^2/(2*ysigma^2)

Nested Classes

[hide private]

Inherited from param.parameterized.Parameterized: __metaclass__

Instance Methods

[hide private]

function(self, params)
Function to draw a pattern that will then be scaled and rotated.

source code

Inherited from base.patterngenerator.PatternGenerator: __call__

Inherited from base.patterngenerator.PatternGenerator (private): _apply_mask

Inherited from param.parameterized.Parameterized: __getstate__, __init__, __repr__, __setstate__, __str__, debug, defaults, force_new_dynamic_value, get_param_values, get_value_generator, inspect_value, message, print_param_values, script_repr, set_dynamic_time_fn, state_pop, state_push, verbose, warning

Inherited from param.parameterized.Parameterized (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 param.parameterized.Parameterized: params, print_param_defaults

Class Variables

[hide private]

aspect_ratio = param.Number(default= 0.3, bounds= (0.0, None),...
Ratio of the width to the height.

size = param.Number(default= 0.5, doc= ...
Overall size of the Gaussian, defined by: exp(-x^2/(2*xsigma^2) - y^2/(2*ysigma^2) where ysigma=size/2 and xsigma=size/2*aspect_ratio.

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

Inherited from param.parameterized.Parameterized: name, print_level

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

function(self, params)

source code

Function to draw a pattern that will then be scaled and rotated.

Instead of implementing __call__ directly, PatternGenerator subclasses will typically implement this helper function used by __call__, because that way they can let __call__ handle the scaling and rotation for them. Alternatively, __call__ itself can be reimplemented entirely by a subclass (e.g. if it does not need to do any scaling or rotation), in which case this function will be ignored.

Overrides: base.patterngenerator.PatternGenerator.function: (inherited documentation)

Class Variable Details

[hide private]

aspect_ratio

Ratio of the width to the height. Specifically, xsigma=ysigma*aspect_ratio (see size).

Value:

param.Number(default= 0.3, bounds= (0.0, None), softbounds= (0.0, 2.0), precedence
= 0.31, doc= """
        Ratio of the width to the height.
        Specifically, xsigma=ysigma*aspect_ratio (see size).""")

size

Overall size of the Gaussian, defined by: exp(-x^2/(2*xsigma^2) - y^2/(2*ysigma^2) where ysigma=size/2 and xsigma=size/2*aspect_ratio.

Value:

param.Number(default= 0.5, doc= """
        Overall size of the Gaussian, defined by:
        exp(-x^2/(2*xsigma^2) - y^2/(2*ysigma^2)
        where ysigma=size/2 and xsigma=size/2*aspect_ratio.""")