]> Creatis software - gdcm.git/blob - src/gdcmDocument.cxx
* src/gdcmDocEntrySet.[h|cxx], gdcmDocument.[h|cxx] : amelioration of
[gdcm.git] / src / gdcmDocument.cxx
1 /*=========================================================================
2                                                                                 
3   Program:   gdcm
4   Module:    $RCSfile: gdcmDocument.cxx,v $
5   Language:  C++
6   Date:      $Date: 2005/01/06 15:36:48 $
7   Version:   $Revision: 1.157 $
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 "gdcmDocument.h"
20 #include "gdcmValEntry.h"
21 #include "gdcmBinEntry.h"
22 #include "gdcmSeqEntry.h"
23 #include "gdcmGlobal.h"
24 #include "gdcmUtil.h"
25 #include "gdcmDebug.h"
26 #include "gdcmTS.h"
27 #include "gdcmException.h"
28 #include "gdcmDictSet.h"
29 #include "gdcmRLEFramesInfo.h"
30 #include "gdcmJPEGFragmentsInfo.h"
31 #include "gdcmDocEntrySet.h"
32 #include "gdcmSQItem.h"
33
34 #include <vector>
35 #include <iomanip>
36
37 // For nthos:
38 #if defined(_MSC_VER) || defined(__BORLANDC__)
39    #include <winsock.h>
40 #else
41    #include <netinet/in.h>
42 #endif
43
44 namespace gdcm 
45 {
46 //-----------------------------------------------------------------------------
47 static const char *TransferSyntaxStrings[] =  {
48   // Implicit VR Little Endian
49   "1.2.840.10008.1.2",
50   // Implicit VR Little Endian DLX G.E?
51   "1.2.840.113619.5.2",
52   // Explicit VR Little Endian
53   "1.2.840.10008.1.2.1",
54   // Deflated Explicit VR Little Endian
55   "1.2.840.10008.1.2.1.99",
56   // Explicit VR Big Endian
57   "1.2.840.10008.1.2.2",
58   // JPEG Baseline (Process 1)
59   "1.2.840.10008.1.2.4.50",
60   // JPEG Extended (Process 2 & 4)
61   "1.2.840.10008.1.2.4.51",
62   // JPEG Extended (Process 3 & 5)
63   "1.2.840.10008.1.2.4.52",
64   // JPEG Spectral Selection, Non-Hierarchical (Process 6 & 8)
65   "1.2.840.10008.1.2.4.53",
66   // JPEG Full Progression, Non-Hierarchical (Process 10 & 12)
67   "1.2.840.10008.1.2.4.55",
68   // JPEG Lossless, Non-Hierarchical (Process 14)
69   "1.2.840.10008.1.2.4.57",
70   // JPEG Lossless, Hierarchical, First-Order Prediction (Process 14, [Selection Value 1])
71   "1.2.840.10008.1.2.4.70",
72   // JPEG 2000 Lossless
73   "1.2.840.10008.1.2.4.90",
74   // JPEG 2000
75   "1.2.840.10008.1.2.4.91",
76   // RLE Lossless
77   "1.2.840.10008.1.2.5",
78   // Unknown
79   "Unknown Transfer Syntax"
80 };
81                                                                                 
82 //-----------------------------------------------------------------------------
83 // Refer to Document::CheckSwap()
84 //const unsigned int Document::HEADER_LENGTH_TO_READ = 256;
85
86 // Refer to Document::SetMaxSizeLoadEntry()
87 const unsigned int Document::MAX_SIZE_LOAD_ELEMENT_VALUE = 0xfff; // 4096
88 const unsigned int Document::MAX_SIZE_PRINT_ELEMENT_VALUE = 0x7fffffff;
89
90 //-----------------------------------------------------------------------------
91 // Constructor / Destructor
92
93 /**
94  * \brief   constructor  
95  * @param   filename file to be opened for parsing
96  */
97 Document::Document( std::string const & filename ) : ElementSet(-1)
98 {
99    SetMaxSizeLoadEntry(MAX_SIZE_LOAD_ELEMENT_VALUE); 
100    Filename = filename;
101    Initialise();
102
103    Fp = 0;
104    if ( !OpenFile() )
105    {
106       return;
107    }
108
109    dbg.Verbose(0, "Document::Document: starting parsing of file: ",
110                   Filename.c_str());
111    Fp->seekg( 0,  std::ios::beg);
112    
113    Fp->seekg(0,  std::ios::end);
114    long lgt = Fp->tellg();
115            
116    Fp->seekg( 0,  std::ios::beg);
117    CheckSwap();
118    long beg = Fp->tellg();
119    lgt -= beg;
120    
121    ParseDES( this, beg, lgt, false); // le Load sera fait a la volee
122
123    Fp->seekg( 0,  std::ios::beg);
124    
125    // Load 'non string' values
126       
127    std::string PhotometricInterpretation = GetEntryByNumber(0x0028,0x0004);   
128    if( PhotometricInterpretation == "PALETTE COLOR " )
129    {
130       LoadEntryBinArea(0x0028,0x1200);  // gray LUT   
131       /// FIXME FIXME FIXME
132       /// The tags refered by the three following lines used to be CORRECTLY
133       /// defined as having an US Value Representation in the public
134       /// dictionnary. BUT the semantics implied by the three following
135       /// lines state that the corresponding tag contents are in fact
136       /// the ones of a BinEntry.
137       /// In order to fix things "Quick and Dirty" the dictionnary was
138       /// altered on PURPOUS but now contains a WRONG value.
139       /// In order to fix things and restore the dictionary to its
140       /// correct value, one needs to decided of the semantics by deciding
141       /// wether the following tags are either:
142       /// - multivaluated US, and hence loaded as ValEntry, but afterwards
143       ///   also used as BinEntry, which requires the proper conversion,
144       /// - OW, and hence loaded as BinEntry, but afterwards also used
145       ///   as ValEntry, which requires the proper conversion.
146       LoadEntryBinArea(0x0028,0x1201);  // R    LUT
147       LoadEntryBinArea(0x0028,0x1202);  // G    LUT
148       LoadEntryBinArea(0x0028,0x1203);  // B    LUT
149       
150       // Segmented Red   Palette Color LUT Data
151       LoadEntryBinArea(0x0028,0x1221);
152       // Segmented Green Palette Color LUT Data
153       LoadEntryBinArea(0x0028,0x1222);
154       // Segmented Blue  Palette Color LUT Data
155       LoadEntryBinArea(0x0028,0x1223);
156    } 
157    //FIXME later : how to use it?
158    LoadEntryBinArea(0x0028,0x3006);  //LUT Data (CTX dependent) 
159
160    CloseFile(); 
161   
162    // --------------------------------------------------------------
163    // Specific code to allow gdcm to read ACR-LibIDO formated images
164    // Note: ACR-LibIDO is an extension of the ACR standard that was
165    //       used at CREATIS. For the time being (say a couple years)
166    //       we keep this kludge to allow a smooth move to gdcm for
167    //       CREATIS developpers (sorry folks).
168    //
169    // if recognition code tells us we deal with a LibIDO image
170    // we switch lineNumber and columnNumber
171    //
172    std::string RecCode;
173    RecCode = GetEntryByNumber(0x0008, 0x0010); // recognition code
174    if (RecCode == "ACRNEMA_LIBIDO_1.1" ||
175        RecCode == "CANRME_AILIBOD1_1." )  // for brain-damaged softwares
176                                           // with "little-endian strings"
177    {
178          Filetype = ACR_LIBIDO; 
179          std::string rows    = GetEntryByNumber(0x0028, 0x0010);
180          std::string columns = GetEntryByNumber(0x0028, 0x0011);
181          SetEntryByNumber(columns, 0x0028, 0x0010);
182          SetEntryByNumber(rows   , 0x0028, 0x0011);
183    }
184    // ----------------- End of ACR-LibIDO kludge ------------------ 
185 }
186
187 /**
188  * \brief This default constructor doesn't parse the file. You should
189  *        then invoke \ref Document::SetFileName and then the parsing.
190  */
191 Document::Document() : ElementSet(-1)
192 {
193    Fp = 0;
194
195    SetMaxSizeLoadEntry(MAX_SIZE_LOAD_ELEMENT_VALUE);
196    Initialise();
197    SwapCode = 0;
198    Filetype = ExplicitVR;
199 }
200
201 /**
202  * \brief   Canonical destructor.
203  */
204 Document::~Document ()
205 {
206    RefPubDict = NULL;
207    RefShaDict = NULL;
208
209    delete RLEInfo;
210    delete JPEGInfo;
211 }
212
213 //-----------------------------------------------------------------------------
214 // Print
215
216 /**
217   * \brief   Prints The Dict Entries of THE public Dicom Dictionary
218   * @return
219   */  
220 void Document::PrintPubDict(std::ostream & os)
221 {
222    RefPubDict->SetPrintLevel(PrintLevel);
223    RefPubDict->Print(os);
224 }
225
226 /**
227   * \brief   Prints The Dict Entries of THE shadow Dicom Dictionary
228   * @return
229   */
230 void Document::PrintShaDict(std::ostream & os)
231 {
232    RefShaDict->SetPrintLevel(PrintLevel);
233    RefShaDict->Print(os);
234 }
235
236 //-----------------------------------------------------------------------------
237 // Public
238 /**
239  * \brief   Get the public dictionary used
240  */
241 Dict* Document::GetPubDict()
242 {
243    return RefPubDict;
244 }
245
246 /**
247  * \brief   Get the shadow dictionary used
248  */
249 Dict* Document::GetShaDict()
250 {
251    return RefShaDict;
252 }
253
254 /**
255  * \brief   Set the shadow dictionary used
256  * \param   dict dictionary to use in shadow
257  */
258 bool Document::SetShaDict(Dict *dict)
259 {
260    RefShaDict = dict;
261    return !RefShaDict;
262 }
263
264 /**
265  * \brief   Set the shadow dictionary used
266  * \param   dictName name of the dictionary to use in shadow
267  */
268 bool Document::SetShaDict(DictKey const & dictName)
269 {
270    RefShaDict = Global::GetDicts()->GetDict(dictName);
271    return !RefShaDict;
272 }
273
274 /**
275  * \brief  This predicate, based on hopefully reasonable heuristics,
276  *         decides whether or not the current Document was properly parsed
277  *         and contains the mandatory information for being considered as
278  *         a well formed and usable Dicom/Acr File.
279  * @return true when Document is the one of a reasonable Dicom/Acr file,
280  *         false otherwise. 
281  */
282 bool Document::IsReadable()
283 {
284    if( Filetype == Unknown)
285    {
286       dbg.Verbose(0, "Document::IsReadable: wrong filetype");
287       return false;
288    }
289
290    if( TagHT.empty() )
291    {
292       dbg.Verbose(0, "Document::IsReadable: no tags in internal"
293                      " hash table.");
294       return false;
295    }
296
297    return true;
298 }
299
300 /**
301  * \brief   Accessor to the Transfer Syntax (when present) of the
302  *          current document (it internally handles reading the
303  *          value from disk when only parsing occured).
304  * @return  The encountered Transfer Syntax of the current document.
305  */
306 TransferSyntaxType Document::GetTransferSyntax()
307 {
308    DocEntry *entry = GetDocEntryByNumber(0x0002, 0x0010);
309    if ( !entry )
310    {
311       return UnknownTS;
312    }
313
314    // The entry might be present but not loaded (parsing and loading
315    // happen at different stages): try loading and proceed with check...
316    LoadDocEntrySafe(entry);
317    if (ValEntry* valEntry = dynamic_cast< ValEntry* >(entry) )
318    {
319       std::string transfer = valEntry->GetValue();
320       // The actual transfer (as read from disk) might be padded. We
321       // first need to remove the potential padding. We can make the
322       // weak assumption that padding was not executed with digits...
323       if  ( transfer.length() == 0 )
324       {
325          // for brain damaged headers
326          return UnknownTS;
327       }
328       while ( !isdigit((unsigned char)transfer[transfer.length()-1]) )
329       {
330          transfer.erase(transfer.length()-1, 1);
331       }
332       for (int i = 0; TransferSyntaxStrings[i] != NULL; i++)
333       {
334          if ( TransferSyntaxStrings[i] == transfer )
335          {
336             return TransferSyntaxType(i);
337          }
338       }
339    }
340    return UnknownTS;
341 }
342
343 bool Document::IsJPEGLossless()
344 {
345    TransferSyntaxType r = GetTransferSyntax();
346    return    r ==  JPEGFullProgressionProcess10_12
347           || r == JPEGLosslessProcess14
348           || r == JPEGLosslessProcess14_1;
349 }
350                                                                                 
351 /**
352  * \brief   Determines if the Transfer Syntax was already encountered
353  *          and if it corresponds to a JPEG2000 one
354  * @return  True when JPEG2000 (Lossly or LossLess) found. False in all
355  *          other cases.
356  */
357 bool Document::IsJPEG2000()
358 {
359    TransferSyntaxType r = GetTransferSyntax();
360    return r == JPEG2000Lossless || r == JPEG2000;
361 }
362
363 /**
364  * \brief   Determines if the Transfer Syntax corresponds to any form
365  *          of Jpeg encoded Pixel data.
366  * @return  True when any form of JPEG found. False otherwise.
367  */
368 bool Document::IsJPEG()
369 {
370    TransferSyntaxType r = GetTransferSyntax();
371    return r == JPEGBaselineProcess1 
372      || r == JPEGExtendedProcess2_4
373      || r == JPEGExtendedProcess3_5
374      || r == JPEGSpectralSelectionProcess6_8
375      ||      IsJPEGLossless()
376      ||      IsJPEG2000();
377 }
378
379 /**
380  * \brief   Determines if the Transfer Syntax corresponds to encapsulated
381  *          of encoded Pixel Data (as opposed to native).
382  * @return  True when encapsulated. False when native.
383  */
384 bool Document::IsEncapsulate()
385 {
386    TransferSyntaxType r = GetTransferSyntax();
387    return IsJPEG() || r == RLELossless;
388 }
389
390 /**
391  * \brief   Predicate for dicom version 3 file.
392  * @return  True when the file is a dicom version 3.
393  */
394 bool Document::IsDicomV3()
395 {
396    // Checking if Transfert Syntax exists is enough
397    // Anyway, it's to late check if the 'Preamble' was found ...
398    // And ... would it be a rich idea to check ?
399    // (some 'no Preamble' DICOM images exist !)
400    return GetDocEntryByNumber(0x0002, 0x0010) != NULL;
401 }
402
403 /**
404  * \brief  returns the File Type 
405  *         (ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown)
406  * @return the FileType code
407  */
408 FileType Document::GetFileType()
409 {
410    return Filetype;
411 }
412
413 /**
414  * \brief  Tries to open the file \ref Document::Filename and
415  *         checks the preamble when existing.
416  * @return The FILE pointer on success. 
417  */
418 std::ifstream* Document::OpenFile()
419 {
420    if (Filename.length() == 0) 
421    {
422       return 0;
423    }
424
425    if(Fp)
426    {
427       dbg.Verbose( 0,
428                    "Document::OpenFile is already opened when opening: ",
429                    Filename.c_str());
430    }
431
432    Fp = new std::ifstream(Filename.c_str(), std::ios::in | std::ios::binary);
433    if( ! *Fp )
434    {
435       dbg.Verbose( 0,
436                    "Document::OpenFile cannot open file: ",
437                    Filename.c_str());
438       delete Fp;
439       Fp = 0;
440       return 0;
441    }
442  
443    uint16_t zero;
444    Fp->read((char*)&zero, (size_t)2);
445    if( Fp->eof() )
446    {
447       CloseFile();
448       return 0;
449    }
450  
451    //ACR -- or DICOM with no Preamble; may start with a Shadow Group --
452    if( 
453        zero == 0x0001 || zero == 0x0100 || zero == 0x0002 || zero == 0x0200 ||
454        zero == 0x0003 || zero == 0x0300 || zero == 0x0004 || zero == 0x0400 ||
455        zero == 0x0005 || zero == 0x0500 || zero == 0x0006 || zero == 0x0600 ||
456        zero == 0x0007 || zero == 0x0700 || zero == 0x0008 || zero == 0x0800 )
457    {
458       return Fp;
459    }
460  
461    //DICOM
462    Fp->seekg(126L, std::ios::cur);
463    char dicm[4];
464    Fp->read(dicm,  (size_t)4);
465    if( Fp->eof() )
466    {
467       CloseFile();
468       return 0;
469    }
470    if( memcmp(dicm, "DICM", 4) == 0 )
471    {
472       return Fp;
473    }
474  
475    CloseFile();
476    dbg.Verbose( 0,
477                 "Document::OpenFile not DICOM/ACR (missing preamble)",
478                 Filename.c_str());
479  
480    return 0;
481 }
482
483 /**
484  * \brief closes the file  
485  * @return  TRUE if the close was successfull 
486  */
487 bool Document::CloseFile()
488 {
489    if( Fp )
490    {
491       Fp->close();
492       delete Fp;
493       Fp = 0;
494    }
495
496    return true; //FIXME how do we detect a non-close ifstream ?
497 }
498
499 /**
500  * \brief Writes in a file all the Header Entries (Dicom Elements) 
501  * @param fp file pointer on an already open file
502  * @param filetype Type of the File to be written 
503  *          (ACR-NEMA, ExplicitVR, ImplicitVR)
504  * \return Always true.
505  */
506 void Document::WriteContent(std::ofstream* fp, FileType filetype)
507 {
508    /// \todo move the following lines (and a lot of others, to be written)
509    /// to a future function CheckAndCorrectHeader  
510    /// (necessary if user wants to write a DICOM V3 file
511    /// starting from an  ACR-NEMA (V2)  Header
512
513    if ( filetype == ImplicitVR || filetype == ExplicitVR )
514    {
515       // writing Dicom File Preamble
516       char filePreamble[128];
517       memset(filePreamble, 0, 128);
518       fp->write(filePreamble, 128);
519       fp->write("DICM", 4);
520    }
521
522 /**
523  * \todo rewrite later, if really usefull
524  *       - 'Group Length' element is optional in DICOM
525  *       - but un-updated odd groups lengthes can causes pb
526  *         (xmedcon breaker)
527  *
528  * if ( (filetype == ImplicitVR) || (filetype == ExplicitVR) )
529  *    UpdateGroupLength(false,filetype);
530  * if ( filetype == ACR)
531  *    UpdateGroupLength(true,ACR);
532  */
533  
534    ElementSet::WriteContent(fp, filetype); // This one is recursive
535 }
536
537 /**
538  * \brief   Modifies the value of a given Doc Entry (Dicom Element)
539  *          when it exists. Create it with the given value when unexistant.
540  * @param   value (string) Value to be set
541  * @param   group   Group number of the Entry 
542  * @param   elem  Element number of the Entry
543  * @param   vr  V(alue) R(epresentation) of the Entry -if private Entry-
544  * \return  pointer to the modified/created Header Entry (NULL when creation
545  *          failed).
546  */ 
547 ValEntry* Document::ReplaceOrCreateByNumber(std::string const & value, 
548                                             uint16_t group, 
549                                             uint16_t elem,
550                                             TagName const & vr )
551 {
552    ValEntry* valEntry = 0;
553    DocEntry* currentEntry = GetDocEntryByNumber( group, elem);
554    
555    if (currentEntry)
556    {
557       valEntry = dynamic_cast< ValEntry* >(currentEntry);
558
559       // Verify the VR
560       if( valEntry )
561          if( valEntry->GetVR()!=vr )
562             valEntry=NULL;
563
564       // if currentEntry doesn't correspond to the requested valEntry
565       if( !valEntry)
566       {
567          if (!RemoveEntry(currentEntry))
568          {
569             dbg.Verbose(0, "Document::ReplaceOrCreateByNumber: removal"
570                            " of previous DocEntry failed.");
571
572             return NULL;
573          }
574       }
575    }
576
577    // Create a new valEntry if necessary
578    if (!valEntry)
579    {
580       valEntry = NewValEntryByNumber(group, elem, vr);
581
582       if ( !AddEntry(valEntry))
583       {
584          dbg.Verbose(0, "Document::ReplaceOrCreateByNumber: AddEntry"
585                         " failed allthough this is a creation.");
586
587          delete valEntry;
588          return NULL;
589       }
590    }
591
592    // Set the binEntry value
593    SetEntry(value, valEntry);
594    return valEntry;
595 }   
596
597 /*
598  * \brief   Modifies the value of a given Header Entry (Dicom Element)
599  *          when it exists. Create it with the given value when unexistant.
600  *          A copy of the binArea is made to be kept in the Document.
601  * @param   binArea (binary) value to be set
602  * @param   Group   Group number of the Entry 
603  * @param   Elem  Element number of the Entry
604  * @param   vr  V(alue) R(epresentation) of the Entry -if private Entry-
605  * \return  pointer to the modified/created Header Entry (NULL when creation
606  *          failed).
607  */
608 BinEntry* Document::ReplaceOrCreateByNumber(uint8_t* binArea,
609                                             int lgth, 
610                                             uint16_t group, 
611                                             uint16_t elem,
612                                             TagName const & vr )
613 {
614    BinEntry* binEntry = 0;
615    DocEntry* currentEntry = GetDocEntryByNumber( group, elem);
616
617    // Verify the currentEntry
618    if (currentEntry)
619    {
620       binEntry = dynamic_cast< BinEntry* >(currentEntry);
621
622       // Verify the VR
623       if( binEntry )
624          if( binEntry->GetVR()!=vr )
625             binEntry=NULL;
626
627       // if currentEntry doesn't correspond to the requested valEntry
628       if( !binEntry)
629       {
630          if (!RemoveEntry(currentEntry))
631          {
632             dbg.Verbose(0, "Document::ReplaceOrCreateByNumber: removal"
633                            " of previous DocEntry failed.");
634
635             return NULL;
636          }
637       }
638    }
639
640    // Create a new binEntry if necessary
641    if (!binEntry)
642    {
643       binEntry = NewBinEntryByNumber(group, elem, vr);
644
645       if ( !AddEntry(binEntry))
646       {
647          dbg.Verbose(0, "Document::ReplaceOrCreateByNumber: AddEntry"
648                         " failed allthough this is a creation.");
649
650          delete binEntry;
651          return NULL;
652       }
653    }
654
655    // Set the binEntry value
656    uint8_t *tmpArea;
657    if (lgth>0 && binArea)
658    {
659       tmpArea = new uint8_t[lgth];
660       memcpy(tmpArea,binArea,lgth);
661    }
662    else
663    {
664       tmpArea = 0;
665    }
666    if (!SetEntry(tmpArea,lgth,binEntry))
667    {
668       if (tmpArea)
669       {
670          delete[] tmpArea;
671       }
672    }
673
674    return binEntry;
675 }  
676
677 /*
678  * \brief   Modifies the value of a given Header Entry (Dicom Element)
679  *          when it exists. Create it when unexistant.
680  * @param   Group   Group number of the Entry 
681  * @param   Elem  Element number of the Entry
682  * \return  pointer to the modified/created SeqEntry (NULL when creation
683  *          failed).
684  */
685 SeqEntry* Document::ReplaceOrCreateByNumber( uint16_t group, uint16_t elem)
686 {
687    SeqEntry* seqEntry = 0;
688    DocEntry* currentEntry = GetDocEntryByNumber( group, elem);
689
690    // Verify the currentEntry
691    if (currentEntry)
692    {
693       seqEntry = dynamic_cast< SeqEntry* >(currentEntry);
694
695       // Verify the VR
696       if( seqEntry )
697          if( seqEntry->GetVR()!="SQ" )
698             seqEntry=NULL;
699
700       // if currentEntry doesn't correspond to the requested valEntry
701       if( !seqEntry)
702       {
703          if (!RemoveEntry(currentEntry))
704          {
705             dbg.Verbose(0, "Document::ReplaceOrCreateByNumber: removal"
706                            " of previous DocEntry failed.");
707
708             return NULL;
709          }
710       }
711    }
712
713    // Create a new seqEntry if necessary
714    if (!seqEntry)
715    {
716       seqEntry = NewSeqEntryByNumber(group, elem);
717
718       if ( !AddEntry(seqEntry))
719       {
720          dbg.Verbose(0, "Document::ReplaceOrCreateByNumber: AddEntry"
721                         " failed allthough this is a creation.");
722
723          delete seqEntry;
724          return NULL;
725       }
726    }
727
728    return seqEntry;
729
730  
731 /**
732  * \brief Set a new value if the invoked element exists
733  *        Seems to be useless !!!
734  * @param value new element value
735  * @param group  group number of the Entry 
736  * @param elem element number of the Entry
737  * \return  boolean 
738  */
739 bool Document::ReplaceIfExistByNumber(std::string const & value, 
740                                       uint16_t group, uint16_t elem ) 
741 {
742    SetEntryByNumber(value, group, elem);
743
744    return true;
745
746
747 std::string Document::GetTransferSyntaxValue(TransferSyntaxType type)
748 {
749    return TransferSyntaxStrings[type];
750 }
751
752 //-----------------------------------------------------------------------------
753 // Protected
754
755 /**
756  * \brief   Checks if a given Dicom Element exists within the H table
757  * @param   group      Group number of the searched Dicom Element 
758  * @param   element  Element number of the searched Dicom Element 
759  * @return true is found
760  */
761 bool Document::CheckIfEntryExistByNumber(uint16_t group, uint16_t element )
762 {
763    const std::string &key = DictEntry::TranslateToKey(group, element );
764    return TagHT.count(key) != 0;
765 }
766
767 /**
768  * \brief   Searches within Header Entries (Dicom Elements) parsed with 
769  *          the public and private dictionaries 
770  *          for the element value of a given tag.
771  * \warning Don't use any longer : use GetPubEntryByName
772  * @param   tagName name of the searched element.
773  * @return  Corresponding element value when it exists,
774  *          and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise.
775  */
776 std::string Document::GetEntryByName(TagName const & tagName)
777 {
778    DictEntry* dictEntry = RefPubDict->GetDictEntryByName(tagName); 
779    if( !dictEntry )
780    {
781       return GDCM_UNFOUND;
782    }
783
784    return GetEntryByNumber(dictEntry->GetGroup(),dictEntry->GetElement());
785 }
786
787 /**
788  * \brief   Searches within Header Entries (Dicom Elements) parsed with 
789  *          the public and private dictionaries 
790  *          for the element value representation of a given tag.
791  *
792  *          Obtaining the VR (Value Representation) might be needed by caller
793  *          to convert the string typed content to caller's native type 
794  *          (think of C++ vs Python). The VR is actually of a higher level
795  *          of semantics than just the native C++ type.
796  * @param   tagName name of the searched element.
797  * @return  Corresponding element value representation when it exists,
798  *          and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise.
799  */
800 std::string Document::GetEntryVRByName(TagName const& tagName)
801 {
802    DictEntry *dictEntry = RefPubDict->GetDictEntryByName(tagName); 
803    if( dictEntry == NULL)
804    {
805       return GDCM_UNFOUND;
806    }
807
808    DocEntry* elem = GetDocEntryByNumber(dictEntry->GetGroup(),
809                                         dictEntry->GetElement());
810    return elem->GetVR();
811 }
812
813 /**
814  * \brief   Searches within Header Entries (Dicom Elements) parsed with 
815  *          the public and private dictionaries 
816  *          for the element value representation of a given tag.
817  * @param   group Group number of the searched tag.
818  * @param   element Element number of the searched tag.
819  * @return  Corresponding element value representation when it exists,
820  *          and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise.
821  */
822 std::string Document::GetEntryByNumber(uint16_t group, uint16_t element)
823 {
824    TagKey key = DictEntry::TranslateToKey(group, element);
825    if ( !TagHT.count(key))
826    {
827       return GDCM_UNFOUND;
828    }
829
830    return ((ValEntry *)TagHT.find(key)->second)->GetValue();
831 }
832
833 /**
834  * \brief   Searches within Header Entries (Dicom Elements) parsed with 
835  *          the public and private dictionaries 
836  *          for the element value representation of a given tag..
837  *
838  *          Obtaining the VR (Value Representation) might be needed by caller
839  *          to convert the string typed content to caller's native type 
840  *          (think of C++ vs Python). The VR is actually of a higher level
841  *          of semantics than just the native C++ type.
842  * @param   group     Group number of the searched tag.
843  * @param   element Element number of the searched tag.
844  * @return  Corresponding element value representation when it exists,
845  *          and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise.
846  */
847 std::string Document::GetEntryVRByNumber(uint16_t group, uint16_t element)
848 {
849    DocEntry* elem = GetDocEntryByNumber(group, element);
850    if ( !elem )
851    {
852       return GDCM_UNFOUND;
853    }
854    return elem->GetVR();
855 }
856
857 /**
858  * \brief   Searches within Header Entries (Dicom Elements) parsed with 
859  *          the public and private dictionaries 
860  *          for the value length of a given tag..
861  * @param   group     Group number of the searched tag.
862  * @param   element Element number of the searched tag.
863  * @return  Corresponding element length; -2 if not found
864  */
865 int Document::GetEntryLengthByNumber(uint16_t group, uint16_t element)
866 {
867    DocEntry* elem =  GetDocEntryByNumber(group, element);
868    if ( !elem )
869    {
870       return -2;  //magic number
871    }
872    return elem->GetLength();
873 }
874 /**
875  * \brief   Sets the value (string) of the Header Entry (Dicom Element)
876  * @param   content string value of the Dicom Element
877  * @param   tagName name of the searched Dicom Element.
878  * @return  true when found
879  */
880 bool Document::SetEntryByName( std::string const & content,
881                                TagName const & tagName)
882 {
883    DictEntry *dictEntry = RefPubDict->GetDictEntryByName(tagName); 
884    if( !dictEntry )
885    {
886       return false;
887    }
888
889    return SetEntryByNumber(content,dictEntry->GetGroup(),
890                                    dictEntry->GetElement());
891 }
892
893 /**
894  * \brief   Accesses an existing DocEntry (i.e. a Dicom Element)
895  *          through it's (group, element) and modifies it's content with
896  *          the given value.
897  * @param   content new value (string) to substitute with
898  * @param   group     group number of the Dicom Element to modify
899  * @param   element element number of the Dicom Element to modify
900  */
901 bool Document::SetEntryByNumber(std::string const& content, 
902                                 uint16_t group, uint16_t element) 
903 {
904    ValEntry* entry = GetValEntryByNumber(group, element);
905    if (!entry )
906    {
907       dbg.Verbose(0, "Document::SetEntryByNumber: no corresponding",
908                      " ValEntry (try promotion first).");
909       return false;
910    }
911    return SetEntry(content,entry);
912
913
914 /**
915  * \brief   Accesses an existing DocEntry (i.e. a Dicom Element)
916  *          through it's (group, element) and modifies it's content with
917  *          the given value.
918  * @param   content new value (void*  -> uint8_t*) to substitute with
919  * @param   lgth new value length
920  * @param   group     group number of the Dicom Element to modify
921  * @param   element element number of the Dicom Element to modify
922  */
923 bool Document::SetEntryByNumber(uint8_t*content, int lgth, 
924                                 uint16_t group, uint16_t element) 
925 {
926    BinEntry* entry = GetBinEntryByNumber(group, element);
927    if (!entry )
928    {
929       dbg.Verbose(0, "Document::SetEntryByNumber: no corresponding",
930                      " ValEntry (try promotion first).");
931       return false;
932    }
933
934    return SetEntry(content,lgth,entry);
935
936
937 /**
938  * \brief   Accesses an existing DocEntry (i.e. a Dicom Element)
939  *          and modifies it's content with the given value.
940  * @param   content new value (string) to substitute with
941  */
942 bool Document::SetEntry(std::string const & content,ValEntry* entry)
943 {
944    if(entry)
945    {
946       entry->SetValue(content);
947       return true;
948    }
949    return false;
950 }
951
952 /**
953  * \brief   Accesses an existing BinEntry (i.e. a Dicom Element)
954  *          and modifies it's content with the given value.
955  * @param   content new value (void*  -> uint8_t*) to substitute with
956  * @param   lgth new value length
957  */
958 bool Document::SetEntry(uint8_t* content, int lgth,BinEntry* entry)
959 {
960    if(entry)
961    {
962       // Hope Binary field length is *never* wrong    
963       /*if(lgth%2) // Non even length are padded with a space (020H).
964       {  
965          lgth++;
966          //content = content + '\0'; // fing a trick to enlarge a binary field?
967       }*/
968       
969       entry->SetBinArea(content);  
970       entry->SetLength(lgth);
971       entry->SetValue(GDCM_BINLOADED);
972       return true;
973    }
974    return false;
975 }
976
977 /**
978  * \brief   Gets (from Header) a 'non string' element value 
979  *          (LoadElementValues has already be executed)  
980  * @param group   group number of the Entry 
981  * @param elem  element number of the Entry
982  * @return Pointer to the 'non string' area
983  */
984 void*  Document::GetEntryBinAreaByNumber(uint16_t group, uint16_t elem) 
985 {
986    DocEntry* entry = GetDocEntryByNumber(group, elem);
987    if (!entry) 
988    {
989       dbg.Verbose(1, "Document::GetDocEntryByNumber: no entry");
990       return 0;
991    }
992    if ( BinEntry* binEntry = dynamic_cast<BinEntry*>(entry) )
993    {
994       return binEntry->GetBinArea();
995    }
996
997    return 0;
998 }
999
1000 /**
1001  * \brief         Loads (from disk) the element content 
1002  *                when a string is not suitable
1003  * @param group   group number of the Entry 
1004  * @param elem  element number of the Entry
1005  */
1006 void Document::LoadEntryBinArea(uint16_t group, uint16_t elem)
1007 {
1008    // Search the corresponding DocEntry
1009    DocEntry *docElement = GetDocEntryByNumber(group, elem);
1010    if ( !docElement )
1011       return;
1012
1013    BinEntry *binElement = dynamic_cast<BinEntry *>(docElement);
1014    if( !binElement )
1015       return;
1016
1017    LoadEntryBinArea(binElement);
1018 }
1019
1020 /**
1021  * \brief         Loads (from disk) the element content 
1022  *                when a string is not suitable
1023  * @param element  Entry whose binArea is going to be loaded
1024  */
1025 void Document::LoadEntryBinArea(BinEntry* element) 
1026 {
1027    if(element->GetBinArea())
1028       return;
1029
1030    bool openFile = !Fp;
1031    if(openFile)
1032       OpenFile();
1033
1034    size_t o =(size_t)element->GetOffset();
1035    Fp->seekg(o, std::ios::beg);
1036
1037    size_t l = element->GetLength();
1038    uint8_t* a = new uint8_t[l];
1039    if( !a )
1040    {
1041       dbg.Verbose(0, "Document::LoadEntryBinArea cannot allocate a");
1042       return;
1043    }
1044
1045    /// \todo check the result 
1046    Fp->read((char*)a, l);
1047    if( Fp->fail() || Fp->eof()) //Fp->gcount() == 1
1048    {
1049       delete[] a;
1050       return;
1051    }
1052
1053    element->SetBinArea(a);
1054
1055    if(openFile)
1056       CloseFile();
1057 }
1058
1059 /**
1060  * \brief   Sets a 'non string' value to a given Dicom Element
1061  * @param   area area containing the 'non string' value
1062  * @param   group     Group number of the searched Dicom Element 
1063  * @param   element Element number of the searched Dicom Element 
1064  * @return  
1065  */
1066 /*bool Document::SetEntryBinAreaByNumber(uint8_t* area,
1067                                        uint16_t group, uint16_t element) 
1068 {
1069    DocEntry* currentEntry = GetDocEntryByNumber(group, element);
1070    if ( !currentEntry )
1071    {
1072       return false;
1073    }
1074
1075    if ( BinEntry* binEntry = dynamic_cast<BinEntry*>(currentEntry) )
1076    {
1077       binEntry->SetBinArea( area );
1078       return true;
1079    }
1080
1081    return false;
1082 }*/
1083
1084 /**
1085  * \brief   Searches within the Header Entries for a Dicom Element of
1086  *          a given tag.
1087  * @param   tagName name of the searched Dicom Element.
1088  * @return  Corresponding Dicom Element when it exists, and NULL
1089  *          otherwise.
1090  */
1091 DocEntry* Document::GetDocEntryByName(TagName const & tagName)
1092 {
1093    DictEntry *dictEntry = RefPubDict->GetDictEntryByName(tagName); 
1094    if( !dictEntry )
1095    {
1096       return NULL;
1097    }
1098
1099   return GetDocEntryByNumber(dictEntry->GetGroup(),dictEntry->GetElement());
1100 }
1101
1102 /**
1103  * \brief  retrieves a Dicom Element (the first one) using (group, element)
1104  * \warning (group, element) IS NOT an identifier inside the Dicom Header
1105  *           if you think it's NOT UNIQUE, check the count number
1106  *           and use iterators to retrieve ALL the Dicoms Elements within
1107  *           a given couple (group, element)
1108  * @param   group Group number of the searched Dicom Element 
1109  * @param   element Element number of the searched Dicom Element 
1110  * @return  
1111  */
1112 DocEntry* Document::GetDocEntryByNumber(uint16_t group, uint16_t element) 
1113 {
1114    TagKey key = DictEntry::TranslateToKey(group, element);
1115    if ( !TagHT.count(key))
1116    {
1117       return NULL;
1118    }
1119    return TagHT.find(key)->second;
1120 }
1121
1122 /**
1123  * \brief  Same as \ref Document::GetDocEntryByNumber except it only
1124  *         returns a result when the corresponding entry is of type
1125  *         ValEntry.
1126  * @return When present, the corresponding ValEntry. 
1127  */
1128 ValEntry* Document::GetValEntryByNumber(uint16_t group, uint16_t element)
1129 {
1130    DocEntry* currentEntry = GetDocEntryByNumber(group, element);
1131    if ( !currentEntry )
1132    {
1133       return 0;
1134    }
1135    if ( ValEntry* entry = dynamic_cast<ValEntry*>(currentEntry) )
1136    {
1137       return entry;
1138    }
1139    dbg.Verbose(0, "Document::GetValEntryByNumber: unfound ValEntry.");
1140
1141    return 0;
1142 }
1143
1144 /**
1145  * \brief  Same as \ref Document::GetDocEntryByNumber except it only
1146  *         returns a result when the corresponding entry is of type
1147  *         BinEntry.
1148  * @return When present, the corresponding BinEntry. 
1149  */
1150 BinEntry* Document::GetBinEntryByNumber(uint16_t group, uint16_t element)
1151 {
1152    DocEntry* currentEntry = GetDocEntryByNumber(group, element);
1153    if ( !currentEntry )
1154    {
1155       return 0;
1156    }
1157    if ( BinEntry* entry = dynamic_cast<BinEntry*>(currentEntry) )
1158    {
1159       return entry;
1160    }
1161    dbg.Verbose(0, "Document::GetBinEntryByNumber: unfound BinEntry.");
1162
1163    return 0;
1164 }
1165
1166 /**
1167  * \brief         Loads the element while preserving the current
1168  *                underlying file position indicator as opposed to
1169  *                to LoadDocEntry that modifies it.
1170  * @param entry   Header Entry whose value shall be loaded. 
1171  * @return  
1172  */
1173 void Document::LoadDocEntrySafe(DocEntry * entry)
1174 {
1175    if(Fp)
1176    {
1177       long PositionOnEntry = Fp->tellg();
1178       LoadDocEntry(entry);
1179       Fp->seekg(PositionOnEntry, std::ios::beg);
1180    }
1181 }
1182
1183 /**
1184  * \brief   Swaps back the bytes of 4-byte long integer accordingly to
1185  *          processor order.
1186  * @return  The properly swaped 32 bits integer.
1187  */
1188 uint32_t Document::SwapLong(uint32_t a)
1189 {
1190    switch (SwapCode)
1191    {
1192       case    0 :
1193          break;
1194       case 4321 :
1195          a=( ((a<<24) & 0xff000000) | ((a<<8)  & 0x00ff0000) | 
1196              ((a>>8)  & 0x0000ff00) | ((a>>24) & 0x000000ff) );
1197          break;
1198    
1199       case 3412 :
1200          a=( ((a<<16) & 0xffff0000) | ((a>>16) & 0x0000ffff) );
1201          break;
1202    
1203       case 2143 :
1204          a=( ((a<< 8) & 0xff00ff00) | ((a>>8) & 0x00ff00ff)  );
1205          break;
1206       default :
1207          //std::cout << "swapCode= " << SwapCode << std::endl;
1208          dbg.Error(" Document::SwapLong : unset swap code");
1209          a = 0;
1210    }
1211    return a;
1212
1213
1214 /**
1215  * \brief   Unswaps back the bytes of 4-byte long integer accordingly to
1216  *          processor order.
1217  * @return  The properly unswaped 32 bits integer.
1218  */
1219 uint32_t Document::UnswapLong(uint32_t a)
1220 {
1221    return SwapLong(a);
1222 }
1223
1224 /**
1225  * \brief   Swaps the bytes so they agree with the processor order
1226  * @return  The properly swaped 16 bits integer.
1227  */
1228 uint16_t Document::SwapShort(uint16_t a)
1229 {
1230    if ( SwapCode == 4321 || SwapCode == 2143 )
1231    {
1232       a = ((( a << 8 ) & 0x0ff00 ) | (( a >> 8 ) & 0x00ff ) );
1233    }
1234    return a;
1235 }
1236
1237 /**
1238  * \brief   Unswaps the bytes so they agree with the processor order
1239  * @return  The properly unswaped 16 bits integer.
1240  */
1241 uint16_t Document::UnswapShort(uint16_t a)
1242 {
1243    return SwapShort(a);
1244 }
1245
1246 //-----------------------------------------------------------------------------
1247 // Private
1248
1249 /**
1250  * \brief   Parses a DocEntrySet (Zero-level DocEntries or SQ Item DocEntries)
1251  * @return  length of the parsed set. 
1252  */ 
1253 void Document::ParseDES(DocEntrySet *set, long offset, 
1254                         long l_max, bool delim_mode)
1255 {
1256    DocEntry *newDocEntry = 0;
1257
1258    while (true)
1259    {
1260       if ( !delim_mode && ((long)(Fp->tellg())-offset) >= l_max)
1261       {
1262          break;
1263       }
1264       newDocEntry = ReadNextDocEntry( );
1265       if ( !newDocEntry )
1266       {
1267          break;
1268       }
1269
1270       VRKey vr = newDocEntry->GetVR();
1271       if ( vr != "SQ" )
1272       {
1273                
1274          if ( Global::GetVR()->IsVROfGdcmStringRepresentable(vr) )
1275          {
1276          /////////////////////// ValEntry
1277             ValEntry* newValEntry =
1278                new ValEntry( newDocEntry->GetDictEntry() ); //LEAK
1279             newValEntry->Copy( newDocEntry );
1280              
1281             // When "set" is a Document, then we are at the top of the
1282             // hierarchy and the Key is simply of the form ( group, elem )...
1283             if (Document* dummy = dynamic_cast< Document* > ( set ) )
1284             {
1285                (void)dummy;
1286                newValEntry->SetKey( newValEntry->GetKey() );
1287             }
1288             // ...but when "set" is a SQItem, we are inserting this new
1289             // valEntry in a sequence item. Hence the key has the
1290             // generalized form (refer to \ref BaseTagKey):
1291             if (SQItem* parentSQItem = dynamic_cast< SQItem* > ( set ) )
1292             {
1293                newValEntry->SetKey(  parentSQItem->GetBaseTagKey()
1294                                    + newValEntry->GetKey() );
1295             }
1296              
1297             LoadDocEntry( newValEntry );
1298             bool delimitor=newValEntry->IsItemDelimitor();
1299             if( !set->AddEntry( newValEntry ) )
1300             {
1301               // If here expect big troubles
1302               delete newValEntry; //otherwise mem leak
1303             }
1304
1305             if (delimitor)
1306             {
1307                delete newDocEntry;
1308                break;
1309             }
1310             if ( !delim_mode && ((long)(Fp->tellg())-offset) >= l_max)
1311             {
1312                delete newDocEntry;
1313                break;
1314             }
1315          }
1316          else
1317          {
1318             if ( ! Global::GetVR()->IsVROfGdcmBinaryRepresentable(vr) )
1319             { 
1320                 ////// Neither ValEntry NOR BinEntry: should mean UNKOWN VR
1321                 dbg.Verbose(0, "Document::ParseDES: neither Valentry, "
1322                                "nor BinEntry. Probably unknown VR.");
1323             }
1324
1325          //////////////////// BinEntry or UNKOWN VR:
1326             BinEntry* newBinEntry = new BinEntry( newDocEntry );  //LEAK
1327
1328             // When "this" is a Document the Key is simply of the
1329             // form ( group, elem )...
1330             if (Document* dummy = dynamic_cast< Document* > ( set ) )
1331             {
1332                (void)dummy;
1333                newBinEntry->SetKey( newBinEntry->GetKey() );
1334             }
1335             // but when "this" is a SQItem, we are inserting this new
1336             // valEntry in a sequence item, and the kay has the
1337             // generalized form (refer to \ref BaseTagKey):
1338             if (SQItem* parentSQItem = dynamic_cast< SQItem* > ( set ) )
1339             {
1340                newBinEntry->SetKey(  parentSQItem->GetBaseTagKey()
1341                                    + newBinEntry->GetKey() );
1342             }
1343
1344             LoadDocEntry( newBinEntry );
1345             if( !set->AddEntry( newBinEntry ) )
1346             {
1347               //Expect big troubles if here
1348               delete newBinEntry;
1349             }
1350          }
1351
1352          if (    ( newDocEntry->GetGroup()   == 0x7fe0 )
1353               && ( newDocEntry->GetElement() == 0x0010 ) )
1354          {
1355              TransferSyntaxType ts = GetTransferSyntax();
1356              if ( ts == RLELossless ) 
1357              {
1358                 long PositionOnEntry = Fp->tellg();
1359                 Fp->seekg( newDocEntry->GetOffset(), std::ios::beg );
1360                 ComputeRLEInfo();
1361                 Fp->seekg( PositionOnEntry, std::ios::beg );
1362              }
1363              else if ( IsJPEG() )
1364              {
1365                 long PositionOnEntry = Fp->tellg();
1366                 Fp->seekg( newDocEntry->GetOffset(), std::ios::beg );
1367                 ComputeJPEGFragmentInfo();
1368                 Fp->seekg( PositionOnEntry, std::ios::beg );
1369              }
1370          }
1371     
1372          // Just to make sure we are at the beginning of next entry.
1373          SkipToNextDocEntry(newDocEntry);
1374          //delete newDocEntry;
1375       }
1376       else
1377       {
1378          // VR = "SQ"
1379          unsigned long l = newDocEntry->GetReadLength();            
1380          if ( l != 0 ) // don't mess the delim_mode for zero-length sequence
1381          {
1382             if ( l == 0xffffffff )
1383             {
1384               delim_mode = true;
1385             }
1386             else
1387             {
1388               delim_mode = false;
1389             }
1390          }
1391          // no other way to create it ...
1392          SeqEntry* newSeqEntry =
1393             new SeqEntry( newDocEntry->GetDictEntry() );
1394          newSeqEntry->Copy( newDocEntry );
1395          newSeqEntry->SetDelimitorMode( delim_mode );
1396
1397          // At the top of the hierarchy, stands a Document. When "set"
1398          // is a Document, then we are building the first depth level.
1399          // Hence the SeqEntry we are building simply has a depth
1400          // level of one:
1401          if (Document* dummy = dynamic_cast< Document* > ( set ) )
1402          {
1403             (void)dummy;
1404             newSeqEntry->SetDepthLevel( 1 );
1405             newSeqEntry->SetKey( newSeqEntry->GetKey() );
1406          }
1407          // But when "set" is allready a SQItem, we are building a nested
1408          // sequence, and hence the depth level of the new SeqEntry
1409          // we are building, is one level deeper:
1410          if (SQItem* parentSQItem = dynamic_cast< SQItem* > ( set ) )
1411          {
1412             newSeqEntry->SetDepthLevel( parentSQItem->GetDepthLevel() + 1 );
1413             newSeqEntry->SetKey(  parentSQItem->GetBaseTagKey()
1414                                 + newSeqEntry->GetKey() );
1415          }
1416
1417          if ( l != 0 )
1418          {  // Don't try to parse zero-length sequences
1419             ParseSQ( newSeqEntry, 
1420                      newDocEntry->GetOffset(),
1421                      l, delim_mode);
1422          }
1423          set->AddEntry( newSeqEntry );
1424          if ( !delim_mode && ((long)(Fp->tellg())-offset) >= l_max)
1425          {
1426             delete newDocEntry;
1427             break;
1428          }
1429       }
1430       delete newDocEntry;
1431    }
1432 }
1433
1434 /**
1435  * \brief   Parses a Sequence ( SeqEntry after SeqEntry)
1436  * @return  parsed length for this level
1437  */ 
1438 void Document::ParseSQ( SeqEntry* seqEntry,
1439                         long offset, long l_max, bool delim_mode)
1440 {
1441    int SQItemNumber = 0;
1442    bool dlm_mod;
1443
1444    while (true)
1445    {
1446       DocEntry* newDocEntry = ReadNextDocEntry();   
1447       if ( !newDocEntry )
1448       {
1449          // FIXME Should warn user
1450          break;
1451       }
1452       if( delim_mode )
1453       {
1454          if ( newDocEntry->IsSequenceDelimitor() )
1455          {
1456             seqEntry->SetSequenceDelimitationItem( newDocEntry ); 
1457             break;
1458          }
1459       }
1460       if ( !delim_mode && ((long)(Fp->tellg())-offset) >= l_max)
1461       {
1462          delete newDocEntry;
1463          break;
1464       }
1465
1466       SQItem *itemSQ = new SQItem( seqEntry->GetDepthLevel() );
1467       std::ostringstream newBase;
1468       newBase << seqEntry->GetKey()
1469               << "/"
1470               << SQItemNumber
1471               << "#";
1472       itemSQ->SetBaseTagKey( newBase.str() );
1473       unsigned int l = newDocEntry->GetReadLength();
1474       
1475       if ( l == 0xffffffff )
1476       {
1477          dlm_mod = true;
1478       }
1479       else
1480       {
1481          dlm_mod = false;
1482       }
1483    
1484       ParseDES(itemSQ, newDocEntry->GetOffset(), l, dlm_mod);
1485       delete newDocEntry;
1486       
1487       seqEntry->AddEntry( itemSQ, SQItemNumber ); 
1488       SQItemNumber++;
1489       if ( !delim_mode && ((long)(Fp->tellg())-offset ) >= l_max )
1490       {
1491          break;
1492       }
1493    }
1494 }
1495
1496 /**
1497  * \brief         Loads the element content if its length doesn't exceed
1498  *                the value specified with Document::SetMaxSizeLoadEntry()
1499  * @param         entry Header Entry (Dicom Element) to be dealt with
1500  */
1501 void Document::LoadDocEntry(DocEntry* entry)
1502 {
1503    uint16_t group  = entry->GetGroup();
1504    std::string  vr = entry->GetVR();
1505    uint32_t length = entry->GetLength();
1506
1507    Fp->seekg((long)entry->GetOffset(), std::ios::beg);
1508
1509    // A SeQuence "contains" a set of Elements.  
1510    //          (fffe e000) tells us an Element is beginning
1511    //          (fffe e00d) tells us an Element just ended
1512    //          (fffe e0dd) tells us the current SeQuence just ended
1513    if( group == 0xfffe )
1514    {
1515       // NO more value field for SQ !
1516       return;
1517    }
1518
1519    // When the length is zero things are easy:
1520    if ( length == 0 )
1521    {
1522       ((ValEntry *)entry)->SetValue("");
1523       return;
1524    }
1525
1526    // The elements whose length is bigger than the specified upper bound
1527    // are not loaded. Instead we leave a short notice of the offset of
1528    // the element content and it's length.
1529
1530    std::ostringstream s;
1531    if (length > MaxSizeLoadEntry)
1532    {
1533       if (BinEntry* binEntryPtr = dynamic_cast< BinEntry* >(entry) )
1534       {  
1535          //s << "gdcm::NotLoaded (BinEntry)";
1536          s << GDCM_NOTLOADED;
1537          s << " Address:" << (long)entry->GetOffset();
1538          s << " Length:"  << entry->GetLength();
1539          s << " x(" << std::hex << entry->GetLength() << ")";
1540          binEntryPtr->SetValue(s.str());
1541       }
1542       // Be carefull : a BinEntry IS_A ValEntry ... 
1543       else if (ValEntry* valEntryPtr = dynamic_cast< ValEntry* >(entry) )
1544       {
1545         // s << "gdcm::NotLoaded. (ValEntry)";
1546          s << GDCM_NOTLOADED;  
1547          s << " Address:" << (long)entry->GetOffset();
1548          s << " Length:"  << entry->GetLength();
1549          s << " x(" << std::hex << entry->GetLength() << ")";
1550          valEntryPtr->SetValue(s.str());
1551       }
1552       else
1553       {
1554          // fusible
1555          std::cout<< "MaxSizeLoadEntry exceeded, neither a BinEntry "
1556                   << "nor a ValEntry ?! Should never print that !" << std::endl;
1557       }
1558
1559       // to be sure we are at the end of the value ...
1560       Fp->seekg((long)entry->GetOffset()+(long)entry->GetLength(),
1561                 std::ios::beg);
1562       return;
1563    }
1564
1565    // When we find a BinEntry not very much can be done :
1566    if (BinEntry* binEntryPtr = dynamic_cast< BinEntry* >(entry) )
1567    {
1568       s << GDCM_BINLOADED;
1569       binEntryPtr->SetValue(s.str());
1570       LoadEntryBinArea(binEntryPtr); // last one, not to erase length !
1571       return;
1572    }
1573     
1574    /// \todo Any compacter code suggested (?)
1575    if ( IsDocEntryAnInteger(entry) )
1576    {   
1577       uint32_t NewInt;
1578       int nbInt;
1579       // When short integer(s) are expected, read and convert the following 
1580       // n *two characters properly i.e. consider them as short integers as
1581       // opposed to strings.
1582       // Elements with Value Multiplicity > 1
1583       // contain a set of integers (not a single one)       
1584       if (vr == "US" || vr == "SS")
1585       {
1586          nbInt = length / 2;
1587          NewInt = ReadInt16();
1588          s << NewInt;
1589          if (nbInt > 1)
1590          {
1591             for (int i=1; i < nbInt; i++)
1592             {
1593                s << '\\';
1594                NewInt = ReadInt16();
1595                s << NewInt;
1596             }
1597          }
1598       }
1599       // See above comment on multiple integers (mutatis mutandis).
1600       else if (vr == "UL" || vr == "SL")
1601       {
1602          nbInt = length / 4;
1603          NewInt = ReadInt32();
1604          s << NewInt;
1605          if (nbInt > 1)
1606          {
1607             for (int i=1; i < nbInt; i++)
1608             {
1609                s << '\\';
1610                NewInt = ReadInt32();
1611                s << NewInt;
1612             }
1613          }
1614       }
1615 #ifdef GDCM_NO_ANSI_STRING_STREAM
1616       s << std::ends; // to avoid oddities on Solaris
1617 #endif //GDCM_NO_ANSI_STRING_STREAM
1618
1619       ((ValEntry *)entry)->SetValue(s.str());
1620       return;
1621    }
1622    
1623   // FIXME: We need an additional byte for storing \0 that is not on disk
1624    char *str = new char[length+1];
1625    Fp->read(str, (size_t)length);
1626    str[length] = '\0'; //this is only useful when length is odd
1627    // Special DicomString call to properly handle \0 and even length
1628    std::string newValue;
1629    if( length % 2 )
1630    {
1631       newValue = Util::DicomString(str, length+1);
1632       //dbg.Verbose(0, "Warning: bad length: ", length );
1633       dbg.Verbose(0, "For string :",  newValue.c_str()); 
1634       // Since we change the length of string update it length
1635       entry->SetReadLength(length+1);
1636    }
1637    else
1638    {
1639       newValue = Util::DicomString(str, length);
1640    }
1641    delete[] str;
1642
1643    if ( ValEntry* valEntry = dynamic_cast<ValEntry* >(entry) )
1644    {
1645       if ( Fp->fail() || Fp->eof())//Fp->gcount() == 1
1646       {
1647          dbg.Verbose(1, "Document::LoadDocEntry",
1648                         "unread element value");
1649          valEntry->SetValue(GDCM_UNREAD);
1650          return;
1651       }
1652
1653       if( vr == "UI" )
1654       {
1655          // Because of correspondance with the VR dic
1656          valEntry->SetValue(newValue);
1657       }
1658       else
1659       {
1660          valEntry->SetValue(newValue);
1661       }
1662    }
1663    else
1664    {
1665       dbg.Error(true, "Document::LoadDocEntry"
1666                       "Should have a ValEntry, here !");
1667    }
1668 }
1669
1670
1671 /**
1672  * \brief  Find the value Length of the passed Header Entry
1673  * @param  entry Header Entry whose length of the value shall be loaded. 
1674  */
1675 void Document::FindDocEntryLength( DocEntry *entry )
1676    throw ( FormatError )
1677 {
1678    uint16_t element = entry->GetElement();
1679    std::string  vr  = entry->GetVR();
1680    uint16_t length16;       
1681    
1682    if ( Filetype == ExplicitVR && !entry->IsImplicitVR() ) 
1683    {
1684       if ( vr == "OB" || vr == "OW" || vr == "SQ" || vr == "UN" ) 
1685       {
1686          // The following reserved two bytes (see PS 3.5-2003, section
1687          // "7.1.2 Data element structure with explicit vr", p 27) must be
1688          // skipped before proceeding on reading the length on 4 bytes.
1689          Fp->seekg( 2L, std::ios::cur);
1690          uint32_t length32 = ReadInt32();
1691
1692          if ( (vr == "OB" || vr == "OW") && length32 == 0xffffffff ) 
1693          {
1694             uint32_t lengthOB;
1695             try 
1696             {
1697                /// \todo rename that to FindDocEntryLengthOBOrOW since
1698                ///       the above test is on both OB and OW...
1699                lengthOB = FindDocEntryLengthOB();
1700             }
1701             catch ( FormatUnexpected )
1702             {
1703                // Computing the length failed (this happens with broken
1704                // files like gdcm-JPEG-LossLess3a.dcm). We still have a
1705                // chance to get the pixels by deciding the element goes
1706                // until the end of the file. Hence we artificially fix the
1707                // the length and proceed.
1708                long currentPosition = Fp->tellg();
1709                Fp->seekg(0L,std::ios::end);
1710                long lengthUntilEOF = (long)(Fp->tellg())-currentPosition;
1711                Fp->seekg(currentPosition, std::ios::beg);
1712                entry->SetLength(lengthUntilEOF);
1713                return;
1714             }
1715             entry->SetLength(lengthOB);
1716             return;
1717          }
1718          FixDocEntryFoundLength(entry, length32); 
1719          return;
1720       }
1721
1722       // Length is encoded on 2 bytes.
1723       length16 = ReadInt16();
1724       
1725       // We can tell the current file is encoded in big endian (like
1726       // Data/US-RGB-8-epicard) when we find the "Transfer Syntax" tag
1727       // and it's value is the one of the encoding of a big endian file.
1728       // In order to deal with such big endian encoded files, we have
1729       // (at least) two strategies:
1730       // * when we load the "Transfer Syntax" tag with value of big endian
1731       //   encoding, we raise the proper flags. Then we wait for the end
1732       //   of the META group (0x0002) among which is "Transfer Syntax",
1733       //   before switching the swap code to big endian. We have to postpone
1734       //   the switching of the swap code since the META group is fully encoded
1735       //   in little endian, and big endian coding only starts at the next
1736       //   group. The corresponding code can be hard to analyse and adds
1737       //   many additional unnecessary tests for regular tags.
1738       // * the second strategy consists in waiting for trouble, that shall
1739       //   appear when we find the first group with big endian encoding. This
1740       //   is easy to detect since the length of a "Group Length" tag (the
1741       //   ones with zero as element number) has to be of 4 (0x0004). When we
1742       //   encounter 1024 (0x0400) chances are the encoding changed and we
1743       //   found a group with big endian encoding.
1744       // We shall use this second strategy. In order to make sure that we
1745       // can interpret the presence of an apparently big endian encoded
1746       // length of a "Group Length" without committing a big mistake, we
1747       // add an additional check: we look in the already parsed elements
1748       // for the presence of a "Transfer Syntax" whose value has to be "big
1749       // endian encoding". When this is the case, chances are we have got our
1750       // hands on a big endian encoded file: we switch the swap code to
1751       // big endian and proceed...
1752       if ( element  == 0x0000 && length16 == 0x0400 ) 
1753       {
1754          TransferSyntaxType ts = GetTransferSyntax();
1755          if ( ts != ExplicitVRBigEndian ) 
1756          {
1757             throw FormatError( "Document::FindDocEntryLength()",
1758                                " not explicit VR." );
1759             return;
1760          }
1761          length16 = 4;
1762          SwitchSwapToBigEndian();
1763          // Restore the unproperly loaded values i.e. the group, the element
1764          // and the dictionary entry depending on them.
1765          uint16_t correctGroup = SwapShort( entry->GetGroup() );
1766          uint16_t correctElem  = SwapShort( entry->GetElement() );
1767          DictEntry* newTag = GetDictEntryByNumber( correctGroup,
1768                                                        correctElem );
1769          if ( !newTag )
1770          {
1771             // This correct tag is not in the dictionary. Create a new one.
1772             newTag = NewVirtualDictEntry(correctGroup, correctElem);
1773          }
1774          // FIXME this can create a memory leaks on the old entry that be
1775          // left unreferenced.
1776          entry->SetDictEntry( newTag );
1777       }
1778        
1779       // Heuristic: well, some files are really ill-formed.
1780       if ( length16 == 0xffff) 
1781       {
1782          // 0xffff means that we deal with 'Unknown Length' Sequence  
1783          length16 = 0;
1784       }
1785       FixDocEntryFoundLength( entry, (uint32_t)length16 );
1786       return;
1787    }
1788    else
1789    {
1790       // Either implicit VR or a non DICOM conformal (see note below) explicit
1791       // VR that ommited the VR of (at least) this element. Farts happen.
1792       // [Note: according to the part 5, PS 3.5-2001, section 7.1 p25
1793       // on Data elements "Implicit and Explicit VR Data Elements shall
1794       // not coexist in a Data Set and Data Sets nested within it".]
1795       // Length is on 4 bytes.
1796       
1797       FixDocEntryFoundLength( entry, ReadInt32() );
1798       return;
1799    }
1800 }
1801
1802 /**
1803  * \brief     Find the Value Representation of the current Dicom Element.
1804  * @param     entry
1805  */
1806 std::string Document::FindDocEntryVR()
1807 {
1808    if ( Filetype != ExplicitVR )
1809       return(GDCM_UNKNOWN);
1810
1811    long positionOnEntry = Fp->tellg();
1812    // Warning: we believe this is explicit VR (Value Representation) because
1813    // we used a heuristic that found "UL" in the first tag. Alas this
1814    // doesn't guarantee that all the tags will be in explicit VR. In some
1815    // cases (see e-film filtered files) one finds implicit VR tags mixed
1816    // within an explicit VR file. Hence we make sure the present tag
1817    // is in explicit VR and try to fix things if it happens not to be
1818    // the case.
1819
1820    char vr[3];
1821    Fp->read (vr, (size_t)2);
1822    vr[2] = 0;
1823
1824    if( !CheckDocEntryVR(vr) )
1825    {
1826       Fp->seekg(positionOnEntry, std::ios::beg);
1827       return(GDCM_UNKNOWN);
1828    }
1829    return(vr);
1830 }
1831
1832 /**
1833  * \brief     Check the correspondance between the VR of the header entry
1834  *            and the taken VR. If they are different, the header entry is 
1835  *            updated with the new VR.
1836  * @param     entry Header Entry to check
1837  * @param     vr    Dicom Value Representation
1838  * @return    false if the VR is incorrect of if the VR isn't referenced
1839  *            otherwise, it returns true
1840 */
1841 bool Document::CheckDocEntryVR(VRKey vr)
1842 {
1843    // CLEANME searching the dicom_vr at each occurence is expensive.
1844    // PostPone this test in an optional integrity check at the end
1845    // of parsing or only in debug mode.
1846    if ( !Global::GetVR()->IsValidVR(vr) )
1847       return false;
1848
1849    return true; 
1850 }
1851
1852 /**
1853  * \brief   Get the transformed value of the header entry. The VR value 
1854  *          is used to define the transformation to operate on the value
1855  * \warning NOT end user intended method !
1856  * @param   entry entry to tranform
1857  * @return  Transformed entry value
1858  */
1859 std::string Document::GetDocEntryValue(DocEntry *entry)
1860 {
1861    if ( IsDocEntryAnInteger(entry) && entry->IsImplicitVR() )
1862    {
1863       std::string val = ((ValEntry *)entry)->GetValue();
1864       std::string vr  = entry->GetVR();
1865       uint32_t length = entry->GetLength();
1866       std::ostringstream s;
1867       int nbInt;
1868
1869       // When short integer(s) are expected, read and convert the following 
1870       // n * 2 bytes properly i.e. as a multivaluated strings
1871       // (each single value is separated fromthe next one by '\'
1872       // as usual for standard multivaluated filels
1873       // Elements with Value Multiplicity > 1
1874       // contain a set of short integers (not a single one) 
1875    
1876       if( vr == "US" || vr == "SS" )
1877       {
1878          uint16_t newInt16;
1879
1880          nbInt = length / 2;
1881          for (int i=0; i < nbInt; i++) 
1882          {
1883             if( i != 0 )
1884             {
1885                s << '\\';
1886             }
1887             newInt16 = ( val[2*i+0] & 0xFF ) + ( ( val[2*i+1] & 0xFF ) << 8);
1888             newInt16 = SwapShort( newInt16 );
1889             s << newInt16;
1890          }
1891       }
1892
1893       // When integer(s) are expected, read and convert the following 
1894       // n * 4 bytes properly i.e. as a multivaluated strings
1895       // (each single value is separated fromthe next one by '\'
1896       // as usual for standard multivaluated filels
1897       // Elements with Value Multiplicity > 1
1898       // contain a set of integers (not a single one) 
1899       else if( vr == "UL" || vr == "SL" )
1900       {
1901          uint32_t newInt32;
1902
1903          nbInt = length / 4;
1904          for (int i=0; i < nbInt; i++) 
1905          {
1906             if( i != 0)
1907             {
1908                s << '\\';
1909             }
1910             newInt32 = ( val[4*i+0] & 0xFF )
1911                     + (( val[4*i+1] & 0xFF ) <<  8 )
1912                     + (( val[4*i+2] & 0xFF ) << 16 )
1913                     + (( val[4*i+3] & 0xFF ) << 24 );
1914             newInt32 = SwapLong( newInt32 );
1915             s << newInt32;
1916          }
1917       }
1918 #ifdef GDCM_NO_ANSI_STRING_STREAM
1919       s << std::ends; // to avoid oddities on Solaris
1920 #endif //GDCM_NO_ANSI_STRING_STREAM
1921       return s.str();
1922    }
1923
1924    return ((ValEntry *)entry)->GetValue();
1925 }
1926
1927 /**
1928  * \brief   Get the reverse transformed value of the header entry. The VR 
1929  *          value is used to define the reverse transformation to operate on
1930  *          the value
1931  * \warning NOT end user intended method !
1932  * @param   entry Entry to reverse transform
1933  * @return  Reverse transformed entry value
1934  */
1935 std::string Document::GetDocEntryUnvalue(DocEntry* entry)
1936 {
1937    if ( IsDocEntryAnInteger(entry) && entry->IsImplicitVR() )
1938    {
1939       std::string vr = entry->GetVR();
1940       std::vector<std::string> tokens;
1941       std::ostringstream s;
1942
1943       if ( vr == "US" || vr == "SS" ) 
1944       {
1945          uint16_t newInt16;
1946
1947          tokens.erase( tokens.begin(), tokens.end()); // clean any previous value
1948          Util::Tokenize (((ValEntry *)entry)->GetValue(), tokens, "\\");
1949          for (unsigned int i=0; i<tokens.size(); i++) 
1950          {
1951             newInt16 = atoi(tokens[i].c_str());
1952             s << (  newInt16        & 0xFF ) 
1953               << (( newInt16 >> 8 ) & 0xFF );
1954          }
1955          tokens.clear();
1956       }
1957       if ( vr == "UL" || vr == "SL")
1958       {
1959          uint32_t newInt32;
1960
1961          tokens.erase(tokens.begin(),tokens.end()); // clean any previous value
1962          Util::Tokenize (((ValEntry *)entry)->GetValue(), tokens, "\\");
1963          for (unsigned int i=0; i<tokens.size();i++) 
1964          {
1965             newInt32 = atoi(tokens[i].c_str());
1966             s << (char)(  newInt32         & 0xFF ) 
1967               << (char)(( newInt32 >>  8 ) & 0xFF )
1968               << (char)(( newInt32 >> 16 ) & 0xFF )
1969               << (char)(( newInt32 >> 24 ) & 0xFF );
1970          }
1971          tokens.clear();
1972       }
1973
1974 #ifdef GDCM_NO_ANSI_STRING_STREAM
1975       s << std::ends; // to avoid oddities on Solaris
1976 #endif //GDCM_NO_ANSI_STRING_STREAM
1977       return s.str();
1978    }
1979
1980    return ((ValEntry *)entry)->GetValue();
1981 }
1982
1983 /**
1984  * \brief   Skip a given Header Entry 
1985  * \warning NOT end user intended method !
1986  * @param   entry entry to skip
1987  */
1988 void Document::SkipDocEntry(DocEntry *entry) 
1989 {
1990    SkipBytes(entry->GetLength());
1991 }
1992
1993 /**
1994  * \brief   Skips to the begining of the next Header Entry 
1995  * \warning NOT end user intended method !
1996  * @param   entry entry to skip
1997  */
1998 void Document::SkipToNextDocEntry(DocEntry *entry) 
1999 {
2000    Fp->seekg((long)(entry->GetOffset()),     std::ios::beg);
2001    Fp->seekg( (long)(entry->GetReadLength()), std::ios::cur);
2002 }
2003
2004 /**
2005  * \brief   When the length of an element value is obviously wrong (because
2006  *          the parser went Jabberwocky) one can hope improving things by
2007  *          applying some heuristics.
2008  * @param   entry entry to check
2009  * @param   foundLength fist assumption about length    
2010  */
2011 void Document::FixDocEntryFoundLength(DocEntry *entry,
2012                                       uint32_t foundLength)
2013 {
2014    entry->SetReadLength( foundLength ); // will be updated only if a bug is found        
2015    if ( foundLength == 0xffffffff)
2016    {
2017       foundLength = 0;
2018    }
2019    
2020    uint16_t gr = entry->GetGroup();
2021    uint16_t el = entry->GetElement(); 
2022      
2023    if ( foundLength % 2)
2024    {
2025       std::ostringstream s;
2026       s << "Warning : Tag with uneven length "
2027         << foundLength 
2028         <<  " in x(" << std::hex << gr << "," << el <<")" << std::dec;
2029       dbg.Verbose(0, s.str().c_str());
2030    }
2031       
2032    //////// Fix for some naughty General Electric images.
2033    // Allthough not recent many such GE corrupted images are still present
2034    // on Creatis hard disks. Hence this fix shall remain when such images
2035    // are no longer in user (we are talking a few years, here)...
2036    // Note: XMedCom probably uses such a trick since it is able to read
2037    //       those pesky GE images ...
2038    if ( foundLength == 13)
2039    {
2040       // Only happens for this length !
2041       if ( entry->GetGroup()   != 0x0008
2042       || ( entry->GetElement() != 0x0070
2043         && entry->GetElement() != 0x0080 ) )
2044       {
2045          foundLength = 10;
2046          entry->SetReadLength(10); /// \todo a bug is to be fixed !?
2047       }
2048    }
2049
2050    //////// Fix for some brain-dead 'Leonardo' Siemens images.
2051    // Occurence of such images is quite low (unless one leaves close to a
2052    // 'Leonardo' source. Hence, one might consider commenting out the
2053    // following fix on efficiency reasons.
2054    else if ( entry->GetGroup()   == 0x0009 
2055         && ( entry->GetElement() == 0x1113
2056           || entry->GetElement() == 0x1114 ) )
2057    {
2058       foundLength = 4;
2059       entry->SetReadLength(4); /// \todo a bug is to be fixed !?
2060    } 
2061  
2062    else if ( entry->GetVR() == "SQ" )
2063    {
2064       foundLength = 0;      // ReadLength is unchanged 
2065    } 
2066     
2067    //////// We encountered a 'delimiter' element i.e. a tag of the form 
2068    // "fffe|xxxx" which is just a marker. Delimiters length should not be
2069    // taken into account.
2070    else if( entry->GetGroup() == 0xfffe )
2071    {    
2072      // According to the norm, fffe|0000 shouldn't exist. BUT the Philips
2073      // image gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm happens to
2074      // causes extra troubles...
2075      if( entry->GetElement() != 0x0000 )
2076      {
2077         foundLength = 0;
2078      }
2079    } 
2080            
2081    entry->SetUsableLength(foundLength);
2082 }
2083
2084 /**
2085  * \brief   Apply some heuristics to predict whether the considered 
2086  *          element value contains/represents an integer or not.
2087  * @param   entry The element value on which to apply the predicate.
2088  * @return  The result of the heuristical predicate.
2089  */
2090 bool Document::IsDocEntryAnInteger(DocEntry *entry)
2091 {
2092    uint16_t element = entry->GetElement();
2093    uint16_t group   = entry->GetGroup();
2094    const std::string & vr  = entry->GetVR();
2095    uint32_t length  = entry->GetLength();
2096
2097    // When we have some semantics on the element we just read, and if we
2098    // a priori know we are dealing with an integer, then we shall be
2099    // able to swap it's element value properly.
2100    if ( element == 0 )  // This is the group length of the group
2101    {  
2102       if ( length == 4 )
2103       {
2104          return true;
2105       }
2106       else 
2107       {
2108          // Allthough this should never happen, still some images have a
2109          // corrupted group length [e.g. have a glance at offset x(8336) of
2110          // gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm].
2111          // Since for dicom compliant and well behaved headers, the present
2112          // test is useless (and might even look a bit paranoid), when we
2113          // encounter such an ill-formed image, we simply display a warning
2114          // message and proceed on parsing (while crossing fingers).
2115          std::ostringstream s;
2116          long filePosition = Fp->tellg();
2117          s << "Erroneous Group Length element length  on : (" \
2118            << std::hex << group << " , " << element 
2119            << ") -before- position x(" << filePosition << ")"
2120            << "lgt : " << length;
2121          dbg.Verbose(0, "Document::IsDocEntryAnInteger", s.str().c_str() );
2122       }
2123    }
2124
2125    if ( vr == "UL" || vr == "US" || vr == "SL" || vr == "SS" )
2126    {
2127       return true;
2128    }   
2129    return false;
2130 }
2131
2132 /**
2133  * \brief  Find the Length till the next sequence delimiter
2134  * \warning NOT end user intended method !
2135  * @return 
2136  */
2137
2138 uint32_t Document::FindDocEntryLengthOB()
2139    throw( FormatUnexpected )
2140 {
2141    // See PS 3.5-2001, section A.4 p. 49 on encapsulation of encoded pixel data.
2142    long positionOnEntry = Fp->tellg();
2143    bool foundSequenceDelimiter = false;
2144    uint32_t totalLength = 0;
2145
2146    while ( !foundSequenceDelimiter )
2147    {
2148       uint16_t group;
2149       uint16_t elem;
2150       try
2151       {
2152          group = ReadInt16();
2153          elem  = ReadInt16();   
2154       }
2155       catch ( FormatError )
2156       {
2157          throw FormatError("Document::FindDocEntryLengthOB()",
2158                            " group or element not present.");
2159       }
2160
2161       // We have to decount the group and element we just read
2162       totalLength += 4;
2163      
2164       if ( group != 0xfffe || ( ( elem != 0xe0dd ) && ( elem != 0xe000 ) ) )
2165       {
2166          dbg.Verbose(1, "Document::FindDocEntryLengthOB: neither an Item "
2167                         "tag nor a Sequence delimiter tag."); 
2168          Fp->seekg(positionOnEntry, std::ios::beg);
2169          throw FormatUnexpected("Document::FindDocEntryLengthOB()",
2170                                 "Neither an Item tag nor a Sequence "
2171                                 "delimiter tag.");
2172       }
2173
2174       if ( elem == 0xe0dd )
2175       {
2176          foundSequenceDelimiter = true;
2177       }
2178
2179       uint32_t itemLength = ReadInt32();
2180       // We add 4 bytes since we just read the ItemLength with ReadInt32
2181       totalLength += itemLength + 4;
2182       SkipBytes(itemLength);
2183       
2184       if ( foundSequenceDelimiter )
2185       {
2186          break;
2187       }
2188    }
2189    Fp->seekg( positionOnEntry, std::ios::beg);
2190    return totalLength;
2191 }
2192
2193 /**
2194  * \brief Reads a supposed to be 16 Bits integer
2195  *       (swaps it depending on processor endianity) 
2196  * @return read value
2197  */
2198 uint16_t Document::ReadInt16()
2199    throw( FormatError )
2200 {
2201    uint16_t g;
2202    Fp->read ((char*)&g, (size_t)2);
2203    if ( Fp->fail() )
2204    {
2205       throw FormatError( "Document::ReadInt16()", " file error." );
2206    }
2207    if( Fp->eof() )
2208    {
2209       throw FormatError( "Document::ReadInt16()", "EOF." );
2210    }
2211    g = SwapShort(g); 
2212    return g;
2213 }
2214
2215 /**
2216  * \brief  Reads a supposed to be 32 Bits integer
2217  *         (swaps it depending on processor endianity)  
2218  * @return read value
2219  */
2220 uint32_t Document::ReadInt32()
2221    throw( FormatError )
2222 {
2223    uint32_t g;
2224    Fp->read ((char*)&g, (size_t)4);
2225    if ( Fp->fail() )
2226    {
2227       throw FormatError( "Document::ReadInt32()", " file error." );
2228    }
2229    if( Fp->eof() )
2230    {
2231       throw FormatError( "Document::ReadInt32()", "EOF." );
2232    }
2233    g = SwapLong(g);
2234    return g;
2235 }
2236
2237 /**
2238  * \brief skips bytes inside the source file 
2239  * \warning NOT end user intended method !
2240  * @return 
2241  */
2242 void Document::SkipBytes(uint32_t nBytes)
2243 {
2244    //FIXME don't dump the returned value
2245    Fp->seekg((long)nBytes, std::ios::cur);
2246 }
2247
2248 /**
2249  * \brief Loads all the needed Dictionaries
2250  * \warning NOT end user intended method !   
2251  */
2252 void Document::Initialise() 
2253 {
2254    RefPubDict = Global::GetDicts()->GetDefaultPubDict();
2255    RefShaDict = NULL;
2256    RLEInfo  = new RLEFramesInfo;
2257    JPEGInfo = new JPEGFragmentsInfo;
2258    Filetype = Unknown;
2259 }
2260
2261 /**
2262  * \brief   Discover what the swap code is (among little endian, big endian,
2263  *          bad little endian, bad big endian).
2264  *          sw is set
2265  * @return false when we are absolutely sure 
2266  *               it's neither ACR-NEMA nor DICOM
2267  *         true  when we hope ours assuptions are OK
2268  */
2269 bool Document::CheckSwap()
2270 {
2271    // The only guaranted way of finding the swap code is to find a
2272    // group tag since we know it's length has to be of four bytes i.e.
2273    // 0x00000004. Finding the swap code in then straigthforward. Trouble
2274    // occurs when we can't find such group...
2275    
2276    uint32_t  x = 4;  // x : for ntohs
2277    bool net2host; // true when HostByteOrder is the same as NetworkByteOrder
2278    uint32_t  s32;
2279    uint16_t  s16;
2280        
2281    char deb[256];
2282     
2283    // First, compare HostByteOrder and NetworkByteOrder in order to
2284    // determine if we shall need to swap bytes (i.e. the Endian type).
2285    if ( x == ntohs(x) )
2286    {
2287       net2host = true;
2288    }
2289    else
2290    {
2291       net2host = false;
2292    }
2293          
2294    // The easiest case is the one of a DICOM header, since it possesses a
2295    // file preamble where it suffice to look for the string "DICM".
2296    Fp->read(deb, 256);
2297    
2298    char *entCur = deb + 128;
2299    if( memcmp(entCur, "DICM", (size_t)4) == 0 )
2300    {
2301       dbg.Verbose(1, "Document::CheckSwap:", "looks like DICOM Version3");
2302       
2303       // Next, determine the value representation (VR). Let's skip to the
2304       // first element (0002, 0000) and check there if we find "UL" 
2305       // - or "OB" if the 1st one is (0002,0001) -,
2306       // in which case we (almost) know it is explicit VR.
2307       // WARNING: if it happens to be implicit VR then what we will read
2308       // is the length of the group. If this ascii representation of this
2309       // length happens to be "UL" then we shall believe it is explicit VR.
2310       // FIXME: in order to fix the above warning, we could read the next
2311       // element value (or a couple of elements values) in order to make
2312       // sure we are not commiting a big mistake.
2313       // We need to skip :
2314       // * the 128 bytes of File Preamble (often padded with zeroes),
2315       // * the 4 bytes of "DICM" string,
2316       // * the 4 bytes of the first tag (0002, 0000),or (0002, 0001)
2317       // i.e. a total of  136 bytes.
2318       entCur = deb + 136;
2319      
2320       // FIXME : FIXME:
2321       // Sometimes (see : gdcmData/icone.dcm) group 0x0002 *is* Explicit VR,
2322       // but elem 0002,0010 (Transfert Syntax) tells us the file is
2323       // *Implicit* VR.  -and it is !- 
2324       
2325       if( memcmp(entCur, "UL", (size_t)2) == 0 ||
2326           memcmp(entCur, "OB", (size_t)2) == 0 ||
2327           memcmp(entCur, "UI", (size_t)2) == 0 ||
2328           memcmp(entCur, "CS", (size_t)2) == 0 )  // CS, to remove later
2329                                                     // when Write DCM *adds*
2330       // FIXME
2331       // Use Document::dicom_vr to test all the possibilities
2332       // instead of just checking for UL, OB and UI !? group 0000 
2333       {
2334          Filetype = ExplicitVR;
2335          dbg.Verbose(1, "Document::CheckSwap:",
2336                      "explicit Value Representation");
2337       } 
2338       else 
2339       {
2340          Filetype = ImplicitVR;
2341          dbg.Verbose(1, "Document::CheckSwap:",
2342                      "not an explicit Value Representation");
2343       }
2344       
2345       if ( net2host )
2346       {
2347          SwapCode = 4321;
2348          dbg.Verbose(1, "Document::CheckSwap:",
2349                         "HostByteOrder != NetworkByteOrder");
2350       }
2351       else 
2352       {
2353          SwapCode = 0;
2354          dbg.Verbose(1, "Document::CheckSwap:",
2355                         "HostByteOrder = NetworkByteOrder");
2356       }
2357       
2358       // Position the file position indicator at first tag (i.e.
2359       // after the file preamble and the "DICM" string).
2360       Fp->seekg(0, std::ios::beg);
2361       Fp->seekg ( 132L, std::ios::beg);
2362       return true;
2363    } // End of DicomV3
2364
2365    // Alas, this is not a DicomV3 file and whatever happens there is no file
2366    // preamble. We can reset the file position indicator to where the data
2367    // is (i.e. the beginning of the file).
2368    dbg.Verbose(1, "Document::CheckSwap:", "not a DICOM Version3 file");
2369    Fp->seekg(0, std::ios::beg);
2370
2371    // Our next best chance would be to be considering a 'clean' ACR/NEMA file.
2372    // By clean we mean that the length of the first tag is written down.
2373    // If this is the case and since the length of the first group HAS to be
2374    // four (bytes), then determining the proper swap code is straightforward.
2375
2376    entCur = deb + 4;
2377    // We assume the array of char we are considering contains the binary
2378    // representation of a 32 bits integer. Hence the following dirty
2379    // trick :
2380    s32 = *((uint32_t *)(entCur));
2381
2382    switch( s32 )
2383    {
2384       case 0x00040000 :
2385          SwapCode = 3412;
2386          Filetype = ACR;
2387          return true;
2388       case 0x04000000 :
2389          SwapCode = 4321;
2390          Filetype = ACR;
2391          return true;
2392       case 0x00000400 :
2393          SwapCode = 2143;
2394          Filetype = ACR;
2395          return true;
2396       case 0x00000004 :
2397          SwapCode = 0;
2398          Filetype = ACR;
2399          return true;
2400       default :
2401          // We are out of luck. It is not a DicomV3 nor a 'clean' ACR/NEMA file.
2402          // It is time for despaired wild guesses. 
2403          // So, let's check if this file wouldn't happen to be 'dirty' ACR/NEMA,
2404          //  i.e. the 'group length' element is not present :     
2405          
2406          //  check the supposed-to-be 'group number'
2407          //  in ( 0x0001 .. 0x0008 )
2408          //  to determine ' SwapCode' value .
2409          //  Only 0 or 4321 will be possible 
2410          //  (no oportunity to check for the formerly well known
2411          //  ACR-NEMA 'Bad Big Endian' or 'Bad Little Endian' 
2412          //  if unsuccessfull (i.e. neither 0x0002 nor 0x0200 etc -3, 4, ..., 8-) 
2413          //  the file IS NOT ACR-NEMA nor DICOM V3
2414          //  Find a trick to tell it the caller...
2415       
2416          s16 = *((uint16_t *)(deb));
2417       
2418          switch ( s16 )
2419          {
2420             case 0x0001 :
2421             case 0x0002 :
2422             case 0x0003 :
2423             case 0x0004 :
2424             case 0x0005 :
2425             case 0x0006 :
2426             case 0x0007 :
2427             case 0x0008 :
2428                SwapCode = 0;
2429                Filetype = ACR;
2430                return true;
2431             case 0x0100 :
2432             case 0x0200 :
2433             case 0x0300 :
2434             case 0x0400 :
2435             case 0x0500 :
2436             case 0x0600 :
2437             case 0x0700 :
2438             case 0x0800 :
2439                SwapCode = 4321;
2440                Filetype = ACR;
2441                return true;
2442             default :
2443                dbg.Verbose(0, "Document::CheckSwap:",
2444                      "ACR/NEMA unfound swap info (Really hopeless !)");
2445                Filetype = Unknown;
2446                return false;
2447          }
2448          // Then the only info we have is the net2host one.
2449          //if (! net2host )
2450          //   SwapCode = 0;
2451          //else
2452          //  SwapCode = 4321;
2453          //return;
2454    }
2455 }
2456
2457
2458
2459 /**
2460  * \brief Restore the unproperly loaded values i.e. the group, the element
2461  *        and the dictionary entry depending on them. 
2462  */
2463 void Document::SwitchSwapToBigEndian() 
2464 {
2465    dbg.Verbose(1, "Document::SwitchSwapToBigEndian",
2466                   "Switching to BigEndian mode.");
2467    if ( SwapCode == 0    ) 
2468    {
2469       SwapCode = 4321;
2470    }
2471    else if ( SwapCode == 4321 ) 
2472    {
2473       SwapCode = 0;
2474    }
2475    else if ( SwapCode == 3412 ) 
2476    {
2477       SwapCode = 2143;
2478    }
2479    else if ( SwapCode == 2143 )
2480    {
2481       SwapCode = 3412;
2482    }
2483 }
2484
2485 /**
2486  * \brief  during parsing, Header Elements too long are not loaded in memory 
2487  * @param newSize
2488  */
2489 void Document::SetMaxSizeLoadEntry(long newSize) 
2490 {
2491    if ( newSize < 0 )
2492    {
2493       return;
2494    }
2495    if ((uint32_t)newSize >= (uint32_t)0xffffffff )
2496    {
2497       MaxSizeLoadEntry = 0xffffffff;
2498       return;
2499    }
2500    MaxSizeLoadEntry = newSize;
2501 }
2502
2503
2504 /**
2505  * \brief Header Elements too long will not be printed
2506  * \todo  See comments of \ref Document::MAX_SIZE_PRINT_ELEMENT_VALUE 
2507  * @param newSize
2508  */
2509 void Document::SetMaxSizePrintEntry(long newSize) 
2510 {
2511    //DOH !! This is exactly SetMaxSizeLoadEntry FIXME FIXME
2512    if ( newSize < 0 )
2513    {
2514       return;
2515    }
2516    if ((uint32_t)newSize >= (uint32_t)0xffffffff )
2517    {
2518       MaxSizePrintEntry = 0xffffffff;
2519       return;
2520    }
2521    MaxSizePrintEntry = newSize;
2522 }
2523
2524
2525
2526 /**
2527  * \brief   Handle broken private tag from Philips NTSCAN
2528  *          where the endianess is being switch to BigEndian for no
2529  *          apparent reason
2530  * @return  no return
2531  */
2532 void Document::HandleBrokenEndian(uint16_t group, uint16_t elem)
2533 {
2534    // Endian reversion. Some files contain groups of tags with reversed endianess.
2535    static int reversedEndian = 0;
2536    // try to fix endian switching in the middle of headers
2537    if ((group == 0xfeff) && (elem == 0x00e0))
2538    {
2539      // start endian swap mark for group found
2540      reversedEndian++;
2541      SwitchSwapToBigEndian();
2542      // fix the tag
2543      group = 0xfffe;
2544      elem = 0xe000;
2545    } 
2546    else if ((group == 0xfffe) && (elem == 0xe00d) && reversedEndian) 
2547    {
2548      // end of reversed endian group
2549      reversedEndian--;
2550      SwitchSwapToBigEndian();
2551    }
2552 }
2553
2554 /**
2555  * \brief   Read the next tag but WITHOUT loading it's value
2556  *          (read the 'Group Number', the 'Element Number',
2557  *           gets the Dict Entry
2558  *          gets the VR, gets the length, gets the offset value)
2559  * @return  On succes the newly created DocEntry, NULL on failure.      
2560  */
2561 DocEntry* Document::ReadNextDocEntry()
2562 {
2563    uint16_t group;
2564    uint16_t elem;
2565
2566    try
2567    {
2568       group = ReadInt16();
2569       elem  = ReadInt16();
2570    }
2571    catch ( FormatError e )
2572    {
2573       // We reached the EOF (or an error occured) therefore 
2574       // header parsing has to be considered as finished.
2575       //std::cout << e;
2576       return 0;
2577    }
2578
2579    HandleBrokenEndian(group, elem);
2580    std::string vr=FindDocEntryVR();
2581
2582    DocEntry *newEntry = NewDocEntryByNumber(group, elem, vr);
2583    if( vr == GDCM_UNKNOWN )
2584    {
2585       if( Filetype == ExplicitVR )
2586       {
2587          // We thought this was explicit VR, but we end up with an
2588          // implicit VR tag. Let's backtrack.   
2589          std::string msg;
2590          msg = Util::Format("Falsely explicit vr file (%04x,%04x)\n", 
2591                        newEntry->GetGroup(), newEntry->GetElement());
2592          dbg.Verbose(1, "Document::FindVR: ", msg.c_str());
2593       }
2594       newEntry->SetImplicitVR();
2595    }
2596
2597    try
2598    {
2599       FindDocEntryLength(newEntry);
2600    }
2601    catch ( FormatError e )
2602    {
2603       // Call it quits
2604       //std::cout << e;
2605       delete newEntry;
2606       return 0;
2607    }
2608
2609    newEntry->SetOffset(Fp->tellg());  
2610
2611    return newEntry;
2612 }
2613
2614
2615 /**
2616  * \brief   Generate a free TagKey i.e. a TagKey that is not present
2617  *          in the TagHt dictionary.
2618  * @param   group The generated tag must belong to this group.  
2619  * @return  The element of tag with given group which is fee.
2620  */
2621 uint32_t Document::GenerateFreeTagKeyInGroup(uint16_t group) 
2622 {
2623    for (uint32_t elem = 0; elem < UINT32_MAX; elem++) 
2624    {
2625       TagKey key = DictEntry::TranslateToKey(group, elem);
2626       if (TagHT.count(key) == 0)
2627       {
2628          return elem;
2629       }
2630    }
2631    return UINT32_MAX;
2632 }
2633
2634 /**
2635  * \brief   Assuming the internal file pointer \ref Document::Fp 
2636  *          is placed at the beginning of a tag check whether this
2637  *          tag is (TestGroup, TestElement).
2638  * \warning On success the internal file pointer \ref Document::Fp
2639  *          is modified to point after the tag.
2640  *          On failure (i.e. when the tag wasn't the expected tag
2641  *          (TestGroup, TestElement) the internal file pointer
2642  *          \ref Document::Fp is restored to it's original position.
2643  * @param   testGroup   The expected group of the tag.
2644  * @param   testElement The expected Element of the tag.
2645  * @return  True on success, false otherwise.
2646  */
2647 bool Document::ReadTag(uint16_t testGroup, uint16_t testElement)
2648 {
2649    long positionOnEntry = Fp->tellg();
2650    long currentPosition = Fp->tellg();          // On debugging purposes
2651
2652    //// Read the Item Tag group and element, and make
2653    // sure they are what we expected:
2654    uint16_t itemTagGroup;
2655    uint16_t itemTagElement;
2656    try
2657    {
2658       itemTagGroup   = ReadInt16();
2659       itemTagElement = ReadInt16();
2660    }
2661    catch ( FormatError e )
2662    {
2663       //std::cerr << e << std::endl;
2664       return false;
2665    }
2666    if ( itemTagGroup != testGroup || itemTagElement != testElement )
2667    {
2668       std::ostringstream s;
2669       s << "   We should have found tag (";
2670       s << std::hex << testGroup << "," << testElement << ")" << std::endl;
2671       s << "   but instead we encountered tag (";
2672       s << std::hex << itemTagGroup << "," << itemTagElement << ")"
2673         << std::endl;
2674       s << "  at address: " << (unsigned)currentPosition << std::endl;
2675       dbg.Verbose(0, "Document::ReadItemTagLength: wrong Item Tag found:");
2676       dbg.Verbose(0, s.str().c_str());
2677       Fp->seekg(positionOnEntry, std::ios::beg);
2678
2679       return false;
2680    }
2681    return true;
2682 }
2683
2684 /**
2685  * \brief   Assuming the internal file pointer \ref Document::Fp 
2686  *          is placed at the beginning of a tag (TestGroup, TestElement),
2687  *          read the length associated to the Tag.
2688  * \warning On success the internal file pointer \ref Document::Fp
2689  *          is modified to point after the tag and it's length.
2690  *          On failure (i.e. when the tag wasn't the expected tag
2691  *          (TestGroup, TestElement) the internal file pointer
2692  *          \ref Document::Fp is restored to it's original position.
2693  * @param   testGroup   The expected group of the tag.
2694  * @param   testElement The expected Element of the tag.
2695  * @return  On success returns the length associated to the tag. On failure
2696  *          returns 0.
2697  */
2698 uint32_t Document::ReadTagLength(uint16_t testGroup, uint16_t testElement)
2699 {
2700    long positionOnEntry = Fp->tellg();
2701    (void)positionOnEntry;
2702
2703    if ( !ReadTag(testGroup, testElement) )
2704    {
2705       return 0;
2706    }
2707                                                                                 
2708    //// Then read the associated Item Length
2709    long currentPosition = Fp->tellg();
2710    uint32_t itemLength  = ReadInt32();
2711    {
2712       std::ostringstream s;
2713       s << "Basic Item Length is: "
2714         << itemLength << std::endl;
2715       s << "  at address: " << (unsigned)currentPosition << std::endl;
2716       dbg.Verbose(0, "Document::ReadItemTagLength: ", s.str().c_str());
2717    }
2718    return itemLength;
2719 }
2720
2721 /**
2722  * \brief When parsing the Pixel Data of an encapsulated file, read
2723  *        the basic offset table (when present, and BTW dump it).
2724  */
2725 void Document::ReadAndSkipEncapsulatedBasicOffsetTable()
2726 {
2727    //// Read the Basic Offset Table Item Tag length...
2728    uint32_t itemLength = ReadTagLength(0xfffe, 0xe000);
2729
2730    // When present, read the basic offset table itself.
2731    // Notes: - since the presence of this basic offset table is optional
2732    //          we can't rely on it for the implementation, and we will simply
2733    //          trash it's content (when present).
2734    //        - still, when present, we could add some further checks on the
2735    //          lengths, but we won't bother with such fuses for the time being.
2736    if ( itemLength != 0 )
2737    {
2738       char* basicOffsetTableItemValue = new char[itemLength + 1];
2739       Fp->read(basicOffsetTableItemValue, itemLength);
2740
2741 #ifdef GDCM_DEBUG
2742       for (unsigned int i=0; i < itemLength; i += 4 )
2743       {
2744          uint32_t individualLength = str2num( &basicOffsetTableItemValue[i],
2745                                               uint32_t);
2746          std::ostringstream s;
2747          s << "   Read one length: ";
2748          s << std::hex << individualLength << std::endl;
2749          dbg.Verbose(0,
2750                      "Document::ReadAndSkipEncapsulatedBasicOffsetTable: ",
2751                      s.str().c_str());
2752       }
2753 #endif //GDCM_DEBUG
2754
2755       delete[] basicOffsetTableItemValue;
2756    }
2757 }
2758
2759 /**
2760  * \brief Parse pixel data from disk of [multi-]fragment RLE encoding.
2761  *        Compute the RLE extra information and store it in \ref RLEInfo
2762  *        for later pixel retrieval usage.
2763  */
2764 void Document::ComputeRLEInfo()
2765 {
2766    TransferSyntaxType ts = GetTransferSyntax();
2767    if ( ts != RLELossless )
2768    {
2769       return;
2770    }
2771
2772    // Encoded pixel data: for the time being we are only concerned with
2773    // Jpeg or RLE Pixel data encodings.
2774    // As stated in PS 3.5-2003, section 8.2 p44:
2775    // "If sent in Encapsulated Format (i.e. other than the Native Format) the
2776    //  value representation OB is used".
2777    // Hence we expect an OB value representation. Concerning OB VR,
2778    // the section PS 3.5-2003, section A.4.c p 58-59, states:
2779    // "For the Value Representations OB and OW, the encoding shall meet the
2780    //   following specifications depending on the Data element tag:"
2781    //   [...snip...]
2782    //    - the first item in the sequence of items before the encoded pixel
2783    //      data stream shall be basic offset table item. The basic offset table
2784    //      item value, however, is not required to be present"
2785
2786    ReadAndSkipEncapsulatedBasicOffsetTable();
2787
2788    // Encapsulated RLE Compressed Images (see PS 3.5-2003, Annex G)
2789    // Loop on the individual frame[s] and store the information
2790    // on the RLE fragments in a RLEFramesInfo.
2791    // Note: - when only a single frame is present, this is a
2792    //         classical image.
2793    //       - when more than one frame are present, then we are in 
2794    //         the case of a multi-frame image.
2795    long frameLength;
2796    while ( (frameLength = ReadTagLength(0xfffe, 0xe000)) )
2797    { 
2798       // Parse the RLE Header and store the corresponding RLE Segment
2799       // Offset Table information on fragments of this current Frame.
2800       // Note that the fragment pixels themselves are not loaded
2801       // (but just skipped).
2802       long frameOffset = Fp->tellg();
2803
2804       uint32_t nbRleSegments = ReadInt32();
2805       if ( nbRleSegments > 16 )
2806       {
2807          // There should be at most 15 segments (refer to RLEFrame class)
2808          dbg.Verbose(0, "Document::ComputeRLEInfo: too many segments.");
2809       }
2810  
2811       uint32_t rleSegmentOffsetTable[16];
2812       for( int k = 1; k <= 15; k++ )
2813       {
2814          rleSegmentOffsetTable[k] = ReadInt32();
2815       }
2816
2817       // Deduce from both the RLE Header and the frameLength the
2818       // fragment length, and again store this info in a
2819       // RLEFramesInfo.
2820       long rleSegmentLength[15];
2821       // skipping (not reading) RLE Segments
2822       if ( nbRleSegments > 1)
2823       {
2824          for(unsigned int k = 1; k <= nbRleSegments-1; k++)
2825          {
2826              rleSegmentLength[k] =  rleSegmentOffsetTable[k+1]
2827                                   - rleSegmentOffsetTable[k];
2828              SkipBytes(rleSegmentLength[k]);
2829           }
2830        }
2831
2832        rleSegmentLength[nbRleSegments] = frameLength 
2833                                       - rleSegmentOffsetTable[nbRleSegments];
2834        SkipBytes(rleSegmentLength[nbRleSegments]);
2835
2836        // Store the collected info
2837        RLEFrame* newFrameInfo = new RLEFrame;
2838        newFrameInfo->NumberFragments = nbRleSegments;
2839        for( unsigned int uk = 1; uk <= nbRleSegments; uk++ )
2840        {
2841           newFrameInfo->Offset[uk] = frameOffset + rleSegmentOffsetTable[uk];
2842           newFrameInfo->Length[uk] = rleSegmentLength[uk];
2843        }
2844        RLEInfo->Frames.push_back( newFrameInfo );
2845    }
2846
2847    // Make sure that at the end of the item we encounter a 'Sequence
2848    // Delimiter Item':
2849    if ( !ReadTag(0xfffe, 0xe0dd) )
2850    {
2851       dbg.Verbose(0, "Document::ComputeRLEInfo: no sequence delimiter ");
2852       dbg.Verbose(0, "    item at end of RLE item sequence");
2853    }
2854 }
2855
2856 /**
2857  * \brief Parse pixel data from disk of [multi-]fragment Jpeg encoding.
2858  *        Compute the jpeg extra information (fragment[s] offset[s] and
2859  *        length) and store it[them] in \ref JPEGInfo for later pixel
2860  *        retrieval usage.
2861  */
2862 void Document::ComputeJPEGFragmentInfo()
2863 {
2864    // If you need to, look for comments of ComputeRLEInfo().
2865    if ( ! IsJPEG() )
2866    {
2867       return;
2868    }
2869
2870    ReadAndSkipEncapsulatedBasicOffsetTable();
2871
2872    // Loop on the fragments[s] and store the parsed information in a
2873    // JPEGInfo.
2874    long fragmentLength;
2875    while ( (fragmentLength = ReadTagLength(0xfffe, 0xe000)) )
2876    { 
2877       long fragmentOffset = Fp->tellg();
2878
2879        // Store the collected info
2880        JPEGFragment* newFragment = new JPEGFragment;
2881        newFragment->Offset = fragmentOffset;
2882        newFragment->Length = fragmentLength;
2883        JPEGInfo->Fragments.push_back( newFragment );
2884
2885        SkipBytes( fragmentLength );
2886    }
2887
2888    // Make sure that at the end of the item we encounter a 'Sequence
2889    // Delimiter Item':
2890    if ( !ReadTag(0xfffe, 0xe0dd) )
2891    {
2892       dbg.Verbose(0, "Document::ComputeRLEInfo: no sequence delimiter ");
2893       dbg.Verbose(0, "    item at end of JPEG item sequence");
2894    }
2895 }
2896
2897 /**
2898  * \brief Walk recursively the given \ref DocEntrySet, and feed
2899  *        the given hash table (\ref TagDocEntryHT) with all the
2900  *        \ref DocEntry (Dicom entries) encountered.
2901  *        This method does the job for \ref BuildFlatHashTable.
2902  * @param builtHT Where to collect all the \ref DocEntry encountered
2903  *        when recursively walking the given set.
2904  * @param set The structure to be traversed (recursively).
2905  */
2906 void Document::BuildFlatHashTableRecurse( TagDocEntryHT& builtHT,
2907                                           DocEntrySet* set )
2908
2909    if (ElementSet* elementSet = dynamic_cast< ElementSet* > ( set ) )
2910    {
2911       TagDocEntryHT const & currentHT = elementSet->GetTagHT();
2912       for( TagDocEntryHT::const_iterator i  = currentHT.begin();
2913                                          i != currentHT.end();
2914                                        ++i)
2915       {
2916          DocEntry* entry = i->second;
2917          if ( SeqEntry* seqEntry = dynamic_cast<SeqEntry*>(entry) )
2918          {
2919             const ListSQItem& items = seqEntry->GetSQItems();
2920             for( ListSQItem::const_iterator item  = items.begin();
2921                                             item != items.end();
2922                                           ++item)
2923             {
2924                BuildFlatHashTableRecurse( builtHT, *item );
2925             }
2926             continue;
2927          }
2928          builtHT[entry->GetKey()] = entry;
2929       }
2930       return;
2931     }
2932
2933    if (SQItem* SQItemSet = dynamic_cast< SQItem* > ( set ) )
2934    {
2935       const ListDocEntry& currentList = SQItemSet->GetDocEntries();
2936       for (ListDocEntry::const_iterator i  = currentList.begin();
2937                                         i != currentList.end();
2938                                       ++i)
2939       {
2940          DocEntry* entry = *i;
2941          if ( SeqEntry* seqEntry = dynamic_cast<SeqEntry*>(entry) )
2942          {
2943             const ListSQItem& items = seqEntry->GetSQItems();
2944             for( ListSQItem::const_iterator item  = items.begin();
2945                                             item != items.end();
2946                                           ++item)
2947             {
2948                BuildFlatHashTableRecurse( builtHT, *item );
2949             }
2950             continue;
2951          }
2952          builtHT[entry->GetKey()] = entry;
2953       }
2954
2955    }
2956 }
2957
2958 /**
2959  * \brief Build a \ref TagDocEntryHT (i.e. a std::map<>) from the current
2960  *        Document.
2961  *
2962  *        The structure used by a Document (through \ref ElementSet),
2963  *        in order to hold the parsed entries of a Dicom header, is a recursive
2964  *        one. This is due to the fact that the sequences (when present)
2965  *        can be nested. Additionaly, the sequence items (represented in
2966  *        gdcm as \ref SQItem) add an extra complexity to the data
2967  *        structure. Hence, a gdcm user whishing to visit all the entries of
2968  *        a Dicom header will need to dig in the gdcm internals (which
2969  *        implies exposing all the internal data structures to the API).
2970  *        In order to avoid this burden to the user, \ref BuildFlatHashTable
2971  *        recursively builds a temporary hash table, which holds all the
2972  *        Dicom entries in a flat structure (a \ref TagDocEntryHT i.e. a
2973  *        std::map<>).
2974  * \warning Of course there is NO integrity constrain between the 
2975  *        returned \ref TagDocEntryHT and the \ref ElementSet used
2976  *        to build it. Hence if the underlying \ref ElementSet is
2977  *        altered, then it is the caller responsability to invoke 
2978  *        \ref BuildFlatHashTable again...
2979  * @return The flat std::map<> we juste build.
2980  */
2981 TagDocEntryHT* Document::BuildFlatHashTable()
2982 {
2983    TagDocEntryHT* FlatHT = new TagDocEntryHT;
2984    BuildFlatHashTableRecurse( *FlatHT, this );
2985    return FlatHT;
2986 }
2987
2988
2989
2990 /**
2991  * \brief   Compares two documents, according to \ref DicomDir rules
2992  * \warning Does NOT work with ACR-NEMA files
2993  * \todo    Find a trick to solve the pb (use RET fields ?)
2994  * @param   document
2995  * @return  true if 'smaller'
2996  */
2997 bool Document::operator<(Document &document)
2998 {
2999    // Patient Name
3000    std::string s1 = GetEntryByNumber(0x0010,0x0010);
3001    std::string s2 = document.GetEntryByNumber(0x0010,0x0010);
3002    if(s1 < s2)
3003    {
3004       return true;
3005    }
3006    else if( s1 > s2 )
3007    {
3008       return false;
3009    }
3010    else
3011    {
3012       // Patient ID
3013       s1 = GetEntryByNumber(0x0010,0x0020);
3014       s2 = document.GetEntryByNumber(0x0010,0x0020);
3015       if ( s1 < s2 )
3016       {
3017          return true;
3018       }
3019       else if ( s1 > s2 )
3020       {
3021          return false;
3022       }
3023       else
3024       {
3025          // Study Instance UID
3026          s1 = GetEntryByNumber(0x0020,0x000d);
3027          s2 = document.GetEntryByNumber(0x0020,0x000d);
3028          if ( s1 < s2 )
3029          {
3030             return true;
3031          }
3032          else if( s1 > s2 )
3033          {
3034             return false;
3035          }
3036          else
3037          {
3038             // Serie Instance UID
3039             s1 = GetEntryByNumber(0x0020,0x000e);
3040             s2 = document.GetEntryByNumber(0x0020,0x000e);    
3041             if ( s1 < s2 )
3042             {
3043                return true;
3044             }
3045             else if( s1 > s2 )
3046             {
3047                return false;
3048             }
3049          }
3050       }
3051    }
3052    return false;
3053 }
3054
3055
3056 /**
3057  * \brief   Re-computes the length of a ACR-NEMA/Dicom group from a DcmHeader
3058  * @param filetype Type of the File to be written 
3059  */
3060 int Document::ComputeGroup0002Length( FileType filetype ) 
3061 {
3062    uint16_t gr, el;
3063    std::string vr;
3064    
3065    int groupLength = 0;
3066    bool found0002 = false;   
3067   
3068    // for each zero-level Tag in the DCM Header
3069    DocEntry *entry;
3070
3071    Initialize();
3072    entry = GetNextEntry();
3073    while(entry)
3074    {
3075       gr = entry->GetGroup();
3076
3077       if (gr == 0x0002)
3078       {
3079          found0002 = true;
3080
3081          el = entry->GetElement();
3082          vr = entry->GetVR();            
3083  
3084          if (filetype == ExplicitVR) 
3085          {
3086             if ( (vr == "OB") || (vr == "OW") || (vr == "SQ") ) 
3087             {
3088                groupLength +=  4; // explicit VR AND OB, OW, SQ : 4 more bytes
3089             }
3090          }
3091          groupLength += 2 + 2 + 4 + entry->GetLength();   
3092       }
3093       else if (found0002 )
3094          break;
3095
3096       entry = GetNextEntry();
3097    }
3098    return groupLength; 
3099 }
3100
3101 } // end namespace gdcm
3102
3103 //-----------------------------------------------------------------------------