]> Creatis software - CreaPhase.git/blob - octave_packages/geometry-1.5.0/geom2d/triangleGrid.m
Add a useful package (from Source forge) for octave
[CreaPhase.git] / octave_packages / geometry-1.5.0 / geom2d / triangleGrid.m
1 %% Copyright (c) 2011, INRA
2 %% 2005-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{pts} = } triangleGrid (@var{bounds}, @var{origin}, @var{size})
36 %% Generate triangular grid of points in the plane.
37 %%
38 %%   usage
39 %%   PTS = triangleGrid(BOUNDS, ORIGIN, SIZE)
40 %%   generate points, lying in the window defined by BOUNDS, given in form
41 %%   [xmin ymin xmax ymax], starting from origin with a constant step equal
42 %%   to size. 
43 %%   SIZE is constant and is equals to the length of the sides of each
44 %%   triangles. 
45 %%
46 %%   TODO: add possibility to use rotated grid
47 %%
48 %% @end deftypefn
49
50 function varargout = triangleGrid(bounds, origin, size, varargin)
51
52   dx = size(1);
53   dy = size(1)*sqrt(3);
54
55   % consider two square grids with different centers
56   pts1 = squareGrid(bounds, origin, [dx dy], varargin{:});
57   pts2 = squareGrid(bounds, origin + [dx dy]/2, [dx dy], varargin{:});
58
59   % gather points
60   pts = [pts1;pts2];
61
62
63   % process output
64   if nargout>0
65       varargout{1} = pts;
66   end
67
68 endfunction
69