Add a useful package (from Source forge) for octave

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

diff --git a/octave_packages/geometry-1.5.0/geom2d/edgeAngle.m b/octave_packages/geometry-1.5.0/geom2d/edgeAngle.m
new file mode 100644 (file)
index 0000000..a217b72
--- /dev/null
+++ b/octave_packages/geometry-1.5.0/geom2d/edgeAngle.m
@@ -0,0 +1,61 @@
+%% Copyright (c) 2011, INRA
+%% 2003-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{theta} =} edgeAngle(@var{edge})
+%% Return angle of edge
+%%
+%%   A = edgeAngle(EDGE)
+%%   Returns the angle between horizontal, right-axis and the edge EDGE.
+%%   Angle is given in radians, between 0 and 2*pi, in counter-clockwise
+%%   direction. 
+%%   Notation for edge is [x1 y1 x2 y2] (coordinates of starting and ending
+%%   points).
+%%
+%%   Example
+%%   p1 = [10 20];
+%%   p2 = [30 40];
+%%   rad2deg(edgeAngle([p1 p2]))
+%%   ans = 
+%%       45
+%% 
+%% @seealso{edges2d, angles2d, edgeAngle, lineAngle, edgeLength}
+%% @end deftypefn
+
+function theta = edgeAngle(edge)
+
+  line = createLine(edge(:,1:2), edge(:,3:4));
+  theta = lineAngle(line);
+
+endfunction
+