X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDict.cxx;h=a314a91a09b4a7caf3cc91c850117da3d106c7f9;hb=f2dd0107ba49eda3386b34715cdc0c046d12397f;hp=fd3e990c26905caa7c4f9895ae717e90d74ffc8e;hpb=1bc5ccd72098866fc29ca8a786e8bb6852f388ea;p=gdcm.git diff --git a/src/gdcmDict.cxx b/src/gdcmDict.cxx index fd3e990c..a314a91a 100644 --- a/src/gdcmDict.cxx +++ b/src/gdcmDict.cxx @@ -1,5 +1,21 @@ -// 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 "gdcmDict.h" #include "gdcmUtil.h" #include "gdcmDebug.h" @@ -8,280 +24,268 @@ #include #include -#ifdef GDCM_NO_ANSI_STRING_STREAM -# include -# define ostringstream ostrstream -# else -# include -#endif +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); //----------------------------------------------------------------------------- // Constructor / Destructor /** - * \brief Construtor - * @param FileName from which to build the dictionary. + * \brief Constructor */ -gdcmDict::gdcmDict(std::string & FileName) { - guint16 group, element; - char buff[1024]; - TagName vr; - TagName fourth; - TagName name; - - std::ifstream from(FileName.c_str()); - dbg.Error(!from, "gdcmDict::gdcmDict: can't open dictionary", - FileName.c_str()); - - while (!from.eof()) { - from >> std::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); - AddNewEntry(newEntry); - } - from.close(); - - filename=FileName; +Dict::Dict( ) +{ + Filename=""; } /** - * \brief Destructor + * \brief Constructor + * @param filename from which to build the dictionary. */ -gdcmDict::~gdcmDict() { - for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag) { - gdcmDictEntry* EntryToDelete = tag->second; - if ( EntryToDelete ) - delete EntryToDelete; +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; } - // Since AddNewEntry adds symetrical in both KeyHt and NameHT we can - // assume all the pointed gdcmDictEntries are already cleaned-up when - // we cleaned KeyHt. - KeyHt.clear(); - NameHt.clear(); } -//----------------------------------------------------------------------------- -// 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. + * \brief Destructor */ -void gdcmDict::Print(std::ostream &os) { - os<<"Dict file name : "<second->GetGroup() << ','; - s << std::hex << std::setw(4) << tag->second->GetElement() << ") = " << std::dec; - s << tag->second->GetVR() << ", "; - s << tag->second->GetFourth() << ", "; - s << tag->second->GetName() << "." << std::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; } - os << s.str(); } /** - * \brief Print all the dictionary entries contained in this dictionary. - * Entries will be sorted by the name of the dictionary entries. - * \warning AVOID USING IT : the name IS NOT an identifier; - * unpredictable result - * @param os The output stream to be written to. + * \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. */ -void gdcmDict::PrintByName(std::ostream& os) { - std::ostringstream s; +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; - for (TagNameHT::iterator tag = NameHt.begin(); tag != NameHt.end(); ++tag){ - s << "Entry : "; - s << tag->second->GetName() << ","; - s << tag->second->GetVR() << ", "; - s << tag->second->GetFourth() << ", "; - s << "(" << std::hex << std::setw(4) << tag->second->GetGroup() << ','; - s << std::hex << std::setw(4) << tag->second->GetElement() << ") = "; - s << std::dec << std::endl; + 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; } - os << s.str(); } -//----------------------------------------------------------------------------- -// Public /** - * \ingroup gdcmDict * \brief adds a new Dicom Dictionary Entry - * @param NewEntry entry to add + * @param newEntry entry to add * @return false if Dicom Element already exists */ -bool gdcmDict::AddNewEntry(gdcmDictEntry *NewEntry) +bool Dict::AddEntry(DictEntry *newEntry) { - TagKey key; - key = NewEntry->GetKey(); + const TagKey &key = newEntry->GetKey(); - if(KeyHt.count(key) == 1) + if ( KeyHt.count(key) == 1 ) { - dbg.Verbose(1, "gdcmDict::AddNewEntry already present", key.c_str()); - return(false); + gdcmErrorMacro( "Already present:" << key ); + return false; } else { - KeyHt[NewEntry->GetKey()] = NewEntry; - NameHt[NewEntry->GetName()] = NewEntry; - return(true); + newEntry->Register(); + KeyHt.insert( TagKeyHT::value_type(key, newEntry)); + return true; } } -/** - * \ingroup gdcmDict - * \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 +/* + * \ 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 */ -bool gdcmDict::ReplaceEntry(gdcmDictEntry *NewEntry) { - if ( RemoveEntry(NewEntry->gdcmDictEntry::GetKey()) ) { - KeyHt[NewEntry->GetKey()] = NewEntry; - NameHt[NewEntry->GetName()] = NewEntry; - return (true); + + /* 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); + return false; } +*/ /** - * \ingroup gdcmDict * \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 gdcmDict::RemoveEntry(TagKey key) +bool Dict::RemoveEntry(TagKey const &key) { - if(KeyHt.count(key) == 1) + TagKeyHT::const_iterator it = KeyHt.find(key); + if ( it != KeyHt.end() ) { - gdcmDictEntry* EntryToDelete = KeyHt.find(key)->second; - - if ( EntryToDelete ) - { - NameHt.erase(EntryToDelete->GetName()); - delete EntryToDelete; - } + it->second->Unregister(); // delete the entry + KeyHt.erase(key); // remove pointer from HTable - KeyHt.erase(key); - return (true); + return true; } else { - dbg.Verbose(1, "gdcmDict::RemoveEntry unfound entry", key.c_str()); - return (false); + gdcmWarningMacro( "Unfound entry" << key ); + return false; } } /** - * \ingroup gdcmDict * \brief removes an already existing Dicom Dictionary Entry, * identified by its group,element number * @param group Dicom group number of the Dicom Element - * @param element Dicom element number of the Dicom Element + * @param elem Dicom element number of the Dicom Element * @return false if Dicom Dictionary Entry doesn't exist */ -bool gdcmDict::RemoveEntry (guint16 group, guint16 element) { - return( RemoveEntry(gdcmDictEntry::TranslateToKey(group, element)) ); +bool Dict::RemoveEntry(uint16_t group, uint16_t elem) +{ + return RemoveEntry(DictEntry::TranslateToKey(group, elem)); } /** - * \ingroup gdcmDict - * \brief Get the dictionnary entry identified by it's name. - * @param name element of the ElVal to modify - * \warning : NEVER use it ! - * the 'name' IS NOT an identifier within the Dicom Dicom Dictionary - * the name MAY CHANGE between two versions ! - * @return the corresponding dictionnary entry when existing, NULL otherwise + * \brief Remove all Dicom Dictionary Entries */ -gdcmDictEntry *gdcmDict::GetDictEntryByName(TagName name) { - if ( ! NameHt.count(name)) - return NULL; - return NameHt.find(name)->second; +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 + } /** - * \ingroup gdcmDict - * \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 + * \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 */ -gdcmDictEntry *gdcmDict::GetDictEntryByNumber(guint16 group, guint16 element) { - TagKey key = gdcmDictEntry::TranslateToKey(group, element); - if ( ! KeyHt.count(key)) - return NULL; - return KeyHt.find(key)->second; +DictEntry *Dict::GetEntry(TagKey const &key) +{ + TagKeyHT::iterator it = KeyHt.find(key); + if ( it == KeyHt.end() ) + { + return 0; + } + return it->second; } - -/** - * \ingroup gdcmDict - * \brief Consider all the entries of the public dicom dictionnary. - * Build all list of all the tag names of all those entries. - * \sa gdcmDictSet::GetPubDictTagNamesByCategory - * @return A list of all entries of the public dicom dictionnary. +/** + * \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 */ -std::list *gdcmDict::GetDictEntryNames(void) +DictEntry *Dict::GetEntry(uint16_t group, uint16_t elem) { - std::list *Result = new std::list; - for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag) + TagKey key = DictEntry::TranslateToKey(group, elem); + TagKeyHT::iterator it = KeyHt.find(key); + if ( it == KeyHt.end() ) { - Result->push_back( tag->second->GetName() ); + return 0; } - return Result; + return it->second; } -/** - * \ingroup gdcmDict - * \brief Consider all the entries of the public dicom dictionnary. - * Build an hashtable whose keys are the names of the groups - * (fourth field in each line of dictionary) and whose corresponding - * values are lists of all the dictionnary entries among that - * group. Note that apparently the Dicom standard doesn't explicitely - * define a name (as a string) for each group. - * A typical usage of this method would be to enable a dynamic - * configuration of a Dicom file browser: the admin/user can - * select in the interface which Dicom tags should be displayed. - * \warning Dicom *doesn't* define any name for any 'categorie' - * (the dictionnary fourth field was formerly NIH defined - * - and no longer he is- - * and will be removed when Dicom provides us a text file - * with the 'official' Dictionnary, that would be more friendly - * than asking us to perform a line by line check of the dictionnary - * at the beginning of each year to -try to- guess the changes) - * Therefore : please NEVER use that fourth field :-( - * - * @return An hashtable: whose keys are the names of the groups and whose - * corresponding values are lists of all the dictionnary entries - * among that group. +/** + * \brief Get the first entry while visiting the Dict entries + * \return The first DicEntry if found, otherwhise NULL */ -std::map > *gdcmDict::GetDictEntryNamesByCategory(void) +DictEntry *Dict::GetFirstEntry() { - std::map > *Result = new std::map >; + ItKeyHt = KeyHt.begin(); + if ( ItKeyHt != KeyHt.end() ) + return ItKeyHt->second; + return NULL; +} - for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag) - { - (*Result)[tag->second->GetFourth()].push_back(tag->second->GetName()); - } - return Result; +/** + * \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; } //----------------------------------------------------------------------------- @@ -289,5 +293,70 @@ std::map > *gdcmDict::GetDictEntryNamesByCat //----------------------------------------------------------------------------- // 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; + + 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(); + +} //----------------------------------------------------------------------------- +} // end namespace gdcm