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