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