This content refers to an unreleased development version of PyMVPA

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.misc.args.group_kwargs

mvpa2.misc.args.group_kwargs(prefixes, assign=False, passthrough=False)

Decorator function to join parts of kwargs together

Parameters :

prefixes : list of strs

Prefixes to split based on. See split_kwargs

assign : bool

Flag to assign the obtained arguments to self._<prefix>_kwargs

passthrough : bool

Flag to pass joined arguments as <prefix>_kwargs argument. Usually it is sufficient to have either assign or passthrough. If none of those is True, decorator simply filters out mentioned groups from being passed to the method

Example: if needed to join all args which start with ‘slave<underscore>’ :

together under slave_kwargs parameter :