Package PyDSTool :: Module MProject :: Class feature_node
[hide private]
[frames] | no frames]

Class feature_node

source code

object --+    
         |    
   feature --+
             |
            feature_node
Known Subclasses:

Abstract super-class for feature regular nodes (supporting sub-features).

Instance Methods [hide private]
 
__init__(self, name, description='', pars=None, ref_traj=None, subfeatures=None)
Sub-features is an ordered sequence of QL or QT feature instances which are (by default) evaluated in this order on a trajectory segment unless evaluation method is overridden.
source code
 
_residual_info(self, feats, sizes)
Update feats and sizes lists in place with metric info, if any.
source code
 
__str__(self)
str(x)
source code
 
__repr__(self)
str(x)
source code
 
__getitem__(self, featname)
Return named sub-feature
source code
 
propagate_verbosity(self, sf) source code
 
evaluate(self, target)
Default method: evaluate sub-features in order (assumes they are stored as a list).
source code
 
set_ref_traj(self, ref_traj)
May or may not be used by the feature.
source code

Inherited from feature: __call__, __eq__, __hash__, __ne__, finish, info, postprocess_ref_traj, prepare, reset_metric, validate

Inherited from feature (private): _find_idx

Inherited from object: __delattr__, __getattribute__, __new__, __reduce__, __reduce_ex__, __setattr__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, name, description='', pars=None, ref_traj=None, subfeatures=None)
(Constructor)

source code 

Sub-features is an ordered sequence of QL or QT feature instances which are (by default) evaluated in this order on a trajectory segment unless evaluation method is overridden.

For more sophisticated use of sub-features, they should be provided as a dictionary mapping feature names to the feature instance.

Overrides: object.__init__

__str__(self)
(Informal representation operator)

source code 

str(x)

Overrides: object.__str__
(inherited documentation)

__repr__(self)
(Representation operator)

source code 

str(x)

Overrides: object.__repr__
(inherited documentation)

evaluate(self, target)

source code 

Default method: evaluate sub-features in order (assumes they are stored as a list).

Can override with more sophisticated method (e.g. for use with a dictionary of sub-features).

Overrides: feature.evaluate

set_ref_traj(self, ref_traj)

source code 

May or may not be used by the feature. If not used, it will be ignored.

Overrides: feature.set_ref_traj