octave_packages/geometry-1.5.0/geom2d/isPointInEllipse.m

   1 %% Copyright (c) 2011, INRA
   2 %% 2011, David Legland <david.legland@grignon.inra.fr>
   3 %% 2011 Adapted to Octave by Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
   4 %%
   5 %% All rights reserved.
   6 %% (simplified BSD License)
   7 %%
   8 %% Redistribution and use in source and binary forms, with or without
   9 %% modification, are permitted provided that the following conditions are met:
  10 %%
  11 %% 1. Redistributions of source code must retain the above copyright notice, this
  12 %%    list of conditions and the following disclaimer.
  13 %%
  14 %% 2. Redistributions in binary form must reproduce the above copyright notice,
  15 %%    this list of conditions and the following disclaimer in the documentation
  16 %%    and/or other materials provided with the distribution.
  17 %%
  18 %% THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  19 %% AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  20 %% IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  21 %% ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
  22 %% LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 %% CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 %% SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 %% INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 %% CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 %% ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 %% POSSIBILITY OF SUCH DAMAGE.
  29 %%
  30 %% The views and conclusions contained in the software and documentation are
  31 %% those of the authors and should not be interpreted as representing official
  32 %% policies, either expressed or implied, of copyright holder.
  33
  34 %% -*- texinfo -*-
  35 %% @deftypefn {Function File} {@var{b} = } isPointInellipse (@var{point}, @var{ellipse})
  36 %% Check if a point is located inside a given ellipse
  37 %%
  38 %%   B = isPointInEllipse(POINT, ELLIPSE)
  39 %%   Returns true if point is located inside the given ellipse.
  40 %%
  41 %%   B = isPointInEllipse(POINT, ELLIPSE, TOL)
  42 %%   Specifies the tolerance value
  43 %%
  44 %%   Example:
  45 %%   isPointInEllipse([1 0], [0 0 2 1 0])
  46 %%   ans =
  47 %%       1
  48 %%   isPointInEllipse([0 0], [0 0 2 1 0])
  49 %%   ans =
  50 %%       1
  51 %%   isPointInEllipse([1 1], [0 0 2 1 0])
  52 %%   ans =
  53 %%       0
  54 %%   isPointInEllipse([1 1], [0 0 2 1 30])
  55 %%   ans =
  56 %%       1
  57 %%
  58 %%   @seealso{ellipses2d, isPointInCircle}
  59 %% @end deftypefn
  60
  61 function b = isPointInEllipse(point, ellipse, varargin)
  62
  63   % extract computation tolerance
  64   tol = 1e-14;
  65   if ~isempty(varargin)
  66       tol = varargin{1};
  67   end
  68
  69   % compute ellipse to unit circle transform
  70   rot = createRotation(-deg2rad(ellipse(5)));
  71   sca = createScaling(1./ellipse(3:4));
  72   trans = sca * rot;
  73
  74   % transform points to unit circle basis
  75   pTrans = bsxfun(@minus, point, ellipse(:,1:2));
  76   pTrans = transformPoint(pTrans, trans);
  77
  78   % test if distance to origin smaller than 1
  79   b = sqrt(sum(power(pTrans, 2), 2)) - 1 <= tol;
  80
  81 endfunction