X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?p=CreaPhase.git;a=blobdiff_plain;f=octave_packages%2Fgeometry-1.5.0%2Fgeom2d%2FnormalizeAngle.m;fp=octave_packages%2Fgeometry-1.5.0%2Fgeom2d%2FnormalizeAngle.m;h=37d89cba99077d252303619b60178f515741d403;hp=0000000000000000000000000000000000000000;hb=f5f7a74bd8a4900f0b797da6783be80e11a68d86;hpb=1705066eceaaea976f010f669ce8e972f3734b05 diff --git a/octave_packages/geometry-1.5.0/geom2d/normalizeAngle.m b/octave_packages/geometry-1.5.0/geom2d/normalizeAngle.m new file mode 100644 index 0000000..37d89cb --- /dev/null +++ b/octave_packages/geometry-1.5.0/geom2d/normalizeAngle.m @@ -0,0 +1,96 @@ +%% Copyright (c) 2011, INRA +%% 2008-2011, David Legland +%% 2011 Adapted to Octave by Juan Pablo Carbajal +%% +%% All rights reserved. +%% (simplified BSD License) +%% +%% Redistribution and use in source and binary forms, with or without +%% modification, are permitted provided that the following conditions are met: +%% +%% 1. Redistributions of source code must retain the above copyright notice, this +%% list of conditions and the following disclaimer. +%% +%% 2. Redistributions in binary form must reproduce the above copyright notice, +%% this list of conditions and the following disclaimer in the documentation +%% and/or other materials provided with the distribution. +%% +%% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" +%% AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +%% IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +%% ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE +%% LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +%% CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +%% SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS +%% INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +%% CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +%% ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE +%% POSSIBILITY OF SUCH DAMAGE. +%% +%% The views and conclusions contained in the software and documentation are +%% those of the authors and should not be interpreted as representing official +%% policies, either expressed or implied, of copyright holder. + +%% -*- texinfo -*- +%% @deftypefn {Function File} {@var{alpha2} =} normalizeAngle (@var{alpha}) +%% @deftypefnx {Function File} {@var{alpha2} =} normalizeAngle (@var{alpha}, @var{center}) +%% Normalize an angle value within a 2*PI interval +%% +%% ALPHA2 = normalizeAngle(ALPHA); +%% ALPHA2 is the same as ALPHA modulo 2*PI and is positive. +%% +%% ALPHA2 = normalizeAngle(ALPHA, CENTER); +%% Specifies the center of the angle interval. +%% If CENTER==0, the interval is [-pi ; +pi] +%% If CENTER==PI, the interval is [0 ; 2*pi] (default). +%% +%% Example: +%% % normalization between 0 and 2*pi (default) +%% normalizeAngle(5*pi) +%% ans = +%% 3.1416 +%% +%% % normalization between -pi and +pi +%% normalizeAngle(7*pi/2, 0) +%% ans = +%% -1.5708 +%% +%% References +%% Follows the same convention as apache commons library, see: +%% http://commons.apache.org/math/api-2.2/org/apache/commons/math/util/MathUtils.html%% +%% +%% @seealso{vectorAngle, lineAngle} +%% @end deftypefn + +function alpha = normalizeAngle(alpha, varargin) + + center = pi; + if ~isempty(varargin) + center = varargin{1}; + end + + alpha = mod(alpha-center+pi, 2*pi) + center-pi; + +endfunction + +%!assert (pi/2, normalizeAngle (pi/2), 1e-6); +%!assert (pi, normalizeAngle (pi), 1e-6); +%!assert (3*pi/2, normalizeAngle (3*pi/2), 1e-6); +%!assert (pi/2, normalizeAngle (pi/2, pi), 1e-6); +%!assert (pi, normalizeAngle (pi, pi), 1e-6); +%!assert (3*pi/2, normalizeAngle (3*pi/2, pi), 1e-6); + +%!test +%! theta = linspace(0, 2*pi-.1, 100); +%! assert(theta, normalizeAngle (theta), 1e-6); + +%!assert (0, normalizeAngle (0, 0), 1e-6); +%!assert (pi/2, normalizeAngle (pi/2, 0), 1e-6); +%!assert (-pi, normalizeAngle (-pi, 0), 1e-6); +%!assert (-pi/2, normalizeAngle (7*pi/2, 0), 1e-6); + +%!test +%! theta = linspace(-pi+.1, pi-.1, 100); +%! assert(theta, normalizeAngle (theta, 0), 1e-6); + +