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.11 2000/07/28 08:28:08 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   draw (sgp);
 312
 313   cout << "Press return to continue";
 314   cio_kb_getc();
 315 }
 316 #endif
 317
 318
 319 /* NAME
 320  *   draw               Draw vector outline of Phantom
 321  *
 322  * SYNOPSIS
 323  *   draw ()
 324  */
 325
 326 #ifdef HAVE_SGP
 327 void
 328 Phantom::draw (SGP& sgp) const
 329 {
 330   double wsize = m_xmax - m_xmin;
 331   double xmin = m_xmin;
 332   double ymin = m_ymin;
 333
 334   if ((m_ymax - m_ymin) > wsize)
 335       wsize = m_ymax - m_ymin;
 336   wsize *= 1.1;
 337
 338   double xmax = xmin + wsize;
 339   double ymax = ymin + wsize;
 340
 341   sgp.setWindow (xmin, ymin, xmax, ymax);
 342   for (PElemIterator i = m_listPElem.begin(); i != m_listPElem.end(); i++)
 343     sgp.polylineAbs ((*i)->xOutline(), (*i)->yOutline(), (*i)->nOutlinePoints());
 344 }
 345 #endif
 346
 347
 348 /* NAME
 349  *   addStdRowland              Make head phantom of S.W. Rowland
 350  *
 351  * REFERENCES
 352  *   S. W. Rowland, "Computer Implementation of Image Reconstruction
 353  *      Formulas", in "Image Reconstruction from Projections: Implementation
 354  *      and Applications", edited by G. T. Herman, 1978.
 355  */
 356
 357 void
 358 Phantom::addStdRowland ()
 359 {
 360   addPElem ("ellipse",  0.0000,  0.0000, 0.6900,  0.9200,   0.0,  1.00);
 361   addPElem ("ellipse",  0.0000, -0.0184, 0.6624,  0.8740,   0.0, -0.98);
 362   addPElem ("ellipse",  0.2200,  0.0000, 0.1100,  0.3100, -18.0, -0.02);
 363   addPElem ("ellipse", -0.2200,  0.0000, 0.1600,  0.4100,  18.0, -0.02);
 364   addPElem ("ellipse",  0.0000,  0.3500, 0.2100,  0.2500,   0.0,  0.01);
 365   addPElem ("ellipse",  0.0000,  0.1000, 0.0460,  0.0460,   0.0,  0.01);
 366   addPElem ("ellipse",  0.0000, -0.1000, 0.0460,  0.0460,   0.0,  0.01);
 367   addPElem ("ellipse", -0.0800, -0.6050, 0.0460,  0.0230,   0.0,  0.01);
 368   addPElem ("ellipse",  0.0000, -0.6050, 0.0230,  0.0230,   0.0,  0.01);
 369   addPElem ("ellipse",  0.0600, -0.6050, 0.0230,  0.0230,   0.0,  0.01);
 370   addPElem ("ellipse",  0.5538, -0.3858, 0.0330,  0.2060, -18.0,  0.03);
 371 }
 372
 373 void
 374 Phantom::addStdRowlandBordered ()
 375 {
 376   addStdRowland ();
 377   addPElem ("ellipse", 0.000, 0.0000, 0.7500, 1.000, 0.0, 0.00);
 378 }
 379
 380 /* NAME
 381  *   addStdHerman                       Standard head phantom of G. T. Herman
 382  *
 383  * REFERENCES
 384  *   G. T. Herman, "Image Reconstructions from Projections:  The Fundementals
 385  *      of Computed Tomography", 1979.
 386  */
 387
 388 void
 389 Phantom::addStdHerman ()
 390 {
 391   addPElem ("ellipse",  0.000,  1.50,  0.375, 0.3000,  90.00, -0.003);
 392   addPElem ("ellipse",  0.675, -0.75,  0.225, 0.1500, 140.00,  0.010);
 393   addPElem ("ellipse",  0.750,  1.50,  0.375, 0.2250,  50.00,  0.003);
 394   addPElem ("segment",  1.375, -7.50,  1.100, 0.6250,  19.20, -0.204);
 395   addPElem ("segment",  1.375, -7.50,  1.100, 4.3200,  19.21,  0.204);
 396   addPElem ("segment",  0.000, -2.25,  1.125, 0.3750,   0.00, -0.003);
 397   addPElem ("segment",  0.000, -2.25,  1.125, 3.0000,   0.00,  0.003);
 398   addPElem ("segment", -1.000,  3.75,  1.000, 0.5000, 135.00, -0.003);
 399   addPElem ("segment", -1.000,  3.75,  1.000, 3.0000, 135.00,  0.003);
 400   addPElem ("segment",  1.000,  3.75,  1.000, 0.5000, 225.00, -0.003);
 401   addPElem ("segment",  1.000,  3.75,  1.000, 3.0000, 225.00,  0.003);
 402   addPElem ("triangle", 5.025,  3.75,  1.125, 0.5000, 110.75,  0.206);
 403   addPElem ("triangle",-5.025,  3.75,  1.125, 0.9000,-110.75,  0.206);
 404   addPElem ("ellipse",  0.000,  0.00,  8.625, 6.4687,  90.00,  0.416);
 405   addPElem ("ellipse",  0.000,  0.00,  7.875, 5.7187,  90.00, -0.206);
 406 }
 407
 408 void
 409 Phantom::addStdHermanBordered ()
 410 {
 411   addStdHerman();
 412   addPElem ("ellipse",  0.000, 0.000, 8.650, 8.650,  0.00, 0.000);
 413 }
 414
 415
 416 /* NAME
 417  *    convertToImagefile                Make image array from Phantom
 418  *
 419  * SYNOPSIS
 420  *    pic_to_imagefile (pic, im, nsample)
 421  *    Phantom& pic              Phantom definitions
 422  *    ImageFile  *im            Computed pixel array
 423  *    int nsample               Number of samples along each axis for each pixel
 424  *                              (total samples per pixel = nsample * nsample)
 425  */
 426
 427 void
 428 Phantom::convertToImagefile (ImageFile& im, const int in_nsample, const int trace) const
 429 {
 430   convertToImagefile (im, in_nsample, trace, 0, im.nx());
 431 }
 432
 433 void
 434 Phantom::convertToImagefile (ImageFile& im, const int in_nsample, const int trace, const int colStart, const int colCount) const
 435 {
 436   int nx = im.nx();
 437   int ny = im.ny();
 438   if (nx < 2 || ny < 2)
 439       return;
 440
 441   int nsample = in_nsample;
 442   if (nsample < 1)
 443     nsample = 1;
 444
 445   double dx = m_xmax - m_xmin;
 446   double dy = m_ymax - m_ymin;
 447   double xcent = m_xmin + dx / 2;
 448   double ycent = m_ymin + dy / 2;
 449   double phmlen = (dx > dy ? dx : dy);
 450
 451   double phmradius = phmlen / 2;
 452
 453   double xmin = xcent - phmradius;
 454   double xmax = xcent + phmradius;
 455   double ymin = ycent - phmradius;
 456   double ymax = ycent + phmradius;
 457
 458   // Each pixel holds the average of the intensity of the cell with (ix,iy) at the center of the pixel
 459   // Set major increments so that the last cell v[nx-1][ny-1] will start at xmax - xinc, ymax - yinc).
 460   // Set minor increments so that sample points are centered in cell
 461
 462   double xinc = (xmax - xmin) / nx;
 463   double yinc = (ymax - ymin) / ny;
 464
 465   double kxinc = xinc / nsample;                /* interval between samples */
 466   double kyinc = yinc / nsample;
 467   double kxofs = kxinc / 2;             /* offset of 1st point */
 468   double kyofs = kyinc / 2;
 469
 470   im.setAxisExtent (xmin, xmax, ymin, ymax);
 471   im.setAxisIncrement (xinc, yinc);
 472
 473   ImageFileArray v = im.getArray();
 474
 475   for (int ix = 0; ix < colCount; ix++)
 476       for (int iy = 0; iy < ny; iy++)
 477           v[ix][iy] = 0;
 478
 479   double x_start = xmin + (colStart * xinc);
 480   for (PElemConstIterator pelem = m_listPElem.begin(); pelem != m_listPElem.end(); pelem++) {
 481       const PhantomElement& rPElem = **pelem;
 482       double x, y, xi, yi;
 483       int ix, iy, kx, ky;
 484       for (ix = 0, x = x_start; ix < colCount; ix++, x += xinc) {
 485           for (iy = 0, y = ymin; iy < ny; iy++, y += yinc) {
 486               for (kx = 0, xi = x + kxofs; kx < nsample; kx++, xi += kxinc) {
 487                   for (ky = 0, yi = y + kyofs; ky < nsample; ky++, yi += kyinc)
 488                       if (rPElem.isPointInside (xi, yi, PHM_COORD) == TRUE)
 489                           v[ix][iy] += rPElem.atten();
 490               } // for kx
 491           } /* for iy */
 492       }  /* for ix */
 493   }  /* for pelem */
 494
 495
 496   if (nsample > 1) {
 497     double factor = 1.0 / (nsample * nsample);
 498
 499     for (int ix = 0; ix < colCount; ix++)
 500       for (int iy = 0; iy < ny; iy++)
 501         v[ix][iy] *= factor;
 502   }
 503 }
 504
 505 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 506 // CLASS IDENTIFICATION
 507 //
 508 //      PhantomElement
 509 //
 510 // PURPOSE
 511 //
 512 ////////////////////////////////////////////////////////////////////////////////////////////////////////
 513
 514
 515 PhantomElement::PhantomElement (const char *type, const double cx, const double cy, const double u, const double v, const double rot, const double atten)
 516     : m_cx(cx), m_cy(cy), m_u(u), m_v(v), m_atten(atten), m_nPoints(0), m_xOutline(0), m_yOutline(0)
 517 {
 518   m_rot = convertDegreesToRadians (rot);   // convert angle to radians
 519
 520   m_type = convertNameToType (type);
 521
 522   makeTransformMatrices ();     // calc transform matrices between phantom and normalized phantomelement
 523   makeVectorOutline ();         // calculate vector outline of pelem
 524
 525   // Find maximum diameter of Object
 526   double r2Max = 0;
 527   for (int i = 0; i < m_nPoints; i++) {
 528     double r2 = (m_xOutline[i] * m_xOutline[i]) + (m_yOutline[i] * m_yOutline[i]);
 529     if (r2 > r2Max)
 530       r2Max = r2;
 531   }
 532   m_diameter = 2 * sqrt( r2Max );
 533
 534   m_rectLimits[0] = m_xmin;   m_rectLimits[1] = m_ymin;
 535   m_rectLimits[2] = m_xmax;   m_rectLimits[3] = m_ymax;
 536 }
 537
 538
 539 PhantomElement::~PhantomElement ()
 540 {
 541     delete m_xOutline;
 542     delete m_yOutline;
 543 }
 544
 545 PhmElemType
 546 PhantomElement::convertNameToType (const char* const typeName)
 547 {
 548     PhmElemType type = PELEM_INVALID;
 549
 550     if (strcasecmp (typeName, "rectangle") == 0)
 551         type = PELEM_RECTANGLE;
 552     else if (strcasecmp (typeName, "triangle") == 0)
 553         type = PELEM_TRIANGLE;
 554     else if (strcasecmp (typeName, "ellipse") == 0)
 555         type = PELEM_ELLIPSE;
 556     else if (strcasecmp (typeName, "sector") == 0)
 557         type = PELEM_SECTOR;
 558     else if (strcasecmp (typeName, "segment") == 0)
 559       type = PELEM_SEGMENT;
 560     else
 561         sys_error (ERR_WARNING, "Unknown PhantomElement type %s [PhantomElement::PhantomElement]", type);
 562
 563     return (type);
 564 }
 565
 566 void
 567 PhantomElement::makeTransformMatrices ()
 568 {
 569   GRFMTX_2D temp;
 570
 571   // To map normalized Pelem coords to world Phantom
 572   //     scale by (u, v)
 573   //     rotate by rot
 574   //     translate by (cx, cy)
 575
 576   scale_mtx2 (m_xformObjToPhm, m_u, m_v);
 577   rot_mtx2  (temp, m_rot);
 578   mult_mtx2 (m_xformObjToPhm, temp, m_xformObjToPhm);
 579   xlat_mtx2 (temp, m_cx, m_cy);
 580   mult_mtx2 (m_xformObjToPhm, temp, m_xformObjToPhm);
 581
 582   // to map world Phantom coodinates to normalized PElem coords
 583   //     translate by (-cx, -cy)
 584   //     rotate by -rot
 585   //     scale by (1/u, 1/v)
 586
 587   xlat_mtx2 (m_xformPhmToObj, -m_cx, -m_cy);
 588   rot_mtx2  (temp, -m_rot);
 589   mult_mtx2 (m_xformPhmToObj, temp, m_xformPhmToObj);
 590   scale_mtx2 (temp, 1 / m_u, 1 / m_v);
 591   mult_mtx2 (m_xformPhmToObj, temp, m_xformPhmToObj);
 592 }
 593
 594
 595 /* NAME
 596  *   pelem_make_points          INTERNAL routine to calculate point array for an pelem
 597  *
 598  * SYNOPSIS
 599  *   makepelempts (pelem)
 600  *   PELEM *pelem       pelem whose points we are calculating
 601  *
 602  * NOTES
 603  *   Called by phm_add_pelem()
 604  */
 605
 606 void
 607 PhantomElement::makeVectorOutline ()
 608 {
 609   double radius, theta, start, stop;
 610   double xfact, yfact;
 611   int cpts;
 612
 613   m_nPoints = 0;
 614   switch (m_type) {
 615   case PELEM_RECTANGLE:
 616     m_nPoints = 5;
 617     m_xOutline = new double [m_nPoints];
 618     m_yOutline = new double [m_nPoints];
 619     m_xOutline[0] =-m_u;        m_yOutline[0] =-m_v;
 620     m_xOutline[1] = m_u;        m_yOutline[1] =-m_v;
 621     m_xOutline[2] = m_u;        m_yOutline[2] = m_v;
 622     m_xOutline[3] =-m_u;        m_yOutline[3] = m_v;
 623     m_xOutline[4] =-m_u;        m_yOutline[4] =-m_v;
 624     break;
 625   case PELEM_TRIANGLE:
 626     m_nPoints = 4;
 627     m_xOutline = new double [m_nPoints];
 628     m_yOutline = new double [m_nPoints];
 629     m_xOutline[0] =-m_u;        m_yOutline[0] = 0.0;
 630     m_xOutline[1] = m_u;        m_yOutline[1] = 0.0;
 631     m_xOutline[2] = 0.0;        m_yOutline[2] = m_v;
 632     m_xOutline[3] =-m_u;        m_yOutline[3] = 0.0;
 633     break;
 634   case PELEM_ELLIPSE:
 635     cpts = numCirclePoints (TWOPI);
 636     m_nPoints = cpts;
 637     m_xOutline = new double [m_nPoints];
 638     m_yOutline = new double [m_nPoints];
 639     calcEllipsePoints (m_xOutline, m_yOutline, cpts, m_u, m_v);
 640     break;
 641   case PELEM_SECTOR:
 642     radius = sqrt(m_u * m_u + m_v * m_v);
 643     theta = atan(m_u / m_v);            // angle with y-axis
 644     start = 3.0 * HALFPI - theta;
 645     stop  = 3.0 * HALFPI + theta;
 646     cpts = numCirclePoints (stop - start);
 647     m_nPoints = 3 + cpts;
 648     m_xOutline = new double [m_nPoints];
 649     m_yOutline = new double [m_nPoints];
 650
 651     m_xOutline[0] = 0.0;                m_yOutline[0] = m_v;
 652     m_xOutline[1] =-m_u;                m_yOutline[1] = 0.0;
 653     calcArcPoints (&m_xOutline[2], &m_yOutline[2], cpts, 0.0, m_v, radius, start, stop);
 654     m_xOutline[cpts + 2] = 0.0;
 655     m_yOutline[cpts + 2] = m_v;
 656     break;
 657   case PELEM_SEGMENT:
 658     radius = sqrt(m_u * m_u + m_v * m_v);
 659     theta = atan (m_u / m_v);           // angle with y-axis
 660     start = 3.0 * HALFPI - theta;
 661     stop  = 3.0 * HALFPI + theta;
 662
 663     cpts = numCirclePoints (stop - start);
 664     m_nPoints = cpts + 1;
 665     m_xOutline = new double [m_nPoints];
 666     m_yOutline = new double [m_nPoints];
 667
 668     calcArcPoints (m_xOutline, m_yOutline, cpts, 0.0, m_v, radius, start, stop);
 669     m_xOutline[cpts] = -m_u;
 670     m_yOutline[cpts] = 0.0;
 671     break;
 672   default:
 673     sys_error(ERR_WARNING, "illegal pelem type %d [makeVectorOutline]", m_type);
 674     return;
 675   }
 676
 677   rotate2d (m_xOutline, m_yOutline, m_nPoints, m_rot);
 678   xlat2d (m_xOutline, m_yOutline, m_nPoints, m_cx, m_cy);
 679
 680   minmax_array (m_xOutline, m_nPoints, m_xmin, m_xmax);
 681   minmax_array (m_yOutline, m_nPoints, m_ymin, m_ymax);
 682
 683   // increase pelem extent by SCALE_PELEM_EXTENT to eliminate chance of
 684   //   missing actual pelem maximum due to polygonal sampling
 685
 686   xfact = (m_xmax - m_xmin) * SCALE_PELEM_EXTENT;
 687   yfact = (m_ymax - m_ymin) * SCALE_PELEM_EXTENT;
 688
 689   m_xmin -= xfact;
 690   m_ymin -= yfact;
 691   m_xmax += xfact;
 692   m_ymax += yfact;
 693 }
 694
 695
 696 /* NAME
 697  *   calc_arc                   Calculate outline of a arc of a circle
 698  *
 699  * SYNOPSIS
 700  *   calc_arc (x, y, xcent, ycent, pts, r, start, stop)
 701  *   double x[], y[];           Array of points
 702  *   int pts                    Number of points in array
 703  *   double xcent, ycent        Center of cirlce
 704  *   double r                   Radius of circle
 705  *   double start, stop         Beginning & ending angles
 706  */
 707
 708 void
 709 PhantomElement::calcArcPoints (double x[], double y[], const int pts, const double xcent, const double ycent, const double r, const double start, const double stop)
 710 {
 711     if (r <= 0.0)
 712         sys_error (ERR_WARNING, "negative or zero radius in calc_arc()");
 713
 714     double theta = (stop - start) / (pts - 1);  // angle incr. between points
 715     double c = cos(theta);
 716     double s = sin(theta);
 717
 718     x[0] = r * cos (start) + xcent;
 719     y[0] = r * sin (start) + ycent;
 720
 721     double xp = x[0] - xcent;
 722     double yp = y[0] - ycent;
 723     for (int i = 1; i < pts; i++) {
 724         double xc = c * xp - s * yp;
 725         double yc = s * xp + c * yp;
 726         x[i] = xc + xcent;
 727         y[i] = yc + ycent;
 728         xp = xc;  yp = yc;
 729     }
 730 }
 731
 732
 733 // NAME
 734 //   PhantomElement::calcEllipsePoints    Calculate outline of a ellipse
 735 //
 736 // SYNOPSIS
 737 //   calcEllipsePoints ()
 738 //
 739
 740
 741 void
 742 PhantomElement::calcEllipsePoints (double x[], double y[], const int pts, const double u, const double v)
 743 {
 744     calcArcPoints (x, y, m_nPoints, 0.0, 0.0, 1.0, 0.0, TWOPI);   // make a unit circle
 745     scale2d (x, y, m_nPoints, m_u, m_v);                             // scale to ellipse
 746 }
 747
 748
 749 /* NAME
 750  *   circle_pts         Calculate number of points to use for circle segment
 751  *
 752  * SYNOPSIS
 753  *   n = circle_pts (theta)
 754  *   int n              Number of points to use for arc
 755  *   double theta       Length of arc in radians
 756  */
 757
 758 int
 759 PhantomElement::numCirclePoints (double theta)
 760 {
 761     theta = clamp (theta, 0., TWOPI);
 762
 763     return static_cast<int> (POINTS_PER_CIRCLE * theta / TWOPI + 1.5);
 764 }
 765
 766
 767 bool
 768 PhantomElement::clipLineWorldCoords (double& x1, double& y1, double& x2, double &y2) const
 769 {
 770   /* check if ray is outside of pelem extents */
 771   double cx1 = x1, cy1 = y1, cx2 = x2, cy2 = y2;
 772   if (! clip_rect (cx1, cy1, cx2, cy2, m_rectLimits))
 773     return false;
 774
 775   // convert phantom coordinates to pelem coordinates
 776   xform_mtx2 (m_xformPhmToObj, x1, y1);
 777   xform_mtx2 (m_xformPhmToObj, x2, y2);
 778
 779   if (! clipLineNormalizedCoords (x1, y1, x2, y2))
 780     return false;
 781
 782   // convert standard pelem coordinates back to phantom coordinates
 783   xform_mtx2 (m_xformObjToPhm, x1, y1);
 784   xform_mtx2 (m_xformObjToPhm, x2, y2);
 785
 786   return true;
 787 }
 788
 789
 790 /* NAME
 791  *   pelem_clip_line                    Clip pelem against an arbitrary line
 792  *
 793  * SYNOPSIS
 794  *   pelem_clip_line (pelem, x1, y1, x2, y2)
 795  *   PhantomElement& pelem;             Pelem to be clipped
 796  *   double *x1, *y1, *x2, *y2  Endpoints of line to be clipped
 797  *
 798  * RETURNS
 799  *   true   if line passes through pelem
 800  *              (x1, y1, x2, y2 hold coordinates of new line)
 801  *   false  if line do not pass through pelem
 802  *              (x1, y1, x2, y2 are undefined)
 803  */
 804
 805 bool
 806 PhantomElement::clipLineNormalizedCoords (double& x1, double& y1, double& x2, double& y2) const
 807 {
 808   bool accept = false;
 809
 810   switch (m_type) {
 811   case PELEM_RECTANGLE:
 812     double rect[4];
 813     rect[0] = -1.0;  rect[1] = -1.0;
 814     rect[2] = 1.0;  rect[3] = 1.0;
 815     accept = clip_rect (x1, y1, x2, y2, rect);
 816     break;
 817   case PELEM_ELLIPSE:
 818     accept = clip_circle (x1, y1, x2, y2, 0.0, 0.0, 1.0, 0.0, 0.0);
 819     break;
 820   case PELEM_TRIANGLE:
 821     accept = clip_triangle (x1, y1, x2, y2, 1.0, 1.0, true);
 822     break;
 823   case PELEM_SEGMENT:
 824     accept = clip_segment (x1, y1, x2, y2, m_u, m_v);
 825     break;
 826   case PELEM_SECTOR:
 827     accept = clip_sector (x1, y1, x2, y2, m_u, m_v);
 828     break;
 829   default:
 830     sys_error (ERR_WARNING, "Illegal pelem type %d [pelem_clip_line]", m_type);
 831     break;
 832   }
 833
 834   return(accept);
 835 }
 836
 837
 838 // METHOD IDENTIFICATION
 839 //    PhantomElement::isPointInside             Check if point is inside pelem
 840 //
 841 // SYNOPSIS
 842 //    is_point_inside (pelem, x, y, coord_type)
 843 //    double x, y               Point to see if lies in pelem
 844 //    int coord_type            Coordinate type (PELEM_COORD or PHM_COORD)
 845 //
 846 // RETURNS
 847 //    true if point lies within pelem
 848 //    false if point lies outside of pelem
 849
 850 bool
 851 PhantomElement::isPointInside (double x, double y, const CoordType coord_type) const
 852 {
 853   if (coord_type == PHM_COORD) {
 854     xform_mtx2 (m_xformPhmToObj, x, y);
 855   } else if (coord_type != PELEM_COORD) {
 856     sys_error(ERR_WARNING, "Illegal coordinate type in pelem_is_point_inside");
 857     return (false);
 858   }
 859
 860   switch (m_type) {
 861   case PELEM_RECTANGLE:
 862     if (x > 1. || x < -1. || y > 1. || y < -1.)
 863       return (false);
 864     else
 865       return (true);
 866     break;
 867   case PELEM_TRIANGLE:
 868     if (y < 0. || y > 1. - x || y > 1. + x)
 869       return (false);
 870     else
 871       return (true);
 872     break;
 873   case PELEM_ELLIPSE:
 874     if (x > 1. || x < -1. || y > 1. || y < -1.)
 875       return (false);
 876     if (x * x + y * y > 1.)             // check if inside unit circle
 877       return (false);
 878     else
 879       return (true);
 880     break;
 881
 882     // for clipping segments & sectors, must NOT scale by (1/u, 1/v)
 883     // because this destroys information about size of arc component
 884
 885   case PELEM_SEGMENT:
 886     if (x > 1. || x < -1. || y > 0.)
 887         return (false);         // clip against y > 0
 888     x *= m_u;                   // put back u & v scale
 889     y *= m_v;
 890     if (x * x + (y-m_v) * (y-m_v) > m_u * m_u + m_v * m_v)
 891       return (false);           // clip against circle, r = sqrt(@)
 892     else
 893       return (true);
 894     break;
 895   case PELEM_SECTOR:
 896       if (x > 1. || x < -1. || y > 1.)   // extent
 897       return (false);
 898       if (y > 1. - x || y > 1. + x)      // triangle
 899           return (false);                      // clip against triangle
 900       x *= m_u;                // circle: put back u & v scale
 901     y *= m_v;
 902     if (x * x + (y-m_v) * (y-m_v) > m_u * m_u + m_v * m_v)
 903         return (false);                // clip against circle
 904     else
 905       return (true);
 906   break;
 907   default:
 908     sys_error (ERR_WARNING, "Illegal pelem type in pelem_is_point_inside()");
 909     break;
 910   }
 911
 912   return (false);
 913 }
 914
 915