libctsim/phantom.cpp

   1 /*****************************************************************************
   2 ** FILE IDENTIFICATION
   3 **
   4 **     Name:                   phm.cpp
   5 **     Purpose:                Routines for phantom objects
   6 **     Progammer:              Kevin Rosenberg
   7 **     Date Started:           Aug 1984
   8 **
   9 **  This is part of the CTSim program
  10 **  Copyright (C) 1983-2000 Kevin Rosenberg
  11 **
  12 **  $Id: phantom.cpp,v 1.6 2000/07/13 07:03:21 kevin Exp $
  13 **
  14 **  This program is free software; you can redistribute it and/or modify
  15 **  it under the terms of the GNU General Public License (version 2) as
  16 **  published by the Free Software Foundation.
  17 **
  18 **  This program is distributed in the hope that it will be useful,
  19 **  but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 **  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 **  GNU General Public License for more details.
  22 **
  23 **  You should have received a copy of the GNU General Public License
  24 **  along with this program; if not, write to the Free Software
  25 **  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  26 ******************************************************************************/
  27
  28 #include "ct.h"
  29
  30
  31 // CLASS IDENTIFICATION
  32 //   Phanton
  33 //
  34
  35 Phantom::Phantom (void)
  36 {
  37   init ();
  38 }
  39
  40
  41 Phantom::Phantom (const char* const phmName)
  42 {
  43   init ();
  44   createFromPhantom (phmName);
  45 }
  46
  47 void
  48 Phantom::init (void)
  49 {
  50   m_nPElem = 0;
  51   m_xmin = 1E30;
  52   m_xmax = -1E30;
  53   m_ymin = 1E30;
  54   m_ymax = -1E30;
  55   m_diameter = 0;
  56   m_composition = P_PELEMS;
  57   m_fail = false;
  58   m_id = PHM_INVALID;
  59 }
  60
  61 Phantom::~Phantom (void)
  62 {
  63   for (PElemIterator i = m_listPElem.begin(); i != m_listPElem.end(); i++) {
  64     delete *i;
  65   }
  66 }
  67
  68
  69 const char*
  70 Phantom::convertPhantomIDToName (const PhantomID phmID)
  71 {
  72   const char *name = "";
  73
  74   if (phmID == PHM_HERMAN)
  75     name = PHM_HERMAN_STR;
  76   else if (phmID == PHM_BHERMAN)
  77     name = PHM_BHERMAN_STR;
  78   else if (phmID == PHM_ROWLAND)
  79     name = PHM_ROWLAND_STR;
  80   else if (phmID == PHM_BROWLAND)
  81     name = PHM_BROWLAND_STR;
  82   else if (phmID == PHM_UNITPULSE)
  83     name = PHM_UNITPULSE_STR;
  84
  85   return (name);
  86 }
  87
  88 Phantom::PhantomID
  89 Phantom::convertNameToPhantomID (const char* const phmName)
  90 {
  91   PhantomID id = PHM_INVALID;
  92
  93   if (strcasecmp (phmName, PHM_HERMAN_STR) == 0)
  94     id = PHM_HERMAN;
  95   else if (strcasecmp (phmName, PHM_BHERMAN_STR) == 0)
  96     id = PHM_BHERMAN;
  97   else if (strcasecmp (phmName, PHM_ROWLAND_STR) == 0)
  98     id = PHM_ROWLAND;
  99   else if (strcasecmp (phmName, PHM_BROWLAND_STR) == 0)
 100     id = PHM_BROWLAND;
 101   else if (strcasecmp (phmName, PHM_UNITPULSE_STR) == 0)
 102     id = PHM_UNITPULSE;
 103
 104   return (id);
 105 }
 106
 107
 108 bool
 109 Phantom::createFromPhantom (const char* const phmName)
 110 {
 111   PhantomID phmid = convertNameToPhantomID (phmName);
 112   if (phmid == PHM_INVALID) {
 113     m_fail = true;
 114     m_failMessage = "Invalid phantom name ";
 115     m_failMessage += phmName;
 116     return false;
 117   }
 118
 119   m_name = phmName;
 120   createFromPhantom (phmid);
 121   return true;
 122 }
 123
 124 bool
 125 Phantom::createFromPhantom (const PhantomID phmid)
 126 {
 127   switch (phmid)
 128     {
 129     case PHM_HERMAN:
 130       addStdHerman();
 131       break;
 132     case PHM_BHERMAN:
 133       addStdHermanBordered();
 134       break;
 135     case PHM_ROWLAND:
 136       addStdRowland();
 137       break;
 138     case PHM_BROWLAND:
 139       addStdRowlandBordered ();
 140       break;
 141     case PHM_UNITPULSE:
 142       m_composition = P_UNIT_PULSE;
 143       addPElem ("rectangle", 0., 0., 100., 100., 0., 0.);     // outline
 144       addPElem ("ellipse", 0., 0., 1., 1., 0., 1.);           // pulse
 145       break;
 146     default:
 147       m_fail = true;
 148       m_failMessage = "Illegal phantom id ";
 149       m_failMessage += phmid;
 150       return false;
 151     }
 152
 153   m_id = phmid;
 154
 155   return true;
 156 }
 157
 158
 159 /* METHOD IDENTIFICATION
 160  *   createFromFile          Add PhantomElements from file
 161  *
 162  * SYNOPSIS
 163  *   createFromFile (filename)
 164  *
 165  * RETURNS
 166  *   true if pelem were added
 167  *   false if an pelem not added
 168  */
 169
 170 bool
 171 Phantom::createFromFile (const char* const fname)
 172 {
 173   bool stoploop = false;
 174   bool retval = false;
 175   FILE *fp;
 176
 177   if ((fp = fopen (fname, "r")) == NULL)
 178     return (false);
 179
 180   do {
 181     double cx, cy, u, v, rot, dens;
 182     char pelemtype[80];
 183     int n = fscanf (fp, "%79s %lf %lf %lf %lf %lf %lf",
 184                 pelemtype, &cx, &cy, &u, &v, &rot, &dens);
 185
 186     if (n == EOF || n == 0) {   /* end of file */
 187       stoploop = true;
 188       retval = false;
 189     } else if (n != 7) {
 190       stoploop = true;
 191       retval = false;
 192     } else {
 193       addPElem (pelemtype, cx, cy, u, v, rot, dens);
 194       retval = true;
 195     }
 196   } while (stoploop == false);
 197
 198   fclose (fp);
 199
 200   return (retval);
 201 }
 202
 203
 204 /* NAME
 205  *   addPElem           Add pelem
 206  *
 207  * SYNOPSIS
 208  *   addPElem (type, cx, cy, u, v, rot, atten)
 209  *   char *type         type of pelem (box, ellipse, etc)
 210  *   double cx, cy      pelem center
 211  *   double u,v         pelem size
 212  *   double rot         rotation angle of pelem (in degrees)
 213  *   double atten       x-ray attenuation cooefficient
 214  */
 215
 216 void
 217 Phantom::addPElem (const char *type, const double cx, const double cy, const double u, const double v, const double rot, const double atten)
 218 {
 219   PhantomElement *pelem = new PhantomElement (type, cx, cy, u, v, rot, atten);
 220
 221   m_listPElem.push_front (pelem);
 222
 223   // update phantom limits
 224   if (m_xmin > pelem->xmin())    m_xmin = pelem->xmin();
 225   if (m_xmax < pelem->xmax())    m_xmax = pelem->xmax();
 226   if (m_ymin > pelem->ymin())    m_ymin = pelem->ymin();
 227   if (m_ymax < pelem->ymax())    m_ymax = pelem->ymax();
 228
 229   if (m_diameter < pelem->diameter())
 230     m_diameter = pelem->diameter();
 231
 232   //  m_diameter = lineLength(m_xmin, m_ymin, m_xmax, m_ymax);
 233
 234   m_nPElem++;
 235 }
 236
 237
 238 /*----------------------------------------------------------------------*/
 239 /*                      Input-Output Routines                           */
 240 /*----------------------------------------------------------------------*/
 241
 242
 243 /* NAME
 244  *   print                              Print vertices of Phantom pelems
 245  *
 246  * SYNOPSIS
 247  *   print (phm)
 248  */
 249
 250 void
 251 Phantom::print (void) const
 252 {
 253   printf("PRINTING Phantom\n\n");
 254   printf("number of pelems in Phantom = %d\n", m_nPElem);
 255   printf("limits: xmin=%8.2g  ymin=%8.2g  xmax=%8.2g  ymax=%8.2g\n",
 256          m_xmin, m_ymin, m_xmax, m_ymax);
 257
 258   for (PElemIterator i = m_listPElem.begin(); i != m_listPElem.end(); i++) {
 259       printf("PELEM:\n");
 260       printf("# pts=%3d atten = %7.4f   rot = %7.2f (deg)\n",
 261              (*i)->nOutlinePoints(), (*i)->atten(), convertRadiansToDegrees ((*i)->rot()));
 262
 263     printf("xmin=%7.3g  ymin=%7.3g  xmax=%7.3g  ymax=%7.3g\n",
 264            (*i)->xmin(), (*i)->ymin(), (*i)->xmax(), (*i)->ymax());
 265
 266     //    for (int i = 0; i < m_nPoints; i++)
 267     //      printf("\t%8.3g    %8.3g\n", i->xOutline()[i], i->yOutline()[i]);
 268   }
 269 }
 270
 271
 272 /* NAME
 273  *   show               Show vector outline of Phantom to user
 274  *
 275  * SYNOPSIS
 276  *   show (pic)
 277  */
 278
 279 #ifdef HAVE_SGP
 280 void
 281 Phantom::show (void) const
 282 {
 283   double wsize = m_xmax - m_xmin;
 284   double xmin = m_xmin;
 285   double ymin = m_ymin;
 286   double xmax, ymax;
 287   SGP_ID gid;
 288
 289   if ((m_ymax - m_ymin) > wsize)
 290       wsize = m_ymax - m_ymin;
 291   wsize *= 1.1;
 292
 293   xmax = xmin + wsize;
 294   ymax = ymin + wsize;
 295
 296   printf("Drawing Phantom:\n\n");
 297   printf("    data limits: %9.3g, %9.3g, %9.3g, %9.3g\n",
 298          m_xmin, m_ymin, m_xmax, m_ymax);
 299   printf("    window size: %9.3g, %9.3g, %9.3g, %9.3g\n",
 300          xmin, ymin, xmax, ymax);
 301
 302   gid = sgp2_init(0, 0, "Phantom Show");
 303   sgp2_window (xmin, ymin, xmax, ymax);
 304
 305   draw();
 306
 307   termgrf2();
 308 }
 309 #endif
 310
 311
 312 /* NAME
 313  *   draw               Draw vector outline of Phantom
 314  *
 315  * SYNOPSIS
 316  *   draw ()
 317  */
 318
 319 #ifdef HAVE_SGP
 320 void
 321 Phantom::draw (void) const
 322 {
 323   for (PElemIterator i = m_listPElem.begin(); i != m_listPElem.end(); i++)
 324     sgp2_polyline_abs ((*i)->xOutline(), (*i)->yOutline(), (*i)->nOutlinePoints());
 325 }
 326 #endif
 327
 328
 329 /* NAME
 330  *   addStdRowland              Make head phantom of S.W. Rowland
 331  *
 332  * REFERENCES
 333  *   S. W. Rowland, "Computer Implementation of Image Reconstruction
 334  *      Formulas", in "Image Reconstruction from Projections: Implementation
 335  *      and Applications", edited by G. T. Herman, 1978.
 336  */
 337
 338 void
 339 Phantom::addStdRowland (void)
 340 {
 341   addPElem("ellipse",  0.0000,  0.0000, 0.6900,  0.9200,   0.0,  1.00);
 342   addPElem("ellipse",  0.0000, -0.0184, 0.6624,  0.8740,   0.0, -0.98);
 343   addPElem("ellipse",  0.2200,  0.0000, 0.1100,  0.3100, -18.0, -0.02);
 344   addPElem("ellipse", -0.2200,  0.0000, 0.1600,  0.4100,  18.0, -0.02);
 345   addPElem("ellipse",  0.0000,  0.3500, 0.2100,  0.2500,   0.0,  0.01);
 346   addPElem("ellipse",  0.0000,  0.1000, 0.0460,  0.0460,   0.0,  0.01);
 347   addPElem("ellipse",  0.0000, -0.1000, 0.0460,  0.0460,   0.0,  0.01);
 348   addPElem("ellipse", -0.0800, -0.6050, 0.0460,  0.0230,   0.0,  0.01);
 349   addPElem("ellipse",  0.0000, -0.6050, 0.0230,  0.0230,   0.0,  0.01);
 350   addPElem("ellipse",  0.0600, -0.6050, 0.0230,  0.0230,   0.0,  0.01);
 351   addPElem("ellipse",  0.5538, -0.3858, 0.0330,  0.2060, -18.0,  0.03);
 352 }
 353
 354 void
 355 Phantom::addStdRowlandBordered (void)
 356 {
 357   addStdRowland ();
 358   addPElem ("ellipse", 0.000, 0.0000, 0.7500, 1.000, 0.0, 0.00);
 359 }
 360
 361 /* NAME
 362  *   addStdHerman                       Standard head phantom of G. T. Herman
 363  *
 364  * REFERENCES
 365  *   G. T. Herman, "Image Reconstructions from Projections:  The Fundementals
 366  *      of Computed Tomography", 1979.
 367  */
 368
 369 void
 370 Phantom::addStdHerman (void)
 371 {
 372   addPElem("ellipse",  0.000,  1.50,  0.375, 0.3000,  90.00, -0.003);
 373   addPElem("ellipse",  0.675, -0.75,  0.225, 0.1500, 140.00,  0.010);
 374   addPElem("ellipse",  0.750,  1.50,  0.375, 0.2250,  50.00,  0.003);
 375   addPElem("segment",  1.375, -7.50,  1.100, 0.6250,  19.20, -0.204);
 376   addPElem("segment",  1.375, -7.50,  1.100, 4.3200,  19.21,  0.204);
 377   addPElem("segment",  0.000, -2.25,  1.125, 0.3750,   0.00, -0.003);
 378   addPElem("segment",  0.000, -2.25,  1.125, 3.0000,   0.00,  0.003);
 379   addPElem("segment", -1.000,  3.75,  1.000, 0.5000, 135.00, -0.003);
 380   addPElem("segment", -1.000,  3.75,  1.000, 3.0000, 135.00,  0.003);
 381   addPElem("segment",  1.000,  3.75,  1.000, 0.5000, 225.00, -0.003);
 382   addPElem("segment",  1.000,  3.75,  1.000, 3.0000, 225.00,  0.003);
 383   addPElem("triangle", 5.025,  3.75,  1.125, 0.5000, 110.75,  0.206);
 384   addPElem("triangle",-5.025,  3.75,  1.125, 0.9000,-110.75,  0.206);
 385   addPElem("ellipse",  0.000,  0.00,  8.625, 6.4687,  90.00,  0.416);
 386   addPElem("ellipse",  0.000,  0.00,  7.875, 5.7187,  90.00, -0.206);
 387 }
 388
 389 void
 390 Phantom::addStdHermanBordered (void)
 391 {
 392   addPElem("ellipse", 0., 0., 6.6, 5.9, 90., 0.);
 393 }
 394
 395
 396 /* NAME
 397  *    convertToImagefile                Make image array from Phantom
 398  *
 399  * SYNOPSIS
 400  *    pic_to_imagefile (pic, im, nsample)
 401  *    Phantom& pic              Phantom definitions
 402  *    ImageFile  *im            Computed pixel array
 403  *    int nsample               Number of samples along each axis for each pixel
 404  *                              (total samples per pixel = nsample * nsample)
 405  */
 406
 407 void
 408 Phantom::convertToImagefile (ImageFile& im, const int in_nsample, const int trace) const
 409 {
 410   convertToImagefile (im, in_nsample, trace, 0, im.nx());
 411 }
 412
 413 void
 414 Phantom::convertToImagefile (ImageFile& im, const int in_nsample, const int trace, const int colStart, const int colCount) const
 415 {
 416   int nx = im.nx();
 417   int ny = im.ny();
 418   if (nx < 2 || ny < 2)
 419       return;
 420
 421   int nsample = in_nsample;
 422   if (nsample < 1)
 423     nsample = 1;
 424
 425   double dx = m_xmax - m_xmin;
 426   double dy = m_ymax - m_ymin;
 427   double xcent = m_xmin + dx / 2;
 428   double ycent = m_ymin + dy / 2;
 429   double phmlen = (dx > dy ? dx : dy);
 430
 431   double phmradius = phmlen / 2;
 432
 433   double xmin = xcent - phmradius;
 434   double xmax = xcent + phmradius;
 435   double ymin = ycent - phmradius;
 436   double ymax = ycent + phmradius;
 437
 438   // Each pixel holds the average of the intensity of the cell with (ix,iy) at the center of the pixel
 439   // Set major increments so that the last cell v[nx-1][ny-1] will start at xmax - xinc, ymax - yinc).
 440   // Set minor increments so that sample points are centered in cell
 441
 442   double xinc = (xmax - xmin) / nx;
 443   double yinc = (ymax - ymin) / ny;
 444
 445   double kxinc = xinc / nsample;                /* interval between samples */
 446   double kyinc = yinc / nsample;
 447   double kxofs = kxinc / 2;             /* offset of 1st point */
 448   double kyofs = kyinc / 2;
 449
 450   im.setAxisExtent (xmin, xmax, ymin, ymax);
 451   im.setAxisIncrement (xinc, yinc);
 452
 453   ImageFileArray v = im.getArray();
 454
 455   double x_start = xmin + (colStart * xinc);
 456   for (PElemConstIterator pelem = m_listPElem.begin(); pelem != m_listPElem.end(); pelem++) {
 457     double x, y, xi, yi;
 458     int ix, iy, kx, ky;
 459     for (ix = 0, x = x_start; ix < colCount; ix++, x += xinc) {
 460       for (iy = 0, y = ymin; iy < ny; iy++, y += yinc) {
 461         for (kx = 0, xi = x + kxofs; kx < nsample; kx++, xi += kxinc) {
 462           for (ky = 0, yi = y + kyofs; ky < nsample; ky++, yi += kyinc)
 463             if ((*pelem)->isPointInside (xi, yi, PHM_COORD) == TRUE)
 464               v[ix][iy] += (*pelem)->atten();
 465         } // for kx
 466       } /* for iy */
 467     }  /* for ix */
 468   }  /* for pelem */
 469
 470
 471   if (nsample > 1) {
 472     double factor = 1.0 / (nsample * nsample);
 473
 474     for (int ix = 0; ix < colCount; ix++)
 475       for (int iy = 0; iy < ny; iy++)
 476         v[ix][iy] *= factor;
 477   }
 478 }
 479
 480 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 481 // CLASS IDENTIFICATION
 482 //
 483 //      PhantomElement
 484 //
 485 // PURPOSE
 486 //
 487 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 488
 489
 490 PhantomElement::PhantomElement (const char *type, const double cx, const double cy, const double u, const double v, const double rot, const double atten)
 491     : m_cx(cx), m_cy(cy), m_u(u), m_v(v), m_atten(atten), m_nPoints(0), m_xOutline(0), m_yOutline(0)
 492 {
 493   m_rot = convertDegreesToRadians (rot);   // convert angle to radians
 494
 495   m_type = convertNameToType (type);
 496
 497   makeTransformMatrices ();     // calc transform matrices between phantom and normalized phantomelement
 498   makeVectorOutline ();         // calculate vector outline of pelem
 499
 500   // Find maximum diameter of Object
 501   double r2Max = 0;
 502   for (int i = 0; i < m_nPoints; i++) {
 503     double r2 = (m_xOutline[i] * m_xOutline[i]) + (m_yOutline[i] * m_yOutline[i]);
 504     if (r2 > r2Max)
 505       r2Max = r2;
 506   }
 507   m_diameter = 2 * sqrt( r2Max );
 508
 509   m_rectLimits[0] = m_xmin;   m_rectLimits[1] = m_ymin;
 510   m_rectLimits[2] = m_xmax;   m_rectLimits[3] = m_ymax;
 511 }
 512
 513
 514 PhantomElement::~PhantomElement (void)
 515 {
 516     delete m_xOutline;
 517     delete m_yOutline;
 518 }
 519
 520 PhmElemType
 521 PhantomElement::convertNameToType (const char* const typeName)
 522 {
 523     PhmElemType type = PELEM_INVALID;
 524
 525     if (strcasecmp (typeName, "rectangle") == 0)
 526         type = PELEM_RECTANGLE;
 527     else if (strcasecmp (typeName, "triangle") == 0)
 528         type = PELEM_TRIANGLE;
 529     else if (strcasecmp (typeName, "ellipse") == 0)
 530         type = PELEM_ELLIPSE;
 531     else if (strcasecmp (typeName, "sector") == 0)
 532         type = PELEM_SECTOR;
 533     else if (strcasecmp (typeName, "segment") == 0)
 534       type = PELEM_SEGMENT;
 535     else
 536         sys_error (ERR_WARNING, "Unknown PhantomElement type %s [PhantomElement::PhantomElement]", type);
 537
 538     return (type);
 539 }
 540
 541 void
 542 PhantomElement::makeTransformMatrices (void)
 543 {
 544   GRFMTX_2D temp;
 545
 546   // To map normalized Pelem coords to world Phantom
 547   //     scale by (u, v)
 548   //     rotate by rot
 549   //     translate by (cx, cy)
 550
 551   scale_mtx2 (m_xformObjToPhm, m_u, m_v);
 552   rot_mtx2  (temp, m_rot);
 553   mult_mtx2 (m_xformObjToPhm, temp, m_xformObjToPhm);
 554   xlat_mtx2 (temp, m_cx, m_cy);
 555   mult_mtx2 (m_xformObjToPhm, temp, m_xformObjToPhm);
 556
 557   // to map world Phantom coodinates to normalized PElem coords
 558   //     translate by (-cx, -cy)
 559   //     rotate by -rot
 560   //     scale by (1/u, 1/v)
 561
 562   xlat_mtx2 (m_xformPhmToObj, -m_cx, -m_cy);
 563   rot_mtx2  (temp, -m_rot);
 564   mult_mtx2 (m_xformPhmToObj, temp, m_xformPhmToObj);
 565   scale_mtx2 (temp, 1 / m_u, 1 / m_v);
 566   mult_mtx2 (m_xformPhmToObj, temp, m_xformPhmToObj);
 567 }
 568
 569
 570 /* NAME
 571  *   pelem_make_points          INTERNAL routine to calculate point array for an pelem
 572  *
 573  * SYNOPSIS
 574  *   makepelempts (pelem)
 575  *   PELEM *pelem       pelem whose points we are calculating
 576  *
 577  * NOTES
 578  *   Called by phm_add_pelem()
 579  */
 580
 581 void
 582 PhantomElement::makeVectorOutline (void)
 583 {
 584   double radius, theta, start, stop;
 585   double xfact, yfact;
 586   int cpts;
 587
 588   m_nPoints = 0;
 589   switch (m_type) {
 590   case PELEM_RECTANGLE:
 591     m_nPoints = 5;
 592     m_xOutline = new double [m_nPoints];
 593     m_yOutline = new double [m_nPoints];
 594     m_xOutline[0] =-m_u;        m_yOutline[0] =-m_v;
 595     m_xOutline[1] = m_u;        m_yOutline[1] =-m_v;
 596     m_xOutline[2] = m_u;        m_yOutline[2] = m_v;
 597     m_xOutline[3] =-m_u;        m_yOutline[3] = m_v;
 598     m_xOutline[4] =-m_u;        m_yOutline[4] =-m_v;
 599     break;
 600   case PELEM_TRIANGLE:
 601     m_nPoints = 4;
 602     m_xOutline = new double [m_nPoints];
 603     m_yOutline = new double [m_nPoints];
 604     m_xOutline[0] =-m_u;        m_yOutline[0] = 0.0;
 605     m_xOutline[1] = m_u;        m_yOutline[1] = 0.0;
 606     m_xOutline[2] = 0.0;        m_yOutline[2] = m_v;
 607     m_xOutline[3] =-m_u;        m_yOutline[3] = 0.0;
 608     break;
 609   case PELEM_ELLIPSE:
 610     cpts = numCirclePoints (TWOPI);
 611     m_nPoints = cpts;
 612     m_xOutline = new double [m_nPoints];
 613     m_yOutline = new double [m_nPoints];
 614     calcEllipsePoints (m_xOutline, m_yOutline, cpts, m_u, m_v);
 615     break;
 616   case PELEM_SECTOR:
 617     radius = sqrt(m_u * m_u + m_v * m_v);
 618     theta = atan(m_u / m_v);            // angle with y-axis
 619     start = 3.0 * HALFPI - theta;
 620     stop  = 3.0 * HALFPI + theta;
 621     cpts = numCirclePoints (stop - start);
 622     m_nPoints = 3 + cpts;
 623     m_xOutline = new double [m_nPoints];
 624     m_yOutline = new double [m_nPoints];
 625
 626     m_xOutline[0] = 0.0;                m_yOutline[0] = m_v;
 627     m_xOutline[1] =-m_u;                m_yOutline[1] = 0.0;
 628     calcArcPoints (&m_xOutline[2], &m_yOutline[2], cpts, 0.0, m_v, radius, start, stop);
 629     m_xOutline[cpts + 2] = 0.0;
 630     m_yOutline[cpts + 2] = m_v;
 631     break;
 632   case PELEM_SEGMENT:
 633     radius = sqrt(m_u * m_u + m_v * m_v);
 634     theta = atan (m_u / m_v);           // angle with y-axis
 635     start = 3.0 * HALFPI - theta;
 636     stop  = 3.0 * HALFPI + theta;
 637
 638     cpts = numCirclePoints (stop - start);
 639     m_nPoints = cpts + 1;
 640     m_xOutline = new double [m_nPoints];
 641     m_yOutline = new double [m_nPoints];
 642
 643     calcArcPoints (m_xOutline, m_yOutline, cpts, 0.0, m_v, radius, start, stop);
 644     m_xOutline[cpts] = -m_u;
 645     m_yOutline[cpts] = 0.0;
 646     break;
 647   default:
 648     sys_error(ERR_WARNING, "illegal pelem type %d [makeVectorOutline]", m_type);
 649     return;
 650   }
 651
 652   rotate2d (m_xOutline, m_yOutline, m_nPoints, m_rot);
 653   xlat2d (m_xOutline, m_yOutline, m_nPoints, m_cx, m_cy);
 654
 655   minmax_array (m_xOutline, m_nPoints, m_xmin, m_xmax);
 656   minmax_array (m_yOutline, m_nPoints, m_ymin, m_ymax);
 657
 658   // increase pelem extent by SCALE_PELEM_EXTENT to eliminate chance of
 659   //   missing actual pelem maximum due to polygonal sampling
 660
 661   xfact = (m_xmax - m_xmin) * SCALE_PELEM_EXTENT;
 662   yfact = (m_ymax - m_ymin) * SCALE_PELEM_EXTENT;
 663
 664   m_xmin -= xfact;
 665   m_ymin -= yfact;
 666   m_xmax += xfact;
 667   m_ymax += yfact;
 668 }
 669
 670
 671 /* NAME
 672  *   calc_arc                   Calculate outline of a arc of a circle
 673  *
 674  * SYNOPSIS
 675  *   calc_arc (x, y, xcent, ycent, pts, r, start, stop)
 676  *   double x[], y[];           Array of points
 677  *   int pts                    Number of points in array
 678  *   double xcent, ycent        Center of cirlce
 679  *   double r                   Radius of circle
 680  *   double start, stop         Beginning & ending angles
 681  */
 682
 683 void
 684 PhantomElement::calcArcPoints (double x[], double y[], const int pts, const double xcent, const double ycent, const double r, const double start, const double stop)
 685 {
 686     if (r <= 0.0)
 687         sys_error (ERR_WARNING, "negative or zero radius in calc_arc()");
 688
 689     double theta = (stop - start) / (pts - 1);  // angle incr. between points
 690     double c = cos(theta);
 691     double s = sin(theta);
 692
 693     x[0] = r * cos (start) + xcent;
 694     y[0] = r * sin (start) + ycent;
 695
 696     double xp = x[0] - xcent;
 697     double yp = y[0] - ycent;
 698     for (int i = 1; i < pts; i++) {
 699         double xc = c * xp - s * yp;
 700         double yc = s * xp + c * yp;
 701         x[i] = xc + xcent;
 702         y[i] = yc + ycent;
 703         xp = xc;  yp = yc;
 704     }
 705 }
 706
 707
 708 // NAME
 709 //   PhantomElement::calcEllipsePoints    Calculate outline of a ellipse
 710 //
 711 // SYNOPSIS
 712 //   calcEllipsePoints ()
 713 //
 714
 715
 716 void
 717 PhantomElement::calcEllipsePoints (double x[], double y[], const int pts, const double u, const double v)
 718 {
 719     calcArcPoints (x, y, m_nPoints, 0.0, 0.0, 1.0, 0.0, TWOPI);   // make a unit circle
 720     scale2d (x, y, m_nPoints, m_u, m_v);                             // scale to ellipse
 721 }
 722
 723
 724 /* NAME
 725  *   circle_pts         Calculate number of points to use for circle segment
 726  *
 727  * SYNOPSIS
 728  *   n = circle_pts (theta)
 729  *   int n              Number of points to use for arc
 730  *   double theta       Length of arc in radians
 731  */
 732
 733 int
 734 PhantomElement::numCirclePoints (double theta)
 735 {
 736     theta = clamp (theta, 0., TWOPI);
 737
 738     return static_cast<int> (POINTS_PER_CIRCLE * theta / TWOPI + 1.5);
 739 }
 740
 741
 742 bool
 743 PhantomElement::clipLineWorldCoords (double& x1, double& y1, double& x2, double &y2) const
 744 {
 745   /* check if ray is outside of pelem extents */
 746   double cx1 = x1, cy1 = y1, cx2 = x2, cy2 = y2;
 747   if (! clip_rect (cx1, cy1, cx2, cy2, m_rectLimits))
 748     return false;
 749
 750   // convert phantom coordinates to pelem coordinates
 751   xform_mtx2 (m_xformPhmToObj, x1, y1);
 752   xform_mtx2 (m_xformPhmToObj, x2, y2);
 753
 754   if (! clipLineNormalizedCoords (x1, y1, x2, y2))
 755     return false;
 756
 757   // convert standard pelem coordinates back to phantom coordinates
 758   xform_mtx2 (m_xformObjToPhm, x1, y1);
 759   xform_mtx2 (m_xformObjToPhm, x2, y2);
 760
 761   return true;
 762 }
 763
 764
 765 /* NAME
 766  *   pelem_clip_line                    Clip pelem against an arbitrary line
 767  *
 768  * SYNOPSIS
 769  *   pelem_clip_line (pelem, x1, y1, x2, y2)
 770  *   PhantomElement& pelem;             Pelem to be clipped
 771  *   double *x1, *y1, *x2, *y2  Endpoints of line to be clipped
 772  *
 773  * RETURNS
 774  *   true   if line passes through pelem
 775  *              (x1, y1, x2, y2 hold coordinates of new line)
 776  *   false  if line do not pass through pelem
 777  *              (x1, y1, x2, y2 are undefined)
 778  */
 779
 780 bool
 781 PhantomElement::clipLineNormalizedCoords (double& x1, double& y1, double& x2, double& y2) const
 782 {
 783   bool accept = false;
 784
 785   switch (m_type) {
 786   case PELEM_RECTANGLE:
 787     double rect[4];
 788     rect[0] = -1.0;  rect[1] = -1.0;
 789     rect[2] = 1.0;  rect[3] = 1.0;
 790     accept = clip_rect (x1, y1, x2, y2, rect);
 791     break;
 792   case PELEM_ELLIPSE:
 793     accept = clip_circle (x1, y1, x2, y2, 0.0, 0.0, 1.0, 0.0, 0.0);
 794     break;
 795   case PELEM_TRIANGLE:
 796     accept = clip_triangle (x1, y1, x2, y2, 1.0, 1.0, true);
 797     break;
 798   case PELEM_SEGMENT:
 799     accept = clip_segment (x1, y1, x2, y2, m_u, m_v);
 800     break;
 801   case PELEM_SECTOR:
 802     accept = clip_sector (x1, y1, x2, y2, m_u, m_v);
 803     break;
 804   default:
 805     sys_error (ERR_WARNING, "Illegal pelem type %d [pelem_clip_line]", m_type);
 806     break;
 807   }
 808
 809   return(accept);
 810 }
 811
 812
 813 // METHOD IDENTIFICATION
 814 //    PhantomElement::isPointInside             Check if point is inside pelem
 815 //
 816 // SYNOPSIS
 817 //    is_point_inside (pelem, x, y, coord_type)
 818 //    double x, y               Point to see if lies in pelem
 819 //    int coord_type            Coordinate type (PELEM_COORD or PHM_COORD)
 820 //
 821 // RETURNS
 822 //    true if point lies within pelem
 823 //    false if point lies outside of pelem
 824
 825 bool
 826 PhantomElement::isPointInside (double x, double y, const CoordType coord_type)
 827 {
 828   if (coord_type == PHM_COORD) {
 829     xform_mtx2 (m_xformPhmToObj, x, y);
 830   } else if (coord_type != PELEM_COORD) {
 831     sys_error(ERR_WARNING, "Illegal coordinate type in pelem_is_point_inside");
 832     return (false);
 833   }
 834
 835   switch (m_type) {
 836   case PELEM_RECTANGLE:
 837     if (x > 1. || x < -1. || y > 1. || y < -1.)
 838       return (false);
 839     else
 840       return (true);
 841     break;
 842   case PELEM_TRIANGLE:
 843     if (y < 0. || y > 1. - x || y > 1. + x)
 844       return (false);
 845     else
 846       return (true);
 847     break;
 848   case PELEM_ELLIPSE:
 849     if (x > 1. || x < -1. || y > 1. || y < -1.)
 850       return (false);
 851     if (x * x + y * y > 1.)             // check if inside unit circle
 852       return (false);
 853     else
 854       return (true);
 855     break;
 856
 857     // for clipping segments & sectors, must NOT scale by (1/u, 1/v)
 858     // because this destroys information about size of arc component
 859
 860   case PELEM_SEGMENT:
 861     if (x > 1. || x < -1. || y > 0.)
 862         return (false);         // clip against y > 0
 863     x *= m_u;                   // put back u & v scale
 864     y *= m_v;
 865     if (x * x + (y-m_v) * (y-m_v) > m_u * m_u + m_v * m_v)
 866       return (false);           // clip against circle, r = sqrt(@)
 867     else
 868       return (true);
 869     break;
 870   case PELEM_SECTOR:
 871       if (x > 1. || x < -1. || y > 1.)   // extent
 872       return (false);
 873       if (y > 1. - x || y > 1. + x)      // triangle
 874           return (false);                      // clip against triangle
 875       x *= m_u;                // circle: put back u & v scale
 876     y *= m_v;
 877     if (x * x + (y-m_v) * (y-m_v) > m_u * m_u + m_v * m_v)
 878         return (false);                // clip against circle
 879     else
 880       return (true);
 881   break;
 882   default:
 883     sys_error (ERR_WARNING, "Illegal pelem type in pelem_is_point_inside()");
 884     break;
 885   }
 886
 887   return (false);
 888 }
 889
 890