darsia.interpret_indexing#

interpret_indexing(axis, indexing)[source]#

Interpret an axis and the indexing convention of an image.

Parameters:

axisstr: Target axis, e.g. "x".
indexingstr: Indexing of the image, e.g. "ijk".

Returns:

componentint: Component corresponding to the axis (for "x", "y", "z", "i", "j", "k").
revertbool: Whether the axis must be reverted when converting (for "xyz", "ijk" and their reduced 1d/2d cases).

Raises:

ValueError: If an unsupported combination is given.