src/gdcmDocEntry.cxx

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDocEntry.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2006/04/11 16:03:26 $
   7   Version:   $Revision: 1.83 $
   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 "gdcmDocEntry.h"
  20 #include "gdcmDataEntry.h"
  21 #include "gdcmTS.h"
  22 #include "gdcmVR.h"
  23 #include "gdcmGlobal.h"
  24 #include "gdcmUtil.h"
  25 #include "gdcmDebug.h"
  26 #include "gdcmDictSet.h"
  27 #include <iomanip> // for std::ios::left, ...
  28 #include <fstream>
  29
  30 namespace gdcm
  31 {
  32 //-----------------------------------------------------------------------------
  33
  34 // Constructor / Destructor
  35 /**
  36  * \brief   Constructor from a given DictEntry
  37  * @param   group Group number
  38  * @param   elem Element number
  39  * @param   vr VR
  40  */
  41 DocEntry::DocEntry(uint16_t group, uint16_t elem, VRKey const &vr)
  42 {
  43    ImplicitVR = false;
  44    DicomDict  = 0;
  45    Offset     = 0 ; // To avoid further missprinting
  46
  47    // init some variables
  48    ReadLength = 0;
  49    Length = 0;
  50
  51    VR = vr;
  52    Key.SetGroupElem(group,elem);
  53 }
  54
  55 /**
  56  * \brief   Destructor from a given DictEntry
  57  */
  58 DocEntry::~DocEntry()
  59 {
  60    if (DicomDict)
  61    {
  62       gdcmAssertMacro(DicomDict);
  63       DicomDict->Unregister();
  64    }
  65 }
  66
  67 //-----------------------------------------------------------------------------
  68 // Public
  69 /**
  70  * \brief   Writes the common part of any DataEntry, SeqEntry
  71  * @param fp already open ofstream pointer
  72  * @param filetype type of the file (ACR, ImplicitVR, ExplicitVR, ...)
  73  */
  74 void DocEntry::WriteContent(std::ofstream *fp, FileType filetype)
  75 {
  76    uint32_t ffff  = 0xffffffff;
  77    uint16_t group = GetGroup();
  78
  79    ///\todo allow skipping Shadow groups
  80
  81    VRKey vr       = GetVR();
  82    uint16_t elem  = GetElement();
  83    uint32_t lgth  = GetLength();
  84
  85    if ( group == 0xfffe && elem == 0x0000 )
  86    {
  87      // Fix in order to make some MR PHILIPS images e-film readable
  88      // see gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm:
  89      // we just *always* ignore spurious fffe|0000 tag !
  90       return;
  91    }
  92
  93    //
  94    // ----------- Writes the common part
  95    //
  96     // To avoid gdcm to propagate oddities.
  97     // --> Don't forget to *write* an even length value
  98    if (lgth%2)
  99       lgth ++;
 100
 101  // ----------- Writes the common part : the Tag
 102    binary_write( *fp, group); //group number
 103    binary_write( *fp, elem);  //element number
 104
 105    // Dicom V3 group 0x0002 is *always* Explicit VR !
 106    if ( filetype == ExplicitVR || filetype == JPEG || group == 0x0002 )
 107    {
 108 // ----------- Writes the common part : the VR + the length
 109
 110       // Special case of delimiters:
 111       if (group == 0xfffe)
 112       {
 113          // Delimiters have NO Value Representation
 114          // Hence we skip writing the VR.
 115          //
 116          // In order to avoid further troubles, we choose to write them
 117          // as 'no-length' Item Delimitors (we pad by writing 0xffffffff)
 118          // We shall force the end of a given SeqItem by writting
 119          //  a Item Delimitation Item (fffe, e00d)
 120
 121          uint32_t ff = 0xffffffff;
 122          binary_write(*fp, ff);
 123          return;
 124       }
 125       uint16_t zero = 0;
 126       uint16_t shortLgr = (uint16_t)lgth;
 127
 128       if( IsVRUnknown() )
 129       {
 130          // GDCM_VRUNKNOWN was stored in the Entry VR;
 131          // deal with Entry as if TS were Implicit VR
 132          binary_write(*fp, lgth);
 133       }
 134       else
 135       {
 136          binary_write(*fp, vr.str());
 137          // See PS 3.5-2004 page 33, 36
 138          if ( (vr == "SQ") || (vr == "OB") || (vr == "OW") || (vr == "OF")
 139           ||  (vr == "UN") || (vr == "UT") )
 140          {
 141             binary_write(*fp, zero);
 142             if (vr == "SQ")
 143             {
 144                // we set SQ length to ffffffff
 145                // and  we shall write a Sequence Delimitor Item
 146                // at the end of the Sequence!
 147                binary_write(*fp, ffff);
 148             }
 149             else
 150             {
 151                binary_write(*fp, lgth);
 152             }
 153          }
 154          else
 155          {
 156             binary_write(*fp, shortLgr);
 157          }
 158       }
 159    }
 160    else // IMPLICIT VR
 161    {
 162 // ----------- Writes the common part : the VR
 163       if (vr == "SQ")
 164       {
 165          binary_write(*fp, ffff);
 166       }
 167       else
 168       {
 169          binary_write(*fp, lgth);
 170       }
 171    }
 172 }
 173
 174 /// \brief Returns the 'Name' '(e.g. "Patient's Name") found in the Dicom
 175 /// Dictionnary of the current Dicom Header Entry
 176 std::string const &DocEntry::GetName()
 177 {
 178    if (DicomDict == 0)
 179       DicomDict =
 180                  Global::GetDicts()->GetDefaultPubDict()->GetEntry(Key[0],Key[1]);
 181    if (DicomDict == 0)
 182       return GDCM_UNKNOWN;
 183    else
 184    {
 185       DicomDict->Register();
 186       return DicomDict->GetName();
 187    }
 188 }
 189
 190    /// \brief Returns the 'Value Multiplicity' (e.g. "1", "6", "1-n", "3-n"),
 191    /// found in the Dicom entry or in the Dicom Dictionnary
 192    /// of the current Dicom entry
 193 std::string const &DocEntry::GetVM()
 194 {
 195    if (DicomDict == 0)
 196       DicomDict =
 197                  Global::GetDicts()->GetDefaultPubDict()->GetEntry(Key[0],Key[1]);
 198    if (DicomDict == 0)
 199       return GDCM_UNKNOWN;
 200    else
 201    {
 202       DicomDict->Register();
 203       return DicomDict->GetVM();
 204    }
 205 }
 206
 207 /**
 208  * \brief   Gets the full length of the elementary DocEntry (not only value
 209  *          length) depending on the VR.
 210  */
 211 uint32_t DocEntry::GetFullLength()
 212 {
 213    uint32_t l = GetReadLength();
 214    if ( IsImplicitVR() )
 215    {
 216       l = l + 8;  // 2 (gr) + 2 (el) + 4 (lgth)
 217    }
 218    else
 219    {
 220       if ( GetVR()=="OB" || GetVR()=="OW" || GetVR()=="SQ" )
 221       {
 222          l = l + 12; // 2 (gr) + 2 (el) + 2 (vr) + 2 (unused) + 4 (lgth)
 223       }
 224       else
 225       {
 226          l = l + 8;  // 2 (gr) + 2 (el) + 2 (vr) + 2 (lgth)
 227       }
 228    }
 229    return l;
 230 }
 231
 232 /**
 233  * \brief   tells us if entry is the last one of a 'no length' SequenceItem
 234  *          (fffe,e00d)
 235  */
 236 bool DocEntry::IsItemDelimitor()
 237 {
 238    return (GetGroup() == 0xfffe && GetElement() == 0xe00d);
 239 }
 240
 241 /**
 242  * \brief   tells us if entry is the first one of an Item
 243  *          (fffe,e000)
 244  */
 245 bool DocEntry::IsItemStarter()
 246 {
 247    return (GetGroup() == 0xfffe && GetElement() == 0xe000);
 248 }
 249
 250 /**
 251  * \brief   tells us if entry is the last one of a 'no length' Sequence
 252  *          (fffe,e0dd)
 253  */
 254 bool DocEntry::IsSequenceDelimitor()
 255 {
 256    return (GetGroup() == 0xfffe && GetElement() == 0xe0dd);
 257 }
 258
 259 /**
 260  * \brief Copies all the attributes from an other DocEntry
 261  * @param doc entry to copy from
 262  */
 263 void DocEntry::Copy(DocEntry *doc)
 264 {
 265    Length     = doc->Length;
 266    ReadLength = doc->ReadLength;
 267    ImplicitVR = doc->ImplicitVR;
 268    Offset     = doc->Offset;
 269 }
 270
 271 //-----------------------------------------------------------------------------
 272 // Protected
 273
 274 //-----------------------------------------------------------------------------
 275 // Private
 276
 277 //-----------------------------------------------------------------------------
 278 // Print
 279 /**
 280  * \brief   Prints the common part of DataEntry, SeqEntry
 281  * @param   os ostream we want to print in
 282  * @param indent Indentation string to be prepended during printing
 283  */
 284 void DocEntry::Print(std::ostream &os, std::string const & )
 285 {
 286    size_t o;
 287    std::string st;
 288    TSKey v;
 289    std::string d2;
 290    VRKey vr;
 291    std::ostringstream s;
 292    uint32_t lgth;
 293
 294    o  = GetOffset();
 295    vr = GetVR();
 296    if ( vr == GDCM_VRUNKNOWN )
 297       vr = "  ";
 298
 299    s << DictEntry::TranslateToKey(GetGroup(),GetElement());
 300
 301    if (PrintLevel >= 2)
 302    {
 303       s << " lg : ";
 304       lgth = GetReadLength(); // ReadLength, as opposed to (usable) Length
 305       if (lgth == 0xffffffff)
 306       {
 307          st = " ffff ";
 308          s.setf(std::ios::left);
 309          s << std::setw(4);
 310          s << "    x(ffff) ";
 311          s.setf(std::ios::left);
 312          s << std::setw(8) << "-1";
 313       }
 314       else
 315       {
 316          st = Util::Format("x(%x)",lgth); // we may keep it
 317          s.setf(std::ios::left);
 318          s << std::setw(11-st.size()) << " ";
 319          s << st << " ";
 320          s.setf(std::ios::left);
 321          s << std::setw(8) << lgth;
 322       }
 323       s << " Off.: ";
 324       st = Util::Format("x(%x)",o);  // we may keep it
 325       s << std::setw(11-st.size()) << " ";
 326       s << st << " ";
 327       s << std::setw(8) << o;
 328    }
 329    if (PrintLevel >= 1)
 330       s << " ";
 331
 332    s << "[" << vr  << "] ";
 333
 334    std::string name;
 335    if ( GetElement() == 0x0000 )
 336       name = "Group Length";
 337    else
 338       name = GetName();
 339
 340    if (PrintLevel >= 1)
 341    {
 342       s.setf(std::ios::left);
 343       s << std::setw(66-name.length()) << " ";
 344    }
 345
 346    s << "[" << name << "]";
 347    os << s.str();
 348 }
 349
 350 //-----------------------------------------------------------------------------
 351 } // end namespace gdcm