1 /*=========================================================================
4 Module: $RCSfile: gdcmDocEntry.cxx,v $
6 Date: $Date: 2006/02/16 20:06:14 $
7 Version: $Revision: 1.81 $
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();
54 * \brief Destructor from a given DictEntry
58 gdcmAssertMacro(DicomDict);
60 DicomDict->Unregister();
63 //-----------------------------------------------------------------------------
66 * \brief Writes the common part of any DataEntry, SeqEntry
67 * @param fp already open ofstream pointer
68 * @param filetype type of the file (ACR, ImplicitVR, ExplicitVR, ...)
70 void DocEntry::WriteContent(std::ofstream *fp, FileType filetype)
72 uint32_t ffff = 0xffffffff;
73 uint16_t group = GetGroup();
75 ///\todo allow skipping Shadow groups
78 uint16_t elem = GetElement();
79 uint32_t lgth = GetLength();
81 if ( group == 0xfffe && elem == 0x0000 )
83 // Fix in order to make some MR PHILIPS images e-film readable
84 // see gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm:
85 // we just *always* ignore spurious fffe|0000 tag !
90 // ----------- Writes the common part
92 // To avoid gdcm to propagate oddities.
93 // --> Don't forget to *write* an even length value
97 // ----------- Writes the common part : the Tag
98 binary_write( *fp, group); //group number
99 binary_write( *fp, elem); //element number
101 // Dicom V3 group 0x0002 is *always* Explicit VR !
102 if ( filetype == ExplicitVR || filetype == JPEG || group == 0x0002 )
104 // ----------- Writes the common part : the VR + the length
106 // Special case of delimiters:
109 // Delimiters have NO Value Representation
110 // Hence we skip writing the VR.
112 // In order to avoid further troubles, we choose to write them
113 // as 'no-length' Item Delimitors (we pad by writing 0xffffffff)
114 // We shall force the end of a given SeqItem by writting
115 // a Item Delimitation Item (fffe, e00d)
117 uint32_t ff = 0xffffffff;
118 binary_write(*fp, ff);
123 uint16_t shortLgr = (uint16_t)lgth;
127 // GDCM_VRUNKNOWN was stored in the Entry VR;
128 // deal with Entry as if TS were Implicit VR
130 binary_write(*fp, lgth);
134 binary_write(*fp, vr.str());
136 // See PS 3.5-2004 page 33, 36
137 if ( (vr == "SQ") || (vr == "OB") || (vr == "OW") || (vr == "OF")
138 || (vr == "UN") || (vr == "UT") )
140 binary_write(*fp, zero);
143 // we set SQ length to ffffffff
144 // and we shall write a Sequence Delimitor Item
145 // at the end of the Sequence!
146 binary_write(*fp, ffff);
150 binary_write(*fp, lgth);
155 binary_write(*fp, shortLgr);
161 // ----------- Writes the common part : the VR
164 binary_write(*fp, ffff);
168 binary_write(*fp, lgth);
174 * \brief Gets the full length of the elementary DocEntry (not only value
175 * length) depending on the VR.
177 uint32_t DocEntry::GetFullLength()
179 uint32_t l = GetReadLength();
180 if ( IsImplicitVR() )
182 l = l + 8; // 2 (gr) + 2 (el) + 4 (lgth)
186 if ( GetVR()=="OB" || GetVR()=="OW" || GetVR()=="SQ" )
188 l = l + 12; // 2 (gr) + 2 (el) + 2 (vr) + 2 (unused) + 4 (lgth)
192 l = l + 8; // 2 (gr) + 2 (el) + 2 (vr) + 2 (lgth)
199 * \brief tells us if entry is the last one of a 'no length' SequenceItem
202 bool DocEntry::IsItemDelimitor()
204 return (GetGroup() == 0xfffe && GetElement() == 0xe00d);
208 * \brief tells us if entry is the first one of an Item
211 bool DocEntry::IsItemStarter()
213 return (GetGroup() == 0xfffe && GetElement() == 0xe000);
217 * \brief tells us if entry is the last one of a 'no length' Sequence
220 bool DocEntry::IsSequenceDelimitor()
222 return (GetGroup() == 0xfffe && GetElement() == 0xe0dd);
226 * \brief Copies all the attributes from an other DocEntry
227 * @param doc entry to copy from
229 void DocEntry::Copy(DocEntry *doc)
231 Length = doc->Length;
232 ReadLength = doc->ReadLength;
233 ImplicitVR = doc->ImplicitVR;
234 Offset = doc->Offset;
237 //-----------------------------------------------------------------------------
240 //-----------------------------------------------------------------------------
243 //-----------------------------------------------------------------------------
246 * \brief Prints the common part of DataEntry, SeqEntry
247 * @param os ostream we want to print in
248 * @param indent Indentation string to be prepended during printing
250 void DocEntry::Print(std::ostream &os, std::string const & )
257 std::ostringstream s;
262 if ( vr == GDCM_VRUNKNOWN )
265 s << DictEntry::TranslateToKey(GetGroup(),GetElement());
270 lgth = GetReadLength(); // ReadLength, as opposed to (usable) Length
271 if (lgth == 0xffffffff)
274 s.setf(std::ios::left);
277 s.setf(std::ios::left);
278 s << std::setw(8) << "-1";
282 st = Util::Format("x(%x)",lgth); // we may keep it
283 s.setf(std::ios::left);
284 s << std::setw(11-st.size()) << " ";
286 s.setf(std::ios::left);
287 s << std::setw(8) << lgth;
290 st = Util::Format("x(%x)",o); // we may keep it
291 s << std::setw(11-st.size()) << " ";
293 s << std::setw(8) << o;
298 s << "[" << vr << "] ";
301 if ( GetElement() == 0x0000 )
302 name = "Group Length";
308 s.setf(std::ios::left);
309 s << std::setw(66-name.length()) << " ";
312 s << "[" << name << "]";
316 //-----------------------------------------------------------------------------
317 } // end namespace gdcm