To provide the most recent news and documentation www.pymvpa.org reflects the development 2.0 series (renamed 0.6 series) of PyMVPA. If you are interested in the documentation of the previous stable 0.4 series of PyMVPA, please visit v04.pymvpa.org.

mvpa2.mappers.fx.BinaryFxNode

class mvpa2.mappers.fx.BinaryFxNode(fx, space, **kwargs)

Extract a dataset attribute and call a function with it and the samples.

This node takes a dataset’s samples and a configurable attribute and passes them to a custom callable. This node can be used to implement comparisons, or error quantifications.

When called with a dataset the node returns a new dataset with the return value of the callable as samples.

Notes

Available conditional attributes:

• calling_time+: Time (in seconds) it took to call the node
• raw_results: Computed results before invoking postproc. Stored only if postproc is not None.

(Conditional attributes enabled by default suffixed with +)

Parameters :

fx : callable

Callable that is passed with the dataset samples as first and attribute values as second argument.

space : str

name of the sample attribute that contains the target values.

enable_ca : None or list of str

Names of the conditional attributes which should be enabled in addition to the default ones

disable_ca : None or list of str

Names of the conditional attributes which should be disabled

postproc : Node instance, optional

Node to perform post-processing of results. This node is applied in __call__() to perform a final processing step on the to be result dataset. If None, nothing is done.

descr : str

Description of the instance