X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocument.cxx;h=773f154cbf80e44a4b70c99d90d3ef6f1aa1625e;hb=fd37aa842b5d31ca266b6bda8a77f3201d02338d;hp=9976959e156995dc10708b731ed4b5cd920a26ac;hpb=44a9814938a6824d3a66b932429084517da6dadf;p=gdcm.git diff --git a/src/gdcmDocument.cxx b/src/gdcmDocument.cxx index 9976959e..773f154c 100644 --- a/src/gdcmDocument.cxx +++ b/src/gdcmDocument.cxx @@ -3,12 +3,12 @@ Program: gdcm Module: $RCSfile: gdcmDocument.cxx,v $ Language: C++ - Date: $Date: 2004/09/13 12:10:53 $ - Version: $Revision: 1.76 $ + Date: $Date: 2004/09/27 08:39:06 $ + Version: $Revision: 1.92 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or - http://www.creatis.insa-lyon.fr/Public/Gdcm/License.htm for details. + http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details. This software is distributed WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR @@ -107,8 +107,6 @@ gdcmDocument::gdcmDocument( std::string const & filename ) long beg = ftell(Fp); lgt -= beg; - SQDepthLevel = 0; - (void)ParseDES( this, beg, lgt, false); // le Load sera fait a la volee rewind(Fp); @@ -118,7 +116,7 @@ gdcmDocument::gdcmDocument( std::string const & filename ) std::string PhotometricInterpretation = GetEntryByNumber(0x0028,0x0004); if( PhotometricInterpretation == "PALETTE COLOR " ) { - LoadEntryVoidArea(0x0028,0x1200); // gray LUT + LoadEntryBinArea(0x0028,0x1200); // gray LUT /// FIXME FIXME FIXME /// The tags refered by the three following lines used to be CORRECTLY /// defined as having an US Value Representation in the public @@ -134,19 +132,19 @@ gdcmDocument::gdcmDocument( std::string const & filename ) /// also used as gdcmBinEntry, which requires the proper conversion, /// - OW, and hence loaded as gdcmBinEntry, but afterwards also used /// as gdcmValEntry, which requires the proper conversion. - LoadEntryVoidArea(0x0028,0x1201); // R LUT - LoadEntryVoidArea(0x0028,0x1202); // G LUT - LoadEntryVoidArea(0x0028,0x1203); // B LUT + LoadEntryBinArea(0x0028,0x1201); // R LUT + LoadEntryBinArea(0x0028,0x1202); // G LUT + LoadEntryBinArea(0x0028,0x1203); // B LUT // Segmented Red Palette Color LUT Data - LoadEntryVoidArea(0x0028,0x1221); + LoadEntryBinArea(0x0028,0x1221); // Segmented Green Palette Color LUT Data - LoadEntryVoidArea(0x0028,0x1222); + LoadEntryBinArea(0x0028,0x1222); // Segmented Blue Palette Color LUT Data - LoadEntryVoidArea(0x0028,0x1223); + LoadEntryBinArea(0x0028,0x1223); } //FIXME later : how to use it? - LoadEntryVoidArea(0x0028,0x3006); //LUT Data (CTX dependent) + LoadEntryBinArea(0x0028,0x3006); //LUT Data (CTX dependent) CloseFile(); @@ -201,7 +199,7 @@ gdcmDocument::~gdcmDocument () for (TagDocEntryHT::const_iterator it = TagHT.begin(); it != TagHT.end(); ++it ) { - delete it->second; + //delete it->second; //temp remove } TagHT.clear(); } @@ -232,7 +230,7 @@ void gdcmDocument::PrintShaDict(std::ostream & os) /** * \brief Get the public dictionary used */ -gdcmDict *gdcmDocument::GetPubDict() +gdcmDict* gdcmDocument::GetPubDict() { return RefPubDict; } @@ -240,7 +238,7 @@ gdcmDict *gdcmDocument::GetPubDict() /** * \brief Get the shadow dictionary used */ -gdcmDict *gdcmDocument::GetShaDict() +gdcmDict* gdcmDocument::GetShaDict() { return RefShaDict; } @@ -540,13 +538,10 @@ bool gdcmDocument::CloseFile() void gdcmDocument::Write(FILE* fp,FileType filetype) { /// \todo move the following lines (and a lot of others, to be written) - /// to a future function CheckAndCorrectHeader - - /// WARNING : Si on veut ecrire du DICOM V3 a partir d'un DcmHeader ACR-NEMA - /// no way (check : FileType est un champ de gdcmDocument ...) - /// a moins de se livrer a un tres complique ajout des champs manquants. - /// faire un CheckAndCorrectHeader (?) - + /// to a future function CheckAndCorrectHeader + /// (necessary if user wants to write a DICOM V3 file + /// starting from an ACR-NEMA (V2) gdcmHeader + if (filetype == gdcmImplicitVR) { std::string implicitVRTransfertSyntax = UI1_2_840_10008_1_2; @@ -595,22 +590,37 @@ void gdcmDocument::Write(FILE* fp,FileType filetype) * @param value (string) Value to be set * @param group Group number of the Entry * @param elem Element number of the Entry + * @param VR V(alue) R(epresentation) of the Entry -if private Entry- * \return pointer to the modified/created Header Entry (NULL when creation * failed). - */ - -gdcmValEntry * gdcmDocument::ReplaceOrCreateByNumber( + */ +gdcmValEntry* gdcmDocument::ReplaceOrCreateByNumber( std::string const & value, uint16_t group, - uint16_t elem ) + uint16_t elem, + std::string const & VR ) { gdcmValEntry* valEntry = 0; gdcmDocEntry* currentEntry = GetDocEntryByNumber( group, elem); if (!currentEntry) { - // The entry wasn't present and we simply create the required ValEntry: - currentEntry = NewDocEntryByNumber(group, elem); + // check if (group,element) DictEntry exists + // if it doesn't, create an entry in gdcmDictSet::VirtualEntry + // and use it + + // Find out if the tag we received is in the dictionaries: + gdcmDict *pubDict = gdcmGlobal::GetDicts()->GetDefaultPubDict(); + gdcmDictEntry* dictEntry = pubDict->GetDictEntryByNumber(group, elem); + if (!dictEntry) + { + currentEntry = NewDocEntryByNumber(group, elem,VR); + } + else + { + currentEntry = NewDocEntryByNumber(group, elem); + } + if (!currentEntry) { dbg.Verbose(0, "gdcmDocument::ReplaceOrCreateByNumber: call to" @@ -656,37 +666,80 @@ gdcmValEntry * gdcmDocument::ReplaceOrCreateByNumber( /* * \brief Modifies the value of a given Header Entry (Dicom Element) * when it exists. Create it with the given value when unexistant. - * @param voidArea (binary) value to be set + * @param binArea (binary) value to be set * @param Group Group number of the Entry * @param Elem Element number of the Entry * \return pointer to the modified/created Header Entry (NULL when creation * failed). */ -gdcmBinEntry * gdcmDocument::ReplaceOrCreateByNumber( - void *voidArea, +gdcmBinEntry* gdcmDocument::ReplaceOrCreateByNumber( + uint8_t* binArea, int lgth, uint16_t group, - uint16_t elem) + uint16_t elem, + std::string const& VR ) { - gdcmBinEntry* b = 0; - gdcmDocEntry* a = GetDocEntryByNumber( group, elem); - if (!a) + gdcmBinEntry* binEntry = 0; + gdcmDocEntry* currentEntry = GetDocEntryByNumber( group, elem); + if (!currentEntry) { - a = NewBinEntryByNumber(group, elem); - if (!a) + + // check if (group,element) DictEntry exists + // if it doesn't, create an entry in gdcmDictSet::VirtualEntry + // and use it + + // Find out if the tag we received is in the dictionaries: + gdcmDict *pubDict = gdcmGlobal::GetDicts()->GetDefaultPubDict(); + gdcmDictEntry *dictEntry = pubDict->GetDictEntryByNumber(group, elem); + + if (!dictEntry) { - return 0; + currentEntry = NewDocEntryByNumber(group, elem, VR); } + else + { + currentEntry = NewDocEntryByNumber(group, elem); + } + if (!currentEntry) + { + dbg.Verbose(0, "gdcmDocument::ReplaceOrCreateByNumber: call to" + " NewDocEntryByNumber failed."); + return NULL; + } + binEntry = new gdcmBinEntry(currentEntry); + if ( !AddEntry(binEntry)) + { + dbg.Verbose(0, "gdcmDocument::ReplaceOrCreateByNumber: AddEntry" + " failed allthough this is a creation."); + } + } + else + { + binEntry = dynamic_cast< gdcmBinEntry* >(currentEntry); + if ( !binEntry ) // Euuuuh? It wasn't a BinEntry + // then we change it to a BinEntry ? + // Shouldn't it be considered as an error ? + { + // We need to promote the gdcmDocEntry to a gdcmBinEntry: + binEntry = new gdcmBinEntry(currentEntry); + if (!RemoveEntry(currentEntry)) + { + dbg.Verbose(0, "gdcmDocument::ReplaceOrCreateByNumber: removal" + " of previous DocEntry failed."); + return NULL; + } + if ( !AddEntry(binEntry)) + { + dbg.Verbose(0, "gdcmDocument::ReplaceOrCreateByNumber: adding" + " promoted BinEntry failed."); + return NULL; + } + } + } - b = new gdcmBinEntry(a); - AddEntry(b); - b->SetVoidArea(voidArea); - } - - SetEntryByNumber(voidArea, lgth, group, elem); - //b->SetVoidArea(voidArea); //what if b == 0 !! + SetEntryByNumber(binArea, lgth, group, elem); - return b; + return binEntry; } @@ -698,7 +751,7 @@ gdcmBinEntry * gdcmDocument::ReplaceOrCreateByNumber( * \return pointer to the modified/created SeqEntry (NULL when creation * failed). */ -gdcmSeqEntry * gdcmDocument::ReplaceOrCreateByNumber( +gdcmSeqEntry* gdcmDocument::ReplaceOrCreateByNumber( uint16_t group, uint16_t elem) { @@ -758,9 +811,9 @@ bool gdcmDocument::CheckIfEntryExistByNumber(uint16_t group, uint16_t element ) * @return Corresponding element value when it exists, * and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise. */ -std::string gdcmDocument::GetEntryByName(TagName const & tagName) +std::string gdcmDocument::GetEntryByName(TagName const& tagName) { - gdcmDictEntry *dictEntry = RefPubDict->GetDictEntryByName(tagName); + gdcmDictEntry* dictEntry = RefPubDict->GetDictEntryByName(tagName); if( !dictEntry ) { return GDCM_UNFOUND; @@ -782,7 +835,7 @@ std::string gdcmDocument::GetEntryByName(TagName const & tagName) * @return Corresponding element value representation when it exists, * and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise. */ -std::string gdcmDocument::GetEntryVRByName(TagName const & tagName) +std::string gdcmDocument::GetEntryVRByName(TagName const& tagName) { gdcmDictEntry *dictEntry = RefPubDict->GetDictEntryByName(tagName); if( dictEntry == NULL) @@ -795,7 +848,6 @@ std::string gdcmDocument::GetEntryVRByName(TagName const & tagName) return elem->GetVR(); } - /** * \brief Searches within Header Entries (Dicom Elements) parsed with * the public and private dictionaries @@ -884,7 +936,7 @@ bool gdcmDocument::SetEntryByName(std::string const & content,std::string const * @param group group number of the Dicom Element to modify * @param element element number of the Dicom Element to modify */ -bool gdcmDocument::SetEntryByNumber(std::string const & content, +bool gdcmDocument::SetEntryByNumber(std::string const& content, uint16_t group, uint16_t element) { @@ -931,12 +983,12 @@ bool gdcmDocument::SetEntryByNumber(std::string const & content, * \brief Accesses an existing gdcmDocEntry (i.e. a Dicom Element) * through it's (group, element) and modifies it's content with * the given value. - * @param content new value (void *) to substitute with + * @param content new value (void* -> uint8_t*) to substitute with * @param lgth new value length * @param group group number of the Dicom Element to modify * @param element element number of the Dicom Element to modify */ -bool gdcmDocument::SetEntryByNumber(void *content, +bool gdcmDocument::SetEntryByNumber(uint8_t*content, int lgth, uint16_t group, uint16_t element) @@ -956,8 +1008,9 @@ bool gdcmDocument::SetEntryByNumber(void *content, } */ gdcmBinEntry* a = (gdcmBinEntry *)TagHT[key]; - a->SetVoidArea(content); + a->SetBinArea(content); a->SetLength(lgth); + a->SetValue(GDCM_BINLOADED); return true; } @@ -1017,7 +1070,7 @@ size_t gdcmDocument::GetEntryOffsetByNumber(uint16_t group, uint16_t elem) * @param elem element number of the Entry * @return Pointer to the 'non string' area */ -void * gdcmDocument::GetEntryVoidAreaByNumber(uint16_t group, uint16_t elem) +void* gdcmDocument::GetEntryBinAreaByNumber(uint16_t group, uint16_t elem) { gdcmDocEntry* entry = GetDocEntryByNumber(group, elem); if (!entry) @@ -1025,7 +1078,7 @@ void * gdcmDocument::GetEntryVoidAreaByNumber(uint16_t group, uint16_t elem) dbg.Verbose(1, "gdcmDocument::GetDocEntryByNumber: no entry"); return 0; } - return ((gdcmBinEntry *)entry)->GetVoidArea(); + return ((gdcmBinEntry *)entry)->GetBinArea(); } /** @@ -1034,7 +1087,7 @@ void * gdcmDocument::GetEntryVoidAreaByNumber(uint16_t group, uint16_t elem) * @param group group number of the Entry * @param elem element number of the Entry */ -void* gdcmDocument::LoadEntryVoidArea(uint16_t group, uint16_t elem) +void* gdcmDocument::LoadEntryBinArea(uint16_t group, uint16_t elem) { gdcmDocEntry *docElement = GetDocEntryByNumber(group, elem); if ( !docElement ) @@ -1044,10 +1097,10 @@ void* gdcmDocument::LoadEntryVoidArea(uint16_t group, uint16_t elem) size_t o =(size_t)docElement->GetOffset(); fseek(Fp, o, SEEK_SET); size_t l = docElement->GetLength(); - char* a = new char[l]; + uint8_t* a = new uint8_t[l]; if(!a) { - dbg.Verbose(0, "gdcmDocument::LoadEntryVoidArea cannot allocate a"); + dbg.Verbose(0, "gdcmDocument::LoadEntryBinArea cannot allocate a"); return NULL; } size_t l2 = fread(a, 1, l , Fp); @@ -1056,31 +1109,30 @@ void* gdcmDocument::LoadEntryVoidArea(uint16_t group, uint16_t elem) delete[] a; return NULL; } - /// \TODO Drop any already existing void area! JPR - if( !SetEntryVoidAreaByNumber( a, group, elem ) ); + /// \todo Drop any already existing void area! JPR + if( !SetEntryBinAreaByNumber( a, group, elem ) ); { - dbg.Verbose(0, "gdcmDocument::LoadEntryVoidArea setting failed."); + dbg.Verbose(0, "gdcmDocument::LoadEntryBinArea setting failed."); } - return a; } /** * \brief Loads (from disk) the element content * when a string is not suitable - * @param element Entry whose voidArea is going to be loaded + * @param element Entry whose binArea is going to be loaded */ -void *gdcmDocument::LoadEntryVoidArea(gdcmBinEntry *element) +void* gdcmDocument::LoadEntryBinArea(gdcmBinEntry* element) { size_t o =(size_t)element->GetOffset(); fseek(Fp, o, SEEK_SET); size_t l = element->GetLength(); - char* a = new char[l]; + uint8_t* a = new uint8_t[l]; if( !a ) { - dbg.Verbose(0, "gdcmDocument::LoadEntryVoidArea cannot allocate a"); + dbg.Verbose(0, "gdcmDocument::LoadEntryBinArea cannot allocate a"); return NULL; } - element->SetVoidArea((void *)a); + element->SetBinArea((uint8_t*)a); /// \todo check the result size_t l2 = fread(a, 1, l , Fp); if( l != l2 ) @@ -1099,7 +1151,7 @@ void *gdcmDocument::LoadEntryVoidArea(gdcmBinEntry *element) * @param element Element number of the searched Dicom Element * @return */ -bool gdcmDocument::SetEntryVoidAreaByNumber(void * area, +bool gdcmDocument::SetEntryBinAreaByNumber(uint8_t* area, uint16_t group, uint16_t element) { @@ -1110,7 +1162,7 @@ bool gdcmDocument::SetEntryVoidAreaByNumber(void * area, } if ( gdcmBinEntry* binEntry = dynamic_cast(currentEntry) ) { - binEntry->SetVoidArea( area ); + binEntry->SetBinArea( area ); return true; } return true; @@ -1319,7 +1371,6 @@ long gdcmDocument::ParseDES(gdcmDocEntrySet *set, gdcmDocEntry *newDocEntry = 0; unsigned long l = 0; - int depth = set->GetDepthLevel(); while (true) { if ( !delim_mode && (ftell(Fp)-offset) >= l_max) @@ -1338,11 +1389,27 @@ long gdcmDocument::ParseDES(gdcmDocEntrySet *set, if ( gdcmGlobal::GetVR()->IsVROfGdcmStringRepresentable(vr) ) { - /////// ValEntry + /////////////////////// ValEntry gdcmValEntry* newValEntry = new gdcmValEntry( newDocEntry->GetDictEntry() ); newValEntry->Copy( newDocEntry ); - newValEntry->SetKey( set->GetBaseTagKey() + newValEntry->GetKey() ); + + // When "set" is a gdcmDocument, then we are at the top of the + // hierarchy and the Key is simply of the form ( group, elem )... + if (gdcmDocument* dummy = dynamic_cast< gdcmDocument* > ( set ) ) + { + (void)dummy; + newValEntry->SetKey( newValEntry->GetKey() ); + } + // ...but when "set" is a gdcmSQItem, we are inserting this new + // valEntry in a sequence item. Hence the key has the + // generalized form (refer to \ref gdcmBaseTagKey): + if (gdcmSQItem* parentSQItem = dynamic_cast< gdcmSQItem* > ( set ) ) + { + newValEntry->SetKey( parentSQItem->GetBaseTagKey() + + newValEntry->GetKey() ); + } + set->AddEntry( newValEntry ); LoadDocEntry( newValEntry ); if (newValEntry->IsItemDelimitor()) @@ -1363,11 +1430,27 @@ long gdcmDocument::ParseDES(gdcmDocEntrySet *set, "nor BinEntry. Probably unknown VR."); } - ////// BinEntry or UNKOWN VR: + //////////////////// BinEntry or UNKOWN VR: gdcmBinEntry* newBinEntry = new gdcmBinEntry( newDocEntry->GetDictEntry() ); newBinEntry->Copy( newDocEntry ); - newBinEntry->SetKey( set->GetBaseTagKey() + newBinEntry->GetKey() ); + + // When "this" is a gdcmDocument the Key is simply of the + // form ( group, elem )... + if (gdcmDocument* dummy = dynamic_cast< gdcmDocument* > ( set ) ) + { + (void)dummy; + newBinEntry->SetKey( newBinEntry->GetKey() ); + } + // but when "this" is a SQItem, we are inserting this new + // valEntry in a sequence item, and the kay has the + // generalized form (refer to \ref gdcmBaseTagKey): + if (gdcmSQItem* parentSQItem = dynamic_cast< gdcmSQItem* > ( set ) ) + { + newBinEntry->SetKey( parentSQItem->GetBaseTagKey() + + newBinEntry->GetKey() ); + } + set->AddEntry( newBinEntry ); LoadDocEntry( newBinEntry ); } @@ -1411,12 +1494,29 @@ long gdcmDocument::ParseDES(gdcmDocEntrySet *set, } // no other way to create it ... gdcmSeqEntry* newSeqEntry = - new gdcmSeqEntry( newDocEntry->GetDictEntry(), - set->GetDepthLevel() ); + new gdcmSeqEntry( newDocEntry->GetDictEntry() ); newSeqEntry->Copy( newDocEntry ); newSeqEntry->SetDelimitorMode( delim_mode ); - newSeqEntry->SetDepthLevel( depth ); - newSeqEntry->SetKey( set->GetBaseTagKey() + newSeqEntry->GetKey() ); + + // At the top of the hierarchy, stands a gdcmDocument. When "set" + // is a gdcmDocument, then we are building the first depth level. + // Hence the gdcmSeqEntry we are building simply has a depth + // level of one: + if (gdcmDocument* dummy = dynamic_cast< gdcmDocument* > ( set ) ) + { + (void)dummy; + newSeqEntry->SetDepthLevel( 1 ); + newSeqEntry->SetKey( newSeqEntry->GetKey() ); + } + // But when "set" is allready a SQItem, we are building a nested + // sequence, and hence the depth level of the new gdcmSeqEntry + // we are building, is one level deeper: + if (gdcmSQItem* parentSQItem = dynamic_cast< gdcmSQItem* > ( set ) ) + { + newSeqEntry->SetDepthLevel( parentSQItem->GetDepthLevel() + 1 ); + newSeqEntry->SetKey( parentSQItem->GetBaseTagKey() + + newSeqEntry->GetKey() ); + } if ( l != 0 ) { // Don't try to parse zero-length sequences @@ -1570,9 +1670,9 @@ void gdcmDocument::LoadDocEntry(gdcmDocEntry* entry) // When we find a BinEntry not very much can be done : if (gdcmBinEntry* binEntryPtr = dynamic_cast< gdcmBinEntry* >(entry) ) { - s << "gdcm::Loaded (BinEntry)"; + s << GDCM_BINLOADED; binEntryPtr->SetValue(s.str()); - LoadEntryVoidArea(binEntryPtr); // last one, not to erase length ! + LoadEntryBinArea(binEntryPtr); // last one, not to erase length ! return; } @@ -2720,7 +2820,6 @@ uint32_t gdcmDocument::ReadTagLength(uint16_t testGroup, uint16_t testElement) /** * \brief Parse pixel data from disk for multi-fragment Jpeg/Rle files * No other way so 'skip' the Data - * */ void gdcmDocument::Parse7FE0 () { @@ -2822,6 +2921,97 @@ void gdcmDocument::Parse7FE0 () } } +/** + * \brief Walk recursively the given \ref gdcmDocEntrySet, and feed + * the given hash table (\ref TagDocEntryHT) with all the + * \ref gdcmDocEntry (Dicom entries) encountered. + * This method does the job for \ref BuildFlatHashTable. + * @param builtHT Where to collect all the \ref gdcmDocEntry encountered + * when recursively walking the given set. + * @param set The structure to be traversed (recursively). + */ +void gdcmDocument::BuildFlatHashTableRecurse( TagDocEntryHT& builtHT, + gdcmDocEntrySet* set ) +{ + if (gdcmElementSet* elementSet = dynamic_cast< gdcmElementSet* > ( set ) ) + { + TagDocEntryHT* currentHT = elementSet->GetTagHT(); + for( TagDocEntryHT::const_iterator i = currentHT->begin(); + i != currentHT->end(); + ++i) + { + gdcmDocEntry* entry = i->second; + if ( gdcmSeqEntry* seqEntry = dynamic_cast(entry) ) + { + ListSQItem& items = seqEntry->GetSQItems(); + for( ListSQItem::const_iterator item = items.begin(); + item != items.end(); + ++item) + { + BuildFlatHashTableRecurse( builtHT, *item ); + } + continue; + } + builtHT[entry->GetKey()] = entry; + } + return; + } + + if (gdcmSQItem* SQItemSet = dynamic_cast< gdcmSQItem* > ( set ) ) + { + ListDocEntry& currentList = SQItemSet->GetDocEntries(); + for (ListDocEntry::iterator i = currentList.begin(); + i != currentList.end(); + ++i) + { + gdcmDocEntry* entry = *i; + if ( gdcmSeqEntry* seqEntry = dynamic_cast(entry) ) + { + ListSQItem& items = seqEntry->GetSQItems(); + for( ListSQItem::const_iterator item = items.begin(); + item != items.end(); + ++item) + { + BuildFlatHashTableRecurse( builtHT, *item ); + } + continue; + } + builtHT[entry->GetKey()] = entry; + } + + } +} + +/** + * \brief Build a \ref TagDocEntryHT (i.e. a std::map<>) from the current + * gdcmDocument. + * + * The structure used by a gdcmDocument (through \ref gdcmElementSet), + * in order to old the parsed entries of a Dicom header, is a recursive + * one. This is due to the fact that the sequences (when present) + * can be nested. Additionaly, the sequence items (represented in + * gdcm as \ref gdcmSQItem) add an extra complexity to the data + * structure. Hence, a gdcm user whishing to visit all the entries of + * a Dicom header will need to dig in the gdcm internals (which + * implies exposing all the internal data structures to the API). + * In order to avoid this burden to the user, \ref BuildFlatHashTable + * recursively builds a temporary hash table, which holds all the + * Dicom entries in a flat structure (a \ref TagDocEntryHT i.e. a + * std::map<>). + * \warning Of course there is NO integrity constrain between the + * returned \ref TagDocEntryHT and the \ref gdcmElementSet used + * to build it. Hence if the underlying \ref gdcmElementSet is + * altered, then it is the caller responsability to invoke + * \ref BuildFlatHashTable again... + * @return The flat std::map<> we juste build. + */ +TagDocEntryHT* gdcmDocument::BuildFlatHashTable() +{ + TagDocEntryHT* FlatHT = new TagDocEntryHT; + BuildFlatHashTableRecurse( *FlatHT, this ); + return FlatHT; +} + /**