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