Package PyDSTool :: Module MProject :: Class feature

Class feature

object --+
         |
        feature

Known Subclasses:

End users of concrete sub-classes provide (required) evaluate method and (optional) prepare, finish methods.

Instance Methods

[hide private]

__init__(self, name, description='', pars=None, ref_traj=None)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature source code

__hash__(self)
hash(x)

source code

__eq__(self, other)

source code

__ne__(self, other)

source code

_find_idx(self)
Internal function for finding index in trajectory meshpoints at which containment first failed.

source code

__call__(self, target)

source code

set_ref_traj(self, ref_traj)
May or may not be used by the feature.

source code

evaluate(self, target)

source code

prepare(self, target)
Operations to prepare for testing (optional).

source code

finish(self, target)
Operations to complete only if evaluate was True (optional).

source code

info(self)

source code

postprocess_ref_traj(self)
User-definable by overriding in a sub-class

source code

validate(self)
NOT YET IMPLEMENTED.

source code

reset_metric(self)

source code

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

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, name, description=`''`, pars=None, ref_traj=None)
(Constructor)

source code

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__: (inherited documentation)

hash(self)
(Hashing function)

source code

hash(x)

Overrides: object.__hash__: (inherited documentation)

_find_idx(self)

source code

Internal function for finding index in trajectory meshpoints at which containment first failed. Defaults to returning None and must be overridden by a class that has access to a mesh.

set_ref_traj(self, ref_traj)

source code

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

prepare(self, target)

source code

Operations to prepare for testing (optional). Override in concrete sub-class if desired

finish(self, target)

source code

Operations to complete only if evaluate was True (optional). Override in concrete sub-class if desired

validate(self)

source code

NOT YET IMPLEMENTED. Would test for reachability of a feature? This is not easy and may be unnecessary!

Class feature

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

__hash__(self) (Hashing function)

_find_idx(self)

set_ref_traj(self, ref_traj)

prepare(self, target)

finish(self, target)

validate(self)

init(self, name, description=`''`, pars=None, ref_traj=None)
(Constructor)

hash(self)
(Hashing function)