brain_pipe.preprocessing.transpose.Transpose

class Transpose(keys: Dict[str, Any] | Sequence[str] | str, **kwargs)

Bases: PipelineStep

Transpose data.

__init__(keys: Dict[str, Any] | Sequence[str] | str, **kwargs)

Create a transposer.

Parameters:

• keys (Union[Dict[str,Any], Sequence[str], str]) – A mapping from the data key to the key of the data to transpose. If a string is given, it is used as the key for the data to transpose.

• kwargs

Methods

__init__(keys, **kwargs)	Create a transposer.
parse_dict_keys(key[, name, ...])	Parse a key or a sequence of keys.

parse_dict_keys(key: str | Sequence[str] | Mapping[str, str], name='key', require_ordered_dict=False) → OrderedDict[str, str]

Parse a key or a sequence of keys.

Parameters:

• key (Union[str, Sequence[str], Mapping[str,str]]) – A key or a sequence of keys.

• name (str) – The name of the key. Used for error messages.

• require_ordered_dict (bool) – If True, the key must be an OrderedDict. If False, the key can also be an ordinary dict.

Returns:

A mapping of input keys to output keys.

Return type:

OrderedDict[str, str]

Raises:

TypeError – If the key is not a string, a sequence of strings or a mapping of strings. If the key is a mapping but require_ordered_dict is True and the mapping is not an OrderedDict.