axis2num.m

Go to the documentation of this file.

% =========================================================================== %
%> @brief convert an axis to a number
%>
%> @param axis axis to convert (x, y, z)
%>
%> @retval num number (1, 2, 3)
%>
%> @copyright see the file @ref LICENSE in the root directory of the repository
% =========================================================================== %
function num = axis2num(axis)
 
arguments
    axis (1,1) char
end
 
switch axis
    case {"x", 'x', "X", 'X'}
        num = 1;
    case {"y", 'y', "Y", 'Y'}
        num = 2;
    case {"z", 'z', "Z", 'Z'}
        num = 3;
    otherwise
        error("The axis %s does not correspond to a number", axis)
end
 
end