X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDict.cxx;h=b8ed20ab925be239a2c7979da54127a02cdb0678;hb=00b6e0ddcbdbd41252e03732783f65efe5f52526;hp=6808a8d0b27778cf83e319aefdab33fc3c875b85;hpb=eb941e8785d3742b8a6a1aac964d43dcb4cf49f0;p=gdcm.git diff --git a/src/gdcmDict.cxx b/src/gdcmDict.cxx index 6808a8d0..b8ed20ab 100644 --- a/src/gdcmDict.cxx +++ b/src/gdcmDict.cxx @@ -1,58 +1,66 @@ -// gdcmDict.cxx - -//This is needed when compiling in debug mode -#ifdef _MSC_VER -// 'identifier' : class 'type' needs to have dll-interface to be used by -// clients of class 'type2' -#pragma warning ( disable : 4251 ) -// 'identifier' : identifier was truncated to 'number' characters in the -// debug information -#pragma warning ( disable : 4786 ) -#endif //_MSC_VER +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDict.cxx,v $ + Language: C++ + Date: $Date: 2004/06/22 13:47:33 $ + Version: $Revision: 1.37 $ + + 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. + + 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" -using namespace std; +#include "gdcmDebug.h" + +#include +#include +#include +//----------------------------------------------------------------------------- +// Constructor / Destructor /** - * \ingroup gdcmDict * \brief Construtor * @param FileName from which to build the dictionary. */ gdcmDict::gdcmDict(std::string & FileName) { - std::ifstream from(FileName.c_str()); - dbg.Error(!from, "gdcmDict::gdcmDict: can't open dictionary", - FileName.c_str()); guint16 group, element; - // CLEANME : use defines for all those constants - char buff[1024]; - TagKey key; + //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; + 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); - // FIXME: use AddNewEntry - NameHt[name] = newEntry; - KeyHt[gdcmDictEntry::TranslateToKey(group, element)] = newEntry; + vr, fourth, name); + AddNewEntry(newEntry); } from.close(); + + filename=FileName; } /** - * \ingroup gdcmDict - * \brief + * \brief Destructor */ gdcmDict::~gdcmDict() { for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag) { @@ -60,142 +68,234 @@ gdcmDict::~gdcmDict() { if ( EntryToDelete ) delete EntryToDelete; } - KeyHt.clear(); // 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 /** - * \ingroup gdcmDict - * \brief - * @param os + * \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. */ -void gdcmDict::Print(std::ostream& os) { +void gdcmDict::Print(std::ostream &os) { + os<<"Dict file name : "<second->GetGroup() << ','; - os << hex << tag->second->GetElement() << ") = " << dec; - os << tag->second->GetVR() << ", "; - os << tag->second->GetFourth() << ", "; - os << tag->second->GetName() << "." << endl; + 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->GetFourth() << ", "; + s << tag->second->GetName() << "." << std::endl; } + os << s.str(); } /** - * \ingroup gdcmDict * \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. */ void gdcmDict::PrintByName(std::ostream& os) { + std::ostringstream s; + 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 << "(" << std::hex << tag->second->GetGroup() << ','; - os << std::hex << tag->second->GetElement() << ") = " << dec << std::endl; + 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(); } +//----------------------------------------------------------------------------- +// Public /** * \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 adds a new Dicom Dictionary Entry + * @param NewEntry entry to add + * @return false if Dicom Element already exists */ -gdcmDictEntry * gdcmDict::GetTagByNumber(guint16 group, guint16 element) { - TagKey key = gdcmDictEntry::TranslateToKey(group, element); - if ( ! KeyHt.count(key)) - return (gdcmDictEntry*)0; - return KeyHt.find(key)->second; +bool gdcmDict::AddNewEntry(gdcmDictEntry *NewEntry) +{ + TagKey key; + key = NewEntry->GetKey(); + + if(KeyHt.count(key) == 1) + { + dbg.Verbose(1, "gdcmDict::AddNewEntry already present", key.c_str()); + return(false); + } + else + { + KeyHt[NewEntry->GetKey()] = NewEntry; + NameHt[NewEntry->GetName()] = NewEntry; /// MEMORY LEAK in + /// std::map<>::operator[] + return(true); + } } /** * \ingroup gdcmDict - * \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 + * \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 */ -gdcmDictEntry * gdcmDict::GetTagByName(TagName name) { - if ( ! NameHt.count(name)) - return (gdcmDictEntry*)0; - return NameHt.find(name)->second; +bool gdcmDict::ReplaceEntry(gdcmDictEntry *NewEntry) { + if ( RemoveEntry(NewEntry->gdcmDictEntry::GetKey()) ) { + KeyHt[NewEntry->GetKey()] = NewEntry; + NameHt[NewEntry->GetName()] = NewEntry; + return (true); + } + return (false); } /** * \ingroup gdcmDict - * \brief - * @param NewEntry - * @return + * \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 */ -int gdcmDict::ReplaceEntry(gdcmDictEntry* NewEntry) { - if ( RemoveEntry(NewEntry->gdcmDictEntry::GetKey()) ) { - KeyHt[ NewEntry->GetKey()] = NewEntry; - return (1); +bool gdcmDict::RemoveEntry(TagKey key) +{ + if(KeyHt.count(key) == 1) + { + gdcmDictEntry* EntryToDelete = KeyHt.find(key)->second; + + if ( EntryToDelete ) + { + NameHt.erase(EntryToDelete->GetName()); + delete EntryToDelete; + } + + KeyHt.erase(key); + return (true); } - return (0); + else + { + dbg.Verbose(1, "gdcmDict::RemoveEntry unfound entry", key.c_str()); + return (false); + } } /** * \ingroup gdcmDict - * \brief - * @param NewEntry - * @return + * \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 + * @return false if Dicom Dictionary Entry doesn't exist */ - int gdcmDict::AddNewEntry(gdcmDictEntry* NewEntry) { - TagKey key; - key = NewEntry->GetKey(); - - if(KeyHt.count(key) == 1) { - dbg.Verbose(1, "gdcmDict::AddNewEntry already present", key.c_str()); - return(0); - } else { - KeyHt[NewEntry->GetKey()] = NewEntry; - return(1); - } +bool gdcmDict::RemoveEntry (guint16 group, guint16 element) { + return( RemoveEntry(gdcmDictEntry::TranslateToKey(group, element)) ); } /** * \ingroup gdcmDict - * \brief - * @param key - * @return + * \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 */ -int gdcmDict::RemoveEntry(TagKey key) { - if(KeyHt.count(key) == 1) { - gdcmDictEntry* EntryToDelete = KeyHt.find(key)->second; - if ( EntryToDelete ) - delete EntryToDelete; - KeyHt.erase(key); - return (1); - } else { - dbg.Verbose(1, "gdcmDict::RemoveEntry unfound entry", key.c_str()); - return (0); - } +gdcmDictEntry *gdcmDict::GetDictEntryByName(TagName name) { + if ( ! NameHt.count(name)) + return NULL; + return NameHt.find(name)->second; } /** * \ingroup gdcmDict - * \brief - * @param group - * @param element - * @return + * \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 */ -int gdcmDict::RemoveEntry (guint16 group, guint16 element) { - return( RemoveEntry(gdcmDictEntry::TranslateToKey(group, element)) ); +gdcmDictEntry *gdcmDict::GetDictEntryByNumber(guint16 group, guint16 element) { + TagKey key = gdcmDictEntry::TranslateToKey(group, element); + if ( ! KeyHt.count(key)) + return NULL; + return KeyHt.find(key)->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. + */ +std::list *gdcmDict::GetDictEntryNames(void) +{ + std::list *Result = new std::list; + for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag) + { + Result->push_back( tag->second->GetName() ); + } + return Result; +} + +/** + * \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. + */ +std::map > *gdcmDict::GetDictEntryNamesByCategory(void) +{ + std::map > *Result = new std::map >; + + for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag) + { + (*Result)[tag->second->GetFourth()].push_back(tag->second->GetName()); + } + return Result; +} + +//----------------------------------------------------------------------------- +// Protected + +//----------------------------------------------------------------------------- +// Private + +//-----------------------------------------------------------------------------