scipp.spatial.translations

scipp.spatial.translations(*, dims, unit=Unit(1), values)

Creates translation transformations from multiple 3-vectors.

Parameters:

• dims (Sequence[str]) – The dimensions of the created variable

• unit (Unit | str, default: Unit(1)) – The unit of the translation

• values (ndarray[tuple[Any, ...], dtype[TypeVar(_Float, bound= float64 | float32, covariant=True)]] | Sequence[Any]) – A list or NumPy array of 3-vectors

Returns:

Variable – An array variable of dtype translation3.

See also

scipp.spatial.translation

Create a single translation transformation.

Examples

Create multiple translations along different axes:

>>> import scipp as sc
>>> trans = sc.spatial.translations(
...     dims=['x'],
...     values=[[1, 0, 0], [0, 1, 0], [0, 0, 1]],
...     unit='m'
... )
>>> trans
<scipp.Variable> (x: 3)  translation3              [m]  [(1, 0, 0), (0, 1, 0), (0, 0, 1)]