1 /*=========================================================================
4 Module: $RCSfile: gdcmDocument.cxx,v $
6 Date: $Date: 2005/10/10 10:49:24 $
7 Version: $Revision: 1.286 $
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 "gdcmDictSet.h"
28 #include "gdcmDocEntrySet.h"
29 #include "gdcmSQItem.h"
34 #include <ctype.h> // for isdigit
35 #include <stdlib.h> // for atoi
39 //-----------------------------------------------------------------------------
41 // Refer to Document::SetMaxSizeLoadEntry()
42 const unsigned int Document::MAX_SIZE_LOAD_ELEMENT_VALUE = 0xfff; // 4096
44 //-----------------------------------------------------------------------------
45 // Constructor / Destructor
46 // Constructors and destructors are protected to avoid user to invoke directly
49 * \brief This default constructor neither loads nor parses the file.
50 * You should then invoke \ref Document::Load.
58 SetMaxSizeLoadEntry(MAX_SIZE_LOAD_ELEMENT_VALUE);
61 Filetype = ExplicitVR;
62 // Load will set it to true if sucessfull
63 Group0002Parsed = false;
64 IsDocumentAlreadyLoaded = false;
65 IsDocumentModified = true;
66 LoadMode = LD_ALL; // default : load everything, later
71 * \brief Constructor (DEPRECATED : not to break the API)
72 * @param fileName 'Document' (File or DicomDir) to be open for parsing
74 Document::Document( std::string const &fileName )
79 SetMaxSizeLoadEntry(MAX_SIZE_LOAD_ELEMENT_VALUE);
82 Filetype = ExplicitVR;
83 Group0002Parsed = false;
84 LoadMode = LD_ALL; // Load everything, later
86 // Load will set it to true if sucessfull
87 IsDocumentAlreadyLoaded = false;
88 IsDocumentModified = true;
90 SetFileName(fileName);
94 * \brief Canonical destructor.
96 Document::~Document ()
101 //-----------------------------------------------------------------------------
105 * \brief Loader. use SetLoadMode(), SetFileName() before !
106 * @return false if file cannot be open or no swap info was found,
107 * or no tag was found.
109 bool Document::Load( )
111 if ( GetFileName() == "" )
113 gdcmWarningMacro( "Use SetFileName, before !" );
116 return DoTheLoadingDocumentJob( );
119 * \brief Loader. (DEPRECATED : not to break the API)
120 * @param fileName 'Document' (File or DicomDir) to be open for parsing
121 * @return false if file cannot be open or no swap info was found,
122 * or no tag was found.
124 bool Document::Load( std::string const &fileName )
127 return DoTheLoadingDocumentJob( );
131 * \brief Performs the Loading Job (internal use only)
132 * @return false if file cannot be open or no swap info was found,
133 * or no tag was found.
135 bool Document::DoTheLoadingDocumentJob( )
137 if ( ! IsDocumentModified ) // Nothing to do !
140 // if ( Filename == fileName )
142 // gdcmWarningMacro( "The file was already parsed inside this "
143 // << "gdcm::Document (its name is: "
144 // << Filename.c_str() );
148 //gdcmWarningMacro( "A file was already parsed inside this "
149 // << "gdcm::Document (previous name was: "
150 // << Filename.c_str() << ". New name is :"
152 // clean out the Entries, if already parsed
153 // (probabely a mistake from the user)
160 // warning already performed in OpenFile()
161 //gdcmWarningMacro( "Unable to open as an ACR/DICOM file: "
162 // << Filename.c_str() );
167 Group0002Parsed = false;
169 gdcmWarningMacro( "Starting parsing of file: " << Filename.c_str());
171 Fp->seekg(0, std::ios::end);
172 long lgt = Fp->tellg(); // total length of the file
174 Fp->seekg(0, std::ios::beg);
176 // CheckSwap returns a boolean
177 // (false if no swap info of any kind was found)
180 gdcmWarningMacro( "Neither a DICOM V3 nor an ACR-NEMA file: "
181 << Filename.c_str());
186 long beg = Fp->tellg(); // just after DICOM preamble (if any)
188 lgt -= beg; // remaining length to parse
191 // Loading is done during parsing
192 ParseDES( this, beg, lgt, false); // delim_mode is first defaulted to false
196 gdcmWarningMacro( "No tag in internal hash table for: "
197 << Filename.c_str());
201 IsDocumentAlreadyLoaded = true;
203 Fp->seekg( 0, std::ios::beg);
205 // Load 'non string' values
207 std::string PhotometricInterpretation = GetEntryValue(0x0028,0x0004);
208 if ( PhotometricInterpretation == "PALETTE COLOR " )
211 // Probabely this line should be outside the 'if'
212 // Try to find an image sample holding a 'gray LUT'
213 LoadEntryBinArea(0x0028,0x1200); // gray LUT
216 /// The tags refered by the three following lines used to be CORRECTLY
217 /// defined as having an US Value Representation in the public
218 /// dictionary. BUT the semantics implied by the three following
219 /// lines state that the corresponding tag contents are in fact
220 /// the ones of a BinEntry.
221 /// In order to fix things "Quick and Dirty" the dictionary was
222 /// altered on PURPOSE but now contains a WRONG value.
223 /// In order to fix things and restore the dictionary to its
224 /// correct value, one needs to decided of the semantics by deciding
225 /// whether the following tags are either :
226 /// - multivaluated US, and hence loaded as ValEntry, but afterwards
227 /// also used as BinEntry, which requires the proper conversion,
228 /// - OW, and hence loaded as BinEntry, but afterwards also used
229 /// as ValEntry, which requires the proper conversion.
230 LoadEntryBinArea(0x0028,0x1201); // R LUT
231 LoadEntryBinArea(0x0028,0x1202); // G LUT
232 LoadEntryBinArea(0x0028,0x1203); // B LUT
234 // Segmented Red Palette Color LUT Data
235 LoadEntryBinArea(0x0028,0x1221);
236 // Segmented Green Palette Color LUT Data
237 LoadEntryBinArea(0x0028,0x1222);
238 // Segmented Blue Palette Color LUT Data
239 LoadEntryBinArea(0x0028,0x1223);
242 //FIXME later : how to use it?
243 SeqEntry *modLutSeq = GetSeqEntry(0x0028,0x3000);
246 SQItem *sqi= modLutSeq->GetFirstSQItem();
249 BinEntry *b = sqi->GetBinEntry(0x0028,0x3006);
252 if ( b->GetLength() != 0 )
254 LoadEntryBinArea(b); //LUT Data (CTX dependent)
260 // Force Loading some more elements if user asked to.
263 for (ListElements::iterator it = UserForceLoadList.begin();
264 it != UserForceLoadList.end();
267 gdcmWarningMacro( "Force Load " << std::hex
268 << (*it).Group << "|" <<(*it).Elem );
270 d = GetDocEntry( (*it).Group, (*it).Elem);
274 gdcmWarningMacro( "You asked toForce Load " << std::hex
275 << (*it).Group <<"|"<< (*it).Elem
276 << " that doesn't exist" );
280 if ( dynamic_cast<ValEntry *>(d) )
282 LoadDocEntry(d, true);
286 BinEntry *b = dynamic_cast<BinEntry *>(d);
290 b->SetValue(GDCM_BINLOADED);
294 if ( dynamic_cast<SeqEntry *>(d) )
296 gdcmWarningMacro( "You cannot 'ForceLoad' a SeqEntry :" << std::hex
297 << (*it).Group <<"|"<< (*it).Elem );
304 // ----------------------------
305 // Specific code to allow gdcm to read ACR-LibIDO formated images
306 // Note: ACR-LibIDO is an extension of the ACR standard that was
307 // used at CREATIS. For the time being (say a couple of years)
308 // we keep this kludge to allow CREATIS users
309 // reading their old images.
311 // if recognition code tells us we deal with a LibIDO image
312 // we switch lineNumber and columnNumber
315 RecCode = GetEntryValue(0x0008, 0x0010); // recognition code (RET)
316 if (RecCode == "ACRNEMA_LIBIDO_1.1" ||
317 RecCode == "CANRME_AILIBOD1_1." ) // for brain-damaged softwares
318 // with "little-endian strings"
320 Filetype = ACR_LIBIDO;
321 std::string rows = GetEntryValue(0x0028, 0x0010);
322 std::string columns = GetEntryValue(0x0028, 0x0011);
323 SetValEntry(columns, 0x0028, 0x0010);
324 SetValEntry(rows , 0x0028, 0x0011);
326 // --- End of ACR-LibIDO kludge ---
332 * \brief Adds a new element we want to load anyway
333 * @param group Group number of the target tag.
334 * @param elem Element number of the target tag.
336 void Document::AddForceLoadElement (uint16_t group, uint16_t elem)
341 UserForceLoadList.push_back(el);
344 * \brief Get the public dictionary used
346 Dict *Document::GetPubDict()
352 * \brief Get the shadow dictionary used
354 Dict *Document::GetShaDict()
360 * \brief Set the shadow dictionary used
361 * @param dict dictionary to use in shadow
363 bool Document::SetShaDict(Dict *dict)
370 * \brief Set the shadow dictionary used
371 * @param dictName name of the dictionary to use in shadow
373 bool Document::SetShaDict(DictKey const &dictName)
375 RefShaDict = Global::GetDicts()->GetDict(dictName);
380 * \brief This predicate tells us whether or not the current Document
381 * was properly parsed and contains at least *one* Dicom Element
382 * (and nothing more, sorry).
383 * @return false when we're 150 % sure it's NOT a Dicom/Acr file,
386 bool Document::IsReadable()
388 if ( Filetype == Unknown )
390 gdcmWarningMacro( "Wrong filetype");
396 gdcmWarningMacro( "No tag in internal hash table.");
404 * \brief Predicate for dicom version 3 file.
405 * @return True when the file is a dicom version 3.
407 bool Document::IsDicomV3()
409 // Checking if Transfer Syntax exists is enough
410 // Anyway, it's too late check if the 'Preamble' was found ...
411 // And ... would it be a rich idea to check ?
412 // (some 'no Preamble' DICOM images exist !)
413 return GetDocEntry(0x0002, 0x0010) != NULL;
417 * \brief Predicate for Papyrus file
418 * Dedicated to whomsoever it may concern
419 * @return True when the file is a Papyrus file.
421 bool Document::IsPapyrus()
423 // check for Papyrus private Sequence
424 DocEntry *e = GetDocEntry(0x0041, 0x1050);
427 // check if it's actually a Sequence
428 if ( !dynamic_cast<SeqEntry*>(e) )
434 * \brief returns the File Type
435 * (ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown)
436 * @return the FileType code
438 FileType Document::GetFileType()
444 * \brief Accessor to the Transfer Syntax (when present) of the
445 * current document (it internally handles reading the
446 * value from disk when only parsing occured).
447 * @return The encountered Transfer Syntax of the current document.
449 std::string Document::GetTransferSyntax()
451 DocEntry *entry = GetDocEntry(0x0002, 0x0010);
457 // The entry might be present but not loaded (parsing and loading
458 // happen at different stages): try loading and proceed with check...
459 LoadDocEntrySafe(entry);
460 if (ValEntry *valEntry = dynamic_cast< ValEntry* >(entry) )
462 std::string transfer = valEntry->GetValue();
463 // The actual transfer (as read from disk) might be padded. We
464 // first need to remove the potential padding. We can make the
465 // weak assumption that padding was not executed with digits...
466 if ( transfer.length() == 0 )
468 // for brain damaged headers
471 while ( !isdigit((unsigned char)transfer[transfer.length()-1]) )
473 transfer.erase(transfer.length()-1, 1);
481 * \brief Accesses the info from 0002,0010 : Transfer Syntax and TS
482 * @return The full Transfer Syntax Name (as opposed to Transfer Syntax UID)
484 std::string Document::GetTransferSyntaxName()
486 // use the TS (TS : Transfer Syntax)
487 std::string transferSyntax = GetEntryValue(0x0002,0x0010);
489 if ( (transferSyntax.find(GDCM_NOTLOADED) < transferSyntax.length()) )
491 gdcmErrorMacro( "Transfer Syntax not loaded. " << std::endl
492 << "Better you increase MAX_SIZE_LOAD_ELEMENT_VALUE" );
493 return "Uncompressed ACR-NEMA";
495 if ( transferSyntax == GDCM_UNFOUND )
497 gdcmWarningMacro( "Unfound Transfer Syntax (0002,0010)");
498 return "Uncompressed ACR-NEMA";
501 // we do it only when we need it
502 const TSKey &tsName = Global::GetTS()->GetValue( transferSyntax );
504 // Global::GetTS() is a global static you shall never try to delete it!
508 // --------------- Swap Code ------------------
510 * \brief Swaps the bytes so they agree with the processor order
511 * @return The properly swaped 16 bits integer.
513 uint16_t Document::SwapShort(uint16_t a)
515 if ( SwapCode == 4321 || SwapCode == 2143 )
517 //a = ((( a << 8 ) & 0xff00 ) | (( a >> 8 ) & 0x00ff ) );
519 a = ( a << 8 ) | ( a >> 8 );
525 * \brief Swaps back the bytes of 4-byte long integer accordingly to
527 * @return The properly swaped 32 bits integer.
529 uint32_t Document::SwapLong(uint32_t a)
536 // a=( ((a<<24) & 0xff000000) | ((a<<8) & 0x00ff0000) |
537 // ((a>>8) & 0x0000ff00) | ((a>>24) & 0x000000ff) );
539 a=( ( a<<24) | ((a<<8) & 0x00ff0000) |
540 ((a>>8) & 0x0000ff00) | (a>>24) );
543 // a=( ((a<<16) & 0xffff0000) | ((a>>16) & 0x0000ffff) );
544 a=( (a<<16) | (a>>16) );
547 a=( ((a<< 8) & 0xff00ff00) | ((a>>8) & 0x00ff00ff) );
550 gdcmErrorMacro( "Unset swap code:" << SwapCode );
557 // -----------------File I/O ---------------
559 * \brief Tries to open the file \ref Document::Filename and
560 * checks the preamble when existing.
561 * @return The FILE pointer on success.
563 std::ifstream *Document::OpenFile()
565 HasDCMPreamble = false;
566 if (Filename.length() == 0)
573 gdcmWarningMacro( "File already open: " << Filename.c_str());
577 Fp = new std::ifstream(Filename.c_str(), std::ios::in | std::ios::binary);
580 // Don't user gdcmErrorMacro :
581 // a spurious message will appear when you use, for instance
582 // gdcm::FileHelper *fh = new gdcm::FileHelper( outputFileName );
583 // to create outputFileName.
584 gdcmWarningMacro( "Cannot open file: " << Filename.c_str());
588 //exit(1); // No function is allowed to leave the application instead
589 // of warning the caller
593 Fp->read((char*)&zero, (size_t)2);
600 //-- ACR or DICOM with no Preamble; may start with a Shadow Group --
602 zero == 0x0001 || zero == 0x0100 || zero == 0x0002 || zero == 0x0200 ||
603 zero == 0x0003 || zero == 0x0300 || zero == 0x0004 || zero == 0x0400 ||
604 zero == 0x0005 || zero == 0x0500 || zero == 0x0006 || zero == 0x0600 ||
605 zero == 0x0007 || zero == 0x0700 || zero == 0x0008 || zero == 0x0800 )
607 std::string msg = Util::Format(
608 "ACR/DICOM starting at the beginning of the file:(%04x)\n", zero);
609 gdcmWarningMacro( msg.c_str() );
614 Fp->seekg(126L, std::ios::cur);
615 char dicm[4]; // = {' ',' ',' ',' '};
616 Fp->read(dicm, (size_t)4);
622 if ( memcmp(dicm, "DICM", 4) == 0 )
624 HasDCMPreamble = true;
628 // -- Neither ACR/No Preamble Dicom nor DICOMV3 file
630 gdcmWarningMacro( "Neither ACR/No Preamble Dicom nor DICOMV3 file: "
631 << Filename.c_str());
636 * \brief closes the file
637 * @return TRUE if the close was successfull
639 bool Document::CloseFile()
651 * \brief Writes in a file all the Entries (Dicom Elements)
652 * @param fp file pointer on an already open file (actually: Output File Stream)
653 * @param filetype Type of the File to be written
654 * (ACR-NEMA, ExplicitVR, ImplicitVR)
656 void Document::WriteContent(std::ofstream *fp, FileType filetype)
658 // Skip if user wants to write an ACR-NEMA file
660 if ( filetype == ImplicitVR || filetype == ExplicitVR )
662 // writing Dicom File Preamble
663 char filePreamble[128];
664 memset(filePreamble, 0, 128);
665 fp->write(filePreamble, 128);
666 fp->write("DICM", 4);
670 * \todo rewrite later, if really usefull
671 * - 'Group Length' element is optional in DICOM
672 * - but un-updated odd groups lengthes can causes pb
675 * if ( (filetype == ImplicitVR) || (filetype == ExplicitVR) )
676 * UpdateGroupLength(false,filetype);
677 * if ( filetype == ACR)
678 * UpdateGroupLength(true,ACR);
681 ElementSet::WriteContent(fp, filetype); // This one is recursive
684 // -----------------------------------------
687 * \brief Loads (from disk) the element content
688 * when a string is not suitable
689 * @param group group number of the Entry
690 * @param elem element number of the Entry
692 void Document::LoadEntryBinArea(uint16_t group, uint16_t elem)
694 // Search the corresponding DocEntry
695 DocEntry *docElement = GetDocEntry(group, elem);
698 gdcmWarningMacro(std::hex << group << "|" << elem
699 << "doesn't exist" );
702 BinEntry *binElement = dynamic_cast<BinEntry *>(docElement);
705 gdcmWarningMacro(std::hex << group << "|" << elem
706 << "is NOT a BinEntry");
709 LoadEntryBinArea(binElement);
713 * \brief Loads (from disk) the element content
714 * when a string is not suitable
715 * @param elem Entry whose binArea is going to be loaded
717 void Document::LoadEntryBinArea(BinEntry *elem)
719 if (elem->GetBinArea() )
726 size_t o =(size_t)elem->GetOffset();
727 Fp->seekg(o, std::ios::beg);
729 size_t l = elem->GetLength();
730 uint8_t *a = new uint8_t[l];
733 gdcmWarningMacro( "Cannot allocate BinEntry content for : "
734 << std::hex << elem->GetGroup()
735 << "|" << elem->GetElement() );
739 Fp->read((char*)a, l);
740 if ( Fp->fail() || Fp->eof() )
753 * \brief Loads the element while preserving the current
754 * underlying file position indicator as opposed to
755 * LoadDocEntry that modifies it.
756 * @param entry DocEntry whose value will be loaded.
758 void Document::LoadDocEntrySafe(DocEntry *entry)
762 long PositionOnEntry = Fp->tellg();
764 Fp->seekg(PositionOnEntry, std::ios::beg);
769 * \brief Compares two documents, according to \ref DicomDir rules
770 * \warning Does NOT work with ACR-NEMA files
771 * \todo Find a trick to solve the pb (use RET fields ?)
772 * @param document to compare with current one
773 * @return true if 'smaller'
775 bool Document::operator<(Document &document)
778 std::string s1 = GetEntryValue(0x0010,0x0010);
779 std::string s2 = document.GetEntryValue(0x0010,0x0010);
791 s1 = GetEntryValue(0x0010,0x0020);
792 s2 = document.GetEntryValue(0x0010,0x0020);
803 // Study Instance UID
804 s1 = GetEntryValue(0x0020,0x000d);
805 s2 = document.GetEntryValue(0x0020,0x000d);
816 // Serie Instance UID
817 s1 = GetEntryValue(0x0020,0x000e);
818 s2 = document.GetEntryValue(0x0020,0x000e);
833 //-----------------------------------------------------------------------------
836 * \brief Reads a supposed to be 16 Bits integer
837 * (swaps it depending on processor endianness)
840 uint16_t Document::ReadInt16()
844 Fp->read ((char*)&g, (size_t)2);
847 throw FormatError( "Document::ReadInt16()", " file error." );
851 throw FormatError( "Document::ReadInt16()", "EOF." );
858 * \brief Reads a supposed to be 32 Bits integer
859 * (swaps it depending on processor endianness)
862 uint32_t Document::ReadInt32()
866 Fp->read ((char*)&g, (size_t)4);
869 throw FormatError( "Document::ReadInt32()", " file error." );
873 throw FormatError( "Document::ReadInt32()", "EOF." );
880 * \brief skips bytes inside the source file
881 * \warning NOT end user intended method !
884 void Document::SkipBytes(uint32_t nBytes)
886 //FIXME don't dump the returned value
887 Fp->seekg((long)nBytes, std::ios::cur);
891 * \brief Re-computes the length of a ACR-NEMA/Dicom group from a DcmHeader
893 int Document::ComputeGroup0002Length( /*FileType filetype*/ )
899 bool found0002 = false;
901 // for each zero-level Tag in the DCM Header
902 DocEntry *entry = GetFirstEntry();
905 gr = entry->GetGroup();
911 if ( entry->GetElement() != 0x0000 )
915 // FIXME : group 0x0002 is *always* Explicit VR!
917 //if ( filetype == ExplicitVR )
919 // if ( (vr == "OB") || (vr == "OW") || (vr == "UT") || (vr == "SQ") )
920 // (no SQ, OW, UT in group 0x0002;)
923 // explicit VR AND OB, OW, SQ, UT : 4 more bytes
927 groupLength += 2 + 2 + 4 + entry->GetLength();
933 entry = GetNextEntry();
938 //-----------------------------------------------------------------------------
941 * \brief Loads all the needed Dictionaries
942 * \warning NOT end user intended method !
944 void Document::Initialize()
946 RefPubDict = Global::GetDicts()->GetDefaultPubDict();
952 * \brief Parses a DocEntrySet (Zero-level DocEntries or SQ Item DocEntries)
953 * @param set DocEntrySet we are going to parse ('zero level' or a SQItem)
954 * @param offset start of parsing
955 * @param l_max length to parse (meaningless when we are in 'delimitor mode')
956 * @param delim_mode : whether we are in 'delimitor mode' (l=0xffffff) or not
958 void Document::ParseDES(DocEntrySet *set, long offset,
959 long l_max, bool delim_mode)
961 DocEntry *newDocEntry;
962 ValEntry *newValEntry;
963 BinEntry *newBinEntry;
964 SeqEntry *newSeqEntry;
966 bool used; // will be set to false when something wrong happens to an Entry.
967 // (Entry will then be deleted)
968 bool delim_mode_intern = delim_mode;
970 gdcmWarningMacro( "Enter in ParseDES, delim-mode " << delim_mode
971 << " at offset " << std::hex << offset );
974 if ( !delim_mode && ((long)(Fp->tellg())-offset) >= l_max)
979 newDocEntry = ReadNextDocEntry( );
982 // Private tag, in IMplicit VR are defaulted as a BinEntry,
983 // Very often they are only composed of Printable characters,
984 // and could be defaulted as a ValEntry.
985 // It's too late to do the Job
986 // (we should check the value, but we know it after LoadDocEntry ...)
987 // --> in next gdcm major release let's unify ValEntry and BinEntry !
989 // Uncoment this printf line to be able to 'follow' the DocEntries
990 // when something *very* strange happens
992 //printf( "%04x|%04x %s\n",newDocEntry->GetGroup(),
993 // newDocEntry->GetElement(),
994 // newDocEntry->GetVR().c_str() );
1001 // an Item Starter found elsewhere but the first position
1002 // of a SeqEntry means previous entry was a Sequence
1003 // but we didn't get it (private Sequence + Implicit VR)
1004 // we have to backtrack.
1005 if ( !first && newDocEntry->IsItemStarter() )
1007 newDocEntry = Backtrack(newDocEntry);
1011 PreviousDocEntry = newDocEntry;
1015 newValEntry = dynamic_cast<ValEntry*>(newDocEntry);
1016 newBinEntry = dynamic_cast<BinEntry*>(newDocEntry);
1018 if ( newValEntry || newBinEntry )
1020 //////////////////////////// ContentEntry
1023 vr = newDocEntry->GetVR();
1024 if ( Filetype == ExplicitVR &&
1025 !Global::GetVR()->IsVROfBinaryRepresentable(vr) )
1027 ////// Neither ValEntry NOR BinEntry: should mean UNKOWN VR
1028 gdcmWarningMacro( std::hex << newDocEntry->GetGroup()
1029 << "|" << newDocEntry->GetElement()
1030 << " : Neither Valentry, nor BinEntry."
1031 "Probably unknown VR.");
1034 //////////////////// BinEntry or UNKOWN VR:
1036 // When "this" is a Document the Key is simply of the
1037 // form ( group, elem )...
1038 //if ( set == this ) // ( dynamic_cast< Document* > ( set ) )
1040 // newBinEntry->SetKey( newBinEntry->GetKey() );
1042 // but when "this" is a SQItem, we are inserting this new
1043 // valEntry in a sequence item, and the key has the
1044 // generalized form (refer to \ref BaseTagKey):
1046 // time waste hunting
1047 //if (SQItem *parentSQItem = dynamic_cast< SQItem* > ( set ) )
1049 // newBinEntry->SetKey( parentSQItem->GetBaseTagKey()
1050 // + newBinEntry->GetKey() );
1053 if ( !set->AddEntry( newBinEntry ) )
1055 gdcmWarningMacro( "in ParseDES : cannot add a BinEntry "
1056 << newBinEntry->GetKey()
1058 << newBinEntry->GetOffset() << " )" );
1063 // Load only if we can add (not a duplicate key)
1064 LoadDocEntry( newBinEntry );
1069 /////////////////////// ValEntry
1071 // When "set" is a Document, then we are at the top of the
1072 // hierarchy and the Key is simply of the form ( group, elem )...
1073 //if ( set == this ) // ( dynamic_cast< Document* > ( set ) )
1075 // newValEntry->SetKey( newValEntry->GetKey() );
1077 // ...but when "set" is a SQItem, we are inserting this new
1078 // valEntry in a sequence item. Hence the key has the
1079 // generalized form (refer to \ref BaseTagKey):
1081 // time waste hunting
1082 //if (SQItem *parentSQItem = dynamic_cast< SQItem* > ( set ) )
1084 // newValEntry->SetKey( parentSQItem->GetBaseTagKey()
1085 // + newValEntry->GetKey() );
1088 if ( !set->AddEntry( newValEntry ) )
1090 gdcmWarningMacro( "in ParseDES : cannot add a ValEntry "
1091 << newValEntry->GetKey()
1093 << newValEntry->GetOffset() << " )" );
1098 // Load only if we can add (not a duplicate key)
1099 LoadDocEntry( newValEntry );
1102 if ( newValEntry->GetElement() == 0x0000 ) // if on group length
1104 if ( newValEntry->GetGroup()%2 != 0 ) // if Shadow Group
1106 if ( LoadMode & LD_NOSHADOW ) // if user asked to skip shad.gr
1108 std::string strLgrGroup = newValEntry->GetValue();
1110 if ( strLgrGroup != GDCM_UNFOUND)
1112 lgrGroup = atoi(strLgrGroup.c_str());
1113 Fp->seekg(lgrGroup, std::ios::cur);
1114 //used = false; // never used
1115 RemoveEntry( newDocEntry ); // Remove and delete
1116 // bcc 5.5 is right "assigned a value that's never used"
1124 bool delimitor = newValEntry->IsItemDelimitor();
1127 (!delim_mode && ((long)(Fp->tellg())-offset) >= l_max) )
1135 // Just to make sure we are at the beginning of next entry.
1136 SkipToNextDocEntry(newDocEntry);
1140 /////////////////////// SeqEntry : VR = "SQ"
1142 unsigned long l = newDocEntry->GetReadLength();
1143 if ( l != 0 ) // don't mess the delim_mode for 'zero-length sequence'
1145 if ( l == 0xffffffff )
1147 delim_mode_intern = true;
1151 delim_mode_intern = false;
1155 if ( (LoadMode & LD_NOSHADOWSEQ) && ! delim_mode_intern )
1157 // User asked to skip SeQuences *only* if they belong to Shadow Group
1158 if ( newDocEntry->GetGroup()%2 != 0 )
1160 Fp->seekg( l, std::ios::cur);
1161 RemoveEntry( newDocEntry ); // Remove and delete
1162 //used = false; // never used
1166 if ( (LoadMode & LD_NOSEQ) && ! delim_mode_intern )
1168 // User asked to skip *any* SeQuence
1169 Fp->seekg( l, std::ios::cur);
1170 //used = false; // never used
1171 RemoveEntry( newDocEntry ); // Remove and delete
1174 // delay the dynamic cast as late as possible
1175 newSeqEntry = dynamic_cast<SeqEntry*>(newDocEntry);
1177 // no other way to create the Delimitor ...
1178 newSeqEntry->SetDelimitorMode( delim_mode_intern );
1180 // At the top of the hierarchy, stands a Document. When "set"
1181 // is a Document, then we are building the first depth level.
1182 // Hence the SeqEntry we are building simply has a depth
1184 // SQItem *parentSQItem = dynamic_cast< SQItem* > ( set );
1185 if ( set == this ) // ( dynamic_cast< Document* > ( set ) )
1187 newSeqEntry->SetDepthLevel( 1 );
1188 // newSeqEntry->SetKey( newSeqEntry->GetKey() );
1190 // But when "set" is already a SQItem, we are building a nested
1191 // sequence, and hence the depth level of the new SeqEntry
1192 // we are building, is one level deeper:
1194 // time waste hunting
1195 else if (SQItem *parentSQItem = dynamic_cast< SQItem* > ( set ) )
1197 newSeqEntry->SetDepthLevel( parentSQItem->GetDepthLevel() + 1 );
1199 // newSeqEntry->SetKey( parentSQItem->GetBaseTagKey()
1200 // + newSeqEntry->GetKey() );
1204 { // Don't try to parse zero-length sequences
1206 gdcmWarningMacro( "Entry in ParseSQ, delim " << delim_mode_intern
1207 << " at offset " << std::hex
1208 << newDocEntry->GetOffset() );
1210 ParseSQ( newSeqEntry,
1211 newDocEntry->GetOffset(),
1212 l, delim_mode_intern);
1214 gdcmWarningMacro( "Exit from ParseSQ, delim " << delim_mode_intern);
1217 if ( !set->AddEntry( newSeqEntry ) )
1219 gdcmWarningMacro( "in ParseDES : cannot add a SeqEntry "
1220 << newSeqEntry->GetKey()
1222 << newSeqEntry->GetOffset() << " )" );
1226 if ( !delim_mode && ((long)(Fp->tellg())-offset) >= l_max)
1232 } // end SeqEntry : VR = "SQ"
1240 gdcmWarningMacro( "Exit from ParseDES, delim-mode " << delim_mode );
1244 * \brief Parses a Sequence ( SeqEntry after SeqEntry)
1245 * @return parsed length for this level
1247 void Document::ParseSQ( SeqEntry *seqEntry,
1248 long offset, long l_max, bool delim_mode)
1250 int SQItemNumber = 0;
1252 long offsetStartCurrentSQItem = offset;
1256 // the first time, we read the fff0,e000 of the first SQItem
1257 DocEntry *newDocEntry = ReadNextDocEntry();
1261 // FIXME Should warn user
1262 gdcmWarningMacro("in ParseSQ : should never get here!");
1267 if ( newDocEntry->IsSequenceDelimitor() )
1269 seqEntry->SetDelimitationItem( newDocEntry );
1273 if ( !delim_mode && ((long)(Fp->tellg())-offset) >= l_max)
1278 // create the current SQItem
1279 SQItem *itemSQ = new SQItem( seqEntry->GetDepthLevel() );
1281 std::ostringstream newBase;
1282 newBase << seqEntry->GetKey()
1286 itemSQ->SetBaseTagKey( newBase.str() );
1288 unsigned int l = newDocEntry->GetReadLength();
1290 if ( l == 0xffffffff )
1299 // Let's try :------------
1300 // remove fff0,e000, created out of the SQItem
1302 Fp->seekg(offsetStartCurrentSQItem, std::ios::beg);
1303 // fill up the current SQItem, starting at the beginning of fff0,e000
1305 ParseDES(itemSQ, offsetStartCurrentSQItem, l+8, dlm_mod);
1307 offsetStartCurrentSQItem = Fp->tellg();
1308 // end try -----------------
1310 seqEntry->AddSQItem( itemSQ, SQItemNumber );
1312 if ( !delim_mode && ((long)(Fp->tellg())-offset ) >= l_max )
1320 * \brief When a private Sequence + Implicit VR is encountered
1321 * we cannot guess it's a Sequence till we find the first
1322 * Item Starter. We then backtrack to do the job.
1323 * @param docEntry Item Starter that warned us
1325 DocEntry *Document::Backtrack(DocEntry *docEntry)
1327 // delete the Item Starter, built erroneously out of any Sequence
1328 // it's not yet in the HTable/chained list
1331 // Get all info we can from PreviousDocEntry
1332 uint16_t group = PreviousDocEntry->GetGroup();
1333 uint16_t elem = PreviousDocEntry->GetElement();
1334 uint32_t lgt = PreviousDocEntry->GetLength();
1335 long offset = PreviousDocEntry->GetOffset();
1337 gdcmWarningMacro( "Backtrack :" << std::hex << group
1339 << " at offset " << offset );
1340 RemoveEntry( PreviousDocEntry );
1342 // forge the Seq Entry
1343 DocEntry *newEntry = NewSeqEntry(group, elem);
1344 newEntry->SetLength(lgt);
1345 newEntry->SetOffset(offset);
1347 // Move back to the beginning of the Sequence
1348 Fp->seekg( 0, std::ios::beg);
1349 Fp->seekg(offset, std::ios::cur);
1355 * \brief Loads (or not) the element content depending if its length exceeds
1356 * or not the value specified with Document::SetMaxSizeLoadEntry()
1357 * @param entry Header Entry (Dicom Element) to be dealt with
1358 * @param forceLoad whether you want to force loading of 'long' elements
1360 void Document::LoadDocEntry(DocEntry *entry, bool forceLoad)
1362 uint16_t group = entry->GetGroup();
1363 std::string vr = entry->GetVR();
1364 uint32_t length = entry->GetLength();
1366 Fp->seekg((long)entry->GetOffset(), std::ios::beg);
1368 // A SeQuence "contains" a set of Elements.
1369 // (fffe e000) tells us an Element is beginning
1370 // (fffe e00d) tells us an Element just ended
1371 // (fffe e0dd) tells us the current SeQuence just ended
1372 if ( group == 0xfffe )
1374 // NO more value field for SQ !
1378 // When the length is zero things are easy:
1381 ((ValEntry *)entry)->SetValue("");
1385 // The elements whose length is bigger than the specified upper bound
1386 // are not loaded. Instead we leave a short notice on the offset of
1387 // the element content and it's length.
1389 std::ostringstream s;
1393 if (length > MaxSizeLoadEntry)
1395 if (BinEntry *binEntryPtr = dynamic_cast< BinEntry* >(entry) )
1397 s << GDCM_NOTLOADED;
1398 s << " Ad.:" << (long)entry->GetOffset();
1399 s << " x(" << std::hex << entry->GetOffset() << ")";
1401 s << " Lgt:" << entry->GetLength();
1402 s << " x(" << std::hex << entry->GetLength() << ")";
1403 binEntryPtr->SetValue(s.str());
1405 else if (ValEntry *valEntryPtr = dynamic_cast< ValEntry* >(entry) )
1407 s << GDCM_NOTLOADED;
1408 s << " Address:" << (long)entry->GetOffset();
1409 s << " Length:" << entry->GetLength();
1410 s << " x(" << std::hex << entry->GetLength() << ")";
1411 valEntryPtr->SetValue(s.str());
1416 gdcmErrorMacro( "MaxSizeLoadEntry exceeded, neither a BinEntry "
1417 << "nor a ValEntry ?! Should never print that !" );
1420 // to be sure we are at the end of the value ...
1421 Fp->seekg((long)entry->GetOffset()+(long)entry->GetLength(),
1427 // When we find a BinEntry not very much can be done :
1428 if (BinEntry *binEntryPtr = dynamic_cast< BinEntry* >(entry) )
1430 s << GDCM_BINLOADED;
1431 binEntryPtr->SetValue(s.str());
1432 LoadEntryBinArea(binEntryPtr); // last one, not to erase length !
1436 if ( IsDocEntryAnInteger(entry) )
1440 // When short integer(s) are expected, read and convert the following
1441 // (n * 2) characters properly i.e. consider them as short integers as
1442 // opposed to strings.
1443 // Elements with Value Multiplicity > 1
1444 // contain a set of integers (not a single one)
1445 if (vr == "US" || vr == "SS")
1448 NewInt = ReadInt16();
1452 for (int i=1; i < nbInt; i++)
1455 NewInt = ReadInt16();
1460 // See above comment on multiple integers (mutatis mutandis).
1461 else if (vr == "UL" || vr == "SL")
1464 NewInt = ReadInt32();
1468 for (int i=1; i < nbInt; i++)
1471 NewInt = ReadInt32();
1476 #ifdef GDCM_NO_ANSI_STRING_STREAM
1477 s << std::ends; // to avoid oddities on Solaris
1478 #endif //GDCM_NO_ANSI_STRING_STREAM
1480 ((ValEntry *)entry)->SetValue(s.str());
1484 // FIXME: We need an additional byte for storing \0 that is not on disk
1485 char *str = new char[length+1];
1486 Fp->read(str, (size_t)length);
1487 str[length] = '\0'; //this is only useful when length is odd
1488 // Special DicomString call to properly handle \0 and even length
1489 std::string newValue;
1492 newValue = Util::DicomString(str, length+1);
1493 gdcmWarningMacro("Warning: bad length: " << length <<
1494 " For string :" << newValue.c_str());
1495 // Since we change the length of string update it length
1496 //entry->SetReadLength(length+1);
1500 newValue = Util::DicomString(str, length);
1504 if ( ValEntry *valEntry = dynamic_cast<ValEntry* >(entry) )
1506 if ( Fp->fail() || Fp->eof())
1509 gdcmWarningMacro("--> fail");
1511 gdcmWarningMacro("Unread element value " << valEntry->GetKey()
1512 << " lgt : " << valEntry->GetReadLength()
1513 << " at " << std::hex << valEntry->GetOffset());
1514 valEntry->SetValue(GDCM_UNREAD);
1520 // Because of correspondance with the VR dic
1521 valEntry->SetValue(newValue);
1525 valEntry->SetValue(newValue);
1530 gdcmWarningMacro("Should have a ValEntry, here ! " << valEntry->GetKey()
1531 << " lgt : " << valEntry->GetReadLength()
1532 << " at " << std::hex << valEntry->GetOffset());
1537 * \brief Find the value Length of the passed Doc Entry
1538 * @param entry Header Entry whose length of the value shall be loaded.
1540 void Document::FindDocEntryLength( DocEntry *entry )
1541 throw ( FormatError )
1543 std::string vr = entry->GetVR();
1546 if ( Filetype == ExplicitVR && !entry->IsImplicitVR() )
1548 if ( vr == "OB" || vr == "OW" || vr == "SQ" || vr == "UT"
1551 // The following reserved two bytes (see PS 3.5-2003, section
1552 // "7.1.2 Data element structure with explicit vr", p 27) must be
1553 // skipped before proceeding on reading the length on 4 bytes.
1554 Fp->seekg( 2L, std::ios::cur);
1555 uint32_t length32 = ReadInt32();
1557 if ( (vr == "OB" || vr == "OW") && length32 == 0xffffffff )
1562 lengthOB = FindDocEntryLengthOBOrOW();
1564 catch ( FormatUnexpected )
1566 // Computing the length failed (this happens with broken
1567 // files like gdcm-JPEG-LossLess3a.dcm). We still have a
1568 // chance to get the pixels by deciding the element goes
1569 // until the end of the file. Hence we artificially fix the
1570 // the length and proceed.
1571 gdcmWarningMacro( " Computing the length failed for " <<
1572 entry->GetKey() <<" in " <<GetFileName());
1574 long currentPosition = Fp->tellg();
1575 Fp->seekg(0L,std::ios::end);
1577 long lengthUntilEOF = (long)(Fp->tellg())-currentPosition;
1578 Fp->seekg(currentPosition, std::ios::beg);
1580 entry->SetReadLength(lengthUntilEOF);
1581 entry->SetLength(lengthUntilEOF);
1584 entry->SetReadLength(lengthOB);
1585 entry->SetLength(lengthOB);
1588 FixDocEntryFoundLength(entry, length32);
1592 // Length is encoded on 2 bytes.
1593 length16 = ReadInt16();
1595 // 0xffff means that we deal with 'No Length' Sequence
1596 // or 'No Length' SQItem
1597 if ( length16 == 0xffff)
1601 FixDocEntryFoundLength( entry, (uint32_t)length16 );
1606 // Either implicit VR or a non DICOM conformal (see note below) explicit
1607 // VR that ommited the VR of (at least) this element. Farts happen.
1608 // [Note: according to the part 5, PS 3.5-2001, section 7.1 p25
1609 // on Data elements "Implicit and Explicit VR Data Elements shall
1610 // not coexist in a Data Set and Data Sets nested within it".]
1611 // Length is on 4 bytes.
1613 // Well ... group 0002 is always coded in 'Explicit VR Litle Endian'
1614 // even if Transfer Syntax is 'Implicit VR ...'
1616 FixDocEntryFoundLength( entry, ReadInt32() );
1622 * \brief Find the Length till the next sequence delimiter
1623 * \warning NOT end user intended method !
1626 uint32_t Document::FindDocEntryLengthOBOrOW()
1627 throw( FormatUnexpected )
1629 // See PS 3.5-2001, section A.4 p. 49 on encapsulation of encoded pixel data.
1630 long positionOnEntry = Fp->tellg();
1631 bool foundSequenceDelimiter = false;
1632 uint32_t totalLength = 0;
1634 while ( !foundSequenceDelimiter )
1640 group = ReadInt16();
1643 catch ( FormatError )
1645 throw FormatError("Unexpected end of file encountered during ",
1646 "Document::FindDocEntryLengthOBOrOW()");
1648 // We have to decount the group and element we just read
1650 if ( group != 0xfffe || ( ( elem != 0xe0dd ) && ( elem != 0xe000 ) ) )
1652 long filePosition = Fp->tellg();
1654 "Neither an Item tag nor a Sequence delimiter tag on :"
1655 << std::hex << group << " , " << elem
1656 << ") -before- position x(" << filePosition << ")" );
1658 Fp->seekg(positionOnEntry, std::ios::beg);
1659 throw FormatUnexpected(
1660 "Neither an Item tag nor a Sequence delimiter tag.");
1662 if ( elem == 0xe0dd )
1664 foundSequenceDelimiter = true;
1666 uint32_t itemLength = ReadInt32();
1667 // We add 4 bytes since we just read the ItemLength with ReadInt32
1668 totalLength += itemLength + 4;
1669 SkipBytes(itemLength);
1671 if ( foundSequenceDelimiter )
1676 Fp->seekg( positionOnEntry, std::ios::beg);
1681 * \brief Find the Value Representation of the current Dicom Element.
1682 * @return Value Representation of the current Entry
1684 std::string Document::FindDocEntryVR()
1686 if ( Filetype != ExplicitVR )
1687 return GDCM_UNKNOWN;
1689 long positionOnEntry = Fp->tellg();
1690 // Warning: we believe this is explicit VR (Value Representation) because
1691 // we used a heuristic that found "UL" in the first tag. Alas this
1692 // doesn't guarantee that all the tags will be in explicit VR. In some
1693 // cases (see e-film filtered files) one finds implicit VR tags mixed
1694 // within an explicit VR file. Hence we make sure the present tag
1695 // is in explicit VR and try to fix things if it happens not to be
1699 Fp->read (vr, (size_t)2);
1702 if ( !CheckDocEntryVR(vr) )
1704 Fp->seekg(positionOnEntry, std::ios::beg);
1705 return GDCM_UNKNOWN;
1711 * \brief Check the correspondance between the VR of the header entry
1712 * and the taken VR. If they are different, the header entry is
1713 * updated with the new VR.
1714 * @param vr Dicom Value Representation
1715 * @return false if the VR is incorrect or if the VR isn't referenced
1716 * otherwise, it returns true
1718 bool Document::CheckDocEntryVR(VRKey vr)
1720 if ( !Global::GetVR()->IsValidVR(vr) )
1727 * \brief Get the transformed value of the header entry. The VR value
1728 * is used to define the transformation to operate on the value
1729 * \warning NOT end user intended method !
1730 * @param entry entry to tranform
1731 * @return Transformed entry value
1733 std::string Document::GetDocEntryValue(DocEntry *entry)
1735 if ( IsDocEntryAnInteger(entry) && entry->IsImplicitVR() )
1737 std::string val = ((ValEntry *)entry)->GetValue();
1738 std::string vr = entry->GetVR();
1739 uint32_t length = entry->GetLength();
1740 std::ostringstream s;
1743 // When short integer(s) are expected, read and convert the following
1744 // n * 2 bytes properly i.e. as a multivaluated strings
1745 // (each single value is separated fromthe next one by '\'
1746 // as usual for standard multivaluated filels
1747 // Elements with Value Multiplicity > 1
1748 // contain a set of short integers (not a single one)
1750 if ( vr == "US" || vr == "SS" )
1755 for (int i=0; i < nbInt; i++)
1761 newInt16 = ( val[2*i+0] & 0xFF ) + ( ( val[2*i+1] & 0xFF ) << 8);
1762 newInt16 = SwapShort( newInt16 );
1767 // When integer(s) are expected, read and convert the following
1768 // n * 4 bytes properly i.e. as a multivaluated strings
1769 // (each single value is separated fromthe next one by '\'
1770 // as usual for standard multivaluated filels
1771 // Elements with Value Multiplicity > 1
1772 // contain a set of integers (not a single one)
1773 else if ( vr == "UL" || vr == "SL" )
1778 for (int i=0; i < nbInt; i++)
1784 newInt32 = ( val[4*i+0] & 0xFF )
1785 + (( val[4*i+1] & 0xFF ) << 8 )
1786 + (( val[4*i+2] & 0xFF ) << 16 )
1787 + (( val[4*i+3] & 0xFF ) << 24 );
1788 newInt32 = SwapLong( newInt32 );
1792 #ifdef GDCM_NO_ANSI_STRING_STREAM
1793 s << std::ends; // to avoid oddities on Solaris
1794 #endif //GDCM_NO_ANSI_STRING_STREAM
1797 return ((ValEntry *)entry)->GetValue();
1801 * \brief Get the reverse transformed value of the header entry. The VR
1802 * value is used to define the reverse transformation to operate on
1804 * \warning NOT end user intended method !
1805 * @param entry Entry to reverse transform
1806 * @return Reverse transformed entry value
1808 std::string Document::GetDocEntryUnvalue(DocEntry *entry)
1810 if ( IsDocEntryAnInteger(entry) && entry->IsImplicitVR() )
1812 std::string vr = entry->GetVR();
1813 std::vector<std::string> tokens;
1814 std::ostringstream s;
1816 if ( vr == "US" || vr == "SS" )
1820 tokens.erase( tokens.begin(), tokens.end()); // clean any previous value
1821 Util::Tokenize (((ValEntry *)entry)->GetValue(), tokens, "\\");
1822 for (unsigned int i=0; i<tokens.size(); i++)
1824 newInt16 = atoi(tokens[i].c_str());
1825 s << ( newInt16 & 0xFF )
1826 << (( newInt16 >> 8 ) & 0xFF );
1830 if ( vr == "UL" || vr == "SL")
1834 tokens.erase(tokens.begin(),tokens.end()); // clean any previous value
1835 Util::Tokenize (((ValEntry *)entry)->GetValue(), tokens, "\\");
1836 for (unsigned int i=0; i<tokens.size();i++)
1838 newInt32 = atoi(tokens[i].c_str());
1839 s << (char)( newInt32 & 0xFF )
1840 << (char)(( newInt32 >> 8 ) & 0xFF )
1841 << (char)(( newInt32 >> 16 ) & 0xFF )
1842 << (char)(( newInt32 >> 24 ) & 0xFF );
1847 #ifdef GDCM_NO_ANSI_STRING_STREAM
1848 s << std::ends; // to avoid oddities on Solaris
1849 #endif //GDCM_NO_ANSI_STRING_STREAM
1853 return ((ValEntry *)entry)->GetValue();
1857 * \brief Skip a given Header Entry
1858 * \warning NOT end user intended method !
1859 * @param entry entry to skip
1861 void Document::SkipDocEntry(DocEntry *entry)
1863 SkipBytes(entry->GetLength());
1867 * \brief Skips to the beginning of the next Header Entry
1868 * \warning NOT end user intended method !
1869 * @param currentDocEntry entry to skip
1871 void Document::SkipToNextDocEntry(DocEntry *currentDocEntry)
1873 int l = currentDocEntry->GetReadLength();
1874 if ( l == -1 ) // length = 0xffff shouldn't appear here ...
1875 // ... but PMS imagers happen !
1877 Fp->seekg((long)(currentDocEntry->GetOffset()), std::ios::beg);
1878 if (currentDocEntry->GetGroup() != 0xfffe) // for fffe pb
1880 Fp->seekg( (long)(currentDocEntry->GetReadLength()),std::ios::cur);
1885 * \brief When the length of an element value is obviously wrong (because
1886 * the parser went Jabberwocky) one can hope improving things by
1887 * applying some heuristics.
1888 * @param entry entry to check
1889 * @param foundLength first assumption about length
1891 void Document::FixDocEntryFoundLength(DocEntry *entry,
1892 uint32_t foundLength)
1894 entry->SetReadLength( foundLength ); // will be updated only if a bug is found
1895 if ( foundLength == 0xffffffff)
1900 uint16_t gr = entry->GetGroup();
1901 uint16_t elem = entry->GetElement();
1903 if ( foundLength % 2)
1905 gdcmWarningMacro( "Warning : Tag with uneven length " << foundLength
1906 << " in x(" << std::hex << gr << "," << elem <<")");
1909 //////// Fix for some naughty General Electric images.
1910 // Allthough not recent many such GE corrupted images are still present
1911 // on Creatis hard disks. Hence this fix shall remain when such images
1912 // are no longer in use (we are talking a few years, here)...
1913 // Note: XMedCon probably uses such a trick since it is able to read
1914 // those pesky GE images ...
1915 if ( foundLength == 13)
1917 // Only happens for this length !
1918 if ( gr != 0x0008 || ( elem != 0x0070 && elem != 0x0080 ) )
1921 entry->SetReadLength(10); // a bug is to be fixed !?
1925 //////// Fix for some brain-dead 'Leonardo' Siemens images.
1926 // Occurence of such images is quite low (unless one leaves close to a
1927 // 'Leonardo' source. Hence, one might consider commenting out the
1928 // following fix on efficiency reasons.
1929 else if ( gr == 0x0009 && ( elem == 0x1113 || elem == 0x1114 ) )
1932 entry->SetReadLength(4); // a bug is to be fixed !?
1935 else if ( entry->GetVR() == "SQ" )
1937 foundLength = 0; // ReadLength is unchanged
1940 //////// We encountered a 'delimiter' element i.e. a tag of the form
1941 // "fffe|xxxx" which is just a marker. Delimiters length should not be
1942 // taken into account.
1943 else if ( gr == 0xfffe )
1945 // According to the norm, fffe|0000 shouldn't exist. BUT the Philips
1946 // image gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm happens to
1947 // causes extra troubles...
1948 if ( entry->GetElement() != 0x0000 )
1953 entry->SetLength(foundLength);
1957 * \brief Apply some heuristics to predict whether the considered
1958 * element value contains/represents an integer or not.
1959 * @param entry The element value on which to apply the predicate.
1960 * @return The result of the heuristical predicate.
1962 bool Document::IsDocEntryAnInteger(DocEntry *entry)
1964 uint16_t elem = entry->GetElement();
1965 uint16_t group = entry->GetGroup();
1966 const std::string &vr = entry->GetVR();
1967 uint32_t length = entry->GetLength();
1969 // When we have some semantics on the element we just read, and if we
1970 // a priori know we are dealing with an integer, then we shall be
1971 // able to swap it's element value properly.
1972 if ( elem == 0 ) // This is the group length of the group
1980 // Allthough this should never happen, still some images have a
1981 // corrupted group length [e.g. have a glance at offset x(8336) of
1982 // gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm].
1983 // Since for dicom compliant and well behaved headers, the present
1984 // test is useless (and might even look a bit paranoid), when we
1985 // encounter such an ill-formed image, we simply display a warning
1986 // message and proceed on parsing (while crossing fingers).
1987 long filePosition = Fp->tellg();
1988 gdcmWarningMacro( "Erroneous Group Length element length on : ("
1989 << std::hex << group << " , " << elem
1990 << ") -before- position x(" << filePosition << ")"
1991 << "lgt : " << length );
1995 if ( vr == "UL" || vr == "US" || vr == "SL" || vr == "SS" )
2003 * \brief Discover what the swap code is (among little endian, big endian,
2004 * bad little endian, bad big endian).
2006 * @return false when we are absolutely sure
2007 * it's neither ACR-NEMA nor DICOM
2008 * true when we hope ours assuptions are OK
2010 bool Document::CheckSwap()
2017 // First, compare HostByteOrder and NetworkByteOrder in order to
2018 // determine if we shall need to swap bytes (i.e. the Endian type).
2019 bool net2host = Util::IsCurrentProcessorBigEndian();
2021 // The easiest case is the one of a 'true' DICOM header, we just have
2022 // to look for the string "DICM" inside the file preamble.
2025 char *entCur = deb + 128;
2026 if ( memcmp(entCur, "DICM", (size_t)4) == 0 )
2028 gdcmWarningMacro( "Looks like DICOM Version3 (preamble + DCM)" );
2030 // Group 0002 should always be VR, and the first element 0000
2031 // Let's be carefull (so many wrong headers ...)
2032 // and determine the value representation (VR) :
2033 // Let's skip to the first element (0002,0000) and check there if we find
2034 // "UL" - or "OB" if the 1st one is (0002,0001) -,
2035 // in which case we (almost) know it is explicit VR.
2036 // WARNING: if it happens to be implicit VR then what we will read
2037 // is the length of the group. If this ascii representation of this
2038 // length happens to be "UL" then we shall believe it is explicit VR.
2039 // We need to skip :
2040 // * the 128 bytes of File Preamble (often padded with zeroes),
2041 // * the 4 bytes of "DICM" string,
2042 // * the 4 bytes of the first tag (0002, 0000),or (0002, 0001)
2043 // i.e. a total of 136 bytes.
2046 // group 0x0002 *is always* Explicit VR Sometimes ,
2047 // even if elem 0002,0010 (Transfer Syntax) tells us the file is
2048 // *Implicit* VR (see former 'gdcmData/icone.dcm')
2050 if ( memcmp(entCur, "UL", (size_t)2) == 0 ||
2051 memcmp(entCur, "OB", (size_t)2) == 0 ||
2052 memcmp(entCur, "UI", (size_t)2) == 0 ||
2053 memcmp(entCur, "CS", (size_t)2) == 0 ) // CS, to remove later
2054 // when Write DCM *adds*
2056 // Use Document::dicom_vr to test all the possibilities
2057 // instead of just checking for UL, OB and UI !? group 0000
2059 Filetype = ExplicitVR;
2060 gdcmWarningMacro( "Group 0002 : Explicit Value Representation");
2064 Filetype = ImplicitVR;
2065 gdcmWarningMacro( "Group 0002 :Not an explicit Value Representation;"
2066 << "Looks like a bugged Header!");
2072 gdcmWarningMacro( "HostByteOrder != NetworkByteOrder");
2077 gdcmWarningMacro( "HostByteOrder = NetworkByteOrder");
2080 // Position the file position indicator at first tag
2081 // (i.e. after the file preamble and the "DICM" string).
2083 Fp->seekg(0, std::ios::beg); // FIXME : Is it usefull?
2085 Fp->seekg ( 132L, std::ios::beg);
2087 } // ------------------------------- End of DicomV3 ----------------
2089 // Alas, this is not a DicomV3 file and whatever happens there is no file
2090 // preamble. We can reset the file position indicator to where the data
2091 // is (i.e. the beginning of the file).
2093 gdcmWarningMacro( "Not a Kosher DICOM Version3 file (no preamble)");
2095 Fp->seekg(0, std::ios::beg);
2097 // Let's check 'No Preamble Dicom File' :
2098 // Should start with group 0x0002
2099 // and be Explicit Value Representation
2101 s16 = *((uint16_t *)(deb));
2114 if ( SwapCode != 0 )
2116 if ( memcmp(entCur, "UL", (size_t)2) == 0 ||
2117 memcmp(entCur, "OB", (size_t)2) == 0 ||
2118 memcmp(entCur, "UI", (size_t)2) == 0 ||
2119 memcmp(entCur, "SH", (size_t)2) == 0 ||
2120 memcmp(entCur, "AE", (size_t)2) == 0 ||
2121 memcmp(entCur, "OB", (size_t)2) == 0 )
2123 Filetype = ExplicitVR;
2124 gdcmWarningMacro( "Group 0002 : Explicit Value Representation");
2128 // ------------------------------- End of 'No Preamble' DicomV3 -------------
2130 // Our next best chance would be to be considering a 'clean' ACR/NEMA file.
2131 // By clean we mean that the length of the first group is written down.
2132 // If this is the case and since the length of the first group HAS to be
2133 // four (bytes), then determining the proper swap code is straightforward.
2136 // We assume the array of char we are considering contains the binary
2137 // representation of a 32 bits integer. Hence the following dirty
2139 s32 = *((uint32_t *)(entCur));
2159 // We are out of luck. It is not a DicomV3 nor a 'clean' ACR/NEMA file.
2160 // It is time for despaired wild guesses.
2161 // So, let's check if this file wouldn't happen to be 'dirty' ACR/NEMA,
2162 // i.e. the 'group length' element is not present :
2164 // check the supposed-to-be 'group number'
2165 // in ( 0x0001 .. 0x0008 )
2166 // to determine ' SwapCode' value .
2167 // Only 0 or 4321 will be possible
2168 // (no oportunity to check for the formerly well known
2169 // ACR-NEMA 'Bad Big Endian' or 'Bad Little Endian'
2170 // if unsuccessfull (i.e. neither 0x0002 nor 0x0200 etc -3, 4, ..., 8-)
2171 // the file IS NOT ACR-NEMA nor DICOM V3
2172 // Find a trick to tell it the caller...
2174 s16 = *((uint16_t *)(deb));
2201 gdcmWarningMacro("ACR/NEMA unfound swap info (Really hopeless !)");
2209 * \brief Change the Byte Swap code.
2211 void Document::SwitchByteSwapCode()
2213 gdcmWarningMacro( "Switching Byte Swap code from "<< SwapCode
2214 << " at :" <<std::hex << Fp->tellg() );
2215 if ( SwapCode == 1234 )
2219 else if ( SwapCode == 4321 )
2223 else if ( SwapCode == 3412 )
2227 else if ( SwapCode == 2143 )
2234 * \brief during parsing, Header Elements too long are not loaded in memory
2235 * @param newSize new size
2237 void Document::SetMaxSizeLoadEntry(long newSize)
2243 if ((uint32_t)newSize >= (uint32_t)0xffffffff )
2245 MaxSizeLoadEntry = 0xffffffff;
2248 MaxSizeLoadEntry = newSize;
2252 * \brief Read the next tag WITHOUT loading it's value
2253 * (read the 'Group Number', the 'Element Number',
2254 * gets the Dict Entry
2255 * gets the VR, gets the length, gets the offset value)
2256 * @return On succes : the newly created DocEntry, NULL on failure.
2258 DocEntry *Document::ReadNextDocEntry()
2265 group = ReadInt16();
2268 catch ( FormatError )
2270 // We reached the EOF (or an error occured) therefore
2271 // header parsing has to be considered as finished.
2275 // Sometimes file contains groups of tags with reversed endianess.
2276 HandleBrokenEndian(group, elem);
2278 // In 'true DICOM' files Group 0002 is always little endian
2279 if ( HasDCMPreamble )
2280 HandleOutOfGroup0002(group, elem);
2282 std::string vr = FindDocEntryVR();
2283 std::string realVR = vr;
2285 if ( vr == GDCM_UNKNOWN )
2287 if ( elem == 0x0000 ) // Group Length
2289 realVR = "UL"; // must be UL
2291 else if (group%2 == 1 && (elem >= 0x0010 && elem <=0x00ff ))
2293 // DICOM PS 3-5 7.8.1 a) states that those
2294 // (gggg-0010->00FF where gggg is odd) attributes have to be LO
2299 DictEntry *dictEntry = GetDictEntry(group,elem);
2302 realVR = dictEntry->GetVR();
2308 if ( Global::GetVR()->IsVROfSequence(realVR) )
2309 newEntry = NewSeqEntry(group, elem);
2310 else if ( Global::GetVR()->IsVROfStringRepresentable(realVR) )
2311 newEntry = NewValEntry(group, elem, realVR);
2313 newEntry = NewBinEntry(group, elem, realVR);
2315 if ( vr == GDCM_UNKNOWN )
2317 if ( Filetype == ExplicitVR )
2319 // We thought this was explicit VR, but we end up with an
2320 // implicit VR tag. Let's backtrack.
2321 if ( newEntry->GetGroup() != 0xfffe )
2324 int offset = Fp->tellg();
2325 msg = Util::Format("Entry (%04x,%04x) at 0x(%x) should be Explicit VR\n",
2326 newEntry->GetGroup(), newEntry->GetElement(), offset );
2327 gdcmWarningMacro( msg.c_str() );
2330 newEntry->SetImplicitVR();
2335 FindDocEntryLength(newEntry);
2337 catch ( FormatError )
2344 newEntry->SetOffset(Fp->tellg());
2350 * \brief Handle broken private tag from Philips NTSCAN
2351 * where the endianess is being switched to BigEndian
2352 * for no apparent reason
2355 void Document::HandleBrokenEndian(uint16_t &group, uint16_t &elem)
2357 // Endian reversion. Some files contain groups of tags with reversed endianess.
2358 static int reversedEndian = 0;
2359 // try to fix endian switching in the middle of headers
2360 if ((group == 0xfeff) && (elem == 0x00e0))
2362 // start endian swap mark for group found
2364 SwitchByteSwapCode();
2369 else if (group == 0xfffe && elem == 0xe00d && reversedEndian)
2371 // end of reversed endian group
2373 SwitchByteSwapCode();
2375 else if (group == 0xfeff && elem == 0xdde0)
2377 // reversed Sequence Terminator found
2378 // probabely a bug in the header !
2379 // Do what you want, it breaks !
2381 //SwitchByteSwapCode();
2382 gdcmWarningMacro( "Should never get here! reversed Sequence Terminator!" );
2387 else if (group == 0xfffe && elem == 0xe0dd)
2389 gdcmWarningMacro( "Straight Sequence Terminator." );
2394 * \brief Group 0002 is always coded Little Endian
2395 * whatever Transfer Syntax is
2398 void Document::HandleOutOfGroup0002(uint16_t &group, uint16_t &elem)
2400 // Endian reversion. Some files contain groups of tags with reversed endianess.
2401 if ( !Group0002Parsed && group != 0x0002)
2403 Group0002Parsed = true;
2404 // we just came out of group 0002
2405 // if Transfer syntax is Big Endian we have to change CheckSwap
2407 std::string ts = GetTransferSyntax();
2408 if ( !Global::GetTS()->IsTransferSyntax(ts) )
2410 gdcmWarningMacro("True DICOM File, with NO Tansfer Syntax: " << ts );
2414 // Group 0002 is always 'Explicit ...' enven when Transfer Syntax says 'Implicit ..."
2416 if ( Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ImplicitVRLittleEndian )
2418 Filetype = ImplicitVR;
2421 // FIXME Strangely, this works with
2422 //'Implicit VR Transfer Syntax (GE Private)
2423 if ( Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ExplicitVRBigEndian )
2425 gdcmWarningMacro("Transfer Syntax Name = ["
2426 << GetTransferSyntaxName() << "]" );
2427 SwitchByteSwapCode();
2428 group = SwapShort(group);
2429 elem = SwapShort(elem);
2434 //-----------------------------------------------------------------------------
2437 //-----------------------------------------------------------------------------
2438 } // end namespace gdcm