vtk/vtkgdcmSerieViewer2.cxx

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: vtkgdcmSerieViewer2.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2006/02/03 16:37:50 $
   7   Version:   $Revision: 1.3 $
   8
   9   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  10   l'Image). All rights reserved. See Doc/License.txt or
  11   http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
  12
  13      This software is distributed WITHOUT ANY WARRANTY; without even
  14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15      PURPOSE.  See the above copyright notices for more information.
  16
  17 =========================================================================*/
  18 // This example illustrates how the vtkGdcmReader vtk class can
  19 // use the result of gdcm::SerieHelper constructor and check
  20 // the various Setters :
  21 //     SerieHelper::SetOrderToReverse,
  22 //     SerieHelper::SetUserLessThanFunction
  23 //     SerieHelper::SetLoadMode
  24 //     vtkGdcmReader::SetUserFunction
  25 //     vtkGdcmReader::SetCoherentFileList
  26 // Usage:
  27 //  * the Directory name that contains the Dicom images constituting the stack
  28 //    should be given as command line argument (keyword : dirname=),
  29 //  * you can navigate through the stack by hitting any character key,
  30 //  * the produced vtk file is named "foo.vtk" (in the invocation directory).
  31 //
  32 //----------------------------------------------------------------------------
  33 #include <vtkRenderWindowInteractor.h>
  34 #include <vtkImageViewer2.h>
  35 #include <vtkStructuredPoints.h>
  36 #include <vtkStructuredPointsWriter.h>
  37 #include <vtkCommand.h>
  38 #include <vtkRenderer.h>
  39 #include <vtkImageMapToColors.h>
  40 #include <vtkLookupTable.h>
  41
  42 #include "vtkGdcmReader.h"
  43 #include "gdcmDocument.h"  // for NO_SHADOWSEQ
  44 #include "gdcmSerieHelper.h"
  45 #include "gdcmDebug.h"
  46 #include "gdcmDataEntry.h"
  47
  48 #include "gdcmArgMgr.h" // for Argument Manager functions
  49 #include <string.h>     // for strcmp
  50 #ifndef vtkFloatingPointType
  51 #define vtkFloatingPointType float
  52 #endif
  53
  54 void userSuppliedMirrorFunction (uint8_t *im, gdcm::File *f);
  55 void userSuppliedTopDownFunction(uint8_t *im, gdcm::File *f);
  56 bool userSuppliedLessThanFunction(gdcm::File *f1, gdcm::File *f2);
  57 bool userSuppliedLessThanFunction2(gdcm::File *f1, gdcm::File *f2);
  58
  59 int orderNb;
  60 uint16_t *elemsToOrderOn;
  61
  62 //----------------------------------------------------------------------------
  63 // Callback for the interaction
  64 class vtkgdcmObserver : public vtkCommand
  65 {
  66 public:
  67    virtual char const *GetClassName() const
  68    {
  69       return "vtkgdcmObserver";
  70    }
  71
  72    static vtkgdcmObserver *New()
  73    {
  74       return new vtkgdcmObserver;
  75    }
  76
  77    vtkgdcmObserver()
  78    {
  79       this->ImageViewer = NULL;
  80    }
  81
  82    virtual void Execute(vtkObject *, unsigned long event, void* )
  83    {
  84       if ( this->ImageViewer )
  85       {
  86          if ( event == vtkCommand::CharEvent )
  87          {
  88             int max = ImageViewer->GetWholeZMax();
  89             int slice = (ImageViewer->GetZSlice() + 1 ) % ++max;
  90             ImageViewer->SetZSlice( slice );
  91             ImageViewer->GetRenderer()->ResetCameraClippingRange();
  92             ImageViewer->Render();
  93          }
  94       }
  95    }
  96    vtkImageViewer2 *ImageViewer;
  97 };
  98
  99 int main(int argc, char *argv[])
 100 {
 101    START_USAGE(usage)
 102    " \n vtkgdcmSerieViewer2 : \n",
 103    " Display a 'Serie' (same Serie UID) within a Directory                    ",
 104    " You can navigate through the stack by hitting any character key.         ",
 105    " usage: vtkgdcmSerieViewer dirname=sourcedirectory                        ",
 106    "                           [noshadowseq][noshadow][noseq]                 ",
 107    "                           [reverse] [{[mirror]|[topdown]|[rotate]}]      ",
 108    "                           [order=] [check][debug]                        ",
 109    "      sourcedirectory : name of the directory holding the images          ",
 110    "                        if it holds more than one serie,                  ",
 111    "                        only the first one id displayed.                  ",
 112    "      noshadowseq: user doesn't want to load Private Sequences            ",
 113    "      noshadow   : user doesn't want to load Private groups (odd number)  ",
 114    "      noseq      : user doesn't want to load Sequences                    ",
 115    "      reverse    : user wants to sort the images reverse order            ",
 116    "      mirror     : user wants to 'mirror' the images | just some simple   ",
 117    "      topdown    : user wants to 'topdown' the images| examples of user   ",
 118    "      rotate     : NOT YET MADE (useless?)           | supplied functions ",
 119    "      check      : user wants to force more coherence checking            ",
 120    "      order=     : group1-elem1,group2-elem2,... (in hexa, no space)      ",
 121    "                   if we want to use them as a sort criterium             ",
 122    "                   Right now : ValEntries only -just an example-          ",
 123    "        or                                                                ",
 124    "      order=     : order=name if we want to sort on file name (why not ?) ",
 125    "      debug      : user wants to run the program in 'debug mode'          ",
 126    FINISH_USAGE
 127
 128
 129    // Initialize Arguments Manager
 130    gdcm::ArgMgr *am= new gdcm::ArgMgr(argc, argv);
 131
 132    if (argc == 1 || am->ArgMgrDefined("usage") )
 133    {
 134       am->ArgMgrUsage(usage); // Display 'usage'
 135       delete am;
 136       return 0;
 137    }
 138
 139    char *dirName = am->ArgMgrWantString("dirname",usage);
 140
 141    int loadMode = gdcm::LD_ALL;
 142    if ( am->ArgMgrDefined("noshadowseq") )
 143       loadMode |= gdcm::LD_NOSHADOWSEQ;
 144    else
 145    {
 146       if ( am->ArgMgrDefined("noshadow") )
 147          loadMode |= gdcm::LD_NOSHADOW;
 148       if ( am->ArgMgrDefined("noseq") )
 149          loadMode |= gdcm::LD_NOSEQ;
 150    }
 151
 152    int reverse = am->ArgMgrDefined("reverse");
 153
 154    int mirror  = am->ArgMgrDefined("mirror");
 155    int topdown = am->ArgMgrDefined("topdown");
 156    int rotate  = am->ArgMgrDefined("rotate");
 157
 158    if ( mirror && topdown )
 159    {
 160       std::cout << "mirror *OR* topDown !"
 161                 << std::endl;
 162       delete am;
 163       return 0;
 164    }
 165    if ( rotate )
 166    {
 167       std::cout << "'rotate' undealt with -> ignored !"
 168                 << std::endl;
 169    }
 170
 171    int check   = am->ArgMgrDefined("check");
 172
 173    // This is so ugly, a cstring is NOT a char * (god damit!)
 174    bool bname = ( strcmp(am->ArgMgrGetString("order", "not found"),"name")==0 );
 175    if (bname)
 176       elemsToOrderOn = am->ArgMgrGetXInt16Enum("order", &orderNb);
 177
 178    if (am->ArgMgrDefined("debug"))
 179       gdcm::Debug::DebugOn();
 180
 181    /* if unused Param we give up */
 182    if ( am->ArgMgrPrintUnusedLabels() )
 183    {
 184       am->ArgMgrUsage(usage);
 185       delete am;
 186       return 0;
 187    }
 188
 189    delete am;  // we don't need Argument Manager any longer
 190
 191    // ----------------------- End Arguments Manager ----------------------
 192
 193    gdcm::SerieHelper *sh = gdcm::SerieHelper::New();
 194    sh->SetLoadMode(loadMode);
 195    if (reverse)
 196       sh->SetSortOrderToReverse();
 197    sh->SetDirectory( dirName, true);
 198
 199    // Just to see
 200
 201    int nbFiles;
 202    // For all the 'Single Serie UID' FileSets of the gdcm::Serie
 203    gdcm::FileList *l = sh->GetFirstSingleSerieUIDFileSet();
 204    if (l == 0 )
 205    {
 206       std::cout << "Oops! No 'Single Serie UID' FileSet found ?!?" << std::endl;
 207       return 0;
 208    }
 209
 210    if (bname)
 211      sh->SetUserLessThanFunction(userSuppliedLessThanFunction2);
 212    else if (orderNb != 0)
 213       sh->SetUserLessThanFunction(userSuppliedLessThanFunction);
 214
 215    while (l)
 216    {
 217       nbFiles = l->size() ;
 218       if ( l->size() > 1 )
 219       {
 220          std::cout << "Sort list : " << nbFiles << " long" << std::endl;
 221          sh->OrderFileList(l);  // sort the list
 222          std::cout << "List sorted" << std::endl;
 223          break;  // The first one is OK. user will have to check
 224       }
 225       else
 226       {
 227          std::cout << "Oops! Empty 'Single Serie UID' FileSet found ?!?"
 228                    << std::endl;
 229       }
 230       l = sh->GetNextSingleSerieUIDFileSet();
 231    }
 232
 233    if (check)
 234    {
 235       if ( !sh->IsCoherent(l) ) // just be sure (?)
 236       {
 237          std::cout << "Files are not coherent. Stop everything " << std::endl;
 238          sh->Delete();
 239          return 0;
 240       }
 241    }
 242
 243    vtkGdcmReader *reader = vtkGdcmReader::New();
 244    reader->AllowLookupTableOff();
 245
 246    if (mirror)
 247       reader->SetUserFunction (userSuppliedMirrorFunction);
 248    else if (topdown)
 249       reader->SetUserFunction (userSuppliedTopDownFunction);
 250
 251    // Only the first FileList is dealt with (just an example)
 252    // (The files will not be parsed twice by the reader)
 253
 254    //---------------------------------------------------------
 255    reader->SetCoherentFileList(l);
 256    //---------------------------------------------------------
 257
 258    // because we passed a Coherent File List from a SerieHelper,
 259    // setting LoadMode is useless in this case
 260    //  reader->SetLoadMode(NO_SHADOWSEQ);
 261    reader->Update();
 262
 263    //print debug info:
 264    reader->GetOutput()->Print( cout );
 265
 266    vtkRenderWindowInteractor *iren = vtkRenderWindowInteractor::New();
 267
 268    vtkImageViewer2 *viewer = vtkImageViewer2::New();
 269
 270    if( reader->GetLookupTable() )
 271    {
 272       //convert to color:
 273       vtkImageMapToColors *map = vtkImageMapToColors::New ();
 274       map->SetInput (reader->GetOutput());
 275       map->SetLookupTable (reader->GetLookupTable());
 276       map->SetOutputFormatToRGB();
 277       viewer->SetInput ( map->GetOutput() );
 278       map->Delete();
 279    }
 280    else
 281    {
 282       vtkFloatingPointType *range = reader->GetOutput()->GetScalarRange();
 283       viewer->SetColorLevel (0.5 * (range[1] + range[0]));
 284       viewer->SetColorWindow (range[1] - range[0]);
 285
 286       viewer->SetInput ( reader->GetOutput() );
 287    }
 288    viewer->SetupInteractor (iren);
 289
 290    //vtkFloatingPointType *range = reader->GetOutput()->GetScalarRange();
 291    //viewer->SetColorWindow (range[1] - range[0]);
 292    //viewer->SetColorLevel (0.5 * (range[1] + range[0]));
 293
 294    // Here is where we setup the observer,
 295    vtkgdcmObserver *obs = vtkgdcmObserver::New();
 296    obs->ImageViewer = viewer;
 297    iren->AddObserver(vtkCommand::CharEvent,obs);
 298    obs->Delete();
 299
 300    //viewer->Render();
 301    iren->Initialize();
 302    iren->Start();
 303
 304    //if you wish you can export dicom to a vtk file
 305    vtkStructuredPointsWriter *writer = vtkStructuredPointsWriter::New();
 306    writer->SetInput( reader->GetOutput());
 307    writer->SetFileName( "foo.vtk" );
 308    writer->SetFileTypeToBinary();
 309    //writer->Write();
 310
 311    reader->Delete();
 312    iren->Delete();
 313    viewer->Delete();
 314    writer->Delete();
 315
 316    return 0;
 317 }
 318
 319
 320 // --------------------------------------------------------
 321 // This is just a *very* simple example of user supplied function
 322 //      to mirror (why not ?) the image
 323 // It's *not* part of gdcm.
 324 // --------------------------------------------------------
 325
 326 #define UF(ty)                          \
 327    int i, j;                            \
 328    ty *imj;                             \
 329    ty tamp;                             \
 330    for (j=0;j<ny;j++)                   \
 331    {                                    \
 332       imj = (ty *)im +j*nx;             \
 333       for (i=0;i<nx/2;i++)              \
 334       {                                 \
 335         tamp       =imj[i];             \
 336         imj[i]     =imj[nx-1-i];        \
 337         imj[nx-1-i]=tamp;               \
 338       }                                 \
 339    }                                    \
 340    if (nx%2 != 0)                       \
 341    {                                    \
 342       i = nx / 2;                       \
 343       for (j=0;j<ny;j++)                \
 344       {                                 \
 345         imj = (ty *)im  +j*nx;          \
 346         tamp       =imj[i];             \
 347         imj[i]     =imj[nx/2+1];        \
 348         imj[nx/2+1]=tamp;               \
 349       }                                 \
 350    }
 351
 352 void userSuppliedMirrorFunction(uint8_t *im, gdcm::File *f)
 353 {
 354    if (f->GetZSize() != 1)
 355    {
 356       std::cout << "mirror : Multiframe images not yet dealt with" << std::endl;
 357       return;
 358    }
 359
 360    if (f->GetSamplesPerPixel() != 1 || f->GetBitsAllocated() == 24)
 361    {
 362       std::cout << "mirror : RGB / YBR not yet dealt with" << std::endl;
 363       return;
 364    }
 365    int nx = f->GetXSize();
 366    int ny = f->GetYSize();
 367
 368    std::string pixelType = f->GetPixelType();
 369    if ( pixelType ==  "8U" || pixelType == "8S" )
 370    {
 371       UF(uint8_t)
 372       return;
 373    }
 374    if ( pixelType == "16U" || pixelType == "16S")
 375    {
 376       UF(uint16_t)
 377       return;
 378    }
 379    std::cout << "mirror : Pixel Size (!=8, !=16) not yet dealt with"
 380              << std::endl;
 381    return;
 382 }
 383
 384
 385 // --------------------------------------------------------
 386 // This is just a *very* simple example of user supplied function
 387 //      to topdown (why not ?) the image
 388 // It's *not* part of gdcm.
 389 // --------------------------------------------------------
 390
 391 #define UF2(ty)                         \
 392    int i, j;                            \
 393    ty *imj, *imJ;                       \
 394    ty tamp;                             \
 395    for (j=0;j<ny/2;j++)                 \
 396    {                                    \
 397       imj = (ty *)im +j*nx;             \
 398       imJ = (ty *)im +(ny-1-j)*nx;      \
 399       for (i=0;i<nx;i++)                \
 400       {                                 \
 401         tamp       =imj[i];             \
 402         imj[i]     =imJ[i];             \
 403         imJ[i]     =tamp;               \
 404       }                                 \
 405    }
 406
 407 void userSuppliedTopDownFunction(uint8_t *im, gdcm::File *f)
 408 {
 409    if (f->GetZSize() != 1)
 410    {
 411       std::cout << "mirror : Multiframe images not yet dealt with" << std::endl;
 412       return;
 413    }
 414
 415    if (f->GetSamplesPerPixel() != 1 || f->GetBitsAllocated() == 24)
 416    {
 417       std::cout << "mirror : RGB / YBR not yet dealt with" << std::endl;
 418       return;
 419    }
 420    int nx = f->GetXSize();
 421    int ny = f->GetYSize();
 422
 423    std::string pixelType = f->GetPixelType();
 424    if ( pixelType ==  "8U" || pixelType == "8S" )
 425    {
 426       UF2(uint8_t)
 427       return;
 428    }
 429    if ( pixelType == "16U" || pixelType == "16S")
 430    {
 431       UF2(uint16_t)
 432       return;
 433    }
 434    std::cout << "topdown : Pixel Size (!=8, !=16) not yet dealt with"
 435              << std::endl;
 436    return;
 437 }
 438
 439 // --------------------------------------------------------
 440 // This is just a *very* simple example of user supplied 'LessThan' function
 441 // It's *not* part of gdcm.
 442 //
 443 // Note : orderNb and elemsToOrderOn are here global variables.
 444 // Within a 'normal' function they would't be any orderNb and elemsToOrderOn var
 445 // User *knows* on what field(s) he wants to compare;
 446 // He just writes a decent function.
 447 // Here, we want to get info from the command line Argument Manager.
 448 //
 449 // Warning : it's up to 'vtkgdcmSerieViewer' user to find a suitable data set !
 450 // --------------------------------------------------------
 451
 452
 453 bool userSuppliedLessThanFunction(gdcm::File *f1, gdcm::File *f2)
 454 {
 455    // for *this* user supplied function, I supposed only ValEntries are checked.
 456 //
 457    std::string s1, s2;
 458    gdcm::DataEntry *e1,*e2;
 459    for (int ri=0; ri<orderNb; ri++)
 460    {
 461       std::cout << std::hex << elemsToOrderOn[2*ri] << "|"
 462                             << elemsToOrderOn[2*ri+1]
 463                             << std::endl;
 464
 465       e1= f1->GetDataEntry( elemsToOrderOn[2*ri],
 466                  elemsToOrderOn[2*ri+1]);
 467
 468       e2= f2->GetDataEntry( elemsToOrderOn[2*ri],
 469                                  elemsToOrderOn[2*ri+1]);
 470       if(!e2 || !e2)
 471       {
 472          std::cout << std::hex << elemsToOrderOn[2*ri] << "|"
 473                               << elemsToOrderOn[2*ri+1]
 474                               << " not found" << std::endl;
 475          continue;
 476       }
 477       s1 = e1->GetString();
 478       s2 = e2->GetString();
 479       std::cout << "[" << s1 << "] vs [" << s2 << "]" << std::endl;
 480       if ( s1 < s2 )
 481          return true;
 482       else if (s1 == s2 )
 483          continue;
 484       else
 485          return false;
 486    }
 487    return false; // all fields equal
 488 }
 489
 490 // --------------------------------------------------------
 491 // This is just an other *very* simple example of user supplied 'LessThan'
 492 // function
 493 // It's *not* part of gdcm.
 494 //
 495 // Warning : it's up to 'vtkgdcmSerieViewer' user to find a suitable data set !
 496 // --------------------------------------------------------
 497
 498 bool userSuppliedLessThanFunction2(gdcm::File *f1, gdcm::File *f2)
 499 {
 500    std::cout << "[" << f1->GetFileName() << "] vs ["
 501                     << f2->GetFileName() << "]" << std::endl;
 502    return f1->GetFileName() < f2->GetFileName();
 503 }