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