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