mne.transforms.Transform

class mne.transforms.Transform(fro, to, trans=None)[source]

A transform.

Parameters:

fro : str | int

The starting coordinate frame.

to : str | int

The ending coordinate frame.

trans : array-like, shape (4, 4) | None

The transformation matrix. If None, an identity matrix will be used.

Attributes

from_str The “from” frame as a string.
to_str The “to” frame as a string.

Methods

__contains__((k) -> True if D has a key k, …)
__getitem__ x.__getitem__(y) <==> x[y]
__iter__() <==> iter(x)
__len__() <==> len(x)
clear(() -> None.  Remove all items from D.)
copy() Make a copy of the transform.
fromkeys(…) v defaults to None.
get((k[,d]) -> D[k] if k in D, …)
has_key((k) -> True if D has a key k, else False)
items(() -> list of D’s (key, value) pairs, …)
iteritems(() -> an iterator over the (key, …)
iterkeys(() -> an iterator over the keys of D)
itervalues(…)
keys(() -> list of D’s keys)
pop((k[,d]) -> v, …) If key is not found, d is returned if given, otherwise KeyError is raised
popitem(() -> (k, v), …) 2-tuple; but raise KeyError if D is empty.
save(fname) Save the transform as -trans.fif file.
setdefault((k[,d]) -> D.get(k,d), …)
update(([E, …) If E present and has a .keys() method, does: for k in E: D[k] = E[k]
values(() -> list of D’s values)
viewitems(…)
viewkeys(…)
viewvalues(…)
__contains__(k) → True if D has a key k, else False
__getitem__()

x.__getitem__(y) <==> x[y]

__iter__() <==> iter(x)
__len__() <==> len(x)
clear() → None. Remove all items from D.
copy()[source]

Make a copy of the transform.

from_str

The “from” frame as a string.

fromkeys(S[, v]) → New dict with keys from S and values equal to v.

v defaults to None.

get(k[, d]) → D[k] if k in D, else d. d defaults to None.
has_key(k) → True if D has a key k, else False
items() → list of D’s (key, value) pairs, as 2-tuples
iteritems() → an iterator over the (key, value) items of D
iterkeys() → an iterator over the keys of D
itervalues() → an iterator over the values of D
keys() → list of D’s keys
pop(k[, d]) → v, remove specified key and return the corresponding value.

If key is not found, d is returned if given, otherwise KeyError is raised

popitem() → (k, v), remove and return some (key, value) pair as a

2-tuple; but raise KeyError if D is empty.

save(fname)[source]

Save the transform as -trans.fif file.

Parameters:

fname : str

The name of the file, which should end in ‘-trans.fif’.

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D
to_str

The “to” frame as a string.

update([E, ]**F) → None. Update D from dict/iterable E and F.

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k in F: D[k] = F[k]

values() → list of D’s values
viewitems() → a set-like object providing a view on D’s items
viewkeys() → a set-like object providing a view on D’s keys
viewvalues() → an object providing a view on D’s values