1 /*=========================================================================
4 Module: $RCSfile: gdcmDocEntry.cxx,v $
6 Date: $Date: 2005/10/20 15:24:09 $
7 Version: $Revision: 1.75 $
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"
22 #include "gdcmGlobal.h"
24 #include "gdcmDebug.h"
26 #include <iomanip> // for std::ios::left, ...
31 //-----------------------------------------------------------------------------
33 // Constructor / Destructor
35 * \brief Constructor from a given DictEntry
36 * @param in Pointer to existing dictionary entry
38 DocEntry::DocEntry(DictEntry *in)
42 Offset = 0 ; // To avoid further missprinting
44 // init some variables
48 gdcmAssertMacro(DicomDict);
49 DicomDict->Register();
53 * \brief Destructor from a given DictEntry
57 gdcmAssertMacro(DicomDict);
59 DicomDict->Unregister();
62 //-----------------------------------------------------------------------------
65 * \brief Writes the common part of any DataEntry, SeqEntry
66 * @param fp already open ofstream pointer
67 * @param filetype type of the file (ACR, ImplicitVR, ExplicitVR, ...)
69 void DocEntry::WriteContent(std::ofstream *fp, FileType filetype)
71 uint32_t ffff = 0xffffffff;
72 uint16_t group = GetGroup();
74 uint16_t el = GetElement();
75 uint32_t lgth = GetLength();
77 if ( group == 0xfffe && el == 0x0000 )
79 // Fix in order to make some MR PHILIPS images e-film readable
80 // see gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm:
81 // we just *always* ignore spurious fffe|0000 tag !
85 // ----------- Writes the common part
87 binary_write( *fp, group); //group number
88 binary_write( *fp, el); //element number
90 // Dicom V3 group 0x0002 is *always* Explicit VR !
91 if ( filetype == ExplicitVR || filetype == JPEG || group == 0x0002 )
93 // Special case of delimiters:
96 // Delimiters have NO Value Representation
97 // Hence we skip writing the VR.
99 // In order to avoid further troubles, we choose to write them
100 // as 'no-length' Item Delimitors (we pad by writing 0xffffffff)
101 // We shall force the end of a given SeqItem by writting
102 // a Item Delimitation Item (fffe, e00d)
104 uint32_t ff = 0xffffffff;
105 binary_write(*fp, ff);
110 uint16_t shortLgr = (uint16_t)lgth;
114 // GDCM_VRUNKNOWN was stored in the Entry VR;
115 // deal with Entry as if TS were Implicit VR
117 // FIXME : troubles expected on big endian processors :
118 // let lgth = 0x00001234
119 // we write 34 12 00 00 on little endian proc (OK)
120 // we write 12 34 00 00 on big endian proc (KO)
121 //binary_write(*fp, shortLgr);
122 //binary_write(*fp, zero);
124 binary_write(*fp, lgth);
128 binary_write(*fp, vr.str());
130 if ( (vr == "OB") || (vr == "OW") || (vr == "SQ") /*|| (vr == "UN")*/ )
132 binary_write(*fp, zero);
135 // we set SQ length to ffffffff
136 // and we shall write a Sequence Delimitor Item
137 // at the end of the Sequence!
138 binary_write(*fp, ffff);
142 binary_write(*fp, lgth);
147 binary_write(*fp, shortLgr);
155 binary_write(*fp, ffff);
159 binary_write(*fp, lgth);
165 * \brief Gets the full length of the elementary DocEntry (not only value
166 * length) depending on the VR.
168 uint32_t DocEntry::GetFullLength()
170 uint32_t l = GetReadLength();
171 if ( IsImplicitVR() )
173 l = l + 8; // 2 (gr) + 2 (el) + 4 (lgth)
177 if ( GetVR()=="OB" || GetVR()=="OW" || GetVR()=="SQ" )
179 l = l + 12; // 2 (gr) + 2 (el) + 2 (vr) + 2 (unused) + 4 (lgth)
183 l = l + 8; // 2 (gr) + 2 (el) + 2 (vr) + 2 (lgth)
190 * \brief tells us if entry is the last one of a 'no length' SequenceItem
193 bool DocEntry::IsItemDelimitor()
195 return (GetGroup() == 0xfffe && GetElement() == 0xe00d);
199 * \brief tells us if entry is the first one of an Item
202 bool DocEntry::IsItemStarter()
204 return (GetGroup() == 0xfffe && GetElement() == 0xe000);
208 * \brief tells us if entry is the last one of a 'no length' Sequence
211 bool DocEntry::IsSequenceDelimitor()
213 return (GetGroup() == 0xfffe && GetElement() == 0xe0dd);
217 * \brief Copies all the attributes from an other DocEntry
218 * @param doc entry to copy from
220 void DocEntry::Copy(DocEntry *doc)
222 Length = doc->Length;
223 ReadLength = doc->ReadLength;
224 ImplicitVR = doc->ImplicitVR;
225 Offset = doc->Offset;
228 //-----------------------------------------------------------------------------
231 //-----------------------------------------------------------------------------
234 //-----------------------------------------------------------------------------
237 * \brief Prints the common part of DataEntry, SeqEntry
238 * @param os ostream we want to print in
239 * @param indent Indentation string to be prepended during printing
241 void DocEntry::Print(std::ostream &os, std::string const & )
248 std::ostringstream s;
253 if ( vr == GDCM_VRUNKNOWN )
256 s << DictEntry::TranslateToKey(GetGroup(),GetElement());
261 lgth = GetReadLength(); // ReadLength, as opposed to (usable) Length
262 if (lgth == 0xffffffff)
265 s.setf(std::ios::left);
268 s.setf(std::ios::left);
269 s << std::setw(8) << "-1";
273 st = Util::Format("x(%x)",lgth); // we may keep it
274 s.setf(std::ios::left);
275 s << std::setw(11-st.size()) << " ";
277 s.setf(std::ios::left);
278 s << std::setw(8) << lgth;
281 st = Util::Format("x(%x)",o); // we may keep it
282 s << std::setw(11-st.size()) << " ";
284 s << std::setw(8) << o;
289 s << "[" << vr << "] ";
292 if ( GetElement() == 0x0000 )
293 name = "Group Length";
299 s.setf(std::ios::left);
300 s << std::setw(66-name.length()) << " ";
303 s << "[" << name << "]";
307 //-----------------------------------------------------------------------------
308 } // end namespace gdcm