mvpa2.measures.base.BinaryFxNode

class mvpa2.measures.base.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 +)

Methods

generate(ds)	Yield processing results.
get_postproc()	Returns the post-processing node or None.
get_space()	Query the processing space name of this node.
reset()
set_postproc(node)	Assigns a post-processing node Set to None to disable postprocessing.
set_space(name)	Set the processing space name of this node.

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

Methods

generate(ds)	Yield processing results.
get_postproc()	Returns the post-processing node or None.
get_space()	Query the processing space name of this node.
reset()
set_postproc(node)	Assigns a post-processing node Set to None to disable postprocessing.
set_space(name)	Set the processing space name of this node.