octave_packages/geometry-1.5.0/geom2d/randomPointInBox.m

   1 %% Copyright (c) 2011, INRA
   2 %% 2007-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{points} =} randomPointInBox (@var{box})
  36 %% @deftypefnx {Function File} {@var{points} =} randomPointInBox (@var{box}, @var{n})
  37 %% Generate random points within a box.
  38 %%
  39 %%   Generate a random point within the box @var{box}. The result is a 1-by-2 row
  40 %% vector. If @var{n} is given, generates @var{n} points. The result is a
  41 %% @var{n}-by-2 array.
  42 %%
  43 %%   Example
  44 %%
  45 %% @example
  46 %%     % draw points within a box
  47 %%     box = [10 80 20 60];
  48 %%     pts =  randomPointInBox(box, 500);
  49 %%     figure(1); clf; hold on;
  50 %%     drawBox(box);
  51 %%     drawPoint(pts, '.');
  52 %%     axis('equal');
  53 %%     axis([0 100 0 100]);
  54 %% @end example
  55 %%
  56 %% @seealso{edges2d, boxes2d, clipLine}
  57 %% @end deftypefn
  58
  59 function points = randomPointInBox(box, N=1, varargin)
  60
  61   % extract box bounds
  62   xmin = box(1);
  63   xmax = box(2);
  64   ymin = box(3);
  65   ymax = box(4);
  66
  67   % compute size of box
  68   dx = xmax - xmin;
  69   dy = ymax - ymin;
  70
  71   % compute point coordinates
  72   points = [rand(N, 1)*dx+xmin , rand(N, 1)*dy+ymin];
  73
  74 endfunction
  75
  76 %!demo
  77 %!     % draw points within a box
  78 %!     bb = [10 80 20 60];
  79 %!     pts =  randomPointInBox(bb, 500);
  80 %!     figure(1); clf; hold on;
  81 %!     drawBox(bb);
  82 %!     drawPoint(pts, '.');
  83 %!     axis equal
  84 %!     axis([0 100 0 100]);
  85