69c4d0807a5065d3136e015ad65740ed5465db79
[ctsim.git] / libctsim / projections.cpp
1 /*****************************************************************************
2 ** FILE IDENTIFICATION
3 **
4 **   Name:         projections.cpp         Projection data classes
5 **   Programmer:   Kevin Rosenberg
6 **   Date Started: Aug 84
7 **
8 **  This is part of the CTSim program
9 **  Copyright (C) 1983-2000 Kevin Rosenberg
10 **
11 **  $Id: projections.cpp,v 1.14 2000/07/13 07:03:21 kevin Exp $
12 **
13 **  This program is free software; you can redistribute it and/or modify
14 **  it under the terms of the GNU General Public License (version 2) as
15 **  published by the Free Software Foundation.
16 **
17 **  This program is distributed in the hope that it will be useful,
18 **  but WITHOUT ANY WARRANTY; without even the implied warranty of
19 **  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20 **  GNU General Public License for more details.
21 **
22 **  You should have received a copy of the GNU General Public License
23 **  along with this program; if not, write to the Free Software
24 **  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
25 ******************************************************************************/
26
27 #include "ct.h"
28
29
30 /* NAME
31  *    Projections               Constructor for projections matrix storage 
32  *
33  * SYNOPSIS
34  *    proj = projections_create (filename, nView, nDet)
35  *    Projections& proj         Allocated projections structure & matrix
36  *    int nView                 Number of rotated view
37  *    int nDet                  Number of detectors
38  *
39  */
40
41 Projections::Projections (const Scanner& scanner)
42   : m_projData(0)
43 {
44   initFromScanner (scanner);
45 }
46
47
48 Projections::Projections (const int nView, const int nDet)
49   : m_projData(0)
50 {
51   init (nView, nDet);
52 }
53
54 Projections::Projections (void)
55   : m_projData(0)
56 {
57   init (0, 0);
58 }
59
60 Projections::~Projections (void)
61 {
62   deleteProjData();
63 }
64
65
66 void
67 Projections::init (const int nView, const int nDet)
68 {
69   m_nView = nView;
70   m_nDet = nDet;
71   newProjData ();
72 }
73
74 void
75 Projections::initFromScanner (const Scanner& scanner)
76 {
77   deleteProjData();
78   init (scanner.nView(), scanner.nDet());
79
80   m_phmLen = scanner.phmLen();
81   m_rotInc = scanner.rotInc();
82   m_detInc = scanner.detInc();
83   m_rotStart = 0;
84   m_detStart =  -scanner.radius() + (scanner.detInc() / 2);
85   m_phmLen = scanner.phmLen();
86 }
87
88 void
89 Projections::setNView (int nView)  // used by MPI to reduce # of views
90 {
91   deleteProjData();
92   init (nView, m_nDet);
93 }
94
95 // NAME
96 // newProjData
97
98 void 
99 Projections::newProjData (void)
100 {
101   if (m_projData)
102     sys_error(ERR_WARNING, "m_projData != NULL [newProjData]");
103
104   if (m_nView > 0 && m_nDet) {
105     m_projData = new DetectorArray* [m_nView];
106
107     for (int i = 0; i < m_nView; i++)
108       m_projData[i] = new DetectorArray (m_nDet);
109   }
110 }
111
112
113 /* NAME
114  *   projections_free                   Free memory allocated to projections
115  *
116  * SYNOPSIS
117  *   projections_free(proj)
118  *   Projections& proj                          Projectionss to be deallocated
119  */
120
121 void 
122 Projections::deleteProjData (void)
123 {
124   if (m_projData != NULL) {
125     for (int i = 0; i < m_nView; i++)
126       delete m_projData[i];
127
128     delete m_projData;
129     m_projData = NULL;
130   }
131 }
132
133
134 /* NAME
135  *    Projections::headerWwrite         Write data header for projections file
136  *
137  */
138
139 bool 
140 Projections::headerWrite (fnetorderstream& fs)
141 {
142   kuint16 _hsize = m_headerSize;
143   kuint16 _signature = m_signature;
144   kuint32 _nView = m_nView;
145   kuint32 _nDet = m_nDet;
146   kuint32 _geom = m_geometry;
147   kuint16 _remarksize = m_remark.length();
148   kuint16 _year = m_year;
149   kuint16 _month = m_month;
150   kuint16 _day = m_day;
151   kuint16 _hour = m_hour;
152   kuint16 _minute = m_minute;
153   kuint16 _second = m_second;
154
155   kfloat64 _calcTime = m_calcTime;
156   kfloat64 _rotStart = m_rotStart;
157   kfloat64 _rotInc = m_rotInc;
158   kfloat64 _detStart = m_detStart;
159   kfloat64 _detInc = m_detInc;
160   kfloat64 _phmLen = m_phmLen;
161   
162   fs.seekp(0);
163   if (! fs)
164     return false;
165
166   fs.writeInt16 (_hsize);
167   fs.writeInt16 (_signature);
168   fs.writeInt32 (_nView);
169   fs.writeInt32 (_nDet);
170   fs.writeInt32 (_geom);
171   fs.writeFloat64 (_calcTime);
172   fs.writeFloat64 (_rotStart);
173   fs.writeFloat64 (_rotInc);
174   fs.writeFloat64 (_detStart);
175   fs.writeFloat64 (_detInc);
176   fs.writeFloat64 (_phmLen);
177   fs.writeInt16 (_year);
178   fs.writeInt16 (_month);
179   fs.writeInt16 (_day);
180   fs.writeInt16 (_hour);
181   fs.writeInt16 (_minute);
182   fs.writeInt16 (_second);
183   fs.writeInt16 (_remarksize);
184   fs.write (m_remark.c_str(), _remarksize);
185
186   m_headerSize = fs.tellp();
187   _hsize = m_headerSize;
188   fs.seekp(0);
189   fs.writeInt16 (_hsize);
190   if (! fs)
191       return false;
192   
193   return true;
194 }
195
196 /* NAME
197  *    projections_read_header         Read data header for projections file
198  *
199  */
200 bool
201 Projections::headerRead (fnetorderstream& fs)
202 {
203   kuint16 _hsize, _signature, _year, _month, _day, _hour, _minute, _second, _remarksize = 0;
204   kuint32 _nView, _nDet, _geom;
205   kfloat64 _calcTime, _rotStart, _rotInc, _detStart, _detInc, _phmLen;
206   
207   fs.seekg(0);
208   if (! fs)
209       return false;
210
211   fs.readInt16 (_hsize);
212   fs.readInt16 (_signature);
213   fs.readInt32 (_nView);
214   fs.readInt32 (_nDet);
215   fs.readInt32 (_geom);
216   fs.readFloat64 (_calcTime);
217   fs.readFloat64 (_rotStart);
218   fs.readFloat64 (_rotInc);
219   fs.readFloat64 (_detStart);
220   fs.readFloat64 (_detInc);
221   fs.readFloat64 (_phmLen);
222   fs.readInt16 (_year);
223   fs.readInt16 (_month);
224   fs.readInt16 (_day);
225   fs.readInt16 (_hour);
226   fs.readInt16 (_minute);
227   fs.readInt16 (_second);
228   fs.readInt16 (_remarksize);
229
230   if (! fs) {
231       sys_error (ERR_SEVERE, "Error reading header information , _remarksize=%d [projections_read_header]", _remarksize);
232       return false;
233   }
234
235   if (_signature != m_signature) {
236     sys_error (ERR_SEVERE, "File %s does not have a valid projection file signature", m_filename.c_str());
237     return false;
238   }
239
240   char remarkStorage[_remarksize+1];
241   fs.read (remarkStorage, _remarksize);
242   if (! fs) {
243     sys_error (ERR_SEVERE, "Error reading remark, _remarksize = %d", _remarksize);
244     return false;
245   }
246   remarkStorage[_remarksize] = 0;
247   m_remark = remarkStorage;
248
249   off_t _hsizeread = fs.tellg();
250   if (!fs || _hsizeread != _hsize) {
251       sys_error (ERR_WARNING, "File header size read %ld != file header size stored %ld [read_projections_header]\n_remarksize=%ld", (long int) _hsizeread, _hsize, _remarksize);
252       return false;
253   }
254   
255   m_headerSize = _hsize;
256   m_nView = _nView;
257   m_nDet = _nDet;
258   m_geometry = _geom;
259   m_calcTime = _calcTime;
260   m_rotStart = _rotStart;
261   m_rotInc = _rotInc;
262   m_detStart = _detStart;
263   m_detInc = _detInc;
264   m_phmLen = _phmLen;
265   m_year = _year;
266   m_month = _month;
267   m_day = _day;
268   m_hour = _hour;
269   m_minute = _minute;
270   m_second = _second;
271
272   m_label.setLabelType (Array2dFileLabel::L_HISTORY);
273   m_label.setLabelString (m_remark);
274   m_label.setCalcTime (m_calcTime);
275   m_label.setDateTime (m_year, m_month, m_day, m_hour, m_minute, m_second);
276
277   return true;
278 }
279
280 bool
281 Projections::read (const char* filename)
282 {
283   frnetorderstream fileRead (filename, ios::in | ios::binary);
284   m_filename = filename;
285
286   if (! fileRead)
287     return false;
288
289   if (! headerRead (fileRead))
290     return false;
291
292   deleteProjData ();
293   newProjData();
294
295   for (int i = 0; i < m_nView; i++) {
296     if (! detarrayRead (fileRead, *m_projData[i], i))
297       break;
298   }
299
300   fileRead.close();
301   return true;
302 }
303
304
305 bool
306 Projections::write (const char* filename)
307 {
308   frnetorderstream fs (filename, ios::out | ios::binary | ios::trunc | ios::ate);
309   m_filename = filename;
310   if (! fs) {
311     sys_error (ERR_SEVERE, "Error opening file %s for output [projections_create]", filename);
312     return false;
313   }
314
315   time_t t = time(NULL);
316   tm* lt = localtime(&t);
317   m_year = lt->tm_year;
318   m_month = lt->tm_mon;
319   m_day = lt->tm_mday;
320   m_hour = lt->tm_hour;
321   m_minute = lt->tm_min;
322   m_second = lt->tm_sec;
323
324   if (! headerWrite (fs))
325       return false;
326
327   if (m_projData != NULL) {
328     for (int i = 0; i < m_nView; i++) {
329       if (! detarrayWrite (fs, *m_projData[i], i))
330         break;
331     }
332   }
333   if (! fs)
334     return false;
335
336  fs.close();
337
338   return true;
339 }
340
341 /* NAME
342  *   detarrayRead               Read a Detector Array structure from the disk
343  *
344  * SYNOPSIS
345  *   detarrayRead (proj, darray, view_num)
346  *   DETARRAY *darray           Detector array storage location to be filled
347  *   int      view_num          View number to read
348  */
349
350 bool
351 Projections::detarrayRead (fnetorderstream& fs, DetectorArray& darray, const int iview)
352 {
353   const int detval_bytes = darray.nDet() * sizeof(kfloat32);
354   const int detheader_bytes = sizeof(kfloat64) /* view_angle */ + sizeof(kint32) /* nDet */;
355   const int view_bytes = detheader_bytes + detval_bytes;
356   const off_t start_data = m_headerSize + (iview * view_bytes);
357   DetectorValue* detval_ptr = darray.detValues();  
358   kfloat64 view_angle;
359   kuint32 nDet;
360
361   fs.seekg (start_data);
362
363   fs.readFloat64 (view_angle);
364   fs.readInt32 (nDet);
365   darray.setViewAngle (view_angle);
366   //  darray.setNDet ( nDet);
367   
368   for (unsigned int i = 0; i < nDet; i++) {
369       kfloat32 detval;
370       fs.readFloat32 (detval);
371       detval_ptr[i] = detval;
372   }
373   if (! fs)
374     return false;
375
376   return true;
377 }
378
379
380 /* NAME
381  *   detarrayWrite                      Write detector array data to the disk
382  *
383  * SYNOPSIS
384  *   detarrayWrite (darray, view_num)
385  *   DETARRAY *darray                   Detector array data to be written
386  *   int      view_num                  View number to write
387  *
388  * DESCRIPTION
389  *       This routine writes the detarray data from the disk sequentially to
390  *    the file that was opened with open_projections().  Data is written in
391  *    binary format.
392  */
393
394 bool
395 Projections::detarrayWrite (fnetorderstream& fs, const DetectorArray& darray, const int iview)
396 {
397   const int detval_bytes = darray.nDet() * sizeof(float);
398   const int detheader_bytes = sizeof(kfloat64) /* view_angle */ + sizeof(kint32) /* nDet */;
399   const int view_bytes = detheader_bytes + detval_bytes;
400   const off_t start_data = m_headerSize + (iview * view_bytes);
401   const DetectorValue* const detval_ptr = darray.detValues();  
402   kfloat64 view_angle = darray.viewAngle();
403   kuint32 nDet = darray.nDet();
404   
405   fs.seekp (start_data);
406   if (! fs) {
407     sys_error (ERR_SEVERE, "Error seeking detectory array [detarrayWrite]");
408     return false;
409   }
410
411   fs.writeFloat64 (view_angle);
412   fs.writeInt32 (nDet);
413
414   for (unsigned int i = 0; i < nDet; i++) {
415     kfloat32 detval = detval_ptr[i];
416     fs.writeFloat32 (detval);
417   }
418
419   if (! fs)
420     return (false);
421
422   return true;
423 }
424
425 /* NAME
426  *   prt_projections                    Print projections data
427  *
428  * SYNOPSIS
429  *   prt_projections (proj)
430  *   Projections& proj                  Projection data to be printed
431  */
432
433 void
434 Projections::printProjectionData (void)
435 {
436   printf("Projections Print\n\n");
437   printf("Description: %s\n", m_remark.c_str());
438   printf("nView = %d  nDet = %d\n", m_nView, m_nDet);
439   printf("rotStart = %8.4f   rotInc = %8.4f\n", m_rotStart, m_rotInc);
440   printf("detStart = %8.4f   detInc = %8.4f\n", m_detStart, m_detInc);
441
442   if (m_projData != NULL) {
443       for (int ir = 0; ir < m_nView; ir++) {
444           DetectorValue* detval = m_projData[ir]->detValues();
445           for (int id = 0; id < m_projData[ir]->nDet(); id++)
446               printf("%8.4f  ", detval[id]);
447           printf("\n");
448       }
449   }
450 }
451
452 void 
453 Projections::printScanInfo (void) const
454 {
455   printf ("Number of detectors: %d\n", m_nDet);
456   printf ("    Number of views: %d\n", m_nView);
457   printf ("             Remark: %s\n", m_remark.c_str());
458   printf ("             phmLen: %f\n", m_phmLen);
459   printf ("           detStart: %f\n", m_detStart);
460   printf ("             detInc: %f\n", m_detInc);
461   printf ("           rotStart: %f\n", m_rotStart);
462   printf ("             rotInc: %f\n", m_rotInc);
463 }
464
465
466
467 /* NAME
468  *   Projections::reconstruct      Reconstruct Image from Projections
469  *
470  * SYNOPSIS
471  *   im = proj.reconstruct (im, filt_type, filt_param, interp_type)
472  *   IMAGE *im                  Output image
473  *   int filt_type              Type of convolution filter to use
474  *   double filt_param          Filter specific parameter
475  *                              Currently, used only with Hamming filters
476  *   int interp_type            Type of interpolation method to use
477  *
478  * ALGORITHM
479  *
480  *      Calculate one-dimensional filter in spatial domain
481  *      Allocate & clear (zero) the 2d output image array
482  *      For each projection view
483  *          Convolve raysum array with filter
484  *          Backproject raysums and add (summate) to image array
485  *      end
486  */
487
488 bool
489 Projections::reconstruct (ImageFile& im, const char* const filterName, double filt_param, const char* const filterMethodName, const int zeropad, const char* const interpName, int interpFactor, const char* const backprojectName, const int trace)
490 {
491   double detInc = m_detInc;
492   int n_filteredProj = m_nDet * interpFactor;
493   double filteredProj [n_filteredProj];   // filtered projections
494
495 #ifdef HAVE_BSPLINE_INTERP
496   int spline_order = 0, zoom_factor = 0;
497   if (interp_type == I_BSPLINE) {
498     zoom_factor = interpFactor;
499     spline_order = 3;
500     zoom_factor = 3;
501     n_filteredProj = (m_nDet - 1) * (zoom_factor + 1) + 1;
502   }
503 #endif
504
505   double filterBW = 1. / detInc;
506   SignalFilter filter (filterName, filterMethodName, filterBW, m_detInc, m_nDet, filt_param, "spatial", zeropad, interpFactor);
507   filter.setTraceLevel(trace);
508
509   if (filter.fail()) {
510       sys_error (ERR_SEVERE, "%s [Projections::reconstruct]", filter.failMessage().c_str());
511       return false;
512   }
513
514   if (trace)
515     cout << "Reconstruct: filter="<<filterName<< ", interp="<<interpName<<", backproject="<<backprojectName<<endl;
516
517 #if HAVE_SGP
518   SGP_ID gid;
519   int nVecFilter = filter.getNFilterPoints();
520   double plot_xaxis [nVecFilter];                       // array for plotting 
521
522   if (trace > TRACE_TEXT && nVecFilter > 0)  {
523     int i;
524     double f;
525     double filterInc = filter.getFilterIncrement();
526     for (i = 0, f = filter.getFilterMin(); i < nVecFilter; i++, f += filterInc) 
527       plot_xaxis[i] = f;
528
529     if (filter.getFilter()) {
530       gid = ezplot (plot_xaxis, filter.getFilter(), nVecFilter);
531       cio_put_str ("Press any key to continue");
532       cio_kb_getc ();
533       sgp2_close (gid);
534     }
535   }
536   if (trace >= TRACE_TEXT) {
537     printf ("nview=%d, ndet=%d, det_start=%.4f, detInc=%.4f\n", m_nView, m_nDet, m_detStart, m_detInc);
538   }
539 #endif  //HAVE_SGP
540
541   Backprojector bj (*this, im, backprojectName, interpName, interpFactor);
542   if (bj.fail()) {
543     sys_error (ERR_SEVERE, "%s [Projections::reconstruct]", bj.failMessage().c_str());
544     return false;
545   }
546
547   for (int iview = 0; iview < m_nView; iview++)  {
548     if (trace >= TRACE_TEXT) 
549       printf ("Reconstructing view %d (last = %d)\n",  iview, m_nView - 1);
550       
551     DetectorArray& darray = getDetectorArray (iview);
552     DetectorValue* detval = darray.detValues();
553
554     filter.filterSignal (detval, filteredProj);
555
556 #ifdef HAVE_SGP
557     if (trace >= TRACE_PLOT)  {
558       ezset  ("clear.");
559       ezset  ("xticks major 5.");
560       ezset  ("xlabel ");
561       ezset  ("ylabel ");
562       ezset  ("xlength .5.");
563       ezset  ("box.");
564       ezset  ("grid.");
565       ezset  ("ufinish yes.");
566       ezplot (detval, plot_xaxis, m_nDet);
567       ezset  ("clear.");
568       ezset  ("xticks major 5.");
569       ezset  ("xlabel ");
570       ezset  ("ylabel ");
571       ezset  ("ustart yes.");
572       ezset  ("xporigin .5.");
573       ezset  ("xlength .5.");
574       ezset ("box");
575
576       ezset ("grid");
577       gid = ezplot (filteredProj, plot_xaxis, n_filteredProj);
578     }
579 #endif  //HAVE_SGP
580
581 #ifdef HAVE_BSPLINE_INTERP
582     if (interp_type == I_BSPLINE) 
583         bspline (m_nDet, zoom_factor, spline_order, filteredProj, filteredProj);
584     
585 #ifdef HAVE_SGP
586     if (trace >= TRACE_PLOT && interp_type == I_BSPLINE) {
587         bspline (m_nDet, zoom_factor, spline_order, filteredProj, filteredProj);
588       ezplot_1d (filteredProj, n_filteredProj);
589     }
590 #endif
591 #endif
592
593     bj.BackprojectView (filteredProj, darray.viewAngle());
594
595 #ifdef HAVE_SGP
596     if (trace >= TRACE_PLOT) {
597       char str[256];
598       printf ("Do you want to exit with current pic (y/n) -- ");
599       fgets(str, sizeof(str), stdin);
600       sgp2_close (sgp2_get_active_win());
601       if (tolower(str[0]) == 'y') {
602         break;
603       }
604     } 
605 #endif  //HAVE_SGP
606   }
607
608   return true;
609 }
610