1 /*=========================================================================
4 Module: $RCSfile: gdcmDict.cxx,v $
6 Date: $Date: 2005/01/18 14:28:32 $
7 Version: $Revision: 1.68 $
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"
29 void FillDefaultDataDict(Dict *d);
30 //-----------------------------------------------------------------------------
31 // Constructor / Destructor
42 * @param filename from which to build the dictionary.
44 Dict::Dict(std::string const &filename)
52 std::ifstream from( filename.c_str() );
55 gdcmVerboseMacro( "Can't open dictionary" << filename.c_str());
56 // Using default embeded one:
57 FillDefaultDataDict( this );
68 from >> std::ws; //remove white space
69 std::getline(from, name);
71 const DictEntry newEntry(group, element, vr, vm, name);
72 AddNewEntry(newEntry);
88 //-----------------------------------------------------------------------------
91 * \brief Print all the dictionary entries contained in this dictionary.
92 * Entries will be sorted by tag i.e. the couple (group, element).
93 * @param os The output stream to be written to.
94 * @param indent indent
96 void Dict::Print(std::ostream &os, std::string const & )
98 os << "Dict file name : " << Filename << std::endl;
101 for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
104 s << "(" << std::hex << std::setw(4) << tag->second.GetGroup() << ',';
105 s << std::hex << std::setw(4) << tag->second.GetElement() << ") = "
107 s << tag->second.GetVR() << ", ";
108 s << tag->second.GetVM() << ", ";
109 s << tag->second.GetName() << "." << std::endl;
115 //-----------------------------------------------------------------------------
118 * \brief Remove all Dicom Dictionary Entries
120 void Dict::ClearEntry()
122 // we assume all the pointed DictEntries are already cleaned-up
123 // when we clean KeyHt.
128 * \brief adds a new Dicom Dictionary Entry
129 * @param newEntry entry to add
130 * @return false if Dicom Element already exists
132 bool Dict::AddNewEntry(DictEntry const &newEntry)
134 const TagKey &key = newEntry.GetKey();
136 if(KeyHt.count(key) == 1)
138 gdcmVerboseMacro( "Already present" << key.c_str());
143 KeyHt.insert( TagKeyHT::value_type(newEntry.GetKey(), newEntry));
149 * \brief replaces an already existing Dicom Element by a new one
150 * @param newEntry new entry (overwrites any previous one with same tag)
151 * @return false if Dicom Element doesn't exist
153 bool Dict::ReplaceEntry(DictEntry const &newEntry)
155 if ( RemoveEntry(newEntry.GetKey()) )
157 KeyHt.insert( TagKeyHT::value_type(newEntry.GetKey(), newEntry));
164 * \brief removes an already existing Dicom Dictionary Entry,
165 * identified by its Tag
166 * @param key (group|element)
167 * @return false if Dicom Dictionary Entry doesn't exist
169 bool Dict::RemoveEntry (TagKey const &key)
171 TagKeyHT::const_iterator it = KeyHt.find(key);
172 if(it != KeyHt.end())
180 gdcmVerboseMacro( "Unfound entry" << key.c_str());
186 * \brief removes an already existing Dicom Dictionary Entry,
187 * identified by its group,element number
188 * @param group Dicom group number of the Dicom Element
189 * @param elem Dicom element number of the Dicom Element
190 * @return false if Dicom Dictionary Entry doesn't exist
192 bool Dict::RemoveEntry (uint16_t group, uint16_t elem)
194 return RemoveEntry(DictEntry::TranslateToKey(group, elem));
198 * \brief Get the dictionary entry identified by a given tag (group,element)
199 * @param group group of the entry to be found
200 * @param elem element of the entry to be found
201 * @return the corresponding dictionary entry when existing, NULL otherwise
203 DictEntry *Dict::GetDictEntry(uint16_t group, uint16_t elem)
205 TagKey key = DictEntry::TranslateToKey(group, elem);
206 TagKeyHT::iterator it = KeyHt.find(key);
207 if ( it == KeyHt.end() )
211 return &(it->second);
215 * \brief Consider all the entries of the public dicom dictionary.
216 * Build all list of all the tag names of all those entries.
217 * \sa DictSet::GetPubDictTagNamesByCategory
218 * @return A list of all entries of the public dicom dictionary.
225 //EntryNamesList *Dict::GetDictEntryNames()
227 // EntryNamesList *result = new EntryNamesList;
228 // for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
230 // result->push_back( tag->second.GetName() );
236 * \brief Consider all the entries of the public dicom dictionary.
237 * Build an hashtable whose keys are the names of the groups
238 * (fourth field in each line of dictionary) and whose corresponding
239 * values are lists of all the dictionary entries among that
240 * group. Note that apparently the Dicom standard doesn't explicitely
241 * define a name (as a string) for each group.
242 * A typical usage of this method would be to enable a dynamic
243 * configuration of a Dicom file browser: the admin/user can
244 * select in the interface which Dicom tags should be displayed.
245 * \warning Dicom *doesn't* define any name for any 'categorie'
246 * (the dictionary fourth field was formerly NIH defined
247 * - and no longer he is-
248 * and will be removed when Dicom provides us a text file
249 * with the 'official' Dictionary, that would be more friendly
250 * than asking us to perform a line by line check of the dictionary
251 * at the beginning of each year to -try to- guess the changes)
252 * Therefore : please NEVER use that fourth field :-(
254 * @return An hashtable: whose keys are the names of the groups and whose
255 * corresponding values are lists of all the dictionary entries
261 //EntryNamesByCatMap *Dict::GetDictEntryNamesByCategory()
263 // EntryNamesByCatMap *result = new EntryNamesByCatMap;
265 // for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
267 // (*result)[tag->second.GetFourth()].push_back(tag->second.GetName());
274 * \brief Get the first entry while visiting the Dict entries
275 * \return The first DicEntry if found, otherwhise NULL
277 DictEntry *Dict::GetFirstEntry()
279 ItKeyHt = KeyHt.begin();
280 if( ItKeyHt != KeyHt.end() )
281 return &(ItKeyHt->second);
286 * \brief Get the next entry while visiting the Hash table (KeyHt)
287 * \note : meaningfull only if GetFirstEntry already called
288 * \return The next DictEntry if found, otherwhise NULL
290 DictEntry *Dict::GetNextEntry()
292 gdcmAssertMacro (ItKeyHt != KeyHt.end());
296 if (ItKeyHt != KeyHt.end())
297 return &(ItKeyHt->second);
302 //-----------------------------------------------------------------------------
305 //-----------------------------------------------------------------------------
308 //-----------------------------------------------------------------------------
310 } // end namespace gdcm