tools/phm2if.cpp

   1 /*****************************************************************************
   2 ** FILE IDENTIFICATION
   3 **
   4 **   Name:          phm2if.cpp
   5 **   Purpose:       Convert an phantom object to an image file
   6 **   Programmer:    Kevin Rosenberg
   7 **   Date Started:  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 #include "timer.h"
  28
  29
  30 enum { O_PHANTOM, O_DESC, O_NSAMPLE, O_FILTER, O_VIEW_RATIO, O_TRACE, O_VERBOSE, O_HELP,
  31 O_PHMFILE, O_FILTER_DOMAIN, O_FILTER_BW, O_FILTER_PARAM, O_DEBUG, O_VERSION };
  32
  33 static struct option my_options[] =
  34 {
  35   {"phantom", 1, 0, O_PHANTOM},
  36   {"phmfile", 1, 0, O_PHMFILE},
  37   {"desc", 1, 0, O_DESC},
  38   {"nsample", 1, 0, O_NSAMPLE},
  39   {"filter", 1, 0, O_FILTER},
  40   {"filter-domain", 1, 0, O_FILTER_DOMAIN},
  41   {"filter-bw", 1, 0, O_FILTER_BW},
  42   {"filter-param", 1, 0, O_FILTER_PARAM},
  43   {"trace", 1, 0, O_TRACE},
  44   {"view-ratio", 1, 0, O_VIEW_RATIO},
  45   {"verbose", 0, 0, O_VERBOSE},
  46   {"debug", 0, 0, O_DEBUG},
  47   {"help", 0, 0, O_HELP},
  48   {"version", 0, 0, O_VERSION},
  49   {0, 0, 0, 0}
  50 };
  51
  52 static const char* g_szIdStr = "$Id$";
  53
  54 void
  55 phm2if_usage (const char *program)
  56 {
  57   std::cout << "phm2if_usage: " << fileBasename(program) << " outfile nx ny [--phantom phantom-name] [--phmfile filename] [--filter filter-name] [OPTIONS]\n";
  58   std::cout << "Generate phantom image from a predefined --phantom or a --phmfile\n";
  59   std::cout << std::endl;
  60   std::cout << "     outfile         Name of output file for image\n";
  61   std::cout << "     nx              Number of pixels X-axis\n";
  62   std::cout << "     ny              Number of pixels Y-axis\n";
  63   std::cout << "     --view-ratio    View diameter to phantom diameter ratio (default = 1)\n";
  64   std::cout << "     --phantom       Phantom to use for projection\n";
  65   std::cout << "        herman       Herman head phantom\n";
  66   std::cout << "        shepp-logan  Shepp-Logan head phantom\n";
  67   std::cout << "        unit-pulse    Unit pulse phantom\n";
  68   std::cout << "     --phmfile       Generate Phantom from phantom file\n";
  69   std::cout << "     --filter        Generate Phantom from a filter function\n";
  70   std::cout << "       abs_bandlimit Abs * Bandlimiting\n";
  71   std::cout << "       abs_sinc      Abs * Sinc\n";
  72   std::cout << "       abs_cos       Abs * Cosine\n";
  73   std::cout << "       abs_hamming   Abs * Hamming\n";
  74   std::cout << "       shepp         Shepp-Logan\n";
  75   std::cout << "       bandlimit     Bandlimiting\n";
  76   std::cout << "       sinc          Sinc\n";
  77   std::cout << "       cos           Cosine\n";
  78   std::cout << "       triangle      Triangle\n";
  79   std::cout << "       hamming       Hamming\n";
  80   std::cout << "     --filter-param  Alpha level for Hamming filter\n";
  81   std::cout << "     --filter-domain Set domain of filter\n";
  82   std::cout << "         spatial     Spatial domain (default)\n";
  83   std::cout << "         freq        Frequency domain\n";
  84   std::cout << "     --filter-bw     Filter bandwidth (default = 1)\n";
  85   std::cout << "     --desc          Description of raysum\n";
  86   std::cout << "     --nsample       Number of samples per axis per pixel (default = 1)\n";
  87   std::cout << "     --trace         Trace level to use\n";
  88   std::cout << "        none         No tracing (default)\n";
  89   std::cout << "        console      Trace text level\n";
  90   std::cout << "     --debug         Debug mode\n";
  91   std::cout << "     --verbose       Verbose mode\n";
  92   std::cout << "     --version       Print version\n";
  93   std::cout << "     --help          Print this help message\n";
  94 }
  95
  96 #ifdef HAVE_MPI
  97 void mpi_gather_image (MPIWorld& mpiWorld, ImageFile* pImGlobal, ImageFile* pImLocal, const int optDebug);
  98 #endif
  99
 100 int
 101 phm2if_main (int argc, char* const argv[])
 102 {
 103   ImageFile* pImGlobal = NULL;
 104   Phantom phm;
 105   std::string optPhmName;
 106   std::string optFilterName;
 107   std::string optDomainName (SignalFilter::convertDomainIDToName (SignalFilter::DOMAIN_SPATIAL));
 108   std::string optOutFilename;
 109   std::string optDesc;
 110   std::string optPhmFilename;
 111   int opt_nx = 0;
 112   int opt_ny = 0;
 113   int opt_nsample = 1;
 114   double optViewRatio = 1.;
 115   double optFilterParam = 1.;
 116   double optFilterBW = 1.;
 117   int optTrace = Trace::TRACE_NONE;
 118   bool optVerbose = false;
 119   bool optDebug = false;
 120   char *endptr = NULL;
 121   char *endstr;
 122   Timer timerProgram;
 123
 124   UNUSED(optDebug);
 125
 126 #ifdef HAVE_MPI
 127   ImageFile* pImLocal = NULL;
 128   MPIWorld mpiWorld (argc, argv);
 129   if (mpiWorld.getRank() == 0) {
 130 #endif
 131     while (1) {
 132       int c = getopt_long(argc, argv, "", my_options, NULL);
 133       if (c == -1)
 134         break;
 135
 136       switch (c) {
 137       case O_PHANTOM:
 138         optPhmName = optarg;
 139         break;
 140       case O_PHMFILE:
 141         optPhmFilename = optarg;
 142         break;
 143       case O_VERBOSE:
 144         optVerbose = true;
 145         break;
 146       case O_DEBUG:
 147         optDebug = true;
 148         break;
 149       case O_TRACE:
 150         if ((optTrace = Trace::convertTraceNameToID(optarg)) == Trace::TRACE_INVALID) {
 151           phm2if_usage(argv[0]);
 152           return (1);
 153         }
 154         break;
 155       case O_FILTER:
 156         optFilterName = optarg;
 157         break;
 158       case O_FILTER_DOMAIN:
 159         optDomainName = optarg;
 160         break;
 161       case O_DESC:
 162         optDesc =  optarg;
 163         break;
 164       case O_FILTER_BW:
 165         optFilterBW = strtod(optarg, &endptr);
 166         endstr = optarg + strlen(optarg);
 167         if (endptr != endstr) {
 168           sys_error(ERR_SEVERE,"Error setting --filter-bw to %s\n", optarg);
 169           phm2if_usage(argv[0]);
 170           return (1);
 171         }
 172         break;
 173       case O_VIEW_RATIO:
 174         optViewRatio = strtod(optarg, &endptr);
 175         endstr = optarg + strlen(optarg);
 176         if (endptr != endstr) {
 177           sys_error(ERR_SEVERE,"Error setting --view-ratio to %s\n", optarg);
 178           phm2if_usage(argv[0]);
 179           return (1);
 180         }
 181         break;
 182       case O_FILTER_PARAM:
 183         optFilterParam = strtod(optarg, &endptr);
 184         endstr = optarg + strlen(optarg);
 185         if (endptr != endstr) {
 186           sys_error(ERR_SEVERE,"Error setting --filter-param to %s\n", optarg);
 187           phm2if_usage(argv[0]);
 188           return (1);
 189         }
 190         break;
 191       case O_NSAMPLE:
 192         opt_nsample = strtol(optarg, &endptr, 10);
 193         endstr = optarg + strlen(optarg);
 194         if (endptr != endstr) {
 195           sys_error(ERR_SEVERE,"Error setting --nsample to %s\n", optarg);
 196           phm2if_usage(argv[0]);
 197           return (1);
 198         }
 199         break;
 200       case O_VERSION:
 201 #ifdef VERSION
 202         std::cout << "Version " << VERSION << std::endl << g_szIdStr << std::endl;
 203 #else
 204         std::cerr << "Unknown version number\n";
 205 #endif
 206       case O_HELP:
 207       case '?':
 208         phm2if_usage(argv[0]);
 209         return (0);
 210       default:
 211         phm2if_usage(argv[0]);
 212         return (1);
 213       }
 214     }
 215
 216     if (optPhmName == "" && optFilterName == "" && optPhmFilename == "") {
 217       std::cerr << "No phantom defined\n" << std::endl;
 218       phm2if_usage(argv[0]);
 219       return (1);
 220     }
 221
 222     if (optind + 3 != argc) {
 223       phm2if_usage(argv[0]);
 224       return (1);
 225     }
 226     optOutFilename = argv[optind];
 227     opt_nx = strtol(argv[optind+1], &endptr, 10);
 228     endstr = argv[optind+1] + strlen(argv[optind+1]);
 229     if (endptr != endstr) {
 230       sys_error(ERR_SEVERE,"Error setting nx to %s\n", argv[optind+1]);
 231       phm2if_usage(argv[0]);
 232       return (1);
 233     }
 234     opt_ny = strtol(argv[optind+2], &endptr, 10);
 235     endstr = argv[optind+2] + strlen(argv[optind+2]);
 236     if (endptr != endstr) {
 237       sys_error(ERR_SEVERE,"Error setting ny to %s\n", argv[optind+2]);
 238       phm2if_usage(argv[0]);
 239       return (1);
 240     }
 241
 242     std::ostringstream oss;
 243     oss << "phm2if: nx=" << opt_nx << ", ny=" << opt_ny << ", viewRatio=" << optViewRatio << ", nsample=" << opt_nsample << ", ";
 244     if (!optPhmFilename.empty()) {
 245       oss << "phantomFile=" << optPhmFilename;
 246     } else if (!optPhmName.empty()) {
 247       oss << "phantom=" << optPhmName;
 248     } else if (!optFilterName.empty()) {
 249       oss << "filter=" << optFilterName << " - " << optDomainName;
 250     }
 251     if (!optDesc.empty())
 252       oss << ": " << optDesc;
 253     optDesc = oss.str();
 254
 255     if (! optPhmName.empty()) {
 256       phm.createFromPhantom (optPhmName.c_str());
 257       if (phm.fail()) {
 258         std::cout << phm.failMessage() << std::endl << std::endl;
 259         phm2if_usage(argv[0]);
 260         return (1);
 261       }
 262     } else if (!optPhmFilename.empty()) {
 263       phm.createFromPhmFile(optPhmFilename.c_str());
 264 #ifdef HAVE_MPI
 265       if (mpiWorld.getRank() == 0)
 266         std::cerr << "Can't use phantom from file in MPI mode\n";
 267       return (1);
 268 #endif
 269     } else {
 270       std::cerr << "Internal error\n";
 271       return (1);
 272     }
 273
 274     if (optVerbose)
 275       std::cout << "Rasterize Phantom to Image\n" << std::endl;
 276 #ifdef HAVE_MPI
 277   }
 278 #endif
 279
 280 #ifdef HAVE_MPI
 281   TimerCollectiveMPI timerBcast (mpiWorld.getComm());
 282   mpiWorld.BcastString (optPhmName);
 283   mpiWorld.getComm().Bcast (&optVerbose, 1, MPI::INT, 0);
 284   mpiWorld.getComm().Bcast (&optDebug, 1, MPI::INT, 0);
 285   mpiWorld.getComm().Bcast (&optTrace, 1, MPI::INT, 0);
 286   mpiWorld.getComm().Bcast (&opt_nx, 1, MPI::INT, 0);
 287   mpiWorld.getComm().Bcast (&opt_ny, 1, MPI::INT, 0);
 288   mpiWorld.getComm().Bcast (&opt_nsample, 1, MPI::INT, 0);
 289   mpiWorld.getComm().Bcast (&optViewRatio, 1, MPI::DOUBLE, 0);
 290   mpiWorld.getComm().Bcast (&optFilterParam, 1, MPI::DOUBLE, 0);
 291   mpiWorld.getComm().Bcast (&optFilterBW, 1, MPI::DOUBLE, 0);
 292
 293   mpiWorld.BcastString (optFilterName);
 294   mpiWorld.BcastString (optDomainName);
 295
 296   if (optVerbose)
 297     timerBcast.timerEndAndReport ("Time to broadcast variables");
 298
 299   mpiWorld.setTotalWorkUnits (opt_nx);
 300
 301   if (mpiWorld.getRank() > 0 && optPhmName != "")
 302     phm.createFromPhantom (optPhmName.c_str());
 303
 304   if (mpiWorld.getRank() == 0) {
 305     pImGlobal = new ImageFile (opt_nx, opt_ny);
 306   }
 307   pImLocal = new ImageFile (opt_nx, opt_ny);
 308 #else
 309   pImGlobal = new ImageFile (opt_nx, opt_ny);
 310 #endif
 311
 312   ImageFileArray v = NULL;
 313 #ifdef HAVE_MPI
 314   if (mpiWorld.getRank() == 0)
 315     v = pImGlobal->getArray ();
 316
 317   if (phm.getComposition() == P_UNIT_PULSE) {
 318     if (mpiWorld.getRank() == 0) {
 319       v[opt_nx/2][opt_ny/2] = 1.;
 320     }
 321   } else if (optFilterName != "") {
 322     if (mpiWorld.getRank() == 0) {
 323       pImGlobal->filterResponse (optDomainName.c_str(), optFilterBW, optFilterName.c_str(), optFilterParam);
 324     }
 325   } else {
 326     TimerCollectiveMPI timerRasterize (mpiWorld.getComm());
 327     phm.convertToImagefile (*pImLocal, optViewRatio, opt_nsample, optTrace, mpiWorld.getMyStartWorkUnit(), mpiWorld.getMyLocalWorkUnits(), false);
 328     if (optVerbose)
 329       timerRasterize.timerEndAndReport ("Time to rasterize phantom");
 330
 331     TimerCollectiveMPI timerGather (mpiWorld.getComm());
 332     mpi_gather_image (mpiWorld, pImGlobal, pImLocal, optDebug);
 333     if (optVerbose)
 334       timerGather.timerEndAndReport ("Time to gather image");
 335   }
 336 #else
 337   v = pImGlobal->getArray ();
 338   if (phm.getComposition() == P_UNIT_PULSE) {
 339     v[opt_nx/2][opt_ny/2] = 1.;
 340   } else if (optFilterName != "") {
 341     pImGlobal->filterResponse (optDomainName.c_str(), optFilterBW, optFilterName.c_str(), optFilterParam);
 342   } else {
 343     phm.convertToImagefile (*pImGlobal, optViewRatio, opt_nsample, optTrace);
 344   }
 345 #endif
 346
 347 #ifdef HAVE_MPI
 348   if (mpiWorld.getRank() == 0)
 349 #endif
 350   {
 351     double calctime = timerProgram.timerEnd ();
 352     pImGlobal->labelAdd (Array2dFileLabel::L_HISTORY, optDesc.c_str(), calctime);
 353     pImGlobal->fileWrite (optOutFilename.c_str());
 354     if (optVerbose)
 355       std::cout << "Time to rasterize phantom: " << calctime << " seconds\n";
 356   }
 357
 358   delete pImGlobal;
 359 #ifdef HAVE_MPI
 360   delete pImLocal;
 361 #endif
 362
 363   return (0);
 364 }
 365
 366
 367
 368 #ifdef HAVE_MPI
 369 void mpi_gather_image (MPIWorld& mpiWorld, ImageFile* pImGlobal, ImageFile* pImLocal, const int optDebug)
 370 {
 371   ImageFileArray vLocal = pImLocal->getArray();
 372   ImageFileArray vGlobal = NULL;
 373   int nyLocal = pImLocal->ny();
 374
 375   if (mpiWorld.getRank() == 0)
 376     vGlobal = pImGlobal->getArray();
 377
 378   for (int iw = 0; iw < mpiWorld.getMyLocalWorkUnits(); iw++)
 379     mpiWorld.getComm().Send(vLocal[iw], nyLocal, pImLocal->getMPIDataType(), 0, 0);
 380
 381   if (mpiWorld.getRank() == 0) {
 382     for (int iProc = 0; iProc < mpiWorld.getNumProcessors(); iProc++) {
 383       for (int iw = mpiWorld.getStartWorkUnit(iProc); iw <= mpiWorld.getEndWorkUnit(iProc); iw++) {
 384         MPI::Status status;
 385         mpiWorld.getComm().Recv(vGlobal[iw], nyLocal, pImLocal->getMPIDataType(), iProc, 0, status);
 386       }
 387     }
 388   }
 389
 390 }
 391 #endif
 392
 393 #ifndef NO_MAIN
 394 int
 395 main (int argc, char* argv[])
 396 {
 397   int retval = 1;
 398
 399   try {
 400     retval = phm2if_main(argc, argv);
 401   } catch (exception e) {
 402     std::cerr << "Exception: " << e.what() << std::endl;
 403   } catch (...) {
 404     std::cerr << "Unknown exception\n";
 405   }
 406
 407   return (retval);
 408 }
 409 #endif