r75: *** empty log message ***
[ctsim.git] / include / ir.h
1 /*****************************************************************************
2 **  This is part of the CTSim program
3 **  Copyright (C) 1983-2000 Kevin Rosenberg
4 **
5 **  $Id: ir.h,v 1.21 2000/06/07 03:49:54 kevin Exp $
6 **  $Log: ir.h,v $
7 **  Revision 1.21  2000/06/07 03:49:54  kevin
8 **  *** empty log message ***
9 **
10 **  Revision 1.20  2000/06/07 02:30:27  kevin
11 **  Added C++ image files
12 **
13 **  Revision 1.19  2000/06/07 00:59:38  kevin
14 **  added imagefiles
15 **
16 **  Revision 1.18  2000/06/05 01:32:45  kevin
17 **  Added C++ compatibility
18 **
19 **  Revision 1.17  2000/06/03 06:29:08  kevin
20 **  *** empty log message ***
21 **
22 **  Revision 1.16  2000/05/24 22:48:17  kevin
23 **  First functional version of SDF library for X-window
24 **
25 **  Revision 1.15  2000/05/16 04:33:17  kevin
26 **  Updated documentation
27 **
28 **  Revision 1.14  2000/05/11 14:07:00  kevin
29 **  Added support for Windows NT
30 **
31 **  Revision 1.13  2000/05/08 20:00:48  kevin
32 **  ANSI C changes
33 **
34 **  Revision 1.12  2000/05/07 12:46:19  kevin
35 **  made c++ compatible
36 **
37 **  Revision 1.11  2000/05/05 02:37:31  kevin
38 **  renamed phmelm to pelm
39 **
40 **  Revision 1.10  2000/05/04 18:16:34  kevin
41 **  renamed filter definitions
42 **
43 **  Revision 1.9  2000/05/04 04:29:18  kevin
44 **  *** empty log message ***
45 **
46 **  Revision 1.8  2000/05/04 04:25:55  kevin
47 **  Renamed phantom and phantom-element functions/variables
48 **
49 **  Revision 1.7  2000/05/03 19:51:41  kevin
50 **  function renaming for phantoms and phantom elements
51 **
52 **  Revision 1.6  2000/05/03 08:49:49  kevin
53 **  Code cleanup
54 **
55 **  Revision 1.5  2000/05/02 20:00:25  kevin
56 **  *** empty log message ***
57 **
58 **  Revision 1.4  2000/05/02 15:31:39  kevin
59 **  code cleaning
60 **
61 **  Revision 1.3  2000/04/29 23:24:29  kevin
62 **  *** empty log message ***
63 **
64 **  Revision 1.2  2000/04/28 14:14:16  kevin
65 **  *** empty log message ***
66 **
67 **  Revision 1.1.1.1  2000/04/28 13:02:43  kevin
68 **  Initial CVS import for first public release
69 **
70 **
71 **
72 **  This program is free software; you can redistribute it and/or modify
73 **  it under the terms of the GNU General Public License (version 2) as
74 **  published by the Free Software Foundation.
75 **
76 **  This program is distributed in the hope that it will be useful,
77 **  but WITHOUT ANY WARRANTY; without even the implied warranty of
78 **  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
79 **  GNU General Public License for more details.
80 **
81 **  You should have received a copy of the GNU General Public License
82 **  along with this program; if not, write to the Free Software
83 **  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
84 ******************************************************************************/
85
86 /*      ir.h        Header File for Image Reconstruction System
87  *      Programmer:   Kevin Rosenberg
88  *      Date Started: 7-1-84
89  */
90
91 #ifndef IR_H
92 #define IR_H
93
94
95 struct histo_st {
96     int *b;                     /* Histogram array (# of elements in each bin) */
97     int nbin;                   /* Number of histogram bins */
98     double xmin, xmax, xinc;    /* Limits of histogram boundaries */
99 };
100
101 typedef struct histo_st HISTOGRAM;
102
103 /*---------------------------------------------------------------------------*/
104
105 static const int POINTS_PER_CIRCLE=90;
106 #define MAXREMARK  99
107
108 typedef FMTX_2D         IMAGE_ARRAY;    /* use 2d floating point matrix */
109 typedef float           IMAGE_ELEM_VAL; /* use floats for image storing */
110
111 struct image_st {
112     IMAGE_ARRAY v;                      /* values of voxels in matrix form */
113     SDF_2D *dfp_2d;                     /* Pointer to disk image file */
114     int nx, ny;                         /* size of voxel matrix */
115     double xmin, xmax, ymin, ymax;      /* extent of voxel matrix in phm coord */
116     char remark[MAXREMARK+1];           /* description of voxel data */
117     float calctime;                     /* time to calculate voxels in seconds */
118 };
119 typedef struct image_st  IMAGE;
120
121 typedef enum {
122   RECTANGLE,
123   TRIANGLE,
124   ELLIPSE,
125   SECTOR,
126   SEGMENT
127 } PElmType;
128
129 struct pelm_st {
130     PElmType type;           /* pelm type (box, ellipse, etc) */
131     double atten;            /* X-ray attenuation coefficient */
132     double cx,cy;            /* center of pelm */
133     double u,v;              /* size of pelm */
134     double rot;              /* pelm rotation angle (in radians) */
135     double *x, *y;           /* ptr to array of points in obj world coord */
136     int pts;                 /* number of points in outline arrays */
137     double xmin, xmax, ymin, ymax; /* pelm limits */
138     double radius;           /*   "   */
139     GRFMTX_2D p_to_o;        /* map from phantom to standard pelm coords */
140     GRFMTX_2D o_to_p;        /* map from std pelm coords to phantom coords */
141     struct pelm_st *next;    /* pointer to next pelm in phantom */
142 };
143 typedef struct pelm_st PELM;
144
145 typedef enum {
146   P_PELMS,        /* Phantom made of Pelms */
147   P_UNIT_PULSE,   /* Special phantom, not made of pelms */
148   P_FILTER        /* defined only by this type */
149 } PhmType;
150
151 struct phm_st {                    /* Phantom structure */
152     PELM *pelm_list;               /* pelm linked-list */
153     PhmType type;
154     int n_pelm;                    /* number of pelms in phantom */
155     double xmin, xmax, ymin, ymax; /* extent of pelms in pelm coordinates */
156     double radius;                 /*      " "    */
157 };
158 typedef struct phm_st    PHANTOM;
159
160
161 /*----------------------------------------------------------------------*/
162 /*                              RAYSUM SYMBOLS                          */
163 /*----------------------------------------------------------------------*/
164
165 /* Ray sums are collected along an array of ndet detectors.  The data
166  * for these detectors is stored in the structure DETECTARRAY
167  */
168
169 typedef float DETECT_TYPE;
170
171 struct detarray_st {
172   DETECT_TYPE *detval;  /* Pointer to array of values recorded by detector */
173   int ndet;             /* Number of detectors in array */
174   double view_angle;    /* View angle in radians */
175 };
176 typedef struct detarray_st DETARRAY;
177
178
179 typedef enum {
180     DETECTOR_PARALLEL,
181     DETECTOR_EQUIANGLE,
182     DETECTOR_EQUILINEAR
183 } ScannerGeometry;
184   
185 struct detector_st {
186   ScannerGeometry geometry;     /* Geometry of detectory */
187   int ndet;                     /* Number of detectors in array */
188   int nview;                    /* Number of rotated views */
189   int nsample;                  /* Number of rays per detector */
190   double detlen;                /* Total length of detector array */
191   double rotlen;                /* Rotation angle length in radians (norm 2PI) */
192   double det_inc;               /* Increment between centers of detectors */
193   double rot_inc;               /* Increment in rotation angle between views */
194   double radius;                /* Radius of rotation.  Distance from */
195                                 /*   center of phm to center of det */
196   double phmlen;                /* Maximum Length of phantom or area of interest */
197   struct {
198     double xd1,yd1,xd2,yd2;     /* Coordinates of detector endpoints */
199     double xs1,ys1,xs2,ys2;     /* Coordinates of source endpoints */
200     double angle;               /* Starting angle */
201   } init;
202 };
203 typedef struct detector_st DETECTOR;
204
205 struct raysum_st {
206   int fd;                       /* Disk file descriptor */
207   int file_mode;                /* Current file mode (read or write) */
208   int header_size;              /* Size of disk file header */
209   int geometry;                 /* Geometry of scanner */
210   struct detarray_st **view;    /* Pointer to array of detarray_st pointers */
211
212   char remark[MAXREMARK+1];     /* description of raysum data */
213   double calctime;              /* time required to calculate raysums */
214
215   int ndet;                     /* number of detectors in array */
216   int nview;                    /* number of rotated views */
217   double rot_start;             /* starting view rotation */
218   double rot_inc;               /* angle between rotations */
219   double det_start;             /* distance of beginning detector to center */
220                                 /*    of PHANTOM */
221   double det_inc;               /* increment between detectors */
222   double phmlen;                /* Length of PHANTOM edge (phm is square) */
223 };
224 typedef struct raysum_st   RAYSUM;
225
226 /*----------------------------------------------------------------------*/
227 /*                              USER SYMBOLS                            */
228 /*----------------------------------------------------------------------*/
229
230 /* Codes for Coordinate Types      */
231 /* Defines coords for pelm_is_point_inside() */
232
233 typedef enum {
234   PELM_COORD,         /* Normalized Pelm Coordinates */
235   PHM_COORD           /* User's phantom Coordinates */
236 } CoordType;
237
238 /* Codes for Filter types */
239
240 typedef enum {  /* filter types for filter_generate() */
241   FILTER_BANDLIMIT, 
242   FILTER_SINC,
243   FILTER_G_HAMMING,
244   FILTER_COSINE,
245   FILTER_TRIANGLE,
246   FILTER_ABS_BANDLIMIT,         /* filter times |x| */
247   FILTER_ABS_SINC, 
248   FILTER_ABS_G_HAMMING,
249   FILTER_ABS_COSINE,
250   FILTER_SHEPP
251 } FilterType;
252
253 /* function domains */
254
255 static const char D_FREQ_STR[]=    "freq";
256 static const char D_SPATIAL_STR[]= "spatial";
257  
258 typedef enum {
259   D_FREQ = 1,
260   D_SPATIAL 
261 } DomainType;
262
263 typedef enum {
264     FUNC_EVEN = 1,    /* function types, f[-n] = f[n] */
265     FUNC_ODD,     /* f[-n] = -f[n] */
266     FUNC_BOTH    /* function has both odd & even components */
267 } FunctionSymmetry;
268
269 /* interpolation methods */
270 #undef HAVE_BSPLINE_INTERP
271 typedef enum {     /* Interpolation methods */
272   I_NEAREST = 1,       /* Nearest neighbor */
273 #if HAVE_BSPLINE_INTERP
274   I_BSPLINE,
275   I_1BSPLINE,      /* 1st order B-Spline */
276   I_2BSPLINE,
277   I_3BSPLINE,
278 #endif
279   I_LINEAR        /* Linear interpolation */
280 } InterpolationType;
281
282 /* Constants for sizing PHANTOM */
283
284 static const double PERCENT_PHM_SIZE_INCR=0.0;  /* Fractional increase in phantom limits compared to pelm size */
285 static const int N_EXTRA_DETECTORS=4;           /* Number of extra detectors widths when calculating detlen */
286
287 static const char O_TRACE_NONE_STR[]=     "none";
288 static const char O_TRACE_TEXT_STR[]=     "text";
289 static const char O_TRACE_PHM_STR[]=      "phm";
290 static const char O_TRACE_RAYS_STR[]=     "rays";
291 static const char O_TRACE_PLOT_STR[]=     "plot";
292 static const char O_TRACE_CLIPPING_STR[]= "clipping";
293
294 enum {
295   TRACE_NONE,           /* No tracing */
296   TRACE_TEXT,           /* Minimal status */
297   TRACE_PHM,            /* Show phantom */
298   TRACE_RAYS,           /* Show all rays */
299   TRACE_PLOT,           /* Plot raysums */
300   TRACE_CLIPPING        /* Plot clipping */
301 };
302
303 typedef enum {
304   O_PHM_HERMAN,               /* Herman head phantom */
305   O_PHM_ROWLAND,              /* Rowland head phantom */
306   O_PHM_BROWLAND,             /* Bordered Rowland head phantom */
307   O_PHM_UNITPULSE             /* Unit pulse phantom */
308 } PhantomType;
309
310 static const char O_PHM_HERMAN_STR[]=    "herman";
311 static const char O_PHM_ROWLAND_STR[]=   "rowland";
312 static const char O_PHM_BROWLAND_STR[]=  "browland";
313 static const char O_PHM_UNITPULSE_STR[]= "unitpulse";
314
315 static const char O_INTERP_NEAREST_STR[]=  "nearest";
316 static const char O_INTERP_LINEAR_STR[]=   "linear";
317 static const char O_INTERP_BSPLINE_STR[]=  "bspline";
318
319 static const char O_FILTER_ABS_BANDLIMIT_STR[]= "abs_bandlimit";
320 static const char O_FILTER_ABS_SINC_STR[]=      "abs_sinc";
321 static const char O_FILTER_ABS_COS_STR[]=       "abs_cos";
322 static const char O_FILTER_ABS_HAMMING_STR[]=   "abs_hamming";
323 static const char O_FILTER_SHEPP_STR[]=         "shepp";
324 static const char O_FILTER_BANDLIMIT_STR[]=     "bandlimit";
325 static const char O_FILTER_SINC_STR[]=          "sinc";
326 static const char O_FILTER_COS_STR[]=           "cos";
327 static const char O_FILTER_HAMMING_STR[]=       "hamming";
328 static const char O_FILTER_TRIANGLE_STR[]=      "triangle";
329
330 typedef  enum {
331   O_BPROJ_TRIG,
332   O_BPROJ_TABLE,
333   O_BPROJ_DIFF,
334   O_BPROJ_DIFF2,
335   O_BPROJ_IDIFF2
336 } BackprojType;
337
338 static const char O_BPROJ_TRIG_STR[]=     "trig";
339 static const char O_BPROJ_TABLE_STR[]=    "table";
340 static const char O_BPROJ_DIFF_STR[]=     "diff";
341 static const char O_BPROJ_DIFF2_STR[]=    "diff2";
342 static const char O_BPROJ_IDIFF2_STR[]=   "idiff2";
343
344 const static int RAYSUM_TRACE_ROW_TITLE=1;
345 const static int RAYSUM_TRACE_ROW_TITLE2=2;
346 const static int RAYSUM_TRACE_ROW_PHANT_ID=4;
347 const static int RAYSUM_TRACE_ROW_CHROMATIC=7;
348 const static int RAYSUM_TRACE_ROW_SCATTER=8;
349 const static int RAYSUM_TRACE_ROW_PHOT_STAT=9;
350 const static int RAYSUM_TRACE_ROW_NDET=12;
351 const static int RAYSUM_TRACE_ROW_NVIEW=13;
352 const static int RAYSUM_TRACE_ROW_SAMPLES=14;
353 const static int RAYSUM_TRACE_ROW_CURR_VIEW=17;
354 const static int RAYSUM_TRACE_ROW_ATTEN=18;
355
356
357 /*************************************************************************
358  *  FUNCTION DECLARATIONS
359  ************************************************************************/
360
361 #ifdef __cplusplus
362 extern "C" {
363 #endif /* __cplusplus */
364
365 #ifdef MPI_CT
366 #define MPI_MAX_PROCESS 128 
367 struct mpi_ct_st
368 {
369   int my_rank;
370   int nproc;
371   int base_local_work_units;
372   int remainder_work_units;
373   int local_work_units[MPI_MAX_PROCESS];
374   int start_work_unit[MPI_MAX_PROCESS];
375   MPI_Comm comm;
376 };
377
378 extern struct mpi_ct_st mpi_ct;
379 void mpi_ct_calc_work_units(const unsigned int global_work_units);
380 #endif
381
382
383 /* From reconstr.c */
384 IMAGE *image_reconst (IMAGE *im, RAYSUM *rs, const FilterType filt_type, double filt_param, InterpolationType interp_type, int interp_param, const BackprojType backproj_type, int const ir_trace);
385
386 /* From bproj.c */
387 void backproj_init (const RAYSUM *rs, IMAGE *im, const BackprojType bproj_method);
388 int  backproj_calc (const RAYSUM *rs, IMAGE *im, const double *t, const double view_angle, 
389                     const int interp_type, const int bproj_method);
390 void backproj_term (const RAYSUM *rs, IMAGE *im, const int bproj_method);
391
392 void backproj_init_trig (const RAYSUM *rs, IMAGE *im);
393 int  backproj_calc_trig (const RAYSUM *rs, IMAGE *im, const double *t, 
394                          const double view_angle, const int interp_type);
395 void backproj_term_trig (const RAYSUM *rs, IMAGE *im);
396 void backproj_init_table (const RAYSUM *rs, IMAGE *im);
397 int  backproj_calc_table (const RAYSUM *rs, IMAGE *im, const double *t, 
398                           const double view_angle, const int interp_type);
399 void backproj_term_table (const RAYSUM *rs, IMAGE *im);
400 void backproj_init_d (const RAYSUM *rs, IMAGE *im);
401 int  backproj_calc_d (const RAYSUM *rs, IMAGE *im, const double *t, 
402                       const double view_angle, const int interp_type);
403 void backproj_term_d (const RAYSUM *rs, IMAGE *im);
404 void backproj_init_d2 (const RAYSUM *rs, IMAGE *im);
405 int  backproj_calc_d2 (const RAYSUM *rs, IMAGE *im, const double *t, 
406                        const double view_angle, const int interp_type);
407 void backproj_term_d2 (const RAYSUM *rs, IMAGE *im);
408 void backproj_init_id (const RAYSUM *rs, IMAGE *im);
409 int  backproj_calc_id (const RAYSUM *rs, IMAGE *im, const double *t, 
410                        const double view_angle, const int interp_type);
411 void backproj_term_id (const RAYSUM *rs, IMAGE *im);
412 void backproj_init_id2 (const RAYSUM *rs, IMAGE *im);
413 int  backproj_calc_id2 (const RAYSUM *rs, IMAGE *im, const double *t, 
414                         const double view_angle, const int interp_type);
415 void backproj_term_id2 (const RAYSUM *rs, IMAGE *im);
416
417 /* bspline.c */
418 int bspline(int samples, int zoom_factor, int spline_order, double input[], double output[]);
419
420 /* convolve.c */
421 double convolve(const double f1[], const double f2[], const double dx, const int n, const int np, const FunctionSymmetry func_type);
422 double convolve_both(const double f1[], const double f2[], const double dx, const int n, const int np);
423
424 /* dialogs.c */
425 int phm_add_pelm_kb(PHANTOM *phm);
426 PHANTOM *phm_select(void);
427 int interpolation_select(void);
428 int filter_select(double *filter_param);
429
430 /* filter.c */
431 double *filter_generate(const FilterType filt_type, double bw, double xmin, double xmax, int n, double param, const DomainType domain, int numint);
432 double filter_spatial_response_calc(int filt_type, double x, double bw, double param, int n);
433 double filter_spatial_response_analytic(int filt_type, double x, double bw, double param);
434 double filter_frequency_response(int filt_type, double u, double bw, double param);
435 double sinc(double x, double mult);
436 double integral_abscos(double u, double w);
437
438 /* image.c */
439 IMAGE *image_create(const char *fname, const int nx, const int ny);
440 int image_clear(IMAGE *im);
441 int image_save(IMAGE *im);
442 IMAGE *image_load(const char *fname);
443 void image_filter_response(IMAGE *im, const DomainType domain, double bw, const FilterType filt_type, double filt_param, const int opt_trace);
444 int image_display (const IMAGE *im);
445 int image_display_scale (const IMAGE *im, const int scale, const double pmin, const double pmax);
446
447 /* options.c */
448 int opt_set_trace(const char *optarg);
449 const char *name_of_phantom(const int phmid);
450 int opt_set_phantom(const char *optarg);
451 InterpolationType opt_set_interpolation(const char *optarg);
452 const char *name_of_interpolation(int interp_type);
453 FilterType opt_set_filter(const char *optarg);
454 const char *name_of_filter(const int filter);
455 DomainType opt_set_filter_domain(const char *optarg);
456 const char *name_of_filter_domain(const DomainType domain);
457 BackprojType opt_set_backproj(const char *optarg);
458 const char *name_of_backproj(const BackprojType backproj);
459
460 /* phm.c */
461 PHANTOM *phm_create(const int phmid);
462 PHANTOM *phm_create_from_file(const char *fname);
463 PHANTOM *phm_init(void);
464 void phm_free (PHANTOM *phm);
465 int phm_add_pelm_file(PHANTOM *phm, const char *fname);
466 void phm_add_pelm (PHANTOM *phm, const char *type, const double cx, const double cy, 
467                const double u, const double v, const double rot, const double atten);
468 int pelm_make_points(PELM *obj);
469 void pelm_make_xform (PELM *obj);
470 PELM *pelm_alloc(void);
471 void calc_arc(double x[], double y[], const int pts, const double xcent, const double ycent, 
472               const double r, const double start, const double stop);
473 void calc_ellipse(double x[], double y[], const int pts, const double u, const double v);
474 int circle_pts(double theta);
475 void phm_print(PHANTOM *phm);
476 #if HAVE_SGP
477 void phm_show(const PHANTOM *phm);
478 void phm_draw(const PHANTOM *phm);
479 #endif
480
481 /* phm2image.c */
482 void phm_to_image(const PHANTOM *phm, IMAGE *im, const int col_start, const int col_count, const int nsample, const int trace);
483 int pelm_is_point_inside(PELM *obj, const double x, const double y, const CoordType coord_type);
484
485 /* phmstd.c */
486 void phm_std_herman (PHANTOM *phm);
487 void phm_std_rowland (PHANTOM *phm);
488 void phm_std_rowland_bordered (PHANTOM *phm);
489
490 /* raycollect.c */
491 int raysum_collect(RAYSUM *rs, const DETECTOR *det, const PHANTOM *phm, const int start_view, const int trace, const int unit_pulse);
492 void rayview(const PHANTOM *phm, DETARRAY *darray, const DETECTOR *det, const double xd1, const double yd1, const double xd2, const double yd2, const double xs1, const double ys1, const double xs2, const double ys2, const int unit_pulse);
493 double phm_ray_attenuation (const PHANTOM *phm, const double x1, const double y1, const double x2, const double y2);
494 double pelm_ray_attenuation (PELM *pelm, const double x1, const double y1, const double x2, const double y2);
495 int pelm_clip_line (const PELM *pelm, double *x1, double *y1, double *x2, double *y2);
496 void raysum_trace_show_param (const char *label, const char *fmt, int row, int color, ...);
497
498 /* scanner.c */
499 DETECTOR *detector_create(const PHANTOM *phm, int geometry, int ndet, int nview, int nsample, const double rot_anglen);
500 void detector_free(DETECTOR *det);
501
502 /* rayio.c */
503 RAYSUM *raysum_create(const char *fname, const int nview, const int ndet);
504 RAYSUM *raysum_create_from_det(const char *fname, const DETECTOR *det);
505 RAYSUM *raysum_open(const char *filename);
506 void raysum_alloc_views(RAYSUM *rs);
507 void raysum_free(RAYSUM *rs);
508 int raysum_is_open(RAYSUM *rs);
509 int raysum_close(RAYSUM *rs);
510 int raysum_read_header(RAYSUM *rs);
511 int raysum_write_header(RAYSUM *rs);
512 int raysum_read(RAYSUM *rs);
513 int raysum_write(RAYSUM *rs);
514 DETARRAY *detarray_alloc(const int n);
515 void detarray_free(DETARRAY *darray);
516 int detarray_read(RAYSUM *rs, DETARRAY *darray, const int view_num);
517 int detarray_write(RAYSUM *rs, const DETARRAY *darray, const int view_num);
518 int raysum_print(const RAYSUM *rs);
519
520 #ifdef __cplusplus
521
522
523 void phm_to_imagefile (const PHANTOM *phm, ImageFile& im, const int col_start, const int col_count, const int nsample, const int trace);
524
525 #endif /* __cplusplus */
526
527
528 #endif