Package topo :: Package analysis :: Module featureresponses :: Class Feature
[hide private]
[frames] | no frames]

Class Feature

source code


Stores the parameters required for generating a map of one input feature.
Instance Methods [hide private]
 
__init__(self, name, range=None, step=0.0, values=None, cyclic=False, value_offset=0.0, value_multiplier=1.0, compute_fn=None, offset=0, keep_peak=True)
Users can provide either a range and a step size, or a list of values.
source code

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

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, name, range=None, step=0.0, values=None, cyclic=False, value_offset=0.0, value_multiplier=1.0, compute_fn=None, offset=0, keep_peak=True)
(Constructor)

source code 

Users can provide either a range and a step size, or a list of values. If a list of values is supplied, the range can be omitted unless the default of the min and max in the list of values is not appropriate.

If non-None, the compute_fn should be a function that when given a list of other parameter values, computes and returns the value for this feature.

If supplied, the offset is added to the given or computed values to allow the starting value to be specified.

Overrides: object.__init__