X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDict.cxx;h=fc7c07f2d69dae556afb8222e035b278293a662c;hb=3a9e9df62b3198c4f93d1768074b6be828ac7308;hp=6b2efbec7d564fe2e431fc2ac32fff806453e1b8;hpb=e40fc77cef3155aab87305ce2f8f14d1acbf158f;p=gdcm.git diff --git a/src/gdcmDict.cxx b/src/gdcmDict.cxx index 6b2efbec..fc7c07f2 100644 --- a/src/gdcmDict.cxx +++ b/src/gdcmDict.cxx @@ -3,12 +3,12 @@ Program: gdcm Module: $RCSfile: gdcmDict.cxx,v $ Language: C++ - Date: $Date: 2004/07/02 13:55:27 $ - Version: $Revision: 1.38 $ + Date: $Date: 2005/02/11 15:22:18 $ + Version: $Revision: 1.74 $ 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 @@ -24,183 +24,128 @@ #include #include +namespace gdcm +{ //----------------------------------------------------------------------------- -// Constructor / Destructor -/** - * \brief Construtor - * @param FileName from which to build the dictionary. - */ -gdcmDict::gdcmDict(std::string & FileName) { - uint16_t group; - uint16_t 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; - from >> group; /// MEMORY LEAK in std::istream::operator>> - from >> element; - from >> vr; - from >> fourth; - eatwhite(from); - getline(from, name); /// MEMORY LEAK in std::getline<> - - gdcmDictEntry * newEntry = new gdcmDictEntry(group, element, - vr, fourth, name); - AddNewEntry(newEntry); - } - from.close(); - - filename=FileName; -} - -/** - * \brief Destructor - */ -gdcmDict::~gdcmDict() { - for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag) - { - gdcmDictEntry* EntryToDelete = tag->second; - if ( EntryToDelete ) - delete EntryToDelete; - } - // 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(); -} +/// \brief auto generate function, to fill up the Dicom Dictionnary, +/// if relevant file is not found on user's disk +void FillDefaultDataDict(Dict *d); //----------------------------------------------------------------------------- -// Print +// Constructor / Destructor /** - * \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 */ -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; + gdcmWarningMacro( "Can't open dictionary" << filename.c_str()); + // Using default embeded one: + FillDefaultDataDict( this ); + } + else + { + while (!from.eof()) + { + from >> std::hex; + from >> group; + from >> element; + from >> vr; + from >> vm; + from >> std::ws; //remove white space + std::getline(from, name); + + const DictEntry newEntry(group, element, vr, vm, name); + AddEntry(newEntry); + } + + Filename = filename; + from.close(); } - 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 Destructor */ -void gdcmDict::PrintByName(std::ostream& os) { - std::ostringstream s; - - 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; - } - os << s.str(); +Dict::~Dict() +{ + ClearEntry(); } //----------------------------------------------------------------------------- // 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 const &newEntry) { - gdcmTagKey key; - key = NewEntry->GetKey(); + const TagKey &key = newEntry.GetKey(); if(KeyHt.count(key) == 1) { - dbg.Verbose(1, "gdcmDict::AddNewEntry already present", key.c_str()); - return(false); + gdcmWarningMacro( "Already present" << key.c_str()); + return false; } else { - KeyHt[NewEntry->GetKey()] = NewEntry; - NameHt[NewEntry->GetName()] = NewEntry; /// MEMORY LEAK in - /// std::map<>::operator[] - return(true); + KeyHt.insert( TagKeyHT::value_type(newEntry.GetKey(), 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) + * @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); +bool Dict::ReplaceEntry(DictEntry const &newEntry) +{ + if ( RemoveEntry(newEntry.GetKey()) ) + { + KeyHt.insert( TagKeyHT::value_type(newEntry.GetKey(), 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(gdcmTagKey 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; - } - KeyHt.erase(key); - return (true); + + return true; } else { - dbg.Verbose(1, "gdcmDict::RemoveEntry unfound entry", key.c_str()); - return (false); + gdcmWarningMacro( "Unfound entry" << key.c_str()); + return false; } } @@ -208,91 +153,66 @@ bool gdcmDict::RemoveEntry(gdcmTagKey key) * \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 (uint16_t group, uint16_t element) +bool Dict::RemoveEntry(uint16_t group, uint16_t elem) { - return( RemoveEntry(gdcmDictEntry::TranslateToKey(group, element)) ); + return RemoveEntry(DictEntry::TranslateToKey(group, elem)); } /** - * \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. + KeyHt.clear(); } /** - * \brief Get the dictionnary entry identified by a given tag (group,element) + * \brief Get the dictionary 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 + * @param elem element of the entry to be found + * @return the corresponding dictionary entry when existing, NULL otherwise */ -gdcmDictEntry* gdcmDict::GetDictEntryByNumber(uint16_t group, uint16_t element) +DictEntry *Dict::GetEntry(uint16_t group, uint16_t elem) { - gdcmTagKey key = gdcmDictEntry::TranslateToKey(group, element); - if ( ! KeyHt.count(key)) - return NULL; - return KeyHt.find(key)->second; + TagKey key = DictEntry::TranslateToKey(group, elem); + TagKeyHT::iterator it = KeyHt.find(key); + if ( it == KeyHt.end() ) + { + return 0; + } + return &(it->second); } -/** - * \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 first entry while visiting the Dict entries + * \return The first DicEntry if found, otherwhise NULL */ -std::list* gdcmDict::GetDictEntryNames(void) +DictEntry *Dict::GetFirstEntry() { - std::list *Result = new std::list; - for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag) - { - Result->push_back( tag->second->GetName() ); - } - return Result; + ItKeyHt = KeyHt.begin(); + if( ItKeyHt != KeyHt.end() ) + return &(ItKeyHt->second); + return NULL; } -/** - * \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 next entry while visiting the Hash table (KeyHt) + * \note : meaningfull only if GetFirstEntry already called + * \return The next DictEntry if found, otherwhise NULL */ -std::map > *gdcmDict::GetDictEntryNamesByCategory(void) +DictEntry *Dict::GetNextEntry() { - std::map > *Result = new std::map >; + gdcmAssertMacro (ItKeyHt != KeyHt.end()); - for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag) - { - (*Result)[tag->second->GetFourth()].push_back(tag->second->GetName()); - } - return Result; + ++ItKeyHt; + if (ItKeyHt != KeyHt.end()) + return &(ItKeyHt->second); + return NULL; } //----------------------------------------------------------------------------- @@ -302,3 +222,30 @@ std::map > *gdcmDict::GetDictEntryNamesByCat // Private //----------------------------------------------------------------------------- +// 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) + { + s << "Entry : "; + s << "(" << std::hex << std::setw(4) << tag->second.GetGroup() << ','; + s << std::hex << std::setw(4) << tag->second.GetElement() << ") = " + << std::dec; + s << tag->second.GetVR() << ", "; + s << tag->second.GetVM() << ", "; + s << tag->second.GetName() << "." << std::endl; + } + os << s.str(); +} + +//----------------------------------------------------------------------------- +} // end namespace gdcm