mne.transforms.Transform

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

A transform.

Parameters
frostr | int

The starting coordinate frame.

tostr | int

The ending coordinate frame.

transarray_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__(self, key, /)

True if the dictionary has the specified key, else False.

__getitem__()

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

__iter__(self, /)

Implement iter(self).

__len__(self, /)

Return len(self).

clear()

copy(self)

Make a copy of the transform.

fromkeys(iterable[, value])

Create a new dictionary with keys from iterable and values set to value.

get(self, key[, default])

Return the value for key if key is in the dictionary, else default.

items()

keys()

pop()

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

popitem()

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

save(self, fname)

Save the transform as -trans.fif file.

setdefault(self, key[, default])

Insert key with a value of default if key is not in the dictionary.

update()

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then 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()

__contains__(self, key, /)

True if the dictionary has the specified key, else False.

__getitem__()

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

__iter__(self, /)

Implement iter(self).

__len__(self, /)

Return len(self).

clear()
copy(self)[source]

Make a copy of the transform.

property from_str

The “from” frame as a string.

fromkeys(iterable, value=None, /)

Create a new dictionary with keys from iterable and values set to value.

get(self, key, default=None, /)

Return the value for key if key is in the dictionary, else default.

items()
keys()
pop()

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

popitem()

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

save(self, fname)[source]

Save the transform as -trans.fif file.

Parameters
fnamestr

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

setdefault(self, key, default=None, /)

Insert key with a value of default if key is not in the dictionary.

Return the value for key if key is in the dictionary, else default.

property to_str

The “to” frame as a string.

update()

If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present and lacks a .keys() method, then 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()