coordax.coords.insert_axes¶

coordax.coords.insert_axes(coordinate: Coordinate, indices_to_axes: dict[int, Coordinate]) → Coordinate[source]¶

Returns coordinate with extra axes inserted at specified positions.

Parameters:

coordinate – The coordinate system to modify.
indices_to_axes – A mapping from insertion index to the new coordinate to insert. Indices are relative to the output coordinate system.

Returns:

A new coordinate object with the axes inserted.

Examples

>>> import coordax as cx
>>> x = cx.SizedAxis('x', 2)
>>> z = cx.SizedAxis('z', 4)
>>> cx.coords.insert_axes(x, {1: z})
CartesianProduct(coordinates=(coordax.SizedAxis('x', size=2), coordax.SizedAxis('z', size=4)))