2 //-----------------------------------------------------------------------------
3 #include "gdcmParser.h"
11 #include <netinet/in.h>
14 #ifdef GDCM_NO_ANSI_STRING_STREAM
16 # define ostringstream ostrstream
22 #define UI1_2_840_10008_1_2 "1.2.840.10008.1.2"
23 #define UI1_2_840_10008_1_2_1 "1.2.840.10008.1.2.1"
24 #define UI1_2_840_10008_1_2_2 "1.2.840.10008.1.2.2"
25 #define UI1_2_840_10008_1_2_1_99 "1.2.840.10008.1.2.1.99"
29 // ---> Warning : This fourth field is NOT part
30 // of the 'official' Dicom Dictionnary
31 // and should NOT be used.
32 // (Not defined for all the groups
33 // may be removed in a future release)
36 // META Meta Information
48 // NMI Nuclear Medicine
50 // BFS Basic Film Session
52 // BIB Basic Image Box
67 // Other usefull abreviations :
68 // Radiographic view associated with Patient Position (0018,5100).
71 // AP = Anterior/Posterior
72 // PA = Posterior/Anterior
75 // RLD = Right Lateral Decubitus
76 // LLD = Left Lateral Decubitus
77 // RLO = Right Lateral Oblique
78 // LLO = Left Lateral Oblique
80 //-----------------------------------------------------------------------------
81 // Refer to gdcmParser::CheckSwap()
82 const unsigned int gdcmParser::HEADER_LENGTH_TO_READ = 256;
84 // Refer to gdcmParser::SetMaxSizeLoadEntry()
85 const unsigned int gdcmParser::MAX_SIZE_LOAD_ELEMENT_VALUE = 4096;
87 // Refer to gdcmParser::SetMaxSizePrintEntry()
88 // TODO : Right now, better see "define, in gdcmHederEntry.cxx
89 const unsigned int gdcmParser::MAX_SIZE_PRINT_ELEMENT_VALUE = 64;
91 //-----------------------------------------------------------------------------
92 // Constructor / Destructor
98 * @param exception_on_error whether we throw an exception or not
99 * @param enable_sequences = true to allow the header
100 * to be parsed *inside* the SeQuences,
101 * when they have an actual length
102 * @param ignore_shadow to allow skipping the shadow elements,
103 * to save memory space.
104 * \warning The TRUE value for this param has to be used
105 * with a FALSE value for the 'enable_sequence' param.
106 * ('public elements' may be embedded in 'shadow Sequences')
108 gdcmParser::gdcmParser(const char *inFilename,
109 bool exception_on_error,
110 bool enable_sequences,
111 bool ignore_shadow) {
112 enableSequences=enable_sequences;
113 ignoreShadow =ignore_shadow;
115 SetMaxSizeLoadEntry(MAX_SIZE_LOAD_ELEMENT_VALUE);
116 filename = inFilename;
119 if ( !OpenFile(exception_on_error))
126 wasUpdated = 0; // will be set to 1 if user adds an entry
127 printLevel = 1; // 'Medium' print level by default
131 * \ingroup gdcmParser
133 * @param exception_on_error
135 gdcmParser::gdcmParser(bool exception_on_error) {
138 SetMaxSizeLoadEntry(MAX_SIZE_LOAD_ELEMENT_VALUE);
141 wasUpdated = 0; // will be set to 1 if user adds an entry
142 printLevel = 1; // 'Medium' print level by default
146 * \ingroup gdcmParser
147 * \brief Canonical destructor.
149 gdcmParser::~gdcmParser (void) {
154 //-----------------------------------------------------------------------------
157 * \ingroup gdcmParser
158 * \brief Prints the Header Entries (Dicom Elements)
159 * both from the H Table and the chained list
162 void gdcmParser::PrintEntry(std::ostream & os) {
163 std::ostringstream s;
165 for (ListTag::iterator i = listEntries.begin();
166 i != listEntries.end();
169 (*i)->SetPrintLevel(printLevel);
176 * \ingroup gdcmParser
177 * \brief Prints The Dict Entries of THE public Dicom Dictionnry
180 void gdcmParser::PrintPubDict(std::ostream & os) {
181 RefPubDict->Print(os);
185 * \ingroup gdcmParser
186 * \brief Prints The Dict Entries of THE shadow Dicom Dictionnry
189 void gdcmParser::PrintShaDict(std::ostream & os) {
190 RefShaDict->Print(os);
193 //-----------------------------------------------------------------------------
196 * \ingroup gdcmParser
197 * \brief Get the public dictionary used
199 gdcmDict *gdcmParser::GetPubDict(void) {
204 * \ingroup gdcmParser
205 * \brief Get the shadow dictionary used
207 gdcmDict *gdcmParser::GetShaDict(void) {
212 * \ingroup gdcmParser
213 * \brief Set the shadow dictionary used
214 * \param dict dictionary to use in shadow
216 bool gdcmParser::SetShaDict(gdcmDict *dict){
222 * \ingroup gdcmParser
223 * \brief Set the shadow dictionary used
224 * \param dictName name of the dictionary to use in shadow
226 bool gdcmParser::SetShaDict(DictKey dictName){
227 RefShaDict=gdcmGlobal::GetDicts()->GetDict(dictName);
232 * \ingroup gdcmParser
233 * \brief This predicate, based on hopefully reasonable heuristics,
234 * decides whether or not the current gdcmParser was properly parsed
235 * and contains the mandatory information for being considered as
236 * a well formed and usable Dicom/Acr File.
237 * @return true when gdcmParser is the one of a reasonable Dicom/Acr file,
240 bool gdcmParser::IsReadable(void) {
241 if(filetype==Unknown) {
244 if(listEntries.size()<=0) {
252 * \ingroup gdcmParser
253 * \brief Determines if the Transfer Syntax was already encountered
254 * and if it corresponds to a ImplicitVRLittleEndian one.
255 * @return True when ImplicitVRLittleEndian found. False in all other cases.
257 bool gdcmParser::IsImplicitVRLittleEndianTransferSyntax(void) {
258 gdcmHeaderEntry *Element = GetHeaderEntryByNumber(0x0002, 0x0010);
261 LoadHeaderEntrySafe(Element);
263 std::string Transfer = Element->GetValue();
264 if ( Transfer == UI1_2_840_10008_1_2 )
270 * \ingroup gdcmParser
271 * \brief Determines if the Transfer Syntax was already encountered
272 * and if it corresponds to a ExplicitVRLittleEndian one.
273 * @return True when ExplicitVRLittleEndian found. False in all other cases.
275 bool gdcmParser::IsExplicitVRLittleEndianTransferSyntax(void) {
276 gdcmHeaderEntry* Element = GetHeaderEntryByNumber(0x0002, 0x0010);
279 LoadHeaderEntrySafe(Element);
281 std::string Transfer = Element->GetValue();
282 if ( Transfer == UI1_2_840_10008_1_2_1 )
288 * \ingroup gdcmParser
289 * \brief Determines if the Transfer Syntax was already encountered
290 * and if it corresponds to a DeflatedExplicitVRLittleEndian one.
291 * @return True when DeflatedExplicitVRLittleEndian found. False in all other cases.
293 bool gdcmParser::IsDeflatedExplicitVRLittleEndianTransferSyntax(void) {
294 gdcmHeaderEntry* Element = GetHeaderEntryByNumber(0x0002, 0x0010);
297 LoadHeaderEntrySafe(Element);
299 std::string Transfer = Element->GetValue();
300 if ( Transfer == UI1_2_840_10008_1_2_1_99 )
306 * \ingroup gdcmParser
307 * \brief Determines if the Transfer Syntax was already encountered
308 * and if it corresponds to a Explicit VR Big Endian one.
309 * @return True when big endian found. False in all other cases.
311 bool gdcmParser::IsExplicitVRBigEndianTransferSyntax(void) {
312 gdcmHeaderEntry* Element = GetHeaderEntryByNumber(0x0002, 0x0010);
315 LoadHeaderEntrySafe(Element);
317 std::string Transfer = Element->GetValue();
318 if ( Transfer == UI1_2_840_10008_1_2_2 ) //1.2.2 ??? A verifier !
324 * \ingroup gdcmParser
325 * \brief returns the File Type
326 * (ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown)
327 * @return the FileType code
329 FileType gdcmParser::GetFileType(void) {
334 * \ingroup gdcmParser
335 * \brief opens the file
336 * @param exception_on_error
339 FILE *gdcmParser::OpenFile(bool exception_on_error)
342 fp=fopen(filename.c_str(),"rb");
343 if(exception_on_error)
346 throw gdcmFileError("gdcmParser::gdcmParser(const char *, bool)");
352 fread(&zero, (size_t)2, (size_t)1, fp);
354 //ACR -- or DICOM with no Preamble --
355 if( zero == 0x0008 || zero == 0x0800 || zero == 0x0002 || zero == 0x0200)
359 fseek(fp, 126L, SEEK_CUR);
361 fread(dicm, (size_t)4, (size_t)1, fp);
362 if( memcmp(dicm, "DICM", 4) == 0 )
366 dbg.Verbose(0, "gdcmParser::OpenFile not DICOM/ACR", filename.c_str());
369 dbg.Verbose(0, "gdcmParser::OpenFile cannot open file", filename.c_str());
375 * \ingroup gdcmParser
376 * \brief closes the file
377 * @return TRUE if the close was successfull
379 bool gdcmParser::CloseFile(void) {
380 int closed = fclose(fp);
388 * \ingroup gdcmParser
389 * \brief writes on disc all the Header Entries (Dicom Elements)
390 * of the Chained List
391 * @param fp file pointer on an already open file
392 * @param type type of the File to be written
393 * (ACR-NEMA, ExplicitVR, ImplicitVR)
394 * @return always "True" ?!
396 bool gdcmParser::Write(FILE *fp, FileType type) {
398 // TODO The stuff was rewritten using the chained list instead
400 // so we could remove the GroupHT from the gdcmParser
404 // TODO : move the following lines (and a lot of others, to be written)
405 // to a future function CheckAndCorrectHeader
408 // Comment pourrait-on savoir si le DcmHeader vient d'un fichier DicomV3 ou non
409 // (FileType est un champ de gdcmParser ...)
410 // WARNING : Si on veut ecrire du DICOM V3 a partir d'un DcmHeader ACR-NEMA
412 // a moins de se livrer a un tres complique ajout des champs manquants.
413 // faire un CheckAndCorrectHeader (?)
416 if (type == ImplicitVR)
418 std::string implicitVRTransfertSyntax = UI1_2_840_10008_1_2;
419 ReplaceOrCreateByNumber(implicitVRTransfertSyntax,0x0002, 0x0010);
421 //FIXME Refer to standards on page 21, chapter 6.2 "Value representation":
422 // values with a VR of UI shall be padded with a single trailing null
423 // Dans le cas suivant on doit pader manuellement avec un 0
425 SetEntryLengthByNumber(18, 0x0002, 0x0010);
428 if (type == ExplicitVR)
430 std::string explicitVRTransfertSyntax = UI1_2_840_10008_1_2_1;
431 ReplaceOrCreateByNumber(explicitVRTransfertSyntax,0x0002, 0x0010);
433 //FIXME Refer to standards on page 21, chapter 6.2 "Value representation":
434 // values with a VR of UI shall be padded with a single trailing null
435 // Dans le cas suivant on doit pader manuellement avec un 0
437 SetEntryLengthByNumber(20, 0x0002, 0x0010);
440 /* TODO : rewrite later
442 if ( (type == ImplicitVR) || (type == ExplicitVR) )
443 UpdateGroupLength(false,type);
445 UpdateGroupLength(true,ACR);
448 WriteEntries(fp,type);
453 * \ingroup gdcmParser
454 * \brief Modifies the value of a given Header Entry (Dicom Element)
455 * if it exists; Creates it with the given value if it doesn't
456 * \warning : adds the Header Entry to the HTable, NOT to the chained List
457 * @param Value passed as a std::string
458 * @param Group group of the Entry
459 * @param Elem element of the Entry
460 * \return pointer to the created Header Entry
461 * NULL if creation failed
463 gdcmHeaderEntry * gdcmParser::ReplaceOrCreateByNumber(
468 a = GetHeaderEntryByNumber( Group, Elem);
470 gdcmHeaderEntry *a =NewHeaderEntryByNumber(Group, Elem);
475 //SetEntryByNumber(Value, Group, Elem);
481 * \ingroup gdcmParser
482 * \brief Modifies the value of a given Header Entry (Dicom Element)
483 * if it exists; Creates it with the given value if it doesn't
484 * @param Value passed as a char*
485 * @param Group group of the Entry
486 * @param Elem element of the Entry
487 * \return pointer to the created Header Entry
488 * NULL if creation failed
491 gdcmHeaderEntry * gdcmParser::ReplaceOrCreateByNumber(
495 gdcmHeaderEntry* nvHeaderEntry=NewHeaderEntryByNumber(Group, Elem);
500 AddHeaderEntry(nvHeaderEntry);
502 std::string v = Value;
503 SetEntryByNumber(v, Group, Elem);
504 return(nvHeaderEntry);
508 * \ingroup gdcmParser
509 * \brief Set a new value if the invoked element exists
510 * Seems to be useless !!!
511 * @param Value new element value
512 * @param Group group of the Entry
513 * @param Elem element of the Entry
516 bool gdcmParser::ReplaceIfExistByNumber(char* Value, guint16 Group, guint16 Elem )
518 std::string v = Value;
519 SetEntryByNumber(v, Group, Elem);
523 //-----------------------------------------------------------------------------
527 * \ingroup gdcmParser
528 * \brief Checks if a given Dicom Element exists
530 * @param group Group number of the searched Dicom Element
531 * @param element Element number of the searched Dicom Element
532 * @return number of occurences
534 int gdcmParser::CheckIfEntryExistByNumber(guint16 group, guint16 element ) {
535 std::string key = gdcmDictEntry::TranslateToKey(group, element );
536 return (tagHT.count(key));
540 * \ingroup gdcmParser
541 * \brief Searches within Header Entries (Dicom Elements) parsed with
542 * the public and private dictionaries
543 * for the element value of a given tag.
544 * \warning Don't use any longer : use GetPubEntryByName
545 * @param tagName name of the searched element.
546 * @return Corresponding element value when it exists,
547 * and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise.
549 std::string gdcmParser::GetEntryByName(std::string tagName) {
550 gdcmDictEntry *dictEntry = RefPubDict->GetDictEntryByName(tagName);
551 if( dictEntry == NULL)
554 return(GetEntryByNumber(dictEntry->GetGroup(),dictEntry->GetElement()));
558 * \ingroup gdcmParser
559 * \brief Searches within Header Entries (Dicom Elements) parsed with
560 * the public and private dictionaries
561 * for the element value representation of a given tag.
563 * Obtaining the VR (Value Representation) might be needed by caller
564 * to convert the string typed content to caller's native type
565 * (think of C++ vs Python). The VR is actually of a higher level
566 * of semantics than just the native C++ type.
567 * @param tagName name of the searched element.
568 * @return Corresponding element value representation when it exists,
569 * and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise.
571 std::string gdcmParser::GetEntryVRByName(std::string tagName) {
572 gdcmDictEntry *dictEntry = RefPubDict->GetDictEntryByName(tagName);
573 if( dictEntry == NULL)
576 gdcmHeaderEntry* elem = GetHeaderEntryByNumber(dictEntry->GetGroup(),
577 dictEntry->GetElement());
578 return elem->GetVR();
583 * \ingroup gdcmParser
584 * \brief Searches within Header Entries (Dicom Elements) parsed with
585 * the public and private dictionaries
586 * for the element value representation of a given tag.
587 * @param group Group of the searched tag.
588 * @param element Element of the searched tag.
589 * @return Corresponding element value representation when it exists,
590 * and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise.
592 std::string gdcmParser::GetEntryByNumber(guint16 group, guint16 element){
593 TagKey key = gdcmDictEntry::TranslateToKey(group, element);
594 if ( ! tagHT.count(key))
596 return tagHT.find(key)->second->GetValue();
600 * \ingroup gdcmParser
601 * \brief Searches within Header Entries (Dicom Elements) parsed with
602 * the public and private dictionaries
603 * for the element value representation of a given tag..
605 * Obtaining the VR (Value Representation) might be needed by caller
606 * to convert the string typed content to caller's native type
607 * (think of C++ vs Python). The VR is actually of a higher level
608 * of semantics than just the native C++ type.
609 * @param group Group of the searched tag.
610 * @param element Element of the searched tag.
611 * @return Corresponding element value representation when it exists,
612 * and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise.
614 std::string gdcmParser::GetEntryVRByNumber(guint16 group, guint16 element) {
615 gdcmHeaderEntry* elem = GetHeaderEntryByNumber(group, element);
618 return elem->GetVR();
622 * \ingroup gdcmParser
623 * \brief Searches within Header Entries (Dicom Elements) parsed with
624 * the public and private dictionaries
625 * for the value length of a given tag..
626 * @param group Group of the searched tag.
627 * @param element Element of the searched tag.
628 * @return Corresponding element length; -2 if not found
630 int gdcmParser::GetEntryLengthByNumber(guint16 group, guint16 element) {
631 gdcmHeaderEntry* elem = GetHeaderEntryByNumber(group, element);
634 return elem->GetLength();
637 * \ingroup gdcmParser
638 * \brief Sets the value (string) of the Header Entry (Dicom Element)
639 * @param content string value of the Dicom Element
640 * @param tagName name of the searched Dicom Element.
641 * @return true when found
643 bool gdcmParser::SetEntryByName(std::string content,std::string tagName) {
644 gdcmDictEntry *dictEntry = RefPubDict->GetDictEntryByName(tagName);
645 if( dictEntry == NULL)
648 return(SetEntryByNumber(content,dictEntry->GetGroup(),
649 dictEntry->GetElement()));
653 * \ingroup gdcmParser
654 * \brief Accesses an existing gdcmHeaderEntry (i.e. a Dicom Element)
655 * through it's (group, element) and modifies it's content with
657 * \warning Don't use any longer : use SetPubEntryByNumber
658 * @param content new value to substitute with
659 * @param group group of the Dicom Element to modify
660 * @param element element of the Dicom Element to modify
662 bool gdcmParser::SetEntryByNumber(std::string content,
666 TagKey key = gdcmDictEntry::TranslateToKey(group, element);
667 if ( ! tagHT.count(key))
669 int l = content.length();
670 if(l%2) // Non even length are padded with a space (020H).
673 content = content + '\0';
678 TagHeaderEntryHT::iterator p2;
679 // DO NOT remove the following lines : they explain the stuff
680 //p= tagHT.equal_range(key); // get a pair of iterators first-last synonym
681 //p2=p.first; // iterator on the first synonym
682 //a=p2->second; // H Table target column (2-nd col)
685 a = ((tagHT.equal_range(key)).first)->second;
687 a-> SetValue(content);
689 std::string vr = a->GetVR();
692 if( (vr == "US") || (vr == "SS") )
694 else if( (vr == "UL") || (vr == "SL") )
704 * \ingroup gdcmParser
705 * \brief Accesses an existing gdcmHeaderEntry (i.e. a Dicom Element)
706 * in the PubHeaderEntrySet of this instance
707 * through it's (group, element) and modifies it's length with
709 * \warning Use with extreme caution.
710 * @param l new length to substitute with
711 * @param group group of the Entry to modify
712 * @param element element of the Entry to modify
713 * @return true on success, false otherwise.
715 bool gdcmParser::SetEntryLengthByNumber(guint32 l,
719 TagKey key = gdcmDictEntry::TranslateToKey(group, element);
720 if ( ! tagHT.count(key))
722 if (l%2) l++; // length must be even
723 ( ((tagHT.equal_range(key)).first)->second )->SetLength(l);
729 * \ingroup gdcmParser
730 * \brief Gets (from Header) the offset of a 'non string' element value
731 * (LoadElementValues has already be executed)
732 * @param Group group of the Entry
733 * @param Elem element of the Entry
734 * @return File Offset of the Element Value
736 size_t gdcmParser::GetEntryOffsetByNumber(guint16 Group, guint16 Elem)
738 gdcmHeaderEntry* Entry = GetHeaderEntryByNumber(Group, Elem);
741 dbg.Verbose(1, "gdcmParser::GetHeaderEntryByNumber",
742 "failed to Locate gdcmHeaderEntry");
745 return Entry->GetOffset();
749 * \ingroup gdcmParser
750 * \brief Gets (from Header) a 'non string' element value
751 * (LoadElementValues has already be executed)
752 * @param Group group of the Entry
753 * @param Elem element of the Entry
754 * @return Pointer to the 'non string' area
756 void * gdcmParser::GetEntryVoidAreaByNumber(guint16 Group, guint16 Elem)
758 gdcmHeaderEntry* Entry = GetHeaderEntryByNumber(Group, Elem);
761 dbg.Verbose(1, "gdcmParser::GetHeaderEntryByNumber",
762 "failed to Locate gdcmHeaderEntry");
765 return Entry->GetVoidArea();
769 * \ingroup gdcmParser
770 * \brief Loads (from disk) the element content
771 * when a string is not suitable
772 * @param Group group of the Entry
773 * @param Elem element of the Entry
775 void *gdcmParser::LoadEntryVoidArea(guint16 Group, guint16 Elem)
777 gdcmHeaderEntry * Element= GetHeaderEntryByNumber(Group, Elem);
780 size_t o =(size_t)Element->GetOffset();
781 fseek(fp, o, SEEK_SET);
782 int l=Element->GetLength();
783 void * a = malloc(l);
787 SetEntryVoidAreaByNumber(a, Group, Elem);
788 // TODO check the result
789 size_t l2 = fread(a, 1, l ,fp);
800 * \ingroup gdcmParser
801 * \brief Sets a 'non string' value to a given Dicom Element
803 * @param group Group number of the searched Dicom Element
804 * @param element Element number of the searched Dicom Element
807 bool gdcmParser::SetEntryVoidAreaByNumber(void * area,
811 TagKey key = gdcmDictEntry::TranslateToKey(group, element);
812 if ( ! tagHT.count(key))
814 ( ((tagHT.equal_range(key)).first)->second )->SetVoidArea(area);
819 * \ingroup gdcmParser
820 * \brief Update the entries with the shadow dictionary.
821 * Only non even entries are analyzed
823 void gdcmParser::UpdateShaEntries(void) {
824 gdcmDictEntry *entry;
827 for(ListTag::iterator it=listEntries.begin();
828 it!=listEntries.end();
831 // Odd group => from public dictionary
832 if((*it)->GetGroup()%2==0)
835 // Peer group => search the corresponding dict entry
837 entry=RefShaDict->GetDictEntryByNumber((*it)->GetGroup(),(*it)->GetElement());
841 if((*it)->IsImplicitVR())
846 (*it)->SetValue(GetHeaderEntryUnvalue(*it));
848 // Set the new entry and the new value
849 (*it)->SetDictEntry(entry);
850 CheckHeaderEntryVR(*it,vr);
852 (*it)->SetValue(GetHeaderEntryValue(*it));
856 // Remove precedent value transformation
857 (*it)->SetDictEntry(NewVirtualDictEntry((*it)->GetGroup(),(*it)->GetElement(),vr));
863 * \ingroup gdcmParser
864 * \brief Searches within the Header Entries for a Dicom Element of
866 * @param tagName name of the searched Dicom Element.
867 * @return Corresponding Dicom Element when it exists, and NULL
870 gdcmHeaderEntry *gdcmParser::GetHeaderEntryByName(std::string tagName) {
871 gdcmDictEntry *dictEntry = RefPubDict->GetDictEntryByName(tagName);
872 if( dictEntry == NULL)
875 return(GetHeaderEntryByNumber(dictEntry->GetGroup(),dictEntry->GetElement()));
879 * \ingroup gdcmParser
880 * \brief retrieves a Dicom Element (the first one) using (group, element)
881 * \warning (group, element) IS NOT an identifier inside the Dicom Header
882 * if you think it's NOT UNIQUE, check the count number
883 * and use iterators to retrieve ALL the Dicoms Elements within
884 * a given couple (group, element)
885 * @param group Group number of the searched Dicom Element
886 * @param element Element number of the searched Dicom Element
889 gdcmHeaderEntry* gdcmParser::GetHeaderEntryByNumber(guint16 group, guint16 element)
891 TagKey key = gdcmDictEntry::TranslateToKey(group, element);
892 if ( ! tagHT.count(key))
894 return tagHT.find(key)->second;
898 * \ingroup gdcmParser
899 * \brief retrieves the Dicom Elements (all of them) using (group, element)
900 * @param group Group number of the searched Dicom Element.
901 * @param element Element number of the searched Dicom Element.
902 * @return a range (i.e.pair<,>) containing all elements whose key is group|element)
905 IterHT gdcmParser::GetHeaderEntrySameNumber(guint16 group, guint16 element){
906 TagKey key = gdcmDictEntry::TranslateToKey(group, element);
907 return (tagHT.equal_range(key));
911 * \ingroup gdcmParser
912 * \brief Loads the element while preserving the current
913 * underlying file position indicator as opposed to
914 * to LoadHeaderEntry that modifies it.
915 * @param entry Header Entry whose value shall be loaded.
918 void gdcmParser::LoadHeaderEntrySafe(gdcmHeaderEntry * entry) {
919 long PositionOnEntry = ftell(fp);
920 LoadHeaderEntry(entry);
921 fseek(fp, PositionOnEntry, SEEK_SET);
925 * \ingroup gdcmParser
926 * \brief Re-computes the length of a ACR-NEMA/Dicom group from a DcmHeader
927 * \warning : to be re-written using the chained list instead of the H table.
928 * \warning : DO NOT use (doesn't work any longer because of the multimap)
929 * \todo : to be re-written using the chained list instead of the H table
930 * @param SkipSequence TRUE if we don't want to write Sequences (ACR-NEMA Files)
931 * @param type Type of the File (ExplicitVR,ImplicitVR, ACR, ...)
933 void gdcmParser::UpdateGroupLength(bool SkipSequence, FileType type) {
937 gdcmHeaderEntry *elem;
939 std::string str_trash;
942 GroupHT groupHt; // to hold the length of each group
945 // typedef std::map<GroupKey, int> GroupHT;
947 gdcmHeaderEntry *elemZ;
949 // for each Tag in the DCM Header
951 for (TagHeaderEntryHT::iterator tag2 = tagHT.begin();
956 gr = elem->GetGroup();
957 el = elem->GetElement();
960 sprintf(trash, "%04x", gr);
961 key = trash; // generate 'group tag'
963 // if the caller decided not to take SEQUENCEs into account
964 // e.g : he wants to write an ACR-NEMA File
966 if (SkipSequence && vr == "SQ")
969 // Still unsolved problem :
970 // we cannot find the 'Sequence Delimitation Item'
971 // since it's at the end of the Hash Table
974 // pas SEQUENCE en ACR-NEMA
976 // --> la descente a l'interieur' des SQ
977 // devrait etre faite avec une liste chainee, pas avec une HTable...
979 if ( groupHt.count(key) == 0) // we just read the first elem of a given group
981 if (el == 0x0000) // the first elem is 0x0000
983 groupHt[key] = 0; // initialize group length
987 groupHt[key] = 2 + 2 + 4 + elem->GetLength(); // non 0x0000 first group elem
990 else // any elem but the first
992 if (type == ExplicitVR)
994 if ( (vr == "OB") || (vr == "OW") || (vr == "SQ") )
996 groupHt[key] += 4; // explicit VR AND OB, OW, SQ : 4 more bytes
999 groupHt[key] += 2 + 2 + 4 + elem->GetLength();
1003 unsigned short int gr_bid;
1005 for (GroupHT::iterator g = groupHt.begin(); // for each group we found
1009 // FIXME: g++ -Wall -Wstrict-prototypes reports on following line:
1010 // warning: unsigned int format, different type arg
1011 sscanf(g->first.c_str(),"%x",&gr_bid);
1012 tk = g->first + "|0000"; // generate the element full tag
1014 if ( tagHT.count(tk) == 0) // if element 0x0000 not found
1016 gdcmDictEntry * tagZ = new gdcmDictEntry(gr_bid, 0x0000, "UL");
1017 elemZ = new gdcmHeaderEntry(tagZ);
1018 elemZ->SetLength(4);
1019 AddHeaderEntry(elemZ); // create it
1023 elemZ=GetHeaderEntryByNumber(gr_bid, 0x0000);
1025 sprintf(trash ,"%d",g->second);
1027 elemZ->SetValue(str_trash);
1032 * \ingroup gdcmParser
1033 * \brief writes on disc according to the requested format
1034 * (ACR-NEMA, ExplicitVR, ImplicitVR) ONE
1036 * @param tag pointer on the gdcmHeaderEntry to be written
1037 * @param type type of the File to be written
1038 * (ACR-NEMA, ExplicitVR, ImplicitVR)
1039 * @param _fp already open file pointer
1041 void gdcmParser::WriteEntry(gdcmHeaderEntry *tag, FILE *_fp,FileType type)
1052 std::vector<std::string> tokens;
1056 // TODO (?) tester les echecs en ecriture (apres chaque fwrite)
1058 itsTimeToWritePixels = false;
1060 // === Deal with the length
1061 // --------------------
1062 if((tag->GetLength())%2==1)
1064 tag->SetValue(tag->GetValue()+"\0");
1065 tag->SetLength(tag->GetReadLength()+1);
1068 gr = tag->GetGroup();
1069 el = tag->GetElement();
1070 lgr = tag->GetReadLength();
1071 val = tag->GetValue().c_str();
1073 voidArea = tag->GetVoidArea();
1077 if (gr < 0x0008) return; // ignore pure DICOM V3 groups
1078 if (gr %2) return; // ignore shadow groups
1079 if (vr == "SQ" ) return; // ignore Sequences
1080 // TODO : find a trick to *skip* the SeQuences !
1081 // Not only ignore the SQ element
1082 if (gr == 0xfffe ) return; // ignore delimiters
1085 fwrite ( &gr,(size_t)2 ,(size_t)1 ,_fp); //group
1086 fwrite ( &el,(size_t)2 ,(size_t)1 ,_fp); //element
1088 if ( (type == ExplicitVR) || (type == DICOMDIR) ) {
1090 guint16 z=0, shortLgr;
1092 if (gr == 0xfffe) { // NO Value Representation for 'delimiters'
1093 // no length : write ffffffff
1094 fwrite (&ff,(size_t)4 ,(size_t)1 ,_fp);
1095 return; // NO value for 'delimiters'
1099 if (vr == "unkn") { // Unknown was 'written'
1100 // deal with Little Endian
1101 fwrite ( &shortLgr,(size_t)2 ,(size_t)1 ,_fp);
1102 fwrite ( &z, (size_t)2 ,(size_t)1 ,_fp);
1104 fwrite (vr.c_str(),(size_t)2 ,(size_t)1 ,_fp);
1105 if ( (vr == "OB") || (vr == "OW") || (vr == "SQ") ){
1106 fwrite ( &z, (size_t)2 ,(size_t)1 ,_fp);
1107 fwrite ( &lgr,(size_t)4 ,(size_t)1 ,_fp);
1109 fwrite ( &shortLgr,(size_t)2 ,(size_t)1 ,_fp);
1115 fwrite ( &lgr,(size_t)4 ,(size_t)1 ,_fp);
1118 // === Deal with the value
1119 // -------------------
1120 if (vr == "SQ") return; // no "value" to write for the SEQuences
1121 if (gr == 0xfffe)return; // no "value" to write for the delimiters
1123 if (voidArea != NULL)
1124 { // there is a 'non string' LUT, overlay, etc
1125 fwrite ( voidArea,(size_t)lgr ,(size_t)1 ,_fp); // Elem value
1129 if (vr == "US" || vr == "SS")
1131 tokens.erase(tokens.begin(),tokens.end()); // clean any previous value
1132 Tokenize (tag->GetValue(), tokens, "\\");
1133 for (unsigned int i=0; i<tokens.size();i++)
1135 val_uint16 = atoi(tokens[i].c_str());
1137 fwrite ( ptr,(size_t)2 ,(size_t)1 ,_fp);
1142 if (vr == "UL" || vr == "SL")
1144 tokens.erase(tokens.begin(),tokens.end()); // clean any previous value
1145 Tokenize (tag->GetValue(), tokens, "\\");
1146 for (unsigned int i=0; i<tokens.size();i++)
1148 val_uint32 = atoi(tokens[i].c_str());
1150 fwrite ( ptr,(size_t)4 ,(size_t)1 ,_fp);
1156 // Pixels are never loaded in the element !
1157 // we stop writting when Pixel are processed
1158 // FIX : we loose trailing elements (RAB, right now)
1160 if ((gr == GrPixel) && (el == NumPixel) ) {
1162 if (compte == countGrPixel) {// we passed *all* the GrPixel,NumPixel
1163 itsTimeToWritePixels = true;
1167 fwrite ( val,(size_t)lgr ,(size_t)1 ,_fp); // Elem value
1171 * \ingroup gdcmParser
1172 * \brief writes on disc according to the requested format
1173 * (ACR-NEMA, ExplicitVR, ImplicitVR) the image
1174 * using the Chained List
1175 * \warning does NOT add the missing elements in the header :
1176 * it's up to the user doing it !
1177 * (function CheckHeaderCoherence to be written)
1178 * \warning DON'T try, right now, to write a DICOM image
1179 * from an ACR Header (meta elements will be missing!)
1180 * \sa WriteEntriesDeprecated (Special temporary method for Theralys)
1181 * @param type type of the File to be written
1182 * (ACR-NEMA, ExplicitVR, ImplicitVR)
1183 * @param _fp already open file pointer
1186 void gdcmParser::WriteEntries(FILE *_fp,FileType type)
1188 // TODO (?) tester les echecs en ecriture (apres chaque fwrite)
1190 for (ListTag::iterator tag2=listEntries.begin();
1191 tag2 != listEntries.end();
1194 WriteEntry(*tag2,_fp,type);
1195 if (itsTimeToWritePixels)
1201 * \ingroup gdcmParser
1202 * \brief writes on disc according to the requested format
1203 * (ACR-NEMA, ExplicitVR, ImplicitVR) the image,
1204 * using only the last synonym of each mutimap H Table post.
1205 * \warning Uses the H Table, instead of the Chained List
1206 * in order to be compliant with the old way to proceed
1207 * (added elements taken in to account)
1208 * Only THERALYS, during a transitory phase is supposed
1209 * to use this method !!!
1210 * \warning DON'T try, right now, to write a DICOM image
1211 * from an ACR Header (meta elements will be missing!)
1213 * @param _fp already open file pointer
1214 * @param type type of the File to be written
1215 * (ACR-NEMA, ExplicitVR, ImplicitVR)
1217 void gdcmParser::WriteEntriesDeprecated(FILE *_fp,FileType type) {
1219 // restent a tester les echecs en ecriture (apres chaque fwrite)
1221 for (TagHeaderEntryHT::iterator tag2=tagHT.begin();
1222 tag2 != tagHT.end();
1224 WriteEntry(tag2->second,_fp,type);
1225 if (itsTimeToWritePixels)
1231 * \ingroup gdcmParser
1232 * \brief Swaps back the bytes of 4-byte long integer accordingly to
1234 * @return The properly swaped 32 bits integer.
1236 guint32 gdcmParser::SwapLong(guint32 a) {
1241 a=( ((a<<24) & 0xff000000) | ((a<<8) & 0x00ff0000) |
1242 ((a>>8) & 0x0000ff00) | ((a>>24) & 0x000000ff) );
1246 a=( ((a<<16) & 0xffff0000) | ((a>>16) & 0x0000ffff) );
1250 a=( ((a<<8) & 0xff00ff00) | ((a>>8) & 0x00ff00ff) );
1253 dbg.Error(" gdcmParser::SwapLong : unset swap code");
1260 * \ingroup gdcmParser
1261 * \brief Unswaps back the bytes of 4-byte long integer accordingly to
1263 * @return The properly unswaped 32 bits integer.
1265 guint32 gdcmParser::UnswapLong(guint32 a) {
1266 return (SwapLong(a));
1270 * \ingroup gdcmParser
1271 * \brief Swaps the bytes so they agree with the processor order
1272 * @return The properly swaped 16 bits integer.
1274 guint16 gdcmParser::SwapShort(guint16 a) {
1275 if ( (sw==4321) || (sw==2143) )
1276 a =(((a<<8) & 0x0ff00) | ((a>>8)&0x00ff));
1281 * \ingroup gdcmParser
1282 * \brief Unswaps the bytes so they agree with the processor order
1283 * @return The properly unswaped 16 bits integer.
1285 guint16 gdcmParser::UnswapShort(guint16 a) {
1286 return (SwapShort(a));
1289 //-----------------------------------------------------------------------------
1292 * \ingroup gdcmParser
1293 * \brief Parses the header of the file but WITHOUT loading element values.
1294 * @return false if file is not ACR-NEMA / DICOM
1296 bool gdcmParser::ParseHeader(bool exception_on_error) throw(gdcmFormatError) {
1302 gdcmHeaderEntry *newHeaderEntry = (gdcmHeaderEntry *)0;
1303 while ( (newHeaderEntry = ReadNextHeaderEntry()) ) {
1304 SkipHeaderEntry(newHeaderEntry);
1305 if ( (ignoreShadow==0) || (newHeaderEntry->GetGroup()%2) == 0) {
1306 AddHeaderEntry(newHeaderEntry);
1313 * \ingroup gdcmParser
1314 * \brief Loads the element values of all the Header Entries pointed in the
1315 * public Chained List.
1317 void gdcmParser::LoadHeaderEntries(void) {
1319 for (ListTag::iterator i = GetListEntry().begin();
1320 i != GetListEntry().end();
1323 LoadHeaderEntry(*i);
1328 // Load 'non string' values
1329 std::string PhotometricInterpretation = GetEntryByNumber(0x0028,0x0004);
1330 if( PhotometricInterpretation == "PALETTE COLOR " ) {
1331 LoadEntryVoidArea(0x0028,0x1200); // gray LUT
1332 LoadEntryVoidArea(0x0028,0x1201); // R LUT
1333 LoadEntryVoidArea(0x0028,0x1202); // G LUT
1334 LoadEntryVoidArea(0x0028,0x1203); // B LUT
1336 LoadEntryVoidArea(0x0028,0x1221); // Segmented Red Palette Color LUT Data
1337 LoadEntryVoidArea(0x0028,0x1222); // Segmented Green Palette Color LUT Data
1338 LoadEntryVoidArea(0x0028,0x1223); // Segmented Blue Palette Color LUT Data
1340 //FIXME : how to use it?
1341 LoadEntryVoidArea(0x0028,0x3006); //LUT Data (CTX dependent)
1343 // --------------------------------------------------------------
1344 // Special Patch to allow gdcm to read ACR-LibIDO formated images
1346 // if recognition code tells us we deal with a LibIDO image
1347 // we switch lineNumber and columnNumber
1349 std::string RecCode;
1350 RecCode = GetEntryByNumber(0x0008, 0x0010); // recognition code
1351 if (RecCode == "ACRNEMA_LIBIDO_1.1" ||
1352 RecCode == "CANRME_AILIBOD1_1." )
1354 filetype = ACR_LIBIDO;
1355 std::string rows = GetEntryByNumber(0x0028, 0x0010);
1356 std::string columns = GetEntryByNumber(0x0028, 0x0011);
1357 SetEntryByNumber(columns, 0x0028, 0x0010);
1358 SetEntryByNumber(rows , 0x0028, 0x0011);
1360 // ----------------- End of Special Patch ----------------
1364 * \ingroup gdcmParser
1365 * \brief Loads the element content if its length doesn't exceed
1366 * the value specified with gdcmParser::SetMaxSizeLoadEntry()
1367 * @param Entry Header Entry (Dicom Element) to be dealt with
1369 void gdcmParser::LoadHeaderEntry(gdcmHeaderEntry *Entry) {
1371 guint16 group = Entry->GetGroup();
1372 std::string vr= Entry->GetVR();
1373 guint32 length = Entry->GetLength();
1374 bool SkipLoad = false;
1376 fseek(fp, (long)Entry->GetOffset(), SEEK_SET);
1378 // the test was commented out to 'go inside' the SeQuences
1379 // we don't any longer skip them !
1381 // if( vr == "SQ" ) // (DO NOT remove this comment)
1384 // A SeQuence "contains" a set of Elements.
1385 // (fffe e000) tells us an Element is beginning
1386 // (fffe e00d) tells us an Element just ended
1387 // (fffe e0dd) tells us the current SeQuence just ended
1388 if( group == 0xfffe )
1392 Entry->SetLength(0);
1393 Entry->SetValue("gdcm::Skipped");
1397 // When the length is zero things are easy:
1398 if ( length == 0 ) {
1399 Entry->SetValue("");
1403 // The elements whose length is bigger than the specified upper bound
1404 // are not loaded. Instead we leave a short notice of the offset of
1405 // the element content and it's length.
1406 if (length > MaxSizeLoadEntry) {
1407 std::ostringstream s;
1408 s << "gdcm::NotLoaded.";
1409 s << " Address:" << (long)Entry->GetOffset();
1410 s << " Length:" << Entry->GetLength();
1411 s << " x(" << std::hex << Entry->GetLength() << ")";
1412 Entry->SetValue(s.str());
1416 // When integer(s) are expected, read and convert the following
1417 // n *(two or four bytes)
1418 // properly i.e. as integers as opposed to strings.
1419 // Elements with Value Multiplicity > 1
1420 // contain a set of integers (not a single one)
1422 // Any compacter code suggested (?)
1423 if ( IsHeaderEntryAnInteger(Entry) ) {
1425 std::ostringstream s;
1427 if (vr == "US" || vr == "SS") {
1429 NewInt = ReadInt16();
1432 for (int i=1; i < nbInt; i++) {
1434 NewInt = ReadInt16();
1439 else if (vr == "UL" || vr == "SL") {
1441 NewInt = ReadInt32();
1444 for (int i=1; i < nbInt; i++) {
1446 NewInt = ReadInt32();
1451 #ifdef GDCM_NO_ANSI_STRING_STREAM
1452 s << std::ends; // to avoid oddities on Solaris
1453 #endif //GDCM_NO_ANSI_STRING_STREAM
1455 Entry->SetValue(s.str());
1459 // We need an additional byte for storing \0 that is not on disk
1460 std::string NewValue(length,0);
1461 item_read = fread(&(NewValue[0]), (size_t)length, (size_t)1, fp);
1462 if ( item_read != 1 ) {
1463 dbg.Verbose(1, "gdcmParser::LoadElementValue","unread element value");
1464 Entry->SetValue("gdcm::UnRead");
1468 if( (vr == "UI") ) // Because of correspondance with the VR dic
1469 Entry->SetValue(NewValue.c_str()); // ??? JPR ???
1471 Entry->SetValue(NewValue);
1475 * \ingroup gdcmParser
1476 * \brief add a new Dicom Element pointer to
1477 * the H Table and at the end of the chained List
1478 * \warning push_bash in listEntries ONLY during ParseHeader
1479 * \todo something to allow further Elements addition,
1480 * (at their right place in the chained list)
1481 * when position to be taken care of
1482 * @param newHeaderEntry
1484 void gdcmParser::AddHeaderEntry(gdcmHeaderEntry *newHeaderEntry) {
1485 tagHT.insert( PairHT( newHeaderEntry->GetKey(),newHeaderEntry) );
1486 listEntries.push_back(newHeaderEntry);
1491 * \ingroup gdcmParser
1492 * \brief Find the value Length of the passed Header Entry
1493 * @param Entry Header Entry whose length of the value shall be loaded.
1495 void gdcmParser::FindHeaderEntryLength (gdcmHeaderEntry *Entry) {
1496 guint16 element = Entry->GetElement();
1497 guint16 group = Entry->GetGroup();
1498 std::string vr = Entry->GetVR();
1501 if( (element == NumPixel) && (group == GrPixel) )
1503 dbg.SetDebug(GDCM_DEBUG);
1504 dbg.Verbose(2, "gdcmParser::FindLength: ",
1505 "we reached (GrPixel,NumPixel)");
1508 if ( (filetype == ExplicitVR) && (! Entry->IsImplicitVR()) )
1510 if ( (vr=="OB") || (vr=="OW") || (vr=="SQ") || (vr=="UN") )
1512 // The following reserved two bytes (see PS 3.5-2001, section
1513 // 7.1.2 Data element structure with explicit vr p27) must be
1514 // skipped before proceeding on reading the length on 4 bytes.
1515 fseek(fp, 2L, SEEK_CUR);
1516 guint32 length32 = ReadInt32();
1518 if ( (vr == "OB") && (length32 == 0xffffffff) )
1520 Entry->SetLength(FindHeaderEntryLengthOB());
1523 FixHeaderEntryFoundLength(Entry, length32);
1527 // Length is encoded on 2 bytes.
1528 length16 = ReadInt16();
1530 // We can tell the current file is encoded in big endian (like
1531 // Data/US-RGB-8-epicard) when we find the "Transfer Syntax" tag
1532 // and it's value is the one of the encoding of a big endian file.
1533 // In order to deal with such big endian encoded files, we have
1534 // (at least) two strategies:
1535 // * when we load the "Transfer Syntax" tag with value of big endian
1536 // encoding, we raise the proper flags. Then we wait for the end
1537 // of the META group (0x0002) among which is "Transfer Syntax",
1538 // before switching the swap code to big endian. We have to postpone
1539 // the switching of the swap code since the META group is fully encoded
1540 // in little endian, and big endian coding only starts at the next
1541 // group. The corresponding code can be hard to analyse and adds
1542 // many additional unnecessary tests for regular tags.
1543 // * the second strategy consists in waiting for trouble, that shall
1544 // appear when we find the first group with big endian encoding. This
1545 // is easy to detect since the length of a "Group Length" tag (the
1546 // ones with zero as element number) has to be of 4 (0x0004). When we
1547 // encounter 1024 (0x0400) chances are the encoding changed and we
1548 // found a group with big endian encoding.
1549 // We shall use this second strategy. In order to make sure that we
1550 // can interpret the presence of an apparently big endian encoded
1551 // length of a "Group Length" without committing a big mistake, we
1552 // add an additional check: we look in the already parsed elements
1553 // for the presence of a "Transfer Syntax" whose value has to be "big
1554 // endian encoding". When this is the case, chances are we have got our
1555 // hands on a big endian encoded file: we switch the swap code to
1556 // big endian and proceed...
1557 if ( (element == 0x0000) && (length16 == 0x0400) )
1559 if ( ! IsExplicitVRBigEndianTransferSyntax() )
1561 dbg.Verbose(0, "gdcmParser::FindLength", "not explicit VR");
1566 SwitchSwapToBigEndian();
1567 // Restore the unproperly loaded values i.e. the group, the element
1568 // and the dictionary entry depending on them.
1569 guint16 CorrectGroup = SwapShort(Entry->GetGroup());
1570 guint16 CorrectElem = SwapShort(Entry->GetElement());
1571 gdcmDictEntry * NewTag = GetDictEntryByNumber(CorrectGroup,
1575 // This correct tag is not in the dictionary. Create a new one.
1576 NewTag = NewVirtualDictEntry(CorrectGroup, CorrectElem);
1578 // FIXME this can create a memory leaks on the old entry that be
1579 // left unreferenced.
1580 Entry->SetDictEntry(NewTag);
1583 // Heuristic: well some files are really ill-formed.
1584 if ( length16 == 0xffff)
1587 //dbg.Verbose(0, "gdcmParser::FindLength",
1588 // "Erroneous element length fixed.");
1589 // Actually, length= 0xffff means that we deal with
1590 // Unknown Sequence Length
1592 FixHeaderEntryFoundLength(Entry, (guint32)length16);
1597 // Either implicit VR or a non DICOM conformal (see note below) explicit
1598 // VR that ommited the VR of (at least) this element. Farts happen.
1599 // [Note: according to the part 5, PS 3.5-2001, section 7.1 p25
1600 // on Data elements "Implicit and Explicit VR Data Elements shall
1601 // not coexist in a Data Set and Data Sets nested within it".]
1602 // Length is on 4 bytes.
1604 FixHeaderEntryFoundLength(Entry, ReadInt32());
1610 * \ingroup gdcmParser
1611 * \brief Find the Value Representation of the current Dicom Element.
1614 void gdcmParser::FindHeaderEntryVR( gdcmHeaderEntry *Entry)
1616 if (filetype != ExplicitVR)
1621 long PositionOnEntry = ftell(fp);
1622 // Warning: we believe this is explicit VR (Value Representation) because
1623 // we used a heuristic that found "UL" in the first tag. Alas this
1624 // doesn't guarantee that all the tags will be in explicit VR. In some
1625 // cases (see e-film filtered files) one finds implicit VR tags mixed
1626 // within an explicit VR file. Hence we make sure the present tag
1627 // is in explicit VR and try to fix things if it happens not to be
1630 int lgrLue=fread (&VR, (size_t)2,(size_t)1, fp); // lgrLue not used
1632 if(!CheckHeaderEntryVR(Entry,VR))
1634 fseek(fp, PositionOnEntry, SEEK_SET);
1635 // When this element is known in the dictionary we shall use, e.g. for
1636 // the semantics (see the usage of IsAnInteger), the VR proposed by the
1637 // dictionary entry. Still we have to flag the element as implicit since
1638 // we know now our assumption on expliciteness is not furfilled.
1640 if ( Entry->IsVRUnknown() )
1641 Entry->SetVR("Implicit");
1642 Entry->SetImplicitVR();
1647 * \ingroup gdcmParser
1648 * \brief Check the correspondance between the VR of the header entry
1649 * and the taken VR. If they are different, the header entry is
1650 * updated with the new VR.
1651 * @param Entry Header Entry to check
1652 * @param vr Dicom Value Representation
1653 * @return false if the VR is incorrect of if the VR isn't referenced
1654 * otherwise, it returns true
1656 bool gdcmParser::CheckHeaderEntryVR(gdcmHeaderEntry *Entry, VRKey vr)
1658 char msg[100]; // for sprintf
1659 bool RealExplicit = true;
1661 // Assume we are reading a falsely explicit VR file i.e. we reached
1662 // a tag where we expect reading a VR but are in fact we read the
1663 // first to bytes of the length. Then we will interogate (through find)
1664 // the dicom_vr dictionary with oddities like "\004\0" which crashes
1665 // both GCC and VC++ implementations of the STL map. Hence when the
1666 // expected VR read happens to be non-ascii characters we consider
1667 // we hit falsely explicit VR tag.
1669 if ( (!isalpha(vr[0])) && (!isalpha(vr[1])) )
1670 RealExplicit = false;
1672 // CLEANME searching the dicom_vr at each occurence is expensive.
1673 // PostPone this test in an optional integrity check at the end
1674 // of parsing or only in debug mode.
1675 if ( RealExplicit && !gdcmGlobal::GetVR()->Count(vr) )
1676 RealExplicit= false;
1678 if ( !RealExplicit )
1680 // We thought this was explicit VR, but we end up with an
1681 // implicit VR tag. Let's backtrack.
1682 sprintf(msg,"Falsely explicit vr file (%04x,%04x)\n",
1683 Entry->GetGroup(),Entry->GetElement());
1684 dbg.Verbose(1, "gdcmParser::FindVR: ",msg);
1685 if (Entry->GetGroup()%2 && Entry->GetElement() == 0x0000) { // Group length is UL !
1686 gdcmDictEntry* NewEntry = NewVirtualDictEntry(
1687 Entry->GetGroup(),Entry->GetElement(),
1688 "UL","FIXME","Group Length");
1689 Entry->SetDictEntry(NewEntry);
1694 if ( Entry->IsVRUnknown() )
1696 // When not a dictionary entry, we can safely overwrite the VR.
1697 if (Entry->GetElement() == 0x0000) { // Group length is UL !
1703 else if ( Entry->GetVR() != vr )
1705 // The VR present in the file and the dictionary disagree. We assume
1706 // the file writer knew best and use the VR of the file. Since it would
1707 // be unwise to overwrite the VR of a dictionary (since it would
1708 // compromise it's next user), we need to clone the actual DictEntry
1709 // and change the VR for the read one.
1710 gdcmDictEntry* NewEntry = NewVirtualDictEntry(
1711 Entry->GetGroup(),Entry->GetElement(),
1712 vr,"FIXME",Entry->GetName());
1713 Entry->SetDictEntry(NewEntry);
1719 * \ingroup gdcmParser
1720 * \brief Get the transformed value of the header entry. The VR value
1721 * is used to define the transformation to operate on the value
1722 * \warning NOT end user intended method !
1724 * @return Transformed entry value
1726 std::string gdcmParser::GetHeaderEntryValue(gdcmHeaderEntry *Entry)
1728 if ( (IsHeaderEntryAnInteger(Entry)) && (Entry->IsImplicitVR()) )
1730 std::string val=Entry->GetValue();
1731 std::string vr=Entry->GetVR();
1732 guint32 length = Entry->GetLength();
1733 std::ostringstream s;
1736 if (vr == "US" || vr == "SS")
1741 for (int i=0; i < nbInt; i++)
1745 NewInt16 = (val[2*i+0]&0xFF)+((val[2*i+1]&0xFF)<<8);
1746 NewInt16 = SwapShort(NewInt16);
1751 else if (vr == "UL" || vr == "SL")
1756 for (int i=0; i < nbInt; i++)
1760 NewInt32= (val[4*i+0]&0xFF)+((val[4*i+1]&0xFF)<<8)+
1761 ((val[4*i+2]&0xFF)<<16)+((val[4*i+3]&0xFF)<<24);
1762 NewInt32=SwapLong(NewInt32);
1766 #ifdef GDCM_NO_ANSI_STRING_STREAM
1767 s << std::ends; // to avoid oddities on Solaris
1768 #endif //GDCM_NO_ANSI_STRING_STREAM
1772 return(Entry->GetValue());
1776 * \ingroup gdcmParser
1777 * \brief Get the reverse transformed value of the header entry. The VR
1778 * value is used to define the reverse transformation to operate on
1780 * \warning NOT end user intended method !
1782 * @return Reverse transformed entry value
1784 std::string gdcmParser::GetHeaderEntryUnvalue(gdcmHeaderEntry *Entry)
1786 if ( (IsHeaderEntryAnInteger(Entry)) && (Entry->IsImplicitVR()) )
1788 std::string vr=Entry->GetVR();
1789 std::ostringstream s;
1790 std::vector<std::string> tokens;
1792 if (vr == "US" || vr == "SS")
1796 tokens.erase(tokens.begin(),tokens.end()); // clean any previous value
1797 Tokenize (Entry->GetValue(), tokens, "\\");
1798 for (unsigned int i=0; i<tokens.size();i++)
1800 NewInt16 = atoi(tokens[i].c_str());
1801 s<<(NewInt16&0xFF)<<((NewInt16>>8)&0xFF);
1805 if (vr == "UL" || vr == "SL")
1809 tokens.erase(tokens.begin(),tokens.end()); // clean any previous value
1810 Tokenize (Entry->GetValue(), tokens, "\\");
1811 for (unsigned int i=0; i<tokens.size();i++)
1813 NewInt32 = atoi(tokens[i].c_str());
1814 s<<(char)(NewInt32&0xFF)<<(char)((NewInt32>>8)&0xFF)
1815 <<(char)((NewInt32>>16)&0xFF)<<(char)((NewInt32>>24)&0xFF);
1820 #ifdef GDCM_NO_ANSI_STRING_STREAM
1821 s << std::ends; // to avoid oddities on Solaris
1822 #endif //GDCM_NO_ANSI_STRING_STREAM
1826 return(Entry->GetValue());
1830 * \ingroup gdcmParser
1831 * \brief Skip a given Header Entry
1832 * \warning NOT end user intended method !
1835 void gdcmParser::SkipHeaderEntry(gdcmHeaderEntry *entry)
1837 SkipBytes(entry->GetLength());
1841 * \ingroup gdcmParser
1842 * \brief When the length of an element value is obviously wrong (because
1843 * the parser went Jabberwocky) one can hope improving things by
1844 * applying this heuristic.
1846 void gdcmParser::FixHeaderEntryFoundLength(gdcmHeaderEntry *Entry, guint32 FoundLength)
1848 Entry->SetReadLength(FoundLength); // will be updated only if a bug is found
1850 if ( FoundLength == 0xffffffff) {
1854 guint16 gr =Entry->GetGroup();
1855 guint16 el =Entry->GetElement();
1857 if (FoundLength%2) {
1858 std::ostringstream s;
1859 s << "Warning : Tag with uneven length " << FoundLength
1860 << " in x(" << std::hex << gr << "," << el <<")" << std::dec;
1861 dbg.Verbose(0,s.str().c_str());
1864 // Sorry for the patch!
1865 // XMedCom did the trick to read some nasty GE images ...
1866 if (FoundLength == 13) {
1867 // The following 'if' will be removed when there is no more
1868 // images on Creatis HDs with a 13 length for Manufacturer...
1869 if ( (Entry->GetGroup() != 0x0008) ||
1870 ( (Entry->GetElement() != 0x0070) && (Entry->GetElement() != 0x0080) ) ){
1871 // end of remove area
1873 Entry->SetReadLength(10); // a bug is to be fixed
1877 // to fix some garbage 'Leonardo' Siemens images
1878 // May be commented out to avoid overhead
1879 else if ( (Entry->GetGroup() == 0x0009) &&
1880 ( (Entry->GetElement() == 0x1113) || (Entry->GetElement() == 0x1114) ) ){
1882 Entry->SetReadLength(4); // a bug is to be fixed
1886 // to try to 'go inside' SeQuences (with length), and not to skip them
1887 else if ( Entry->GetVR() == "SQ")
1889 if (enableSequences) // only if the user does want to !
1890 FoundLength =0; // ReadLength is unchanged
1893 // a SeQuence Element is beginning
1894 // Let's forget it's length
1895 // (we want to 'go inside')
1897 // Pb : *normaly* fffe|e000 is just a marker, its length *should be* zero
1898 // in gdcm-MR-PHILIPS-16-Multi-Seq.dcm we find lengthes as big as 28800
1899 // if we set the length to zero IsHeaderEntryAnInteger() breaks...
1900 // if we don't, we lost 28800 characters from the Header :-(
1902 else if(Entry->GetGroup() == 0xfffe)
1904 // cout << "ReadLength " <<Entry->GetReadLength() << " UsableLength " << FoundLength << endl;
1906 // sometimes, length seems to be wrong
1907 FoundLength =0; // some more clever checking to be done !
1909 // only gdcm-MR-PHILIPS-16-Multi-Seq.dcm
1910 // causes troubles :-(
1913 Entry->SetUsableLength(FoundLength);
1917 * \ingroup gdcmParser
1918 * \brief Apply some heuristics to predict whether the considered
1919 * element value contains/represents an integer or not.
1920 * @param Entry The element value on which to apply the predicate.
1921 * @return The result of the heuristical predicate.
1923 bool gdcmParser::IsHeaderEntryAnInteger(gdcmHeaderEntry *Entry) {
1924 guint16 element = Entry->GetElement();
1925 guint16 group = Entry->GetGroup();
1926 std::string vr = Entry->GetVR();
1927 guint32 length = Entry->GetLength();
1928 // When we have some semantics on the element we just read, and if we
1929 // a priori know we are dealing with an integer, then we shall be
1930 // able to swap it's element value properly.
1931 if ( element == 0 ) // This is the group length of the group
1937 std::ostringstream s;
1938 int filePosition = ftell(fp);
1939 s << "Erroneous Group Length element length on : (" \
1940 << std::hex << group << " , " << element
1941 << ") -before- position x(" << filePosition << ")"
1942 << "lgt : " << length;
1943 // These 2 lines commented out : a *very dirty* patch
1944 // to go on PrintHeader'ing gdcm-MR-PHILIPS-16-Multi-Seq.dcm.
1945 // have a glance at offset x(8336) ...
1946 // For *regular* headers, the test is useless..
1947 // lets's print a warning message and go on,
1948 // instead of giving up with an error message
1950 //std::cout << s.str().c_str() << std::endl;
1952 // dbg.Error("gdcmParser::IsHeaderEntryAnInteger",
1953 // s.str().c_str());
1956 if ( (vr == "UL") || (vr == "US") || (vr == "SL") || (vr == "SS") )
1962 * \ingroup gdcmParser
1963 * \brief Find the Length till the next sequence delimiter
1964 * \warning NOT end user intended method !
1968 guint32 gdcmParser::FindHeaderEntryLengthOB(void) {
1969 // See PS 3.5-2001, section A.4 p. 49 on encapsulation of encoded pixel data.
1972 long PositionOnEntry = ftell(fp);
1973 bool FoundSequenceDelimiter = false;
1974 guint32 TotalLength = 0;
1977 while ( ! FoundSequenceDelimiter)
1983 TotalLength += 4; // We even have to decount the group and element
1985 if ( g != 0xfffe && g!=0xb00c ) /*for bogus header */
1987 char msg[100]; // for sprintf. Sorry
1988 sprintf(msg,"wrong group (%04x) for an item sequence (%04x,%04x)\n",g, g,n);
1989 dbg.Verbose(1, "gdcmParser::FindLengthOB: ",msg);
1993 if ( n == 0xe0dd || ( g==0xb00c && n==0x0eb6 ) ) /* for bogus header */
1994 FoundSequenceDelimiter = true;
1995 else if ( n != 0xe000 )
1997 char msg[100]; // for sprintf. Sorry
1998 sprintf(msg,"wrong element (%04x) for an item sequence (%04x,%04x)\n",
2000 dbg.Verbose(1, "gdcmParser::FindLengthOB: ",msg);
2004 ItemLength = ReadInt32();
2005 TotalLength += ItemLength + 4; // We add 4 bytes since we just read
2006 // the ItemLength with ReadInt32
2007 SkipBytes(ItemLength);
2009 fseek(fp, PositionOnEntry, SEEK_SET);
2014 * \ingroup gdcmParser
2015 * \brief Reads a supposed to be 16 Bits integer
2016 * (swaps it depending on processor endianity)
2017 * @return read value
2019 guint16 gdcmParser::ReadInt16(void) {
2022 item_read = fread (&g, (size_t)2,(size_t)1, fp);
2023 if ( item_read != 1 ) {
2025 dbg.Verbose(0, "gdcmParser::ReadInt16", " File Error");
2035 * \ingroup gdcmParser
2036 * \brief Reads a supposed to be 32 Bits integer
2037 * (swaps it depending on processor endianity)
2038 * @return read value
2040 guint32 gdcmParser::ReadInt32(void) {
2043 item_read = fread (&g, (size_t)4,(size_t)1, fp);
2044 if ( item_read != 1 ) {
2046 dbg.Verbose(0, "gdcmParser::ReadInt32", " File Error");
2056 * \ingroup gdcmParser
2057 * \brief skips bytes inside the source file
2058 * \warning NOT end user intended method !
2061 void gdcmParser::SkipBytes(guint32 NBytes) {
2062 //FIXME don't dump the returned value
2063 (void)fseek(fp, (long)NBytes, SEEK_CUR);
2067 * \ingroup gdcmParser
2068 * \brief Loads all the needed Dictionaries
2069 * \warning NOT end user intended method !
2071 void gdcmParser::Initialise(void)
2073 RefPubDict = gdcmGlobal::GetDicts()->GetDefaultPubDict();
2074 RefShaDict = (gdcmDict*)0;
2078 * \ingroup gdcmParser
2079 * \brief Discover what the swap code is (among little endian, big endian,
2080 * bad little endian, bad big endian).
2082 * @return false when we are absolutely sure
2083 * it's neither ACR-NEMA nor DICOM
2084 * true when we hope ours assuptions are OK
2086 bool gdcmParser::CheckSwap() {
2088 // The only guaranted way of finding the swap code is to find a
2089 // group tag since we know it's length has to be of four bytes i.e.
2090 // 0x00000004. Finding the swap code in then straigthforward. Trouble
2091 // occurs when we can't find such group...
2093 guint32 x=4; // x : for ntohs
2094 bool net2host; // true when HostByteOrder is the same as NetworkByteOrder
2100 char deb[HEADER_LENGTH_TO_READ];
2102 // First, compare HostByteOrder and NetworkByteOrder in order to
2103 // determine if we shall need to swap bytes (i.e. the Endian type).
2109 // The easiest case is the one of a DICOM header, since it possesses a
2110 // file preamble where it suffice to look for the string "DICM".
2111 lgrLue = fread(deb, 1, HEADER_LENGTH_TO_READ, fp);
2114 if(memcmp(entCur, "DICM", (size_t)4) == 0) {
2115 dbg.Verbose(1, "gdcmParser::CheckSwap:", "looks like DICOM Version3");
2117 // Next, determine the value representation (VR). Let's skip to the
2118 // first element (0002, 0000) and check there if we find "UL"
2119 // - or "OB" if the 1st one is (0002,0001) -,
2120 // in which case we (almost) know it is explicit VR.
2121 // WARNING: if it happens to be implicit VR then what we will read
2122 // is the length of the group. If this ascii representation of this
2123 // length happens to be "UL" then we shall believe it is explicit VR.
2124 // FIXME: in order to fix the above warning, we could read the next
2125 // element value (or a couple of elements values) in order to make
2126 // sure we are not commiting a big mistake.
2127 // We need to skip :
2128 // * the 128 bytes of File Preamble (often padded with zeroes),
2129 // * the 4 bytes of "DICM" string,
2130 // * the 4 bytes of the first tag (0002, 0000),or (0002, 0001)
2131 // i.e. a total of 136 bytes.
2135 // Sometimes (see : gdcmData/icone.dcm) group 0x0002 *is* Explicit VR,
2136 // but elem 0002,0010 (Transfert Syntax) tells us the file is *Implicit* VR.
2139 if( (memcmp(entCur, "UL", (size_t)2) == 0) ||
2140 (memcmp(entCur, "OB", (size_t)2) == 0) ||
2141 (memcmp(entCur, "UI", (size_t)2) == 0) ||
2142 (memcmp(entCur, "CS", (size_t)2) == 0) ) // CS, to remove later
2143 // when Write DCM *adds*
2145 // Use gdcmParser::dicom_vr to test all the possibilities
2146 // instead of just checking for UL, OB and UI !? // group 0000
2149 filetype = ExplicitVR;
2150 dbg.Verbose(1, "gdcmParser::CheckSwap:",
2151 "explicit Value Representation");
2155 filetype = ImplicitVR;
2156 dbg.Verbose(1, "gdcmParser::CheckSwap:",
2157 "not an explicit Value Representation");
2163 dbg.Verbose(1, "gdcmParser::CheckSwap:",
2164 "HostByteOrder != NetworkByteOrder");
2169 dbg.Verbose(1, "gdcmParser::CheckSwap:",
2170 "HostByteOrder = NetworkByteOrder");
2173 // Position the file position indicator at first tag (i.e.
2174 // after the file preamble and the "DICM" string).
2176 fseek (fp, 132L, SEEK_SET);
2180 // Alas, this is not a DicomV3 file and whatever happens there is no file
2181 // preamble. We can reset the file position indicator to where the data
2182 // is (i.e. the beginning of the file).
2183 dbg.Verbose(1, "gdcmParser::CheckSwap:", "not a DICOM Version3 file");
2186 // Our next best chance would be to be considering a 'clean' ACR/NEMA file.
2187 // By clean we mean that the length of the first tag is written down.
2188 // If this is the case and since the length of the first group HAS to be
2189 // four (bytes), then determining the proper swap code is straightforward.
2192 // We assume the array of char we are considering contains the binary
2193 // representation of a 32 bits integer. Hence the following dirty
2195 s32 = *((guint32 *)(entCur));
2216 // We are out of luck. It is not a DicomV3 nor a 'clean' ACR/NEMA file.
2217 // It is time for despaired wild guesses.
2218 // So, let's check if this file wouldn't happen to be 'dirty' ACR/NEMA,
2219 // i.e. the 'group length' element is not present :
2221 // check the supposed to be 'group number'
2222 // 0x0002 or 0x0004 or 0x0008
2223 // to determine ' sw' value .
2224 // Only 0 or 4321 will be possible
2225 // (no oportunity to check for the formerly well known
2226 // ACR-NEMA 'Bad Big Endian' or 'Bad Little Endian'
2227 // if unsuccessfull (i.e. neither 0x0002 nor 0x0200 etc -4, 8-)
2228 // the file IS NOT ACR-NEMA nor DICOM V3
2229 // Find a trick to tell it the caller...
2231 s16 = *((guint16 *)(deb));
2247 dbg.Verbose(0, "gdcmParser::CheckSwap:",
2248 "ACR/NEMA unfound swap info (Really hopeless !)");
2253 // Then the only info we have is the net2host one.
2263 * \ingroup gdcmParser
2264 * \brief Restore the unproperly loaded values i.e. the group, the element
2265 * and the dictionary entry depending on them.
2267 void gdcmParser::SwitchSwapToBigEndian(void)
2269 dbg.Verbose(1, "gdcmParser::SwitchSwapToBigEndian",
2270 "Switching to BigEndian mode.");
2291 * \ingroup gdcmParser
2292 * \brief during parsing, Header Elements too long are not loaded in memory
2295 void gdcmParser::SetMaxSizeLoadEntry(long NewSize)
2299 if ((guint32)NewSize >= (guint32)0xffffffff)
2301 MaxSizeLoadEntry = 0xffffffff;
2304 MaxSizeLoadEntry = NewSize;
2309 * \ingroup gdcmParser
2310 * \brief Header Elements too long will not be printed
2312 * \todo : not yet usable
2313 * (see MAX_SIZE_PRINT_ELEMENT_VALUE
2314 * in gdcmHeaderEntry gdcmLoadEntry)
2318 void gdcmParser::SetMaxSizePrintEntry(long NewSize)
2322 if ((guint32)NewSize >= (guint32)0xffffffff)
2324 MaxSizePrintEntry = 0xffffffff;
2327 MaxSizePrintEntry = NewSize;
2331 * \ingroup gdcmParser
2332 * \brief Searches both the public and the shadow dictionary (when they
2333 * exist) for the presence of the DictEntry with given name.
2334 * The public dictionary has precedence on the shadow one.
2335 * @param Name name of the searched DictEntry
2336 * @return Corresponding DictEntry when it exists, NULL otherwise.
2338 gdcmDictEntry *gdcmParser::GetDictEntryByName(std::string Name)
2340 gdcmDictEntry *found = (gdcmDictEntry *)0;
2341 if (!RefPubDict && !RefShaDict)
2343 dbg.Verbose(0, "gdcmParser::GetDictEntry",
2344 "we SHOULD have a default dictionary");
2348 found = RefPubDict->GetDictEntryByName(Name);
2354 found = RefShaDict->GetDictEntryByName(Name);
2362 * \ingroup gdcmParser
2363 * \brief Searches both the public and the shadow dictionary (when they
2364 * exist) for the presence of the DictEntry with given
2365 * group and element. The public dictionary has precedence on the
2367 * @param group group of the searched DictEntry
2368 * @param element element of the searched DictEntry
2369 * @return Corresponding DictEntry when it exists, NULL otherwise.
2371 gdcmDictEntry *gdcmParser::GetDictEntryByNumber(guint16 group,guint16 element)
2373 gdcmDictEntry *found = (gdcmDictEntry *)0;
2374 if (!RefPubDict && !RefShaDict)
2376 dbg.Verbose(0, "gdcmParser::GetDictEntry",
2377 "we SHOULD have a default dictionary");
2381 found = RefPubDict->GetDictEntryByNumber(group, element);
2387 found = RefShaDict->GetDictEntryByNumber(group, element);
2395 * \ingroup gdcmParser
2396 * \brief Read the next tag but WITHOUT loading it's value
2397 * @return On succes the newly created HeaderEntry, NULL on failure.
2399 gdcmHeaderEntry *gdcmParser::ReadNextHeaderEntry(void) {
2401 gdcmHeaderEntry *NewEntry;
2406 // We reached the EOF (or an error occured) therefore
2407 // header parsing has to be considered as finished.
2408 return (gdcmHeaderEntry *)0;
2410 /* Pb : how to propagate the element length (used in SkipHeaderEntry)
2411 // direct call to SkipBytes ?
2413 if (ignoreShadow == 1 && g%2 ==1) //JPR
2414 // if user wants to skip shadow groups
2415 // and current element *is* a shadow element
2416 // we don't create anything
2417 return (gdcmHeaderEntry *)1; // to tell caller it's NOT finished
2419 NewEntry = NewHeaderEntryByNumber(g, n);
2420 FindHeaderEntryVR(NewEntry);
2421 FindHeaderEntryLength(NewEntry);
2427 NewEntry->SetOffset(ftell(fp));
2432 * \ingroup gdcmParser
2433 * \brief Build a new Element Value from all the low level arguments.
2434 * Check for existence of dictionary entry, and build
2435 * a default one when absent.
2436 * @param Name Name of the underlying DictEntry
2438 gdcmHeaderEntry *gdcmParser::NewHeaderEntryByName(std::string Name)
2440 gdcmDictEntry *NewTag = GetDictEntryByName(Name);
2442 NewTag = NewVirtualDictEntry(0xffff, 0xffff, "LO", "unkn", Name);
2444 gdcmHeaderEntry* NewEntry = new gdcmHeaderEntry(NewTag);
2447 dbg.Verbose(1, "gdcmParser::ObtainHeaderEntryByName",
2448 "failed to allocate gdcmHeaderEntry");
2449 return (gdcmHeaderEntry *)0;
2455 * \ingroup gdcmParser
2456 * \brief Request a new virtual dict entry to the dict set
2457 * @param group group of the underlying DictEntry
2458 * @param element element of the underlying DictEntry
2459 * @param vr VR of the underlying DictEntry
2460 * @param fourth owner group
2461 * @param name english name
2463 gdcmDictEntry *gdcmParser::NewVirtualDictEntry(guint16 group, guint16 element,
2468 return gdcmGlobal::GetDicts()->NewVirtualDictEntry(group,element,vr,fourth,name);
2472 * \ingroup gdcmParser
2473 * \brief Build a new Element Value from all the low level arguments.
2474 * Check for existence of dictionary entry, and build
2475 * a default one when absent.
2476 * @param Group group of the underlying DictEntry
2477 * @param Elem element of the underlying DictEntry
2479 gdcmHeaderEntry *gdcmParser::NewHeaderEntryByNumber(guint16 Group, guint16 Elem)
2481 // Find out if the tag we encountered is in the dictionaries:
2482 gdcmDictEntry *DictEntry = GetDictEntryByNumber(Group, Elem);
2484 DictEntry = NewVirtualDictEntry(Group, Elem);
2486 gdcmHeaderEntry *NewEntry = new gdcmHeaderEntry(DictEntry);
2489 dbg.Verbose(1, "gdcmParser::NewHeaderEntryByNumber",
2490 "failed to allocate gdcmHeaderEntry");
2496 // Never used; commented out, waiting for removal.
2498 * \ingroup gdcmParser
2499 * \brief Small utility function that creates a new manually crafted
2500 * (as opposed as read from the file) gdcmHeaderEntry with user
2501 * specified name and adds it to the public tag hash table.
2502 * \note A fake TagKey is generated so the PubDict can keep it's coherence.
2503 * @param NewTagName The name to be given to this new tag.
2504 * @param VR The Value Representation to be given to this new tag.
2505 * @return The newly hand crafted Element Value.
2507 //gdcmHeaderEntry *gdcmParser::NewManualHeaderEntryToPubDict(std::string NewTagName,
2510 // gdcmHeaderEntry *NewEntry = NULL;
2511 // guint32 StuffGroup = 0xffff; // Group to be stuffed with additional info
2512 // guint32 FreeElem = 0;
2513 // gdcmDictEntry *DictEntry = NULL;
2515 // FreeElem = GenerateFreeTagKeyInGroup(StuffGroup);
2516 // if (FreeElem == UINT32_MAX)
2518 // dbg.Verbose(1, "gdcmHeader::NewManualHeaderEntryToPubDict",
2519 // "Group 0xffff in Public Dict is full");
2523 // DictEntry = NewVirtualDictEntry(StuffGroup, FreeElem,
2524 // VR, "GDCM", NewTagName);
2525 // NewEntry = new gdcmHeaderEntry(DictEntry);
2526 // AddHeaderEntry(NewEntry);
2531 * \ingroup gdcmParser
2532 * \brief Generate a free TagKey i.e. a TagKey that is not present
2533 * in the TagHt dictionary.
2534 * @param group The generated tag must belong to this group.
2535 * @return The element of tag with given group which is fee.
2537 guint32 gdcmParser::GenerateFreeTagKeyInGroup(guint16 group)
2539 for (guint32 elem = 0; elem < UINT32_MAX; elem++)
2541 TagKey key = gdcmDictEntry::TranslateToKey(group, elem);
2542 if (tagHT.count(key) == 0)
2548 //-----------------------------------------------------------------------------