X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDict.cxx;h=75834e1f76ea3f8a82b836d97241470cafcd9627;hb=9b3db5f141ec2b11eadefaa2ea2a3a20058b37f9;hp=e362675dab70de9f96474a486a4a66b59e597c93;hpb=5a6910a313a526514242a21b868c7186fca14168;p=gdcm.git diff --git a/src/gdcmDict.cxx b/src/gdcmDict.cxx index e362675d..75834e1f 100644 --- a/src/gdcmDict.cxx +++ b/src/gdcmDict.cxx @@ -1,8 +1,12 @@ // gdcmDict.cxx - +//----------------------------------------------------------------------------- #include "gdcmDict.h" #include "gdcmUtil.h" + #include +#include +#include + #ifdef GDCM_NO_ANSI_STRING_STREAM # include # define ostringstream ostrstream @@ -10,23 +14,24 @@ # include #endif +//----------------------------------------------------------------------------- +// 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; 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); @@ -37,13 +42,14 @@ gdcmDict::gdcmDict(std::string & FileName) { fourth = buff; from.getline(buff, 256, '\n'); name = buff; + gdcmDictEntry * newEntry = new gdcmDictEntry(group, element, vr, fourth, name); - // FIXME: use AddNewEntry - NameHt[name] = newEntry; - KeyHt[gdcmDictEntry::TranslateToKey(group, element)] = newEntry; + AddNewEntry(newEntry); } from.close(); + + filename=FileName; } /** @@ -56,19 +62,22 @@ 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 /** * \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() << ','; - s << std::hex << tag->second->GetElement() << ") = " << std::dec; + 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; @@ -96,7 +105,7 @@ void gdcmDict::PrintByKey(std::ostream& os) { * \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 + * \warning AVOID USING IT : the name IS NOT an identifier; * unpredictable result * @param os The output stream to be written to. */ @@ -104,78 +113,58 @@ void gdcmDict::PrintByName(std::ostream& os) { std::ostringstream s; for (TagNameHT::iterator tag = NameHt.begin(); tag != NameHt.end(); ++tag){ - s << "Tag : "; + s << "Entry : "; s << tag->second->GetName() << ","; s << tag->second->GetVR() << ", "; s << tag->second->GetFourth() << ", "; - s << "(" << std::hex << tag->second->GetGroup() << ','; - s << std::hex << tag->second->GetElement() << ") = " << std::dec << std::endl; + 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 - */ -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; -} - -/** - * \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 adds a new Dicom Dictionary Entry + * @param NewEntry entry to add + * @return false if Dicom Element already exists */ -gdcmDictEntry * gdcmDict::GetTagByName(TagName name) { - if ( ! NameHt.count(name)) - return (gdcmDictEntry*)0; - return NameHt.find(name)->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; + return(true); + } } /** * \ingroup gdcmDict * \brief replaces an already existing Dicom Element by a new one - * @param NewEntry + * @param NewEntry new entry (overwrites any previous one with same tag) * @return false if Dicom Element doesn't exist */ -bool gdcmDict::ReplaceEntry(gdcmDictEntry* NewEntry) { +bool gdcmDict::ReplaceEntry(gdcmDictEntry *NewEntry) { if ( RemoveEntry(NewEntry->gdcmDictEntry::GetKey()) ) { - KeyHt[ NewEntry->GetKey()] = NewEntry; + KeyHt[NewEntry->GetKey()] = NewEntry; + NameHt[NewEntry->GetName()] = NewEntry; return (true); } return (false); } -/** - * \ingroup gdcmDict - * \brief adds a new Dicom Dictionary Entry - * @param NewEntry - * @return false if Dicom Element already existed - */ - 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; - return(true); - } -} - /** * \ingroup gdcmDict * \brief removes an already existing Dicom Dictionary Entry, @@ -183,14 +172,23 @@ bool gdcmDict::ReplaceEntry(gdcmDictEntry* NewEntry) { * @param key (group|element) * @return false if Dicom Dictionary Entry doesn't exist */ -bool gdcmDict::RemoveEntry(TagKey key) { - if(KeyHt.count(key) == 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); - } else { + } + else + { dbg.Verbose(1, "gdcmDict::RemoveEntry unfound entry", key.c_str()); return (false); } @@ -199,8 +197,7 @@ bool gdcmDict::RemoveEntry(TagKey key) { /** * \ingroup gdcmDict * \brief removes an already existing Dicom Dictionary Entry, - * identified by its group,element - number + * 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 @@ -209,3 +206,91 @@ bool gdcmDict::RemoveEntry (guint16 group, guint16 element) { return( RemoveEntry(gdcmDictEntry::TranslateToKey(group, element)) ); } +/** + * \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 + */ +gdcmDictEntry *gdcmDict::GetDictEntryByName(TagName name) { + if ( ! NameHt.count(name)) + return NULL; + return NameHt.find(name)->second; +} + +/** + * \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 + */ +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 + +//-----------------------------------------------------------------------------