]> Creatis software - CreaPhase.git/blob - octave_packages/geometry-1.5.0/geom2d/transformPoint.m
Add a useful package (from Source forge) for octave
[CreaPhase.git] / octave_packages / geometry-1.5.0 / geom2d / transformPoint.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{pt2} = } transformPoint (@var{pt1}, @var{Trans})
36 %% @deftypefnx {Function File} {[@var{px2} @var{py2}]= } transformPoint (@var{px1}, @var{py1}, @var{Trans})
37 %% Transform a point with an affine transform.
38 %%
39 %%   where @var{pt1} has the form [xp yp], and @var{Trans} is a [2x2], [2x3] or [3x3]
40 %%   matrix, returns the point transformed with affine transform @var{Trans}.
41 %%
42 %%   Format of @var{Trans} can be one of :
43 %%   [a b]   ,   [a b c] , or [a b c]
44 %%   [d e]       [d e f]      [d e f]
45 %%                            [0 0 1]
46 %%
47 %%   Also works when @var{pt1} is a [Nx2] array of double. In this case, @var{pt2} has
48 %%   the same size as @var{pt1}.
49 %%
50 %%   Also works when @var{px1} and @var{py1} are arrays the same size. The function
51 %%   transform each couple of (@var{px1}, @var{py1}), and return the result in 
52 %%   (@var{px2}, @var{py2}), which is the same size as (@var{px1} @var{py1}).
53 %%
54 %%   @seealso{points2d, transforms2d, createTranslation, createRotation}
55 %% @end deftypefn
56
57 function varargout = transformPoint(varargin)
58
59   if length(varargin)==2
60       var = varargin{1};
61       px = var(:,1);
62       py = var(:,2);
63       trans = varargin{2};
64   elseif length(varargin)==3
65       px = varargin{1};
66       py = varargin{2};
67       trans = varargin{3};
68   else
69       error('wrong number of arguments in "transformPoint"');
70   end
71
72
73   % compute position
74   px2 = px*trans(1,1) + py*trans(1,2);
75   py2 = px*trans(2,1) + py*trans(2,2);
76
77   % add translation vector, if exist
78   if size(trans, 2)>2
79       px2 = px2 + trans(1,3);
80       py2 = py2 + trans(2,3);
81   end
82
83
84   if nargout==0 || nargout==1
85       varargout{1} = [px2 py2];
86   elseif nargout==2
87       varargout{1} = px2;
88       varargout{2} = py2;
89   end
90
91 endfunction
92