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