ThreeDViewer.image.axial_align#

axial_align(orientation_field, index)#

Aligns the components of an orientation field such that a singular direction (index) is always positive.

Parameters:
orientation_fieldnp.ndarray

The orientation field to align.

index{‘x’, ‘y’, ‘z’}

The axis to align towards, {‘x’, ‘y’ or ‘z’}.

Returns:
np.ndarray

Aligned components of orientation field along specified axis.