src/gdcmDict.cxx

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDict.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2005/01/23 10:12:33 $
   7   Version:   $Revision: 1.69 $
   8
   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.
  12
  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.
  16
  17 =========================================================================*/
  18
  19 #include "gdcmDict.h"
  20 #include "gdcmUtil.h"
  21 #include "gdcmDebug.h"
  22
  23 #include <fstream>
  24 #include <iostream>
  25 #include <iomanip>
  26
  27 namespace gdcm
  28 {
  29 void FillDefaultDataDict(Dict *d);
  30 //-----------------------------------------------------------------------------
  31 // Constructor / Destructor
  32 /**
  33  * \brief   Constructor
  34  */
  35 Dict::Dict( )
  36 {
  37    Filename="";
  38 }
  39
  40 /**
  41  * \brief   Constructor
  42  * @param   filename from which to build the dictionary.
  43  */
  44 Dict::Dict(std::string const &filename)
  45 {
  46    uint16_t group;
  47    uint16_t element;
  48    TagName vr;
  49    TagName vm;
  50    TagName name;
  51
  52    std::ifstream from( filename.c_str() );
  53    if( !from )
  54    {
  55       gdcmVerboseMacro( "Can't open dictionary" << filename.c_str());
  56       // Using default embeded one:
  57       FillDefaultDataDict( this );
  58    }
  59    else
  60    {
  61       while (!from.eof())
  62       {
  63          from >> std::hex;
  64          from >> group;
  65          from >> element;
  66          from >> vr;
  67          from >> vm;
  68          from >> std::ws;  //remove white space
  69          std::getline(from, name);
  70
  71          const DictEntry newEntry(group, element, vr, vm, name);
  72          AddNewEntry(newEntry);
  73       }
  74
  75       Filename = filename;
  76       from.close();
  77    }
  78 }
  79
  80 /**
  81  * \brief  Destructor
  82  */
  83 Dict::~Dict()
  84 {
  85    ClearEntry();
  86 }
  87
  88 //-----------------------------------------------------------------------------
  89 // Print
  90 /**
  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 Indentation string to be prepended during printing
  95  */
  96 void Dict::Print(std::ostream &os, std::string const & )
  97 {
  98    os << "Dict file name : " << Filename << std::endl;
  99    std::ostringstream s;
 100
 101    for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
 102    {
 103       s << "Entry : ";
 104       s << "(" << std::hex << std::setw(4) << tag->second.GetGroup() << ',';
 105       s << std::hex << std::setw(4) << tag->second.GetElement() << ") = "
 106         << std::dec;
 107       s << tag->second.GetVR() << ", ";
 108       s << tag->second.GetVM() << ", ";
 109       s << tag->second.GetName() << "."  << std::endl;
 110    }
 111    os << s.str();
 112 }
 113
 114
 115 //-----------------------------------------------------------------------------
 116 // Public
 117 /**
 118  * \brief   Remove all Dicom Dictionary Entries
 119  */
 120 void Dict::ClearEntry()
 121 {
 122    // we assume all the pointed DictEntries are already cleaned-up
 123    // when we clean KeyHt.
 124    KeyHt.clear();
 125 }
 126
 127 /**
 128  * \brief  adds a new Dicom Dictionary Entry
 129  * @param   newEntry entry to add
 130  * @return  false if Dicom Element already exists
 131  */
 132 bool Dict::AddNewEntry(DictEntry const &newEntry)
 133 {
 134    const TagKey &key = newEntry.GetKey();
 135
 136    if(KeyHt.count(key) == 1)
 137    {
 138       gdcmVerboseMacro( "Already present" << key.c_str());
 139       return false;
 140    }
 141    else
 142    {
 143       KeyHt.insert( TagKeyHT::value_type(newEntry.GetKey(), newEntry));
 144       return true;
 145    }
 146 }
 147
 148 /**
 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
 152  */
 153 bool Dict::ReplaceEntry(DictEntry const &newEntry)
 154 {
 155    if ( RemoveEntry(newEntry.GetKey()) )
 156    {
 157        KeyHt.insert( TagKeyHT::value_type(newEntry.GetKey(), newEntry));
 158        return true;
 159    }
 160    return false;
 161 }
 162
 163 /**
 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
 168  */
 169 bool Dict::RemoveEntry (TagKey const &key)
 170 {
 171    TagKeyHT::const_iterator it = KeyHt.find(key);
 172    if(it != KeyHt.end())
 173    {
 174       KeyHt.erase(key);
 175
 176       return true;
 177    }
 178    else
 179    {
 180       gdcmVerboseMacro( "Unfound entry" << key.c_str());
 181       return false;
 182   }
 183 }
 184
 185 /**
 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
 191  */
 192 bool Dict::RemoveEntry (uint16_t group, uint16_t elem)
 193 {
 194    return RemoveEntry(DictEntry::TranslateToKey(group, elem));
 195 }
 196
 197 /**
 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
 202  */
 203 DictEntry *Dict::GetDictEntry(uint16_t group, uint16_t elem)
 204 {
 205    TagKey key = DictEntry::TranslateToKey(group, elem);
 206    TagKeyHT::iterator it = KeyHt.find(key);
 207    if ( it == KeyHt.end() )
 208    {
 209       return 0;
 210    }
 211    return &(it->second);
 212 }
 213
 214 /**
 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.
 219  */
 220
 221
 222  // Probabely useless
 223
 224
 225 //EntryNamesList *Dict::GetDictEntryNames()
 226 //{
 227 //   EntryNamesList *result = new EntryNamesList;
 228 //   for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
 229 //   {
 230 //      result->push_back( tag->second.GetName() );
 231 //   }
 232 //   return result;
 233 //}
 234
 235 /**
 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 :-(
 253  *
 254  * @return  An hashtable: whose keys are the names of the groups and whose
 255  *          corresponding values are lists of all the dictionary entries
 256  *          among that group.
 257  */
 258
 259  // Probabely useless
 260
 261 //EntryNamesByCatMap *Dict::GetDictEntryNamesByCategory()
 262 //{
 263 //   EntryNamesByCatMap *result = new EntryNamesByCatMap;
 264 //
 265 //   for (TagKeyHT::iterator tag = KeyHt.begin(); tag != KeyHt.end(); ++tag)
 266 //   {
 267 //      (*result)[tag->second.GetFourth()].push_back(tag->second.GetName());
 268 //   }
 269 //
 270 //   return result;
 271 //}
 272
 273 /**
 274  * \brief   Get the first entry while visiting the Dict entries
 275  * \return  The first DicEntry if found, otherwhise NULL
 276  */
 277 DictEntry *Dict::GetFirstEntry()
 278 {
 279    ItKeyHt = KeyHt.begin();
 280    if( ItKeyHt != KeyHt.end() )
 281       return &(ItKeyHt->second);
 282    return NULL;
 283 }
 284
 285 /**
 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
 289  */
 290 DictEntry *Dict::GetNextEntry()
 291 {
 292    gdcmAssertMacro (ItKeyHt != KeyHt.end());
 293
 294    {
 295       ++ItKeyHt;
 296       if (ItKeyHt != KeyHt.end())
 297          return &(ItKeyHt->second);
 298    }
 299    return NULL;
 300 }
 301
 302 //-----------------------------------------------------------------------------
 303 // Protected
 304
 305 //-----------------------------------------------------------------------------
 306 // Private
 307
 308 //-----------------------------------------------------------------------------
 309
 310 } // end namespace gdcm