Program: gdcm
Module: $RCSfile: gdcmDocEntry.cxx,v $
Language: C++
- Date: $Date: 2004/09/24 11:34:21 $
- Version: $Revision: 1.21 $
+ Date: $Date: 2006/07/06 12:38:06 $
+ Version: $Revision: 1.85 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
- http://www.creatis.insa-lyon.fr/Public/Gdcm/License.htm for details.
+ http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
=========================================================================*/
#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>
-// CLEAN ME
-#define MAX_SIZE_PRINT_ELEMENT_VALUE 64
-
+namespace gdcm
+{
//-----------------------------------------------------------------------------
+
// Constructor / Destructor
/**
- * \ingroup gdcmDocEntry
- * \brief Constructor from a given gdcmDictEntry
- * @param in Pointer to existing dictionary entry
+ * \brief Constructor from a given DictEntry
+ * @param group Group number
+ * @param elem Element number
+ * @param vr VR
*/
-gdcmDocEntry::gdcmDocEntry(gdcmDictEntry* in)
+DocEntry::DocEntry(uint16_t group, uint16_t elem, VRKey const &vr)
{
ImplicitVR = false;
- DictEntry = in;
- SetKey( in->GetKey( ) );
+ DicomDict = 0;
Offset = 0 ; // To avoid further missprinting
+
+ // init some variables
+ ReadLength = 0;
+ Length = 0;
+
+ VR = vr;
+ Key.SetGroupElem(group,elem);
}
-//-----------------------------------------------------------------------------
-// Print
/**
- * \ingroup gdcmDocEntry
- * \brief Prints the common part of gdcmValEntry, gdcmBinEntry, gdcmSeqEntry
- * @param os ostream we want to print in
+ * \brief Destructor from a given DictEntry
*/
-void gdcmDocEntry::Print(std::ostream& os)
+DocEntry::~DocEntry()
{
- PrintLevel = 2; // FIXME
-
- size_t o;
- unsigned short int g, e;
- char st[20],st2[10];
- TSKey v;
- std::string d2, vr;
- std::ostringstream s;
- uint32_t lgth;
-
- g = GetGroup();
- e = GetElement();
- o = GetOffset();
- vr = GetVR();
-
- sprintf(st2,"%04x|%04x", GetGroup(),GetElement());
- s << st2;
- if (PrintLevel >= 2)
+ if (DicomDict)
{
- s << " lg : ";
- lgth = GetReadLength(); // ReadLength, as opposed to UsableLength
- if (lgth == 0xffffffff)
- {
- sprintf(st,"x(ffff)"); // I said : "x(ffff)" !
- s.setf(std::ios::left);
- s << std::setw(10-strlen(st)) << " ";
- s << st << " ";
- s.setf(std::ios::left);
- s << std::setw(8) << "-1";
- }
- else
- {
- sprintf(st,"x(%x)",lgth);
- s.setf(std::ios::left);
- s << std::setw(10-strlen(st)) << " ";
- s << st << " ";
- s.setf(std::ios::left);
- s << std::setw(8) << lgth;
- }
- s << " Off.: ";
- sprintf(st,"x(%x)",o);
- s << std::setw(10-strlen(st)) << " ";
- s << st << " ";
- s << std::setw(8) << o;
- }
-
- s << "[" << vr << "] ";
-
- if (PrintLevel >= 1)
- {
- s.setf(std::ios::left);
- s << std::setw(66-GetName().length()) << " ";
+ gdcmAssertMacro(DicomDict);
+ DicomDict->Unregister();
}
-
- s << "[" << GetName()<< "]";
- os << s.str();
}
+//-----------------------------------------------------------------------------
+// Public
/**
- * \ingroup gdcmDocEntry
- * \brief Writes the common part of any gdcmValEntry, gdcmBinEntry, gdcmSeqEntry
- * @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, ...)
*/
-void gdcmDocEntry::Write(FILE* fp, FileType filetype)
+void DocEntry::WriteContent(std::ofstream *fp, FileType filetype)
{
- uint32_t FFFF = 0xffffffff;
+ uint32_t ffff = 0xffffffff;
uint16_t group = GetGroup();
- gdcmVRKey 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:
return;
}
-//
-// ----------- Writes the common part
-//
- fwrite ( &group,(size_t)2 ,(size_t)1 ,fp); //group
- fwrite ( &el, (size_t)2 ,(size_t)1 ,fp); //element
-
- if ( filetype == gdcmExplicitVR )
+ //
+ // ----------- Writes the common part
+ //
+ // 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
+
+ // Dicom V3 group 0x0002 is *always* Explicit VR !
+ if ( filetype == ExplicitVR || filetype == JPEG || filetype == JPEG2000 || group == 0x0002 )
{
+// ----------- 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)
+ // We shall force the end of a given SeqItem by writting
+ // a Item Delimitation Item (fffe, e00d)
- // TODO : verify if the Sequence Delimitor Item was forced during Parsing
-
- int ff = 0xffffffff;
- fwrite (&ff,(size_t)4 ,(size_t)1 ,fp);
+ 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 == "unkn")
+ if( IsVRUnknown() )
{
- // Unknown was 'written'
- // deal with Little Endian
- fwrite ( &shortLgr,(size_t)2 ,(size_t)1 ,fp);
- fwrite ( &z, (size_t)2 ,(size_t)1 ,fp);
+ // GDCM_VRUNKNOWN was stored in the Entry VR;
+ // deal with Entry as if TS were Implicit VR
+ binary_write(*fp, lgth);
}
else
{
- fwrite (vr.c_str(),(size_t)2 ,(size_t)1 ,fp);
-
- if ( (vr == "OB") || (vr == "OW") || (vr == "SQ") || (vr == "UN") )
+ 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") )
{
- fwrite ( &z, (size_t)2 ,(size_t)1 ,fp);
- if (vr == "SQ")
+ binary_write(*fp, zero);
+ if ( (filetype == JPEG || filetype == JPEG2000) && group == 0x7fe0 && elem == 0x0010)
+ {
+ gdcmAssertMacro( GetVR() == "OW" );
+ binary_write(*fp, ffff);
+ }
+ else if (vr == "SQ")
{
// we set SQ length to ffffffff
// and we shall write a Sequence Delimitor Item
// at the end of the Sequence!
- fwrite ( &FFFF,(size_t)4 ,(size_t)1 ,fp);
+ binary_write(*fp, ffff);
}
else
{
- fwrite ( &lgr,(size_t)4 ,(size_t)1 ,fp);
+ binary_write(*fp, lgth);
}
}
else
{
- fwrite ( &shortLgr,(size_t)2 ,(size_t)1 ,fp);
+ binary_write(*fp, shortLgr);
}
}
}
else // IMPLICIT VR
{
+// ----------- Writes the common part : the VR
if (vr == "SQ")
{
- fwrite ( &FFFF,(size_t)4 ,(size_t)1 ,fp);
+ binary_write(*fp, ffff);
}
else
{
- fwrite ( &lgr,(size_t)4 ,(size_t)1 ,fp);
+ 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 gdcmDocEntry
- * \brief Gets the full length of the elementary DocEntry (not only value length)
+ * \brief Gets the full length of the elementary DocEntry (not only value
+ * length) depending on the VR.
*/
-uint32_t gdcmDocEntry::GetFullLength()
+uint32_t DocEntry::GetFullLength()
{
uint32_t l = GetReadLength();
if ( IsImplicitVR() )
}
/**
- * \ingroup gdcmDocEntry
- * \brief Copies all the attributes from an other DocEntry
+ * \brief tells us if entry is the last one of a 'no length' SequenceItem
+ * (fffe,e00d)
*/
-void gdcmDocEntry::Copy (gdcmDocEntry* e)
+bool DocEntry::IsItemDelimitor()
{
- DictEntry = e->DictEntry;
- UsableLength = e->UsableLength;
- ReadLength = e->ReadLength;
- ImplicitVR = e->ImplicitVR;
- Offset = e->Offset;
- PrintLevel = e->PrintLevel;
- // TODO : remove gdcmDocEntry SQDepth
+ return (GetGroup() == 0xfffe && GetElement() == 0xe00d);
}
/**
- * \ingroup gdcmDocEntry
- * \brief tells us if entry is the last one of a 'no length' SequenceItem
- * (fffe,e00d)
+ * \brief tells us if entry is the first one of an Item
+ * (fffe,e000)
*/
-bool gdcmDocEntry::IsItemDelimitor()
+bool DocEntry::IsItemStarter()
{
- return (GetGroup() == 0xfffe && GetElement() == 0xe00d);
+ return (GetGroup() == 0xfffe && GetElement() == 0xe000);
}
+
/**
- * \ingroup gdcmDocEntry
* \brief tells us if entry is the last one of a 'no length' Sequence
* (fffe,e0dd)
*/
-bool gdcmDocEntry::IsSequenceDelimitor()
+bool DocEntry::IsSequenceDelimitor()
{
return (GetGroup() == 0xfffe && GetElement() == 0xe0dd);
}
+/**
+ * \brief Copies all the attributes from an other DocEntry
+ * @param doc entry to copy from
+ */
+void DocEntry::Copy(DocEntry *doc)
+{
+ 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;
+ if ( GetElement() == 0x0000 )
+ name = "Group Length";
+ else
+ name = GetName();
+
+ if (PrintLevel >= 1)
+ {
+ s.setf(std::ios::left);
+ s << std::setw(66-name.length()) << " ";
+ }
+
+ s << "[" << name << "]";
+ os << s.str();
+}
+
+//-----------------------------------------------------------------------------
+} // end namespace gdcm