Program: gdcm
Module: $RCSfile: gdcmDocEntry.cxx,v $
Language: C++
- Date: $Date: 2005/01/06 20:03:27 $
- Version: $Revision: 1.38 $
+ Date: $Date: 2007/08/29 15:30:49 $
+ Version: $Revision: 1.93 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
=========================================================================*/
#include "gdcmDocEntry.h"
+#include "gdcmDataEntry.h"
#include "gdcmTS.h"
#include "gdcmVR.h"
#include "gdcmGlobal.h"
#include "gdcmUtil.h"
-
+#include "gdcmDebug.h"
+#include "gdcmDictSet.h"
#include <iomanip> // for std::ios::left, ...
#include <fstream>
-namespace gdcm
+namespace GDCM_NAME_SPACE
{
-
-// CLEAN ME
-#define MAX_SIZE_PRINT_ELEMENT_VALUE 64
-
//-----------------------------------------------------------------------------
+
// Constructor / Destructor
/**
- * \ingroup DocEntry
* \brief Constructor from a given DictEntry
- * @param in Pointer to existing dictionary entry
+ * @param group Group number
+ * @param elem Element number
+ * @param vr VR
*/
-DocEntry::DocEntry(DictEntry *in)
+DocEntry::DocEntry(uint16_t group, uint16_t elem, VRKey const &vr)
{
ImplicitVR = false;
- DicomDict = in;
- SetKey( in->GetKey( ) );
+ DicomDict = 0;
Offset = 0 ; // To avoid further missprinting
// init some variables
ReadLength = 0;
- UsableLength = 0;
+ Length = 0;
+
+ VR = vr;
+ Key.SetGroupElem(group,elem);
}
-//-----------------------------------------------------------------------------
-// Print
/**
- * \ingroup DocEntry
- * \brief Prints the common part of ValEntry, BinEntry, SeqEntry
- * @param os ostream we want to print in
+ * \brief Destructor from a given DictEntry
*/
-void DocEntry::Print(std::ostream &os)
+DocEntry::~DocEntry()
{
- size_t o;
- std::string st;
- TSKey v;
- std::string d2, vr;
- std::ostringstream s;
- uint32_t lgth;
-
- o = GetOffset();
- vr = GetVR();
- if(vr==GDCM_UNKNOWN)
- vr=" ";
-
- s << DictEntry::TranslateToKey(GetGroup(),GetElement());
-
- if (PrintLevel >= 2)
+ if (DicomDict)
{
- s << " lg : ";
- lgth = GetReadLength(); // ReadLength, as opposed to UsableLength
- if (lgth == 0xffffffff)
- {
- st = Util::Format("x(ffff)"); // I said : "x(ffff)" !
- s.setf(std::ios::left);
- s << std::setw(10-st.size()) << " ";
- s << st << " ";
- s.setf(std::ios::left);
- s << std::setw(8) << "-1";
- }
- else
- {
- st = Util::Format("x(%x)",lgth);
- s.setf(std::ios::left);
- s << std::setw(10-st.size()) << " ";
- s << st << " ";
- s.setf(std::ios::left);
- s << std::setw(8) << lgth;
- }
- s << " Off.: ";
- st = Util::Format("x(%x)",o);
- s << std::setw(10-st.size()) << " ";
- s << st << " ";
- s << std::setw(8) << o;
+ gdcmAssertMacro(DicomDict);
+ DicomDict->Unregister();
}
-
- s << "[" << vr << "] ";
-
- if (PrintLevel >= 1)
- {
- s.setf(std::ios::left);
- s << std::setw(66-GetName().length()) << " ";
- }
-
- s << "[" << GetName()<< "]";
- os << s.str();
}
+//-----------------------------------------------------------------------------
+// Public
/**
- * \ingroup DocEntry
- * \brief Writes the common part of any ValEntry, BinEntry, SeqEntry
- * @param fp already open file pointer
- * @param filetype type of the file to be written
+ * \brief Writes the common part of any DataEntry, SeqEntry
+ * @param fp already open ofstream pointer
+ * @param filetype type of the file (ACR, ImplicitVR, ExplicitVR, JPEG, JPEG2000...)
*/
-void DocEntry::WriteContent(std::ofstream *fp, FileType filetype)
+void DocEntry::WriteContent(std::ofstream *fp, FileType filetype, bool insideMetaElements, bool insideSequence)
{
uint32_t ffff = 0xffffffff;
uint16_t group = GetGroup();
- VRKey vr = GetVR();
- uint16_t el = GetElement();
- uint32_t lgr = GetReadLength();
- if ( group == 0xfffe && el == 0x0000 )
+ ///\todo allow skipping Shadow groups
+
+ VRKey vr = GetVR();
+ uint16_t elem = GetElement();
+ uint32_t lgth = GetLength();
+
+ if ( group == 0xfffe && elem == 0x0000 )
{
// Fix in order to make some MR PHILIPS images e-film readable
// see gdcmData/gdcm-MR-PHILIPS-16-Multi-Seq.dcm:
//
// ----------- Writes the common part
//
- binary_write( *fp, group); //group
- binary_write( *fp, el); //element
+ // To avoid gdcm to propagate oddities.
+ // --> Don't forget to *write* an even length value
+ if (lgth%2)
+ lgth ++;
+
+ // ----------- Writes the common part : the Tag
+ binary_write( *fp, group); //group number
+ binary_write( *fp, elem); //element number
- if ( filetype == ExplicitVR )
+ // Dicom V3 group 0x0002 is *always* Explicit VR !
+ if ( filetype == ExplicitVR || filetype == JPEG || filetype == JPEG2000 || (group == 0x0002 && insideMetaElements) )
{
+// ----------- Writes the common part : the VR + the length
+
// Special case of delimiters:
if (group == 0xfffe)
- {
+ {
// Delimiters have NO Value Representation
// Hence we skip writing the VR.
+ //
// In order to avoid further troubles, we choose to write them
// as 'no-length' Item Delimitors (we pad by writing 0xffffffff)
- // The end of a given Item will be found when :
- // - a new Item Delimitor Item is encountered (the Seq goes on)
- // - a Sequence Delimitor Item is encountered (the Seq just ended)
-
- // TODO : verify if the Sequence Delimitor Item was forced during Parsing
+ // We shall force the end of a given SeqItem by writting
+ // a Item Delimitation Item (fffe, e00d)
uint32_t ff = 0xffffffff;
binary_write(*fp, ff);
return;
}
+ uint16_t zero = 0;
+ uint16_t shortLgr = (uint16_t)lgth;
- uint16_t z = 0;
- uint16_t shortLgr = lgr;
-
- if (vr == GDCM_UNKNOWN)
- {
- // Unknown was 'written'
- // deal with Little Endian
- binary_write(*fp, shortLgr);
- binary_write(*fp, z);
- }
- else
+ if( IsVRUnknown() )
{
- binary_write(*fp, vr);
- assert( vr.size() == 2 );
-
- if ( (vr == "OB") || (vr == "OW") || (vr == "SQ") || (vr == "UN") )
+ // if VR was not set by user, we set it to "UN"
+ SetVR("UN");
+ vr=GetVR();
+ }
+
+ //{
+ binary_write(*fp, vr.str());
+ // See PS 3.5-2004 page 33, 36
+ if ( (vr == "SQ") || (vr == "OB") || (vr == "OW") || (vr == "OF")
+ || (vr == "UN") || (vr == "UT") )
{
- binary_write(*fp, z);
- if (vr == "SQ")
+ binary_write(*fp, zero);
+
+ if ( (filetype == JPEG || filetype == JPEG2000) && group == 0x7fe0 && elem == 0x0010 && !insideSequence)
+ {
+ // Only the 'true' Pixel Element may be compressed (hope so!)
+ binary_write(*fp, ffff);
+ }
+ else if (vr == "SQ")
{
// we set SQ length to ffffffff
// and we shall write a Sequence Delimitor Item
}
else
{
- binary_write(*fp, lgr);
+ binary_write(*fp, lgth);
}
}
else
{
binary_write(*fp, shortLgr);
}
- }
+ //}
}
else // IMPLICIT VR
{
+// ----------- Writes the common part : the VR
if (vr == "SQ")
{
binary_write(*fp, ffff);
}
else
{
- binary_write(*fp, lgr);
+ binary_write(*fp, lgth);
}
}
}
-//-----------------------------------------------------------------------------
-// Public
+/// \brief Returns the 'Name' '(e.g. "Patient's Name") found in the Dicom
+/// Dictionnary of the current Dicom Header Entry
+std::string const &DocEntry::GetName()
+{
+ if (DicomDict == 0)
+ DicomDict =
+ Global::GetDicts()->GetDefaultPubDict()->GetEntry(Key[0],Key[1]);
+ if (DicomDict == 0)
+ return GDCM_UNKNOWN;
+ else
+ {
+ DicomDict->Register();
+ return DicomDict->GetName();
+ }
+}
+
+ /// \brief Returns the 'Value Multiplicity' (e.g. "1", "6", "1-n", "3-n"),
+ /// found in the Dicom entry or in the Dicom Dictionnary
+ /// of the current Dicom entry
+std::string const &DocEntry::GetVM()
+{
+ if (DicomDict == 0)
+ DicomDict =
+ Global::GetDicts()->GetDefaultPubDict()->GetEntry(Key[0],Key[1]);
+ if (DicomDict == 0)
+ return GDCM_UNKNOWN;
+ else
+ {
+ DicomDict->Register();
+ return DicomDict->GetVM();
+ }
+}
/**
- * \ingroup DocEntry
* \brief Gets the full length of the elementary DocEntry (not only value
* length) depending on the VR.
*/
}
/**
- * \ingroup DocEntry
- * \brief Copies all the attributes from an other DocEntry
+ * \brief Copies all the attributes from an other DocEntry
+ * @param doc entry to copy from
*/
-void DocEntry::Copy (DocEntry *e)
+void DocEntry::Copy(DocEntry *doc)
{
-// DicomDict = e->DicomDict;
- UsableLength = e->UsableLength;
- ReadLength = e->ReadLength;
- ImplicitVR = e->ImplicitVR;
- Offset = e->Offset;
- // TODO : remove DocEntry SQDepth
-}
-
-/**
- * \ingroup DocEntry
- * \brief tells us if entry is the last one of a 'no length' SequenceItem
- * (fffe,e00d)
- */
-bool DocEntry::IsItemDelimitor()
-{
- return (GetGroup() == 0xfffe && GetElement() == 0xe00d);
-}
-/**
- * \ingroup DocEntry
- * \brief tells us if entry is the last one of a 'no length' Sequence
- * (fffe,e0dd)
- */
-bool DocEntry::IsSequenceDelimitor()
-{
- return (GetGroup() == 0xfffe && GetElement() == 0xe0dd);
+ Length = doc->Length;
+ ReadLength = doc->ReadLength;
+ ImplicitVR = doc->ImplicitVR;
+ Offset = doc->Offset;
}
//-----------------------------------------------------------------------------
// Protected
-
//-----------------------------------------------------------------------------
// Private
//-----------------------------------------------------------------------------
+// Print
+/**
+ * \brief Prints the common part of DataEntry, SeqEntry
+ * @param os ostream we want to print in
+ * @param indent Indentation string to be prepended during printing
+ */
+void DocEntry::Print(std::ostream &os, std::string const & )
+{
+ size_t o;
+ std::string st;
+ TSKey v;
+ std::string d2;
+ VRKey vr;
+ std::ostringstream s;
+ uint32_t lgth;
+
+ o = GetOffset();
+ vr = GetVR();
+ if ( vr == GDCM_VRUNKNOWN )
+ vr = " ";
+ s << DictEntry::TranslateToKey(GetGroup(),GetElement());
+
+ if (PrintLevel >= 2)
+ {
+ s << " lg : ";
+ lgth = GetReadLength(); // ReadLength, as opposed to (usable) Length
+ if (lgth == 0xffffffff)
+ {
+ st = " ffff ";
+ s.setf(std::ios::left);
+ s << std::setw(4);
+ s << " x(ffff) ";
+ s.setf(std::ios::left);
+ s << std::setw(8) << "-1";
+ }
+ else
+ {
+ st = Util::Format("x(%x)",lgth); // we may keep it
+ s.setf(std::ios::left);
+ s << std::setw(11-st.size()) << " ";
+ s << st << " ";
+ s.setf(std::ios::left);
+ s << std::setw(8) << lgth;
+ }
+ s << " Off.: ";
+ st = Util::Format("x(%x)",o); // we may keep it
+ s << std::setw(11-st.size()) << " ";
+ s << st << " ";
+ s << std::setw(8) << o;
+ }
+ if (PrintLevel >= 1)
+ s << " ";
+
+ s << "[" << vr << "] ";
+
+ std::string name;
+ uint16_t e = GetElement();
+ if ( e == 0x0000 )
+ name = "Group Length";
+ else if ( GetGroup()%2 == 1 )
+ {
+ if ( e >= 0x0010 && e <= 0x00ff )
+ name = "Private Creator";
+ else if (e == 0x0001)
+ name = "Private Group Length To End";
+ }
+ else
+ {
+ name = GetName();
+ // prevent Print from any CR at end of name (hope it's enought!)
+ if (name[name.length()-1] == 0x0d || name[name.length()-1] == 0x0a)
+ {
+ name.replace(name.length()-1, 1, 1, ' ');
+ }
+ }
+ if (PrintLevel >= 1)
+ {
+ s.setf(std::ios::left);
+ s << std::setw(66-name.length()) << " ";
+ }
+
+ s << "[" << name << "]";
+ os << s.str();
+}
+
+//-----------------------------------------------------------------------------
} // end namespace gdcm