Package topo :: Package outputfn :: Module basic :: Class GeneralizedLogistic
[hide private]
[frames] | no frames]

Class GeneralizedLogistic

source code

                       object --+        
                                |        
param.parameterized.Parameterized --+    
                                    |    
         base.functionfamily.OutputFn --+
                                        |
                                       GeneralizedLogistic

The generalized logistic curve (Richards' curve): y = l + (u /(1 + b * exp(-r*(x-2*m))^(1/b))).

The logistic curve is a flexible function for specifying a nonlinear growth curve using five parameters:

From Richards, F.J. (1959), A flexible growth function for empirical use. J. Experimental Botany 10: 290--300. http://en.wikipedia.org/wiki/Generalised_logistic_curve

Nested Classes [hide private]

Inherited from param.parameterized.Parameterized: __metaclass__

Instance Methods [hide private]
 
__call__(self, x) source code

Inherited from base.functionfamily.OutputFn: __add__

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 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]
  l = param.Number(default= 1, doc= "Parameter controlling the l...
Parameter controlling the lower asymptote.
  u = param.Number(default= 1, doc= "Parameter controlling the u...
Parameter controlling the upper asymptote (upper asymptote minus lower asymptote.
  m = param.Number(default= 1, doc= "Parameter controlling the t...
Parameter controlling the time of maximum growth.
  r = param.Number(default= 1, doc= "Parameter controlling the g...
Parameter controlling the growth rate.
  b = param.Number(default= 1, doc= "Parameter which affects nea...
Parameter which affects near which asymptote maximum growth occurs.

Inherited from base.functionfamily.OutputFn: norm_value

Inherited from param.parameterized.Parameterized: name, print_level

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__call__(self, x)
(Call operator)

source code 
Overrides: base.functionfamily.OutputFn.__call__

Class Variable Details [hide private]

l

Parameter controlling the lower asymptote.
Value:
param.Number(default= 1, doc= "Parameter controlling the lower asymptote.")

u

Parameter controlling the upper asymptote (upper asymptote minus lower asymptote.
Value:
param.Number(default= 1, doc= "Parameter controlling the upper asymptote (upper as\
ymptote minus lower asymptote.")

m

Parameter controlling the time of maximum growth.
Value:
param.Number(default= 1, doc= "Parameter controlling the time of maximum growth.")

r

Parameter controlling the growth rate.
Value:
param.Number(default= 1, doc= "Parameter controlling the growth rate.")

b

Parameter which affects near which asymptote maximum growth occurs.
Value:
param.Number(default= 1, doc= "Parameter which affects near which asymptote maximu\
m growth occurs.")