]> Creatis software - gdcm.git/blobdiff - src/gdcmHeader.cxx
upgrade GdcmHeaderEntry Print Method for DICOMDIR
[gdcm.git] / src / gdcmHeader.cxx
index e9d528117364d0e8927e902852e553ad8072a40a..bfe4b672c6b97698329b972bbcbdd260bfac8e8e 100644 (file)
  * @param   enable_sequences = true to allow the header 
  *          to be parsed *inside* the SeQuences, 
  *          when they have an actual length 
+ * @param   ignore_shadow = true if user wants to skip shadow groups 
+            during parsing, to save memory space
  *\TODO : may be we need one more bool, 
  *         to allow skipping the private elements while parsing the header
  *         in order to save space        
  */
 gdcmHeader::gdcmHeader(const char *InFilename, 
                        bool exception_on_error,
-                       bool enable_sequences ):
-   gdcmParser(InFilename,exception_on_error,enable_sequences)
+                       bool enable_sequences, 
+                      bool ignore_shadow):
+   gdcmParser(InFilename,exception_on_error,enable_sequences,ignore_shadow)
 {
 }
 
@@ -59,6 +62,33 @@ gdcmHeader::~gdcmHeader (void) {
 
 //-----------------------------------------------------------------------------
 // Public
+/**
+ * \ingroup gdcmHeader
+ * \brief  This predicate, based on hopefully reasonable heuristics,
+ *         decides whether or not the current gdcmParser was properly parsed
+ *         and contains the mandatory information for being considered as
+ *         a well formed and usable Dicom/Acr File.
+ * @return true when gdcmParser is the one of a reasonable Dicom/Acr file,
+ *         false otherwise. 
+ */
+bool gdcmHeader::IsReadable(void) {
+   if(!gdcmParser::IsReadable())
+      return(false);
+
+   std::string res = GetEntryByNumber(0x0028, 0x0005);
+   if ( res != GDCM_UNFOUND && atoi(res.c_str()) > 4 ) 
+      return false; // Image Dimensions
+   if ( !GetHeaderEntryByNumber(0x0028, 0x0100) )
+      return false; // "Bits Allocated"
+   if ( !GetHeaderEntryByNumber(0x0028, 0x0101) )
+      return false; // "Bits Stored"
+   if ( !GetHeaderEntryByNumber(0x0028, 0x0102) )
+      return false; // "High Bit"
+   if ( !GetHeaderEntryByNumber(0x0028, 0x0103) )
+      return false; // "Pixel Representation"
+   return true;
+}
+
 /**
  * \ingroup gdcmHeader
  * \brief   Determines if the Transfer Syntax was already encountered
@@ -90,11 +120,7 @@ bool gdcmHeader::IsJPEGExtendedProcess2_4TransferSyntax(void) {
    if ( !Element )
       return false;
    LoadHeaderEntrySafe(Element);
-
-   std::string Transfer = Element->GetValue();
-   if ( Transfer == "1.2.840.10008.1.2.4.51" )
-      return true;
-   return false;
+   return ( Element->GetValue() == "1.2.840.10008.1.2.4.51" );
 }
 
 /**
@@ -151,8 +177,9 @@ bool gdcmHeader::IsRLELossLessTransferSyntax(void) {
    LoadHeaderEntrySafe(Element);
 
    std::string Transfer = Element->GetValue();
-   if ( Transfer == "1.2.840.10008.1.2.5" )
+   if ( Transfer == "1.2.840.10008.1.2.5" ) {
       return true;
+    }
    return false;
 }
 
@@ -217,9 +244,8 @@ bool gdcmHeader::IsDicomV3(void) {
  *          0 means the file is NOT USABLE. The caller will have to check
  */
 int gdcmHeader::GetXSize(void) {
-   // We cannot check for "Columns" because the "Columns" tag is present
-   // both in IMG (0028,0011) and OLY (6000,0011) sections of the dictionary.
-   std::string StrSize = GetEntryByNumber(0x0028,0x0011);
+   std::string StrSize;
+   StrSize = GetEntryByNumber(0x0028,0x0011);
    if (StrSize == GDCM_UNFOUND)
       return 0;
    return atoi(StrSize.c_str());
@@ -233,8 +259,6 @@ int gdcmHeader::GetXSize(void) {
  *          (The file contains a Signal, not an Image).
  */
 int gdcmHeader::GetYSize(void) {
-   // We cannot check for "Rows" because the "Rows" tag is present
-   // both in IMG (0028,0010) and OLY (6000,0010) sections of the dictionary.
    std::string StrSize = GetEntryByNumber(0x0028,0x0010);
    if (StrSize != GDCM_UNFOUND)
       return atoi(StrSize.c_str());
@@ -391,38 +415,60 @@ std::string gdcmHeader::GetPixelType(void) {
 
 /**
  * \ingroup gdcmHeader
- * \brief   Recover the offset (from the beginning of the file) of the pixels.
+ * \brief   Recover the offset (from the beginning of the file) 
+ * \        of *image* pixels (not *icone image* pixels, if any !)
  */
 size_t gdcmHeader::GetPixelOffset(void) {
-   // If this file complies with the norm we should encounter the
-   // "Image Location" tag (0x0028, 0x0200). This tag contains the
+   // We may encounter the 'RETired' (0x0028, 0x0200) tag
+   // (Image Location") . This Element contains the number of
    // the group that contains the pixel data (hence the "Pixel Data"
    // is found by indirection through the "Image Location").
    // Inside the group pointed by "Image Location" the searched element
    // is conventionally the element 0x0010 (when the norm is respected).
    // When the "Image Location" is absent we default to group 0x7fe0.
+   //
+   // If the element (0x0088,0x0200) 'icone image sequence' is found
+   // (grPixel,numPixel) is stored twice : the first one for the icon
+   // the second one for the image ...
+   // pb : sometimes , (0x0088,0x0200) exists, but doesn't contain *anything*
+   // see gdcmData/MxTwinLossLess.dcm ...
    guint16 grPixel;
    guint16 numPixel;
    std::string ImageLocation = GetEntryByNumber(0x0028, 0x0200);
 
    if ( ImageLocation == GDCM_UNFOUND ) { // Image Location
-      grPixel = 0x7fe0;
+      grPixel = 0x7fe0;                   // default value
    } else {
       grPixel = (guint16) atoi( ImageLocation.c_str() );
    }
-   if (grPixel != 0x7fe0)
+   
+   if (grPixel == 0xe07f) // sometimes Image Location value doesn't follow 
+      grPixel = 0x7fe0;   // the supposed processor endianity. 
+                          // see gdcmData/cr172241.dcm
+      
+   if (grPixel != 0x7fe0) 
       // This is a kludge for old dirty Philips imager.
       numPixel = 0x1010;
    else
       numPixel = 0x0010;
-         
-   gdcmHeaderEntry* PixelElement = GetHeaderEntryByNumber(grPixel,numPixel);
-   if (PixelElement)
+      
+   IterHT it = GetHeaderEntrySameNumber(grPixel,numPixel);          
+   //std::string icone = GetEntryByNumber(0x0088,0x0200); //icone image sequence
+   TagKey key = gdcmDictEntry::TranslateToKey(grPixel,numPixel);
+   gdcmHeaderEntry* PixelElement;
+  
+   if (tagHT.count(key) == 1)   
+      PixelElement = (it.first)->second;
+   else
+      PixelElement = (++it.first)->second;
+   
+   if (PixelElement) {
       return PixelElement->GetOffset();
+   }
    else
       return 0;
 }
-
+// TODO : unify those two (previous one and next one)
 /**
  * \ingroup gdcmHeader
  * \brief   Recover the pixel area length (in Bytes)
@@ -439,22 +485,38 @@ size_t gdcmHeader::GetPixelAreaLength(void) {
    guint16 grPixel;
    guint16 numPixel;
    std::string ImageLocation = GetEntryByNumber(0x0028, 0x0200);
-   if ( ImageLocation == GDCM_UNFOUND ) {
-      grPixel = 0x7fe0;
+   if ( ImageLocation == GDCM_UNFOUND ) { // Image Location
+      grPixel = 0x7fe0;                   // default value
    } else {
       grPixel = (guint16) atoi( ImageLocation.c_str() );
    }
+   if (grPixel == 0xe07f) // sometimes group doesn't follow 
+      grPixel = 0x7fe0;   // the supposed processor endianity. see cr172241.dcm
+      
    if (grPixel != 0x7fe0)
       // This is a kludge for old dirty Philips imager.
       numPixel = 0x1010;
    else
       numPixel = 0x0010;
-         
-   gdcmHeaderEntry* PixelElement = GetHeaderEntryByNumber(grPixel,numPixel);
+              
+   IterHT it = GetHeaderEntrySameNumber(grPixel,numPixel);          
+   //std::string icone = GetEntryByNumber(0x0088,0x0200); //icone image sequence
+   TagKey key = gdcmDictEntry::TranslateToKey(grPixel,numPixel);
+   gdcmHeaderEntry* PixelElement;
+  
+   if (tagHT.count(key) == 1)   
+      PixelElement = (it.first)->second;
+   else
+      PixelElement = (++it.first)->second;
+   
    if (PixelElement)
       return PixelElement->GetLength();
-   else
+   else {
+      std::cout << "Big trouble : Pixel Element ("
+                << std::hex << grPixel<<","<< numPixel<< ") NOT found" 
+                << std::endl;
       return 0;
+   }
 }
 
 /**
@@ -468,6 +530,8 @@ size_t gdcmHeader::GetPixelAreaLength(void) {
 bool gdcmHeader::HasLUT(void) {
 
    // Check the presence of the LUT Descriptors 
+   
+   // LutDescriptorRed    
    if ( !GetHeaderEntryByNumber(0x0028,0x1101) )
       return false;
    // LutDescriptorGreen 
@@ -476,12 +540,17 @@ bool gdcmHeader::HasLUT(void) {
    // LutDescriptorBlue 
    if ( !GetHeaderEntryByNumber(0x0028,0x1103) )
       return false;
-   //  It is not enough
-   // we check also 
+      
+   //  It is not enough :
+   //  we check also 
+   
+   // Red Palette Color Lookup Table Data
    if ( !GetHeaderEntryByNumber(0x0028,0x1201) )
-      return false;  
+      return false; 
+   // Green Palette Color Lookup Table Data       
    if ( !GetHeaderEntryByNumber(0x0028,0x1202) )
       return false;
+   // Blue Palette Color Lookup Table Data      
    if ( !GetHeaderEntryByNumber(0x0028,0x1203) )
       return false;   
    return true;
@@ -565,15 +634,15 @@ unsigned char * gdcmHeader::GetLUTRGBA(void) {
    tokens.erase(tokens.begin(),tokens.end()); // clean any previous value
    Tokenize (LutDescriptionG, tokens, "\\");
    lengthG=atoi(tokens[0].c_str()); // Green LUT length in Bytes
-   debG   =atoi(tokens[1].c_str());
-   nbitsG =atoi(tokens[2].c_str());
+   debG   =atoi(tokens[1].c_str()); // subscript of the first Lut Value
+   nbitsG =atoi(tokens[2].c_str()); // Lut item size (in Bits)
    tokens.clear();  
    
    tokens.erase(tokens.begin(),tokens.end()); // clean any previous value
    Tokenize (LutDescriptionB, tokens, "\\");
    lengthB=atoi(tokens[0].c_str()); // Blue LUT length in Bytes
-   debB   =atoi(tokens[1].c_str());
-   nbitsB =atoi(tokens[2].c_str());
+   debB   =atoi(tokens[1].c_str()); // subscript of the first Lut Value
+   nbitsB =atoi(tokens[2].c_str()); // Lut item size (in Bits)
    tokens.clear();
  
    // Load LUTs into memory, (as they were stored on disk)
@@ -614,7 +683,8 @@ unsigned char * gdcmHeader::GetLUTRGBA(void) {
    // if it works, we shall have to check the 3 Palettes
    // to see which byte is ==0 (first one, or second one)
    // and fix the code
-   // We give up the checking to avoid some overhead 
+   // We give up the checking to avoid some (useless ?)overhead 
+   // (optimistic asumption)
    unsigned char *a;      
    int i;
 
@@ -640,7 +710,6 @@ unsigned char * gdcmHeader::GetLUTRGBA(void) {
    } 
    
    //How to free the now useless LUTs?
-
    //free(LutR); free(LutB); free(LutG); // Seg Fault when used
    return(LUTRGBA);   
 } 
@@ -679,7 +748,9 @@ std::string gdcmHeader::GetTransfertSyntaxName(void) {
 void gdcmHeader::SetImageDataSize(size_t ImageDataSize) {
    std::string content1;
    char car[20];       
-   // Assumes HeaderEntry (0x7fe0, 0x0010) exists ...  
+   // Assumes HeaderEntry (0x7fe0, 0x0010) exists ...
+   // TODO define private members PixelGroupNumber, PicxelElementNumber
+   //      update them, use them (only necessary for ACR-NEMA, not DICOM)      
    sprintf(car,"%d",ImageDataSize);
  
    gdcmHeaderEntry *a = GetHeaderEntryByNumber(0x7fe0, 0x0010);