r55: Updated documentation
[ctsim.git] / include / ir.h
index 96b21290e5b4618af1a18c95daf1cd007bff64fc..08cdd1d9b2014381b8ecb8eb710ab8ece91ca943 100644 (file)
@@ -2,8 +2,11 @@
 **  This is part of the CTSim program
 **  Copyright (C) 1983-2000 Kevin Rosenberg
 **
-**  $Id: ir.h,v 1.14 2000/05/11 14:07:00 kevin Exp $
+**  $Id: ir.h,v 1.15 2000/05/16 04:33:17 kevin Exp $
 **  $Log: ir.h,v $
+**  Revision 1.15  2000/05/16 04:33:17  kevin
+**  Updated documentation
+**
 **  Revision 1.14  2000/05/11 14:07:00  kevin
 **  Added support for Windows NT
 **
@@ -203,10 +206,10 @@ struct detector_st {
 typedef struct detector_st DETECTOR;
 
 struct raysum_st {
-  int fd;
-  int file_mode;
-  int header_size;
-  int geometry;
+  int fd;                      /* Disk file descriptor */
+  int file_mode;               /* Current file mode (read or write) */
+  int header_size;             /* Size of disk file header */
+  int geometry;                        /* Geometry of scanner */
   struct detarray_st **view;   /* Pointer to array of detarray_st pointers */
 
   char remark[MAXREMARK+1];    /* description of raysum data */
@@ -420,22 +423,23 @@ IMAGE *image_load(const char *fname);
 void image_filter_response(IMAGE *im, int domain, double bw, int filt_type, double filt_param, int opt_trace);
 
 /* options.c */
-int opt_set_trace(const char *optarg, const char *program);
+int opt_set_trace(const char *optarg);
 const char *name_of_phantom(const int phmid);
-int opt_set_phantom(const char *optarg, const char *program);
-int opt_set_interpolation(const char *optarg, const char *program);
+int opt_set_phantom(const char *optarg);
+int opt_set_interpolation(const char *optarg);
 const char *name_of_interpolation(int interp_type);
-int opt_set_filter(const char *optarg, const char *program);
+int opt_set_filter(const char *optarg);
 const char *name_of_filter(const int filter);
-DomainType opt_set_filter_domain(const char *optarg, const char *program);
+DomainType opt_set_filter_domain(const char *optarg);
 const char *name_of_filter_domain(const DomainType domain);
-int opt_set_backproj(const char *optarg, const char *program);
+int opt_set_backproj(const char *optarg);
 const char *name_of_backproj(const BackprojType backproj);
 
 /* phm.c */
 PHANTOM *phm_create(const int phmid);
 PHANTOM *phm_create_from_file(const char *fname);
 PHANTOM *phm_init(void);
+void phm_free (PHANTOM *phm);
 int phm_add_pelm_file(PHANTOM *phm, const char *fname);
 void phm_add_pelm (PHANTOM *phm, const char *type, const double cx, const double cy, 
               const double u, const double v, const double rot, const double atten);