Add a useful package (from Source forge) for octave

[CreaPhase.git] / octave_packages / geometry-1.5.0 / geom2d / createRay.m

diff --git a/octave_packages/geometry-1.5.0/geom2d/createRay.m b/octave_packages/geometry-1.5.0/geom2d/createRay.m
new file mode 100644 (file)
index 0000000..ec4f918
--- /dev/null
+++ b/octave_packages/geometry-1.5.0/geom2d/createRay.m
@@ -0,0 +1,104 @@
+%% Copyright (c) 2011, INRA
+%% 2007-2011, David Legland <david.legland@grignon.inra.fr>
+%% 2011 Adapted to Octave by Juan Pablo Carbajal <carbajal@ifi.uzh.ch>
+%%
+%% 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{ray} = } createRay (@var{point}, @var{angle})
+%% @deftypefnx {Function File} { @var{ray} = } createRay (@var{x0},@var{y0}, @var{angle})
+%% @deftypefnx {Function File} { @var{ray} = } createRay (@var{p1}, @var{p2})
+%%  Create a ray (half-line), from various inputs.
+%%
+%%  A Ray is represented in a parametric form: [x0 y0 dx dy].
+%%   x = x0 + t*dx
+%%   y = y0 + t*dy;
+%%   for all t>0.
+%%
+%%   @var{point} is a Nx2 array giving the starting point of the ray, and @var{angle} is the
+%%   orientation of the ray respect to the positive x-axis. The ray origin can be specified with 2 input arguments @var{x0},@var{y0}.
+%%
+%%   If two points @var{p1}, @var{p2} are given, creates a ray starting from point @var{p1} and going in the direction of point
+%%   @var{p2}.
+%%
+%%   Example
+%% @example
+%%   origin  = [3 4];
+%%   theta   = pi/6;
+%%   ray = createRay(origin, theta);
+%%   axis([0 10 0 10]);
+%%   drawRay(ray);
+%% @end example
+%%
+%% @seealso{rays2d, createLine, points2d}
+%% @end deftypefn
+
+function ray = createRay(varargin)
+
+  if length(varargin)==2
+      p0 = varargin{1};
+      arg = varargin{2};
+      if size(arg, 2)==1
+          % second input is the ray angle
+          ray = [p0 cos(arg) sin(arg)];
+      else
+          % second input is another point
+          ray = [p0 arg-p0];
+      end
+      
+  elseif length(varargin)==3   
+      x = varargin{1};
+      y = varargin{2};
+      theta = varargin{3};
+      ray = [x y cos(theta) sin(theta)];   
+
+  else
+      error("Wrong number of arguments in 'createRay'. ");
+  end
+
+endfunction
+
+%!shared p1,p2,ray
+%!  p1 = [1 1];
+%!  p2 = [2 3];
+%!  ray = createRay(p1, p2);
+
+%!assert (p1, ray(1,1:2), 1e-6);
+%!assert (p2-p1, ray(1,3:4), 1e-6);
+
+%!shared p1,p2,ray
+%!  p1 = [1 1;1 1];
+%!  p2 = [2 3;2 4];
+%!  ray = createRay(p1, p2);
+
+%!assert (2, size(ray, 1));
+%!assert (p1, ray(:,1:2), 1e-6);
+%!assert (p2-p1, ray(:,3:4), 1e-6);
+