annotate src/fft2.cc @ 2878:55cca18e943a

[project @ 1997-04-24 09:19:43 by jwe]
author jwe
date Thu, 24 Apr 1997 09:25:02 +0000
parents 8b262e771614
children 8aa189b811d0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
676
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
1 /*
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
2
2847
8b262e771614 [project @ 1997-03-27 16:18:26 by jwe]
jwe
parents: 2465
diff changeset
3 Copyright (C) 1996, 1997 John W. Eaton
676
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
4
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
5 This file is part of Octave.
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
6
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
7 Octave is free software; you can redistribute it and/or modify it
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
8 under the terms of the GNU General Public License as published by the
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
9 Free Software Foundation; either version 2, or (at your option) any
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
10 later version.
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
11
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
12 Octave is distributed in the hope that it will be useful, but WITHOUT
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
15 for more details.
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
16
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
17 You should have received a copy of the GNU General Public License
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
18 along with Octave; see the file COPYING. If not, write to the Free
1315
611d403c7f3d [project @ 1995-06-25 19:56:32 by jwe]
jwe
parents: 1192
diff changeset
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
676
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
20
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
21 */
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
22
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
23 #ifdef HAVE_CONFIG_H
1192
b6360f2d4fa6 [project @ 1995-03-30 21:38:35 by jwe]
jwe
parents: 1086
diff changeset
24 #include <config.h>
676
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
25 #endif
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
26
1352
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1315
diff changeset
27 #include "defun-dld.h"
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1315
diff changeset
28 #include "error.h"
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1315
diff changeset
29 #include "gripes.h"
19c10b8657d5 [project @ 1995-09-05 08:11:57 by jwe]
jwe
parents: 1315
diff changeset
30 #include "help.h"
1740
fe9d3b2ded26 [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents: 1684
diff changeset
31 #include "mappers.h"
fe9d3b2ded26 [project @ 1996-01-12 11:03:26 by jwe]
jwe
parents: 1684
diff changeset
32 #include "oct-obj.h"
676
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
33 #include "utils.h"
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
34
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
35 // This function should be merged with Fifft2.
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
36
2465
7ee42ff6536a [project @ 1996-11-03 08:54:14 by jwe]
jwe
parents: 2200
diff changeset
37 DEFUN_DLD (fft2, args, ,
676
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
38 "fft2 (X [, N] [, M])\n\
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
39 \n\
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
40 two dimensional fast fourier transform of a vector")
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
41 {
2086
bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe]
jwe
parents: 1996
diff changeset
42 octave_value_list retval;
676
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
43
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
44 int nargin = args.length ();
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
45
712
36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe]
jwe
parents: 701
diff changeset
46 if (nargin < 1 || nargin > 3)
676
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
47 {
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
48 print_usage ("fft2");
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
49 return retval;
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
50 }
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
51
2086
bfb775fb6fe8 [project @ 1996-04-25 05:55:19 by jwe]
jwe
parents: 1996
diff changeset
52 octave_value arg = args(0);
676
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
53
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
54 int n_rows = arg.rows ();
712
36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe]
jwe
parents: 701
diff changeset
55 if (nargin > 1)
1086
75fc98220389 [project @ 1995-01-31 04:17:15 by jwe]
jwe
parents: 1009
diff changeset
56 {
75fc98220389 [project @ 1995-01-31 04:17:15 by jwe]
jwe
parents: 1009
diff changeset
57 double dval = args(1).double_value ();
75fc98220389 [project @ 1995-01-31 04:17:15 by jwe]
jwe
parents: 1009
diff changeset
58 if (xisnan (dval))
75fc98220389 [project @ 1995-01-31 04:17:15 by jwe]
jwe
parents: 1009
diff changeset
59 error ("fft2: NaN is invalid as N_ROWS");
75fc98220389 [project @ 1995-01-31 04:17:15 by jwe]
jwe
parents: 1009
diff changeset
60 else
75fc98220389 [project @ 1995-01-31 04:17:15 by jwe]
jwe
parents: 1009
diff changeset
61 n_rows = NINT (dval);
75fc98220389 [project @ 1995-01-31 04:17:15 by jwe]
jwe
parents: 1009
diff changeset
62 }
676
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
63
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
64 if (error_state)
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
65 return retval;
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
66
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
67 int n_cols = arg.columns ();
712
36ba0576bd1b [project @ 1994-09-19 14:18:15 by jwe]
jwe
parents: 701
diff changeset
68 if (nargin > 2)
1086
75fc98220389 [project @ 1995-01-31 04:17:15 by jwe]
jwe
parents: 1009
diff changeset
69 {
75fc98220389 [project @ 1995-01-31 04:17:15 by jwe]
jwe
parents: 1009
diff changeset
70 double dval = args(2).double_value ();
75fc98220389 [project @ 1995-01-31 04:17:15 by jwe]
jwe
parents: 1009
diff changeset
71 if (xisnan (dval))
75fc98220389 [project @ 1995-01-31 04:17:15 by jwe]
jwe
parents: 1009
diff changeset
72 error ("fft2: NaN is invalid as N_COLS");
75fc98220389 [project @ 1995-01-31 04:17:15 by jwe]
jwe
parents: 1009
diff changeset
73 else
75fc98220389 [project @ 1995-01-31 04:17:15 by jwe]
jwe
parents: 1009
diff changeset
74 n_cols = NINT (dval);
75fc98220389 [project @ 1995-01-31 04:17:15 by jwe]
jwe
parents: 1009
diff changeset
75 }
676
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
76
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
77 if (error_state)
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
78 return retval;
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
79
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
80 if (n_rows < 0 || n_cols < 0)
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
81 {
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
82 error ("fft2: number of points must be greater than zero");
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
83 return retval;
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
84 }
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
85
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
86 int arg_is_empty = empty_arg ("fft2", arg.rows (), arg.columns ());
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
87
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
88 if (arg_is_empty < 0)
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
89 return retval;
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
90 else if (arg_is_empty || n_rows == 0 || n_cols == 0)
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
91 return Matrix ();
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
92
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
93 if (arg.is_real_type ())
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
94 {
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
95 Matrix m = arg.matrix_value ();
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
96
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
97 if (! error_state)
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
98 {
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
99 m.resize (n_rows, n_cols, 0.0);
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
100 retval = m.fourier2d ();
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
101 }
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
102 }
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
103 else if (arg.is_complex_type ())
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
104 {
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
105 ComplexMatrix m = arg.complex_matrix_value ();
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
106
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
107 if (! error_state)
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
108 {
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
109 m.resize (n_rows, n_cols, 0.0);
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
110 retval = m.fourier2d ();
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
111 }
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
112 }
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
113 else
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
114 {
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
115 gripe_wrong_type_arg ("fft2", arg);
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
116 }
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
117
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
118 return retval;
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
119 }
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
120
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
121 /*
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
122 ;;; Local Variables: ***
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
123 ;;; mode: C++ ***
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
124 ;;; End: ***
d31fde825c53 [project @ 1994-09-08 04:42:58 by jwe]
jwe
parents:
diff changeset
125 */