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