CoordinateSystem

class sofia_redux.scan.coordinate_systems.coordinate_system.CoordinateSystem(name='Default Coordinate System', dimensions=None)

Bases: ABC

Initialize a coordinate system.

A standard coordinate system is simply a collection of axes used to define that system. Each axis contains a name and label. By default, axes will be named x, y, z, y, v, w, yx, yy, yz, yu, yv, yw, zx, …. with increasing dimension.

Parameters:

namestr, optional

The name of the coordinate system.

dimensionsint, optional

The number of axes in the coordinate system.

Attributes Summary

default_axes_labels
size	Return the number of axes in the coordinate system.

Methods Summary

add_axis(axis)	Add an axis to the coordinate system.
dimension_name(dimension)	Return a default axis dimension name for a dimension number.

Attributes Documentation

default_axes_labels = ['x', 'y', 'z', 'u', 'v', 'w']

size

Return the number of axes in the coordinate system.

Returns:

n_axisint

Methods Documentation

add_axis(axis)

Add an axis to the coordinate system.

Parameters:

axisCoordinateAxis

Returns:

None

dimension_name(dimension)

Return a default axis dimension name for a dimension number.

Parameters:

dimensionint

Returns:

str