1 /*=========================================================================
4 Module: $RCSfile: gdcmDocEntry.cxx,v $
6 Date: $Date: 2005/10/28 13:02:32 $
7 Version: $Revision: 1.76 $
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
88 // ----------- Writes the common part : the Tag
89 binary_write( *fp, group); //group number
90 binary_write( *fp, el); //element number
92 // Dicom V3 group 0x0002 is *always* Explicit VR !
93 if ( filetype == ExplicitVR || filetype == JPEG || group == 0x0002 )
96 // ----------- Writes the common part : the VR + the length
98 // Special case of delimiters:
101 // Delimiters have NO Value Representation
102 // Hence we skip writing the VR.
104 // In order to avoid further troubles, we choose to write them
105 // as 'no-length' Item Delimitors (we pad by writing 0xffffffff)
106 // We shall force the end of a given SeqItem by writting
107 // a Item Delimitation Item (fffe, e00d)
109 uint32_t ff = 0xffffffff;
110 binary_write(*fp, ff);
115 uint16_t shortLgr = (uint16_t)lgth;
119 // GDCM_VRUNKNOWN was stored in the Entry VR;
120 // deal with Entry as if TS were Implicit VR
122 binary_write(*fp, lgth);
126 binary_write(*fp, vr.str());
128 if ( (vr == "OB") || (vr == "OW") || (vr == "SQ") /*|| (vr == "UN")*/ )
129 // FIXME : what is the status of VR = "UN"
130 // --> uncomment or remove comment !
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);
153 // ----------- Writes the common part : the VR
156 binary_write(*fp, ffff);
160 binary_write(*fp, lgth);
166 * \brief Gets the full length of the elementary DocEntry (not only value
167 * length) depending on the VR.
169 uint32_t DocEntry::GetFullLength()
171 uint32_t l = GetReadLength();
172 if ( IsImplicitVR() )
174 l = l + 8; // 2 (gr) + 2 (el) + 4 (lgth)
178 if ( GetVR()=="OB" || GetVR()=="OW" || GetVR()=="SQ" )
180 l = l + 12; // 2 (gr) + 2 (el) + 2 (vr) + 2 (unused) + 4 (lgth)
184 l = l + 8; // 2 (gr) + 2 (el) + 2 (vr) + 2 (lgth)
191 * \brief tells us if entry is the last one of a 'no length' SequenceItem
194 bool DocEntry::IsItemDelimitor()
196 return (GetGroup() == 0xfffe && GetElement() == 0xe00d);
200 * \brief tells us if entry is the first one of an Item
203 bool DocEntry::IsItemStarter()
205 return (GetGroup() == 0xfffe && GetElement() == 0xe000);
209 * \brief tells us if entry is the last one of a 'no length' Sequence
212 bool DocEntry::IsSequenceDelimitor()
214 return (GetGroup() == 0xfffe && GetElement() == 0xe0dd);
218 * \brief Copies all the attributes from an other DocEntry
219 * @param doc entry to copy from
221 void DocEntry::Copy(DocEntry *doc)
223 Length = doc->Length;
224 ReadLength = doc->ReadLength;
225 ImplicitVR = doc->ImplicitVR;
226 Offset = doc->Offset;
229 //-----------------------------------------------------------------------------
232 //-----------------------------------------------------------------------------
235 //-----------------------------------------------------------------------------
238 * \brief Prints the common part of DataEntry, SeqEntry
239 * @param os ostream we want to print in
240 * @param indent Indentation string to be prepended during printing
242 void DocEntry::Print(std::ostream &os, std::string const & )
249 std::ostringstream s;
254 if ( vr == GDCM_VRUNKNOWN )
257 s << DictEntry::TranslateToKey(GetGroup(),GetElement());
262 lgth = GetReadLength(); // ReadLength, as opposed to (usable) Length
263 if (lgth == 0xffffffff)
266 s.setf(std::ios::left);
269 s.setf(std::ios::left);
270 s << std::setw(8) << "-1";
274 st = Util::Format("x(%x)",lgth); // we may keep it
275 s.setf(std::ios::left);
276 s << std::setw(11-st.size()) << " ";
278 s.setf(std::ios::left);
279 s << std::setw(8) << lgth;
282 st = Util::Format("x(%x)",o); // we may keep it
283 s << std::setw(11-st.size()) << " ";
285 s << std::setw(8) << o;
290 s << "[" << vr << "] ";
293 if ( GetElement() == 0x0000 )
294 name = "Group Length";
300 s.setf(std::ios::left);
301 s << std::setw(66-name.length()) << " ";
304 s << "[" << name << "]";
308 //-----------------------------------------------------------------------------
309 } // end namespace gdcm