1 /*=========================================================================
4 Module: $RCSfile: gdcmDict.cxx,v $
6 Date: $Date: 2004/10/18 02:31:58 $
7 Version: $Revision: 1.47 $
9 Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
10 l'Image). All rights reserved. See Doc/License.txt or
11 http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
13 This software is distributed WITHOUT ANY WARRANTY; without even
14 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 PURPOSE. See the above copyright notices for more information.
17 =========================================================================*/
21 #include "gdcmDebug.h"
30 //-----------------------------------------------------------------------------
31 // Constructor / Destructor
34 * @param filename from which to build the dictionary.
36 Dict::Dict(std::string const & filename)
44 std::ifstream from( filename.c_str() );
45 dbg.Error(!from, "Dict::Dict: can't open dictionary",
55 from >> std::ws; //remove white space
56 std::getline(from, name);
58 DictEntry * newEntry = new DictEntry(group, element, vr, fourth, name);
59 AddNewEntry(newEntry);
71 for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
73 DictEntry* entryToDelete = tag->second;
79 // Since AddNewEntry adds symetrical in both KeyHt and NameHT we can
80 // assume all the pointed DictEntries are already cleaned-up when
86 //-----------------------------------------------------------------------------
89 * \brief Print all the dictionary entries contained in this dictionary.
90 * Entries will be sorted by tag i.e. the couple (group, element).
91 * @param os The output stream to be written to.
93 void Dict::Print(std::ostream &os)
95 os << "Dict file name : " << Filename << std::endl;
100 * \brief Print all the dictionary entries contained in this dictionary.
101 * Entries will be sorted by tag i.e. the couple (group, element).
102 * @param os The output stream to be written to.
104 void Dict::PrintByKey(std::ostream &os)
106 std::ostringstream s;
108 for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
111 s << "(" << std::hex << std::setw(4) << tag->second->GetGroup() << ',';
112 s << std::hex << std::setw(4) << tag->second->GetElement() << ") = "
114 s << tag->second->GetVR() << ", ";
115 s << tag->second->GetFourth() << ", ";
116 s << tag->second->GetName() << "." << std::endl;
122 * \brief Print all the dictionary entries contained in this dictionary.
123 * Entries will be sorted by the name of the dictionary entries.
124 * \warning AVOID USING IT : the name IS NOT an identifier;
125 * unpredictable result
126 * @param os The output stream to be written to.
128 void Dict::PrintByName(std::ostream& os)
130 std::ostringstream s;
132 for (TagNameHT::iterator tag = NameHt.begin(); tag != NameHt.end(); ++tag)
135 s << tag->second->GetName() << ",";
136 s << tag->second->GetVR() << ", ";
137 s << tag->second->GetFourth() << ", ";
138 s << "(" << std::hex << std::setw(4) << tag->second->GetGroup() << ',';
139 s << std::hex << std::setw(4) << tag->second->GetElement() << ") = ";
140 s << std::dec << std::endl;
145 //-----------------------------------------------------------------------------
149 * \brief adds a new Dicom Dictionary Entry
150 * @param newEntry entry to add
151 * @return false if Dicom Element already exists
153 bool Dict::AddNewEntry(DictEntry *newEntry)
155 TagKey key = newEntry->GetKey();
157 if(KeyHt.count(key) == 1)
159 dbg.Verbose(1, "Dict::AddNewEntry already present", key.c_str());
164 KeyHt[newEntry->GetKey()] = newEntry;
165 NameHt[newEntry->GetName()] = newEntry;
172 * \brief replaces an already existing Dicom Element by a new one
173 * @param newEntry new entry (overwrites any previous one with same tag)
174 * @return false if Dicom Element doesn't exist
176 bool Dict::ReplaceEntry(DictEntry *newEntry)
178 if ( RemoveEntry(newEntry->DictEntry::GetKey()) )
180 KeyHt[newEntry->GetKey()] = newEntry;
181 NameHt[newEntry->GetName()] = newEntry;
189 * \brief removes an already existing Dicom Dictionary Entry,
190 * identified by its Tag
191 * @param key (group|element)
192 * @return false if Dicom Dictionary Entry doesn't exist
194 bool Dict::RemoveEntry(TagKey const & key)
196 TagKeyHT::const_iterator it = KeyHt.find(key);
197 if(it != KeyHt.end())
199 DictEntry* entryToDelete = it->second;
203 NameHt.erase(entryToDelete->GetName());
204 delete entryToDelete;
212 dbg.Verbose(1, "Dict::RemoveEntry unfound entry", key.c_str());
218 * \brief removes an already existing Dicom Dictionary Entry,
219 * identified by its group,element number
220 * @param group Dicom group number of the Dicom Element
221 * @param element Dicom element number of the Dicom Element
222 * @return false if Dicom Dictionary Entry doesn't exist
224 bool Dict::RemoveEntry (uint16_t group, uint16_t element)
226 return RemoveEntry(DictEntry::TranslateToKey(group, element));
230 * \brief Get the dictionnary entry identified by it's name.
231 * @param name element of the ElVal to modify
232 * \warning : NEVER use it !
233 * the 'name' IS NOT an identifier within the Dicom Dicom Dictionary
234 * the name MAY CHANGE between two versions !
235 * @return the corresponding dictionnary entry when existing, NULL otherwise
237 DictEntry* Dict::GetDictEntryByName(TagName const & name)
239 TagNameHT::const_iterator it = NameHt.find(name);
240 if ( it == NameHt.end() )
248 * \brief Get the dictionnary entry identified by a given tag (group,element)
249 * @param group group of the entry to be found
250 * @param element element of the entry to be found
251 * @return the corresponding dictionnary entry when existing, NULL otherwise
253 DictEntry* Dict::GetDictEntryByNumber(uint16_t group, uint16_t element)
255 TagKey key = DictEntry::TranslateToKey(group, element);
256 TagKeyHT::const_iterator it = KeyHt.find(key);
257 if ( it == KeyHt.end() )
265 * \brief Consider all the entries of the public dicom dictionnary.
266 * Build all list of all the tag names of all those entries.
267 * \sa DictSet::GetPubDictTagNamesByCategory
268 * @return A list of all entries of the public dicom dictionnary.
270 EntryNamesList* Dict::GetDictEntryNames()
272 EntryNamesList *result = new EntryNamesList;
273 for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
275 result->push_back( tag->second->GetName() );
282 * \brief Consider all the entries of the public dicom dictionnary.
283 * Build an hashtable whose keys are the names of the groups
284 * (fourth field in each line of dictionary) and whose corresponding
285 * values are lists of all the dictionnary entries among that
286 * group. Note that apparently the Dicom standard doesn't explicitely
287 * define a name (as a string) for each group.
288 * A typical usage of this method would be to enable a dynamic
289 * configuration of a Dicom file browser: the admin/user can
290 * select in the interface which Dicom tags should be displayed.
291 * \warning Dicom *doesn't* define any name for any 'categorie'
292 * (the dictionnary fourth field was formerly NIH defined
293 * - and no longer he is-
294 * and will be removed when Dicom provides us a text file
295 * with the 'official' Dictionnary, that would be more friendly
296 * than asking us to perform a line by line check of the dictionnary
297 * at the beginning of each year to -try to- guess the changes)
298 * Therefore : please NEVER use that fourth field :-(
300 * @return An hashtable: whose keys are the names of the groups and whose
301 * corresponding values are lists of all the dictionnary entries
304 EntryNamesByCatMap *Dict::GetDictEntryNamesByCategory()
306 EntryNamesByCatMap *result = new EntryNamesByCatMap;
308 for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
310 (*result)[tag->second->GetFourth()].push_back(tag->second->GetName());
316 //-----------------------------------------------------------------------------
319 //-----------------------------------------------------------------------------
322 //-----------------------------------------------------------------------------
324 } // end namespace gdcm