]> Creatis software - gdcm.git/blobdiff - src/gdcmHeader.cxx
Commenataires?
[gdcm.git] / src / gdcmHeader.cxx
index a2bece5180e74a3a48decff566b0f06c739246c6..3107da2ff3bf31765a6245aedcf5dcc9181e8854 100644 (file)
@@ -1,3 +1,5 @@
+// gdcmHeader.cxx
+
 #include "gdcm.h"
 #include <stdio.h>
 // For nthos:
@@ -11,7 +13,7 @@
 #include <sstream>
 #include "gdcmUtil.h"
 
-#define HEADER_LENGHT_TO_READ 256 // on ne lit plus que le debut
+#define HEADER_LENGTH_TO_READ 256 // on ne lit plus que le debut
 
 namespace Error {
        struct FileReadError {
@@ -88,31 +90,23 @@ void gdcmHeader::InitVRDict (void) {
 
 /**
  * \ingroup gdcmHeader
- * \brief   La seule maniere sure que l'on aie pour determiner 
- *          si on est en   LITTLE_ENDIAN,       BIG-ENDIAN, 
- *          BAD-LITTLE-ENDIAN, BAD-BIG-ENDIAN
- *          est de trouver l'element qui donne la longueur d'un 'GROUP'
- *          (on sait que la longueur de cet element vaut 0x00000004)
- *          et de regarder comment cette longueur est codee en memoire  
- *          
- *          Le probleme vient de ce que parfois, il n'y en a pas ...
- *          
- *          On fait alors le pari qu'on a a faire a du LITTLE_ENDIAN propre.
- *          (Ce qui est la norme -pas respectee- depuis ACR-NEMA)
- *          Si ce n'est pas le cas, on ne peut rien faire.
+ * \brief   Discover what the swap code is (among little endian, big endian,
+ *          bad little endian, bad big endian).
  *
- *          (il faudrait avoir des fonctions auxquelles 
- *          on passe le code Swap en parametre, pour faire des essais 'manuels')
  */
 void gdcmHeader::CheckSwap()
 {
+       // The only guaranted way of finding the swap code is to find a
+       // group tag since we know it's length has to be of four bytes i.e.
+       // 0x00000004. Finding the swap code in then straigthforward. Trouble
+       // occurs when we can't find such group...
        guint32  s;
        guint32  x=4;  // x : pour ntohs
        bool net2host; // true when HostByteOrder is the same as NetworkByteOrder
         
        int lgrLue;
        char * entCur;
-       char deb[HEADER_LENGHT_TO_READ];
+       char deb[HEADER_LENGTH_TO_READ];
         
        // First, compare HostByteOrder and NetworkByteOrder in order to
        // determine if we shall need to swap bytes (i.e. the Endian type).
@@ -123,7 +117,7 @@ void gdcmHeader::CheckSwap()
        
        // The easiest case is the one of a DICOM header, since it possesses a
        // file preamble where it suffice to look for the sting "DICM".
-       lgrLue = fread(deb, 1, HEADER_LENGHT_TO_READ, fp);
+       lgrLue = fread(deb, 1, HEADER_LENGTH_TO_READ, fp);
        
        entCur = deb + 128;
        if(memcmp(entCur, "DICM", (size_t)4) == 0) {
@@ -209,15 +203,13 @@ void gdcmHeader::CheckSwap()
                return;
        default :
                dbg.Verbose(0, "gdcmHeader::CheckSwap:",
-                              "ACE/NEMA unfound swap info (time to raise bets)");
+                              "ACR/NEMA unfound swap info (time to raise bets)");
        }
 
        // We are out of luck. It is not a DicomV3 nor a 'clean' ACR/NEMA file.
        // It is time for despaired wild guesses. So, let's assume this file
        // happens to be 'dirty' ACR/NEMA, i.e. the length of the group is
        // not present. Then the only info we have is the net2host one.
-       //FIXME  Si c'est du RAW, ca degagera + tard
-       
        if (! net2host )
                sw = 0;
        else
@@ -226,7 +218,8 @@ void gdcmHeader::CheckSwap()
 }
 
 void gdcmHeader::SwitchSwapToBigEndian(void) {
-       dbg.Verbose(1, "gdcmHeader::FindLength", "Switching to BigEndian mode.");
+       dbg.Verbose(1, "gdcmHeader::SwitchSwapToBigEndian",
+                      "Switching to BigEndian mode.");
        if ( sw == 0    ) {
                sw = 4321;
                return;
@@ -243,36 +236,16 @@ void gdcmHeader::SwitchSwapToBigEndian(void) {
                sw = 3412;
 }
 
+void gdcmHeader::GetPixels(size_t lgrTotale, void* Pixels) {
+       size_t pixelsOffset; 
+       pixelsOffset = GetPixelOffset();
+       fseek(fp, pixelsOffset, SEEK_SET);
+       fread(Pixels, 1, lgrTotale, fp);
+}
+
 /**
  * \ingroup   gdcmHeader
- * \brief     recupere la longueur d'un champ DICOM.
- *            Preconditions:
- *            1/ le fichier doit deja avoir ete ouvert,
- *            2/ CheckSwap() doit avoir ete appele
- *            3/ la  partie 'group'  ainsi que la  partie 'elem' 
- *               de l'acr_element doivent avoir ete lues.
- *
- *            ACR-NEMA : we allways get
- *                 GroupNumber   (2 Octets) 
- *                 ElementNumber (2 Octets) 
- *                 ElementSize   (4 Octets)
- *            DICOM en implicit Value Representation :
- *                 GroupNumber   (2 Octets) 
- *                 ElementNumber (2 Octets) 
- *                 ElementSize   (4 Octets)
- *
- *            DICOM en explicit Value Representation :
- *                 GroupNumber         (2 Octets) 
- *                 ElementNumber       (2 Octets) 
- *                 ValueRepresentation (2 Octets) 
- *                 ElementSize         (2 Octets)
- *
- *            ATTENTION : dans le cas ou ValueRepresentation = OB, OW, SQ, UN
- *                 GroupNumber         (2 Octets) 
- *                 ElementNumber       (2 Octets) 
- *                 ValueRepresentation (2 Octets)
- *                 zone reservee       (2 Octets) 
- *                 ElementSize         (4 Octets)
+ * \brief     Find the value representation of the current tag.
  *
  * @param sw  code swap
  * @param skippedLength  pointeur sur nombre d'octets que l'on a saute qd
@@ -283,6 +256,9 @@ void gdcmHeader::SwitchSwapToBigEndian(void) {
  */
 
 void gdcmHeader::FindVR( ElValue *ElVal) {
+       if (filetype != ExplicitVR)
+               return;
+
        char VR[3];
        string vr;
        int lgrLue;
@@ -296,9 +272,6 @@ void gdcmHeader::FindVR( ElValue *ElVal) {
        // the case.
        bool RealExplicit = true;
        
-       if (filetype != ExplicitVR)
-               return;
-
        lgrLue=fread (&VR, (size_t)2,(size_t)1, fp);
        VR[2]=0;
        vr = string(VR);
@@ -307,7 +280,7 @@ void gdcmHeader::FindVR( ElValue *ElVal) {
        // a tag where we expect reading a VR but are in fact we read the
        // first to bytes of the length. Then we will interogate (through find)
        // the dicom_vr dictionary with oddities like "\004\0" which crashes
-       // both GCC and VC++ implentations of the STL map. Hence when the
+       // both GCC and VC++ implementations of the STL map. Hence when the
        // expected VR read happens to be non-ascii characters we consider
        // we hit falsely explicit VR tag.
 
@@ -321,8 +294,26 @@ void gdcmHeader::FindVR( ElValue *ElVal) {
                RealExplicit = false;
 
        if ( RealExplicit ) {
-               if ( ElVal->IsVrUnknown() ) 
+               if ( ElVal->IsVrUnknown() ) {
+                       // When not a dictionary entry, we can safely overwrite the vr.
                        ElVal->SetVR(vr);
+                       return; 
+               }
+               if ( ElVal->GetVR() == vr ) {
+                       // The vr we just read and the dictionary agree. Nothing to do.
+                       return;
+               }
+               // The vr present in the file and the dictionary disagree. We assume
+               // the file writer knew best and use the vr of the file. Since it would
+               // be unwise to overwrite the vr of a dictionary (since it would
+               // compromise it's next user), we need to clone the actual DictEntry
+               // and change the vr for the read one.
+               gdcmDictEntry* NewTag = new gdcmDictEntry(ElVal->GetGroup(),
+                                          ElVal->GetElement(),
+                                          vr,
+                                          "FIXME",
+                                          ElVal->GetName());
+               ElVal->SetDictEntry(NewTag);
                return; 
        }
        
@@ -348,7 +339,7 @@ void gdcmHeader::FindVR( ElValue *ElVal) {
  * @return  True when big endian found. False in all other cases.
  */
 bool gdcmHeader::IsBigEndianTransferSyntax(void) {
-       ElValue* Element = PubElVals.GetElement(0x0002, 0x0010);
+       ElValue* Element = PubElVals.GetElementByNumber(0x0002, 0x0010);
        if ( !Element )
                return false;
        LoadElementValueSafe(Element);
@@ -365,7 +356,41 @@ void gdcmHeader::FixFoundLength(ElValue * ElVal, guint32 FoudLength) {
        ElVal->SetLength(FoudLength);
 }
 
-void gdcmHeader::FindLength( ElValue * ElVal) {
+guint32 gdcmHeader::FindLengthOB(void) {
+       // See PS 3.5-2001, section A.4 p. 49 on encapsulation of encoded pixel data.
+       guint16 g;
+       guint16 n; 
+       long PositionOnEntry = ftell(fp);
+       bool FoundSequenceDelimiter = false;
+       guint32 TotalLength = 0;
+       guint32 ItemLength;
+
+       while ( ! FoundSequenceDelimiter) {
+               g = ReadInt16();
+               n = ReadInt16();
+               TotalLength += 4;  // We even have to decount the group and element 
+               if ( g != 0xfffe ) {
+                       dbg.Verbose(1, "gdcmHeader::FindLengthOB: ",
+                                   "wrong group for an item sequence.");
+                       throw Error::FileReadError(fp, "gdcmHeader::FindLengthOB");
+               }
+               if ( n == 0xe0dd )
+                       FoundSequenceDelimiter = true;
+               else if ( n != 0xe000) {
+                       dbg.Verbose(1, "gdcmHeader::FindLengthOB: ",
+                                   "wrong element for an item sequence.");
+                       throw Error::FileReadError(fp, "gdcmHeader::FindLengthOB");
+               }
+               ItemLength = ReadInt32();
+               TotalLength += ItemLength + 4;  // We add 4 bytes since we just read
+                                               // the ItemLength with ReadInt32
+               SkipBytes(ItemLength);
+       }
+       fseek(fp, PositionOnEntry, SEEK_SET);
+       return TotalLength;
+}
+
+void gdcmHeader::FindLength(ElValue * ElVal) {
        guint16 element = ElVal->GetElement();
        string  vr      = ElVal->GetVR();
        guint16 length16;
@@ -377,7 +402,12 @@ void gdcmHeader::FindLength( ElValue * ElVal) {
                        // 7.1.2 Data element structure with explicit vr p27) must be
                        // skipped before proceeding on reading the length on 4 bytes.
                        fseek(fp, 2L, SEEK_CUR);
-                       FixFoundLength(ElVal, ReadInt32());
+                       guint32 length32 = ReadInt32();
+                       if ( (vr == "OB") && (length32 == 0xffffffff) ) {
+                               ElVal->SetLength(FindLengthOB());
+                               return;
+                       }
+                       FixFoundLength(ElVal, length32);
                        return;
                }
 
@@ -386,7 +416,7 @@ void gdcmHeader::FindLength( ElValue * ElVal) {
                
                // We can tell the current file is encoded in big endian (like
                // Data/US-RGB-8-epicard) when we find the "Transfer Syntax" tag
-               // and it's value is the one of the encoding of a bie endian file.
+               // and it's value is the one of the encoding of a big endian file.
                // In order to deal with such big endian encoded files, we have
                // (at least) two strategies:
                // * when we load the "Transfer Syntax" tag with value of big endian
@@ -397,7 +427,7 @@ void gdcmHeader::FindLength( ElValue * ElVal) {
                //   in little endian, and big endian coding only starts at the next
                //   group. The corresponding code can be hard to analyse and adds
                //   many additional unnecessary tests for regular tags.
-               // * the second strategy consist to wait for trouble, that shall appear
+               // * the second strategy consist in waiting for trouble, that shall appear
                //   when we find the first group with big endian encoding. This is
                //   easy to detect since the length of a "Group Length" tag (the
                //   ones with zero as element number) has to be of 4 (0x0004). When we
@@ -411,7 +441,7 @@ void gdcmHeader::FindLength( ElValue * ElVal) {
                // endian encoding". When this is the case, chances are we got our
                // hands on a big endian encoded file: we switch the swap code to
                // big endian and proceed...
-               if ( (element  == 0) && (length16 == 1024) ) {
+               if ( (element  == 0x000) && (length16 == 0x0400) ) {
                        if ( ! IsBigEndianTransferSyntax() )
                                throw Error::FileReadError(fp, "gdcmHeader::FindLength");
                        length16 = 4;
@@ -491,9 +521,13 @@ guint16 gdcmHeader::SwapShort(guint16 a) {
        return (a);
 }
 
-void gdcmHeader::SkipElementValue(ElValue * ElVal) {
+void gdcmHeader::SkipBytes(guint32 NBytes) {
        //FIXME don't dump the returned value
-       (void)fseek(fp, (long)ElVal->GetLength(), SEEK_CUR);
+       (void)fseek(fp, (long)NBytes, SEEK_CUR);
+}
+
+void gdcmHeader::SkipElementValue(ElValue * ElVal) {
+       SkipBytes(ElVal->GetLength());
 }
 
 void gdcmHeader::SetMaxSizeLoadElementValue(long NewSize) {
@@ -526,6 +560,12 @@ void gdcmHeader::LoadElementValue(ElValue * ElVal) {
        fseek(fp, (long)ElVal->GetOffset(), SEEK_SET);
        
        // Sequences not treated yet !
+       //
+       // Ne faudrait-il pas au contraire trouver immediatement
+       // une maniere 'propre' de traiter les sequences (vr = SQ)
+       // car commencer par les ignorer risque de conduire a qq chose
+       // qui pourrait ne pas etre generalisable
+       //
        if( vr == "SQ" )
                SkipLoad = true;
 
@@ -555,6 +595,10 @@ void gdcmHeader::LoadElementValue(ElValue * ElVal) {
        }
 
        // Values bigger than specified are not loaded.
+       //
+       // En fait, c'est les elements dont la longueur est superieure 
+       // a celle fixee qui ne sont pas charges
+       //
        if (length > MaxSizeLoadElementValue) {
                ostringstream s;
                s << "gdcm::NotLoaded.";
@@ -584,7 +628,7 @@ void gdcmHeader::LoadElementValue(ElValue * ElVal) {
        }
        
        // FIXME The exact size should be length if we move to strings or whatever
-       char* NewValue = (char*)g_malloc(length+1);
+       char* NewValue = (char*)malloc(length+1);
        if( !NewValue) {
                dbg.Verbose(1, "LoadElementValue: Failed to allocate NewValue");
                return;
@@ -593,7 +637,7 @@ void gdcmHeader::LoadElementValue(ElValue * ElVal) {
        
        item_read = fread(NewValue, (size_t)length, (size_t)1, fp);
        if ( item_read != 1 ) {
-               g_free(NewValue);
+               free(NewValue);
                Error::FileReadError(fp, "gdcmHeader::LoadElementValue");
                ElVal->SetValue("gdcm::UnRead");
                return;
@@ -709,6 +753,23 @@ bool gdcmHeader::IsAnInteger(ElValue * ElVal) {
        if ( (group == 0x0028) && (element == 0x0005) )
                // This tag is retained from ACR/NEMA
                // CHECKME Why should "Image Dimensions" be a single integer ?
+               //
+               // "Image Dimensions", c'est en fait le 'nombre de dimensions'
+               // de l'objet ACR-NEMA stocké
+               // 1 : Signal
+               // 2 : Image
+               // 3 : Volume
+               // 4 : Sequence
+               //
+               // DICOM V3 ne retient pas cette information
+               // Par defaut, tout est 'Image',
+               // C'est a l'utilisateur d'explorer l'ensemble des entetes
+               // pour savoir à quoi il a a faire
+               //
+               // Le Dicom Multiframe peut etre utilise pour stocker,
+               // dans un seul fichier, une serie temporelle (cardio vasculaire GE, p.ex)
+               // ou un volume (medecine Nucleaire, p.ex)
+               //
                return true;
        
        if ( (group == 0x0028) && (element == 0x0200) )
@@ -734,7 +795,7 @@ size_t gdcmHeader::GetPixelOffset(void) {
        guint16 numPixel;
        string ImageLocation = GetPubElValByName("Image Location");
        if ( ImageLocation == "UNFOUND" ) {
-               grPixel = 0x7FE0;
+               grPixel = 0x7fe0;
        } else {
                grPixel = (guint16) atoi( ImageLocation.c_str() );
        }
@@ -744,7 +805,7 @@ size_t gdcmHeader::GetPixelOffset(void) {
                numPixel = 0x1010;
        else
                numPixel = 0x0010;
-       ElValue* PixelElement = PubElVals.GetElement(grPixel, numPixel);
+       ElValue* PixelElement = PubElVals.GetElementByNumber(grPixel, numPixel);
        if (PixelElement)
                return PixelElement->GetOffset();
        else
@@ -752,6 +813,10 @@ size_t gdcmHeader::GetPixelOffset(void) {
 }
 
 gdcmDictEntry * gdcmHeader::IsInDicts(guint32 group, guint32 element) {
+       //
+       // Y a-t-il une raison de lui passer des guint32
+       // alors que group et element sont des guint16?
+       //
        gdcmDictEntry * found = (gdcmDictEntry*)0;
        if (!RefPubDict && !RefShaDict) {
                //FIXME build a default dictionary !
@@ -770,12 +835,97 @@ gdcmDictEntry * gdcmHeader::IsInDicts(guint32 group, guint32 element) {
        return found;
 }
 
+list<string> * gdcmHeader::GetPubTagNames(void) {
+       list<string> * Result = new list<string>;
+       TagHT entries = RefPubDict->GetEntries();
+
+       for (TagHT::iterator tag = entries.begin(); tag != entries.end(); ++tag){
+      Result->push_back( tag->second->GetName() );
+       }
+       return Result;
+}
+
+map<string, list<string> > * gdcmHeader::GetPubTagNamesByCategory(void) {
+       map<string, list<string> > * Result = new map<string, list<string> >;
+       TagHT entries = RefPubDict->GetEntries();
+
+       for (TagHT::iterator tag = entries.begin(); tag != entries.end(); ++tag){
+               (*Result)[tag->second->GetFourth()].push_back(tag->second->GetName());
+       }
+       return Result;
+}
+
 string gdcmHeader::GetPubElValByNumber(guint16 group, guint16 element) {
-       return PubElVals.GetElValue(group, element);
+       return PubElVals.GetElValueByNumber(group, element);
+}
+
+string gdcmHeader::GetPubElValRepByNumber(guint16 group, guint16 element) {
+       ElValue* elem =  PubElVals.GetElementByNumber(group, element);
+       if ( !elem )
+               return "gdcm::Unfound";
+       return elem->GetVR();
 }
 
 string gdcmHeader::GetPubElValByName(string TagName) {
-       return PubElVals.GetElValue(TagName);
+       return PubElVals.GetElValueByName(TagName);
+}
+
+string gdcmHeader::GetPubElValRepByName(string TagName) {
+       ElValue* elem =  PubElVals.GetElementByName(TagName);
+       if ( !elem )
+               return "gdcm::Unfound";
+       return elem->GetVR();
+}
+
+string gdcmHeader::GetShaElValByNumber(guint16 group, guint16 element) {
+       return ShaElVals.GetElValueByNumber(group, element);
+}
+
+string gdcmHeader::GetShaElValRepByNumber(guint16 group, guint16 element) {
+       ElValue* elem =  ShaElVals.GetElementByNumber(group, element);
+       if ( !elem )
+               return "gdcm::Unfound";
+       return elem->GetVR();
+}
+
+string gdcmHeader::GetShaElValByName(string TagName) {
+       return ShaElVals.GetElValueByName(TagName);
+}
+
+string gdcmHeader::GetShaElValRepByName(string TagName) {
+       ElValue* elem =  ShaElVals.GetElementByName(TagName);
+       if ( !elem )
+               return "gdcm::Unfound";
+       return elem->GetVR();
+}
+
+
+string gdcmHeader::GetElValByNumber(guint16 group, guint16 element) {
+       string pub = GetPubElValByNumber(group, element);
+       if (pub.length())
+               return pub;
+       return GetShaElValByNumber(group, element);
+}
+
+string gdcmHeader::GetElValRepByNumber(guint16 group, guint16 element) {
+       string pub = GetPubElValRepByNumber(group, element);
+       if (pub.length())
+               return pub;
+       return GetShaElValRepByNumber(group, element);
+}
+
+string gdcmHeader::GetElValByName(string TagName) {
+       string pub = GetPubElValByName(TagName);
+       if (pub.length())
+               return pub;
+       return GetShaElValByName(TagName);
+}
+
+string gdcmHeader::GetElValRepByName(string TagName) {
+       string pub = GetPubElValRepByName(TagName);
+       if (pub.length())
+               return pub;
+       return GetShaElValRepByName(TagName);
 }
 
 /**