X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDict.cxx;h=a314a91a09b4a7caf3cc91c850117da3d106c7f9;hb=76ac46b16fd92d0fb444f786d4946424d9029315;hp=645dcf855be65846dc5871302eafc8d4395dec02;hpb=565a47ec4e037897aaf770aeccc5d67d7ad7b478;p=gdcm.git diff --git a/src/gdcmDict.cxx b/src/gdcmDict.cxx index 645dcf85..a314a91a 100644 --- a/src/gdcmDict.cxx +++ b/src/gdcmDict.cxx @@ -1,158 +1,362 @@ -// gdcmDict.cxx +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDict.cxx,v $ + Language: C++ + Date: $Date: 2007/05/23 14:18:09 $ + Version: $Revision: 1.87 $ + + 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.html for details. + + This software is distributed WITHOUT ANY WARRANTY; without even + the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR + PURPOSE. See the above copyright notices for more information. + +=========================================================================*/ -#include #include "gdcmDict.h" #include "gdcmUtil.h" +#include "gdcmDebug.h" + +#include +#include +#include + +namespace GDCM_NAME_SPACE +{ +//----------------------------------------------------------------------------- +/// \brief auto generated function, to fill up the Dicom Dictionnary, +/// if relevant file is not found on user's disk +void FillDefaultDataDict(Dict *d); -gdcmDict::gdcmDict(const char* FileName) { - std::ifstream from(FileName); - dbg.Error(!from, "gdcmDict::gdcmDict: can't open dictionary", FileName); - guint16 group, element; - // CLEANME : use defines for all those constants - char buff[1024]; - TagKey key; - TagName vr; - TagName fourth; - TagName name; - while (!from.eof()) { - from >> hex >> group >> element; - eatwhite(from); - from.getline(buff, 256, ' '); - vr = buff; - eatwhite(from); - from.getline(buff, 256, ' '); - fourth = buff; - from.getline(buff, 256, '\n'); - name = buff; - gdcmDictEntry * newEntry = new gdcmDictEntry(group, element, - vr, fourth, name); - NameHt[name] = newEntry; - KeyHt[gdcmDictEntry::TranslateToKey(group, element)] = newEntry; - } - from.close(); -} - -void gdcmDict::Print(ostream& os) { - PrintByKey(os); +//----------------------------------------------------------------------------- +// Constructor / Destructor +/** + * \brief Constructor + */ +Dict::Dict( ) +{ + Filename=""; } /** - * \ingroup gdcmHeader - * \brief Print all the dictionary entries contained in this dictionary. - * Entries will be sorted by tag i.e. the couple (group, element). - * @param os The output stream to be written to. + * \brief Constructor + * @param filename from which to build the dictionary. */ -void gdcmDict::PrintByKey(ostream& os) { - for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag){ - os << "Tag : "; - os << "(" << hex << tag->second->GetGroup() << ','; - os << hex << tag->second->GetElement() << ") = " << dec; - os << tag->second->GetVR() << ", "; - os << tag->second->GetFourth() << ", "; - os << tag->second->GetName() << "." << endl; - } +Dict::Dict(std::string const &filename) +{ + gdcmDebugMacro( "in Dict::Dict, filename =[" << filename << "]" ); + std::ifstream from( filename.c_str() ); + if ( !from ) + { + gdcmWarningMacro( "Can't open dictionary" << filename.c_str()); + // Using default embeded one: + FillDefaultDataDict( this ); + } + else + { + gdcmDebugMacro( "in Dict::Dict, DoTheLoadingJob filename =[" + << filename << "]" ); + DoTheLoadingJob(from); + Filename = filename; + } } /** - * \ingroup gdcmHeader - * \brief Print all the dictionary entries contained in this dictionary. - * Entries will be sorted by the name of the dictionary entries. - * @param os The output stream to be written to. + * \brief Destructor + */ +Dict::~Dict() +{ + ClearEntry(); +} + +//----------------------------------------------------------------------------- +// Public + +/** + * \brief Add all the entries held in a source dictionary + * \note it concerns only Private Dictionnary + * @param filename from which to build the dictionary. */ -void gdcmDict::PrintByName(ostream& os) { - for (TagNameHT::iterator tag = NameHt.begin(); tag != NameHt.end(); ++tag){ - os << "Tag : "; - os << tag->second->GetName() << ","; - os << tag->second->GetVR() << ", "; - os << tag->second->GetFourth() << ", "; - os << "(" << hex << tag->second->GetGroup() << ','; - os << hex << tag->second->GetElement() << ") = " << dec << endl; - } +bool Dict::AddDict(std::string const &filename) +{ + std::ifstream from( filename.c_str() ); + if ( !from ) + { + gdcmWarningMacro( "Can't open dictionary" << filename.c_str()); + return false; + } + else + { + DoTheLoadingJob(from); + return true; + } } /** - * \ingroup gdcmHeader - * \brief Get the dictionnary entry identified by a given tag (group,element) - * @param group group of the entry to be found - * @param element element of the entry to be found - * @return the corresponding dictionnary entry when existing, NULL otherwise - */ -gdcmDictEntry * gdcmDict::GetTagByKey(guint16 group, guint16 element) { - TagKey key = gdcmDictEntry::TranslateToKey(group, element); - if ( ! KeyHt.count(key)) - return (gdcmDictEntry*)0; - if (KeyHt.count(key) > 1) - dbg.Verbose(0, "gdcmDict::GetTagByName", - "multiple entries for this key (FIXME) !"); - return KeyHt.find(key)->second; + * \brief Removes from the current Dicom Dict all the entries held in a source dictionary + * \note it concerns only Private Dictionnary + * @param filename from which we read the entries to remove. + */ +bool Dict::RemoveDict(std::string const &filename) +{ + std::ifstream from( filename.c_str() ); + if ( !from ) + { + gdcmWarningMacro( "Can't open dictionary" << filename.c_str()); + return false; + } + else + { + uint16_t group; + uint16_t elem; + TagName vr; + TagName vm; + TagName name; + + while ( true ) + { + from >> std::hex; + from >> group; + + if (from.eof()) + break; + + from >> elem; + from >> vr; + from >> vm; + // from >> std::ws; //remove white space + std::getline(from, name); + + RemoveEntry(group,elem); + } + from.close(); + return true; + } } /** - * \ingroup gdcmHeader - * \brief Get the dictionnary entry identified by it's name. - * @param name element of the ElVal to modify - * @return the corresponding dictionnary entry when existing, NULL otherwise - */ -gdcmDictEntry * gdcmDict::GetTagByName(TagName name) { - if ( ! NameHt.count(name)) - return (gdcmDictEntry*)0; - if (NameHt.count(name) > 1) - dbg.Verbose(0, "gdcmDict::GetTagByName", - "multiple entries for this key (FIXME) !"); - return NameHt.find(name)->second; -} - - -int gdcmDict::ReplaceEntry(gdcmDictEntry* NewEntry) { - //JPRCLEAN - // au cas ou la NewEntry serait incomplete - // Question : cela peut-il se produire ? - // - // --> NON : voir constructeur - //TagKey key; - //key = NewEntry->GetKey(); - //if (key =="") { - // NewEntry->gdcmDictEntry::SetKey( - // gdcmDictEntry::TranslateToKey(NewEntry->GetGroup(), NewEntry->GetElement()) - // ); - //} - - KeyHt.erase (NewEntry->gdcmDictEntry::GetKey()); - KeyHt[ NewEntry->GetKey()] = NewEntry; - return (1); - // Question(jpr): Dans quel cas ça peut planter ? - // Reponse(frog): dans les mauvais cas... + * \brief adds a new Dicom Dictionary Entry + * @param newEntry entry to add + * @return false if Dicom Element already exists + */ +bool Dict::AddEntry(DictEntry *newEntry) +{ + const TagKey &key = newEntry->GetKey(); + + if ( KeyHt.count(key) == 1 ) + { + gdcmErrorMacro( "Already present:" << key ); + return false; + } + else + { + newEntry->Register(); + KeyHt.insert( TagKeyHT::value_type(key, newEntry)); + return true; + } } + +/* + * \ brief replaces an already existing Dicom Element by a new one + * @ param newEntry new entry (overwrites any previous one with same tag) + * @ return false if Dicom Element doesn't exist + */ + + /* seems to be useless +bool Dict::ReplaceEntry(DictEntry *newEntry) // seems to be useless +{ + const TagKey &key = newEntry->GetKey(); + if ( RemoveEntry(key) ) + { + newEntry->Register(); + KeyHt.insert( TagKeyHT::value_type(key, newEntry)); + return true; + } + return false; +} +*/ -int gdcmDict::AddNewEntry(gdcmDictEntry* NewEntry) { +/** + * \brief removes an already existing Dicom Dictionary Entry, + * identified by its Tag + * @param key (group|element) + * @return false if Dicom Dictionary Entry doesn't exist + */ +bool Dict::RemoveEntry(TagKey const &key) +{ + TagKeyHT::const_iterator it = KeyHt.find(key); + if ( it != KeyHt.end() ) + { + it->second->Unregister(); // delete the entry + KeyHt.erase(key); // remove pointer from HTable - TagKey key; - key = NewEntry->GetKey(); - - if(KeyHt.count(key) >= 1) { - dbg.Verbose(1, "gdcmDict::AddNewEntry allready present", key.c_str()); - return(0); - } else { - KeyHt[NewEntry->GetKey()] = NewEntry; - return(1); - } - } + return true; + } + else + { + gdcmWarningMacro( "Unfound entry" << key ); + return false; + } +} +/** + * \brief removes an already existing Dicom Dictionary Entry, + * identified by its group,element number + * @param group Dicom group number of the Dicom Element + * @param elem Dicom element number of the Dicom Element + * @return false if Dicom Dictionary Entry doesn't exist + */ +bool Dict::RemoveEntry(uint16_t group, uint16_t elem) +{ + return RemoveEntry(DictEntry::TranslateToKey(group, elem)); +} + +/** + * \brief Remove all Dicom Dictionary Entries + */ +void Dict::ClearEntry() +{ + // we assume all the pointed DictEntries are already cleaned-up + // when we clean KeyHt. + TagKeyHT::const_iterator it; + + for(it = KeyHt.begin();it!=KeyHt.end();++it) + it->second->Unregister(); // delete the entry + KeyHt.clear(); // remove all the entries from HTable + +} + +/** + * \brief Get the dictionary entry identified by a given tag ("group|element") + * @param key tag of the searched entry + * @return the corresponding dictionary entry when existing, NULL otherwise + */ +DictEntry *Dict::GetEntry(TagKey const &key) +{ + TagKeyHT::iterator it = KeyHt.find(key); + if ( it == KeyHt.end() ) + { + return 0; + } + return it->second; +} +/** + * \brief Get the dictionary entry identified by its "group" and "element") + * @param group Group number of the searched entry. + * @param elem Element number of the searched entry. + * @return the corresponding dictionary entry when existing, NULL otherwise + */ +DictEntry *Dict::GetEntry(uint16_t group, uint16_t elem) +{ + TagKey key = DictEntry::TranslateToKey(group, elem); + TagKeyHT::iterator it = KeyHt.find(key); + if ( it == KeyHt.end() ) + { + return 0; + } + return it->second; +} -int gdcmDict::RemoveEntry(TagKey key) { - if(KeyHt.count(key) == 1) { - KeyHt.erase(key); - return (1); - } else { - dbg.Verbose(1, "gdcmDict::RemoveEntry unfound entry", key.c_str()); - return (0); - } +/** + * \brief Get the first entry while visiting the Dict entries + * \return The first DicEntry if found, otherwhise NULL + */ +DictEntry *Dict::GetFirstEntry() +{ + ItKeyHt = KeyHt.begin(); + if ( ItKeyHt != KeyHt.end() ) + return ItKeyHt->second; + return NULL; } +/** + * \brief Get the next entry while visiting the Hash table (KeyHt) + * \note : meaningfull only if GetFirstEntry already called + * \return The next DictEntry if found, otherwhise NULL + */ +DictEntry *Dict::GetNextEntry() +{ + gdcmAssertMacro (ItKeyHt != KeyHt.end()); + + ++ItKeyHt; + if (ItKeyHt != KeyHt.end()) + return ItKeyHt->second; + return NULL; +} + +//----------------------------------------------------------------------------- +// Protected + +//----------------------------------------------------------------------------- +// Private +/** + * \brief Add all the dictionary entries from an already open source file + * @param from input stream to read from. + */ +void Dict::DoTheLoadingJob(std::ifstream &from) +{ + if (!from) + return; + + uint16_t group; + uint16_t elem; + VRKey vr; + TagName vm; + TagName name; + + DictEntry *newEntry; + while ( true ) + { + from >> std::hex; + from >> group; + from >> elem; + from >> vr; + from >> vm; + from >> std::ws; //remove white space + std::getline(from, name); + + if(from.eof()) { + break; + } + + newEntry = DictEntry::New(group, elem, vr, vm, name); + AddEntry(newEntry); + newEntry->Delete(); + } + from.close(); +} +//----------------------------------------------------------------------------- +// Print +/** + * \brief Print all the dictionary entries contained in this dictionary. + * Entries will be sorted by tag i.e. the couple (group, element). + * @param os The output stream to be written to. + * @param indent Indentation string to be prepended during printing + */ +void Dict::Print(std::ostream &os, std::string const & ) +{ + os << "Dict file name : [" << Filename << "]" << std::endl; + std::ostringstream s; -int gdcmDict::RemoveEntry (guint16 group, guint16 element) { + for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag) + { +std::cout << tag->second->GetKey() << " " << tag->second->GetName() + << std::endl; + s << "Entry : "; + s << "(" << tag->second->GetKey() << ") = " + << std::dec; + s << tag->second->GetVR() << ", "; + s << tag->second->GetVM() << ", "; + s << tag->second->GetName() << "." << std::endl; + + } + os << s.str(); - return( RemoveEntry(gdcmDictEntry::TranslateToKey(group, element)) ); } +//----------------------------------------------------------------------------- +} // end namespace gdcm