]> Creatis software - gdcm.git/blobdiff - src/gdcmFile.cxx
ENH: Try to sync gdcm CVS and gdcm 1.2. ~2000 lines of changes, please be gentle...
[gdcm.git] / src / gdcmFile.cxx
index 9d435e133f60c9cc2783907bc7d676fbe47ea751..e2effd6364ac30f3e474a5be0c49944e66296270 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmFile.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/10/25 15:28:49 $
-  Version:   $Revision: 1.296 $
+  Date:      $Date: 2006/02/16 20:06:14 $
+  Version:   $Revision: 1.315 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
 //
 // --------------  Remember ! ----------------------------------
 //
-// Image Position Patient                              (0020,0032):
+// Image Position (Patient)                            (0020,0032):
 // If not found (ACR_NEMA) we try Image Position       (0020,0030)
 // If not found (ACR-NEMA), we consider Slice Location (0020,1041)
 //                                   or Location       (0020,0050) 
 //                                   as the Z coordinate, 
 // 0. for all the coordinates if nothing is found
 //
-// Image Position (Patient) (0020,0032) VM=3 What is it used for?
+// Image Position (Patient) (0020,0032) VM=3
 // -->
 //  The attribute Patient Orientation (0020,0020) from the General Image Module 
 // is of type 2C and has the condition Required if image does not require 
 // Image Orientation (0020,0037) and Image Position (0020,0032). 
 // However, if the image does require the attributes 
 // - Image Orientation (Patient) (0020,0037), VM=6
-// - Image Position Patient (0020,0032), VM=3
+// - Image Position (Patient)    (0020,0032), VM=3
 // then attribute Patient Orientation (0020,0020) should not be present
 //  in the images.
 //
@@ -65,7 +65,7 @@
 // FFDR = Feet First-Decubitus Right
 // FFDL = Feet First-Decubitus Left
 
-//  we can also find      
+//  we can also find (non standard!)     
 
 // SEMIERECT
 // SUPINE
@@ -124,7 +124,7 @@ File::File():
 /**
  * \brief   Canonical destructor.
  */
