dc004844a5e4157e68c251ec30842ea3f3f92bc1
[ctsim.git] / tools / pjrec.cpp
1 /*****************************************************************************
2 ** FILE IDENTIFICATION
3 **
4 **   Name:          pjrec.cpp
5 **   Purpose:       Reconstruct an image from projections
6 **   Programmer:    Kevin Rosenberg
7 **   Date Started:  Aug 1984
8 **
9 **  This is part of the CTSim program
10 **  Copyright (C) 1983-2000 Kevin Rosenberg
11 **
12 **  $Id: pjrec.cpp,v 1.1 2000/07/13 07:01:35 kevin Exp $
13 **
14 **  This program is free software; you can redistribute it and/or modify
15 **  it under the terms of the GNU General Public License (version 2) as
16 **  published by the Free Software Foundation.
17 **
18 **  This program is distributed in the hope that it will be useful,
19 **  but WITHOUT ANY WARRANTY; without even the implied warranty of
20 **  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21 **  GNU General Public License for more details.
22 **
23 **  You should have received a copy of the GNU General Public License
24 **  along with this program; if not, write to the Free Software
25 **  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
26 ******************************************************************************/
27
28 #include "ct.h"
29 #include "timer.h"
30
31
32 enum {O_INTERP, O_FILTER, O_FILTER_METHOD, O_ZEROPAD, O_FILTER_PARAM, O_BACKPROJ, O_PREINTERPOLATION_FACTOR, O_VERBOSE, O_TRACE, O_HELP, O_DEBUG, O_VERSION};
33
34 static struct option my_options[] =
35 {
36   {"interp", 1, 0, O_INTERP},
37   {"preinterpolation-factor", 1, 0, O_PREINTERPOLATION_FACTOR},
38   {"filter", 1, 0, O_FILTER},
39   {"filter-method", 1, 0, O_FILTER_METHOD},
40   {"zeropad", 1, 0, O_ZEROPAD},
41   {"filter-param", 1, 0, O_FILTER_PARAM},
42   {"backproj", 1, 0, O_BACKPROJ},
43   {"trace", 1, 0, O_TRACE},
44   {"debug", 0, 0, O_DEBUG},
45   {"verbose", 0, 0, O_VERBOSE},
46   {"help", 0, 0, O_HELP},
47   {"version", 0, 0, O_VERSION},
48   {0, 0, 0, 0}
49 };
50
51
52 void 
53 pjrec_usage (const char *program)
54 {
55   cout << "usage: " << fileBasename(program) << " raysum-file image-file nx-image ny-image [OPTIONS]" << endl;
56   cout << "Image reconstruction from raysum projections" << endl;
57   cout << endl;
58   cout << "  raysum-file     Input raysum file" << endl;
59   cout << "  image-file      Output image file in SDF2D format" << endl;
60   cout << "  nx-image        Number of columns in output image" << endl;
61   cout << "  ny-image        Number of rows in output image" << endl;
62   cout << "  --interp        Interpolation method during backprojection" << endl;
63   cout << "    nearest     Nearest neighbor interpolation" << endl;
64   cout << "    linear      Linear interpolation" << endl;
65 #if HAVE_BSPLINE_INTERP
66   cout << "    bspline     B-spline interpolation" << endl;
67 #endif
68   cout << "  --preinterpolate  Preinterpolation factor (default = 1)\n";
69   cout << "                    Used only with frequency-based filtering\n";
70   cout << "  --filter       Filter name" << endl;
71   cout << "    abs_bandlimit Abs * Bandlimiting (default)" << endl;
72   cout << "    abs_sinc      Abs * Sinc" << endl;
73   cout << "    abs_cos       Abs * Cosine" << endl;
74   cout << "    abs_hamming   Abs * Hamming" << endl;
75   cout << "    shepp         Shepp-Logan" << endl;
76   cout << "    bandlimit     Bandlimiting" << endl;
77   cout << "    sinc          Sinc" << endl;
78   cout << "    cos           Cosine" << endl;
79   cout << "    triangle      Triangle" << endl;
80   cout << "    hamming       Hamming" << endl;
81   cout << "  --filter-method  Filter method before backprojections\n";;
82   cout << "    convolution      Spatial filtering (default)\n";
83   cout << "    fourier          Frequency filtering with discete fourier\n";
84   cout << "    fourier_table    Frequency filtering with table lookup fourier\n";
85   cout << "    fft              Fast Fourier Transform\n";
86 #if HAVE_FFTW
87   cout << "    fftw             Fast Fourier Transform West library\n";
88   cout << "    rfftw            Fast Fourier Transform West (real-mode) library\n";
89 #endif
90   cout << "  --zeropad n   Set zeropad level (default = 0)\n";
91   cout << "                set n to number of powers to two to pad\n";
92   cout << "  --backproj    Backprojection Method" << endl;
93   cout << "    trig        Trigometric functions at every point" << endl;
94   cout << "    table       Trigometric functions with precalculated table" << endl;
95   cout << "    diff        Difference method" << endl;
96   cout << "    diff2       Optimized difference method (default)" << endl;
97   cout << "    idiff2      Optimized difference method with integer math" << endl;
98   cout << "    idiff3      Highly-optimized difference method with integer math" << endl;
99   cout << "  --filter-param Alpha level for Hamming filter" << endl;
100   cout << "  --trace        Set tracing to level" << endl;
101   cout << "     none      No tracing (default)" << endl;
102   cout << "     text      Text level tracing" << endl;
103   cout << "     phm       Trace phantom" << endl;
104   cout << "     rays      Trace allrays" << endl;
105   cout << "     plot      Trace plotting" << endl;
106   cout << "     clipping  Trace clipping" << endl;
107   cout << "  --verbose      Turn on verbose mode" << endl;
108   cout << "  --debug        Turn on debug mode" << endl;
109   cout << "  --version      Print version" << endl;
110   cout << "  --help         Print this help message" << endl;
111 }
112
113
114 #ifdef HAVE_MPI
115 static void ScatterProjectionsMPI (MPIWorld& mpiWorld, Projections& projGlobal, Projections& projLocal, const int debug);
116 static void ReduceImageMPI (MPIWorld& mpiWorld, ImageFile* imLocal, ImageFile* imGlobal);
117 #endif
118
119
120 int 
121 pjrec_main (int argc, char * argv[])
122 {
123   Projections projGlobal;
124   ImageFile* imGlobal = NULL;
125   char* filenameProj = NULL;
126   char* filenameImage = NULL;
127   string remark;
128   char *endptr;
129   int optVerbose = 0;
130   int optDebug = 0;
131   int optZeroPad = 0;
132   int optTrace = TRACE_NONE;
133   double optFilterParam = -1;
134   string optFilterName = SignalFilter::FILTER_ABS_BANDLIMIT_STR;
135   string optFilterMethodName = SignalFilter::FILTER_METHOD_CONVOLUTION_STR;
136   string optInterpName = Backprojector::INTERP_LINEAR_STR;
137   string optBackprojName = Backprojector::BPROJ_IDIFF2_STR;
138   //  string optFilterMethodName = SignalFilter::FILTER_METHOD_CONVOLUTION_STR;
139   int optPreinterpolationFactor = 1;
140   int nx, ny;
141 #ifdef HAVE_MPI
142   ImageFile* imLocal;
143   int mpi_nview, mpi_ndet;
144   double mpi_detinc, mpi_rotinc, mpi_phmlen;
145   MPIWorld mpiWorld (argc, argv);
146 #endif
147
148   Timer timerProgram;
149
150 #ifdef HAVE_MPI
151   if (mpiWorld.getRank() == 0) {
152 #endif
153     while (1) {
154       int c = getopt_long(argc, argv, "", my_options, NULL);
155       char *endptr = NULL;
156       
157       if (c == -1)
158         break;
159       
160       switch (c)
161         {
162         case O_INTERP:
163           optInterpName = optarg;
164           break;
165         case O_PREINTERPOLATION_FACTOR:
166           optPreinterpolationFactor = strtol(optarg, &endptr, 10);
167           if (endptr != optarg + strlen(optarg)) {
168             pjrec_usage(argv[0]);
169             return(1);
170           }
171           break;
172         case O_FILTER:
173           optFilterName = optarg;
174           break;
175         case O_FILTER_METHOD:
176           optFilterMethodName = optarg;
177           break;
178         case O_BACKPROJ:
179           optBackprojName = optarg;
180           break;
181         case O_FILTER_PARAM:
182           optFilterParam = strtod(optarg, &endptr);
183           if (endptr != optarg + strlen(optarg)) {
184             pjrec_usage(argv[0]);
185             return(1);
186           }
187           break;
188         case O_ZEROPAD:
189           optZeroPad = strtol(optarg, &endptr, 10);
190           if (endptr != optarg + strlen(optarg)) {
191             pjrec_usage(argv[0]);
192             return(1);
193           }
194           break;
195         case O_VERBOSE:
196           optVerbose = 1;
197           break;
198         case O_DEBUG:
199           optDebug = 1;
200           break;
201         case O_TRACE:
202           if ((optTrace = convertTraceNameToID(optarg)) == TRACE_INVALID) {
203             pjrec_usage(argv[0]);
204             return (1);
205           }
206           break;
207         case O_VERSION:
208 #ifdef VERSION
209           cout <<  "Version " <<  VERSION << endl;
210 #else
211           cout << "Unknown version number" << endl;
212 #endif
213           return (0);
214         case O_HELP:
215         case '?':
216           pjrec_usage(argv[0]);
217           return (0);
218         default:
219           pjrec_usage(argv[0]);
220           return (1);
221         }
222     }
223   
224     if (optind + 4 != argc) {
225       pjrec_usage(argv[0]);
226       return (1);
227     }
228
229     filenameProj = argv[optind];
230   
231     filenameImage = argv[optind + 1];
232   
233     nx = strtol(argv[optind + 2], &endptr, 10);
234     ny = strtol(argv[optind + 3], &endptr, 10);
235   
236     ostringstream filterDesc;
237     if (optFilterParam >= 0)
238       filterDesc << optFilterName << ": alpha=" << optFilterParam; 
239     else
240       filterDesc << optFilterName;
241
242     ostringstream label;
243     label << "pjrec: " << nx << "x" << ny << ", " << filterDesc.str() << ", " << optInterpName << ", preinterpolation=" << optPreinterpolationFactor << ", " << optBackprojName;
244     remark = label.str();
245   
246     if (optVerbose)
247       cout << "Remark: " << remark << endl;
248 #ifdef HAVE_MPI
249   }
250 #endif
251
252 #ifdef HAVE_MPI
253   if (mpiWorld.getRank() == 0) {
254     projGlobal.read (filenameProj);
255     if (optVerbose)
256       projGlobal.printScanInfo();
257
258     mpi_ndet = projGlobal.nDet();
259     mpi_nview = projGlobal.nView();
260     mpi_detinc = projGlobal.detInc();
261     mpi_phmlen = projGlobal.phmLen();
262     mpi_rotinc = projGlobal.rotInc();
263   }
264
265   TimerCollectiveMPI timerBcast (mpiWorld.getComm());
266   mpiWorld.BcastString (optBackprojName);
267   mpiWorld.BcastString (optFilterName);
268   mpiWorld.BcastString (optFilterMethodName);
269   mpiWorld.BcastString (optInterpName);
270   mpiWorld.getComm().Bcast (&optVerbose, 1, MPI::INT, 0);
271   mpiWorld.getComm().Bcast (&optDebug, 1, MPI::INT, 0);
272   mpiWorld.getComm().Bcast (&optTrace, 1, MPI::INT, 0);
273   mpiWorld.getComm().Bcast (&optFilterParam, 1, MPI::DOUBLE, 0);
274   mpiWorld.getComm().Bcast (&optZeroPad, 1, MPI::INT, 0);
275   mpiWorld.getComm().Bcast (&optPreinterpolationFactor, 1, MPI::INT, 0);
276   mpiWorld.getComm().Bcast (&mpi_ndet, 1, MPI::INT, 0);
277   mpiWorld.getComm().Bcast (&mpi_nview, 1, MPI::INT, 0);
278   mpiWorld.getComm().Bcast (&mpi_detinc, 1, MPI::DOUBLE, 0);
279   mpiWorld.getComm().Bcast (&mpi_phmlen, 1, MPI::DOUBLE, 0);
280   mpiWorld.getComm().Bcast (&mpi_rotinc, 1, MPI::DOUBLE, 0);
281   mpiWorld.getComm().Bcast (&nx, 1, MPI::INT, 0);
282   mpiWorld.getComm().Bcast (&ny, 1, MPI::INT, 0);
283   if (optVerbose)
284       timerBcast.timerEndAndReport ("Time to broadcast variables");
285
286   mpiWorld.setTotalWorkUnits (mpi_nview);
287
288   Projections projLocal (mpiWorld.getMyLocalWorkUnits(), mpi_ndet);
289   projLocal.setDetInc (mpi_detinc);
290   projLocal.setPhmLen (mpi_phmlen);
291   projLocal.setRotInc (mpi_rotinc);
292
293   TimerCollectiveMPI timerScatter (mpiWorld.getComm());
294   ScatterProjectionsMPI (mpiWorld, projGlobal, projLocal, optDebug);
295   if (optVerbose)
296       timerScatter.timerEndAndReport ("Time to scatter projections");
297
298   if (mpiWorld.getRank() == 0) {
299     imGlobal = new ImageFile (nx, ny);
300   }
301
302   imLocal = new ImageFile (nx, ny);
303 #else
304   projGlobal.read (filenameProj);
305   if (optVerbose)
306     projGlobal.printScanInfo();
307
308   imGlobal = new ImageFile (nx, ny);
309 #endif
310
311 #ifdef HAVE_MPI
312   TimerCollectiveMPI timerReconstruct (mpiWorld.getComm());
313   projLocal.reconstruct (*imLocal, optFilterName.c_str(), optFilterParam, optFilterMethodName.c_str(), optZeroPad, optInterpName.c_str(), optPreinterpolationFactor, optBackprojName.c_str(), optTrace);
314   if (optVerbose)
315       timerReconstruct.timerEndAndReport ("Time to reconstruct");
316
317   TimerCollectiveMPI timerReduce (mpiWorld.getComm());
318   ReduceImageMPI (mpiWorld, imLocal, imGlobal);
319   if (optVerbose)
320       timerReduce.timerEndAndReport ("Time to reduce image");
321 #else
322   projGlobal.reconstruct (*imGlobal, optFilterName.c_str(), optFilterParam, optFilterMethodName.c_str(), optZeroPad, optInterpName.c_str(), optPreinterpolationFactor, optBackprojName.c_str(), optTrace);
323 #endif
324
325 #ifdef HAVE_MPI
326   if (mpiWorld.getRank() == 0)
327 #endif
328     {
329       double calcTime = timerProgram.timerEnd();
330       imGlobal->labelAdd (projGlobal.getLabel());
331       imGlobal->labelAdd (Array2dFileLabel::L_HISTORY, remark.c_str(), calcTime);
332       imGlobal->fileWrite (filenameImage);
333       if (optVerbose)
334         cout << "Run time: " << calcTime << " seconds" << endl;
335     }
336 #ifdef HAVE_MPI
337   MPI::Finalize();
338 #endif
339
340   return (0);
341 }
342
343
344 //////////////////////////////////////////////////////////////////////////////////////
345 // MPI Support Routines
346 //
347 //////////////////////////////////////////////////////////////////////////////////////
348
349 #ifdef HAVE_MPI
350 static void ScatterProjectionsMPI (MPIWorld& mpiWorld, Projections& projGlobal, Projections& projLocal, const int optDebug)
351 {
352   if (mpiWorld.getRank() == 0) {
353     for (int iProc = 0; iProc < mpiWorld.getNumProcessors(); iProc++) {
354       for (int iw = mpiWorld.getStartWorkUnit(iProc); iw <= mpiWorld.getEndWorkUnit(iProc); iw++) {
355         DetectorArray& detarray = projGlobal.getDetectorArray( iw );
356         int nDet = detarray.nDet();
357         DetectorValue* detval = detarray.detValues();
358
359         double viewAngle = detarray.viewAngle();
360         mpiWorld.getComm().Send(&nDet, 1, MPI::INT, iProc, 0);
361         mpiWorld.getComm().Send(&viewAngle, 1, MPI::DOUBLE, iProc, 0);
362         mpiWorld.getComm().Send(detval, nDet, MPI::FLOAT, iProc, 0);
363       }
364     }
365   }
366
367   for (int iw = 0; iw < mpiWorld.getMyLocalWorkUnits(); iw++) {
368     MPI::Status status;
369     int nDet;
370     double viewAngle;
371     DetectorValue* detval = projLocal.getDetectorArray(iw).detValues();
372
373     mpiWorld.getComm().Recv(&nDet, 1, MPI::INT, 0, 0, status);
374     mpiWorld.getComm().Recv(&viewAngle, 1, MPI::DOUBLE, 0, 0, status);
375     mpiWorld.getComm().Recv(detval, nDet, MPI::FLOAT, 0, 0, status);
376     projLocal.getDetectorArray(iw).setViewAngle( viewAngle );
377   }
378 }
379
380 static void
381 ReduceImageMPI (MPIWorld& mpiWorld, ImageFile* imLocal, ImageFile* imGlobal)
382 {
383   ImageFileArray vLocal = imLocal->getArray();
384
385   for (int ix = 0; ix < imLocal->nx(); ix++) {
386     void *recvbuf = NULL;
387     if (mpiWorld.getRank() == 0) {
388       ImageFileArray vGlobal = imGlobal->getArray();
389       recvbuf = vGlobal[ix];
390     }
391     mpiWorld.getComm().Reduce (vLocal[ix], recvbuf, imLocal->ny(), imLocal->getMPIDataType(), MPI::SUM, 0);
392   }
393 }
394
395 #endif
396
397
398 #ifndef NO_MAIN
399 int 
400 main (int argc, char* argv[])
401 {
402   int retval = 1;
403
404   try {
405     retval = pjrec_main(argc, argv);
406   } catch (exception e) {
407     cerr << "Exception: " << e.what() << endl;
408   } catch (...) {
409     cerr << "Unknown exception" << endl;
410   }
411
412   return (retval);
413 }
414 #endif
415