Example/SplitIntoXCoherentDirectories.cxx

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: SplitIntoXCoherentDirectories.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2007/10/24 08:03:10 $
   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 #include "gdcmSerieHelper.h"
  19 #include "gdcmFileHelper.h"
  20 #include "gdcmFile.h"
  21 #include "gdcmDebug.h"
  22 #include <iostream>
  23 #include "gdcmDirList.h"
  24 #include "gdcmUtil.h"
  25 #include "gdcmArgMgr.h"
  26 #include "gdcmDictSet.h"  // for GetName
  27 int main(int argc, char *argv[])
  28 {
  29
  30    START_USAGE(usage)
  31    "\n exXCoherentFileSet :\n                                                 ",
  32    "Shows the various 'XCoherent' Filesets within a directory                 ",
  33    "Optionaly copis the images in a Directories tree                          ",
  34    "usage: exXCoherentFileSet {dirin=inputDirectoryName}                      ",
  35    "                           dirout=outputDirectoryName                     ",
  36    "                       { tag=group-elem | pos | ori } [sort]              ",
  37    "                       [{ write | copy }] [studyUID = ]                   ",
  38    "                       [ { [noshadowseq] | [noshadow][noseq] } ] [debug]  ",
  39    "                                                                          ",
  40    "       dirin : user wants to analyze *all* the files                      ",
  41    "                            within the directory                          ",
  42    "       copy  : user wants to copy the files into a directories tree       ",
  43    "       write : user wants to rewrite the files into a directories tree    ",
  44    "               each directory with the same 'Series Instance UID'         ",
  45    "       dirout : will be created if doesn't exist                          ",
  46    "       pos  : user wants to split each Single SerieUID Fileset on the     ",
  47    "                         'Image Position '                                ",
  48    "       ori  : user wants to split each Single SerieUID Fileset on the     ",
  49    "                         'Image Orientation '                             ",
  50    "       tag : group-elem    (in hexa, no space)                            ",
  51    "                       the user wants to split on                         ",
  52    "       sort :  user wants FileHelper to sort the images                   ",
  53    "               Warning : will probabely crah if sort has no meaning       ",
  54    "                (not only look at image names)                            ",
  55    "       studyUID   : *aware* user wants to add the serie                   ",
  56    "                                             to an already existing study ",
  57    "       verbose    : user wants to run the program in 'verbose mode'       ",
  58    "       debug      : developper wants to run the program in 'debug mode'   ",
  59    FINISH_USAGE
  60
  61    // ----- Initialize Arguments Manager ------
  62
  63    GDCM_NAME_SPACE::ArgMgr *am = new GDCM_NAME_SPACE::ArgMgr(argc, argv);
  64
  65    if (am->ArgMgrDefined("usage") || argc == 1)
  66    {
  67       am->ArgMgrUsage(usage); // Display 'usage'
  68       delete am;
  69       return 0;
  70    }
  71
  72    if (am->ArgMgrDefined("debug"))
  73       GDCM_NAME_SPACE::Debug::DebugOn();
  74
  75    int loadMode;
  76    int maxSize;
  77
  78    const char *dirName  = am->ArgMgrGetString("dirin");
  79    if (dirName == 0)
  80    {
  81        std::cout <<std::endl
  82                  << "'dirin=' must be present;"
  83                  <<  std::endl;
  84        am->ArgMgrUsage(usage); // Display 'usage'
  85        delete am;
  86        return 0;
  87    }
  88
  89    const char *dirNameout;
  90    dirNameout  = am->ArgMgrGetString("dirout",".");
  91
  92    bool pos  =    ( 0 != am->ArgMgrDefined("pos") );
  93    bool ori  =    ( 0 != am->ArgMgrDefined("ori") );
  94    bool sort =    ( 0 != am->ArgMgrDefined("sort") );
  95    bool copy =    ( 0 != am->ArgMgrDefined("copy") );
  96    bool write =   ( 0 != am->ArgMgrDefined("write") );
  97    bool verbose = ( 0 != am->ArgMgrDefined("verbose") );
  98    bool tag     = ( 0 != am->ArgMgrDefined("tag") );
  99
 100    if( copy && write )
 101    {
 102       std::cout << "COPY and WRITE are mutually exclusive" << std::endl;
 103       delete am;
 104       return 0;
 105    }
 106
 107    if( (tag && (pos || ori)) || (pos && (tag || ori)) || (ori && (tag || pos)) )
 108    {
 109       std::cout << " POS, ORI and TAG are mutually exclusive" << std::endl;
 110       delete am;
 111       return 0;
 112    }
 113
 114    if( (!tag && !pos && !ori))
 115    {
 116       std::cout << " One of POS, ORI and TAG is mandatory!" << std::endl;
 117       delete am;
 118       return 0;
 119    }
 120    int nb;
 121    uint16_t *groupelem;
 122    if (tag)
 123    {
 124       groupelem = am->ArgMgrGetXInt16Enum("tag", &nb);
 125       if (nb != 1)
 126       {
 127          std::cout << "TAG : one and only one group,elem!" << std::endl;
 128          delete am;
 129          return 0;
 130       }
 131    }
 132
 133    bool userDefinedStudy = ( 0 != am->ArgMgrDefined("userDefinedStudy") );
 134    const char *studyUID  = am->ArgMgrGetString("studyUID");
 135
 136    /* if unused Param we give up */
 137    if ( am->ArgMgrPrintUnusedLabels() )
 138    {
 139       am->ArgMgrUsage(usage);
 140       delete am;
 141       return 0;
 142    }
 143
 144    delete am;  // ------ we don't need Arguments Manager any longer ------
 145
 146
 147    GDCM_NAME_SPACE::SerieHelper *s;
 148    s = GDCM_NAME_SPACE::SerieHelper::New();
 149
 150    GDCM_NAME_SPACE::File *f;
 151
 152    GDCM_NAME_SPACE::DirList dirlist(dirName, true); // recursive exploration
 153    GDCM_NAME_SPACE::DirListType fileNames = dirlist.GetFilenames();
 154
 155    GDCM_NAME_SPACE::FileList *l = new GDCM_NAME_SPACE::FileList;
 156 // Loop on all the gdcm-readable files
 157    for (GDCM_NAME_SPACE::DirListType::iterator it = fileNames.begin();
 158                                     it != fileNames.end();
 159                                   ++it)
 160    {
 161       if (verbose)
 162          std::cout << *it << std::endl;
 163
 164       if (write) {
 165          loadMode = GDCM_NAME_SPACE::LD_ALL; // load any DataElement
 166           maxSize  = 0x7fff;                  // load any length
 167       } else {
 168          loadMode = GDCM_NAME_SPACE::LD_NOSEQ | GDCM_NAME_SPACE::LD_NOSHADOW ;
 169          maxSize  = 0x0100;
 170       }
 171
 172       f = GDCM_NAME_SPACE::File::New();
 173       f->SetLoadMode(loadMode);
 174       f->SetMaxSizeLoadEntry(maxSize);
 175       f->SetFileName( *it );
 176       f->Load();
 177       l->push_back(f);
 178    }
 179
 180    std::string systemCommand;
 181    std::string filenameout;
 182    if (write || copy) {
 183       if (verbose)
 184          std::cout << "Check for output directory :[" << dirNameout << "]."
 185                    <<std::endl;
 186       if ( ! GDCM_NAME_SPACE::DirList::IsDirectory(dirNameout) )    // dirout not found
 187       {
 188          std::string strDirNameout(dirNameout);          // to please gcc 4
 189          systemCommand = "mkdir " +strDirNameout;        // create it!
 190          if (verbose)
 191             std::cout << systemCommand << std::endl;
 192          system (systemCommand.c_str());
 193          if ( ! GDCM_NAME_SPACE::DirList::IsDirectory(dirNameout) ) // be sure it worked
 194          {
 195              std::cout << "KO : not a dir : [" << dirNameout << "] (creation failure ?)"
 196                        << std::endl;
 197          return 0;
 198          }
 199          else
 200          {
 201             if (verbose)
 202                std::cout << "Directory [" << dirNameout << "] created." << std::endl;
 203          }
 204       }
 205       else
 206       {
 207          if (verbose)
 208             std::cout << "Output Directory [" << dirNameout
 209                       << "] already exists; Used as is."
 210                       << std::endl;
 211       }
 212    }
 213       // --> End of checking supposed-to-be-directory names
 214
 215    int nbFiles;
 216    std::string fileName;
 217
 218    // For all the Single SerieUID Files Sets of the GDCM_NAME_SPACE::Serie
 219
 220    //GDCM_NAME_SPACE::FileList *l = s->GetFirstSingleSerieUIDFileSet();//===> Ignore 'Serie UID"
 221
 222    GDCM_NAME_SPACE::XCoherentFileSetmap xcm;
 223
 224    std::string serieUID;
 225    std::string currentSerieWriteDir = "";
 226    std::string xCoherentWriteDir = "";
 227    std::string xCoherentName = "";
 228    std::string serieDirectory;
 229    std::string lastFilename;
 230    std::string rep("_");
 231    int controlCount = 0;
 232
 233    // 'Study Instance UID'
 234    // The user is allowed to create his own Study,
 235    //          keeping the same 'Study Instance UID' for various images
 236    // The user may add images to a 'Manufacturer Study',
 237    //          adding new Series to an already existing Study
 238    std::string strStudyUID;
 239    if (write) {
 240       if ( !userDefinedStudy )
 241          strStudyUID =  GDCM_NAME_SPACE::Util::CreateUniqueUID();
 242       else
 243          strStudyUID = studyUID;
 244    }
 245
 246 //   while (l) // for each 'Single SerieUID FileSet' //===> Ignore 'Serie UID"
 247 //   {
 248       nbFiles = l->size() ;
 249       if ( l->size() > 2 ) // ignore a Directory with less than 2 images.
 250                            // Why not ? Just an example, for testing!
 251       {
 252           // Just not to make too many modif in the code
 253           serieUID = "SingleSerie"; //s->GetCurrentSerieUIDFileSetUID();
 254           GDCM_NAME_SPACE::Util::ReplaceSpecChar(serieUID, rep);
 255
 256           // --- for write
 257           if (write || copy)
 258           {
 259              currentSerieWriteDir = currentSerieWriteDir + dirNameout;
 260              unsigned int l = strlen(dirNameout)-1;
 261              if ( dirNameout[l] != '/'  &&  dirNameout[l] != '\\')
 262                 currentSerieWriteDir = currentSerieWriteDir + GDCM_NAME_SPACE::GDCM_FILESEPARATOR;
 263
 264              currentSerieWriteDir = currentSerieWriteDir + serieUID;
 265              if (verbose)
 266                 std::cout << "[" << currentSerieWriteDir<< "]" << std::endl;
 267             // if ( ! GDCM_NAME_SPACE::DirList::IsDirectory(currentSerieWriteDir) )
 268              {
 269                 systemCommand   = "mkdir " + currentSerieWriteDir;
 270                 system( systemCommand.c_str());
 271                 if (verbose)
 272                    std::cout <<  "1 " <<systemCommand << std::endl;
 273              }
 274          }
 275           // --- end for write
 276
 277          std::cout << "Split the 'Single SerieUID' FileSet :["
 278                    << serieUID
 279                    << "]  " << nbFiles << " long" << std::endl;
 280          std::cout << "-----------------------------------" << std::endl;
 281
 282 GDCM_NAME_SPACE::Debug::DebugOn();
 283
 284
 285          if (ori)
 286             xcm = s->SplitOnOrientation(l);
 287          else if (pos)
 288             xcm = s->SplitOnPosition(l);
 289          else if (groupelem != 0) {
 290
 291             std:: cout << GDCM_NAME_SPACE::Global::GetDicts()->GetDefaultPubDict()->GetEntry(groupelem[0],groupelem[1])->GetName() << std::endl;
 292
 293             xcm = s->SplitOnTagValue(l, groupelem[0],groupelem[1] );
 294          }
 295
 296          GDCM_NAME_SPACE::FileHelper *fh;
 297
 298          for (GDCM_NAME_SPACE::XCoherentFileSetmap::iterator i = xcm.begin();
 299                                                   i != xcm.end();
 300                                                 ++i)
 301          {
 302             xCoherentName = (*i).first;
 303             if (verbose)
 304                std::cout << "xCoherentName = " << xCoherentName << std::endl;
 305              GDCM_NAME_SPACE::Util::ReplaceSpecChar(xCoherentName, rep);
 306              // --- for write
 307              if (write || copy)
 308              {
 309                 xCoherentWriteDir = currentSerieWriteDir + GDCM_NAME_SPACE::GDCM_FILESEPARATOR+ xCoherentName;
 310                // if ( ! GDCM_NAME_SPACE::DirList::IsDirectory(xCoherentWriteDir) )
 311                 {
 312                    systemCommand   = "mkdir " + xCoherentWriteDir;
 313                    system( systemCommand.c_str());
 314                    if (verbose)
 315                       std::cout << "2 " << systemCommand << std::endl;
 316                 }
 317             }
 318             // --- end for write
 319
 320             if (ori)
 321                std::cout << "Orientation : ";
 322             else if (pos)
 323                std::cout << "Position : ";
 324             else if (groupelem != 0)
 325                std::cout << "Tag (" << std::hex << groupelem[0]
 326                          << "|" << groupelem[1] << ") value : ";
 327             std::cout << "[" << (*i).first << "]" << std::endl;
 328
 329             if (verbose)
 330                std::cout << "xCoherentName [" << xCoherentName << "]" << std::endl;
 331
 332            // Within a 'just to see' program,
 333            // OrderFileList() causes trouble, since some files
 334            // (eg:MIP views) don't have 'Position', now considered as mandatory
 335            // --> Activated on user demand.
 336
 337             if (sort) {
 338               s->OrderFileList((*i).second);  // sort the XCoherent Fileset
 339               std::cout << "ZSpacing for the file set " << s->GetZSpacing()
 340                         << std::endl;
 341             }
 342
 343             std::string strSerieUID =  GDCM_NAME_SPACE::Util::CreateUniqueUID();
 344
 345             for (GDCM_NAME_SPACE::FileList::iterator it2 =  ((*i).second)->begin();
 346                                           it2 != ((*i).second)->end();
 347                                         ++it2)
 348             {
 349                controlCount ++;
 350                fileName = (*it2)->GetFileName();
 351                std::cout << "    " << fileName << std::endl;
 352
 353                // --- for write
 354                lastFilename =  GDCM_NAME_SPACE::Util::GetName( fileName );
 355                filenameout = xCoherentWriteDir  + GDCM_NAME_SPACE::GDCM_FILESEPARATOR+ lastFilename;
 356                if (write)
 357                {
 358                   fh = GDCM_NAME_SPACE::FileHelper::New( (*it2) );
 359                   fh->SetKeepOverlays( true );
 360                   fh->InsertEntryString(strSerieUID,0x0020,0x000e,"UI");
 361                   unsigned int dataSize  = fh->GetImageDataRawSize();
 362                   uint8_t *imageData = fh->GetImageDataRaw();// somewhat important : Loads the Pixels in memory !
 363                   if (!imageData)
 364                      std::cout << "fail to read [" << (*it2)->GetFileName() << std::endl;
 365                   fh->SetWriteTypeToDcmExplVR();
 366                   fh->SetContentType(GDCM_NAME_SPACE::UNMODIFIED_PIXELS_IMAGE);
 367                   if (!fh->Write(filenameout))
 368                   {
 369                      std::cout << "Fail to write :[" << filenameout << "]"
 370                                << std::endl;
 371                   }
 372                   fh->Delete();
 373                }
 374                else if (copy)
 375                {
 376                    systemCommand   = "cp " + fileName + " " + filenameout;
 377                    system( systemCommand.c_str());
 378                }
 379                if (verbose)
 380                      std::cout << "3 " << systemCommand << std::endl;
 381             }
 382             std::cout << std::endl;
 383          }
 384       }
 385      // l = s->GetNextSingleSerieUIDFileSet(); //===> Ignore 'Serie UID"
 386
 387    if ( controlCount == 0 )
 388       std::cout << "No suitable file was found!" << std::endl;
 389
 390    s->Delete();
 391    return 0;
 392 }