-File::~File ()
+File::~File()
 {
    if ( RLEInfo )
       delete RLEInfo;
@@ -155,7 +155,6 @@ bool File::Load( )
  */
 bool File::DoTheLoadingJob( ) 
 {
-
    // for some ACR-NEMA images GrPixel, NumPixel is *not* 7fe0,0010
    // We may encounter the 'RETired' (0x0028, 0x0200) tag
    // (Image Location") . This entry contains the number of
@@ -469,9 +468,13 @@ float File::GetXSpacing()
    {
       nbValue = entry->GetValueCount();
       // Can't use IsValueCountValid because of the complex heuristic.
+      if( nbValue !=2 )
+         gdcmWarningMacro("ImagerPixelSpacing (0x0018,0x1164) "
+         << "has a wrong number of values :" << nbValue);
+     
       if( nbValue >= 3 )
          xspacing = (float)entry->GetValue(2);
-      if( nbValue >= 2 )
+      else if( nbValue >= 2 )
          xspacing = (float)entry->GetValue(1);
       else
          xspacing = (float)entry->GetValue(0);
@@ -489,6 +492,10 @@ float File::GetXSpacing()
    if( entry )
    {
       nbValue = entry->GetValueCount();
+      if( nbValue !=2 )
+         gdcmWarningMacro("PixelSpacing (0x0018,0x0030) "
+          << "has a wrong number of values :" << nbValue);      
+      
       if( nbValue >= 3 )
          xspacing = (float)entry->GetValue(2);
       else if( nbValue >= 2 )
@@ -554,18 +561,17 @@ float File::GetYSpacing()
  * \brief gets the info from 0018,0088 : Space Between Slices
  *                 else from 0018,0050 : Slice Thickness
  *                 else 1.0
+ *
+ * When an element is missing, we suppose slices join together
+ * (no overlapping, no interslice gap) but we have no way to check it !
+ * For *Dicom* images, ZSpacing *should be* calculated using 
+ * XOrigin, YOrigin, ZOrigin (of the top left image corner)
+ * of 2 consecutive images, and the Orientation
+ * Computing ZSpacing on a single image is not really meaningfull ! 
  * @return Z dimension of a voxel-to be
  */
 float File::GetZSpacing()
 {
-   // --->
-   // ---> Warning :
-   // --->
-  // For *Dicom* images, ZSpacing should be calculated using 
-  // XOrigin, YOrigin, ZOrigin (of the top left image corner)
-  // of 2 consecutive images, and the Orientation
-  // 
-  // Computing ZSpacing on a single image is not really meaningfull !
 
    float zspacing = 1.0f;
 
@@ -593,7 +599,6 @@ float File::GetZSpacing()
    // if no 'Spacing Between Slices' is found, 
    // we assume slices join together
    // (no overlapping, no interslice gap)
-   // if they don't, we're fucked up
    entry = GetDataEntry(0x0018,0x0050);
    if( entry )
    {
@@ -606,6 +611,21 @@ float File::GetZSpacing()
    else
       gdcmWarningMacro("Unfound Slice Thickness (0018,0050)");
 
+   // if no 'Spacing Between Slices' is found, 
+   // we assume slices join together
+   // (no overlapping, no interslice gap)
+   entry = GetDataEntry(0x3004,0x000c);
+   if( entry )
+   {
+      float z1 = (float)entry->GetValue(0);
+      float z2 = (float)entry->GetValue(1);
+      zspacing = z2 - z1; // can be negative...
+
+      if ( zspacing == 0.0 )
+         zspacing = 1.0;
+      return zspacing;
+   }
+
    return zspacing;
 }
 
@@ -747,16 +767,21 @@ float File::GetZOrigin()
 /**
   * \brief gets the info from 0020,0037 : Image Orientation Patient
   *                   or from 0020 0035 : Image Orientation (RET)
+  *
   * (needed to organize DICOM files based on their x,y,z position)
-  * @param iop adress of the (6)float array to receive values
-  * @return true when one of the tag is found
-  *         false when nothing is found
+  *
+  * @param iop adress of the (6)float array to receive values.
+  *        (defaulted as 1.,0.,0.,0.,1.,0. if nothing -or inconsistent stuff-
+  *        is found.
+  * @return true when one of the tag -with consistent values- is found
+  *         false when nothing or inconsistent stuff - is found
   */
 bool File::GetImageOrientationPatient( float iop[6] )
 {
    std::string strImOriPat;
    //iop is supposed to be float[6]
-   iop[0] = iop[1] = iop[2] = iop[3] = iop[4] = iop[5] = 0.;
+   iop[0] = iop[4] = 1.;
+   iop[1] = iop[2] = iop[3] = iop[5] = 0.;
 
    // 0020 0037 DS REL Image Orientation (Patient)
    if ( (strImOriPat = GetEntryString(0x0020,0x0037)) != GDCM_UNFOUND )
@@ -768,6 +793,7 @@ bool File::GetImageOrientationPatient( float iop[6] )
                         << " Less than 6 values were found." );
          return false;
       }
+      return true;
    }
    //For ACR-NEMA
    // 0020 0035 DS REL Image Orientation (RET)
@@ -780,8 +806,9 @@ bool File::GetImageOrientationPatient( float iop[6] )
                         << "Less than 6 values were found." );
          return false;
       }
+      return true;
    }
