]> Creatis software - gdcm.git/blob - src/gdcmDocument.cxx
Comments
[gdcm.git] / src / gdcmDocument.cxx
1 /*=========================================================================
2                                                                                 
3   Program:   gdcm
4   Module:    $RCSfile: gdcmDocument.cxx,v $
5   Language:  C++
6   Date:      $Date: 2005/07/05 18:44:21 $
7   Version:   $Revision: 1.255 $
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 "gdcmDictSet.h"
28 #include "gdcmDocEntrySet.h"
29 #include "gdcmSQItem.h"
30
31 #include <vector>
32 #include <iomanip>
33 #include <fstream>
34 #include <ctype.h>  // for isdigit
35 #include <stdlib.h> // for atoi
36
37 namespace gdcm 
38 {
39 //-----------------------------------------------------------------------------
40
41 // Refer to Document::SetMaxSizeLoadEntry()
42 const unsigned int Document::MAX_SIZE_LOAD_ELEMENT_VALUE = 0xfff; // 4096
43
44 //-----------------------------------------------------------------------------
45 // Constructor / Destructor
46 // Constructors and destructors are protected to avoid user to invoke directly
47
48 /**
49  * \brief This default constructor neither loads nor parses the file. 
50  *        You should then invoke \ref Document::Load.
51  *         
52  */
53 Document::Document() 
54          :ElementSet(-1)
55 {
56    Fp = 0;
57
58    SetMaxSizeLoadEntry(MAX_SIZE_LOAD_ELEMENT_VALUE);
59    Initialize();
60    SwapCode = 1234;
61    Filetype = ExplicitVR;
62    // Load will set it to true if sucessfull
63    Group0002Parsed = false;
64    IsDocumentAlreadyLoaded = false;
65    LoadMode = 0x00000000; // default : load everything, later
66 }
67
68 /**
69  * \brief   Constructor (not to break the API) 
70  * @param   fileName 'Document' (File or DicomDir) to be open for parsing
71  */
72 Document::Document( std::string const &fileName )
73          :ElementSet(-1) 
74 {
75    Fp = 0;
76
77    SetMaxSizeLoadEntry(MAX_SIZE_LOAD_ELEMENT_VALUE);
78    Initialize();
79    SwapCode = 1234;
80    Filetype = ExplicitVR;
81    Group0002Parsed = false;
82    LoadMode = 0x00000000; // Load everything, later
83
84    // Load will set it to true if sucessfull
85    IsDocumentAlreadyLoaded = false;
86
87    Load(fileName);
88 }
89 /**
90  * \brief   Canonical destructor.
91  */
92 Document::~Document ()
93 {
94    RefPubDict = NULL;
95    RefShaDict = NULL;
96 }
97
98 //-----------------------------------------------------------------------------
99 // Public
100
101 /**
102  * \brief   Loader  
103  * @param   fileName 'Document' (File or DicomDir) to be open for parsing
104  * @return false if file cannot be open or no swap info was found,
105  *         or no tag was found.
106  */
107 bool Document::Load( std::string const &fileName ) 
108 {
109    // We should clean out anything that already exists.
110    // Check IsDocumentAlreadyLoaded to be sure.
111    if ( IsDocumentAlreadyLoaded )
112    {
113       gdcmWarningMacro( "A file was already parsed inside this "
114                         << "gdcm::Document (previous name was: "
115                         << Filename.c_str() << ". New name is :"
116                         << fileName );
117      // todo : clean out the 'Document'
118      // Should we call ClearEntry() on the parent object ?!?
119    }
120
121    Filename = fileName;
122
123    Fp = 0;
124    if ( !OpenFile() )
125    {
126       // warning already performed in OpenFile()
127       //gdcmWarningMacro( "Unable to open as an ACR/DICOM file: "
128       //                 << Filename.c_str() );
129       Filetype = Unknown;
130       return false;
131    }
132
133    Group0002Parsed = false;
134
135    gdcmWarningMacro( "Starting parsing of file: " << Filename.c_str());
136
137    Fp->seekg(0, std::ios::end);
138    long lgt = Fp->tellg();       // total length of the file
139
140    Fp->seekg(0, std::ios::beg);
141
142    // CheckSwap returns a boolean 
143    // (false if no swap info of any kind was found)
144    if (! CheckSwap() )
145    {
146       gdcmWarningMacro( "Neither a DICOM V3 nor an ACR-NEMA file: " 
147                    << Filename.c_str());
148       CloseFile(); 
149       return false;      
150     }
151
152    long beg = Fp->tellg();      // just after DICOM preamble (if any)
153
154    lgt -= beg;                  // remaining length to parse    
155
156    // Recursive call.
157    // Loading is done during parsing
158    ParseDES( this, beg, lgt, false); // delim_mode is first defaulted to false
159
160    if ( IsEmpty() )
161    { 
162       gdcmWarningMacro( "No tag in internal hash table for: "
163                         << Filename.c_str());
164       CloseFile(); 
165       return false;
166    }
167    IsDocumentAlreadyLoaded = true;
168
169    Fp->seekg( 0, std::ios::beg);
170    
171    // Load 'non string' values
172       
173    std::string PhotometricInterpretation = GetEntryValue(0x0028,0x0004);   
174    if ( PhotometricInterpretation == "PALETTE COLOR " )
175    {
176    // FIXME
177    // Probabely this line should be outside the 'if'
178    // Try to find an image sample holding a 'gray LUT'
179       LoadEntryBinArea(0x0028,0x1200);  // gray LUT
180    
181       /// FIXME
182       /// The tags refered by the three following lines used to be CORRECTLY
183       /// defined as having an US Value Representation in the public
184       /// dictionary. BUT the semantics implied by the three following
185       /// lines state that the corresponding tag contents are in fact
186       /// the ones of a BinEntry.
187       /// In order to fix things "Quick and Dirty" the dictionary was
188       /// altered on PURPOSE but now contains a WRONG value.
189       /// In order to fix things and restore the dictionary to its
190       /// correct value, one needs to decided of the semantics by deciding
191       /// whether the following tags are either :
192       /// - multivaluated US, and hence loaded as ValEntry, but afterwards
193       ///   also used as BinEntry, which requires the proper conversion,
194       /// - OW, and hence loaded as BinEntry, but afterwards also used
195       ///   as ValEntry, which requires the proper conversion.
196       LoadEntryBinArea(0x0028,0x1201);  // R    LUT
197       LoadEntryBinArea(0x0028,0x1202);  // G    LUT
198       LoadEntryBinArea(0x0028,0x1203);  // B    LUT
199       
200       // Segmented Red   Palette Color LUT Data
201       LoadEntryBinArea(0x0028,0x1221);
202       // Segmented Green Palette Color LUT Data
203       LoadEntryBinArea(0x0028,0x1222);
204       // Segmented Blue  Palette Color LUT Data
205       LoadEntryBinArea(0x0028,0x1223);
206    }
207  
208    //FIXME later : how to use it?
209    SeqEntry *modLutSeq = GetSeqEntry(0x0028,0x3000);
210    if ( modLutSeq !=0 )
211    {
212       SQItem *sqi= modLutSeq->GetFirstSQItem();
213       if ( sqi != 0 )
214       {
215          BinEntry *b = sqi->GetBinEntry(0x0028,0x3006);
216          if ( b != 0 )
217          {
218             if ( b->GetLength() != 0 )
219             {
220                LoadEntryBinArea(b);    //LUT Data (CTX dependent)
221             }   
222         }
223      }      
224    }
225
226    CloseFile(); 
227   
228    // ----------------------------
229    // Specific code to allow gdcm to read ACR-LibIDO formated images
230    // Note: ACR-LibIDO is an extension of the ACR standard that was
231    //       used at CREATIS. For the time being (say a couple of years)
232    //       we keep this kludge to allow CREATIS users 
233    //       reading their old images.
234    //
235    // if recognition code tells us we deal with a LibIDO image
236    // we switch lineNumber and columnNumber
237    //
238    std::string RecCode;
239    RecCode = GetEntryValue(0x0008, 0x0010); // recognition code (RET)
240    if (RecCode == "ACRNEMA_LIBIDO_1.1" ||
241        RecCode == "CANRME_AILIBOD1_1." )  // for brain-damaged softwares
242                                           // with "little-endian strings"
243    {
244          Filetype = ACR_LIBIDO; 
245          std::string rows    = GetEntryValue(0x0028, 0x0010);
246          std::string columns = GetEntryValue(0x0028, 0x0011);
247          SetValEntry(columns, 0x0028, 0x0010);
248          SetValEntry(rows   , 0x0028, 0x0011);
249    }
250    // --- End of ACR-LibIDO kludge --- 
251
252    return true;
253 }
254
255 /**
256  * \brief   Get the public dictionary used
257  */
258 Dict *Document::GetPubDict()
259 {
260    return RefPubDict;
261 }
262
263 /**
264  * \brief   Get the shadow dictionary used
265  */
266 Dict *Document::GetShaDict()
267 {
268    return RefShaDict;
269 }
270
271 /**
272  * \brief   Set the shadow dictionary used
273  * @param   dict dictionary to use in shadow
274  */
275 bool Document::SetShaDict(Dict *dict)
276 {
277    RefShaDict = dict;
278    return !RefShaDict;
279 }
280
281 /**
282  * \brief   Set the shadow dictionary used
283  * @param   dictName name of the dictionary to use in shadow
284  */
285 bool Document::SetShaDict(DictKey const &dictName)
286 {
287    RefShaDict = Global::GetDicts()->GetDict(dictName);
288    return !RefShaDict;
289 }
290
291 /**
292  * \brief  This predicate tells us whether or not the current Document 
293  *         was properly parsed and contains at least *one* Dicom Element
294  *         (and nothing more, sorry).
295  * @return false when we're 150 % sure it's NOT a Dicom/Acr file,
296  *         true otherwise. 
297  */
298 bool Document::IsReadable()
299 {
300    if ( Filetype == Unknown )
301    {
302       gdcmWarningMacro( "Wrong filetype");
303       return false;
304    }
305
306    if ( IsEmpty() )
307    { 
308       gdcmWarningMacro( "No tag in internal hash table.");
309       return false;
310    }
311
312    return true;
313 }
314
315 /**
316  * \brief   Predicate for dicom version 3 file.
317  * @return  True when the file is a dicom version 3.
318  */
319 bool Document::IsDicomV3()
320 {
321    // Checking if Transfer Syntax exists is enough
322    // Anyway, it's too late check if the 'Preamble' was found ...
323    // And ... would it be a rich idea to check ?
324    // (some 'no Preamble' DICOM images exist !)
325    return GetDocEntry(0x0002, 0x0010) != NULL;
326 }
327
328 /**
329  * \brief   Predicate for Papyrus file
330  *          Dedicated to whomsoever it may concern
331  * @return  True when the file is a Papyrus file.
332  */
333 bool Document::IsPapyrus()
334 {
335    // check for Papyrus private Sequence
336    DocEntry *e = GetDocEntry(0x0041, 0x1050);
337    if ( !e )
338       return false;
339    // check if it's actually a Sequence
340    if ( !dynamic_cast<SeqEntry*>(e) )
341       return  false;
342    return true;
343 }
344
345 /**
346  * \brief  returns the File Type 
347  *         (ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown)
348  * @return the FileType code
349  */
350 FileType Document::GetFileType()
351 {
352    return Filetype;
353 }
354
355 /**
356  * \brief   Accessor to the Transfer Syntax (when present) of the
357  *          current document (it internally handles reading the
358  *          value from disk when only parsing occured).
359  * @return  The encountered Transfer Syntax of the current document.
360  */
361 std::string Document::GetTransferSyntax()
362 {
363    DocEntry *entry = GetDocEntry(0x0002, 0x0010);
364    if ( !entry )
365    {
366       return GDCM_UNKNOWN;
367    }
368
369    // The entry might be present but not loaded (parsing and loading
370    // happen at different stages): try loading and proceed with check...
371    LoadDocEntrySafe(entry);
372    if (ValEntry *valEntry = dynamic_cast< ValEntry* >(entry) )
373    {
374       std::string transfer = valEntry->GetValue();
375       // The actual transfer (as read from disk) might be padded. We
376       // first need to remove the potential padding. We can make the
377       // weak assumption that padding was not executed with digits...
378       if  ( transfer.length() == 0 )
379       {
380          // for brain damaged headers
381          return GDCM_UNKNOWN;
382       }
383       while ( !isdigit((unsigned char)transfer[transfer.length()-1]) )
384       {
385          transfer.erase(transfer.length()-1, 1);
386       }
387       return transfer;
388    }
389    return GDCM_UNKNOWN;
390 }
391
392 /**
393  * \brief Accesses the info from 0002,0010 : Transfer Syntax and TS
394  * @return The full Transfer Syntax Name (as opposed to Transfer Syntax UID)
395  */
396 std::string Document::GetTransferSyntaxName()
397 {
398    // use the TS (TS : Transfer Syntax)
399    std::string transferSyntax = GetEntryValue(0x0002,0x0010);
400
401    if ( (transferSyntax.find(GDCM_NOTLOADED) < transferSyntax.length()) )
402    {
403       gdcmErrorMacro( "Transfer Syntax not loaded. " << std::endl
404                << "Better you increase MAX_SIZE_LOAD_ELEMENT_VALUE" );
405       return "Uncompressed ACR-NEMA";
406    }
407    if ( transferSyntax == GDCM_UNFOUND )
408    {
409       gdcmWarningMacro( "Unfound Transfer Syntax (0002,0010)");
410       return "Uncompressed ACR-NEMA";
411    }
412
413    // we do it only when we need it
414    const TSKey &tsName = Global::GetTS()->GetValue( transferSyntax );
415
416    // Global::GetTS() is a global static you shall never try to delete it!
417    return tsName;
418 }
419 //
420 // --------------- Swap Code ------------------
421 /**
422  * \brief   Swaps the bytes so they agree with the processor order
423  * @return  The properly swaped 16 bits integer.
424  */
425 uint16_t Document::SwapShort(uint16_t a)
426 {
427    if ( SwapCode == 4321 || SwapCode == 2143 )
428    {
429       //a = ((( a << 8 ) & 0xff00 ) | (( a >> 8 ) & 0x00ff ) );
430       // Save CPU time
431       a = ( a << 8 ) | ( a >> 8 );
432    }
433    return a;
434 }
435
436 /**
437  * \brief   Swaps back the bytes of 4-byte long integer accordingly to
438  *          processor order.
439  * @return  The properly swaped 32 bits integer.
440  */
441 uint32_t Document::SwapLong(uint32_t a)
442 {
443    switch (SwapCode)
444    {
445       case 1234 :
446          break;
447       case 4321 :
448 //         a=( ((a<<24) & 0xff000000) | ((a<<8)  & 0x00ff0000) | 
449 //             ((a>>8)  & 0x0000ff00) | ((a>>24) & 0x000000ff) );
450 // save CPU time
451          a=( ( a<<24)               | ((a<<8)  & 0x00ff0000) | 
452              ((a>>8)  & 0x0000ff00) |  (a>>24)                );
453          break;   
454       case 3412 :
455 //       a=( ((a<<16) & 0xffff0000) | ((a>>16) & 0x0000ffff) );
456          a=( (a<<16)                | (a>>16)  );
457          break;  
458       case 2143 :
459          a=( ((a<< 8) & 0xff00ff00) | ((a>>8) & 0x00ff00ff)  );
460       break;
461       default :
462          gdcmErrorMacro( "Unset swap code:" << SwapCode );
463          a = 0;
464    }
465    return a;
466
467
468 //
469 // -----------------File I/O ---------------
470 /**
471  * \brief  Tries to open the file \ref Document::Filename and
472  *         checks the preamble when existing.
473  * @return The FILE pointer on success. 
474  */
475 std::ifstream *Document::OpenFile()
476 {
477    HasDCMPreamble = false;
478    if (Filename.length() == 0) 
479    {
480       return 0;
481    }
482
483    if ( Fp )
484    {
485       gdcmWarningMacro( "File already open: " << Filename.c_str());
486       CloseFile();
487    }
488
489    Fp = new std::ifstream(Filename.c_str(), std::ios::in | std::ios::binary);
490    if ( ! *Fp )
491    {
492    // Don't user gdcmErrorMacro :
493    // a spurious message will appear when you use, for instance 
494    // gdcm::FileHelper *fh = new gdcm::FileHelper( outputFileName );
495    // to create outputFileName.
496       gdcmWarningMacro( "Cannot open file: " << Filename.c_str());
497       delete Fp;
498       Fp = 0;
499       return 0;
500       //exit(1); // No function is allowed to leave the application instead
501                  // of warning the caller
502    }
503  
504    uint16_t zero = 0;
505    Fp->read((char*)&zero, (size_t)2);
506    if ( Fp->eof() )
507    {
508       CloseFile();
509       return 0;
510    }
511  
512    //-- ACR or DICOM with no Preamble; may start with a Shadow Group --
513    if ( 
514        zero == 0x0001 || zero == 0x0100 || zero == 0x0002 || zero == 0x0200 ||
515        zero == 0x0003 || zero == 0x0300 || zero == 0x0004 || zero == 0x0400 ||
516        zero == 0x0005 || zero == 0x0500 || zero == 0x0006 || zero == 0x0600 ||
517        zero == 0x0007 || zero == 0x0700 || zero == 0x0008 || zero == 0x0800 )
518    {
519       std::string msg = Util::Format(
520         "ACR/DICOM starting at the begining of the file:(%04x)\n", zero);
521       gdcmWarningMacro( msg.c_str() );
522       return Fp;
523    }
524  
525    //-- DICOM --
526    Fp->seekg(126L, std::ios::cur);
527    char dicm[4] = {' ',' ',' ',' '};
528    Fp->read(dicm,  (size_t)4);
529    if ( Fp->eof() )
530    {
531       CloseFile();
532       return 0;
533    }
534    if ( memcmp(dicm, "DICM", 4) == 0 )
535    {
536       HasDCMPreamble = true;
537       return Fp;
538    }
539
540    // -- Neither ACR/No Preamble Dicom nor DICOMV3 file
541    CloseFile();
542    gdcmWarningMacro( "Neither ACR/No Preamble Dicom nor DICOMV3 file: "
543                       << Filename.c_str()); 
544    return 0;
545 }
546
547 /**
548  * \brief closes the file  
549  * @return  TRUE if the close was successfull 
550  */
551 bool Document::CloseFile()
552 {
553    if ( Fp )
554    {
555       Fp->close();
556       delete Fp;
557       Fp = 0;
558    }
559    return true;
560 }
561
562 /**
563  * \brief Writes in a file all the Header Entries (Dicom Elements) 
564  * @param fp file pointer on an already open file (actually: Output File Stream)
565  * @param filetype Type of the File to be written 
566  *          (ACR-NEMA, ExplicitVR, ImplicitVR)
567  * @return Always true.
568  */
569 void Document::WriteContent(std::ofstream *fp, FileType filetype)
570 {
571    // \TODO move the following lines (and a lot of others, to be written)
572    // to a future function CheckAndCorrectHeader  
573
574    // (necessary if user wants to write a DICOM V3 file
575    // starting from an ACR-NEMA (V2) Header
576
577    if ( filetype == ImplicitVR || filetype == ExplicitVR )
578    {
579       // writing Dicom File Preamble
580       char filePreamble[128];
581       memset(filePreamble, 0, 128);
582       fp->write(filePreamble, 128);
583       fp->write("DICM", 4);
584    }
585
586    /*
587     * \todo rewrite later, if really usefull
588     *       - 'Group Length' element is optional in DICOM
589     *       - but un-updated odd groups lengthes can causes pb
590     *         (xmedcon breaker)
591     *
592     * if ( (filetype == ImplicitVR) || (filetype == ExplicitVR) )
593     *    UpdateGroupLength(false,filetype);
594     * if ( filetype == ACR)
595     *    UpdateGroupLength(true,ACR);
596     */
597
598    ElementSet::WriteContent(fp, filetype); // This one is recursive
599 }
600
601 // -----------------------------------------
602 // Content entries 
603 /**
604  * \brief Loads (from disk) the element content 
605  *        when a string is not suitable
606  * @param group   group number of the Entry 
607  * @param elem  element number of the Entry
608  */
609 void Document::LoadEntryBinArea(uint16_t group, uint16_t elem)
610 {
611    // Search the corresponding DocEntry
612    DocEntry *docElement = GetDocEntry(group, elem);
613    if ( !docElement )
614       return;
615
616    BinEntry *binElement = dynamic_cast<BinEntry *>(docElement);
617    if ( !binElement )
618       return;
619
620    LoadEntryBinArea(binElement);
621 }
622
623 /**
624  * \brief Loads (from disk) the element content 
625  *        when a string is not suitable
626  * @param elem  Entry whose binArea is going to be loaded
627  */
628 void Document::LoadEntryBinArea(BinEntry *elem) 
629 {
630    if (elem->GetBinArea() )
631       return;
632
633    bool openFile = !Fp;
634    if ( openFile )
635       OpenFile();
636
637    size_t o =(size_t)elem->GetOffset();
638    Fp->seekg(o, std::ios::beg);
639
640    size_t l = elem->GetLength();
641    uint8_t *a = new uint8_t[l];
642    if ( !a )
643    {
644       gdcmWarningMacro( "Cannot allocate BinEntry content");
645       return;
646    }
647
648    Fp->read((char*)a, l);
649    if ( Fp->fail() || Fp->eof() )
650    {
651       delete[] a;
652       return;
653    }
654
655    elem->SetBinArea(a);
656
657    if ( openFile )
658       CloseFile();
659 }
660
661 /**
662  * \brief  Loads the element while preserving the current
663  *         underlying file position indicator as opposed to
664  *        LoadDocEntry that modifies it.
665  * @param entry   DocEntry whose value will be loaded. 
666  */
667 void Document::LoadDocEntrySafe(DocEntry *entry)
668 {
669    if ( Fp )
670    {
671       long PositionOnEntry = Fp->tellg();
672       LoadDocEntry(entry);
673       Fp->seekg(PositionOnEntry, std::ios::beg);
674    }
675 }
676
677 /**
678  * \brief   Compares two documents, according to \ref DicomDir rules
679  * \warning Does NOT work with ACR-NEMA files
680  * \todo    Find a trick to solve the pb (use RET fields ?)
681  * @param   document to compare with current one
682  * @return  true if 'smaller'
683  */
684 bool Document::operator<(Document &document)
685 {
686    // Patient Name
687    std::string s1 = GetEntryValue(0x0010,0x0010);
688    std::string s2 = document.GetEntryValue(0x0010,0x0010);
689    if (s1 < s2)
690    {
691       return true;
692    }
693    else if ( s1 > s2 )
694    {
695       return false;
696    }
697    else
698    {
699       // Patient ID
700       s1 = GetEntryValue(0x0010,0x0020);
701       s2 = document.GetEntryValue(0x0010,0x0020);
702       if ( s1 < s2 )
703       {
704          return true;
705       }
706       else if ( s1 > s2 )
707       {
708          return false;
709       }
710       else
711       {
712          // Study Instance UID
713          s1 = GetEntryValue(0x0020,0x000d);
714          s2 = document.GetEntryValue(0x0020,0x000d);
715          if ( s1 < s2 )
716          {
717             return true;
718          }
719          else if ( s1 > s2 )
720          {
721             return false;
722          }
723          else
724          {
725             // Serie Instance UID
726             s1 = GetEntryValue(0x0020,0x000e);
727             s2 = document.GetEntryValue(0x0020,0x000e);    
728             if ( s1 < s2 )
729             {
730                return true;
731             }
732             else if ( s1 > s2 )
733             {
734                return false;
735             }
736          }
737       }
738    }
739    return false;
740 }
741
742 //-----------------------------------------------------------------------------
743 // Protected
744 /**
745  * \brief Reads a supposed to be 16 Bits integer
746  *       (swaps it depending on processor endianness) 
747  * @return read value
748  */
749 uint16_t Document::ReadInt16()
750    throw( FormatError )
751 {
752    uint16_t g;
753    Fp->read ((char*)&g, (size_t)2);
754    if ( Fp->fail() )
755    {
756       throw FormatError( "Document::ReadInt16()", " file error." );
757    }
758    if ( Fp->eof() )
759    {
760       throw FormatError( "Document::ReadInt16()", "EOF." );
761    }
762    g = SwapShort(g); 
763    return g;
764 }
765
766 /**
767  * \brief  Reads a supposed to be 32 Bits integer
768  *        (swaps it depending on processor endianness)  
769  * @return read value
770  */
771 uint32_t Document::ReadInt32()
772    throw( FormatError )
773 {
774    uint32_t g;
775    Fp->read ((char*)&g, (size_t)4);
776    if ( Fp->fail() )
777    {
778       throw FormatError( "Document::ReadInt32()", " file error." );
779    }
780    if ( Fp->eof() )
781    {
782       throw FormatError( "Document::ReadInt32()", "EOF." );
783    }
784    g = SwapLong(g);
785    return g;
786 }
787
788 /**
789  * \brief skips bytes inside the source file 
790  * \warning NOT end user intended method !
791  * @return 
792  */
793 void Document::SkipBytes(uint32_t nBytes)
794 {
795    //FIXME don't dump the returned value
796    Fp->seekg((long)nBytes, std::ios::cur);
797 }
798
799 /**
800  * \brief   Re-computes the length of a ACR-NEMA/Dicom group from a DcmHeader
801  * @param filetype Type of the File to be written 
802  */
803 int Document::ComputeGroup0002Length( FileType filetype ) 
804 {
805    uint16_t gr;
806    std::string vr;
807    
808    int groupLength = 0;
809    bool found0002 = false;   
810   
811    // for each zero-level Tag in the DCM Header
812    DocEntry *entry = GetFirstEntry();
813    while( entry )
814    {
815       gr = entry->GetGroup();
816
817       if ( gr == 0x0002 )
818       {
819          found0002 = true;
820
821          if ( entry->GetElement() != 0x0000 )
822          {
823             vr = entry->GetVR();
824  
825             if ( filetype == ExplicitVR )
826             {
827                if ( (vr == "OB") || (vr == "OW") || (vr == "SQ") || (vr == "UT") ) 
828                {
829                   // explicit VR AND OB, OW, SQ, UT : 4 more bytes
830                   groupLength +=  4;
831                }
832             }
833             groupLength += 2 + 2 + 4 + entry->GetLength();   
834          }
835       }
836       else if (found0002 )
837          break;
838
839       entry = GetNextEntry();
840    }
841    return groupLength; 
842 }
843
844 //-----------------------------------------------------------------------------
845 // Private
846 /**
847  * \brief Loads all the needed Dictionaries
848  * \warning NOT end user intended method !   
849  */
850 void Document::Initialize() 
851 {
852    RefPubDict = Global::GetDicts()->GetDefaultPubDict();
853    RefShaDict = NULL;
854    Filetype   = Unknown;
855 }
856
857 /**
858  * \brief   Parses a DocEntrySet (Zero-level DocEntries or SQ Item DocEntries)
859  * @param set DocEntrySet we are going to parse ('zero level' or a SQItem)
860  * @param offset start of parsing
861  * @param l_max  length to parse
862  * @param delim_mode : whether we are in 'delimitor mode' (l=0xffffff) or not
863  */ 
864 void Document::ParseDES(DocEntrySet *set, long offset, 
865                         long l_max, bool delim_mode)
866 {
867    DocEntry *newDocEntry;
868    ValEntry *newValEntry;
869    BinEntry *newBinEntry;
870    SeqEntry *newSeqEntry;
871    VRKey vr;
872    bool used;
873    bool delim_mode_intern;
874
875    while (true)
876    {
877       if ( !delim_mode && ((long)(Fp->tellg())-offset) >= l_max)
878       {
879          break;
880       }
881
882       used = true;
883       newDocEntry = ReadNextDocEntry( );
884
885       if ( !newDocEntry )
886       {
887          break;
888       }
889
890       vr = newDocEntry->GetVR();
891       newValEntry = dynamic_cast<ValEntry*>(newDocEntry);
892       newBinEntry = dynamic_cast<BinEntry*>(newDocEntry);
893       newSeqEntry = dynamic_cast<SeqEntry*>(newDocEntry);
894
895       if ( newValEntry || newBinEntry )
896       {
897          if ( newBinEntry )
898          {
899             if ( Filetype == ExplicitVR && 
900                  !Global::GetVR()->IsVROfBinaryRepresentable(vr) )
901             { 
902                 ////// Neither ValEntry NOR BinEntry: should mean UNKOWN VR
903                 gdcmWarningMacro( std::hex << newDocEntry->GetGroup() 
904                                   << "|" << newDocEntry->GetElement()
905                                   << " : Neither Valentry, nor BinEntry." 
906                                   "Probably unknown VR.");
907             }
908
909          //////////////////// BinEntry or UNKOWN VR:
910             // When "this" is a Document the Key is simply of the
911             // form ( group, elem )...
912             if ( dynamic_cast< Document* > ( set ) )
913             {
914                newBinEntry->SetKey( newBinEntry->GetKey() );
915             }
916             // but when "this" is a SQItem, we are inserting this new
917             // valEntry in a sequence item, and the key has the
918             // generalized form (refer to \ref BaseTagKey):
919             if (SQItem *parentSQItem = dynamic_cast< SQItem* > ( set ) )
920             {
921                newBinEntry->SetKey(  parentSQItem->GetBaseTagKey()
922                                    + newBinEntry->GetKey() );
923             }
924
925             LoadDocEntry( newBinEntry );
926             if ( !set->AddEntry( newBinEntry ) )
927             {
928               //Expect big troubles if here
929               //delete newBinEntry;
930               gdcmWarningMacro("in ParseDES : shouldn't get here !");
931               used=false;
932             }
933          }
934          else
935          {
936          /////////////////////// ValEntry
937
938             // When "set" is a Document, then we are at the top of the
939             // hierarchy and the Key is simply of the form ( group, elem )...
940             if ( dynamic_cast< Document* > ( set ) )
941             {
942                newValEntry->SetKey( newValEntry->GetKey() );
943             }
944             // ...but when "set" is a SQItem, we are inserting this new
945             // valEntry in a sequence item. Hence the key has the
946             // generalized form (refer to \ref BaseTagKey):
947             if (SQItem *parentSQItem = dynamic_cast< SQItem* > ( set ) )
948             {
949                newValEntry->SetKey(  parentSQItem->GetBaseTagKey()
950                                    + newValEntry->GetKey() );
951             }
952              
953             LoadDocEntry( newValEntry );
954             bool delimitor=newValEntry->IsItemDelimitor();
955
956             if ( LoadMode & NO_SHADOW ) // User asked to skip, if possible, 
957                                         // shadow groups ( if possible :
958                                         // whether element 0x0000 exits)
959             {
960                if ( newValEntry->GetGroup()%2 != 0 )
961                {
962                   if ( newValEntry->GetElement() == 0x0000 )
963                   {
964                      std::string strLgrGroup = newValEntry->GetValue();
965                      int lgrGroup;
966                      if ( strLgrGroup != GDCM_UNFOUND)
967                      {
968                         lgrGroup = atoi(strLgrGroup.c_str());
969                         Fp->seekg(lgrGroup, std::ios::cur);
970                         used = false;
971                         continue;
972                      }
973                   }
974                }
975              }
976
977             if ( !set->AddEntry( newValEntry ) )
978             {
979               // If here expect big troubles
980               // delete newValEntry; //otherwise mem leak
981               used=false;
982             }
983
984             if (delimitor)
985             {
986                if ( !used )
987                   delete newDocEntry;
988                break;
989             }
990             if ( !delim_mode && ((long)(Fp->tellg())-offset) >= l_max )
991             {
992                if ( !used )
993                   delete newDocEntry;
994                break;
995             }
996          }
997
998          // Just to make sure we are at the beginning of next entry.
999          SkipToNextDocEntry(newDocEntry);
1000       }
1001       else
1002       {
1003          /////////////////////// SeqEntry :  VR = "SQ"
1004
1005          unsigned long l = newDocEntry->GetReadLength();          
1006          if ( l != 0 ) // don't mess the delim_mode for 'zero-length sequence'
1007          {
1008             if ( l == 0xffffffff )
1009             {
1010               delim_mode_intern = true;
1011             }
1012             else
1013             {
1014               delim_mode_intern = false;
1015             }
1016          }
1017
1018          if ( (LoadMode & NO_SHADOWSEQ) && ! delim_mode_intern )
1019          { 
1020            // User asked to skip SeQuences *only* if they belong to Shadow Group
1021             if ( newDocEntry->GetGroup()%2 != 0 )
1022             {
1023                 Fp->seekg( l, std::ios::cur);
1024                 used = false;
1025                 continue;  
1026             } 
1027          } 
1028          if ( (LoadMode & NO_SEQ) && ! delim_mode_intern ) 
1029          {
1030            // User asked to skip *any* SeQuence
1031             Fp->seekg( l, std::ios::cur);
1032             used = false;
1033             continue;
1034          }
1035          
1036          // no other way to create it ...
1037          newSeqEntry->SetDelimitorMode( delim_mode_intern );
1038
1039          // At the top of the hierarchy, stands a Document. When "set"
1040          // is a Document, then we are building the first depth level.
1041          // Hence the SeqEntry we are building simply has a depth
1042          // level of one:
1043          if ( dynamic_cast< Document* > ( set ) )
1044          {
1045             newSeqEntry->SetDepthLevel( 1 );
1046             newSeqEntry->SetKey( newSeqEntry->GetKey() );
1047          }
1048          // But when "set" is already a SQItem, we are building a nested
1049          // sequence, and hence the depth level of the new SeqEntry
1050          // we are building, is one level deeper:
1051          if (SQItem *parentSQItem = dynamic_cast< SQItem* > ( set ) )
1052          {
1053             newSeqEntry->SetDepthLevel( parentSQItem->GetDepthLevel() + 1 );
1054             newSeqEntry->SetKey(  parentSQItem->GetBaseTagKey()
1055                                 + newSeqEntry->GetKey() );
1056          }
1057
1058          if ( l != 0 )
1059          {  // Don't try to parse zero-length sequences
1060             ParseSQ( newSeqEntry, 
1061                      newDocEntry->GetOffset(),
1062                      l, delim_mode_intern);
1063          }
1064          if ( !set->AddEntry( newSeqEntry ) )
1065          {
1066             used = false;
1067          }
1068  
1069          if ( !delim_mode && ((long)(Fp->tellg())-offset) >= l_max)
1070          {
1071             if ( !used )
1072                delete newDocEntry;
1073             break;
1074          }
1075       }
1076
1077       if ( !used )
1078          delete newDocEntry;
1079    }
1080 }
1081
1082 /**
1083  * \brief   Parses a Sequence ( SeqEntry after SeqEntry)
1084  * @return  parsed length for this level
1085  */ 
1086 void Document::ParseSQ( SeqEntry *seqEntry,
1087                         long offset, long l_max, bool delim_mode)
1088 {
1089    int SQItemNumber = 0;
1090    bool dlm_mod;
1091    long offsetStartCurrentSQItem = offset;
1092
1093    while (true)
1094    {
1095       // the first time, we read the fff0,e000 of the first SQItem
1096       DocEntry *newDocEntry = ReadNextDocEntry();
1097
1098       if ( !newDocEntry )
1099       {
1100          // FIXME Should warn user
1101          gdcmWarningMacro("in ParseSQ : should never get here!");
1102          break;
1103       }
1104       if ( delim_mode )
1105       {
1106          if ( newDocEntry->IsSequenceDelimitor() )
1107          {
1108             seqEntry->SetDelimitationItem( newDocEntry ); 
1109             break;
1110          }
1111       }
1112       if ( !delim_mode && ((long)(Fp->tellg())-offset) >= l_max)
1113       {
1114          delete newDocEntry;
1115          break;
1116       }
1117       // create the current SQItem
1118       SQItem *itemSQ = new SQItem( seqEntry->GetDepthLevel() );
1119       std::ostringstream newBase;
1120       newBase << seqEntry->GetKey()
1121               << "/"
1122               << SQItemNumber
1123               << "#";
1124       itemSQ->SetBaseTagKey( newBase.str() );
1125       unsigned int l = newDocEntry->GetReadLength();
1126       
1127       if ( l == 0xffffffff )
1128       {
1129          dlm_mod = true;
1130       }
1131       else
1132       {
1133          dlm_mod = false;
1134       }
1135
1136       // Let's try :------------
1137       // remove fff0,e000, created out of the SQItem
1138       delete newDocEntry;
1139       Fp->seekg(offsetStartCurrentSQItem, std::ios::beg);
1140       // fill up the current SQItem, starting at the beginning of fff0,e000
1141
1142       ParseDES(itemSQ, offsetStartCurrentSQItem, l+8, dlm_mod);
1143
1144       offsetStartCurrentSQItem = Fp->tellg();
1145       // end try -----------------
1146  
1147       seqEntry->AddSQItem( itemSQ, SQItemNumber ); 
1148       SQItemNumber++;
1149       if ( !delim_mode && ((long)(Fp->tellg())-offset ) >= l_max )
1150       {
1151          break;
1152       }
1153    }
1154 }
1155
1156 /**
1157  * \brief   Loads the element content if its length doesn't exceed
1158  *          the value specified with Document::SetMaxSizeLoadEntry()
1159  * @param   entry Header Entry (Dicom Element) to be dealt with
1160  */
1161 void Document::LoadDocEntry(DocEntry *entry)
1162 {
1163    uint16_t group  = entry->GetGroup();
1164    std::string  vr = entry->GetVR();
1165    uint32_t length = entry->GetLength();
1166
1167    Fp->seekg((long)entry->GetOffset(), std::ios::beg);
1168
1169    // A SeQuence "contains" a set of Elements.  
1170    //          (fffe e000) tells us an Element is beginning
1171    //          (fffe e00d) tells us an Element just ended
1172    //          (fffe e0dd) tells us the current SeQuence just ended
1173    if ( group == 0xfffe )
1174    {
1175       // NO more value field for SQ !
1176       return;
1177    }
1178
1179    // When the length is zero things are easy:
1180    if ( length == 0 )
1181    {
1182       ((ValEntry *)entry)->SetValue("");
1183       return;
1184    }
1185
1186    // The elements whose length is bigger than the specified upper bound
1187    // are not loaded. Instead we leave a short notice on the offset of
1188    // the element content and it's length.
1189
1190    std::ostringstream s;
1191    if (length > MaxSizeLoadEntry)
1192    {
1193       if (BinEntry *binEntryPtr = dynamic_cast< BinEntry* >(entry) )
1194       {  
1195          s << GDCM_NOTLOADED;
1196          s << " Ad.:" << (long)entry->GetOffset();
1197          s << " x(" << std::hex << entry->GetOffset() << ")";
1198          s << std::dec;
1199          s << " Lgt:"  << entry->GetLength();
1200          s << " x(" << std::hex << entry->GetLength() << ")";
1201          binEntryPtr->SetValue(s.str());
1202       }
1203       else if (ValEntry *valEntryPtr = dynamic_cast< ValEntry* >(entry) )
1204       {
1205          s << GDCM_NOTLOADED;  
1206          s << " Address:" << (long)entry->GetOffset();
1207          s << " Length:"  << entry->GetLength();
1208          s << " x(" << std::hex << entry->GetLength() << ")";
1209          valEntryPtr->SetValue(s.str());
1210       }
1211       else
1212       {
1213          // fusible
1214          gdcmErrorMacro( "MaxSizeLoadEntry exceeded, neither a BinEntry "
1215                       << "nor a ValEntry ?! Should never print that !" );
1216       }
1217
1218       // to be sure we are at the end of the value ...
1219       Fp->seekg((long)entry->GetOffset()+(long)entry->GetLength(),
1220                 std::ios::beg);
1221       return;
1222    }
1223
1224    // When we find a BinEntry not very much can be done :
1225    if (BinEntry *binEntryPtr = dynamic_cast< BinEntry* >(entry) )
1226    {
1227       s << GDCM_BINLOADED;
1228       binEntryPtr->SetValue(s.str());
1229       LoadEntryBinArea(binEntryPtr); // last one, not to erase length !
1230       return;
1231    }
1232
1233    if ( IsDocEntryAnInteger(entry) )
1234    {   
1235       uint32_t NewInt;
1236       int nbInt;
1237       // When short integer(s) are expected, read and convert the following 
1238       // (n * 2) characters properly i.e. consider them as short integers as
1239       // opposed to strings.
1240       // Elements with Value Multiplicity > 1
1241       // contain a set of integers (not a single one)       
1242       if (vr == "US" || vr == "SS")
1243       {
1244          nbInt = length / 2;
1245          NewInt = ReadInt16();
1246          s << NewInt;
1247          if (nbInt > 1)
1248          {
1249             for (int i=1; i < nbInt; i++)
1250             {
1251                s << '\\';
1252                NewInt = ReadInt16();
1253                s << NewInt;
1254             }
1255          }
1256       }
1257       // See above comment on multiple integers (mutatis mutandis).
1258       else if (vr == "UL" || vr == "SL")
1259       {
1260          nbInt = length / 4;
1261          NewInt = ReadInt32();
1262          s << NewInt;
1263          if (nbInt > 1)
1264          {
1265             for (int i=1; i < nbInt; i++)
1266             {
1267                s << '\\';
1268                NewInt = ReadInt32();
1269                s << NewInt;
1270             }
1271          }
1272       }
1273 #ifdef GDCM_NO_ANSI_STRING_STREAM
1274       s << std::ends; // to avoid oddities on Solaris
1275 #endif //GDCM_NO_ANSI_STRING_STREAM
1276
1277       ((ValEntry *)entry)->SetValue(s.str());
1278       return;
1279    }
1280    
1281   // FIXME: We need an additional byte for storing \0 that is not on disk
1282    char *str = new char[length+1];
1283    Fp->read(str, (size_t)length);
1284    str[length] = '\0'; //this is only useful when length is odd
1285    // Special DicomString call to properly handle \0 and even length
1286    std::string newValue;
1287    if ( length % 2 )
1288    {
1289       newValue = Util::DicomString(str, length+1);
1290       gdcmWarningMacro("Warning: bad length: " << length <<
1291                        " For string :" <<  newValue.c_str()); 
1292       // Since we change the length of string update it length
1293       //entry->SetReadLength(length+1);
1294    }
1295    else
1296    {
1297       newValue = Util::DicomString(str, length);
1298    }
1299    delete[] str;
1300
1301    if ( ValEntry *valEntry = dynamic_cast<ValEntry* >(entry) )
1302    {
1303       if ( Fp->fail() || Fp->eof())
1304       {
1305          if ( Fp->fail() )
1306             gdcmWarningMacro("--> fail");
1307
1308          gdcmWarningMacro("Unread element value " << valEntry->GetKey() 
1309                           << " lgt : " << valEntry->GetReadLength() 
1310                           << " at " << std::hex << valEntry->GetOffset());
1311          valEntry->SetValue(GDCM_UNREAD);
1312          return;
1313       }
1314
1315       if ( vr == "UI" )
1316       {
1317          // Because of correspondance with the VR dic
1318          valEntry->SetValue(newValue);
1319       }
1320       else
1321       {
1322          valEntry->SetValue(newValue);
1323       }
1324    }
1325    else
1326    {
1327       gdcmWarningMacro("Should have a ValEntry, here ! " << valEntry->GetKey() 
1328                           << " lgt : " << valEntry->GetReadLength() 
1329                           << " at " << std::hex << valEntry->GetOffset());
1330    }
1331 }
1332
1333 /**
1334  * \brief  Find the value Length of the passed Header Entry
1335  * @param  entry Header Entry whose length of the value shall be loaded. 
1336  */
1337 void Document::FindDocEntryLength( DocEntry *entry )
1338    throw ( FormatError )
1339 {
1340    std::string  vr  = entry->GetVR();
1341    uint16_t length16;       
1342    
1343    if ( Filetype == ExplicitVR && !entry->IsImplicitVR() ) 
1344    {
1345       if ( vr == "OB" || vr == "OW" || vr == "SQ" || vr == "UT" || vr == "UN" ) 
1346       {
1347          // The following reserved two bytes (see PS 3.5-2003, section
1348          // "7.1.2 Data element structure with explicit vr", p 27) must be
1349          // skipped before proceeding on reading the length on 4 bytes.
1350          Fp->seekg( 2L, std::ios::cur);
1351          uint32_t length32 = ReadInt32();
1352
1353          if ( (vr == "OB" || vr == "OW") && length32 == 0xffffffff ) 
1354          {
1355             uint32_t lengthOB;
1356             try 
1357             {
1358                lengthOB = FindDocEntryLengthOBOrOW();
1359             }
1360             catch ( FormatUnexpected )
1361             {
1362                // Computing the length failed (this happens with broken
1363                // files like gdcm-JPEG-LossLess3a.dcm). We still have a
1364                // chance to get the pixels by deciding the element goes
1365                // until the end of the file. Hence we artificially fix the
1366                // the length and proceed.
1367                long currentPosition = Fp->tellg();
1368                Fp->seekg(0L,std::ios::end);
1369
1370                long lengthUntilEOF = (long)(Fp->tellg())-currentPosition;
1371                Fp->seekg(currentPosition, std::ios::beg);
1372
1373                entry->SetReadLength(lengthUntilEOF);
1374                entry->SetLength(lengthUntilEOF);
1375                return;
1376             }
1377             entry->SetReadLength(lengthOB);
1378             entry->SetLength(lengthOB);
1379             return;
1380          }
1381          FixDocEntryFoundLength(entry, length32); 
1382          return;
1383       }
1384
1385       // Length is encoded on 2 bytes.
1386       length16 = ReadInt16();
1387   
1388       // 0xffff means that we deal with 'No Length' Sequence 
1389       //        or 'No Length' SQItem
1390       if ( length16 == 0xffff) 
1391       {           
1392          length16 = 0;
1393       }
1394       FixDocEntryFoundLength( entry, (uint32_t)length16 );
1395       return;
1396    }
1397    else
1398    {
1399       // Either implicit VR or a non DICOM conformal (see note below) explicit
1400       // VR that ommited the VR of (at least) this element. Farts happen.
1401       // [Note: according to the part 5, PS 3.5-2001, section 7.1 p25
1402       // on Data elements "Implicit and Explicit VR Data Elements shall
1403       // not coexist in a Data Set and Data Sets nested within it".]
1404       // Length is on 4 bytes.
1405
1406      // Well ... group 0002 is always coded in 'Explicit VR Litle Endian'
1407      // even if Transfer Syntax is 'Implicit VR ...' 
1408       
1409       FixDocEntryFoundLength( entry, ReadInt32() );
1410       return;
1411    }
1412 }
1413
1414 /**
1415  * \brief  Find the Length till the next sequence delimiter
1416  * \warning NOT end user intended method !
1417  * @return 
1418  */
1419 uint32_t Document::FindDocEntryLengthOBOrOW()
1420    throw( FormatUnexpected )
1421 {
1422    // See PS 3.5-2001, section A.4 p. 49 on encapsulation of encoded pixel data.
1423    long positionOnEntry = Fp->tellg();
1424    bool foundSequenceDelimiter = false;
1425    uint32_t totalLength = 0;
1426
1427    while ( !foundSequenceDelimiter )
1428    {
1429       uint16_t group;
1430       uint16_t elem;
1431       try
1432       {
1433          group = ReadInt16();
1434          elem  = ReadInt16();   
1435       }
1436       catch ( FormatError )
1437       {
1438          throw FormatError("Unexpected end of file encountered during ",
1439                            "Document::FindDocEntryLengthOBOrOW()");
1440       }
1441       // We have to decount the group and element we just read
1442       totalLength += 4;     
1443       if ( group != 0xfffe || ( ( elem != 0xe0dd ) && ( elem != 0xe000 ) ) )
1444       {
1445          long filePosition = Fp->tellg();
1446          gdcmWarningMacro( 
1447               "Neither an Item tag nor a Sequence delimiter tag on :" 
1448            << std::hex << group << " , " << elem 
1449            << ") -before- position x(" << filePosition << ")" );
1450   
1451          Fp->seekg(positionOnEntry, std::ios::beg);
1452          throw FormatUnexpected( 
1453                "Neither an Item tag nor a Sequence delimiter tag.");
1454       }
1455       if ( elem == 0xe0dd )
1456       {
1457          foundSequenceDelimiter = true;
1458       }
1459       uint32_t itemLength = ReadInt32();
1460       // We add 4 bytes since we just read the ItemLength with ReadInt32
1461       totalLength += itemLength + 4;
1462       SkipBytes(itemLength);
1463       
1464       if ( foundSequenceDelimiter )
1465       {
1466          break;
1467       }
1468    }
1469    Fp->seekg( positionOnEntry, std::ios::beg);
1470    return totalLength;
1471 }
1472
1473 /**
1474  * \brief     Find the Value Representation of the current Dicom Element.
1475  * @return    Value Representation of the current Entry
1476  */
1477 std::string Document::FindDocEntryVR()
1478 {
1479    if ( Filetype != ExplicitVR )
1480       return GDCM_UNKNOWN;
1481
1482    long positionOnEntry = Fp->tellg();
1483    // Warning: we believe this is explicit VR (Value Representation) because
1484    // we used a heuristic that found "UL" in the first tag. Alas this
1485    // doesn't guarantee that all the tags will be in explicit VR. In some
1486    // cases (see e-film filtered files) one finds implicit VR tags mixed
1487    // within an explicit VR file. Hence we make sure the present tag
1488    // is in explicit VR and try to fix things if it happens not to be
1489    // the case.
1490
1491    char vr[3];
1492    Fp->read (vr, (size_t)2);
1493    vr[2] = 0;
1494
1495    if ( !CheckDocEntryVR(vr) )
1496    {
1497       Fp->seekg(positionOnEntry, std::ios::beg);
1498       return GDCM_UNKNOWN;
1499    }
1500    return vr;
1501 }
1502
1503 /**
1504  * \brief     Check the correspondance between the VR of the header entry
1505  *            and the taken VR. If they are different, the header entry is 
1506  *            updated with the new VR.
1507  * @param     vr    Dicom Value Representation
1508  * @return    false if the VR is incorrect of if the VR isn't referenced
1509  *            otherwise, it returns true
1510 */
1511 bool Document::CheckDocEntryVR(VRKey vr)
1512 {
1513    if ( !Global::GetVR()->IsValidVR(vr) )
1514       return false;
1515
1516    return true; 
1517 }
1518
1519 /**
1520  * \brief   Get the transformed value of the header entry. The VR value 
1521  *          is used to define the transformation to operate on the value
1522  * \warning NOT end user intended method !
1523  * @param   entry entry to tranform
1524  * @return  Transformed entry value
1525  */
1526 std::string Document::GetDocEntryValue(DocEntry *entry)
1527 {
1528    if ( IsDocEntryAnInteger(entry) && entry->IsImplicitVR() )
1529    {
1530       std::string val = ((ValEntry *)entry)->GetValue();
1531       std::string vr  = entry->GetVR();
1532       uint32_t length = entry->GetLength();
1533       std::ostringstream s;
1534       int nbInt;
1535
1536       // When short integer(s) are expected, read and convert the following 
1537       // n * 2 bytes properly i.e. as a multivaluated strings
1538       // (each single value is separated fromthe next one by '\'
1539       // as usual for standard multivaluated filels
1540       // Elements with Value Multiplicity > 1
1541       // contain a set of short integers (not a single one) 
1542    
1543       if ( vr == "US" || vr == "SS" )
1544       {
1545          uint16_t newInt16;
1546
1547          nbInt = length / 2;
1548          for (int i=0; i < nbInt; i++) 
1549          {
1550             if ( i != 0 )
1551             {
1552                s << '\\';
1553             }
1554             newInt16 = ( val[2*i+0] & 0xFF ) + ( ( val[2*i+1] & 0xFF ) << 8);
1555             newInt16 = SwapShort( newInt16 );
1556             s << newInt16;
1557          }
1558       }
1559
1560       // When integer(s) are expected, read and convert the following 
1561       // n * 4 bytes properly i.e. as a multivaluated strings
1562       // (each single value is separated fromthe next one by '\'
1563       // as usual for standard multivaluated filels
1564       // Elements with Value Multiplicity > 1
1565       // contain a set of integers (not a single one) 
1566       else if ( vr == "UL" || vr == "SL" )
1567       {
1568          uint32_t newInt32;
1569
1570          nbInt = length / 4;
1571          for (int i=0; i < nbInt; i++) 
1572          {
1573             if ( i != 0)
1574             {
1575                s << '\\';
1576             }
1577             newInt32 = ( val[4*i+0] & 0xFF )
1578                     + (( val[4*i+1] & 0xFF ) <<  8 )
1579                     + (( val[4*i+2] & 0xFF ) << 16 )
1580                     + (( val[4*i+3] & 0xFF ) << 24 );
1581             newInt32 = SwapLong( newInt32 );
1582             s << newInt32;
1583          }
1584       }
1585 #ifdef GDCM_NO_ANSI_STRING_STREAM
1586       s << std::ends; // to avoid oddities on Solaris
1587 #endif //GDCM_NO_ANSI_STRING_STREAM
1588       return s.str();
1589    }
1590    return ((ValEntry *)entry)->GetValue();
1591 }
1592
1593 /**
1594  * \brief   Get the reverse transformed value of the header entry. The VR 
1595  *          value is used to define the reverse transformation to operate on
1596  *          the value
1597  * \warning NOT end user intended method !
1598  * @param   entry Entry to reverse transform
1599  * @return  Reverse transformed entry value
1600  */
1601 std::string Document::GetDocEntryUnvalue(DocEntry *entry)
1602 {
1603    if ( IsDocEntryAnInteger(entry) && entry->IsImplicitVR() )
1604    {
1605       std::string vr = entry->GetVR();
1606       std::vector<std::string> tokens;
1607       std::ostringstream s;
1608
1609       if ( vr == "US" || vr == "SS" ) 
1610       {
1611          uint16_t newInt16;
1612
1613          tokens.erase( tokens.begin(), tokens.end()); // clean any previous value
1614          Util::Tokenize (((ValEntry *)entry)->GetValue(), tokens, "\\");
1615          for (unsigned int i=0; i<tokens.size(); i++) 
1616          {
1617             newInt16 = atoi(tokens[i].c_str());
1618             s << (  newInt16        & 0xFF ) 
1619               << (( newInt16 >> 8 ) & 0xFF );
1620          }
1621          tokens.clear();
1622       }
1623       if ( vr == "UL" || vr == "SL")
1624       {
1625          uint32_t newInt32;
1626
1627          tokens.erase(tokens.begin(),tokens.end()); // clean any previous value
1628          Util::Tokenize (((ValEntry *)entry)->GetValue(), tokens, "\\");
1629          for (unsigned int i=0; i<tokens.size();i++) 
1630          {
1631             newInt32 = atoi(tokens[i].c_str());
1632             s << (char)(  newInt32         & 0xFF ) 
1633               << (char)(( newInt32 >>  8 ) & 0xFF )
1634               << (char)(( newInt32 >> 16 ) & 0xFF )
1635               << (char)(( newInt32 >> 24 ) & 0xFF );
1636          }
1637          tokens.clear();
1638       }
1639
1640 #ifdef GDCM_NO_ANSI_STRING_STREAM
1641       s << std::ends; // to avoid oddities on Solaris
1642 #endif //GDCM_NO_ANSI_STRING_STREAM
1643       return s.str();
1644    }
1645
1646    return ((ValEntry *)entry)->GetValue();
1647 }
1648
1649 /**
1650  * \brief   Skip a given Header Entry 
1651  * \warning NOT end user intended method !
1652  * @param   entry entry to skip
1653  */
1654 void Document::SkipDocEntry(DocEntry *entry) 
1655 {
1656    SkipBytes(entry->GetLength());
1657 }
1658
1659 /**
1660  * \brief   Skips to the beginning of the next Header Entry 
1661  * \warning NOT end user intended method !
1662  * @param   currentDocEntry entry to skip
1663  */
1664 void Document::SkipToNextDocEntry(DocEntry *currentDocEntry) 
1665 {
1666    Fp->seekg((long)(currentDocEntry->GetOffset()),     std::ios::beg);
1667    if (currentDocEntry->GetGroup() != 0xfffe)  // for fffe pb
1668       Fp->seekg( (long)(currentDocEntry->GetReadLength()),std::ios::cur);
1669 }
1670
1671 /**
1672  * \brief   When the length of an element value is obviously wrong (because
1673  *          the parser went Jabberwocky) one can hope improving things by
1674  *          applying some heuristics.
1675  * @param   entry entry to check
1676  * @param   foundLength first assumption about length    
1677  */
1678 void Document::FixDocEntryFoundLength(DocEntry *entry,
1679                                       uint32_t foundLength)
1680 {
1681    entry->SetReadLength( foundLength ); // will be updated only if a bug is found        
1682    if ( foundLength == 0xffffffff)
1683    {
1684       foundLength = 0;
1685    }
1686    
1687    uint16_t gr   = entry->GetGroup();
1688    uint16_t elem = entry->GetElement(); 
1689      
1690    if ( foundLength % 2)
1691    {
1692       gdcmWarningMacro( "Warning : Tag with uneven length " << foundLength 
1693         <<  " in x(" << std::hex << gr << "," << elem <<")");
1694    }
1695       
1696    //////// Fix for some naughty General Electric images.
1697    // Allthough not recent many such GE corrupted images are still present
1698    // on Creatis hard disks. Hence this fix shall remain when such images
1699    // are no longer in use (we are talking a few years, here)...
1700    // Note: XMedCon probably uses such a trick since it is able to read
1701    //       those pesky GE images ...
1702    if ( foundLength == 13)
1703    {
1704       // Only happens for this length !
1705       if ( gr != 0x0008 || ( elem != 0x0070 && elem != 0x0080 ) )
1706       {
1707          foundLength = 10;
1708          entry->SetReadLength(10); // a bug is to be fixed !?
1709       }
1710    }
1711
1712    //////// Fix for some brain-dead 'Leonardo' Siemens images.
1713    // Occurence of such images is quite low (unless one leaves close to a
1714    // 'Leonardo' source. Hence, one might consider commenting out the
1715    // following fix on efficiency reasons.
1716    else if ( gr   == 0x0009 && ( elem == 0x1113 || elem == 0x1114 ) )
1717    {
1718       foundLength = 4;
1719       entry->SetReadLength(4); // a bug is to be fixed !?
1720    } 
1721  
1722    else if ( entry->GetVR() == "SQ" )
1723    {
1724       foundLength = 0;      // ReadLength is unchanged 
1725    } 
1726     
1727    //////// We encountered a 'delimiter' element i.e. a tag of the form 
1728    // "fffe|xxxx" which is just a marker. Delimiters length should not be
1729    // taken into account.
1730    else if ( gr == 0xfffe )
1731    {    
1732      // According to the norm, fffe|0000 shouldn't exist. BUT the Philips
1733      // image gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm happens to
1734      // causes extra troubles...
1735      if ( entry->GetElement() != 0x0000 )
1736      {
1737         foundLength = 0;
1738      }
1739    }            
1740    entry->SetLength(foundLength);
1741 }
1742
1743 /**
1744  * \brief   Apply some heuristics to predict whether the considered 
1745  *          element value contains/represents an integer or not.
1746  * @param   entry The element value on which to apply the predicate.
1747  * @return  The result of the heuristical predicate.
1748  */
1749 bool Document::IsDocEntryAnInteger(DocEntry *entry)
1750 {
1751    uint16_t elem         = entry->GetElement();
1752    uint16_t group        = entry->GetGroup();
1753    const std::string &vr = entry->GetVR();
1754    uint32_t length       = entry->GetLength();
1755
1756    // When we have some semantics on the element we just read, and if we
1757    // a priori know we are dealing with an integer, then we shall be
1758    // able to swap it's element value properly.
1759    if ( elem == 0 )  // This is the group length of the group
1760    {  
1761       if ( length == 4 )
1762       {
1763          return true;
1764       }
1765       else 
1766       {
1767          // Allthough this should never happen, still some images have a
1768          // corrupted group length [e.g. have a glance at offset x(8336) of
1769          // gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm].
1770          // Since for dicom compliant and well behaved headers, the present
1771          // test is useless (and might even look a bit paranoid), when we
1772          // encounter such an ill-formed image, we simply display a warning
1773          // message and proceed on parsing (while crossing fingers).
1774          long filePosition = Fp->tellg();
1775          gdcmWarningMacro( "Erroneous Group Length element length  on : (" 
1776            << std::hex << group << " , " << elem
1777            << ") -before- position x(" << filePosition << ")"
1778            << "lgt : " << length );
1779       }
1780    }
1781
1782    if ( vr == "UL" || vr == "US" || vr == "SL" || vr == "SS" )
1783    {
1784       return true;
1785    }   
1786    return false;
1787 }
1788
1789 /**
1790  * \brief   Discover what the swap code is (among little endian, big endian,
1791  *          bad little endian, bad big endian).
1792  *          sw is set
1793  * @return false when we are absolutely sure 
1794  *               it's neither ACR-NEMA nor DICOM
1795  *         true  when we hope ours assuptions are OK
1796  */
1797 bool Document::CheckSwap()
1798 {   
1799    uint32_t  s32;
1800    uint16_t  s16;
1801        
1802    char deb[256];
1803     
1804    // First, compare HostByteOrder and NetworkByteOrder in order to
1805    // determine if we shall need to swap bytes (i.e. the Endian type).
1806    bool net2host = Util::IsCurrentProcessorBigEndian();
1807          
1808    // The easiest case is the one of a 'true' DICOM header, we just have
1809    // to look for the string "DICM" inside the file preamble.
1810    Fp->read(deb, 256);
1811    
1812    char *entCur = deb + 128;
1813    if ( memcmp(entCur, "DICM", (size_t)4) == 0 )
1814    {
1815       gdcmWarningMacro( "Looks like DICOM Version3 (preamble + DCM)" );
1816       
1817       // Group 0002 should always be VR, and the first element 0000
1818       // Let's be carefull (so many wrong headers ...)
1819       // and determine the value representation (VR) : 
1820       // Let's skip to the first element (0002,0000) and check there if we find
1821       // "UL"  - or "OB" if the 1st one is (0002,0001) -,
1822       // in which case we (almost) know it is explicit VR.
1823       // WARNING: if it happens to be implicit VR then what we will read
1824       // is the length of the group. If this ascii representation of this
1825       // length happens to be "UL" then we shall believe it is explicit VR.
1826       // We need to skip :
1827       // * the 128 bytes of File Preamble (often padded with zeroes),
1828       // * the 4 bytes of "DICM" string,
1829       // * the 4 bytes of the first tag (0002, 0000),or (0002, 0001)
1830       // i.e. a total of  136 bytes.
1831       entCur = deb + 136;
1832      
1833       // group 0x0002 *is always* Explicit VR Sometimes ,
1834       // even if elem 0002,0010 (Transfer Syntax) tells us the file is
1835       // *Implicit* VR  (see former 'gdcmData/icone.dcm')
1836       
1837       if ( memcmp(entCur, "UL", (size_t)2) == 0 ||
1838            memcmp(entCur, "OB", (size_t)2) == 0 ||
1839            memcmp(entCur, "UI", (size_t)2) == 0 ||
1840            memcmp(entCur, "CS", (size_t)2) == 0 )  // CS, to remove later
1841                                                    // when Write DCM *adds*
1842       // FIXME
1843       // Use Document::dicom_vr to test all the possibilities
1844       // instead of just checking for UL, OB and UI !? group 0000 
1845       {
1846          Filetype = ExplicitVR;
1847          gdcmWarningMacro( "Group 0002 : Explicit Value Representation");
1848       } 
1849       else 
1850       {
1851          Filetype = ImplicitVR;
1852          gdcmWarningMacro( "Group 0002 :Not an explicit Value Representation;"
1853                         << "Looks like a bugged Header!");
1854       }
1855       
1856       if ( net2host )
1857       {
1858          SwapCode = 4321;
1859          gdcmWarningMacro( "HostByteOrder != NetworkByteOrder");
1860       }
1861       else 
1862       {
1863          SwapCode = 1234;
1864          gdcmWarningMacro( "HostByteOrder = NetworkByteOrder");
1865       }
1866       
1867       // Position the file position indicator at first tag 
1868       // (i.e. after the file preamble and the "DICM" string).
1869
1870       Fp->seekg(0, std::ios::beg); // FIXME : Is it usefull?
1871
1872       Fp->seekg ( 132L, std::ios::beg);
1873       return true;
1874    } // ------------------------------- End of DicomV3 ----------------
1875
1876    // Alas, this is not a DicomV3 file and whatever happens there is no file
1877    // preamble. We can reset the file position indicator to where the data
1878    // is (i.e. the beginning of the file).
1879
1880    gdcmWarningMacro( "Not a Kosher DICOM Version3 file (no preamble)");
1881
1882    Fp->seekg(0, std::ios::beg);
1883
1884    // Let's check 'No Preamble Dicom File' :
1885    // Should start with group 0x0002
1886    // and be Explicit Value Representation
1887
1888    s16 = *((uint16_t *)(deb));
1889    SwapCode = 0;     
1890    switch ( s16 )
1891    {
1892       case 0x0002 :
1893          SwapCode = 1234;
1894          entCur = deb + 4;
1895          break;
1896       case 0x0200 :
1897          SwapCode = 4321;
1898          entCur = deb + 6;
1899     } 
1900
1901    if ( SwapCode != 0 )
1902    {
1903       if ( memcmp(entCur, "UL", (size_t)2) == 0 ||
1904            memcmp(entCur, "OB", (size_t)2) == 0 ||
1905            memcmp(entCur, "UI", (size_t)2) == 0 ||
1906            memcmp(entCur, "SH", (size_t)2) == 0 ||
1907            memcmp(entCur, "AE", (size_t)2) == 0 ||
1908            memcmp(entCur, "OB", (size_t)2) == 0 )
1909          {
1910             Filetype = ExplicitVR;
1911             gdcmWarningMacro( "Group 0002 : Explicit Value Representation");
1912             return true;
1913           }
1914     }
1915 // ------------------------------- End of 'No Preamble' DicomV3 -------------
1916
1917    // Our next best chance would be to be considering a 'clean' ACR/NEMA file.
1918    // By clean we mean that the length of the first group is written down.
1919    // If this is the case and since the length of the first group HAS to be
1920    // four (bytes), then determining the proper swap code is straightforward.
1921
1922    entCur = deb + 4;
1923    // We assume the array of char we are considering contains the binary
1924    // representation of a 32 bits integer. Hence the following dirty
1925    // trick :
1926    s32 = *((uint32_t *)(entCur));
1927    switch( s32 )
1928    {
1929       case 0x00040000 :
1930          SwapCode = 3412;
1931          Filetype = ACR;
1932          return true;
1933       case 0x04000000 :
1934          SwapCode = 4321;
1935          Filetype = ACR;
1936          return true;
1937       case 0x00000400 :
1938          SwapCode = 2143;
1939          Filetype = ACR;
1940          return true;
1941       case 0x00000004 :
1942          SwapCode = 1234;
1943          Filetype = ACR;
1944          return true;
1945       default :
1946          // We are out of luck. It is not a DicomV3 nor a 'clean' ACR/NEMA file.
1947          // It is time for despaired wild guesses. 
1948          // So, let's check if this file wouldn't happen to be 'dirty' ACR/NEMA,
1949          //  i.e. the 'group length' element is not present :     
1950          
1951          //  check the supposed-to-be 'group number'
1952          //  in ( 0x0001 .. 0x0008 )
1953          //  to determine ' SwapCode' value .
1954          //  Only 0 or 4321 will be possible 
1955          //  (no oportunity to check for the formerly well known
1956          //  ACR-NEMA 'Bad Big Endian' or 'Bad Little Endian' 
1957          //  if unsuccessfull (i.e. neither 0x0002 nor 0x0200 etc -3, 4, ..., 8-) 
1958          //  the file IS NOT ACR-NEMA nor DICOM V3
1959          //  Find a trick to tell it the caller...
1960       
1961          s16 = *((uint16_t *)(deb));
1962       
1963          switch ( s16 )
1964          {
1965             case 0x0001 :
1966             case 0x0002 :
1967             case 0x0003 :
1968             case 0x0004 :
1969             case 0x0005 :
1970             case 0x0006 :
1971             case 0x0007 :
1972             case 0x0008 :
1973                SwapCode = 1234;
1974                Filetype = ACR;
1975                return true;
1976             case 0x0100 :
1977             case 0x0200 :
1978             case 0x0300 :
1979             case 0x0400 :
1980             case 0x0500 :
1981             case 0x0600 :
1982             case 0x0700 :
1983             case 0x0800 :
1984                SwapCode = 4321;
1985                Filetype = ACR;
1986                return true;
1987             default :
1988                gdcmWarningMacro( "ACR/NEMA unfound swap info (Really hopeless !)");
1989                Filetype = Unknown;
1990                return false;
1991          }
1992    }
1993 }
1994
1995 /**
1996  * \brief Change the Byte Swap code. 
1997  */
1998 void Document::SwitchByteSwapCode() 
1999 {
2000    gdcmWarningMacro( "Switching Byte Swap code from "<< SwapCode
2001                      << " at :" <<std::hex << Fp->tellg() );
2002    if ( SwapCode == 1234 ) 
2003    {
2004       SwapCode = 4321;
2005    }
2006    else if ( SwapCode == 4321 ) 
2007    {
2008       SwapCode = 1234;
2009    }
2010    else if ( SwapCode == 3412 ) 
2011    {
2012       SwapCode = 2143;
2013    }
2014    else if ( SwapCode == 2143 )
2015    {
2016       SwapCode = 3412;
2017    }
2018 }
2019
2020 /**
2021  * \brief  during parsing, Header Elements too long are not loaded in memory 
2022  * @param newSize new size
2023  */
2024 void Document::SetMaxSizeLoadEntry(long newSize) 
2025 {
2026    if ( newSize < 0 )
2027    {
2028       return;
2029    }
2030    if ((uint32_t)newSize >= (uint32_t)0xffffffff )
2031    {
2032       MaxSizeLoadEntry = 0xffffffff;
2033       return;
2034    }
2035    MaxSizeLoadEntry = newSize;
2036 }
2037
2038 /**
2039  * \brief   Read the next tag WITHOUT loading it's value
2040  *          (read the 'Group Number', the 'Element Number',
2041  *          gets the Dict Entry
2042  *          gets the VR, gets the length, gets the offset value)
2043  * @return  On succes : the newly created DocEntry, NULL on failure.      
2044  */
2045 DocEntry *Document::ReadNextDocEntry()
2046 {
2047    uint16_t group;
2048    uint16_t elem;
2049
2050    try
2051    {
2052       group = ReadInt16();
2053       elem  = ReadInt16();
2054    }
2055    catch ( FormatError e )
2056    {
2057       // We reached the EOF (or an error occured) therefore 
2058       // header parsing has to be considered as finished.
2059       return 0;
2060    }
2061
2062    // Sometimes file contains groups of tags with reversed endianess.
2063    HandleBrokenEndian(group, elem);
2064
2065    // In 'true DICOM' files Group 0002 is always little endian
2066    if ( HasDCMPreamble )
2067       HandleOutOfGroup0002(group, elem);
2068  
2069    std::string vr = FindDocEntryVR();
2070    std::string realVR = vr;
2071
2072    if ( vr == GDCM_UNKNOWN )
2073    {
2074       if ( elem == 0x0000 ) // Group Length
2075          realVR = "UL";     // must be UL
2076       else
2077       {
2078          DictEntry *dictEntry = GetDictEntry(group,elem);
2079          if ( dictEntry )
2080             realVR = dictEntry->GetVR();
2081       }
2082    }
2083
2084    DocEntry *newEntry;
2085    if ( Global::GetVR()->IsVROfSequence(realVR) )
2086       newEntry = NewSeqEntry(group, elem);
2087    else if ( Global::GetVR()->IsVROfStringRepresentable(realVR) )
2088       newEntry = NewValEntry(group, elem,vr);
2089    else
2090       newEntry = NewBinEntry(group, elem,vr);
2091
2092    if ( vr == GDCM_UNKNOWN )
2093    {
2094       if ( Filetype == ExplicitVR )
2095       {
2096          // We thought this was explicit VR, but we end up with an
2097          // implicit VR tag. Let's backtrack.
2098          if ( newEntry->GetGroup() != 0xfffe )
2099          { 
2100             std::string msg;
2101             int offset = Fp->tellg();
2102             msg = Util::Format("Entry (%04x,%04x) at 0x(%x) should be Explicit VR\n", 
2103                           newEntry->GetGroup(), newEntry->GetElement(), offset );
2104             gdcmWarningMacro( msg.c_str() );
2105           }
2106       }
2107       newEntry->SetImplicitVR();
2108    }
2109
2110    try
2111    {
2112       FindDocEntryLength(newEntry);
2113    }
2114    catch ( FormatError e )
2115    {
2116       // Call it quits
2117       delete newEntry;
2118       return 0;
2119    }
2120
2121    newEntry->SetOffset(Fp->tellg());  
2122
2123    return newEntry;
2124 }
2125
2126 /**
2127  * \brief   Handle broken private tag from Philips NTSCAN
2128  *          where the endianess is being switched to BigEndian 
2129  *          for no apparent reason
2130  * @return  no return
2131  */
2132 void Document::HandleBrokenEndian(uint16_t &group, uint16_t &elem)
2133 {
2134    // Endian reversion. Some files contain groups of tags with reversed endianess.
2135    static int reversedEndian = 0;
2136    // try to fix endian switching in the middle of headers
2137    if ((group == 0xfeff) && (elem == 0x00e0))
2138    {
2139      // start endian swap mark for group found
2140      reversedEndian++;
2141      SwitchByteSwapCode();
2142      // fix the tag
2143      group = 0xfffe;
2144      elem  = 0xe000;
2145    } 
2146    else if (group == 0xfffe && elem == 0xe00d && reversedEndian) 
2147    {
2148      // end of reversed endian group
2149      reversedEndian--;
2150      SwitchByteSwapCode();
2151    }
2152 }
2153
2154 /**
2155  * \brief   Group 0002 is always coded Little Endian
2156  *          whatever Transfer Syntax is
2157  * @return  no return
2158  */
2159 void Document::HandleOutOfGroup0002(uint16_t &group, uint16_t &elem)
2160 {
2161    // Endian reversion. Some files contain groups of tags with reversed endianess.
2162    if ( !Group0002Parsed && group != 0x0002)
2163    {
2164       Group0002Parsed = true;
2165       // we just came out of group 0002
2166       // if Transfer syntax is Big Endian we have to change CheckSwap
2167
2168       std::string ts = GetTransferSyntax();
2169       if ( !Global::GetTS()->IsTransferSyntax(ts) )
2170       {
2171          gdcmWarningMacro("True DICOM File, with NO Tansfer Syntax: " << ts );
2172          return;
2173       }
2174
2175       // Group 0002 is always 'Explicit ...' enven when Transfer Syntax says 'Implicit ..." 
2176
2177       if ( Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ImplicitVRLittleEndian )
2178          {
2179             Filetype = ImplicitVR;
2180          }
2181        
2182       // FIXME Strangely, this works with 
2183       //'Implicit VR Transfer Syntax (GE Private)
2184       if ( Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ExplicitVRBigEndian )
2185       {
2186          gdcmWarningMacro("Transfer Syntax Name = [" 
2187                         << GetTransferSyntaxName() << "]" );
2188          SwitchByteSwapCode();
2189          group = SwapShort(group);
2190          elem  = SwapShort(elem);
2191       }
2192    }
2193 }
2194
2195 //-----------------------------------------------------------------------------
2196 // Print
2197
2198 //-----------------------------------------------------------------------------
2199 } // end namespace gdcm