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+: None
• raw_results: None

(Conditional attributes enabled by default suffixed with +)

Methods

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

pass_attr : str, list of str|tuple, optional

Additional attributes to pass on to an output dataset. Attributes can be taken from all three attribute collections of an input dataset (sa, fa, a – see Dataset.get_attr()), or from the collection of conditional attributes (ca) of a node instance. Corresponding collection name prefixes should be used to identify attributes, e.g. ‘ca.null_prob’ for the conditional attribute ‘null_prob’, or ‘fa.stats’ for the feature attribute stats. In addition to a plain attribute identifier it is possible to use a tuple to trigger more complex operations. The first tuple element is the attribute identifier, as described before. The second element is the name of the target attribute collection (sa, fa, or a). The third element is the axis number of a multidimensional array that shall be swapped with the current first axis. The fourth element is a new name that shall be used for an attribute in the output dataset. Example: (‘ca.null_prob’, ‘fa’, 1, ‘pvalues’) will take the conditional attribute ‘null_prob’ and store it as a feature attribute ‘pvalues’, while swapping the first and second axes. Simplified instructions can be given by leaving out consecutive tuple elements starting from the end.

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