src/gdcmSerieHeader.cxx

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmSerieHeader.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2005/01/14 22:20:11 $
   7   Version:   $Revision: 1.9 $
   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
  19 #include "gdcmSerieHeader.h"
  20 #include "gdcmDirList.h"
  21 #include "gdcmHeader.h"
  22 #include "gdcmDebug.h"
  23
  24 #include <math.h>
  25 #include <algorithm>
  26 #include <vector>
  27
  28 namespace gdcm
  29 {
  30
  31 typedef std::vector<Header* > GdcmHeaderVector;
  32 //-----------------------------------------------------------------------------
  33 // Constructor / Destructor
  34 SerieHeader::SerieHeader()
  35 {
  36    CoherentGdcmFileList.clear();
  37    // Later will contain: 0020 000e UI REL Series Instance UID
  38    CurrentSerieUID = "";
  39 }
  40
  41 SerieHeader::~SerieHeader()
  42 {
  43    /// \todo
  44    for ( GdcmHeaderList::const_iterator it = CoherentGdcmFileList.begin();
  45          it != CoherentGdcmFileList.end(); ++it)
  46    {
  47       delete *it;
  48    }
  49    CoherentGdcmFileList.clear();
  50 }
  51
  52 //-----------------------------------------------------------------------------
  53 // Print
  54
  55 //-----------------------------------------------------------------------------
  56 // Public
  57 /**
  58  * \brief add a File to the list based on file name
  59  * @param   filename Name of the file to deal with
  60  */
  61 void SerieHeader::AddFileName(std::string const &filename)
  62 {
  63    //directly use string and not const char*:
  64    Header *header = new Header( filename );
  65    if( header->IsReadable() )
  66    {
  67       // 0020 000e UI REL Series Instance UID
  68       std::string uid =  header->GetEntry (0x0020, 0x000e);
  69       // if uid == GDCM_UNFOUND then consistenly we should find GDCM_UNFOUND
  70       // no need here to do anything special
  71       if( CurrentSerieUID == "" )
  72       {
  73          // Set the current one
  74          CurrentSerieUID = uid;
  75       }
  76       if( CurrentSerieUID == uid )
  77       {
  78          // Current Serie UID and DICOM header seems to match add the file:
  79          CoherentGdcmFileList.push_back( header );
  80       }
  81       else
  82       {
  83          gdcmVerboseMacro("Wrong Serie Instance UID should be:" << CurrentSerieUID );
  84       }
  85    }
  86    else
  87    {
  88       gdcmVerboseMacro("Could not read file: " << filename );
  89       delete header;
  90    }
  91 }
  92
  93 /**
  94  * \brief Sets the Directory
  95  * @param   dir Name of the directory to deal with
  96  */
  97 void SerieHeader::SetDirectory(std::string const &dir)
  98 {
  99    CurrentSerieUID = ""; //Reset previous Serie Instance UID
 100    DirList dirList(dir);  //OS specific
 101
 102    DirListType filenames_list = dirList.GetFilenames();
 103    for( DirListType::const_iterator it = filenames_list.begin();
 104         it != filenames_list.end(); ++it)
 105    {
 106       AddFileName( *it );
 107    }
 108 }
 109
 110 /**
 111  * \brief Sorts the File List
 112  * \warning This could be implemented in a 'Strategy Pattern' approach
 113  *          But as I don't know how to do it, I leave it this way
 114  *          BTW, this is also a Strategy, I don't know this is the best approach :)
 115  */
 116 void SerieHeader::OrderGdcmFileList()
 117 {
 118    if( ImagePositionPatientOrdering() )
 119    {
 120       return ;
 121    }
 122    else if( ImageNumberOrdering() )
 123    {
 124       return ;
 125    }
 126    else
 127    {
 128       FileNameOrdering();
 129    }
 130 }
 131
 132 //-----------------------------------------------------------------------------
 133 // Protected
 134
 135 //-----------------------------------------------------------------------------
 136 // Private
 137 /**
 138  * \ingroup Header
 139  * \brief sorts the images, according to their Patient Position
 140  *  We may order, considering :
 141  *   -# Image Number
 142  *   -# Image Position Patient
 143  *   -# More to come :)
 144  * @return false only if the header is bugged !
 145  */
 146 bool SerieHeader::ImagePositionPatientOrdering()
 147 //based on Jolinda's algorithm
 148 {
 149    //iop is calculated based on the file file
 150    float cosines[6];
 151    float normal[3];
 152    float ipp[3];
 153    float dist;
 154    float min = 0, max = 0;
 155    bool first = true;
 156    int n=0;
 157    std::vector<float> distlist;
 158
 159    //!\todo rewrite this for loop.
 160    for ( GdcmHeaderList::const_iterator
 161          it = CoherentGdcmFileList.begin();
 162          it != CoherentGdcmFileList.end(); ++it )
 163    {
 164       if( first )
 165       {
 166          (*it)->GetImageOrientationPatient( cosines );
 167
 168          //You only have to do this once for all slices in the volume. Next,
 169          // for each slice, calculate the distance along the slice normal
 170          // using the IPP tag ("dist" is initialized to zero before reading
 171          // the first slice) :
 172          normal[0] = cosines[1]*cosines[5] - cosines[2]*cosines[4];
 173          normal[1] = cosines[2]*cosines[3] - cosines[0]*cosines[5];
 174          normal[2] = cosines[0]*cosines[4] - cosines[1]*cosines[3];
 175
 176          ipp[0] = (*it)->GetXOrigin();
 177          ipp[1] = (*it)->GetYOrigin();
 178          ipp[2] = (*it)->GetZOrigin();
 179
 180          dist = 0;
 181          for ( int i = 0; i < 3; ++i )
 182          {
 183             dist += normal[i]*ipp[i];
 184          }
 185
 186          if( dist == 0 )
 187          {
 188             return false;
 189          }
 190
 191          distlist.push_back( dist );
 192
 193          max = min = dist;
 194          first = false;
 195       }
 196       else
 197       {
 198          ipp[0] = (*it)->GetXOrigin();
 199          ipp[1] = (*it)->GetYOrigin();
 200          ipp[2] = (*it)->GetZOrigin();
 201
 202          dist = 0;
 203          for ( int i = 0; i < 3; ++i )
 204          {
 205             dist += normal[i]*ipp[i];
 206          }
 207
 208          if( dist == 0 )
 209          {
 210             return false;
 211          }
 212
 213          distlist.push_back( dist );
 214
 215          min = (min < dist) ? min : dist;
 216          max = (max > dist) ? max : dist;
 217       }
 218       ++n;
 219    }
 220
 221    // Then I order the slices according to the value "dist". Finally, once
 222    // I've read in all the slices, I calculate the z-spacing as the difference
 223    // between the "dist" values for the first two slices.
 224    GdcmHeaderVector CoherentGdcmFileVector(n);
 225    // CoherentGdcmFileVector.reserve( n );
 226    CoherentGdcmFileVector.resize( n );
 227    // gdcmAssertMacro( CoherentGdcmFileVector.capacity() >= n );
 228
 229    float step = (max - min)/(n - 1);
 230    int pos;
 231    n = 0;
 232
 233    //VC++ don't understand what scope is !! it -> it2
 234    for (GdcmHeaderList::const_iterator it2  = CoherentGdcmFileList.begin();
 235         it2 != CoherentGdcmFileList.end(); ++it2, ++n)
 236    {
 237       //2*n sort algo !!
 238       //Assumption: all files are present (no one missing)
 239       pos = (int)( fabs( (distlist[n]-min)/step) + .5 );
 240
 241       CoherentGdcmFileVector[pos] = *it2;
 242    }
 243
 244    CoherentGdcmFileList.clear();  //this doesn't delete list's element, node only
 245
 246    //VC++ don't understand what scope is !! it -> it3
 247    for (GdcmHeaderVector::const_iterator it3  = CoherentGdcmFileVector.begin();
 248         it3 != CoherentGdcmFileVector.end(); ++it3)
 249    {
 250       CoherentGdcmFileList.push_back( *it3 );
 251    }
 252
 253    distlist.clear();
 254    CoherentGdcmFileVector.clear();
 255
 256    return true;
 257 }
 258
 259 /**
 260  * \ingroup Header
 261  * \brief sorts the images, according to their Image Number
 262  * @return false only if the header is bugged !
 263  */
 264
 265 bool SerieHeader::ImageNumberOrdering()
 266 {
 267    int min, max, pos;
 268    int n = 0;//CoherentGdcmFileList.size() is a O(N) operation
 269    unsigned char *partition;
 270
 271    GdcmHeaderList::const_iterator it = CoherentGdcmFileList.begin();
 272    min = max = (*it)->GetImageNumber();
 273
 274    for (; it != CoherentGdcmFileList.end(); ++it, ++n)
 275    {
 276       pos = (*it)->GetImageNumber();
 277
 278       //else
 279       min = (min < pos) ? min : pos;
 280       max = (max > pos) ? max : pos;
 281    }
 282
 283    // Find out if sorting worked:
 284    if( min == max || max == 0 || max > (n+min)) return false;
 285
 286    //bzeros(partition, n); //This function is deprecated, better use memset.
 287    partition = new unsigned char[n];
 288    memset(partition, 0, n);
 289
 290    GdcmHeaderVector CoherentGdcmFileVector(n);
 291
 292    //VC++ don't understand what scope is !! it -> it2
 293    for (GdcmHeaderList::const_iterator it2 = CoherentGdcmFileList.begin();
 294         it2 != CoherentGdcmFileList.end(); ++it2)
 295    {
 296       pos = (*it2)->GetImageNumber();
 297       CoherentGdcmFileVector[pos - min] = *it2;
 298       partition[pos - min]++;
 299    }
 300
 301    unsigned char mult = 1;
 302    for( int i=0; i<n ; i++ )
 303    {
 304       mult *= partition[i];
 305    }
 306
 307    //VC++ don't understand what scope is !! it -> it3
 308    CoherentGdcmFileList.clear();  //this doesn't delete list's element, node only
 309    for ( GdcmHeaderVector::const_iterator it3 = CoherentGdcmFileVector.begin();
 310          it3 != CoherentGdcmFileVector.end(); ++it3 )
 311    {
 312       CoherentGdcmFileList.push_back( *it3 );
 313    }
 314    CoherentGdcmFileVector.clear();
 315
 316    delete[] partition;
 317
 318    return mult != 0;
 319 }
 320
 321
 322 /**
 323  * \ingroup Header
 324  * \brief sorts the images, according to their File Name
 325  * @return false only if the header is bugged !
 326  */
 327 bool SerieHeader::FileNameOrdering()
 328 {
 329    //using the sort
 330    //sort(CoherentGdcmFileList.begin(), CoherentGdcmFileList.end());
 331    return true;
 332 }
 333
 334 } // end namespace gdcm
 335 //-----------------------------------------------------------------------------