]> Creatis software - gdcm.git/blobdiff - src/gdcmFile.cxx
Debug vs Warning
[gdcm.git] / src / gdcmFile.cxx
index b26c57d831b59495ceb2d1c672dbccbe757b29c4..917ef615ab0c75f04fc0a750964554ac78928868 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmFile.cxx,v $
   Language:  C++
-  Date:      $Date: 2005/10/23 15:26:43 $
-  Version:   $Revision: 1.289 $
+  Date:      $Date: 2005/11/09 10:18:44 $
+  Version:   $Revision: 1.303 $
                                                                                 
   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
@@ -233,7 +233,7 @@ bool File::DoTheLoadingJob( )
             DictEntry* newDict = DictEntry::New(GrPixel,NumPixel,
                                                 PixelVR,"1","Pixel Data");
 
-            DataEntry *newEntry = new DataEntry(newDict);
+            DataEntry *newEntry = DataEntry::New(newDict);
             newDict->Delete();
             newEntry->Copy(entry);
             newEntry->SetBinArea(oldEntry->GetBinArea(),oldEntry->IsSelfArea());
@@ -241,6 +241,7 @@ bool File::DoTheLoadingJob( )
 
             RemoveEntry(oldEntry);
             AddEntry(newEntry);
+            newEntry->Delete();
          }
       }
    }
@@ -468,9 +469,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);
@@ -488,9 +493,13 @@ 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);
-      if( nbValue >= 2 )
+      else if( nbValue >= 2 )
          xspacing = (float)entry->GetValue(1);
       else
          xspacing = (float)entry->GetValue(0);
@@ -630,7 +639,10 @@ float File::GetXOrigin()
 
    if( entry->GetValueCount() == 3 )
    {
-      gdcmAssertMacro( entry->IsValueCountValid() );
+      if (!entry->IsValueCountValid() )
+      {
+         gdcmErrorMacro( "Invalid Value Count" );
+      }
       return (float)entry->GetValue(0);
    }
    return 0.0f;
@@ -658,7 +670,10 @@ float File::GetYOrigin()
 
    if( entry->GetValueCount() == 3 )
    {
-      gdcmAssertMacro( entry->IsValueCountValid() );
+      if (!entry->IsValueCountValid() )
+      {
+         gdcmErrorMacro( "Invalid Value Count" );
+      }
       return (float)entry->GetValue(1);
    }
    return 0.0f;
@@ -679,7 +694,10 @@ float File::GetZOrigin()
    {
       if( entry->GetValueCount() == 3 )
       {
-         gdcmAssertMacro( entry->IsValueCountValid() );
+         if (!entry->IsValueCountValid() )
+         {
+            gdcmErrorMacro( "Invalid Value Count" );
+         }
          return (float)entry->GetValue(2);
       }
       gdcmWarningMacro( "Wrong Image Position Patient (0020,0032)");
@@ -691,7 +709,10 @@ float File::GetZOrigin()
    {
       if( entry->GetValueCount() == 3 )
       {
-         gdcmAssertMacro( entry->IsValueCountValid() );
+         if (!entry->IsValueCountValid() )
+         {
+            gdcmErrorMacro( "Invalid Value Count" );
+         }
          return (float)entry->GetValue(2);
       }
       gdcmWarningMacro( "Wrong Image Position (RET) (0020,0030)");
@@ -704,7 +725,10 @@ float File::GetZOrigin()
    {
       if( entry->GetValueCount() == 1 )
       {
-         gdcmAssertMacro( entry->IsValueCountValid() );
+         if (!entry->IsValueCountValid() )
+         {
+            gdcmErrorMacro( "Invalid Value Count" );
+         }
          return (float)entry->GetValue(0); // VM=1 !
       }
       gdcmWarningMacro( "Wrong Slice Location (0020,1041)");
@@ -716,7 +740,10 @@ float File::GetZOrigin()
    {
       if( entry->GetValueCount() == 1 )
       {
-         gdcmAssertMacro( entry->IsValueCountValid() );
+         if (!entry->IsValueCountValid() )
+         {
+            gdcmErrorMacro( "Invalid Value Count" );
+         }
          return (float)entry->GetValue(0);
       }
       gdcmWarningMacro( "Wrong Location (0020,0050)");
@@ -776,7 +803,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);
@@ -793,7 +820,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);
@@ -810,7 +837,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);
@@ -827,7 +854,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
    }
