src/gdcmDocEntry.cxx

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmDocEntry.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2006/07/06 12:38:06 $
   7   Version:   $Revision: 1.85 $
   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 || filetype == JPEG2000 || 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 ( (filetype == JPEG || filetype == JPEG2000) && group == 0x7fe0 && elem == 0x0010)
 143             {
 144                gdcmAssertMacro( GetVR() == "OW" );
 145                binary_write(*fp, ffff);
 146             }
 147             else if (vr == "SQ")
 148             {
 149                // we set SQ length to ffffffff
 150                // and  we shall write a Sequence Delimitor Item
 151                // at the end of the Sequence!
 152                binary_write(*fp, ffff);
 153             }
 154             else
 155             {
 156                binary_write(*fp, lgth);
 157             }
 158          }
 159          else
 160          {
 161             binary_write(*fp, shortLgr);
 162          }
 163       }
 164    }
 165    else // IMPLICIT VR
 166    {
 167 // ----------- Writes the common part : the VR
 168       if (vr == "SQ")
 169       {
 170          binary_write(*fp, ffff);
 171       }
 172       else
 173       {
 174          binary_write(*fp, lgth);
 175       }
 176    }
 177 }
 178
 179 /// \brief Returns the 'Name' '(e.g. "Patient's Name") found in the Dicom
 180 /// Dictionnary of the current Dicom Header Entry
 181 std::string const &DocEntry::GetName()
 182 {
 183    if (DicomDict == 0)
 184       DicomDict =
 185                  Global::GetDicts()->GetDefaultPubDict()->GetEntry(Key[0],Key[1]);
 186    if (DicomDict == 0)
 187       return GDCM_UNKNOWN;
 188    else
 189    {
 190       DicomDict->Register();
 191       return DicomDict->GetName();
 192    }
 193 }
 194
 195    /// \brief Returns the 'Value Multiplicity' (e.g. "1", "6", "1-n", "3-n"),
 196    /// found in the Dicom entry or in the Dicom Dictionnary
 197    /// of the current Dicom entry
 198 std::string const &DocEntry::GetVM()
 199 {
 200    if (DicomDict == 0)
 201       DicomDict =
 202                  Global::GetDicts()->GetDefaultPubDict()->GetEntry(Key[0],Key[1]);
 203    if (DicomDict == 0)
 204       return GDCM_UNKNOWN;
 205    else
 206    {
 207       DicomDict->Register();
 208       return DicomDict->GetVM();
 209    }
 210 }
 211
 212 /**
 213  * \brief   Gets the full length of the elementary DocEntry (not only value
 214  *          length) depending on the VR.
 215  */
 216 uint32_t DocEntry::GetFullLength()
 217 {
 218    uint32_t l = GetReadLength();
 219    if ( IsImplicitVR() )
 220    {
 221       l = l + 8;  // 2 (gr) + 2 (el) + 4 (lgth)
 222    }
 223    else
 224    {
 225       if ( GetVR()=="OB" || GetVR()=="OW" || GetVR()=="SQ" )
 226       {
 227          l = l + 12; // 2 (gr) + 2 (el) + 2 (vr) + 2 (unused) + 4 (lgth)
 228       }
 229       else
 230       {
 231          l = l + 8;  // 2 (gr) + 2 (el) + 2 (vr) + 2 (lgth)
 232       }
 233    }
 234    return l;
 235 }
 236
 237 /**
 238  * \brief   tells us if entry is the last one of a 'no length' SequenceItem
 239  *          (fffe,e00d)
 240  */
 241 bool DocEntry::IsItemDelimitor()
 242 {
 243    return (GetGroup() == 0xfffe && GetElement() == 0xe00d);
 244 }
 245
 246 /**
 247  * \brief   tells us if entry is the first one of an Item
 248  *          (fffe,e000)
 249  */
 250 bool DocEntry::IsItemStarter()
 251 {
 252    return (GetGroup() == 0xfffe && GetElement() == 0xe000);
 253 }
 254
 255 /**
 256  * \brief   tells us if entry is the last one of a 'no length' Sequence
 257  *          (fffe,e0dd)
 258  */
 259 bool DocEntry::IsSequenceDelimitor()
 260 {
 261    return (GetGroup() == 0xfffe && GetElement() == 0xe0dd);
 262 }
 263
 264 /**
 265  * \brief Copies all the attributes from an other DocEntry
 266  * @param doc entry to copy from
 267  */
 268 void DocEntry::Copy(DocEntry *doc)
 269 {
 270    Length     = doc->Length;
 271    ReadLength = doc->ReadLength;
 272    ImplicitVR = doc->ImplicitVR;
 273    Offset     = doc->Offset;
 274 }
 275
 276 //-----------------------------------------------------------------------------
 277 // Protected
 278
 279 //-----------------------------------------------------------------------------
 280 // Private
 281
 282 //-----------------------------------------------------------------------------
 283 // Print
 284 /**
 285  * \brief   Prints the common part of DataEntry, SeqEntry
 286  * @param   os ostream we want to print in
 287  * @param indent Indentation string to be prepended during printing
 288  */
 289 void DocEntry::Print(std::ostream &os, std::string const & )
 290 {
 291    size_t o;
 292    std::string st;
 293    TSKey v;
 294    std::string d2;
 295    VRKey vr;
 296    std::ostringstream s;
 297    uint32_t lgth;
 298
 299    o  = GetOffset();
 300    vr = GetVR();
 301    if ( vr == GDCM_VRUNKNOWN )
 302       vr = "  ";
 303
 304    s << DictEntry::TranslateToKey(GetGroup(),GetElement());
 305
 306    if (PrintLevel >= 2)
 307    {
 308       s << " lg : ";
 309       lgth = GetReadLength(); // ReadLength, as opposed to (usable) Length
 310       if (lgth == 0xffffffff)
 311       {
 312          st = " ffff ";
 313          s.setf(std::ios::left);
 314          s << std::setw(4);
 315          s << "    x(ffff) ";
 316          s.setf(std::ios::left);
 317          s << std::setw(8) << "-1";
 318       }
 319       else
 320       {
 321          st = Util::Format("x(%x)",lgth); // we may keep it
 322          s.setf(std::ios::left);
 323          s << std::setw(11-st.size()) << " ";
 324          s << st << " ";
 325          s.setf(std::ios::left);
 326          s << std::setw(8) << lgth;
 327       }
 328       s << " Off.: ";
 329       st = Util::Format("x(%x)",o);  // we may keep it
 330       s << std::setw(11-st.size()) << " ";
 331       s << st << " ";
 332       s << std::setw(8) << o;
 333    }
 334    if (PrintLevel >= 1)
 335       s << " ";
 336
 337    s << "[" << vr  << "] ";
 338
 339    std::string name;
 340    if ( GetElement() == 0x0000 )
 341       name = "Group Length";
 342    else
 343       name = GetName();
 344
 345    if (PrintLevel >= 1)
 346    {
 347       s.setf(std::ios::left);
 348       s << std::setw(66-name.length()) << " ";
 349    }
 350
 351    s << "[" << name << "]";
 352    os << s.str();
 353 }
 354
 355 //-----------------------------------------------------------------------------
 356 } // end namespace gdcm