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-2000 Kevin Rosenberg
  11 **
  12 **  $Id: phantom.h,v 1.20 2001/01/02 16:02:12 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 diameter() const {return m_diameter;}
  73     const double xmin() const {return m_xmin;}
  74     const double xmax() const {return m_xmax;}
  75     const double ymin() const {return m_ymin;}
  76     const double ymax() const {return m_ymax;}
  77     const double rot() const {return m_rot;}
  78     const double cx() const {return m_cx;}
  79     const double cy() const {return m_cy;}
  80     const double u() const {return m_u;}
  81     const double v() const {return m_v;}
  82
  83     void printDefinition (std::ostream& os) const;
  84     void printDefinition (std::ostringstream& os) const;
  85
  86  private:
  87     PhmElemType m_type;      // pelem type (box, ellipse, etc)
  88     double m_cx, m_cy;       // center of pelem
  89     double m_u, m_v;                 // size of pelem
  90     double m_atten;          // X-ray attenuation coefficient
  91     double m_rot;                    // pelem rotation angle (in radians)
  92     double *m_x, *m_y;       // ptr to array of points in obj world coord
  93     int m_nPoints;                   // number of points in outline arrays
  94     double m_xmin, m_xmax, m_ymin, m_ymax;  // pelem limits
  95     double m_diameter;
  96     GRFMTX_2D m_xformPhmToObj;        // map from phantom to normalized pelem coords
  97     GRFMTX_2D m_xformObjToPhm;        // map from normalized pelem coords to phantom coords
  98     double* m_xOutline;
  99     double* m_yOutline;
 100     double  m_rectLimits[4];
 101
 102     static const int POINTS_PER_CIRCLE;
 103     static const double SCALE_PELEM_EXTENT;  // increase pelem limits by 0.5%
 104
 105     static PhmElemType convertNameToType (const char* const typeName);
 106     static const char* const convertTypeToName (PhmElemType iType);
 107
 108     void makeTransformMatrices ();
 109
 110     void makeVectorOutline ();
 111
 112     void calcArcPoints (double x[], double y[], const int pts, const double xcent, const double ycent, const double r, const double start, const double stop);
 113
 114     void calcEllipsePoints (double x[], double y[], const int pts, const double u, const double v);
 115
 116     static int numCirclePoints (double theta);
 117
 118     PhantomElement (const PhantomElement& rhs);        // copy constructor
 119     PhantomElement& operator= (const PhantomElement&); // assignment operator
 120 };
 121
 122
 123 typedef enum {
 124     P_PELEMS,        // Phantom made of PElems
 125     P_UNIT_PULSE,   // Special phantom, not made of pelems
 126     P_FILTER      // defined only by this type
 127 } PhantomComposition;
 128
 129
 130 //////////////////////////////////////////////////////
 131 // Phantom Class Declaration
 132 //////////////////////////////////////////////////////
 133
 134 class SGP;
 135 class ImageFile;
 136 class Phantom
 137 {
 138  public:
 139     static const int PHM_INVALID;
 140     static const int PHM_HERMAN;
 141     static const int PHM_B_HERMAN;
 142     static const int PHM_SHEPP_LOGAN;
 143     static const int PHM_B_SHEPP_LOGAN;
 144     static const int PHM_UNITPULSE;
 145
 146     Phantom ();
 147     Phantom (const char* const phmName);
 148
 149     ~Phantom ();
 150
 151     void setComposition (PhantomComposition composition)
 152         { m_composition = composition; }
 153
 154     const PhantomComposition getComposition () const
 155         { return m_composition; }
 156
 157     bool createFromPhantom (const char* const phmName);
 158
 159     bool createFromPhantom (const int phmid);
 160
 161     bool createFromFile (const char* const fname);
 162
 163     bool fileWrite (const char* const fname);
 164
 165     void addPElem (const PhantomElement& pelem);
 166
 167     void addPElem (const char* const composition, const double cx, const double cy, const double u, const double v, const double rot, const double atten);
 168
 169     void convertToImagefile (ImageFile& im, const int in_nsample, const int trace, const int colStart, const int colCount, bool bStoreAtColumnPos) const;
 170
 171     void convertToImagefile (ImageFile& im, const int in_nsample, const int trace) const;
 172
 173     void printDefinitions (std::ostream& os) const;
 174     void printDefinitions (std::ostringstream& os) const;
 175
 176     bool fail() const             {return m_fail;}
 177     const std::string& failMessage() const {return m_failMessage;}
 178     const std::string& name() const     {return m_name;}
 179     const int id() const     {return m_id;}
 180
 181 #if HAVE_SGP
 182     void show () const;
 183     void show (SGP& sgp) const;
 184     void draw (SGP& sgp) const;
 185 #endif
 186
 187     void addStdHerman ();
 188     void addStdHermanBordered ();
 189     void addStdSheppLogan ();
 190     void addStdSheppLoganBordered ();
 191
 192     void print (std::ostream& os) const;
 193     void print (std::ostringstream& os) const;
 194
 195     const double maxAxisLength () const {return (((m_xmax - m_xmin) > (m_ymax - m_ymin)) ? (m_xmax - m_xmin) : (m_ymax - m_ymin));}
 196
 197     const double diameter() const {return m_diameter;}
 198     const double xmin() const {return m_xmin;}
 199     const double xmax() const {return m_xmax;}
 200     const double ymin() const {return m_ymin;}
 201     const double ymax() const {return m_ymax;}
 202           std::list<PhantomElement*>& listPElem() {return m_listPElem;}
 203     const std::list<PhantomElement*>& listPElem() const {return m_listPElem;}
 204     const int nPElem() const {return m_nPElem;}
 205
 206     static const int getPhantomCount() {return s_iPhantomCount;}
 207     static const char** getPhantomNameArray() {return s_aszPhantomName;}
 208     static const char** getPhantomTitleArray() {return s_aszPhantomTitle;}
 209     static int convertNameToPhantomID (const char* const phmName);
 210     static const char* convertPhantomIDToName (const int phmID);
 211     static const char* convertPhantomIDToTitle (const int phmID);
 212
 213  private:
 214     PhantomComposition m_composition;
 215     int m_nPElem;                           // number of pelems in phantom
 216     double m_xmin, m_xmax, m_ymin, m_ymax;  // extent of pelems in pelem coordinates
 217     double m_diameter;                        // diameter of object
 218     mutable std::list<PhantomElement*> m_listPElem;      // pelem lists
 219     std::string m_name;
 220     int m_id;
 221     bool m_fail;
 222     std::string m_failMessage;
 223
 224     static const char* s_aszPhantomName[];
 225     static const char* s_aszPhantomTitle[];
 226     static const int s_iPhantomCount;
 227
 228     void init();
 229
 230     Phantom (const Phantom& rhs);        // copy constructor
 231     Phantom& operator= (const Phantom&); // assignment operator
 232 };
 233
 234 typedef std::list<PhantomElement*>::iterator PElemIterator;
 235 typedef std::list<PhantomElement*>::const_iterator PElemConstIterator;
 236
 237 #endif