1 /*=========================================================================
4 Module: $RCSfile: gdcmDocument.cxx,v $
6 Date: $Date: 2005/01/17 11:03:28 $
7 Version: $Revision: 1.192 $
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.
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.
17 =========================================================================*/
19 #include "gdcmDocument.h"
20 #include "gdcmValEntry.h"
21 #include "gdcmBinEntry.h"
22 #include "gdcmSeqEntry.h"
23 #include "gdcmGlobal.h"
25 #include "gdcmDebug.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"
38 #if defined(_MSC_VER) || defined(__BORLANDC__)
41 #include <netinet/in.h>
47 //-----------------------------------------------------------------------------
48 // Refer to Document::CheckSwap()
49 //const unsigned int Document::HEADER_LENGTH_TO_READ = 256;
51 // Refer to Document::SetMaxSizeLoadEntry()
52 const unsigned int Document::MAX_SIZE_LOAD_ELEMENT_VALUE = 0xfff; // 4096
53 const unsigned int Document::MAX_SIZE_PRINT_ELEMENT_VALUE = 0x7fffffff;
55 //-----------------------------------------------------------------------------
56 // Constructor / Destructor
60 * @param filename file to be opened for parsing
62 Document::Document( std::string const &filename ) : ElementSet(-1)
64 SetMaxSizeLoadEntry(MAX_SIZE_LOAD_ELEMENT_VALUE);
74 Group0002Parsed = false;
76 gdcmVerboseMacro( "Starting parsing of file: " << Filename.c_str());
77 // Fp->seekg( 0, std::ios::beg);
79 Fp->seekg(0, std::ios::end);
80 long lgt = Fp->tellg();
82 Fp->seekg( 0, std::ios::beg);
85 long beg = Fp->tellg();
88 ParseDES( this, beg, lgt, false); // Loading is done during parsing
90 Fp->seekg( 0, std::ios::beg);
92 // Load 'non string' values
94 std::string PhotometricInterpretation = GetEntry(0x0028,0x0004);
95 if( PhotometricInterpretation == "PALETTE COLOR " )
97 LoadEntryBinArea(0x0028,0x1200); // gray LUT
99 /// The tags refered by the three following lines used to be CORRECTLY
100 /// defined as having an US Value Representation in the public
101 /// dictionary. BUT the semantics implied by the three following
102 /// lines state that the corresponding tag contents are in fact
103 /// the ones of a BinEntry.
104 /// In order to fix things "Quick and Dirty" the dictionary was
105 /// altered on PURPOSE but now contains a WRONG value.
106 /// In order to fix things and restore the dictionary to its
107 /// correct value, one needs to decided of the semantics by deciding
108 /// whether the following tags are either:
109 /// - multivaluated US, and hence loaded as ValEntry, but afterwards
110 /// also used as BinEntry, which requires the proper conversion,
111 /// - OW, and hence loaded as BinEntry, but afterwards also used
112 /// as ValEntry, which requires the proper conversion.
113 LoadEntryBinArea(0x0028,0x1201); // R LUT
114 LoadEntryBinArea(0x0028,0x1202); // G LUT
115 LoadEntryBinArea(0x0028,0x1203); // B LUT
117 // Segmented Red Palette Color LUT Data
118 LoadEntryBinArea(0x0028,0x1221);
119 // Segmented Green Palette Color LUT Data
120 LoadEntryBinArea(0x0028,0x1222);
121 // Segmented Blue Palette Color LUT Data
122 LoadEntryBinArea(0x0028,0x1223);
124 //FIXME later : how to use it?
125 LoadEntryBinArea(0x0028,0x3006); //LUT Data (CTX dependent)
129 // --------------------------------------------------------------
130 // Specific code to allow gdcm to read ACR-LibIDO formated images
131 // Note: ACR-LibIDO is an extension of the ACR standard that was
132 // used at CREATIS. For the time being (say a couple years)
133 // we keep this kludge to allow a smooth move to gdcm for
134 // CREATIS developpers (sorry folks).
136 // if recognition code tells us we deal with a LibIDO image
137 // we switch lineNumber and columnNumber
140 RecCode = GetEntry(0x0008, 0x0010); // recognition code
141 if (RecCode == "ACRNEMA_LIBIDO_1.1" ||
142 RecCode == "CANRME_AILIBOD1_1." ) // for brain-damaged softwares
143 // with "little-endian strings"
145 Filetype = ACR_LIBIDO;
146 std::string rows = GetEntry(0x0028, 0x0010);
147 std::string columns = GetEntry(0x0028, 0x0011);
148 SetEntry(columns, 0x0028, 0x0010);
149 SetEntry(rows , 0x0028, 0x0011);
151 // ----------------- End of ACR-LibIDO kludge ------------------
155 * \brief This default constructor doesn't parse the file. You should
156 * then invoke \ref Document::SetFileName and then the parsing.
158 Document::Document() : ElementSet(-1)
162 SetMaxSizeLoadEntry(MAX_SIZE_LOAD_ELEMENT_VALUE);
165 Filetype = ExplicitVR;
166 Group0002Parsed = false;
170 * \brief Canonical destructor.
172 Document::~Document ()
181 //-----------------------------------------------------------------------------
185 * \brief Prints The Dict Entries of THE public Dicom Dictionary
188 void Document::PrintPubDict(std::ostream &os)
190 RefPubDict->SetPrintLevel(PrintLevel);
191 RefPubDict->Print(os);
195 * \brief Prints The Dict Entries of THE shadow Dicom Dictionary
198 void Document::PrintShaDict(std::ostream &os)
200 RefShaDict->SetPrintLevel(PrintLevel);
201 RefShaDict->Print(os);
204 //-----------------------------------------------------------------------------
207 * \brief Get the public dictionary used
209 Dict *Document::GetPubDict()
215 * \brief Get the shadow dictionary used
217 Dict *Document::GetShaDict()
223 * \brief Set the shadow dictionary used
224 * @param dict dictionary to use in shadow
226 bool Document::SetShaDict(Dict *dict)
233 * \brief Set the shadow dictionary used
234 * @param dictName name of the dictionary to use in shadow
236 bool Document::SetShaDict(DictKey const &dictName)
238 RefShaDict = Global::GetDicts()->GetDict(dictName);
243 * \brief This predicate, based on hopefully reasonable heuristics,
244 * decides whether or not the current Document was properly parsed
245 * and contains the mandatory information for being considered as
246 * a well formed and usable Dicom/Acr File.
247 * @return true when Document is the one of a reasonable Dicom/Acr file,
250 bool Document::IsReadable()
252 if( Filetype == Unknown)
254 gdcmVerboseMacro( "Wrong filetype");
260 gdcmVerboseMacro( "No tags in internal hash table.");
268 * \brief Accessor to the Transfer Syntax (when present) of the
269 * current document (it internally handles reading the
270 * value from disk when only parsing occured).
271 * @return The encountered Transfer Syntax of the current document.
273 std::string Document::GetTransferSyntax()
275 DocEntry *entry = GetDocEntry(0x0002, 0x0010);
281 // The entry might be present but not loaded (parsing and loading
282 // happen at different stages): try loading and proceed with check...
283 LoadDocEntrySafe(entry);
284 if (ValEntry *valEntry = dynamic_cast< ValEntry* >(entry) )
286 std::string transfer = valEntry->GetValue();
287 // The actual transfer (as read from disk) might be padded. We
288 // first need to remove the potential padding. We can make the
289 // weak assumption that padding was not executed with digits...
290 if ( transfer.length() == 0 )
292 // for brain damaged headers
295 while ( !isdigit((unsigned char)transfer[transfer.length()-1]) )
297 transfer.erase(transfer.length()-1, 1);
305 * \brief Predicate for dicom version 3 file.
306 * @return True when the file is a dicom version 3.
308 bool Document::IsDicomV3()
310 // Checking if Transfer Syntax exists is enough
311 // Anyway, it's to late check if the 'Preamble' was found ...
312 // And ... would it be a rich idea to check ?
313 // (some 'no Preamble' DICOM images exist !)
314 return GetDocEntry(0x0002, 0x0010) != NULL;
318 * \brief returns the File Type
319 * (ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown)
320 * @return the FileType code
322 FileType Document::GetFileType()
328 * \brief Tries to open the file \ref Document::Filename and
329 * checks the preamble when existing.
330 * @return The FILE pointer on success.
332 std::ifstream *Document::OpenFile()
335 HasDCMPreamble = false;
336 if (Filename.length() == 0)
343 gdcmVerboseMacro( "File already open: " << Filename.c_str());
346 Fp = new std::ifstream(Filename.c_str(), std::ios::in | std::ios::binary);
349 gdcmDebugMacro( "Cannot open file: " << Filename.c_str());
356 Fp->read((char*)&zero, (size_t)2);
363 //ACR -- or DICOM with no Preamble; may start with a Shadow Group --
365 zero == 0x0001 || zero == 0x0100 || zero == 0x0002 || zero == 0x0200 ||
366 zero == 0x0003 || zero == 0x0300 || zero == 0x0004 || zero == 0x0400 ||
367 zero == 0x0005 || zero == 0x0500 || zero == 0x0006 || zero == 0x0600 ||
368 zero == 0x0007 || zero == 0x0700 || zero == 0x0008 || zero == 0x0800 )
371 = Util::Format("ACR/DICOM with no preamble: (%04x)\n", zero);
372 gdcmVerboseMacro( msg.c_str() );
377 Fp->seekg(126L, std::ios::cur);
379 Fp->read(dicm, (size_t)4);
385 if( memcmp(dicm, "DICM", 4) == 0 )
387 HasDCMPreamble = true;
392 gdcmVerboseMacro( "Not DICOM/ACR (missing preamble)" << Filename.c_str());
398 * \brief closes the file
399 * @return TRUE if the close was successfull
401 bool Document::CloseFile()
410 return true; //FIXME how do we detect a non-close ifstream ?
414 * \brief Writes in a file all the Header Entries (Dicom Elements)
415 * @param fp file pointer on an already open file
416 * @param filetype Type of the File to be written
417 * (ACR-NEMA, ExplicitVR, ImplicitVR)
418 * \return Always true.
420 void Document::WriteContent(std::ofstream *fp, FileType filetype)
422 /// \todo move the following lines (and a lot of others, to be written)
423 /// to a future function CheckAndCorrectHeader
424 /// (necessary if user wants to write a DICOM V3 file
425 /// starting from an ACR-NEMA (V2) Header
427 if ( filetype == ImplicitVR || filetype == ExplicitVR )
429 // writing Dicom File Preamble
430 char filePreamble[128];
431 memset(filePreamble, 0, 128);
432 fp->write(filePreamble, 128);
433 fp->write("DICM", 4);
437 * \todo rewrite later, if really usefull
438 * - 'Group Length' element is optional in DICOM
439 * - but un-updated odd groups lengthes can causes pb
442 * if ( (filetype == ImplicitVR) || (filetype == ExplicitVR) )
443 * UpdateGroupLength(false,filetype);
444 * if ( filetype == ACR)
445 * UpdateGroupLength(true,ACR);
448 ElementSet::WriteContent(fp, filetype); // This one is recursive
452 * \brief Modifies the value of a given Doc Entry (Dicom Element)
453 * when it exists. Create it with the given value when unexistant.
454 * @param value (string) Value to be set
455 * @param group Group number of the Entry
456 * @param elem Element number of the Entry
457 * @param vr V(alue) R(epresentation) of the Entry -if private Entry-
458 * \return pointer to the modified/created Header Entry (NULL when creation
461 ValEntry *Document::ReplaceOrCreate(std::string const &value,
466 ValEntry *valEntry = 0;
467 DocEntry *currentEntry = GetDocEntry( group, elem);
471 valEntry = dynamic_cast< ValEntry* >(currentEntry);
475 if( valEntry->GetVR()!=vr )
478 // if currentEntry doesn't correspond to the requested valEntry
481 if (!RemoveEntry(currentEntry))
483 gdcmVerboseMacro( "Removal of previous DocEntry failed.");
490 // Create a new valEntry if necessary
493 valEntry = NewValEntry(group, elem, vr);
495 if ( !AddEntry(valEntry))
497 gdcmVerboseMacro("AddEntry failed although this is a creation.");
504 // Set the binEntry value
505 SetEntry(value, valEntry);
510 * \brief Modifies the value of a given Header Entry (Dicom Element)
511 * when it exists. Create it with the given value when unexistant.
512 * A copy of the binArea is made to be kept in the Document.
513 * @param binArea (binary) value to be set
514 * @param Group Group number of the Entry
515 * @param Elem Element number of the Entry
516 * @param vr V(alue) R(epresentation) of the Entry -if private Entry-
517 * \return pointer to the modified/created Header Entry (NULL when creation
520 BinEntry *Document::ReplaceOrCreate(uint8_t *binArea,
526 BinEntry *binEntry = 0;
527 DocEntry *currentEntry = GetDocEntry( group, elem);
529 // Verify the currentEntry
532 binEntry = dynamic_cast< BinEntry* >(currentEntry);
536 if( binEntry->GetVR()!=vr )
539 // if currentEntry doesn't correspond to the requested valEntry
542 if (!RemoveEntry(currentEntry))
544 gdcmVerboseMacro( "Removal of previous DocEntry failed.");
551 // Create a new binEntry if necessary
554 binEntry = NewBinEntry(group, elem, vr);
556 if ( !AddEntry(binEntry))
558 gdcmVerboseMacro( "AddEntry failed allthough this is a creation.");
565 // Set the binEntry value
567 if (lgth>0 && binArea)
569 tmpArea = new uint8_t[lgth];
570 memcpy(tmpArea,binArea,lgth);
576 if (!SetEntry(tmpArea,lgth,binEntry))
588 * \brief Modifies the value of a given Header Entry (Dicom Element)
589 * when it exists. Create it when unexistant.
590 * @param Group Group number of the Entry
591 * @param Elem Element number of the Entry
592 * \return pointer to the modified/created SeqEntry (NULL when creation
595 SeqEntry *Document::ReplaceOrCreate( uint16_t group, uint16_t elem)
597 SeqEntry *seqEntry = 0;
598 DocEntry *currentEntry = GetDocEntry( group, elem);
600 // Verify the currentEntry
603 seqEntry = dynamic_cast< SeqEntry* >(currentEntry);
607 if( seqEntry->GetVR()!="SQ" )
610 // if currentEntry doesn't correspond to the requested valEntry
613 if (!RemoveEntry(currentEntry))
615 gdcmVerboseMacro( "Removal of previous DocEntry failed.");
622 // Create a new seqEntry if necessary
625 seqEntry = NewSeqEntry(group, elem);
627 if ( !AddEntry(seqEntry))
629 gdcmVerboseMacro( "AddEntry failed allthough this is a creation.");
640 * \brief Set a new value if the invoked element exists
641 * Seems to be useless !!!
642 * @param value new element value
643 * @param group group number of the Entry
644 * @param elem element number of the Entry
647 bool Document::ReplaceIfExist(std::string const &value,
648 uint16_t group, uint16_t elem )
650 SetEntry(value, group, elem);
655 //-----------------------------------------------------------------------------
659 * \brief Checks if a given Dicom Element exists within the H table
660 * @param group Group number of the searched Dicom Element
661 * @param element Element number of the searched Dicom Element
662 * @return true is found
664 bool Document::CheckIfEntryExist(uint16_t group, uint16_t element )
666 const std::string &key = DictEntry::TranslateToKey(group, element );
667 return TagHT.count(key) != 0;
672 * \brief Searches within Header Entries (Dicom Elements) parsed with
673 * the public and private dictionaries
674 * for the element value representation of a given tag.
675 * @param group Group number of the searched tag.
676 * @param element Element number of the searched tag.
677 * @return Corresponding element value representation when it exists,
678 * and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise.
680 std::string Document::GetEntry(uint16_t group, uint16_t element)
682 TagKey key = DictEntry::TranslateToKey(group, element);
683 if ( !TagHT.count(key))
688 return ((ValEntry *)TagHT.find(key)->second)->GetValue();
692 * \brief Searches within Header Entries (Dicom Elements) parsed with
693 * the public and private dictionaries
694 * for the element value representation of a given tag..
696 * Obtaining the VR (Value Representation) might be needed by caller
697 * to convert the string typed content to caller's native type
698 * (think of C++ vs Python). The VR is actually of a higher level
699 * of semantics than just the native C++ type.
700 * @param group Group number of the searched tag.
701 * @param element Element number of the searched tag.
702 * @return Corresponding element value representation when it exists,
703 * and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise.
705 std::string Document::GetEntryVR(uint16_t group, uint16_t element)
707 DocEntry *elem = GetDocEntry(group, element);
712 return elem->GetVR();
716 * \brief Searches within Header Entries (Dicom Elements) parsed with
717 * the public and private dictionaries
718 * for the value length of a given tag..
719 * @param group Group number of the searched tag.
720 * @param element Element number of the searched tag.
721 * @return Corresponding element length; -2 if not found
723 int Document::GetEntryLength(uint16_t group, uint16_t element)
725 DocEntry *elem = GetDocEntry(group, element);
728 return -2; //magic number
730 return elem->GetLength();
734 * \brief Accesses an existing DocEntry (i.e. a Dicom Element)
735 * through it's (group, element) and modifies it's content with
737 * @param content new value (string) to substitute with
738 * @param group group number of the Dicom Element to modify
739 * @param element element number of the Dicom Element to modify
741 bool Document::SetEntry(std::string const& content,
742 uint16_t group, uint16_t element)
744 ValEntry *entry = GetValEntry(group, element);
747 gdcmVerboseMacro( "No corresponding ValEntry (try promotion first).");
750 return SetEntry(content,entry);
754 * \brief Accesses an existing DocEntry (i.e. a Dicom Element)
755 * through it's (group, element) and modifies it's content with
757 * @param content new value (void* -> uint8_t*) to substitute with
758 * @param lgth new value length
759 * @param group group number of the Dicom Element to modify
760 * @param element element number of the Dicom Element to modify
762 bool Document::SetEntry(uint8_t*content, int lgth,
763 uint16_t group, uint16_t element)
765 BinEntry *entry = GetBinEntry(group, element);
768 gdcmVerboseMacro( "No corresponding ValEntry (try promotion first).");
772 return SetEntry(content,lgth,entry);
776 * \brief Accesses an existing DocEntry (i.e. a Dicom Element)
777 * and modifies it's content with the given value.
778 * @param content new value (string) to substitute with
779 * @param entry Entry to be modified
781 bool Document::SetEntry(std::string const &content,ValEntry *entry)
785 entry->SetValue(content);
792 * \brief Accesses an existing BinEntry (i.e. a Dicom Element)
793 * and modifies it's content with the given value.
794 * @param content new value (void* -> uint8_t*) to substitute with
795 * @param entry Entry to be modified
796 * @param lgth new value length
798 bool Document::SetEntry(uint8_t *content, int lgth, BinEntry *entry)
802 // Hope Binary field length is *never* wrong
803 /*if(lgth%2) // Non even length are padded with a space (020H).
806 //content = content + '\0'; // fing a trick to enlarge a binary field?
809 entry->SetBinArea(content);
810 entry->SetLength(lgth);
811 entry->SetValue(GDCM_BINLOADED);
818 * \brief Gets (from Header) a 'non string' element value
819 * (LoadElementValues has already be executed)
820 * @param group group number of the Entry
821 * @param elem element number of the Entry
822 * @return Pointer to the 'non string' area
824 void *Document::GetEntryBinArea(uint16_t group, uint16_t elem)
826 DocEntry *entry = GetDocEntry(group, elem);
829 gdcmVerboseMacro( "No entry");
832 if ( BinEntry *binEntry = dynamic_cast<BinEntry*>(entry) )
834 return binEntry->GetBinArea();
841 * \brief Loads (from disk) the element content
842 * when a string is not suitable
843 * @param group group number of the Entry
844 * @param elem element number of the Entry
846 void Document::LoadEntryBinArea(uint16_t group, uint16_t elem)
848 // Search the corresponding DocEntry
849 DocEntry *docElement = GetDocEntry(group, elem);
853 BinEntry *binElement = dynamic_cast<BinEntry *>(docElement);
857 LoadEntryBinArea(binElement);
861 * \brief Loads (from disk) the element content
862 * when a string is not suitable
863 * @param element Entry whose binArea is going to be loaded
865 void Document::LoadEntryBinArea(BinEntry *element)
867 if(element->GetBinArea())
874 size_t o =(size_t)element->GetOffset();
875 Fp->seekg(o, std::ios::beg);
877 size_t l = element->GetLength();
878 uint8_t *a = new uint8_t[l];
881 gdcmVerboseMacro( "Cannot allocate a");
885 /// \todo check the result
886 Fp->read((char*)a, l);
887 if( Fp->fail() || Fp->eof())
893 element->SetBinArea(a);
900 * \brief Sets a 'non string' value to a given Dicom Element
901 * @param area area containing the 'non string' value
902 * @param group Group number of the searched Dicom Element
903 * @param element Element number of the searched Dicom Element
906 /*bool Document::SetEntryBinArea(uint8_t *area,
907 uint16_t group, uint16_t element)
909 DocEntry *currentEntry = GetDocEntry(group, element);
915 if ( BinEntry *binEntry = dynamic_cast<BinEntry*>(currentEntry) )
917 binEntry->SetBinArea( area );
925 * \brief retrieves a Dicom Element (the first one) using (group, element)
926 * \warning (group, element) IS NOT an identifier inside the Dicom Header
927 * if you think it's NOT UNIQUE, check the count number
928 * and use iterators to retrieve ALL the Dicoms Elements within
929 * a given couple (group, element)
930 * @param group Group number of the searched Dicom Element
931 * @param element Element number of the searched Dicom Element
934 DocEntry *Document::GetDocEntry(uint16_t group, uint16_t element)
936 TagKey key = DictEntry::TranslateToKey(group, element);
937 if ( !TagHT.count(key))
941 return TagHT.find(key)->second;
945 * \brief Same as \ref Document::GetDocEntry except it only
946 * returns a result when the corresponding entry is of type
948 * @return When present, the corresponding ValEntry.
950 ValEntry *Document::GetValEntry(uint16_t group, uint16_t element)
952 DocEntry *currentEntry = GetDocEntry(group, element);
957 if ( ValEntry *entry = dynamic_cast<ValEntry*>(currentEntry) )
961 gdcmVerboseMacro( "Unfound ValEntry.");
967 * \brief Same as \ref Document::GetDocEntry except it only
968 * returns a result when the corresponding entry is of type
970 * @return When present, the corresponding BinEntry.
972 BinEntry *Document::GetBinEntry(uint16_t group, uint16_t element)
974 DocEntry *currentEntry = GetDocEntry(group, element);
979 if ( BinEntry *entry = dynamic_cast<BinEntry*>(currentEntry) )
983 gdcmVerboseMacro( "Unfound BinEntry.");
989 * \brief Loads the element while preserving the current
990 * underlying file position indicator as opposed to
991 * to LoadDocEntry that modifies it.
992 * @param entry Header Entry whose value will be loaded.
995 void Document::LoadDocEntrySafe(DocEntry *entry)
999 long PositionOnEntry = Fp->tellg();
1000 LoadDocEntry(entry);
1001 Fp->seekg(PositionOnEntry, std::ios::beg);
1006 * \brief Swaps back the bytes of 4-byte long integer accordingly to
1008 * @return The properly swaped 32 bits integer.
1010 uint32_t Document::SwapLong(uint32_t a)
1017 a=( ((a<<24) & 0xff000000) | ((a<<8) & 0x00ff0000) |
1018 ((a>>8) & 0x0000ff00) | ((a>>24) & 0x000000ff) );
1021 a=( ((a<<16) & 0xffff0000) | ((a>>16) & 0x0000ffff) );
1024 a=( ((a<< 8) & 0xff00ff00) | ((a>>8) & 0x00ff00ff) );
1027 gdcmErrorMacro( "Unset swap code:" << SwapCode );
1034 * \brief Unswaps back the bytes of 4-byte long integer accordingly to
1036 * @return The properly unswaped 32 bits integer.
1038 uint32_t Document::UnswapLong(uint32_t a)
1044 * \brief Swaps the bytes so they agree with the processor order
1045 * @return The properly swaped 16 bits integer.
1047 uint16_t Document::SwapShort(uint16_t a)
1049 if ( SwapCode == 4321 || SwapCode == 2143 )
1051 a = ((( a << 8 ) & 0x0ff00 ) | (( a >> 8 ) & 0x00ff ) );
1057 * \brief Unswaps the bytes so they agree with the processor order
1058 * @return The properly unswaped 16 bits integer.
1060 uint16_t Document::UnswapShort(uint16_t a)
1062 return SwapShort(a);
1065 //-----------------------------------------------------------------------------
1069 * \brief Parses a DocEntrySet (Zero-level DocEntries or SQ Item DocEntries)
1070 * @return length of the parsed set.
1072 void Document::ParseDES(DocEntrySet *set, long offset,
1073 long l_max, bool delim_mode)
1075 DocEntry *newDocEntry = 0;
1076 ValEntry *newValEntry;
1077 BinEntry *newBinEntry;
1078 SeqEntry *newSeqEntry;
1084 if ( !delim_mode && ((long)(Fp->tellg())-offset) >= l_max)
1090 newDocEntry = ReadNextDocEntry( );
1097 vr = newDocEntry->GetVR();
1098 newValEntry = dynamic_cast<ValEntry*>(newDocEntry);
1099 newBinEntry = dynamic_cast<BinEntry*>(newDocEntry);
1100 newSeqEntry = dynamic_cast<SeqEntry*>(newDocEntry);
1102 if ( newValEntry || newBinEntry )
1106 if ( ! Global::GetVR()->IsVROfBinaryRepresentable(vr) )
1108 ////// Neither ValEntry NOR BinEntry: should mean UNKOWN VR
1109 gdcmVerboseMacro( std::hex << newDocEntry->GetGroup()
1110 << "|" << newDocEntry->GetElement()
1111 << " : Neither Valentry, nor BinEntry."
1112 "Probably unknown VR.");
1115 //////////////////// BinEntry or UNKOWN VR:
1116 // When "this" is a Document the Key is simply of the
1117 // form ( group, elem )...
1118 if (/*Document *dummy =*/ dynamic_cast< Document* > ( set ) )
1121 newBinEntry->SetKey( newBinEntry->GetKey() );
1123 // but when "this" is a SQItem, we are inserting this new
1124 // valEntry in a sequence item, and the key has the
1125 // generalized form (refer to \ref BaseTagKey):
1126 if (SQItem *parentSQItem = dynamic_cast< SQItem* > ( set ) )
1128 newBinEntry->SetKey( parentSQItem->GetBaseTagKey()
1129 + newBinEntry->GetKey() );
1132 LoadDocEntry( newBinEntry );
1133 if( !set->AddEntry( newBinEntry ) )
1135 //Expect big troubles if here
1136 //delete newBinEntry;
1142 /////////////////////// ValEntry
1143 // When "set" is a Document, then we are at the top of the
1144 // hierarchy and the Key is simply of the form ( group, elem )...
1145 if (/*Document *dummy =*/ dynamic_cast< Document* > ( set ) )
1148 newValEntry->SetKey( newValEntry->GetKey() );
1150 // ...but when "set" is a SQItem, we are inserting this new
1151 // valEntry in a sequence item. Hence the key has the
1152 // generalized form (refer to \ref BaseTagKey):
1153 if (SQItem *parentSQItem = dynamic_cast< SQItem* > ( set ) )
1155 newValEntry->SetKey( parentSQItem->GetBaseTagKey()
1156 + newValEntry->GetKey() );
1159 LoadDocEntry( newValEntry );
1160 bool delimitor=newValEntry->IsItemDelimitor();
1161 if( !set->AddEntry( newValEntry ) )
1163 // If here expect big troubles
1164 //delete newValEntry; //otherwise mem leak
1174 if ( !delim_mode && ((long)(Fp->tellg())-offset) >= l_max)
1182 if ( ( newDocEntry->GetGroup() == 0x7fe0 )
1183 && ( newDocEntry->GetElement() == 0x0010 ) )
1185 std::string ts = GetTransferSyntax();
1186 if ( Global::GetTS()->IsRLELossless(ts) )
1188 long positionOnEntry = Fp->tellg();
1189 Fp->seekg( newDocEntry->GetOffset(), std::ios::beg );
1191 Fp->seekg( positionOnEntry, std::ios::beg );
1193 else if ( Global::GetTS()->IsJPEG(ts) )
1195 long positionOnEntry = Fp->tellg();
1196 Fp->seekg( newDocEntry->GetOffset(), std::ios::beg );
1197 ComputeJPEGFragmentInfo();
1198 Fp->seekg( positionOnEntry, std::ios::beg );
1202 // Just to make sure we are at the beginning of next entry.
1203 SkipToNextDocEntry(newDocEntry);
1208 unsigned long l = newDocEntry->GetReadLength();
1209 if ( l != 0 ) // don't mess the delim_mode for zero-length sequence
1211 if ( l == 0xffffffff )
1220 // no other way to create it ...
1221 newSeqEntry->SetDelimitorMode( delim_mode );
1223 // At the top of the hierarchy, stands a Document. When "set"
1224 // is a Document, then we are building the first depth level.
1225 // Hence the SeqEntry we are building simply has a depth
1227 if (/*Document *dummy =*/ dynamic_cast< Document* > ( set ) )
1230 newSeqEntry->SetDepthLevel( 1 );
1231 newSeqEntry->SetKey( newSeqEntry->GetKey() );
1233 // But when "set" is already a SQItem, we are building a nested
1234 // sequence, and hence the depth level of the new SeqEntry
1235 // we are building, is one level deeper:
1236 if (SQItem *parentSQItem = dynamic_cast< SQItem* > ( set ) )
1238 newSeqEntry->SetDepthLevel( parentSQItem->GetDepthLevel() + 1 );
1239 newSeqEntry->SetKey( parentSQItem->GetBaseTagKey()
1240 + newSeqEntry->GetKey() );
1244 { // Don't try to parse zero-length sequences
1245 ParseSQ( newSeqEntry,
1246 newDocEntry->GetOffset(),
1249 set->AddEntry( newSeqEntry );
1250 if ( !delim_mode && ((long)(Fp->tellg())-offset) >= l_max)
1262 * \brief Parses a Sequence ( SeqEntry after SeqEntry)
1263 * @return parsed length for this level
1265 void Document::ParseSQ( SeqEntry *seqEntry,
1266 long offset, long l_max, bool delim_mode)
1268 int SQItemNumber = 0;
1270 long offsetStartCurrentSQItem = offset;
1274 // the first time, we read the fff0,e000 of the first SQItem
1275 DocEntry *newDocEntry = ReadNextDocEntry();
1279 // FIXME Should warn user
1284 if ( newDocEntry->IsSequenceDelimitor() )
1286 seqEntry->SetSequenceDelimitationItem( newDocEntry );
1290 if ( !delim_mode && ((long)(Fp->tellg())-offset) >= l_max)
1295 // create the current SQItem
1296 SQItem *itemSQ = new SQItem( seqEntry->GetDepthLevel() );
1297 std::ostringstream newBase;
1298 newBase << seqEntry->GetKey()
1302 itemSQ->SetBaseTagKey( newBase.str() );
1303 unsigned int l = newDocEntry->GetReadLength();
1305 if ( l == 0xffffffff )
1314 // when we're here, element fffe,e000 is already passed.
1315 // it's lost for the SQItem we're going to process !!
1317 //ParseDES(itemSQ, newDocEntry->GetOffset(), l, dlm_mod);
1318 //delete newDocEntry; // FIXME well ... it's too late to use it !
1320 // Let's try :------------
1321 // remove fff0,e000, created out of the SQItem
1323 Fp->seekg(offsetStartCurrentSQItem, std::ios::beg);
1324 // fill up the current SQItem, starting at the beginning of fff0,e000
1325 ParseDES(itemSQ, offsetStartCurrentSQItem, l+8, dlm_mod);
1326 offsetStartCurrentSQItem = Fp->tellg();
1327 // end try -----------------
1329 seqEntry->AddEntry( itemSQ, SQItemNumber );
1331 if ( !delim_mode && ((long)(Fp->tellg())-offset ) >= l_max )
1339 * \brief Loads the element content if its length doesn't exceed
1340 * the value specified with Document::SetMaxSizeLoadEntry()
1341 * @param entry Header Entry (Dicom Element) to be dealt with
1343 void Document::LoadDocEntry(DocEntry *entry)
1345 uint16_t group = entry->GetGroup();
1346 std::string vr = entry->GetVR();
1347 uint32_t length = entry->GetLength();
1349 Fp->seekg((long)entry->GetOffset(), std::ios::beg);
1351 // A SeQuence "contains" a set of Elements.
1352 // (fffe e000) tells us an Element is beginning
1353 // (fffe e00d) tells us an Element just ended
1354 // (fffe e0dd) tells us the current SeQuence just ended
1355 if( group == 0xfffe )
1357 // NO more value field for SQ !
1361 // When the length is zero things are easy:
1364 ((ValEntry *)entry)->SetValue("");
1368 // The elements whose length is bigger than the specified upper bound
1369 // are not loaded. Instead we leave a short notice of the offset of
1370 // the element content and it's length.
1372 std::ostringstream s;
1373 if (length > MaxSizeLoadEntry)
1375 if (BinEntry *binEntryPtr = dynamic_cast< BinEntry* >(entry) )
1377 //s << "gdcm::NotLoaded (BinEntry)";
1378 s << GDCM_NOTLOADED;
1379 s << " Address:" << (long)entry->GetOffset();
1380 s << " Length:" << entry->GetLength();
1381 s << " x(" << std::hex << entry->GetLength() << ")";
1382 binEntryPtr->SetValue(s.str());
1384 // Be carefull : a BinEntry IS_A ValEntry ...
1385 else if (ValEntry *valEntryPtr = dynamic_cast< ValEntry* >(entry) )
1387 // s << "gdcm::NotLoaded. (ValEntry)";
1388 s << GDCM_NOTLOADED;
1389 s << " Address:" << (long)entry->GetOffset();
1390 s << " Length:" << entry->GetLength();
1391 s << " x(" << std::hex << entry->GetLength() << ")";
1392 valEntryPtr->SetValue(s.str());
1397 gdcmErrorMacro( "MaxSizeLoadEntry exceeded, neither a BinEntry "
1398 << "nor a ValEntry ?! Should never print that !" );
1401 // to be sure we are at the end of the value ...
1402 Fp->seekg((long)entry->GetOffset()+(long)entry->GetLength(),
1407 // When we find a BinEntry not very much can be done :
1408 if (BinEntry *binEntryPtr = dynamic_cast< BinEntry* >(entry) )
1410 s << GDCM_BINLOADED;
1411 binEntryPtr->SetValue(s.str());
1412 LoadEntryBinArea(binEntryPtr); // last one, not to erase length !
1416 /// \todo Any compacter code suggested (?)
1417 if ( IsDocEntryAnInteger(entry) )
1421 // When short integer(s) are expected, read and convert the following
1422 // n *two characters properly i.e. consider them as short integers as
1423 // opposed to strings.
1424 // Elements with Value Multiplicity > 1
1425 // contain a set of integers (not a single one)
1426 if (vr == "US" || vr == "SS")
1429 NewInt = ReadInt16();
1433 for (int i=1; i < nbInt; i++)
1436 NewInt = ReadInt16();
1441 // See above comment on multiple integers (mutatis mutandis).
1442 else if (vr == "UL" || vr == "SL")
1445 NewInt = ReadInt32();
1449 for (int i=1; i < nbInt; i++)
1452 NewInt = ReadInt32();
1457 #ifdef GDCM_NO_ANSI_STRING_STREAM
1458 s << std::ends; // to avoid oddities on Solaris
1459 #endif //GDCM_NO_ANSI_STRING_STREAM
1461 ((ValEntry *)entry)->SetValue(s.str());
1465 // FIXME: We need an additional byte for storing \0 that is not on disk
1466 char *str = new char[length+1];
1467 Fp->read(str, (size_t)length);
1468 str[length] = '\0'; //this is only useful when length is odd
1469 // Special DicomString call to properly handle \0 and even length
1470 std::string newValue;
1473 newValue = Util::DicomString(str, length+1);
1474 gdcmVerboseMacro("Warning: bad length: " << length <<
1475 ",For string :" << newValue.c_str());
1476 // Since we change the length of string update it length
1477 //entry->SetReadLength(length+1);
1481 newValue = Util::DicomString(str, length);
1485 if ( ValEntry *valEntry = dynamic_cast<ValEntry* >(entry) )
1487 if ( Fp->fail() || Fp->eof())
1489 gdcmVerboseMacro("Unread element value");
1490 valEntry->SetValue(GDCM_UNREAD);
1496 // Because of correspondance with the VR dic
1497 valEntry->SetValue(newValue);
1501 valEntry->SetValue(newValue);
1506 gdcmErrorMacro( "Should have a ValEntry, here !");
1512 * \brief Find the value Length of the passed Header Entry
1513 * @param entry Header Entry whose length of the value shall be loaded.
1515 void Document::FindDocEntryLength( DocEntry *entry )
1516 throw ( FormatError )
1518 std::string vr = entry->GetVR();
1521 if ( Filetype == ExplicitVR && !entry->IsImplicitVR() )
1523 if ( vr == "OB" || vr == "OW" || vr == "SQ" || vr == "UN" )
1525 // The following reserved two bytes (see PS 3.5-2003, section
1526 // "7.1.2 Data element structure with explicit vr", p 27) must be
1527 // skipped before proceeding on reading the length on 4 bytes.
1528 Fp->seekg( 2L, std::ios::cur);
1529 uint32_t length32 = ReadInt32();
1531 if ( (vr == "OB" || vr == "OW") && length32 == 0xffffffff )
1536 lengthOB = FindDocEntryLengthOBOrOW();
1538 catch ( FormatUnexpected )
1540 // Computing the length failed (this happens with broken
1541 // files like gdcm-JPEG-LossLess3a.dcm). We still have a
1542 // chance to get the pixels by deciding the element goes
1543 // until the end of the file. Hence we artificially fix the
1544 // the length and proceed.
1545 long currentPosition = Fp->tellg();
1546 Fp->seekg(0L,std::ios::end);
1548 long lengthUntilEOF = (long)(Fp->tellg())-currentPosition;
1549 Fp->seekg(currentPosition, std::ios::beg);
1551 entry->SetReadLength(lengthUntilEOF);
1552 entry->SetLength(lengthUntilEOF);
1555 entry->SetReadLength(lengthOB);
1556 entry->SetLength(lengthOB);
1559 FixDocEntryFoundLength(entry, length32);
1563 // Length is encoded on 2 bytes.
1564 length16 = ReadInt16();
1566 // FIXME : This heuristic supposes that the first group following
1567 // group 0002 *has* and element 0000.
1568 // BUT ... Element 0000 is optionnal :-(
1571 // Fixed using : HandleOutOfGroup0002()
1572 // (first hereafter strategy ...)
1574 // We can tell the current file is encoded in big endian (like
1575 // Data/US-RGB-8-epicard) when we find the "Transfer Syntax" tag
1576 // and it's value is the one of the encoding of a big endian file.
1577 // In order to deal with such big endian encoded files, we have
1578 // (at least) two strategies:
1579 // * when we load the "Transfer Syntax" tag with value of big endian
1580 // encoding, we raise the proper flags. Then we wait for the end
1581 // of the META group (0x0002) among which is "Transfer Syntax",
1582 // before switching the swap code to big endian. We have to postpone
1583 // the switching of the swap code since the META group is fully encoded
1584 // in little endian, and big endian coding only starts at the next
1585 // group. The corresponding code can be hard to analyse and adds
1586 // many additional unnecessary tests for regular tags.
1587 // * the second strategy consists in waiting for trouble, that shall
1588 // appear when we find the first group with big endian encoding. This
1589 // is easy to detect since the length of a "Group Length" tag (the
1590 // ones with zero as element number) has to be of 4 (0x0004). When we
1591 // encounter 1024 (0x0400) chances are the encoding changed and we
1592 // found a group with big endian encoding.
1593 //---> Unfortunately, element 0000 is optional.
1594 //---> This will not work when missing!
1595 // We shall use this second strategy. In order to make sure that we
1596 // can interpret the presence of an apparently big endian encoded
1597 // length of a "Group Length" without committing a big mistake, we
1598 // add an additional check: we look in the already parsed elements
1599 // for the presence of a "Transfer Syntax" whose value has to be "big
1600 // endian encoding". When this is the case, chances are we have got our
1601 // hands on a big endian encoded file: we switch the swap code to
1602 // big endian and proceed...
1605 // if ( element == 0x0000 && length16 == 0x0400 )
1607 // std::string ts = GetTransferSyntax();
1608 // if ( Global::GetTS()->GetSpecialTransferSyntax(ts)
1609 // != TS::ExplicitVRBigEndian )
1611 // throw FormatError( "Document::FindDocEntryLength()",
1612 // " not explicit VR." );
1616 // SwitchByteSwapCode();
1618 // Restore the unproperly loaded values i.e. the group, the element
1619 // and the dictionary entry depending on them.
1620 // uint16_t correctGroup = SwapShort( entry->GetGroup() );
1621 // uint16_t correctElem = SwapShort( entry->GetElement() );
1622 // DictEntry *newTag = GetDictEntry( correctGroup, correctElem ); if ( !newTag )
1624 // This correct tag is not in the dictionary. Create a new one.
1625 // newTag = NewVirtualDictEntry(correctGroup, correctElem);
1627 // FIXME this can create a memory leaks on the old entry that be
1628 // left unreferenced.
1629 // entry->SetDictEntry( newTag );
1633 // 0xffff means that we deal with 'No Length' Sequence
1634 // or 'No Length' SQItem
1635 if ( length16 == 0xffff)
1639 FixDocEntryFoundLength( entry, (uint32_t)length16 );
1644 // Either implicit VR or a non DICOM conformal (see note below) explicit
1645 // VR that ommited the VR of (at least) this element. Farts happen.
1646 // [Note: according to the part 5, PS 3.5-2001, section 7.1 p25
1647 // on Data elements "Implicit and Explicit VR Data Elements shall
1648 // not coexist in a Data Set and Data Sets nested within it".]
1649 // Length is on 4 bytes.
1651 FixDocEntryFoundLength( entry, ReadInt32() );
1657 * \brief Find the Value Representation of the current Dicom Element.
1658 * @return Value Representation of the current Entry
1660 std::string Document::FindDocEntryVR()
1662 if ( Filetype != ExplicitVR )
1663 return GDCM_UNKNOWN;
1665 long positionOnEntry = Fp->tellg();
1666 // Warning: we believe this is explicit VR (Value Representation) because
1667 // we used a heuristic that found "UL" in the first tag. Alas this
1668 // doesn't guarantee that all the tags will be in explicit VR. In some
1669 // cases (see e-film filtered files) one finds implicit VR tags mixed
1670 // within an explicit VR file. Hence we make sure the present tag
1671 // is in explicit VR and try to fix things if it happens not to be
1675 Fp->read (vr, (size_t)2);
1678 if( !CheckDocEntryVR(vr) )
1680 Fp->seekg(positionOnEntry, std::ios::beg);
1681 return GDCM_UNKNOWN;
1687 * \brief Check the correspondance between the VR of the header entry
1688 * and the taken VR. If they are different, the header entry is
1689 * updated with the new VR.
1690 * @param vr Dicom Value Representation
1691 * @return false if the VR is incorrect of if the VR isn't referenced
1692 * otherwise, it returns true
1694 bool Document::CheckDocEntryVR(VRKey vr)
1696 // CLEANME searching the dicom_vr at each occurence is expensive.
1697 // PostPone this test in an optional integrity check at the end
1698 // of parsing or only in debug mode.
1699 if ( !Global::GetVR()->IsValidVR(vr) )
1706 * \brief Get the transformed value of the header entry. The VR value
1707 * is used to define the transformation to operate on the value
1708 * \warning NOT end user intended method !
1709 * @param entry entry to tranform
1710 * @return Transformed entry value
1712 std::string Document::GetDocEntryValue(DocEntry *entry)
1714 if ( IsDocEntryAnInteger(entry) && entry->IsImplicitVR() )
1716 std::string val = ((ValEntry *)entry)->GetValue();
1717 std::string vr = entry->GetVR();
1718 uint32_t length = entry->GetLength();
1719 std::ostringstream s;
1722 // When short integer(s) are expected, read and convert the following
1723 // n * 2 bytes properly i.e. as a multivaluated strings
1724 // (each single value is separated fromthe next one by '\'
1725 // as usual for standard multivaluated filels
1726 // Elements with Value Multiplicity > 1
1727 // contain a set of short integers (not a single one)
1729 if( vr == "US" || vr == "SS" )
1734 for (int i=0; i < nbInt; i++)
1740 newInt16 = ( val[2*i+0] & 0xFF ) + ( ( val[2*i+1] & 0xFF ) << 8);
1741 newInt16 = SwapShort( newInt16 );
1746 // When integer(s) are expected, read and convert the following
1747 // n * 4 bytes properly i.e. as a multivaluated strings
1748 // (each single value is separated fromthe next one by '\'
1749 // as usual for standard multivaluated filels
1750 // Elements with Value Multiplicity > 1
1751 // contain a set of integers (not a single one)
1752 else if( vr == "UL" || vr == "SL" )
1757 for (int i=0; i < nbInt; i++)
1763 newInt32 = ( val[4*i+0] & 0xFF )
1764 + (( val[4*i+1] & 0xFF ) << 8 )
1765 + (( val[4*i+2] & 0xFF ) << 16 )
1766 + (( val[4*i+3] & 0xFF ) << 24 );
1767 newInt32 = SwapLong( newInt32 );
1771 #ifdef GDCM_NO_ANSI_STRING_STREAM
1772 s << std::ends; // to avoid oddities on Solaris
1773 #endif //GDCM_NO_ANSI_STRING_STREAM
1777 return ((ValEntry *)entry)->GetValue();
1781 * \brief Get the reverse transformed value of the header entry. The VR
1782 * value is used to define the reverse transformation to operate on
1784 * \warning NOT end user intended method !
1785 * @param entry Entry to reverse transform
1786 * @return Reverse transformed entry value
1788 std::string Document::GetDocEntryUnvalue(DocEntry *entry)
1790 if ( IsDocEntryAnInteger(entry) && entry->IsImplicitVR() )
1792 std::string vr = entry->GetVR();
1793 std::vector<std::string> tokens;
1794 std::ostringstream s;
1796 if ( vr == "US" || vr == "SS" )
1800 tokens.erase( tokens.begin(), tokens.end()); // clean any previous value
1801 Util::Tokenize (((ValEntry *)entry)->GetValue(), tokens, "\\");
1802 for (unsigned int i=0; i<tokens.size(); i++)
1804 newInt16 = atoi(tokens[i].c_str());
1805 s << ( newInt16 & 0xFF )
1806 << (( newInt16 >> 8 ) & 0xFF );
1810 if ( vr == "UL" || vr == "SL")
1814 tokens.erase(tokens.begin(),tokens.end()); // clean any previous value
1815 Util::Tokenize (((ValEntry *)entry)->GetValue(), tokens, "\\");
1816 for (unsigned int i=0; i<tokens.size();i++)
1818 newInt32 = atoi(tokens[i].c_str());
1819 s << (char)( newInt32 & 0xFF )
1820 << (char)(( newInt32 >> 8 ) & 0xFF )
1821 << (char)(( newInt32 >> 16 ) & 0xFF )
1822 << (char)(( newInt32 >> 24 ) & 0xFF );
1827 #ifdef GDCM_NO_ANSI_STRING_STREAM
1828 s << std::ends; // to avoid oddities on Solaris
1829 #endif //GDCM_NO_ANSI_STRING_STREAM
1833 return ((ValEntry *)entry)->GetValue();
1837 * \brief Skip a given Header Entry
1838 * \warning NOT end user intended method !
1839 * @param entry entry to skip
1841 void Document::SkipDocEntry(DocEntry *entry)
1843 SkipBytes(entry->GetLength());
1847 * \brief Skips to the begining of the next Header Entry
1848 * \warning NOT end user intended method !
1849 * @param currentDocEntry entry to skip
1851 void Document::SkipToNextDocEntry(DocEntry *currentDocEntry)
1853 Fp->seekg((long)(currentDocEntry->GetOffset()), std::ios::beg);
1854 if (currentDocEntry->GetGroup() != 0xfffe) // for fffe pb
1855 Fp->seekg( (long)(currentDocEntry->GetReadLength()),std::ios::cur);
1859 * \brief When the length of an element value is obviously wrong (because
1860 * the parser went Jabberwocky) one can hope improving things by
1861 * applying some heuristics.
1862 * @param entry entry to check
1863 * @param foundLength first assumption about length
1865 void Document::FixDocEntryFoundLength(DocEntry *entry,
1866 uint32_t foundLength)
1868 entry->SetReadLength( foundLength ); // will be updated only if a bug is found
1869 if ( foundLength == 0xffffffff)
1874 uint16_t gr = entry->GetGroup();
1875 uint16_t elem = entry->GetElement();
1877 if ( foundLength % 2)
1879 gdcmVerboseMacro( "Warning : Tag with uneven length " << foundLength
1880 << " in x(" << std::hex << gr << "," << elem <<")");
1883 //////// Fix for some naughty General Electric images.
1884 // Allthough not recent many such GE corrupted images are still present
1885 // on Creatis hard disks. Hence this fix shall remain when such images
1886 // are no longer in use (we are talking a few years, here)...
1887 // Note: XMedCom probably uses such a trick since it is able to read
1888 // those pesky GE images ...
1889 if ( foundLength == 13)
1891 // Only happens for this length !
1892 if ( gr != 0x0008 || ( elem != 0x0070 && elem != 0x0080 ) )
1895 entry->SetReadLength(10); /// \todo a bug is to be fixed !?
1899 //////// Fix for some brain-dead 'Leonardo' Siemens images.
1900 // Occurence of such images is quite low (unless one leaves close to a
1901 // 'Leonardo' source. Hence, one might consider commenting out the
1902 // following fix on efficiency reasons.
1903 else if ( gr == 0x0009 && ( elem == 0x1113 || elem == 0x1114 ) )
1906 entry->SetReadLength(4); /// \todo a bug is to be fixed !?
1909 else if ( entry->GetVR() == "SQ" )
1911 foundLength = 0; // ReadLength is unchanged
1914 //////// We encountered a 'delimiter' element i.e. a tag of the form
1915 // "fffe|xxxx" which is just a marker. Delimiters length should not be
1916 // taken into account.
1917 else if( gr == 0xfffe )
1919 // According to the norm, fffe|0000 shouldn't exist. BUT the Philips
1920 // image gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm happens to
1921 // causes extra troubles...
1922 if( entry->GetElement() != 0x0000 )
1928 entry->SetLength(foundLength);
1932 * \brief Apply some heuristics to predict whether the considered
1933 * element value contains/represents an integer or not.
1934 * @param entry The element value on which to apply the predicate.
1935 * @return The result of the heuristical predicate.
1937 bool Document::IsDocEntryAnInteger(DocEntry *entry)
1939 uint16_t elem = entry->GetElement();
1940 uint16_t group = entry->GetGroup();
1941 const std::string &vr = entry->GetVR();
1942 uint32_t length = entry->GetLength();
1944 // When we have some semantics on the element we just read, and if we
1945 // a priori know we are dealing with an integer, then we shall be
1946 // able to swap it's element value properly.
1947 if ( elem == 0 ) // This is the group length of the group
1955 // Allthough this should never happen, still some images have a
1956 // corrupted group length [e.g. have a glance at offset x(8336) of
1957 // gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm].
1958 // Since for dicom compliant and well behaved headers, the present
1959 // test is useless (and might even look a bit paranoid), when we
1960 // encounter such an ill-formed image, we simply display a warning
1961 // message and proceed on parsing (while crossing fingers).
1962 long filePosition = Fp->tellg();
1963 gdcmVerboseMacro( "Erroneous Group Length element length on : ("
1964 << std::hex << group << " , " << elem
1965 << ") -before- position x(" << filePosition << ")"
1966 << "lgt : " << length );
1970 if ( vr == "UL" || vr == "US" || vr == "SL" || vr == "SS" )
1978 * \brief Find the Length till the next sequence delimiter
1979 * \warning NOT end user intended method !
1983 uint32_t Document::FindDocEntryLengthOBOrOW()
1984 throw( FormatUnexpected )
1986 // See PS 3.5-2001, section A.4 p. 49 on encapsulation of encoded pixel data.
1987 long positionOnEntry = Fp->tellg();
1988 bool foundSequenceDelimiter = false;
1989 uint32_t totalLength = 0;
1991 while ( !foundSequenceDelimiter )
1997 group = ReadInt16();
2000 catch ( FormatError )
2002 throw FormatError("Unexpected end of file encountered during ",
2003 "Document::FindDocEntryLengthOBOrOW()");
2006 // We have to decount the group and element we just read
2009 if ( group != 0xfffe || ( ( elem != 0xe0dd ) && ( elem != 0xe000 ) ) )
2011 long filePosition = Fp->tellg();
2012 gdcmVerboseMacro( "Neither an Item tag nor a Sequence delimiter tag on :"
2013 << std::hex << group << " , " << elem
2014 << ") -before- position x(" << filePosition << ")" );
2016 Fp->seekg(positionOnEntry, std::ios::beg);
2017 throw FormatUnexpected( "Neither an Item tag nor a Sequence delimiter tag.");
2020 if ( elem == 0xe0dd )
2022 foundSequenceDelimiter = true;
2025 uint32_t itemLength = ReadInt32();
2026 // We add 4 bytes since we just read the ItemLength with ReadInt32
2027 totalLength += itemLength + 4;
2028 SkipBytes(itemLength);
2030 if ( foundSequenceDelimiter )
2035 Fp->seekg( positionOnEntry, std::ios::beg);
2040 * \brief Reads a supposed to be 16 Bits integer
2041 * (swaps it depending on processor endianity)
2042 * @return read value
2044 uint16_t Document::ReadInt16()
2045 throw( FormatError )
2048 Fp->read ((char*)&g, (size_t)2);
2051 throw FormatError( "Document::ReadInt16()", " file error." );
2055 throw FormatError( "Document::ReadInt16()", "EOF." );
2062 * \brief Reads a supposed to be 32 Bits integer
2063 * (swaps it depending on processor endianity)
2064 * @return read value
2066 uint32_t Document::ReadInt32()
2067 throw( FormatError )
2070 Fp->read ((char*)&g, (size_t)4);
2073 throw FormatError( "Document::ReadInt32()", " file error." );
2077 throw FormatError( "Document::ReadInt32()", "EOF." );
2084 * \brief skips bytes inside the source file
2085 * \warning NOT end user intended method !
2088 void Document::SkipBytes(uint32_t nBytes)
2090 //FIXME don't dump the returned value
2091 Fp->seekg((long)nBytes, std::ios::cur);
2095 * \brief Loads all the needed Dictionaries
2096 * \warning NOT end user intended method !
2098 void Document::Initialise()
2100 RefPubDict = Global::GetDicts()->GetDefaultPubDict();
2102 RLEInfo = new RLEFramesInfo;
2103 JPEGInfo = new JPEGFragmentsInfo;
2108 * \brief Discover what the swap code is (among little endian, big endian,
2109 * bad little endian, bad big endian).
2111 * @return false when we are absolutely sure
2112 * it's neither ACR-NEMA nor DICOM
2113 * true when we hope ours assuptions are OK
2115 bool Document::CheckSwap()
2117 // The only guaranted way of finding the swap code is to find a
2118 // group tag since we know it's length has to be of four bytes i.e.
2119 // 0x00000004. Finding the swap code in then straigthforward. Trouble
2120 // occurs when we can't find such group...
2122 uint32_t x = 4; // x : for ntohs
2123 bool net2host; // true when HostByteOrder is the same as NetworkByteOrder
2129 // First, compare HostByteOrder and NetworkByteOrder in order to
2130 // determine if we shall need to swap bytes (i.e. the Endian type).
2131 if ( x == ntohs(x) )
2140 // The easiest case is the one of a 'true' DICOM header, we just have
2141 // to look for the string "DICM" inside the file preamble.
2144 char *entCur = deb + 128;
2145 if( memcmp(entCur, "DICM", (size_t)4) == 0 )
2147 gdcmVerboseMacro( "Looks like DICOM Version3 (preamble + DCM)" );
2149 // Group 0002 should always be VR, and the first element 0000
2150 // Let's be carefull (so many wrong headers ...)
2151 // and determine the value representation (VR) :
2152 // Let's skip to the first element (0002,0000) and check there if we find
2153 // "UL" - or "OB" if the 1st one is (0002,0001) -,
2154 // in which case we (almost) know it is explicit VR.
2155 // WARNING: if it happens to be implicit VR then what we will read
2156 // is the length of the group. If this ascii representation of this
2157 // length happens to be "UL" then we shall believe it is explicit VR.
2158 // We need to skip :
2159 // * the 128 bytes of File Preamble (often padded with zeroes),
2160 // * the 4 bytes of "DICM" string,
2161 // * the 4 bytes of the first tag (0002, 0000),or (0002, 0001)
2162 // i.e. a total of 136 bytes.
2165 // group 0x0002 *is always* Explicit VR Sometimes ,
2166 // even if elem 0002,0010 (Transfer Syntax) tells us the file is
2167 // *Implicit* VR (see former 'gdcmData/icone.dcm')
2169 if( memcmp(entCur, "UL", (size_t)2) == 0 ||
2170 memcmp(entCur, "OB", (size_t)2) == 0 ||
2171 memcmp(entCur, "UI", (size_t)2) == 0 ||
2172 memcmp(entCur, "CS", (size_t)2) == 0 ) // CS, to remove later
2173 // when Write DCM *adds*
2175 // Use Document::dicom_vr to test all the possibilities
2176 // instead of just checking for UL, OB and UI !? group 0000
2178 Filetype = ExplicitVR;
2179 gdcmVerboseMacro( "Group 0002 : Explicit Value Representation");
2183 Filetype = ImplicitVR;
2184 gdcmVerboseMacro( "Group 0002 :Not an explicit Value Representation;"
2185 << "Looks like a bugged Header!");
2191 gdcmVerboseMacro( "HostByteOrder != NetworkByteOrder");
2196 gdcmVerboseMacro( "HostByteOrder = NetworkByteOrder");
2199 // Position the file position indicator at first tag
2200 // (i.e. after the file preamble and the "DICM" string).
2201 Fp->seekg(0, std::ios::beg);
2202 Fp->seekg ( 132L, std::ios::beg);
2206 // Alas, this is not a DicomV3 file and whatever happens there is no file
2207 // preamble. We can reset the file position indicator to where the data
2208 // is (i.e. the beginning of the file).
2209 gdcmVerboseMacro( "Not a DICOM Version3 file");
2210 Fp->seekg(0, std::ios::beg);
2212 // Our next best chance would be to be considering a 'clean' ACR/NEMA file.
2213 // By clean we mean that the length of the first tag is written down.
2214 // If this is the case and since the length of the first group HAS to be
2215 // four (bytes), then determining the proper swap code is straightforward.
2218 // We assume the array of char we are considering contains the binary
2219 // representation of a 32 bits integer. Hence the following dirty
2221 s32 = *((uint32_t *)(entCur));
2242 // We are out of luck. It is not a DicomV3 nor a 'clean' ACR/NEMA file.
2243 // It is time for despaired wild guesses.
2244 // So, let's check if this file wouldn't happen to be 'dirty' ACR/NEMA,
2245 // i.e. the 'group length' element is not present :
2247 // check the supposed-to-be 'group number'
2248 // in ( 0x0001 .. 0x0008 )
2249 // to determine ' SwapCode' value .
2250 // Only 0 or 4321 will be possible
2251 // (no oportunity to check for the formerly well known
2252 // ACR-NEMA 'Bad Big Endian' or 'Bad Little Endian'
2253 // if unsuccessfull (i.e. neither 0x0002 nor 0x0200 etc -3, 4, ..., 8-)
2254 // the file IS NOT ACR-NEMA nor DICOM V3
2255 // Find a trick to tell it the caller...
2257 s16 = *((uint16_t *)(deb));
2284 gdcmVerboseMacro( "ACR/NEMA unfound swap info (Really hopeless !)");
2294 * \brief Change the Byte Swap code.
2296 void Document::SwitchByteSwapCode()
2298 gdcmVerboseMacro( "Switching Byte Swap code from "<< SwapCode);
2299 if ( SwapCode == 1234 )
2303 else if ( SwapCode == 4321 )
2307 else if ( SwapCode == 3412 )
2311 else if ( SwapCode == 2143 )
2318 * \brief during parsing, Header Elements too long are not loaded in memory
2321 void Document::SetMaxSizeLoadEntry(long newSize)
2327 if ((uint32_t)newSize >= (uint32_t)0xffffffff )
2329 MaxSizeLoadEntry = 0xffffffff;
2332 MaxSizeLoadEntry = newSize;
2337 * \brief Header Elements too long will not be printed
2338 * \todo See comments of \ref Document::MAX_SIZE_PRINT_ELEMENT_VALUE
2341 void Document::SetMaxSizePrintEntry(long newSize)
2343 //DOH !! This is exactly SetMaxSizeLoadEntry FIXME FIXME
2348 if ((uint32_t)newSize >= (uint32_t)0xffffffff )
2350 MaxSizePrintEntry = 0xffffffff;
2353 MaxSizePrintEntry = newSize;
2359 * \brief Handle broken private tag from Philips NTSCAN
2360 * where the endianess is being switch to BigEndian for no
2364 void Document::HandleBrokenEndian(uint16_t &group, uint16_t &elem)
2366 // Endian reversion. Some files contain groups of tags with reversed endianess.
2367 static int reversedEndian = 0;
2368 // try to fix endian switching in the middle of headers
2369 if ((group == 0xfeff) && (elem == 0x00e0))
2371 // start endian swap mark for group found
2373 SwitchByteSwapCode();
2378 else if (group == 0xfffe && elem == 0xe00d && reversedEndian)
2380 // end of reversed endian group
2382 SwitchByteSwapCode();
2387 * \brief Accesses the info from 0002,0010 : Transfer Syntax and TS
2389 * @return The full Transfer Syntax Name (as opposed to Transfer Syntax UID)
2391 std::string Document::GetTransferSyntaxName()
2393 // use the TS (TS : Transfer Syntax)
2394 std::string transferSyntax = GetEntry(0x0002,0x0010);
2396 if ( (transferSyntax.find(GDCM_NOTLOADED) < transferSyntax.length()) )
2398 gdcmErrorMacro( "Transfer Syntax not loaded. " << std::endl
2399 << "Better you increase MAX_SIZE_LOAD_ELEMENT_VALUE" );
2400 return "Uncompressed ACR-NEMA";
2402 if ( transferSyntax == GDCM_UNFOUND )
2404 gdcmVerboseMacro( "Unfound Transfer Syntax (0002,0010)");
2405 return "Uncompressed ACR-NEMA";
2408 // we do it only when we need it
2409 const TSKey &tsName = Global::GetTS()->GetValue( transferSyntax );
2411 // Global::GetTS() is a global static you shall never try to delete it!
2416 * \brief Group 0002 is always coded Little Endian
2417 * whatever Transfer Syntax is
2420 void Document::HandleOutOfGroup0002(uint16_t &group, uint16_t &elem)
2422 // Endian reversion. Some files contain groups of tags with reversed endianess.
2423 if ( !Group0002Parsed && group != 0x0002)
2425 Group0002Parsed = true;
2426 // we just came out of group 0002
2427 // if Transfer syntax is Big Endian we have to change CheckSwap
2429 std::string ts = GetTransferSyntax();
2430 if ( !Global::GetTS()->IsTransferSyntax(ts) )
2432 gdcmVerboseMacro("True DICOM File, with NO Tansfer Syntax: " << ts );
2436 // FIXME Strangely, this works with
2437 //'Implicit VR Transfer Syntax (GE Private)
2438 if ( Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ExplicitVRBigEndian )
2440 gdcmVerboseMacro("Transfer Syntax Name = ["
2441 << GetTransferSyntaxName() << "]" );
2442 SwitchByteSwapCode();
2443 group = SwapShort(group);
2444 elem = SwapShort(elem);
2450 * \brief Read the next tag but WITHOUT loading it's value
2451 * (read the 'Group Number', the 'Element Number',
2452 * gets the Dict Entry
2453 * gets the VR, gets the length, gets the offset value)
2454 * @return On succes the newly created DocEntry, NULL on failure.
2456 DocEntry *Document::ReadNextDocEntry()
2463 group = ReadInt16();
2466 catch ( FormatError e )
2468 // We reached the EOF (or an error occured) therefore
2469 // header parsing has to be considered as finished.
2474 // Sometimes file contains groups of tags with reversed endianess.
2475 HandleBrokenEndian(group, elem);
2477 // In 'true DICOM' files Group 0002 is always little endian
2478 if ( HasDCMPreamble )
2479 HandleOutOfGroup0002(group, elem);
2481 std::string vr = FindDocEntryVR();
2482 std::string realVR = vr;
2484 if( vr == GDCM_UNKNOWN)
2486 DictEntry *dictEntry = GetDictEntry(group,elem);
2488 realVR = dictEntry->GetVR();
2492 if( Global::GetVR()->IsVROfSequence(realVR) )
2493 newEntry = NewSeqEntry(group, elem);
2494 else if( Global::GetVR()->IsVROfStringRepresentable(realVR) )
2495 newEntry = NewValEntry(group, elem,vr);
2497 newEntry = NewBinEntry(group, elem,vr);
2499 if( vr == GDCM_UNKNOWN )
2501 if( Filetype == ExplicitVR )
2503 // We thought this was explicit VR, but we end up with an
2504 // implicit VR tag. Let's backtrack.
2505 if ( newEntry->GetGroup() != 0xfffe )
2508 msg = Util::Format("Entry (%04x,%04x) should be Explicit VR\n",
2509 newEntry->GetGroup(), newEntry->GetElement());
2510 gdcmVerboseMacro( msg.c_str() );
2513 newEntry->SetImplicitVR();
2518 FindDocEntryLength(newEntry);
2520 catch ( FormatError e )
2528 newEntry->SetOffset(Fp->tellg());
2535 * \brief Generate a free TagKey i.e. a TagKey that is not present
2536 * in the TagHt dictionary.
2537 * @param group The generated tag must belong to this group.
2538 * @return The element of tag with given group which is fee.
2540 uint32_t Document::GenerateFreeTagKeyInGroup(uint16_t group)
2542 for (uint32_t elem = 0; elem < UINT32_MAX; elem++)
2544 TagKey key = DictEntry::TranslateToKey(group, elem);
2545 if (TagHT.count(key) == 0)
2554 * \brief Assuming the internal file pointer \ref Document::Fp
2555 * is placed at the beginning of a tag check whether this
2556 * tag is (TestGroup, TestElement).
2557 * \warning On success the internal file pointer \ref Document::Fp
2558 * is modified to point after the tag.
2559 * On failure (i.e. when the tag wasn't the expected tag
2560 * (TestGroup, TestElement) the internal file pointer
2561 * \ref Document::Fp is restored to it's original position.
2562 * @param testGroup The expected group of the tag.
2563 * @param testElement The expected Element of the tag.
2564 * @return True on success, false otherwise.
2566 bool Document::ReadTag(uint16_t testGroup, uint16_t testElement)
2568 long positionOnEntry = Fp->tellg();
2569 long currentPosition = Fp->tellg(); // On debugging purposes
2571 //// Read the Item Tag group and element, and make
2572 // sure they are what we expected:
2573 uint16_t itemTagGroup;
2574 uint16_t itemTagElement;
2577 itemTagGroup = ReadInt16();
2578 itemTagElement = ReadInt16();
2580 catch ( FormatError e )
2582 //std::cerr << e << std::endl;
2585 if ( itemTagGroup != testGroup || itemTagElement != testElement )
2587 gdcmVerboseMacro( "Wrong Item Tag found:"
2588 << " We should have found tag ("
2589 << std::hex << testGroup << "," << testElement << ")" << std::endl
2590 << " but instead we encountered tag ("
2591 << std::hex << itemTagGroup << "," << itemTagElement << ")"
2592 << " at address: " << " 0x(" << (unsigned int)currentPosition << ")"
2594 Fp->seekg(positionOnEntry, std::ios::beg);
2602 * \brief Assuming the internal file pointer \ref Document::Fp
2603 * is placed at the beginning of a tag (TestGroup, TestElement),
2604 * read the length associated to the Tag.
2605 * \warning On success the internal file pointer \ref Document::Fp
2606 * is modified to point after the tag and it's length.
2607 * On failure (i.e. when the tag wasn't the expected tag
2608 * (TestGroup, TestElement) the internal file pointer
2609 * \ref Document::Fp is restored to it's original position.
2610 * @param testGroup The expected group of the tag.
2611 * @param testElement The expected Element of the tag.
2612 * @return On success returns the length associated to the tag. On failure
2615 uint32_t Document::ReadTagLength(uint16_t testGroup, uint16_t testElement)
2618 if ( !ReadTag(testGroup, testElement) )
2623 //// Then read the associated Item Length
2624 long currentPosition = Fp->tellg();
2625 uint32_t itemLength = ReadInt32();
2627 gdcmVerboseMacro( "Basic Item Length is: "
2628 << itemLength << std::endl
2629 << " at address: " << std::hex << (unsigned int)currentPosition);
2635 * \brief When parsing the Pixel Data of an encapsulated file, read
2636 * the basic offset table (when present, and BTW dump it).
2638 void Document::ReadAndSkipEncapsulatedBasicOffsetTable()
2640 //// Read the Basic Offset Table Item Tag length...
2641 uint32_t itemLength = ReadTagLength(0xfffe, 0xe000);
2643 // When present, read the basic offset table itself.
2644 // Notes: - since the presence of this basic offset table is optional
2645 // we can't rely on it for the implementation, and we will simply
2646 // trash it's content (when present).
2647 // - still, when present, we could add some further checks on the
2648 // lengths, but we won't bother with such fuses for the time being.
2649 if ( itemLength != 0 )
2651 char *basicOffsetTableItemValue = new char[itemLength + 1];
2652 Fp->read(basicOffsetTableItemValue, itemLength);
2655 for (unsigned int i=0; i < itemLength; i += 4 )
2657 uint32_t individualLength = str2num( &basicOffsetTableItemValue[i],
2659 gdcmVerboseMacro( "Read one length: " <<
2660 std::hex << individualLength );
2664 delete[] basicOffsetTableItemValue;
2669 * \brief Parse pixel data from disk of [multi-]fragment RLE encoding.
2670 * Compute the RLE extra information and store it in \ref RLEInfo
2671 * for later pixel retrieval usage.
2673 void Document::ComputeRLEInfo()
2675 std::string ts = GetTransferSyntax();
2676 if ( !Global::GetTS()->IsRLELossless(ts) )
2681 // Encoded pixel data: for the time being we are only concerned with
2682 // Jpeg or RLE Pixel data encodings.
2683 // As stated in PS 3.5-2003, section 8.2 p44:
2684 // "If sent in Encapsulated Format (i.e. other than the Native Format) the
2685 // value representation OB is used".
2686 // Hence we expect an OB value representation. Concerning OB VR,
2687 // the section PS 3.5-2003, section A.4.c p 58-59, states:
2688 // "For the Value Representations OB and OW, the encoding shall meet the
2689 // following specifications depending on the Data element tag:"
2691 // - the first item in the sequence of items before the encoded pixel
2692 // data stream shall be basic offset table item. The basic offset table
2693 // item value, however, is not required to be present"
2695 ReadAndSkipEncapsulatedBasicOffsetTable();
2697 // Encapsulated RLE Compressed Images (see PS 3.5-2003, Annex G)
2698 // Loop on the individual frame[s] and store the information
2699 // on the RLE fragments in a RLEFramesInfo.
2700 // Note: - when only a single frame is present, this is a
2702 // - when more than one frame are present, then we are in
2703 // the case of a multi-frame image.
2705 while ( (frameLength = ReadTagLength(0xfffe, 0xe000)) )
2707 // Parse the RLE Header and store the corresponding RLE Segment
2708 // Offset Table information on fragments of this current Frame.
2709 // Note that the fragment pixels themselves are not loaded
2710 // (but just skipped).
2711 long frameOffset = Fp->tellg();
2713 uint32_t nbRleSegments = ReadInt32();
2714 if ( nbRleSegments > 16 )
2716 // There should be at most 15 segments (refer to RLEFrame class)
2717 gdcmVerboseMacro( "Too many segments.");
2720 uint32_t rleSegmentOffsetTable[16];
2721 for( int k = 1; k <= 15; k++ )
2723 rleSegmentOffsetTable[k] = ReadInt32();
2726 // Deduce from both the RLE Header and the frameLength the
2727 // fragment length, and again store this info in a
2729 long rleSegmentLength[15];
2730 // skipping (not reading) RLE Segments
2731 if ( nbRleSegments > 1)
2733 for(unsigned int k = 1; k <= nbRleSegments-1; k++)
2735 rleSegmentLength[k] = rleSegmentOffsetTable[k+1]
2736 - rleSegmentOffsetTable[k];
2737 SkipBytes(rleSegmentLength[k]);
2741 rleSegmentLength[nbRleSegments] = frameLength
2742 - rleSegmentOffsetTable[nbRleSegments];
2743 SkipBytes(rleSegmentLength[nbRleSegments]);
2745 // Store the collected info
2746 RLEFrame *newFrameInfo = new RLEFrame;
2747 newFrameInfo->NumberFragments = nbRleSegments;
2748 for( unsigned int uk = 1; uk <= nbRleSegments; uk++ )
2750 newFrameInfo->Offset[uk] = frameOffset + rleSegmentOffsetTable[uk];
2751 newFrameInfo->Length[uk] = rleSegmentLength[uk];
2753 RLEInfo->Frames.push_back( newFrameInfo );
2756 // Make sure that at the end of the item we encounter a 'Sequence
2758 if ( !ReadTag(0xfffe, 0xe0dd) )
2760 gdcmVerboseMacro( "No sequence delimiter item at end of RLE item sequence");
2765 * \brief Parse pixel data from disk of [multi-]fragment Jpeg encoding.
2766 * Compute the jpeg extra information (fragment[s] offset[s] and
2767 * length) and store it[them] in \ref JPEGInfo for later pixel
2770 void Document::ComputeJPEGFragmentInfo()
2772 // If you need to, look for comments of ComputeRLEInfo().
2773 std::string ts = GetTransferSyntax();
2774 if ( ! Global::GetTS()->IsJPEG(ts) )
2779 ReadAndSkipEncapsulatedBasicOffsetTable();
2781 // Loop on the fragments[s] and store the parsed information in a
2783 long fragmentLength;
2784 while ( (fragmentLength = ReadTagLength(0xfffe, 0xe000)) )
2786 long fragmentOffset = Fp->tellg();
2788 // Store the collected info
2789 JPEGFragment *newFragment = new JPEGFragment;
2790 newFragment->Offset = fragmentOffset;
2791 newFragment->Length = fragmentLength;
2792 JPEGInfo->Fragments.push_back( newFragment );
2794 SkipBytes( fragmentLength );
2797 // Make sure that at the end of the item we encounter a 'Sequence
2799 if ( !ReadTag(0xfffe, 0xe0dd) )
2801 gdcmVerboseMacro( "No sequence delimiter item at end of JPEG item sequence");
2806 * \brief Walk recursively the given \ref DocEntrySet, and feed
2807 * the given hash table (\ref TagDocEntryHT) with all the
2808 * \ref DocEntry (Dicom entries) encountered.
2809 * This method does the job for \ref BuildFlatHashTable.
2810 * @param builtHT Where to collect all the \ref DocEntry encountered
2811 * when recursively walking the given set.
2812 * @param set The structure to be traversed (recursively).
2814 /*void Document::BuildFlatHashTableRecurse( TagDocEntryHT &builtHT,
2817 if (ElementSet *elementSet = dynamic_cast< ElementSet* > ( set ) )
2819 TagDocEntryHT const ¤tHT = elementSet->GetTagHT();
2820 for( TagDocEntryHT::const_iterator i = currentHT.begin();
2821 i != currentHT.end();
2824 DocEntry *entry = i->second;
2825 if ( SeqEntry *seqEntry = dynamic_cast<SeqEntry*>(entry) )
2827 const ListSQItem& items = seqEntry->GetSQItems();
2828 for( ListSQItem::const_iterator item = items.begin();
2829 item != items.end();
2832 BuildFlatHashTableRecurse( builtHT, *item );
2836 builtHT[entry->GetKey()] = entry;
2841 if (SQItem *SQItemSet = dynamic_cast< SQItem* > ( set ) )
2843 const ListDocEntry& currentList = SQItemSet->GetDocEntries();
2844 for (ListDocEntry::const_iterator i = currentList.begin();
2845 i != currentList.end();
2848 DocEntry *entry = *i;
2849 if ( SeqEntry *seqEntry = dynamic_cast<SeqEntry*>(entry) )
2851 const ListSQItem& items = seqEntry->GetSQItems();
2852 for( ListSQItem::const_iterator item = items.begin();
2853 item != items.end();
2856 BuildFlatHashTableRecurse( builtHT, *item );
2860 builtHT[entry->GetKey()] = entry;
2867 * \brief Build a \ref TagDocEntryHT (i.e. a std::map<>) from the current
2870 * The structure used by a Document (through \ref ElementSet),
2871 * in order to hold the parsed entries of a Dicom header, is a recursive
2872 * one. This is due to the fact that the sequences (when present)
2873 * can be nested. Additionaly, the sequence items (represented in
2874 * gdcm as \ref SQItem) add an extra complexity to the data
2875 * structure. Hence, a gdcm user whishing to visit all the entries of
2876 * a Dicom header will need to dig in the gdcm internals (which
2877 * implies exposing all the internal data structures to the API).
2878 * In order to avoid this burden to the user, \ref BuildFlatHashTable
2879 * recursively builds a temporary hash table, which holds all the
2880 * Dicom entries in a flat structure (a \ref TagDocEntryHT i.e. a
2882 * \warning Of course there is NO integrity constrain between the
2883 * returned \ref TagDocEntryHT and the \ref ElementSet used
2884 * to build it. Hence if the underlying \ref ElementSet is
2885 * altered, then it is the caller responsability to invoke
2886 * \ref BuildFlatHashTable again...
2887 * @return The flat std::map<> we juste build.
2889 /*TagDocEntryHT *Document::BuildFlatHashTable()
2891 TagDocEntryHT *FlatHT = new TagDocEntryHT;
2892 BuildFlatHashTableRecurse( *FlatHT, this );
2899 * \brief Compares two documents, according to \ref DicomDir rules
2900 * \warning Does NOT work with ACR-NEMA files
2901 * \todo Find a trick to solve the pb (use RET fields ?)
2903 * @return true if 'smaller'
2905 bool Document::operator<(Document &document)
2908 std::string s1 = GetEntry(0x0010,0x0010);
2909 std::string s2 = document.GetEntry(0x0010,0x0010);
2921 s1 = GetEntry(0x0010,0x0020);
2922 s2 = document.GetEntry(0x0010,0x0020);
2933 // Study Instance UID
2934 s1 = GetEntry(0x0020,0x000d);
2935 s2 = document.GetEntry(0x0020,0x000d);
2946 // Serie Instance UID
2947 s1 = GetEntry(0x0020,0x000e);
2948 s2 = document.GetEntry(0x0020,0x000e);
2965 * \brief Re-computes the length of a ACR-NEMA/Dicom group from a DcmHeader
2966 * @param filetype Type of the File to be written
2968 int Document::ComputeGroup0002Length( FileType filetype )
2973 int groupLength = 0;
2974 bool found0002 = false;
2976 // for each zero-level Tag in the DCM Header
2980 entry = GetNextEntry();
2983 gr = entry->GetGroup();
2989 el = entry->GetElement();
2990 vr = entry->GetVR();
2992 if (filetype == ExplicitVR)
2994 if ( (vr == "OB") || (vr == "OW") || (vr == "SQ") )
2996 groupLength += 4; // explicit VR AND OB, OW, SQ : 4 more bytes
2999 groupLength += 2 + 2 + 4 + entry->GetLength();
3001 else if (found0002 )
3004 entry = GetNextEntry();
3009 } // end namespace gdcm
3011 //-----------------------------------------------------------------------------