1 /*=========================================================================
4 Module: $RCSfile: gdcmDocEntry.cxx,v $
6 Date: $Date: 2006/03/22 13:19:25 $
7 Version: $Revision: 1.82 $
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 =========================================================================*/
19 #include "gdcmDocEntry.h"
20 #include "gdcmDataEntry.h"
23 #include "gdcmGlobal.h"
25 #include "gdcmDebug.h"
27 #include <iomanip> // for std::ios::left, ...
32 //-----------------------------------------------------------------------------
34 // Constructor / Destructor
36 * \brief Constructor from a given DictEntry
37 * @param in Pointer to existing dictionary entry
39 DocEntry::DocEntry(DictEntry *in)
43 Offset = 0 ; // To avoid further missprinting
45 // init some variables
49 gdcmAssertMacro(DicomDict);
50 DicomDict->Register();
57 * \brief Destructor from a given DictEntry
61 gdcmAssertMacro(DicomDict);
63 DicomDict->Unregister();
66 //-----------------------------------------------------------------------------
69 * \brief Writes the common part of any DataEntry, SeqEntry
70 * @param fp already open ofstream pointer
71 * @param filetype type of the file (ACR, ImplicitVR, ExplicitVR, ...)
73 void DocEntry::WriteContent(std::ofstream *fp, FileType filetype)
75 uint32_t ffff = 0xffffffff;
76 uint16_t group = GetGroup();
78 ///\todo allow skipping Shadow groups
81 uint16_t elem = GetElement();
82 uint32_t lgth = GetLength();
84 if ( group == 0xfffe && elem == 0x0000 )
86 // Fix in order to make some MR PHILIPS images e-film readable
87 // see gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm:
88 // we just *always* ignore spurious fffe|0000 tag !
93 // ----------- Writes the common part
95 // To avoid gdcm to propagate oddities.
96 // --> Don't forget to *write* an even length value
100 // ----------- Writes the common part : the Tag
101 binary_write( *fp, group); //group number
102 binary_write( *fp, elem); //element number
104 // Dicom V3 group 0x0002 is *always* Explicit VR !
105 if ( filetype == ExplicitVR || filetype == JPEG || group == 0x0002 )
107 // ----------- Writes the common part : the VR + the length
109 // Special case of delimiters:
112 // Delimiters have NO Value Representation
113 // Hence we skip writing the VR.
115 // In order to avoid further troubles, we choose to write them
116 // as 'no-length' Item Delimitors (we pad by writing 0xffffffff)
117 // We shall force the end of a given SeqItem by writting
118 // a Item Delimitation Item (fffe, e00d)
120 uint32_t ff = 0xffffffff;
121 binary_write(*fp, ff);
126 uint16_t shortLgr = (uint16_t)lgth;
130 // GDCM_VRUNKNOWN was stored in the Entry VR;
131 // deal with Entry as if TS were Implicit VR
133 binary_write(*fp, lgth);
137 binary_write(*fp, vr.str());
139 // See PS 3.5-2004 page 33, 36
140 if ( (vr == "SQ") || (vr == "OB") || (vr == "OW") || (vr == "OF")
141 || (vr == "UN") || (vr == "UT") )
143 binary_write(*fp, zero);
146 // we set SQ length to ffffffff
147 // and we shall write a Sequence Delimitor Item
148 // at the end of the Sequence!
149 binary_write(*fp, ffff);
153 binary_write(*fp, lgth);
158 binary_write(*fp, shortLgr);
164 // ----------- Writes the common part : the VR
167 binary_write(*fp, ffff);
171 binary_write(*fp, lgth);
177 * \brief Gets the full length of the elementary DocEntry (not only value
178 * length) depending on the VR.
180 uint32_t DocEntry::GetFullLength()
182 uint32_t l = GetReadLength();
183 if ( IsImplicitVR() )
185 l = l + 8; // 2 (gr) + 2 (el) + 4 (lgth)
189 if ( GetVR()=="OB" || GetVR()=="OW" || GetVR()=="SQ" )
191 l = l + 12; // 2 (gr) + 2 (el) + 2 (vr) + 2 (unused) + 4 (lgth)
195 l = l + 8; // 2 (gr) + 2 (el) + 2 (vr) + 2 (lgth)
202 * \brief tells us if entry is the last one of a 'no length' SequenceItem
205 bool DocEntry::IsItemDelimitor()
207 return (GetGroup() == 0xfffe && GetElement() == 0xe00d);
211 * \brief tells us if entry is the first one of an Item
214 bool DocEntry::IsItemStarter()
216 return (GetGroup() == 0xfffe && GetElement() == 0xe000);
220 * \brief tells us if entry is the last one of a 'no length' Sequence
223 bool DocEntry::IsSequenceDelimitor()
225 return (GetGroup() == 0xfffe && GetElement() == 0xe0dd);
229 * \brief Copies all the attributes from an other DocEntry
230 * @param doc entry to copy from
232 void DocEntry::Copy(DocEntry *doc)
234 Length = doc->Length;
235 ReadLength = doc->ReadLength;
236 ImplicitVR = doc->ImplicitVR;
237 Offset = doc->Offset;
240 //-----------------------------------------------------------------------------
243 //-----------------------------------------------------------------------------
246 //-----------------------------------------------------------------------------
249 * \brief Prints the common part of DataEntry, SeqEntry
250 * @param os ostream we want to print in
251 * @param indent Indentation string to be prepended during printing
253 void DocEntry::Print(std::ostream &os, std::string const & )
260 std::ostringstream s;
265 if ( vr == GDCM_VRUNKNOWN )
268 s << DictEntry::TranslateToKey(GetGroup(),GetElement());
273 lgth = GetReadLength(); // ReadLength, as opposed to (usable) Length
274 if (lgth == 0xffffffff)
277 s.setf(std::ios::left);
280 s.setf(std::ios::left);
281 s << std::setw(8) << "-1";
285 st = Util::Format("x(%x)",lgth); // we may keep it
286 s.setf(std::ios::left);
287 s << std::setw(11-st.size()) << " ";
289 s.setf(std::ios::left);
290 s << std::setw(8) << lgth;
293 st = Util::Format("x(%x)",o); // we may keep it
294 s << std::setw(11-st.size()) << " ";
296 s << std::setw(8) << o;
301 s << "[" << vr << "] ";
304 if ( GetElement() == 0x0000 )
305 name = "Group Length";
311 s.setf(std::ios::left);
312 s << std::setw(66-name.length()) << " ";
315 s << "[" << name << "]";
319 //-----------------------------------------------------------------------------
320 } // end namespace gdcm