-   return true;
+   return false;
 }
 
 /**
@@ -795,7 +822,7 @@ int File::GetBitsStored()
    DataEntry *entry = GetDataEntry(0x0028,0x0101);
    if( !entry )
    {
-      gdcmWarningMacro("(0028,0101) is supposed to be mandatory");
+      gdcmWarningMacro("BitsStored (0028,0101) is supposed to be mandatory");
       return 0;
    }
    return (int)entry->GetValue(0);
@@ -812,7 +839,7 @@ int File::GetBitsAllocated()
    DataEntry *entry = GetDataEntry(0x0028,0x0100);
    if( !entry )
    {
-      gdcmWarningMacro("(0028,0100) is supposed to be mandatory");
+      gdcmWarningMacro("BitsAllocated (0028,0100) is supposed to be mandatory");
       return 0;
    }
    return (int)entry->GetValue(0);
@@ -829,7 +856,7 @@ int File::GetHighBitPosition()
    DataEntry *entry = GetDataEntry(0x0028,0x0102);
    if( !entry )
    {
-      gdcmWarningMacro("(0028,0102) is supposed to be mandatory");
+      gdcmWarningMacro("HighBitPosition (0028,0102) is supposed to be mandatory");
       return 0;
    }
    return (int)entry->GetValue(0);
@@ -846,7 +873,7 @@ int File::GetSamplesPerPixel()
    DataEntry *entry = GetDataEntry(0x0028,0x0002);
    if( !entry )
    {
-      gdcmWarningMacro("(0028,0002) is supposed to be mandatory");
+      gdcmWarningMacro("SamplesPerPixel (0028,0002) is supposed to be mandatory");
       return 1; // Well, it's supposed to be mandatory ...
                 // but sometimes it's missing : *we* assume Gray pixels
    }
@@ -863,7 +890,6 @@ int File::GetPlanarConfiguration()
    DataEntry *entry = GetDataEntry(0x0028,0x0006);
    if( !entry )
    {
-      gdcmWarningMacro( "Not found : Planar Configuration (0028,0006)");
       return 0;
    }
    return (int)entry->GetValue(0);
@@ -921,7 +947,7 @@ std::string File::GetPixelType()
    std::string bitsAlloc = GetEntryString(0x0028, 0x0100); // Bits Allocated
    if ( bitsAlloc == GDCM_UNFOUND )
    {
-      gdcmWarningMacro( "Missing  Bits Allocated (0028,0100)");
+      gdcmWarningMacro( "Bits Allocated (0028,0100) supposed to be mandatory");
       bitsAlloc = "16"; // default and arbitrary value, not to polute the output
    }
 
@@ -965,7 +991,8 @@ bool File::IsSignedPixelData()
    DataEntry *entry = GetDataEntry(0x0028, 0x0103);//"Pixel Representation"
    if( !entry )
    {
-      gdcmWarningMacro( "Missing Pixel Representation (0028,0103)");
+      gdcmWarningMacro( "Pixel Representation (0028,0103) supposed to be "
+                      << "mandatory");
       return false;
    }
    return entry->GetValue(0) != 0;
@@ -986,7 +1013,8 @@ bool File::IsMonochrome()
    }
    if ( PhotometricInterp == GDCM_UNFOUND )
    {
-      gdcmWarningMacro( "Not found : Photometric Interpretation (0028,0004)");
+      gdcmWarningMacro( "Photometric Interpretation (0028,0004) supposed to be "
+                         << "mandatory");
    }
    return false;
 }
@@ -1005,7 +1033,8 @@ bool File::IsMonochrome1()
    }
    if ( PhotometricInterp == GDCM_UNFOUND )
    {
-      gdcmWarningMacro( "Not found : Photometric Interpretation (0028,0004)");
+      gdcmWarningMacro( "Photometric Interpretation (0028,0004) : supposed to"
+      << " be mandatory! ");
    }
    return false;
 }
@@ -1024,7 +1053,7 @@ bool File::IsPaletteColor()
    }
    if ( PhotometricInterp == GDCM_UNFOUND )
    {
-      gdcmWarningMacro( "Not found : Palette color (0028,0004)");
+      gdcmDebugMacro( "Not found : Palette color (0028,0004)");
    }
    return false;
 }
@@ -1043,7 +1072,7 @@ bool File::IsYBRFull()
    }
    if ( PhotometricInterp == GDCM_UNFOUND )
    {
-      gdcmWarningMacro( "Not found : YBR Full (0028,0004)");
+      gdcmDebugMacro( "Not found : YBR Full (0028,0004)");
    }
    return false;
 }
@@ -1129,7 +1158,7 @@ int File::GetLUTNbits()
 
 /**
  *\brief gets the info from 0028,1052 : Rescale Intercept
- * @return Rescale Intercept
+ * @return Rescale Intercept. defaulted to 0.0 is not found or empty
  */
 float File::GetRescaleIntercept()
 {
@@ -1146,7 +1175,7 @@ float File::GetRescaleIntercept()
 
 /**
  *\brief   gets the info from 0028,1053 : Rescale Slope
- * @return Rescale Slope
+ * @return Rescale Slope. defaulted to 1.0 is not found or empty
  */
 float File::GetRescaleSlope()
 {
@@ -1154,7 +1183,7 @@ float File::GetRescaleSlope()
    DataEntry *entry = GetDataEntry(0x0028, 0x1053);
    if( !entry )
    {
-      gdcmWarningMacro( "Missing Rescale Slope (0028,1053)");
+      gdcmDebugMacro( "Missing Rescale Slope (0028,1053)");
       return 1.0f;
    }
    return (float)entry->GetValue(0);
@@ -1244,7 +1273,7 @@ size_t File::GetPixelOffset()
    }
    else
    {
-      gdcmDebugMacro( "Big trouble : Pixel Element ("
+      gdcmWarningMacro( "Big trouble : Pixel Element ("
                       << std::hex << GrPixel<<","<< NumPixel<< ") NOT found" );
       return 0;
    }
@@ -1266,7 +1295,7 @@ size_t File::GetPixelAreaLength()
    }
    else
    {
-      gdcmDebugMacro( "Big trouble : Pixel Element ("
+      gdcmWarningMacro( "Big trouble : Pixel Element ("
                       << std::hex << GrPixel<<","<< NumPixel<< ") NOT found" );
       return 0;
    }
@@ -1472,19 +1501,18 @@ bool File::Write(std::string fileName, FileType writetype)
       e0000->SetString(sLen.str());
    }
 
-   // Derma?.dcm does not have it...let's remove it  FIXME FIXME
+   /// \todo FIXME : Derma?.dcm does not have it...let's remove it ?!? JPRx
    if( writetype != JPEG )
-     {
-     int i_lgPix = GetEntryLength(GrPixel, NumPixel);
-     if (i_lgPix != -2)
-       {
-       // no (GrPixel, NumPixel) element
-       std::string s_lgPix = Util::Format("%d", i_lgPix+12);
-       s_lgPix = Util::DicomString( s_lgPix.c_str() );
-       InsertEntryString(s_lgPix,GrPixel, 0x0000);
-       }
-     }
-
+   {
+      int i_lgPix = GetEntryLength(GrPixel, NumPixel);
+      if (i_lgPix != -2)
+      {
+         // no (GrPixel, NumPixel) element
+         std::string s_lgPix = Util::Format("%d", i_lgPix+12);
+         s_lgPix = Util::DicomString( s_lgPix.c_str() );
+         InsertEntryString(s_lgPix,GrPixel, 0x0000);   
+      }
+   }
    Document::WriteContent(fp, writetype);
 
    fp->close();
@@ -1557,7 +1585,7 @@ void File::ComputeRLEInfo()
       // Offset Table information on fragments of this current Frame.
       // Note that the fragment pixels themselves are not loaded
       // (but just skipped).
-      long frameOffset = Fp->tellg();
+      long frameOffset = Fp->tellg(); // once per fragment
 
       uint32_t nbRleSegments = ReadInt32();
       if ( nbRleSegments > 16 )
@@ -1604,7 +1632,7 @@ void File::ComputeRLEInfo()
 
    // Make sure that  we encounter a 'Sequence Delimiter Item'
    // at the end of the item :
-   if ( !ReadTag(0xfffe, 0xe0dd) )
+   if ( !ReadTag(0xfffe, 0xe0dd) ) // once per RLE File
    {
       gdcmWarningMacro( "No sequence delimiter item at end of RLE item sequence");
    }
@@ -1657,7 +1685,7 @@ void File::ComputeJPEGFragmentInfo()
         i++;
         }
 