@@ -844,7 +871,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);
@@ -902,7 +928,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
    }
 
@@ -946,7 +972,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;
@@ -967,7 +994,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;
 }
@@ -986,7 +1014,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;
 }
@@ -1005,7 +1034,7 @@ bool File::IsPaletteColor()
    }
    if ( PhotometricInterp == GDCM_UNFOUND )
    {
-      gdcmWarningMacro( "Not found : Palette color (0028,0004)");
+      gdcmDebugMacro( "Not found : Palette color (0028,0004)");
    }
    return false;
 }
@@ -1024,7 +1053,7 @@ bool File::IsYBRFull()
    }
    if ( PhotometricInterp == GDCM_UNFOUND )
    {
-      gdcmWarningMacro( "Not found : YBR Full (0028,0004)");
+      gdcmDebugMacro( "Not found : YBR Full (0028,0004)");
    }
    return false;
 }
@@ -1135,7 +1164,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);
@@ -1225,7 +1254,7 @@ size_t File::GetPixelOffset()
    }
    else
    {
-      gdcmDebugMacro( "Big trouble : Pixel Element ("
+      gdcmWarningMacro( "Big trouble : Pixel Element ("
                       << std::hex << GrPixel<<","<< NumPixel<< ") NOT found" );
       return 0;
    }
@@ -1247,7 +1276,7 @@ size_t File::GetPixelAreaLength()
    }
    else
    {
-      gdcmDebugMacro( "Big trouble : Pixel Element ("
+      gdcmWarningMacro( "Big trouble : Pixel Element ("
                       << std::hex << GrPixel<<","<< NumPixel<< ") NOT found" );
       return 0;
    }
@@ -1453,19 +1482,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
+   // 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();
@@ -1658,7 +1686,7 @@ void File::ComputeJPEGFragmentInfo()
 
 /**
  * \brief   Assuming the internal file pointer \ref Document::Fp 
- *          is placed at the beginning of a tag check whether this
+ *          is placed at the beginning of a tag, check whether this
  *          tag is (TestGroup, TestElem).
  * \warning On success the internal file pointer \ref Document::Fp
  *          is modified to point after the tag.
@@ -1693,15 +1721,17 @@ bool File::ReadTag(uint16_t testGroup, uint16_t testElem)
       return false;
    }
    if ( itemTagGroup != testGroup || itemTagElem != testElem )
-   {
-      gdcmErrorMacro( "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 << ")" 
-       ) ;
+   { 
+       // in order not to pollute output we don't warn on 'delimitors'
+      if (itemTagGroup != 0xfffe ||  testGroup != 0xfffe )
+         gdcmErrorMacro( "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 << ")" 
+          ) ;
       Fp->seekg(positionOnEntry, std::ios::beg);
 
       return false;
@@ -1728,7 +1758,9 @@ uint32_t File::ReadTagLength(uint16_t testGroup, uint16_t testElem)
 
    if ( !ReadTag(testGroup, testElem) )
    {
-      gdcmErrorMacro( "ReadTag did not succeed for ("
+      // Avoid polutting output
+      if ( testGroup != 0xfffe ) 
+         gdcmErrorMacro( "ReadTag did not succeed for ("
                     << DictEntry::TranslateToKey(testGroup,testElem) 
                     << ")..." );
       return 0;
@@ -1772,9 +1804,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] );
       }
 
@@ -1785,21 +1817,6 @@ void File::ReadEncapsulatedBasicOffsetTable()
 // These are the deprecated method that one day should be removed (after the next release)
 
 #ifndef GDCM_LEGACY_REMOVE
-/*
- *  brief  Constructor (DEPRECATED : temporaryly kept not to break the API)
- *  param  filename name of the file whose header we want to analyze
- *  deprecated do not use any longer
- */
-File::File( std::string const &filename )
-     :Document( )
-{    
-   RLEInfo  = new RLEFramesInfo;
-   JPEGInfo = new JPEGFragmentsInfo;
-
-   SetFileName( filename );
-   Load( ); // gdcm::Document is first Loaded, then the 'File part'
-}
-
 /*
  * \ brief   Loader. (DEPRECATED :  temporaryly kept not to break the API)
  * @ param   fileName file to be open for parsing