Package topo :: Package numbergen :: Module basic :: Class VonMisesRandom

Class VonMisesRandom

Circularly normal distributed random number.

If kappa is zero, this distribution reduces to a uniform random angle over the range 0 to 2*pi. Otherwise, it is concentrated to a greater or lesser degree (determined by kappa) around the mean mu. For large kappa (narrow peaks), this distribution approaches the Gaussian (normal) distribution with variance 1/kappa. See the random module for further details.

Nested Classes

[hide private]

Inherited from param.parameterized.Parameterized: __metaclass__

Instance Methods

[hide private]

__call__(self)

source code

Inherited from RandomDistribution: __init__

Inherited from NumberGenerator: __abs__, __add__, __div__, __floordiv__, __mod__, __mul__, __neg__, __pos__, __pow__, __radd__, __rdiv__, __rfloordiv__, __rmod__, __rmul__, __rpow__, __rsub__, __rtruediv__, __sub__, __truediv__

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

Inherited from param.parameterized.Parameterized (private): _add_parameter, _instantiate_param, _set_name, _setup_params

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

Class Methods

[hide private]

Inherited from param.parameterized.Parameterized: params, print_param_defaults

Class Variables

[hide private]

mu = param.Number(default= 0.0, softbounds= (0.0, 2* pi), doc=...
Mean value, in the range 0 to 2*pi.

kappa = param.Number(default= 1.0, softbounds= (0.0, 50.0), do...
Concentration (inverse variance).

name = <param.parameterized.String object at 0xb1ff7ec>
String identifier for this object.

Inherited from param.parameterized.Parameterized: print_level

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

call(self)
(Call operator)

source code

Overrides: NumberGenerator.__call__

Class Variable Details

[hide private]

mu

Mean value, in the range 0 to 2*pi.

Value:

param.Number(default= 0.0, softbounds= (0.0, 2* pi), doc= """
        Mean value, in the range 0 to 2*pi.""")

kappa

Concentration (inverse variance).

Value:

param.Number(default= 1.0, softbounds= (0.0, 50.0), doc= """
        Concentration (inverse variance).""")

Class VonMisesRandom

__call__(self) (Call operator)

mu

kappa

call(self)
(Call operator)