include/phantom.h

   1 /*****************************************************************************
   2 ** FILE IDENTIFICATION
   3 **
   4 **   Name:          phantom.h
   5 **   Purpose:       Header file for Phantom objects
   6 **   Programmer:    Kevin Rosenberg
   7 **   Date Started:  July 1, 1984
   8 **
   9 **  This is part of the CTSim program
  10 **  Copyright (c) 1983-2001 Kevin Rosenberg
  11 **
  12 **  $Id: phantom.h,v 1.23 2001/02/09 14:34:16 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 #ifndef PHANTOM_H
  29 #define PHANTOM_H
  30
  31 #include <list>
  32 #include "ctsupport.h"
  33
  34 typedef enum {
  35     PELEM_INVALID,
  36     PELEM_RECTANGLE,
  37     PELEM_TRIANGLE,
  38     PELEM_ELLIPSE,
  39     PELEM_SECTOR,
  40     PELEM_SEGMENT
  41 } PhmElemType;
  42
  43 /* Codes for Coordinate Types      */
  44 /* Defines coords for isPointInside() */
  45
  46 typedef enum {
  47   PELEM_COORD,         /* Normalized PElem Coordinates */
  48   PHM_COORD           /* World phantom Coordinates */
  49 } CoordType;
  50
  51
  52 class PhantomElement
  53 {
  54  public:
  55     PhantomElement (const char* const type, const double cx, const double cy, const double u, const double v, const double rot, const double atten);
  56
  57     ~PhantomElement ();
  58
  59     bool isPointInside (double x, double y, const CoordType coord_type) const;
  60
  61     bool clipLineNormalizedCoords (double& x1, double& y1, double& x2, double& y2) const;
  62
  63     bool clipLineWorldCoords (double& x1, double& y1, double& x2, double& y2) const;
  64
  65     const int nOutlinePoints() const {return m_nPoints;}
  66     double* rectLimits() {return m_rectLimits;}
  67     double* xOutline() {return m_xOutline;}
  68     double* yOutline() {return m_yOutline;}
  69     double* const xOutline() const {return m_xOutline;}
  70     double* const yOutline() const {return m_yOutline;}
  71     const double atten() const {return m_atten;}
  72     const double xmin() const {return m_xmin;}
  73     const double xmax() const {return m_xmax;}
  74     const double ymin() const {return m_ymin;}
  75     const double ymax() const {return m_ymax;}
  76     const double rot() const {return m_rot;}
  77     const double cx() const {return m_cx;}
  78     const double cy() const {return m_cy;}
  79     const double u() const {return m_u;}
  80     const double v() const {return m_v;}
  81
  82     void printDefinition (std::ostream& os) const;
  83     void printDefinition (std::ostringstream& os) const;
  84
  85  private:
  86     PhmElemType m_type;      // pelem type (box, ellipse, etc)
  87     double m_cx, m_cy;       // center of pelem
  88     double m_u, m_v;                 // size of pelem
  89     double m_atten;          // X-ray attenuation coefficient
  90     double m_rot;                    // pelem rotation angle (in radians)
  91     double *m_x, *m_y;       // ptr to array of points in obj world coord
  92     int m_nPoints;                   // number of points in outline arrays
  93     double m_xmin, m_xmax, m_ymin, m_ymax;  // pelem limits
  94     GRFMTX_2D m_xformPhmToObj;        // map from phantom to normalized pelem coords
  95     GRFMTX_2D m_xformObjToPhm;        // map from normalized pelem coords to phantom coords
  96     double* m_xOutline;
  97     double* m_yOutline;
  98     double  m_rectLimits[4];
  99
 100     static const int POINTS_PER_CIRCLE;
 101     static const double SCALE_PELEM_EXTENT;  // increase pelem limits by 0.5%
 102
 103     static PhmElemType convertNameToType (const char* const typeName);
 104     static const char* const convertTypeToName (PhmElemType iType);
 105
 106     void makeTransformMatrices ();
 107
 108     void makeVectorOutline ();
 109
 110     void calcArcPoints (double x[], double y[], const int pts, const double xcent, const double ycent, const double r, const double start, const double stop);
 111
 112     void calcEllipsePoints (double x[], double y[], const int pts, const double u, const double v);
 113
 114     static int numCirclePoints (double theta);
 115
 116     PhantomElement (const PhantomElement& rhs);        // copy constructor
 117     PhantomElement& operator= (const PhantomElement&); // assignment operator
 118 };
 119
 120
 121 typedef enum {
 122     P_PELEMS,        // Phantom made of PElems
 123     P_UNIT_PULSE,   // Special phantom, not made of pelems
 124     P_FILTER      // defined only by this type
 125 } PhantomComposition;
 126
 127
 128 //////////////////////////////////////////////////////
 129 // Phantom Class Declaration
 130 //////////////////////////////////////////////////////
 131
 132 class SGP;
 133 class ImageFile;
 134 class Phantom
 135 {
 136  public:
 137     static const int PHM_INVALID;
 138     static const int PHM_HERMAN;
 139     static const int PHM_SHEPP_LOGAN;
 140     static const int PHM_UNITPULSE;
 141
 142     Phantom ();
 143     Phantom (const char* const phmName);
 144
 145     ~Phantom ();
 146
 147     void setComposition (PhantomComposition composition)
 148         { m_composition = composition; }
 149
 150     const PhantomComposition getComposition () const
 151         { return m_composition; }
 152
 153     bool createFromPhantom (const char* const phmName);
 154
 155     bool createFromPhantom (const int phmid);
 156
 157     bool createFromFile (const char* const fname);
 158
 159     bool fileWrite (const char* const fname);
 160
 161     void addPElem (const PhantomElement& pelem);
 162
 163     void addPElem (const char* const composition, const double cx, const double cy, const double u, const double v, const double rot, const double atten);
 164
 165     void convertToImagefile (ImageFile& im, double dViewRatio, const int in_nsample, const int trace, const int colStart, const int colCount, bool bStoreAtColumnPos) const;
 166
 167     void convertToImagefile (ImageFile& im, double dViewRatio, const int in_nsample, const int trace) const;
 168
 169     void printDefinitions (std::ostream& os) const;
 170     void printDefinitions (std::ostringstream& os) const;
 171
 172     bool fail() const             {return m_fail;}
 173     const std::string& failMessage() const {return m_failMessage;}
 174     const std::string& name() const     {return m_name;}
 175     const int id() const     {return m_id;}
 176
 177 #if HAVE_SGP
 178     void show () const;
 179     void show (SGP& sgp) const;
 180     void draw (SGP& sgp) const;
 181 #endif
 182
 183     void addStdHerman ();
 184     void addStdSheppLogan ();
 185
 186     void print (std::ostream& os) const;
 187     void print (std::ostringstream& os) const;
 188
 189     double maxAxisLength () const
 190     {  return maxValue<double> (m_xmax - m_xmin, m_ymax - m_ymin); }
 191
 192     double getDiameterBoundaryCircle() const
 193     { return SQRT2 * maxAxisLength(); }
 194
 195     const double xmin() const {return m_xmin;}
 196     const double xmax() const {return m_xmax;}
 197     const double ymin() const {return m_ymin;}
 198     const double ymax() const {return m_ymax;}
 199           std::list<PhantomElement*>& listPElem() {return m_listPElem;}
 200     const std::list<PhantomElement*>& listPElem() const {return m_listPElem;}
 201     const int nPElem() const {return m_nPElem;}
 202
 203     static const int getPhantomCount() {return s_iPhantomCount;}
 204     static const char** getPhantomNameArray() {return s_aszPhantomName;}
 205     static const char** getPhantomTitleArray() {return s_aszPhantomTitle;}
 206     static int convertNameToPhantomID (const char* const phmName);
 207     static const char* convertPhantomIDToName (const int phmID);
 208     static const char* convertPhantomIDToTitle (const int phmID);
 209
 210  private:
 211     PhantomComposition m_composition;
 212     int m_nPElem;                           // number of pelems in phantom
 213     double m_xmin, m_xmax, m_ymin, m_ymax;  // extent of pelems in pelem coordinates
 214     mutable std::list<PhantomElement*> m_listPElem;      // pelem lists
 215     std::string m_name;
 216     int m_id;
 217     bool m_fail;
 218     std::string m_failMessage;
 219     static const char* s_aszPhantomName[];
 220     static const char* s_aszPhantomTitle[];
 221     static const int s_iPhantomCount;
 222
 223     void init();
 224
 225     Phantom (const Phantom& rhs);        // copy constructor
 226     Phantom& operator= (const Phantom&); // assignment operator
 227 };
 228
 229 typedef std::list<PhantomElement*>::iterator PElemIterator;
 230 typedef std::list<PhantomElement*>::const_iterator PElemConstIterator;
 231
 232 #endif