-      long fragmentOffset = Fp->tellg();
+      long fragmentOffset = Fp->tellg(); // Once per fragment
       // Store the collected info
       JPEGFragment *newFragment = new JPEGFragment;
       newFragment->SetOffset(fragmentOffset);
@@ -1690,8 +1718,8 @@ void File::ComputeJPEGFragmentInfo()
  */
 bool File::ReadTag(uint16_t testGroup, uint16_t testElem)
 {
-   long positionOnEntry = Fp->tellg();
-   long currentPosition = Fp->tellg();          // On debugging purposes
+   long positionOnEntry = Fp->tellg(); // Only when reading fragments
+   //long currentPosition = positionOnEntry;      // On debugging purposes
 
    // Read the Item Tag group and element, and make
    // sure they are what we expected:
@@ -1712,16 +1740,16 @@ bool File::ReadTag(uint16_t testGroup, uint16_t testElem)
       return false;
    }
    if ( itemTagGroup != testGroup || itemTagElem != testElem )
-   { 
+   {
        // in order not to pollute output we don't warn on 'delimitors'
       if (itemTagGroup != 0xfffe ||  testGroup != 0xfffe )
-         gdcmErrorMacro( "Wrong Item Tag found:"
+         gdcmWarningMacro( "Wrong Item Tag found:"
           << "   We should have found tag ("
           << DictEntry::TranslateToKey(testGroup,testElem) << ")" << std::endl
           << "   but instead we encountered tag ("
           << DictEntry::TranslateToKey(itemTagGroup,itemTagElem) << ")"
           << "  at address: " << "  0x(" << std::hex 
-          << (unsigned int)currentPosition  << std::dec << ")" 
+          << (unsigned int)positionOnEntry  << std::dec << ")" 
           ) ;
       Fp->seekg(positionOnEntry, std::ios::beg);
 
@@ -1758,10 +1786,12 @@ uint32_t File::ReadTagLength(uint16_t testGroup, uint16_t testElem)
    }
                                                                                 
    //// Then read the associated Item Length
-   long currentPosition = Fp->tellg();
+   
+   // long currentPosition = Fp->tellg(); // save time // JPRx
    uint32_t itemLength  = ReadInt32();
    gdcmDebugMacro( "Basic Item Length is: " << itemLength 
-        << "  at address: " << std::hex << (unsigned int)currentPosition);
+//        << "  at address: " << std::hex << (unsigned int)currentPosition
+   );
    return itemLength;
 }
 
@@ -1795,9 +1825,9 @@ void File::ReadEncapsulatedBasicOffsetTable()
          uint32_t val = BasicOffsetTableItemValue[i];
          BasicOffsetTableItemValue[i] 
            = (  (val<<24)               | ((val<<8)  & 0x00ff0000) | 
-              ((val>>8)  & 0x0000ff00) |  (val>>24)               );
+              ( (val>>8)  & 0x0000ff00) |  (val>>24)               );
 #endif
-         gdcmWarningMacro( "Read one length for: " << 
+         gdcmDebugMacro( "Read one length for: " << 
                           std::hex << BasicOffsetTableItemValue[i] );
       }
 
@@ -1813,7 +1843,7 @@ void File::ReadEncapsulatedBasicOffsetTable()
  * @ param   fileName file to be open for parsing
  * @ return false if file cannot be open or no swap info was found,
  *         or no tag was found.
- * @ deprecated Use the Load() [ + SetLoadMode() ] + SetFileName() functions instead
+ * @deprecated Use the Load() [ + SetLoadMode() ] + SetFileName() functions instead
  */
 bool File::Load( std::string const &fileName ) 
 {