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