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