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