octave_packages/geometry-1.5.0/geom2d/squareGrid.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} = } squaregrid (@var{bounds}, @var{origin}, @var{size})
  36 %% Generate equally spaces points in plane.
  37 %%
  38 %%   usage
  39 %%   PTS = squareGrid(BOUNDS, ORIGIN, SIZE)
  40 %%   generate points, lying in the window defined by BOUNDS (=[xmin ymin
  41 %%   xmax ymax]), starting from origin with a constant step equal to size.
  42 %%
  43 %%   Example
  44 %%   PTS = squareGrid([0 0 10 10], [3 3], [4 2])
  45 %%   will return points :
  46 %%   [3 1;7 1;3 3;7 3;3 5;7 5;3 7;7 7;3 9;7 9];
  47 %%
  48 %%   TODO: add possibility to use rotated grid
  49 %%
  50 %% @end deftypefn
  51
  52 function varargout = squareGrid(bounds, origin, size)
  53
  54   % find all x coordinate
  55   x1 = bounds(1) + mod(origin(1)-bounds(1), size(1));
  56   x2 = bounds(3) - mod(bounds(3)-origin(1), size(1));
  57   lx = (x1:size(1):x2)';
  58
  59   % find all y coordinate
  60   y1 = bounds(2) + mod(origin(2)-bounds(2), size(2));
  61   y2 = bounds(4) - mod(bounds(4)-origin(2), size(2));
  62   ly = (y1:size(2):y2)';
  63
  64   % number of points in each coord, and total number of points
  65   ny = length(ly);
  66   nx = length(lx);
  67   np = nx*ny;
  68
  69   % create points
  70   pts = zeros(np, 2);
  71   for i=1:ny
  72       pts( (1:nx)'+(i-1)*nx, 1) = lx;
  73       pts( (1:nx)'+(i-1)*nx, 2) = ly(i);
  74   end
  75
  76   % process output
  77   if nargout>0
  78       varargout{1} = pts;
  79   end
  80
  81 endfunction
  82