X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmHeader.cxx;h=d9e26448923776f6773671057bd477c546380af6;hb=f5d6e67978dff569e38c19df24f14aea254ecd7b;hp=37b2e1ecbb4b57c88f20e7555ac2def7829a1263;hpb=b6c826571b5f85de9256b0973df29e916c40d243;p=gdcm.git diff --git a/src/gdcmHeader.cxx b/src/gdcmHeader.cxx index 37b2e1ec..d9e26448 100644 --- a/src/gdcmHeader.cxx +++ b/src/gdcmHeader.cxx @@ -1,4 +1,6 @@ -// gdcmHeader.cxx +// $Header: /cvs/public/gdcm/src/Attic/gdcmHeader.cxx,v 1.104 2003/10/30 17:04:21 jpr Exp $ + +#include "gdcmHeader.h" #include #include @@ -11,82 +13,152 @@ #include // for isalpha #include #include "gdcmUtil.h" -#include "gdcmHeader.h" - -#include +#include "gdcmTS.h" // Refer to gdcmHeader::CheckSwap() #define HEADER_LENGTH_TO_READ 256 // Refer to gdcmHeader::SetMaxSizeLoadElementValue() -#define _MaxSizeLoadElementValue_ 1024 - -VRHT * gdcmHeader::dicom_vr = (VRHT*)0; - +//#define _MaxSizeLoadElementValue_ 1024 +#define _MaxSizeLoadElementValue_ 4096 +/** + * \ingroup gdcmHeader + * \brief + */ void gdcmHeader::Initialise(void) { - if (!gdcmHeader::dicom_vr) - InitVRDict(); - Dicts = new gdcmDictSet(); + dicom_vr = gdcmGlobal::GetVR(); + dicom_ts = gdcmGlobal::GetTS(); + Dicts = gdcmGlobal::GetDicts(); RefPubDict = Dicts->GetDefaultPubDict(); RefShaDict = (gdcmDict*)0; } -gdcmHeader::gdcmHeader(const char *InFilename, bool exception_on_error) - throw(gdcmFileError) { +/** + * \ingroup gdcmHeader + * \brief + * @param InFilename + * @param exception_on_error + */ +gdcmHeader::gdcmHeader(const char *InFilename, bool exception_on_error) { + SetMaxSizeLoadElementValue(_MaxSizeLoadElementValue_); + filename = InFilename; + Initialise(); + if ( !OpenFile(exception_on_error)) + return; + ParseHeader(); + LoadElements(); + CloseFile(); +} + +/** + * \ingroup gdcmHeader + * \brief + * @param exception_on_error + */ +gdcmHeader::gdcmHeader(bool exception_on_error) { SetMaxSizeLoadElementValue(_MaxSizeLoadElementValue_); - filename = InFilename; Initialise(); - fp=fopen(InFilename,"rb"); +} + +/** + * \ingroup gdcmHeader + * \brief + * @param exception_on_error + * @return + */ + bool gdcmHeader::OpenFile(bool exception_on_error) + throw(gdcmFileError) { + fp=fopen(filename.c_str(),"rb"); if(exception_on_error) { if(!fp) throw gdcmFileError("gdcmHeader::gdcmHeader(const char *, bool)"); } - else - dbg.Error(!fp, "gdcmHeader::gdcmHeader cannot open file", InFilename); - ParseHeader(); - AddAndDefaultElements(); + + if ( fp ) { + guint16 zero; + fread(&zero, (size_t)2, (size_t)1, fp); + + //ACR -- or DICOM with no Preamble + if( zero == 0x0008 || zero == 0x0800 || zero == 0x0002 || zero == 0x0200) + return true; + //DICOM + fseek(fp, 126L, SEEK_CUR); + char dicm[4]; + fread(dicm, (size_t)4, (size_t)1, fp); + if( memcmp(dicm, "DICM", 4) == 0 ) + return true; + fclose(fp); + dbg.Verbose(0, "gdcmHeader::gdcmHeader not DICOM/ACR", filename.c_str()); + } + else { + dbg.Verbose(0, "gdcmHeader::gdcmHeader cannot open file", filename.c_str()); + } + return false; } +/** + * \ingroup gdcmHeader + * \brief + * @return TRUE if the close was successfull + */ +bool gdcmHeader::CloseFile(void) { + int closed = fclose(fp); + fp = (FILE *)0; + if (! closed) + return false; + return true; +} +/** + * \ingroup gdcmHeader + * \brief Canonical destructor. + */ gdcmHeader::~gdcmHeader (void) { - //FIXME obviously there is much to be done here ! - fclose(fp); - return; + dicom_vr = (gdcmVR*)0; + Dicts = (gdcmDictSet*)0; + RefPubDict = (gdcmDict*)0; + RefShaDict = (gdcmDict*)0; + return; } -void gdcmHeader::InitVRDict (void) { - if (dicom_vr) { - dbg.Verbose(0, "gdcmHeader::InitVRDict:", "VR dictionary allready set"); - return; - } - VRHT *vr = new VRHT; - (*vr)["AE"] = "Application Entity"; // At most 16 bytes - (*vr)["AS"] = "Age String"; // Exactly 4 bytes - (*vr)["AT"] = "Attribute Tag"; // 2 16-bit unsigned short integers - (*vr)["CS"] = "Code String"; // At most 16 bytes - (*vr)["DA"] = "Date"; // Exactly 8 bytes - (*vr)["DS"] = "Decimal String"; // At most 16 bytes - (*vr)["DT"] = "Date Time"; // At most 26 bytes - (*vr)["FL"] = "Floating Point Single"; // 32-bit IEEE 754:1985 float - (*vr)["FD"] = "Floating Point Double"; // 64-bit IEEE 754:1985 double - (*vr)["IS"] = "Integer String"; // At most 12 bytes - (*vr)["LO"] = "Long String"; // At most 64 chars - (*vr)["LT"] = "Long Text"; // At most 10240 chars - (*vr)["OB"] = "Other Byte String"; // String of bytes (vr independant) - (*vr)["OW"] = "Other Word String"; // String of 16-bit words (vr dep) - (*vr)["PN"] = "Person Name"; // At most 64 chars - (*vr)["SH"] = "Short String"; // At most 16 chars - (*vr)["SL"] = "Signed Long"; // Exactly 4 bytes - (*vr)["SQ"] = "Sequence of Items"; // Not Applicable - (*vr)["SS"] = "Signed Short"; // Exactly 2 bytes - (*vr)["ST"] = "Short Text"; // At most 1024 chars - (*vr)["TM"] = "Time"; // At most 16 bytes - (*vr)["UI"] = "Unique Identifier"; // At most 64 bytes - (*vr)["UL"] = "Unsigned Long "; // Exactly 4 bytes - (*vr)["UN"] = "Unknown"; // Any length of bytes - (*vr)["US"] = "Unsigned Short "; // Exactly 2 bytes - (*vr)["UT"] = "Unlimited Text"; // At most 2^32 -1 chars - dicom_vr = vr; -} +// Fourth semantics: +// +// ---> Warning : This fourth field is NOT part +// of the 'official' Dicom Dictionnary +// and should NOT be used. +// (Not defined for all the groups +// may be removed in a future release) +// +// CMD Command +// META Meta Information +// DIR Directory +// ID +// PAT Patient +// ACQ Acquisition +// REL Related +// IMG Image +// SDY Study +// VIS Visit +// WAV Waveform +// PRC +// DEV Device +// NMI Nuclear Medicine +// MED +// BFS Basic Film Session +// BFB Basic Film Box +// BIB Basic Image Box +// BAB +// IOB +// PJ +// PRINTER +// RT Radio Therapy +// DVH +// SSET +// RES Results +// CRV Curve +// OLY Overlays +// PXL Pixels +// DL Delimiters +// /** * \ingroup gdcmHeader @@ -101,7 +173,7 @@ void gdcmHeader::CheckSwap() // 0x00000004. Finding the swap code in then straigthforward. Trouble // occurs when we can't find such group... guint32 s; - guint32 x=4; // x : pour ntohs + guint32 x=4; // x : for ntohs bool net2host; // true when HostByteOrder is the same as NetworkByteOrder int lgrLue; @@ -121,14 +193,7 @@ void gdcmHeader::CheckSwap() entCur = deb + 128; if(memcmp(entCur, "DICM", (size_t)4) == 0) { - filetype = TrueDicom; dbg.Verbose(1, "gdcmHeader::CheckSwap:", "looks like DICOM Version3"); - } else { - filetype = Unknown; - dbg.Verbose(1, "gdcmHeader::CheckSwap:", "not a DICOM Version3 file"); - } - - if(filetype == TrueDicom) { // Next, determine the value representation (VR). Let's skip to the // first element (0002, 0000) and check there if we find "UL" // - or "OB" if the 1st one is (0002,0001) -, @@ -145,9 +210,13 @@ void gdcmHeader::CheckSwap() // * the 4 bytes of the first tag (0002, 0000),or (0002, 0001) // i.e. a total of 136 bytes. entCur = deb + 136; + // FIXME + // Use gdcmHeader::dicom_vr to test all the possibilities + // instead of just checking for UL, OB and UI !? if( (memcmp(entCur, "UL", (size_t)2) == 0) || - (memcmp(entCur, "OB", (size_t)2) == 0) ) - { + (memcmp(entCur, "OB", (size_t)2) == 0) || + (memcmp(entCur, "UI", (size_t)2) == 0) ) + { filetype = ExplicitVR; dbg.Verbose(1, "gdcmHeader::CheckSwap:", "explicit Value Representation"); @@ -156,7 +225,6 @@ void gdcmHeader::CheckSwap() dbg.Verbose(1, "gdcmHeader::CheckSwap:", "not an explicit Value Representation"); } - if (net2host) { sw = 4321; dbg.Verbose(1, "gdcmHeader::CheckSwap:", @@ -172,11 +240,12 @@ void gdcmHeader::CheckSwap() rewind(fp); fseek (fp, 132L, SEEK_SET); return; - } // End of TrueDicom + } // End of DicomV3 // Alas, this is not a DicomV3 file and whatever happens there is no file // preamble. We can reset the file position indicator to where the data // is (i.e. the beginning of the file). + dbg.Verbose(1, "gdcmHeader::CheckSwap:", "not a DICOM Version3 file"); rewind(fp); // Our next best chance would be to be considering a 'clean' ACR/NEMA file. @@ -216,6 +285,7 @@ void gdcmHeader::CheckSwap() // It is time for despaired wild guesses. So, let's assume this file // happens to be 'dirty' ACR/NEMA, i.e. the length of the group is // not present. Then the only info we have is the net2host one. + filetype = Unknown; if (! net2host ) sw = 0; else @@ -223,6 +293,10 @@ void gdcmHeader::CheckSwap() return; } +/** + * \ingroup gdcmHeader + * \brief + */ void gdcmHeader::SwitchSwapToBigEndian(void) { dbg.Verbose(1, "gdcmHeader::SwitchSwapToBigEndian", "Switching to BigEndian mode."); @@ -242,30 +316,20 @@ void gdcmHeader::SwitchSwapToBigEndian(void) { sw = 3412; } -void gdcmHeader::GetPixels(size_t lgrTotale, void* _Pixels) { - size_t pixelsOffset; - pixelsOffset = GetPixelOffset(); - fseek(fp, pixelsOffset, SEEK_SET); - if (IsJPEGLossless()) { - _Pixels=_IdDcmJpegRead(fp); - } else { - fread(_Pixels, 1, lgrTotale, fp); - } -} - - - /** * \ingroup gdcmHeader * \brief Find the value representation of the current tag. + * @param ElVal */ -void gdcmHeader::FindVR( ElValue *ElVal) { +void gdcmHeader::FindVR( gdcmElValue *ElVal) { if (filetype != ExplicitVR) return; char VR[3]; - string vr; + std::string vr; int lgrLue; + char msg[100]; // for sprintf. Sorry + long PositionOnEntry = ftell(fp); // Warning: we believe this is explicit VR (Value Representation) because // we used a heuristic that found "UL" in the first tag. Alas this @@ -278,7 +342,7 @@ void gdcmHeader::FindVR( ElValue *ElVal) { lgrLue=fread (&VR, (size_t)2,(size_t)1, fp); VR[2]=0; - vr = string(VR); + vr = std::string(VR); // Assume we are reading a falsely explicit VR file i.e. we reached // a tag where we expect reading a VR but are in fact we read the @@ -294,7 +358,7 @@ void gdcmHeader::FindVR( ElValue *ElVal) { // CLEANME searching the dicom_vr at each occurence is expensive. // PostPone this test in an optional integrity check at the end // of parsing or only in debug mode. - if ( RealExplicit && !dicom_vr->count(vr) ) + if ( RealExplicit && !dicom_vr->Count(vr) ) RealExplicit= false; if ( RealExplicit ) { @@ -322,8 +386,12 @@ void gdcmHeader::FindVR( ElValue *ElVal) { } // We thought this was explicit VR, but we end up with an - // implicit VR tag. Let's backtrack. - dbg.Verbose(1, "gdcmHeader::FindVR:", "Falsely explicit vr file"); + // implicit VR tag. Let's backtrack. + + sprintf(msg,"Falsely explicit vr file (%04x,%04x)\n", + ElVal->GetGroup(),ElVal->GetElement()); + dbg.Verbose(1, "gdcmHeader::FindVR: ",msg); + fseek(fp, PositionOnEntry, SEEK_SET); // When this element is known in the dictionary we shall use, e.g. for // the semantics (see the usage of IsAnInteger), the vr proposed by the @@ -337,17 +405,17 @@ void gdcmHeader::FindVR( ElValue *ElVal) { /** * \ingroup gdcmHeader - * \brief Determines if the Transfer Syntax was allready encountered + * \brief Determines if the Transfer Syntax was already encountered * and if it corresponds to a ImplicitVRLittleEndian one. * * @return True when ImplicitVRLittleEndian found. False in all other cases. */ bool gdcmHeader::IsImplicitVRLittleEndianTransferSyntax(void) { - ElValue* Element = PubElVals.GetElementByNumber(0x0002, 0x0010); + gdcmElValue* Element = PubElValSet.GetElementByNumber(0x0002, 0x0010); if ( !Element ) return false; LoadElementValueSafe(Element); - string Transfer = Element->GetValue(); + std::string Transfer = Element->GetValue(); if ( Transfer == "1.2.840.10008.1.2" ) return true; return false; @@ -355,17 +423,17 @@ bool gdcmHeader::IsImplicitVRLittleEndianTransferSyntax(void) { /** * \ingroup gdcmHeader - * \brief Determines if the Transfer Syntax was allready encountered + * \brief Determines if the Transfer Syntax was already encountered * and if it corresponds to a ExplicitVRLittleEndian one. * * @return True when ExplicitVRLittleEndian found. False in all other cases. */ bool gdcmHeader::IsExplicitVRLittleEndianTransferSyntax(void) { - ElValue* Element = PubElVals.GetElementByNumber(0x0002, 0x0010); + gdcmElValue* Element = PubElValSet.GetElementByNumber(0x0002, 0x0010); if ( !Element ) return false; LoadElementValueSafe(Element); - string Transfer = Element->GetValue(); + std::string Transfer = Element->GetValue(); if ( Transfer == "1.2.840.10008.1.2.1" ) return true; return false; @@ -373,17 +441,17 @@ bool gdcmHeader::IsExplicitVRLittleEndianTransferSyntax(void) { /** * \ingroup gdcmHeader - * \brief Determines if the Transfer Syntax was allready encountered + * \brief Determines if the Transfer Syntax was already encountered * and if it corresponds to a DeflatedExplicitVRLittleEndian one. * * @return True when DeflatedExplicitVRLittleEndian found. False in all other cases. */ bool gdcmHeader::IsDeflatedExplicitVRLittleEndianTransferSyntax(void) { - ElValue* Element = PubElVals.GetElementByNumber(0x0002, 0x0010); + gdcmElValue* Element = PubElValSet.GetElementByNumber(0x0002, 0x0010); if ( !Element ) return false; LoadElementValueSafe(Element); - string Transfer = Element->GetValue(); + std::string Transfer = Element->GetValue(); if ( Transfer == "1.2.840.10008.1.2.1.99" ) return true; return false; @@ -391,17 +459,17 @@ bool gdcmHeader::IsDeflatedExplicitVRLittleEndianTransferSyntax(void) { /** * \ingroup gdcmHeader - * \brief Determines if the Transfer Syntax was allready encountered + * \brief Determines if the Transfer Syntax was already encountered * and if it corresponds to a Explicit VR Big Endian one. * * @return True when big endian found. False in all other cases. */ bool gdcmHeader::IsExplicitVRBigEndianTransferSyntax(void) { - ElValue* Element = PubElVals.GetElementByNumber(0x0002, 0x0010); + gdcmElValue* Element = PubElValSet.GetElementByNumber(0x0002, 0x0010); if ( !Element ) return false; LoadElementValueSafe(Element); - string Transfer = Element->GetValue(); + std::string Transfer = Element->GetValue(); if ( Transfer == "1.2.840.10008.1.2.2" ) //1.2.2 ??? A verifier ! return true; return false; @@ -409,49 +477,56 @@ bool gdcmHeader::IsExplicitVRBigEndianTransferSyntax(void) { /** * \ingroup gdcmHeader - * \brief Determines if the Transfer Syntax was allready encountered + * \brief Determines if the Transfer Syntax was already encountered * and if it corresponds to a JPEGBaseLineProcess1 one. * * @return True when JPEGBaseLineProcess1found. False in all other cases. */ bool gdcmHeader::IsJPEGBaseLineProcess1TransferSyntax(void) { - ElValue* Element = PubElVals.GetElementByNumber(0x0002, 0x0010); + gdcmElValue* Element = PubElValSet.GetElementByNumber(0x0002, 0x0010); if ( !Element ) return false; LoadElementValueSafe(Element); - string Transfer = Element->GetValue(); + std::string Transfer = Element->GetValue(); if ( Transfer == "1.2.840.10008.1.2.4.50" ) return true; return false; } -// faire qq chose d'intelligent a la place de ça - +/** + * \ingroup gdcmHeader + * \brief + * + * @return + */ bool gdcmHeader::IsJPEGLossless(void) { - ElValue* Element = PubElVals.GetElementByNumber(0x0002, 0x0010); + gdcmElValue* Element = PubElValSet.GetElementByNumber(0x0002, 0x0010); + // faire qq chose d'intelligent a la place de ça if ( !Element ) return false; LoadElementValueSafe(Element); const char * Transfert = Element->GetValue().c_str(); if ( memcmp(Transfert+strlen(Transfert)-2 ,"70",2)==0) return true; if ( memcmp(Transfert+strlen(Transfert)-2 ,"55",2)==0) return true; + if (Element->GetValue() == "1.2.840.10008.1.2.4.57") return true; + return false; } /** * \ingroup gdcmHeader - * \brief Determines if the Transfer Syntax was allready encountered + * \brief Determines if the Transfer Syntax was already encountered * and if it corresponds to a JPEGExtendedProcess2-4 one. * * @return True when JPEGExtendedProcess2-4 found. False in all other cases. */ bool gdcmHeader::IsJPEGExtendedProcess2_4TransferSyntax(void) { - ElValue* Element = PubElVals.GetElementByNumber(0x0002, 0x0010); + gdcmElValue* Element = PubElValSet.GetElementByNumber(0x0002, 0x0010); if ( !Element ) return false; LoadElementValueSafe(Element); - string Transfer = Element->GetValue(); + std::string Transfer = Element->GetValue(); if ( Transfer == "1.2.840.10008.1.2.4.51" ) return true; return false; @@ -459,17 +534,17 @@ bool gdcmHeader::IsJPEGExtendedProcess2_4TransferSyntax(void) { /** * \ingroup gdcmHeader - * \brief Determines if the Transfer Syntax was allready encountered + * \brief Determines if the Transfer Syntax was already encountered * and if it corresponds to a JPEGExtendeProcess3-5 one. * * @return True when JPEGExtendedProcess3-5 found. False in all other cases. */ bool gdcmHeader::IsJPEGExtendedProcess3_5TransferSyntax(void) { - ElValue* Element = PubElVals.GetElementByNumber(0x0002, 0x0010); + gdcmElValue* Element = PubElValSet.GetElementByNumber(0x0002, 0x0010); if ( !Element ) return false; LoadElementValueSafe(Element); - string Transfer = Element->GetValue(); + std::string Transfer = Element->GetValue(); if ( Transfer == "1.2.840.10008.1.2.4.52" ) return true; return false; @@ -477,36 +552,111 @@ bool gdcmHeader::IsJPEGExtendedProcess3_5TransferSyntax(void) { /** * \ingroup gdcmHeader - * \brief Determines if the Transfer Syntax was allready encountered + * \brief Determines if the Transfer Syntax was already encountered * and if it corresponds to a JPEGSpectralSelectionProcess6-8 one. * * @return True when JPEGSpectralSelectionProcess6-8 found. False in all * other cases. */ bool gdcmHeader::IsJPEGSpectralSelectionProcess6_8TransferSyntax(void) { - ElValue* Element = PubElVals.GetElementByNumber(0x0002, 0x0010); + gdcmElValue* Element = PubElValSet.GetElementByNumber(0x0002, 0x0010); if ( !Element ) return false; LoadElementValueSafe(Element); - string Transfer = Element->GetValue(); + std::string Transfer = Element->GetValue(); if ( Transfer == "1.2.840.10008.1.2.4.53" ) return true; return false; } +/** + * \ingroup gdcmHeader + * \brief Determines if the Transfer Syntax was already encountered + * and if it corresponds to a RLE Lossless one. + * + * @return True when RLE Lossless found. False in all + * other cases. + */ +bool gdcmHeader::IsRLELossLessTransferSyntax(void) { + gdcmElValue* Element = PubElValSet.GetElementByNumber(0x0002, 0x0010); + if ( !Element ) + return false; + LoadElementValueSafe(Element); + std::string Transfer = Element->GetValue(); + if ( Transfer == "1.2.840.10008.1.2.5" ) + return true; + return false; +} + +/** + * \ingroup gdcmHeader + * \brief Determines if the Transfer Syntax was already encountered + * and if it corresponds to a JPEG200 one.0 + * + * @return True when JPEG2000 (Lossly or LossLess) found. False in all + * other cases. + */ +bool gdcmHeader::IsJPEG2000(void) { + gdcmElValue* Element = PubElValSet.GetElementByNumber(0x0002, 0x0010); + if ( !Element ) + return false; + LoadElementValueSafe(Element); + std::string Transfer = Element->GetValue(); + if ( (Transfer == "1.2.840.10008.1.2.4.90") + || (Transfer == "1.2.840.10008.1.2.4.91") ) + return true; + return false; +} + +/** + * \ingroup gdcmHeader + * \brief Predicate for dicom version 3 file. + * @return True when the file is a dicom version 3. + */ +bool gdcmHeader::IsDicomV3(void) { + if ( (filetype == ExplicitVR) + || (filetype == ImplicitVR) ) + return true; + return false; +} + /** * \ingroup gdcmHeader * \brief When the length of an element value is obviously wrong (because * the parser went Jabberwocky) one can hope improving things by * applying this heuristic. */ -void gdcmHeader::FixFoundLength(ElValue * ElVal, guint32 FoundLength) { +void gdcmHeader::FixFoundLength(gdcmElValue * ElVal, guint32 FoundLength) { if ( FoundLength == 0xffffffff) FoundLength = 0; + + // Sorry for the patch! + // XMedCom did the trick to read some nasty GE images ... + else if (FoundLength == 13) { + // The following 'if' will be removed when there is no more + // images on Creatis HDs with a 13 length for Manufacturer... + if ( (ElVal->GetGroup() != 0x0008) || (ElVal->GetElement() != 0x0070)) { + // end of remove area + FoundLength =10; + } + } + // to fix some garbage 'Leonardo' Siemens images + // May be commented out to avoid overhead + else if ( (ElVal->GetGroup() == 0x0009) + && + ( (ElVal->GetElement() == 0x1113) || (ElVal->GetElement() == 0x1114) ) ) + FoundLength =4; + ElVal->SetLength(FoundLength); } -guint32 gdcmHeader::FindLengthOB(void) { +/** + * \ingroup gdcmHeader + * \brief + * + * @return + */ + guint32 gdcmHeader::FindLengthOB(void) { // See PS 3.5-2001, section A.4 p. 49 on encapsulation of encoded pixel data. guint16 g; guint16 n; @@ -517,51 +667,69 @@ guint32 gdcmHeader::FindLengthOB(void) { while ( ! FoundSequenceDelimiter) { g = ReadInt16(); - n = ReadInt16(); + n = ReadInt16(); if (errno == 1) return 0; TotalLength += 4; // We even have to decount the group and element - if ( g != 0xfffe ) { - dbg.Verbose(1, "gdcmHeader::FindLengthOB: ", - "wrong group for an item sequence."); + + if ( g != 0xfffe && g!=0xb00c ) /*for bogus header */ { + char msg[100]; // for sprintf. Sorry + sprintf(msg,"wrong group (%04x) for an item sequence (%04x,%04x)\n",g, g,n); + dbg.Verbose(1, "gdcmHeader::FindLengthOB: ",msg); errno = 1; return 0; } - if ( n == 0xe0dd ) + if ( n == 0xe0dd || ( g==0xb00c && n==0x0eb6 ) ) /* for bogus header */ FoundSequenceDelimiter = true; - else if ( n != 0xe000) { - dbg.Verbose(1, "gdcmHeader::FindLengthOB: ", - "wrong element for an item sequence."); + else if ( n != 0xe000 ){ + char msg[100]; // for sprintf. Sorry + sprintf(msg,"wrong element (%04x) for an item sequence (%04x,%04x)\n", + n, g,n); + dbg.Verbose(1, "gdcmHeader::FindLengthOB: ",msg); errno = 1; return 0; } ItemLength = ReadInt32(); TotalLength += ItemLength + 4; // We add 4 bytes since we just read - // the ItemLength with ReadInt32 + // the ItemLength with ReadInt32 SkipBytes(ItemLength); } fseek(fp, PositionOnEntry, SEEK_SET); return TotalLength; } -void gdcmHeader::FindLength(ElValue * ElVal) { +/** + * \ingroup gdcmHeader + * \brief + * + * @return + */ + void gdcmHeader::FindLength (gdcmElValue * ElVal) { guint16 element = ElVal->GetElement(); - string vr = ElVal->GetVR(); + guint16 group = ElVal->GetGroup(); + std::string vr = ElVal->GetVR(); guint16 length16; + if( (element == 0x0010) && (group == 0x7fe0) ) { + dbg.SetDebug(0); + dbg.Verbose(2, "gdcmHeader::FindLength: ", + "we reached 7fe0 0010"); + } if ( (filetype == ExplicitVR) && ! ElVal->IsImplicitVr() ) { - if ( (vr=="OB") || (vr=="OW") || (vr=="SQ") || (vr=="UN") ) { + // The following reserved two bytes (see PS 3.5-2001, section // 7.1.2 Data element structure with explicit vr p27) must be // skipped before proceeding on reading the length on 4 bytes. fseek(fp, 2L, SEEK_CUR); + guint32 length32 = ReadInt32(); + if ( (vr == "OB") && (length32 == 0xffffffff) ) { ElVal->SetLength(FindLengthOB()); return; } - FixFoundLength(ElVal, length32); + FixFoundLength(ElVal, length32); return; } @@ -590,12 +758,12 @@ void gdcmHeader::FindLength(ElValue * ElVal) { // We shall use this second strategy. In order to make sure that we // can interpret the presence of an apparently big endian encoded // length of a "Group Length" without committing a big mistake, we - // add an additional check: we look in the allready parsed elements + // add an additional check: we look in the already parsed elements // for the presence of a "Transfer Syntax" whose value has to be "big // endian encoding". When this is the case, chances are we have got our // hands on a big endian encoded file: we switch the swap code to // big endian and proceed... - if ( (element == 0x000) && (length16 == 0x0400) ) { + if ( (element == 0x0000) && (length16 == 0x0400) ) { if ( ! IsExplicitVRBigEndianTransferSyntax() ) { dbg.Verbose(0, "gdcmHeader::FindLength", "not explicit VR"); errno = 1; @@ -607,7 +775,8 @@ void gdcmHeader::FindLength(ElValue * ElVal) { // and the dictionary entry depending on them. guint16 CorrectGroup = SwapShort(ElVal->GetGroup()); guint16 CorrectElem = SwapShort(ElVal->GetElement()); - gdcmDictEntry * NewTag = GetDictEntryByKey(CorrectGroup, CorrectElem); + gdcmDictEntry * NewTag = GetDictEntryByNumber(CorrectGroup, + CorrectElem); if (!NewTag) { // This correct tag is not in the dictionary. Create a new one. NewTag = new gdcmDictEntry(CorrectGroup, CorrectElem); @@ -620,9 +789,12 @@ void gdcmHeader::FindLength(ElValue * ElVal) { // Heuristic: well some files are really ill-formed. if ( length16 == 0xffff) { length16 = 0; - dbg.Verbose(0, "gdcmHeader::FindLength", - "Erroneous element length fixed."); + //dbg.Verbose(0, "gdcmHeader::FindLength", + // "Erroneous element length fixed."); + // Actually, length= 0xffff means that we deal with + // Unknown Sequence Length } + FixFoundLength(ElVal, (guint32)length16); return; } @@ -640,11 +812,9 @@ void gdcmHeader::FindLength(ElValue * ElVal) { * \ingroup gdcmHeader * \brief Swaps back the bytes of 4-byte long integer accordingly to * processor order. - * - * @return The suggested integer. + * @return The properly swaped 32 bits integer. */ guint32 gdcmHeader::SwapLong(guint32 a) { - // FIXME: il pourrait y avoir un pb pour les entiers negatifs ... switch (sw) { case 0 : break; @@ -678,16 +848,34 @@ guint16 gdcmHeader::SwapShort(guint16 a) { return (a); } -void gdcmHeader::SkipBytes(guint32 NBytes) { +/** + * \ingroup gdcmHeader + * \brief + * + * @return + */ + void gdcmHeader::SkipBytes(guint32 NBytes) { //FIXME don't dump the returned value (void)fseek(fp, (long)NBytes, SEEK_CUR); } -void gdcmHeader::SkipElementValue(ElValue * ElVal) { +/** + * \ingroup gdcmHeader + * \brief + * @param ElVal + * @return + */ + void gdcmHeader::SkipElementValue(gdcmElValue * ElVal) { SkipBytes(ElVal->GetLength()); } -void gdcmHeader::SetMaxSizeLoadElementValue(long NewSize) { +/** + * \ingroup gdcmHeader + * \brief + * @param NewSize + * @return + */ + void gdcmHeader::SetMaxSizeLoadElementValue(long NewSize) { if (NewSize < 0) return; if ((guint32)NewSize >= (guint32)0xffffffff) { @@ -703,42 +891,35 @@ void gdcmHeader::SetMaxSizeLoadElementValue(long NewSize) { * than the value specified with * gdcmHeader::SetMaxSizeLoadElementValue() */ -void gdcmHeader::LoadElementValue(ElValue * ElVal) { +void gdcmHeader::LoadElementValue(gdcmElValue * ElVal) { size_t item_read; guint16 group = ElVal->GetGroup(); - guint16 elem = ElVal->GetElement(); - string vr = ElVal->GetVR(); + std::string vr= ElVal->GetVR(); guint32 length = ElVal->GetLength(); bool SkipLoad = false; fseek(fp, (long)ElVal->GetOffset(), SEEK_SET); - // Sequences not treated yet ! + // FIXME Sequences not treated yet ! // // Ne faudrait-il pas au contraire trouver immediatement // une maniere 'propre' de traiter les sequences (vr = SQ) // car commencer par les ignorer risque de conduire a qq chose // qui pourrait ne pas etre generalisable - // + // Well, I'm expecting your code !!! + if( vr == "SQ" ) SkipLoad = true; - // Heuristic : a sequence "contains" a set of tags (called items). It looks - // like the last tag of a sequence (the one that terminates the sequence) - // has a group of 0xfffe (with a dummy length). + // A sequence "contains" a set of Elements. + // (fffe e000) tells us an Element is beginning + // (fffe e00d) tells us an Element just ended + // (fffe e0dd) tells us the current SQuence just ended + if( group == 0xfffe ) SkipLoad = true; - // The group length doesn't represent data to be loaded in memory, since - // each element of the group shall be loaded individualy. - if( elem == 0 ) - //SkipLoad = true; // modif sauvage JPR - // On charge la longueur du groupe - // quand l'element 0x0000 est présent ! - if ( SkipLoad ) { - // FIXME the following skip is not necessary - SkipElementValue(ElVal); ElVal->SetLength(0); ElVal->SetValue("gdcm::Skipped"); return; @@ -754,7 +935,7 @@ void gdcmHeader::LoadElementValue(ElValue * ElVal) { // are not loaded. Instead we leave a short notice of the offset of // the element content and it's length. if (length > MaxSizeLoadElementValue) { - ostringstream s; + std::ostringstream s; s << "gdcm::NotLoaded."; s << " Address:" << (long)ElVal->GetOffset(); s << " Length:" << ElVal->GetLength(); @@ -766,66 +947,42 @@ void gdcmHeader::LoadElementValue(ElValue * ElVal) { // four bytes properly i.e. as an integer as opposed to a string. // pour les elements de Value Multiplicity > 1 - // on aura en fait une serie d'entiers - - // code original - - //if ( IsAnInteger(ElVal) ) { - // guint32 NewInt; - // if( length == 2 ) { - // NewInt = ReadInt16(); - // } else if( length == 4 ) { - // - // NewInt = ReadInt32(); - // } else - // dbg.Error(true, "LoadElementValue: Inconsistency when reading Int."); - // - // //FIXME: make the following an util fonction - // ostringstream s; - // s << NewInt; - // ElVal->SetValue(s.str()); - // return; - //} - - // modif proposee. JPR + // on aura en fait une serie d'entiers // on devrait pouvoir faire + compact (?) - if ( IsAnInteger(ElVal) ) { - guint32 NewInt; - ostringstream s; - int nbInt; - if (vr == "US" || vr == "SS") { - nbInt = length / 2; - NewInt = ReadInt16(); - s << NewInt; - if (nbInt > 1) { - for (int i=1; i < nbInt; i++) { - s << '\\'; - NewInt = ReadInt16(); - s << NewInt; - //printf("%s\n", s.str().c_str()); - } - } + if ( IsAnInteger(ElVal) ) { + guint32 NewInt; + std::ostringstream s; + int nbInt; + if (vr == "US" || vr == "SS") { + nbInt = length / 2; + NewInt = ReadInt16(); + s << NewInt; + if (nbInt > 1) { + for (int i=1; i < nbInt; i++) { + s << '\\'; + NewInt = ReadInt16(); + s << NewInt; + } + } - } else if (vr == "UL" || vr == "SL") { - nbInt = length / 4; - NewInt = ReadInt32(); - s << NewInt; - if (nbInt > 1) { - for (int i=1; i < nbInt; i++) { - s << '\\'; - NewInt = ReadInt32(); - s << NewInt; - } - } - } - ElVal->SetValue(s.str()); - return; - } - - + } else if (vr == "UL" || vr == "SL") { + nbInt = length / 4; + NewInt = ReadInt32(); + s << NewInt; + if (nbInt > 1) { + for (int i=1; i < nbInt; i++) { + s << '\\'; + NewInt = ReadInt32(); + s << NewInt; + } + } + } + ElVal->SetValue(s.str()); + return; + } - // FIXME The exact size should be length if we move to strings or whatever + // We need an additional byte for storing \0 that is not on disk char* NewValue = (char*)malloc(length+1); if( !NewValue) { dbg.Verbose(1, "LoadElementValue: Failed to allocate NewValue"); @@ -841,6 +998,7 @@ void gdcmHeader::LoadElementValue(ElValue * ElVal) { return; } ElVal->SetValue(NewValue); + free(NewValue); } /** @@ -851,41 +1009,79 @@ void gdcmHeader::LoadElementValue(ElValue * ElVal) { * @param ElVal Element whose value shall be loaded. * @return */ -void gdcmHeader::LoadElementValueSafe(ElValue * ElVal) { +void gdcmHeader::LoadElementValueSafe(gdcmElValue * ElVal) { long PositionOnEntry = ftell(fp); LoadElementValue(ElVal); fseek(fp, PositionOnEntry, SEEK_SET); } - +/** + * \ingroup gdcmHeader + * \brief Reads a supposed to be 16 Bits integer + * \ (swaps it depending on processor endianity) + * + * @return integer acts as a boolean + */ guint16 gdcmHeader::ReadInt16(void) { guint16 g; size_t item_read; item_read = fread (&g, (size_t)2,(size_t)1, fp); - errno = 0; if ( item_read != 1 ) { - dbg.Verbose(1, "gdcmHeader::ReadInt16", " File read error"); + // dbg.Verbose(0, "gdcmHeader::ReadInt16", " Failed to read :"); + // if(feof(fp)) + // dbg.Verbose(0, "gdcmHeader::ReadInt16", " End of File encountered"); + if(ferror(fp)) + dbg.Verbose(0, "gdcmHeader::ReadInt16", " File Error"); errno = 1; return 0; } + errno = 0; g = SwapShort(g); return g; } +/** + * \ingroup gdcmHeader + * \brief Reads a supposed to be 32 Bits integer + * \ (swaps it depending on processor endianity) + * + * @return + */ guint32 gdcmHeader::ReadInt32(void) { guint32 g; size_t item_read; item_read = fread (&g, (size_t)4,(size_t)1, fp); - errno = 0; - if ( item_read != 1 ) { - dbg.Verbose(1, "gdcmHeader::ReadInt32", " File read error"); + if ( item_read != 1 ) { + //dbg.Verbose(0, "gdcmHeader::ReadInt32", " Failed to read :"); + //if(feof(fp)) + // dbg.Verbose(0, "gdcmHeader::ReadInt32", " End of File encountered"); + if(ferror(fp)) + dbg.Verbose(0, "gdcmHeader::ReadInt32", " File Error"); errno = 1; return 0; } + errno = 0; g = SwapLong(g); return g; } +/** + * \ingroup gdcmHeader + * \brief + * + * @return + */ + gdcmElValue* gdcmHeader::GetElValueByNumber(guint16 Group, guint16 Elem) { + + gdcmElValue* elValue = PubElValSet.GetElementByNumber(Group, Elem); + if (!elValue) { + dbg.Verbose(1, "gdcmHeader::GetElValueByNumber", + "failed to Locate gdcmElValue"); + return (gdcmElValue*)0; + } + return elValue; +} + /** * \ingroup gdcmHeader * \brief Build a new Element Value from all the low level arguments. @@ -894,21 +1090,99 @@ guint32 gdcmHeader::ReadInt32(void) { * @param Group group of the underlying DictEntry * @param Elem element of the underlying DictEntry */ -ElValue* gdcmHeader::NewElValueByKey(guint16 Group, guint16 Elem) { +gdcmElValue* gdcmHeader::NewElValueByNumber(guint16 Group, guint16 Elem) { // Find out if the tag we encountered is in the dictionaries: - gdcmDictEntry * NewTag = GetDictEntryByKey(Group, Elem); + gdcmDictEntry * NewTag = GetDictEntryByNumber(Group, Elem); if (!NewTag) NewTag = new gdcmDictEntry(Group, Elem); - ElValue* NewElVal = new ElValue(NewTag); + gdcmElValue* NewElVal = new gdcmElValue(NewTag); if (!NewElVal) { - dbg.Verbose(1, "gdcmHeader::NewElValueByKey", - "failed to allocate ElValue"); - return (ElValue*)0; + dbg.Verbose(1, "gdcmHeader::NewElValueByNumber", + "failed to allocate gdcmElValue"); + return (gdcmElValue*)0; } return NewElVal; } +/** + * \ingroup gdcmHeader + * \brief TODO + * @param Value + * @param Group + * @param Elem + * \return integer acts as a boolean + */ +int gdcmHeader::ReplaceOrCreateByNumber(std::string Value, + guint16 Group, guint16 Elem ) { + + // TODO : FIXME JPRx + // curieux, non ? + // on (je) cree une Elvalue ne contenant pas de valeur + // on l'ajoute au ElValSet + // on affecte une valeur a cette ElValue a l'interieur du ElValSet + // --> devrait pouvoir etre fait + simplement ??? + if (CheckIfExistByNumber(Group, Elem) == 0) { + gdcmElValue* a =NewElValueByNumber(Group, Elem); + if (a == NULL) + return 0; + PubElValSet.Add(a); + } + PubElValSet.SetElValueByNumber(Value, Group, Elem); + return(1); +} + + +/** + * \ingroup gdcmHeader + * \brief Modify (or Creates if not found) an element + * @param Value new value + * @param Group + * @param Elem + * \return integer acts as a boolean + * + */ +int gdcmHeader::ReplaceOrCreateByNumber(char* Value, guint16 Group, guint16 Elem ) { + + gdcmElValue* nvElValue=NewElValueByNumber(Group, Elem); + PubElValSet.Add(nvElValue); + std::string v = Value; + PubElValSet.SetElValueByNumber(v, Group, Elem); + return(1); +} + + +/** + * \ingroup gdcmHeader + * \brief Set a new value if the invoked element exists + * Seems to be useless !!! + * @param Value + * @param Group + * @param Elem + * \return integer acts as a boolean + */ +int gdcmHeader::ReplaceIfExistByNumber(char* Value, guint16 Group, guint16 Elem ) { + + //gdcmElValue* elValue = PubElValSet.GetElementByNumber(Group, Elem); + std::string v = Value; + PubElValSet.SetElValueByNumber(v, Group, Elem); + return 1; +} + + +/** + * \ingroup gdcmHeader + * \brief Checks if a given ElValue (group,number) + * \ exists in the Public ElValSet + * @param Group + * @param Elem + * @return integer acts as a boolean + */ + +int gdcmHeader::CheckIfExistByNumber(guint16 Group, guint16 Elem ) { + return (PubElValSet.CheckIfExistByNumber(Group, Elem)); + } + /** * \ingroup gdcmHeader * \brief Build a new Element Value from all the low level arguments. @@ -916,17 +1190,17 @@ ElValue* gdcmHeader::NewElValueByKey(guint16 Group, guint16 Elem) { * a default one when absent. * @param Name Name of the underlying DictEntry */ -ElValue* gdcmHeader::NewElValueByName(string Name) { +gdcmElValue* gdcmHeader::NewElValueByName(std::string Name) { gdcmDictEntry * NewTag = GetDictEntryByName(Name); if (!NewTag) NewTag = new gdcmDictEntry(0xffff, 0xffff, "LO", "Unknown", Name); - ElValue* NewElVal = new ElValue(NewTag); + gdcmElValue* NewElVal = new gdcmElValue(NewTag); if (!NewElVal) { dbg.Verbose(1, "gdcmHeader::ObtainElValueByName", - "failed to allocate ElValue"); - return (ElValue*)0; + "failed to allocate gdcmElValue"); + return (gdcmElValue*)0; } return NewElVal; } @@ -936,25 +1210,28 @@ ElValue* gdcmHeader::NewElValueByName(string Name) { * \brief Read the next tag but WITHOUT loading it's value * @return On succes the newly created ElValue, NULL on failure. */ -ElValue * gdcmHeader::ReadNextElement(void) { - guint16 g; - guint16 n; - ElValue * NewElVal; +gdcmElValue * gdcmHeader::ReadNextElement(void) { + + guint16 g,n; + gdcmElValue * NewElVal; g = ReadInt16(); n = ReadInt16(); + if (errno == 1) // We reached the EOF (or an error occured) and header parsing // has to be considered as finished. - return (ElValue *)0; + return (gdcmElValue *)0; - NewElVal = NewElValueByKey(g, n); + NewElVal = NewElValueByNumber(g, n); FindVR(NewElVal); FindLength(NewElVal); - if (errno == 1) + if (errno == 1) { // Call it quits - return (ElValue *)0; - NewElVal->SetOffset(ftell(fp)); + return (gdcmElValue *)0; + } + NewElVal->SetOffset(ftell(fp)); + //if ( (g==0x7fe0) && (n==0x0010) ) return NewElVal; } @@ -965,10 +1242,9 @@ ElValue * gdcmHeader::ReadNextElement(void) { * @param ElVal The element value on which to apply the predicate. * @return The result of the heuristical predicate. */ -bool gdcmHeader::IsAnInteger(ElValue * ElVal) { - guint16 group = ElVal->GetGroup(); +bool gdcmHeader::IsAnInteger(gdcmElValue * ElVal) { guint16 element = ElVal->GetElement(); - string vr = ElVal->GetVR(); + std::string vr = ElVal->GetVR(); guint32 length = ElVal->GetLength(); // When we have some semantics on the element we just read, and if we @@ -977,48 +1253,14 @@ bool gdcmHeader::IsAnInteger(ElValue * ElVal) { if ( element == 0 ) { // This is the group length of the group if (length == 4) return true; - else + else { dbg.Error("gdcmHeader::IsAnInteger", - "Erroneous Group Length element length."); + "Erroneous Group Length element length."); + } } - - /* - // on le traite tt de même (VR peut donner l'info) - // faire qq chose + ruse (pas de test si pas de VR) - if ( group % 2 != 0 ) - // We only have some semantics on documented elements, which are - // the even ones. - return false; - */ - - /* - if ( (length != 4) && ( length != 2) ) - // Swapping only make sense on integers which are 2 or 4 bytes long. - - // En fait, pour les entiers de 'Value Multiplicity' supérieur a 1 - // la longueur n'est pas forcement 2 ou 4 - // ET il faudra swapper. - return false; - */ - if ( (vr == "UL") || (vr == "US") || (vr == "SL") || (vr == "SS") ) return true; - - // est-ce encore utile? - // mieux vaut modifier le source du Dicom Dictionnaty - // et remplacer pour ces 2 cas RET par US - - if ( (group == 0x0028) && (element == 0x0005) ) - // The "Image Dimensions" tag is retained from ACR/NEMA and contains - // the number of dimensions of the contained object (1 for Signal, - // 2 for Image, 3 for Volume, 4 for Sequence). - return true; - - if ( (group == 0x0028) && (element == 0x0200) ) - // This tag is retained from ACR/NEMA - return true; - return false; } @@ -1033,28 +1275,63 @@ size_t gdcmHeader::GetPixelOffset(void) { // is found by indirection through the "Image Location"). // Inside the group pointed by "Image Location" the searched element // is conventionally the element 0x0010 (when the norm is respected). - // When the "Image Location" is absent we default to group 0x7fe0. + // When the "Image Location" is absent we default to group 0x7fe0. guint16 grPixel; guint16 numPixel; - string ImageLocation = GetPubElValByName("Image Location"); - if ( ImageLocation == "gdcm::Unfound" ) { + std::string ImageLocation = GetPubElValByName("Image Location"); + if ( ImageLocation == GDCM_UNFOUND ) { grPixel = 0x7fe0; } else { grPixel = (guint16) atoi( ImageLocation.c_str() ); } if (grPixel != 0x7fe0) - // FIXME is this still necessary ? - // Now, this looks like an old dirty fix for Philips imager + // This is a kludge for old dirty Philips imager. numPixel = 0x1010; else numPixel = 0x0010; - ElValue* PixelElement = PubElVals.GetElementByNumber(grPixel, numPixel); + + gdcmElValue* PixelElement = PubElValSet.GetElementByNumber(grPixel, + numPixel); if (PixelElement) return PixelElement->GetOffset(); else return 0; } +/** + * \ingroup gdcmHeader + * \brief Recover the pixel area length (in Bytes) . + */ +size_t gdcmHeader::GetPixelAreaLength(void) { + // If this file complies with the norm we should encounter the + // "Image Location" tag (0x0028, 0x0200). This tag contains the + // the group that contains the pixel data (hence the "Pixel Data" + // is found by indirection through the "Image Location"). + // Inside the group pointed by "Image Location" the searched element + // is conventionally the element 0x0010 (when the norm is respected). + // When the "Image Location" is absent we default to group 0x7fe0. + guint16 grPixel; + guint16 numPixel; + std::string ImageLocation = GetPubElValByName("Image Location"); + if ( ImageLocation == GDCM_UNFOUND ) { + grPixel = 0x7fe0; + } else { + grPixel = (guint16) atoi( ImageLocation.c_str() ); + } + if (grPixel != 0x7fe0) + // This is a kludge for old dirty Philips imager. + numPixel = 0x1010; + else + numPixel = 0x0010; + + gdcmElValue* PixelElement = PubElValSet.GetElementByNumber(grPixel, + numPixel); + if (PixelElement) + return PixelElement->GetLength(); + else + return 0; +} + /** * \ingroup gdcmHeader * \brief Searches both the public and the shadow dictionary (when they @@ -1065,19 +1342,20 @@ size_t gdcmHeader::GetPixelOffset(void) { * @param element element of the searched DictEntry * @return Corresponding DictEntry when it exists, NULL otherwise. */ -gdcmDictEntry * gdcmHeader::GetDictEntryByKey(guint16 group, guint16 element) { +gdcmDictEntry * gdcmHeader::GetDictEntryByNumber(guint16 group, + guint16 element) { gdcmDictEntry * found = (gdcmDictEntry*)0; if (!RefPubDict && !RefShaDict) { - dbg.Verbose(0, "FIXME in gdcmHeader::GetDictEntry", + dbg.Verbose(0, "gdcmHeader::GetDictEntry", "we SHOULD have a default dictionary"); } if (RefPubDict) { - found = RefPubDict->GetTagByKey(group, element); + found = RefPubDict->GetTagByNumber(group, element); if (found) return found; } if (RefShaDict) { - found = RefShaDict->GetTagByKey(group, element); + found = RefShaDict->GetTagByNumber(group, element); if (found) return found; } @@ -1092,10 +1370,10 @@ gdcmDictEntry * gdcmHeader::GetDictEntryByKey(guint16 group, guint16 element) { * @param Name name of the searched DictEntry * @return Corresponding DictEntry when it exists, NULL otherwise. */ -gdcmDictEntry * gdcmHeader::GetDictEntryByName(string Name) { +gdcmDictEntry * gdcmHeader::GetDictEntryByName(std::string Name) { gdcmDictEntry * found = (gdcmDictEntry*)0; if (!RefPubDict && !RefShaDict) { - dbg.Verbose(0, "FIXME in gdcmHeader::GetDictEntry", + dbg.Verbose(0, "gdcmHeader::GetDictEntry", "we SHOULD have a default dictionary"); } if (RefPubDict) { @@ -1118,10 +1396,10 @@ gdcmDictEntry * gdcmHeader::GetDictEntryByName(string Name) { * @param group Group of the researched tag. * @param element Element of the researched tag. * @return Corresponding element value when it exists, and the string - * "gdcm::Unfound" otherwise. + * GDCM_UNFOUND ("gdcm::Unfound") otherwise. */ -string gdcmHeader::GetPubElValByNumber(guint16 group, guint16 element) { - return PubElVals.GetElValueByNumber(group, element); +std::string gdcmHeader::GetPubElValByNumber(guint16 group, guint16 element) { + return PubElValSet.GetElValueByNumber(group, element); } /** @@ -1136,12 +1414,12 @@ string gdcmHeader::GetPubElValByNumber(guint16 group, guint16 element) { * @param group Group of the researched tag. * @param element Element of the researched tag. * @return Corresponding element value representation when it exists, - * and the string "gdcm::Unfound" otherwise. + * and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise. */ -string gdcmHeader::GetPubElValRepByNumber(guint16 group, guint16 element) { - ElValue* elem = PubElVals.GetElementByNumber(group, element); +std::string gdcmHeader::GetPubElValRepByNumber(guint16 group, guint16 element) { + gdcmElValue* elem = PubElValSet.GetElementByNumber(group, element); if ( !elem ) - return "gdcm::Unfound"; + return GDCM_UNFOUND; return elem->GetVR(); } @@ -1151,10 +1429,10 @@ string gdcmHeader::GetPubElValRepByNumber(guint16 group, guint16 element) { * a given tag. * @param TagName name of the researched element. * @return Corresponding element value when it exists, and the string - * "gdcm::Unfound" otherwise. + * GDCM_UNFOUND ("gdcm::Unfound") otherwise. */ -string gdcmHeader::GetPubElValByName(string TagName) { - return PubElVals.GetElValueByName(TagName); +std::string gdcmHeader::GetPubElValByName(std::string TagName) { + return PubElValSet.GetElValueByName(TagName); } /** @@ -1168,12 +1446,12 @@ string gdcmHeader::GetPubElValByName(string TagName) { * of semantics than just the native C++ type. * @param TagName name of the researched element. * @return Corresponding element value representation when it exists, - * and the string "gdcm::Unfound" otherwise. + * and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise. */ -string gdcmHeader::GetPubElValRepByName(string TagName) { - ElValue* elem = PubElVals.GetElementByName(TagName); +std::string gdcmHeader::GetPubElValRepByName(std::string TagName) { + gdcmElValue* elem = PubElValSet.GetElementByName(TagName); if ( !elem ) - return "gdcm::Unfound"; + return GDCM_UNFOUND; return elem->GetVR(); } @@ -1184,10 +1462,10 @@ string gdcmHeader::GetPubElValRepByName(string TagName) { * @param group Group of the researched tag. * @param element Element of the researched tag. * @return Corresponding element value representation when it exists, - * and the string "gdcm::Unfound" otherwise. + * and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise. */ -string gdcmHeader::GetShaElValByNumber(guint16 group, guint16 element) { - return ShaElVals.GetElValueByNumber(group, element); +std::string gdcmHeader::GetShaElValByNumber(guint16 group, guint16 element) { + return ShaElValSet.GetElValueByNumber(group, element); } /** @@ -1202,12 +1480,12 @@ string gdcmHeader::GetShaElValByNumber(guint16 group, guint16 element) { * @param group Group of the researched tag. * @param element Element of the researched tag. * @return Corresponding element value representation when it exists, - * and the string "gdcm::Unfound" otherwise. + * and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise. */ -string gdcmHeader::GetShaElValRepByNumber(guint16 group, guint16 element) { - ElValue* elem = ShaElVals.GetElementByNumber(group, element); +std::string gdcmHeader::GetShaElValRepByNumber(guint16 group, guint16 element) { + gdcmElValue* elem = ShaElValSet.GetElementByNumber(group, element); if ( !elem ) - return "gdcm::Unfound"; + return GDCM_UNFOUND; return elem->GetVR(); } @@ -1217,10 +1495,10 @@ string gdcmHeader::GetShaElValRepByNumber(guint16 group, guint16 element) { * for an element value of given tag. * @param TagName name of the researched element. * @return Corresponding element value when it exists, and the string - * "gdcm::Unfound" otherwise. + * GDCM_UNFOUND ("gdcm::Unfound") otherwise. */ -string gdcmHeader::GetShaElValByName(string TagName) { - return ShaElVals.GetElValueByName(TagName); +std::string gdcmHeader::GetShaElValByName(std::string TagName) { + return ShaElValSet.GetElValueByName(TagName); } /** @@ -1234,12 +1512,12 @@ string gdcmHeader::GetShaElValByName(string TagName) { * of semantics than just the native C++ type. * @param TagName name of the researched element. * @return Corresponding element value representation when it exists, - * and the string "gdcm::Unfound" otherwise. + * and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise. */ -string gdcmHeader::GetShaElValRepByName(string TagName) { - ElValue* elem = ShaElVals.GetElementByName(TagName); +std::string gdcmHeader::GetShaElValRepByName(std::string TagName) { + gdcmElValue* elem = ShaElValSet.GetElementByName(TagName); if ( !elem ) - return "gdcm::Unfound"; + return GDCM_UNFOUND; return elem->GetVR(); } @@ -1251,10 +1529,10 @@ string gdcmHeader::GetShaElValRepByName(string TagName) { * @param group Group of the researched tag. * @param element Element of the researched tag. * @return Corresponding element value representation when it exists, - * and the string "gdcm::Unfound" otherwise. + * and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise. */ -string gdcmHeader::GetElValByNumber(guint16 group, guint16 element) { - string pub = GetPubElValByNumber(group, element); +std::string gdcmHeader::GetElValByNumber(guint16 group, guint16 element) { + std::string pub = GetPubElValByNumber(group, element); if (pub.length()) return pub; return GetShaElValByNumber(group, element); @@ -1273,10 +1551,10 @@ string gdcmHeader::GetElValByNumber(guint16 group, guint16 element) { * @param group Group of the researched tag. * @param element Element of the researched tag. * @return Corresponding element value representation when it exists, - * and the string "gdcm::Unfound" otherwise. + * and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise. */ -string gdcmHeader::GetElValRepByNumber(guint16 group, guint16 element) { - string pub = GetPubElValRepByNumber(group, element); +std::string gdcmHeader::GetElValRepByNumber(guint16 group, guint16 element) { + std::string pub = GetPubElValRepByNumber(group, element); if (pub.length()) return pub; return GetShaElValRepByNumber(group, element); @@ -1289,10 +1567,10 @@ string gdcmHeader::GetElValRepByNumber(guint16 group, guint16 element) { * for the element value of a given tag. * @param TagName name of the researched element. * @return Corresponding element value when it exists, - * and the string "gdcm::Unfound" otherwise. + * and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise. */ -string gdcmHeader::GetElValByName(string TagName) { - string pub = GetPubElValByName(TagName); +std::string gdcmHeader::GetElValByName(std::string TagName) { + std::string pub = GetPubElValByName(TagName); if (pub.length()) return pub; return GetShaElValByName(TagName); @@ -1310,10 +1588,10 @@ string gdcmHeader::GetElValByName(string TagName) { * of semantics than just the native C++ type. * @param TagName name of the researched element. * @return Corresponding element value representation when it exists, - * and the string "gdcm::Unfound" otherwise. + * and the string GDCM_UNFOUND ("gdcm::Unfound") otherwise. */ -string gdcmHeader::GetElValRepByName(string TagName) { - string pub = GetPubElValRepByName(TagName); +std::string gdcmHeader::GetElValRepByName(std::string TagName) { + std::string pub = GetPubElValRepByName(TagName); if (pub.length()) return pub; return GetShaElValRepByName(TagName); @@ -1321,73 +1599,76 @@ string gdcmHeader::GetElValRepByName(string TagName) { /** * \ingroup gdcmHeader - * \brief Accesses an existing ElValue in the PubElVals of this instance + * \brief Accesses an existing gdcmElValue in the PubElValSet of this instance * through it's (group, element) and modifies it's content with * the given value. * @param content new value to substitute with * @param group group of the ElVal to modify * @param element element of the ElVal to modify */ -int gdcmHeader::SetPubElValByNumber(string content, guint16 group, +int gdcmHeader::SetPubElValByNumber(std::string content, guint16 group, guint16 element) + +//TODO : homogeneiser les noms : SetPubElValByNumber +// qui appelle PubElValSet.SetElValueByNumber +// pourquoi pas SetPubElValueByNumber ?? { - return ( PubElVals.SetElValueByNumber (content, group, element) ); + + return ( PubElValSet.SetElValueByNumber (content, group, element) ); } /** * \ingroup gdcmHeader - * \brief Accesses an existing ElValue in the PubElVals of this instance + * \brief Accesses an existing gdcmElValue in the PubElValSet of this instance * through tag name and modifies it's content with the given value. * @param content new value to substitute with * @param TagName name of the tag to be modified */ -int gdcmHeader::SetPubElValByName(string content, string TagName) { - return ( PubElVals.SetElValueByName (content, TagName) ); +int gdcmHeader::SetPubElValByName(std::string content, std::string TagName) { + return ( PubElValSet.SetElValueByName (content, TagName) ); } /** * \ingroup gdcmHeader - * \brief Accesses an existing ElValue in the PubElVals of this instance + * \brief Accesses an existing gdcmElValue in the PubElValSet of this instance * through it's (group, element) and modifies it's length with * the given value. - * NOT FOR BOZOs ! - * @param contents new length to substitute with + * \warning Use with extreme caution. + * @param length new length to substitute with * @param group group of the ElVal to modify * @param element element of the ElVal to modify + * @return 1 on success, 0 otherwise. */ -int gdcmHeader::SetPubElValLengthByNumber(guint32 lgr, guint16 group, - guint16 element) -{ - return ( PubElVals.SetElValueLengthByNumber (lgr, group, element) ); + +int gdcmHeader::SetPubElValLengthByNumber(guint32 length, guint16 group, + guint16 element) { + return ( PubElValSet.SetElValueLengthByNumber (length, group, element) ); } /** * \ingroup gdcmHeader - * \brief Accesses an existing ElValue in the ShaElVals of this instance + * \brief Accesses an existing gdcmElValue in the ShaElValSet of this instance * through it's (group, element) and modifies it's content with * the given value. * @param content new value to substitute with * @param group group of the ElVal to modify * @param element element of the ElVal to modify + * @return 1 on success, 0 otherwise. */ -int gdcmHeader::SetShaElValByNumber(string content, - guint16 group, guint16 element) -{ - return ( ShaElVals.SetElValueByNumber (content, group, element) ); +int gdcmHeader::SetShaElValByNumber(std::string content, + guint16 group, guint16 element) { + return ( ShaElValSet.SetElValueByNumber (content, group, element) ); } - - - /** * \ingroup gdcmHeader - * \brief Accesses an existing ElValue in the ShaElVals of this instance + * \brief Accesses an existing gdcmElValue in the ShaElValSet of this instance * through tag name and modifies it's content with the given value. * @param content new value to substitute with - * @param TagName name of the tag to be modified + * @param ShadowTagName name of the tag to be modified */ -int gdcmHeader::SetShaElValByName(string content, string TagName) { - return ( ShaElVals.SetElValueByName (content, TagName) ); +int gdcmHeader::SetShaElValByName(std::string content, std::string ShadowTagName) { + return ( ShaElValSet.SetElValueByName (content, ShadowTagName) ); } /** @@ -1395,42 +1676,69 @@ int gdcmHeader::SetShaElValByName(string content, string TagName) { * \brief Parses the header of the file but WITHOUT loading element values. */ void gdcmHeader::ParseHeader(bool exception_on_error) throw(gdcmFormatError) { - ElValue * newElValue = (ElValue *)0; + gdcmElValue * newElValue = (gdcmElValue *)0; rewind(fp); CheckSwap(); while ( (newElValue = ReadNextElement()) ) { SkipElementValue(newElValue); - PubElVals.Add(newElValue); + PubElValSet.Add(newElValue); } } /** * \ingroup gdcmHeader - * \brief Once the header is parsed add some gdcm convenience/helper elements - * in the ElValSet. For example add: - * - gdcmImageType which is an entry containing a short for the - * type of image and whose value ranges in - * I8 (unsigned 8 bit image) - * I16 (unsigned 8 bit image) - * IS16 (signed 8 bit image) - * - gdcmXsize, gdcmYsize, gdcmZsize whose values are respectively - * the ones of the official DICOM fields Rows, Columns and Planes. + * \brief This predicate, based on hopefully reasonnable heuristics, + * decides whether or not the current gdcmHeader was properly parsed + * and contains the mandatory information for being considered as + * a well formed and usable image. + * @return true when gdcmHeader is the one of a reasonable Dicom file, + * false otherwise. */ -void gdcmHeader::AddAndDefaultElements(void) { - ElValue* NewEntry = (ElValue*)0; - - NewEntry = NewElValueByName("gdcmXSize"); - NewEntry->SetValue(GetElValByName("Rows")); - PubElVals.Add(NewEntry); - - NewEntry = NewElValueByName("gdcmYSize"); - NewEntry->SetValue(GetElValByName("Columns")); - PubElVals.Add(NewEntry); +bool gdcmHeader::IsReadable(void) { + if ( GetElValByName("Image Dimensions") != GDCM_UNFOUND + && atoi(GetElValByName("Image Dimensions").c_str()) > 4 ) { + return false; + } + if ( GetElValByName("Bits Allocated") == GDCM_UNFOUND ) + return false; + if ( GetElValByName("Bits Stored") == GDCM_UNFOUND ) + return false; + if ( GetElValByName("High Bit") == GDCM_UNFOUND ) + return false; + if ( GetElValByName("Pixel Representation") == GDCM_UNFOUND ) + return false; + return true; +} - NewEntry = NewElValueByName("gdcmZSize"); - NewEntry->SetValue(GetElValByName("Planes")); - PubElVals.Add(NewEntry); +/** + * \ingroup gdcmHeader + * \brief Small utility function that creates a new manually crafted + * (as opposed as read from the file) gdcmElValue with user + * specified name and adds it to the public tag hash table. + * \note A fake TagKey is generated so the PubDict can keep it's coherence. + * @param NewTagName The name to be given to this new tag. + * @param VR The Value Representation to be given to this new tag. + * @ return The newly hand crafted Element Value. + */ +gdcmElValue* gdcmHeader::NewManualElValToPubDict(std::string NewTagName, + std::string VR) { + gdcmElValue* NewElVal = (gdcmElValue*)0; + guint32 StuffGroup = 0xffff; // Group to be stuffed with additional info + guint32 FreeElem = 0; + gdcmDictEntry* NewEntry = (gdcmDictEntry*)0; + + FreeElem = PubElValSet.GenerateFreeTagKeyInGroup(StuffGroup); + if (FreeElem == UINT32_MAX) { + dbg.Verbose(1, "gdcmHeader::NewManualElValToPubDict", + "Group 0xffff in Public Dict is full"); + return (gdcmElValue*)0; + } + NewEntry = new gdcmDictEntry(StuffGroup, FreeElem, + VR, "GDCM", NewTagName); + NewElVal = new gdcmElValue(NewEntry); + PubElValSet.Add(NewElVal); + return NewElVal; } /** @@ -1440,16 +1748,555 @@ void gdcmHeader::AddAndDefaultElements(void) { */ void gdcmHeader::LoadElements(void) { rewind(fp); - TagElValueHT ht = PubElVals.GetTagHt(); + TagElValueHT ht = PubElValSet.GetTagHt(); for (TagElValueHT::iterator tag = ht.begin(); tag != ht.end(); ++tag) { LoadElementValue(tag->second); - } + } + rewind(fp); + + // Load 'non string' values + std::string PhotometricInterpretation = GetPubElValByNumber(0x0028,0x0004); + if( PhotometricInterpretation == "PALETTE COLOR " ){ + LoadElementVoidArea(0x0028,0x1200); // gray LUT + LoadElementVoidArea(0x0028,0x1201); // R LUT + LoadElementVoidArea(0x0028,0x1202); // G LUT + LoadElementVoidArea(0x0028,0x1203); // B LUT + + LoadElementVoidArea(0x0028,0x1221); // Segmented Red Palette Color LUT Data + LoadElementVoidArea(0x0028,0x1222); // Segmented Green Palette Color LUT Data + LoadElementVoidArea(0x0028,0x1223); // Segmented Blue Palette Color LUT Data + } + + // -------------------------------------------------------------- + // Special Patch to allow gdcm to read ACR-LibIDO formated images + // + // if recognition code tells us we deal with a LibIDO image + // we switch lineNumber and columnNumber + // + std::string RecCode; + RecCode = GetPubElValByNumber(0x0008, 0x0010); + if (RecCode == "ACRNEMA_LIBIDO_1.1" || + RecCode == "CANRME_AILIBOD1_1." ) { + filetype = ACR_LIBIDO; + std::string rows = GetPubElValByNumber(0x0028, 0x0010); + std::string columns = GetPubElValByNumber(0x0028, 0x0011); + SetPubElValByNumber(columns, 0x0028, 0x0010); + SetPubElValByNumber(rows , 0x0028, 0x0011); + } + // ----------------- End of Special Patch ---------------- } -void gdcmHeader::PrintPubElVal(ostream & os) { - PubElVals.Print(os); +/** + * \ingroup gdcmHeader + * \brief + * @return + */ +void gdcmHeader::PrintPubElVal(std::ostream & os) { + PubElValSet.Print(os); } -void gdcmHeader::PrintPubDict(ostream & os) { +/** + * \ingroup gdcmHeader + * \brief + * @return + */ +void gdcmHeader::PrintPubDict(std::ostream & os) { RefPubDict->Print(os); } + +/** + * \ingroup gdcmHeader + * \brief + * @return integer, acts as a Boolean + */ +int gdcmHeader::Write(FILE * fp, FileType type) { + + + // TODO : move the following lines (and a lot of others) + // to a future function CheckAndCorrectHeader + + if (type == ImplicitVR) { + std::string implicitVRTransfertSyntax = "1.2.840.10008.1.2"; + ReplaceOrCreateByNumber(implicitVRTransfertSyntax,0x0002, 0x0010); + + //FIXME Refer to standards on page 21, chapter 6.2 "Value representation": + // values with a VR of UI shall be padded with a single trailing null + // Dans le cas suivant on doit pader manuellement avec un 0 + + PubElValSet.SetElValueLengthByNumber(18, 0x0002, 0x0010); + } + + if (type == ExplicitVR) { + std::string explicitVRTransfertSyntax = "1.2.840.10008.1.2.1"; + ReplaceOrCreateByNumber(explicitVRTransfertSyntax,0x0002, 0x0010); + + //FIXME Refer to standards on page 21, chapter 6.2 "Value representation": + // values with a VR of UI shall be padded with a single trailing null + // Dans le cas suivant on doit pader manuellement avec un 0 + + PubElValSet.SetElValueLengthByNumber(20, 0x0002, 0x0010); + } + + return PubElValSet.Write(fp, type); +} + +// +// ------------------------ 'non string' elements related functions +// + +/** + * \ingroup gdcmHeader + * \brief Loads (from disk) the element content + * when a string is not suitable + */ +void * gdcmHeader::LoadElementVoidArea(guint16 Group, guint16 Elem) { + gdcmElValue * Element= PubElValSet.GetElementByNumber(Group, Elem); + if ( !Element ) + return NULL; + size_t o =(size_t)Element->GetOffset(); + fseek(fp, o, SEEK_SET); + int l=Element->GetLength(); + void * a = malloc(l); + if(!a) { + std::cout << "Big Broblem (LoadElementVoidArea, malloc) " + << std::hex << Group << " " << Elem << std::endl; + return NULL; + } + /* int res = */ PubElValSet.SetVoidAreaByNumber(a, Group, Elem); + // TODO check the result + size_t l2 = fread(a, 1, l ,fp); + if(l != l2) { + std::cout << "Big Broblem (LoadElementVoidArea, fread) " + << std::hex << Group << " " << Elem << std::endl; + free(a); + return NULL; + } + return a; +} + +/** + * \ingroup gdcmHeader + * \brief Gets (from Header) the offset of a 'non string' element value + * \ (LoadElementValue has already be executed) + * @param Group + * @param Elem + * @return File Offset of the Element Value + */ + size_t gdcmHeader::GetPubElValOffsetByNumber(guint16 Group, guint16 Elem) { + gdcmElValue* elValue = PubElValSet.GetElementByNumber(Group, Elem); + if (!elValue) { + dbg.Verbose(1, "gdcmHeader::GetElValueByNumber", + "failed to Locate gdcmElValue"); + return (size_t)0; + } + return elValue->GetOffset(); +} + +/** + * \ingroup gdcmHeader +* \brief Gets (from Header) a 'non string' element value + * \ (LoadElementValue has already be executed) + * @param Group + * @param Elem + * @return Pointer to the 'non string' area + + */ + void * gdcmHeader::GetPubElValVoidAreaByNumber(guint16 Group, guint16 Elem) { + gdcmElValue* elValue = PubElValSet.GetElementByNumber(Group, Elem); + if (!elValue) { + dbg.Verbose(1, "gdcmHeader::GetElValueByNumber", + "failed to Locate gdcmElValue"); + return (NULL); + } + return elValue->GetVoidArea(); +} + + +// +// ============================================================================= +// Heuristics based accessors +//============================================================================== +// + +// TODO : move to an other file. + + +/** + * \ingroup gdcmHeader + * \brief Retrieve the number of columns of image. + * @return The encountered size when found, 0 by default. + */ +int gdcmHeader::GetXSize(void) { + // We cannot check for "Columns" because the "Columns" tag is present + // both in IMG (0028,0011) and OLY (6000,0011) sections of the dictionary. + std::string StrSize = GetPubElValByNumber(0x0028,0x0011); + if (StrSize == GDCM_UNFOUND) + return 0; + return atoi(StrSize.c_str()); +} + +/** + * \ingroup gdcmHeader + * \brief Retrieve the number of lines of image. + * \warning The defaulted value is 1 as opposed to gdcmHeader::GetXSize() + * @return The encountered size when found, 1 by default. + */ +int gdcmHeader::GetYSize(void) { + // We cannot check for "Rows" because the "Rows" tag is present + // both in IMG (0028,0010) and OLY (6000,0010) sections of the dictionary. + std::string StrSize = GetPubElValByNumber(0x0028,0x0010); + if (StrSize != GDCM_UNFOUND) + return atoi(StrSize.c_str()); + if ( IsDicomV3() ) + return 0; + else + // The Rows (0028,0010) entry is optional for ACR/NEMA. It might + // hence be a signal (1d image). So we default to 1: + return 1; +} + +/** + * \ingroup gdcmHeader + * \brief Retrieve the number of planes of volume or the number + * of frames of a multiframe. + * \warning When present we consider the "Number of Frames" as the third + * dimension. When absent we consider the third dimension as + * being the "Planes" tag content. + * @return The encountered size when found, 1 by default. + */ +int gdcmHeader::GetZSize(void) { + // Both in DicomV3 and ACR/Nema the consider the "Number of Frames" + // as the third dimension. + std::string StrSize = GetPubElValByNumber(0x0028,0x0008); + if (StrSize != GDCM_UNFOUND) + return atoi(StrSize.c_str()); + + // We then consider the "Planes" entry as the third dimension [we + // cannot retrieve by name since "Planes tag is present both in + // IMG (0028,0012) and OLY (6000,0012) sections of the dictionary]. + StrSize = GetPubElValByNumber(0x0028,0x0012); + if (StrSize != GDCM_UNFOUND) + return atoi(StrSize.c_str()); + return 1; +} + +/** + * \ingroup gdcmHeader + * \brief Retrieve the number of Bits Stored + * (as opposite to number of Bits Allocated) + * + * @return The encountered number of Bits Stored, 0 by default. + */ +int gdcmHeader::GetBitsStored(void) { + std::string StrSize = GetPubElValByNumber(0x0028,0x0101); + if (StrSize == GDCM_UNFOUND) + return 1; + return atoi(StrSize.c_str()); +} + +/** + * \ingroup gdcmHeader + * \brief Retrieve the number of Bits Allocated + * (8, 12 -compacted ACR-NEMA files, 16, ...) + * + * @return The encountered number of Bits Allocated, 0 by default. + */ +int gdcmHeader::GetBitsAllocated(void) { + std::string StrSize = GetPubElValByNumber(0x0028,0x0100); + if (StrSize == GDCM_UNFOUND) + return 1; + return atoi(StrSize.c_str()); +} + +/** + * \ingroup gdcmHeader + * \brief Retrieve the number of Samples Per Pixel + * (1 : gray level, 3 : RGB) + * + * @return The encountered number of Samples Per Pixel, 1 by default. + */ +int gdcmHeader::GetSamplesPerPixel(void) { + std::string StrSize = GetPubElValByNumber(0x0028,0x0002); + if (StrSize == GDCM_UNFOUND) + return 1; // Well, it's supposed to be mandatory ... + return atoi(StrSize.c_str()); +} + +/** + * \ingroup gdcmHeader + * \brief Retrieve the Planar Configuration for RGB images + * (0 : RGB Pixels , 1 : R Plane + G Plane + B Plane) + * + * @return The encountered Planar Configuration, 0 by default. + */ +int gdcmHeader::GetPlanarConfiguration(void) { + std::string StrSize = GetPubElValByNumber(0x0028,0x0006); + if (StrSize == GDCM_UNFOUND) + return 0; + return atoi(StrSize.c_str()); +} + +/** + * \ingroup gdcmHeader + * \brief Return the size (in bytes) of a single pixel of data. + * @return The size in bytes of a single pixel of data. + * + */ +int gdcmHeader::GetPixelSize(void) { + std::string PixelType = GetPixelType(); + if (PixelType == "8U" || PixelType == "8S") + return 1; + if (PixelType == "16U" || PixelType == "16S") + return 2; + if (PixelType == "32U" || PixelType == "32S") + return 4; + dbg.Verbose(0, "gdcmHeader::GetPixelSize: Unknown pixel type"); + return 0; +} + +/** + * \ingroup gdcmHeader + * \brief Build the Pixel Type of the image. + * Possible values are: + * - 8U unsigned 8 bit, + * - 8S signed 8 bit, + * - 16U unsigned 16 bit, + * - 16S signed 16 bit, + * - 32U unsigned 32 bit, + * - 32S signed 32 bit, + * \warning 12 bit images appear as 16 bit. + * @return + */ +std::string gdcmHeader::GetPixelType(void) { + std::string BitsAlloc; + BitsAlloc = GetElValByName("Bits Allocated"); + if (BitsAlloc == GDCM_UNFOUND) { + dbg.Verbose(0, "gdcmHeader::GetPixelType: unfound Bits Allocated"); + BitsAlloc = std::string("16"); + } + if (BitsAlloc == "12") + BitsAlloc = std::string("16"); + + std::string Signed; + Signed = GetElValByName("Pixel Representation"); + if (Signed == GDCM_UNFOUND) { + dbg.Verbose(0, "gdcmHeader::GetPixelType: unfound Pixel Representation"); + BitsAlloc = std::string("0"); + } + if (Signed == "0") + Signed = std::string("U"); + else + Signed = std::string("S"); + + return( BitsAlloc + Signed); +} + +/** + * \ingroup gdcmHeader + * \brief gets the info from 0002,0010 : Transfert Syntax + * \ else 1. + * @return Transfert Syntax Name (as oposite to Transfert Syntax UID) + */ +std::string gdcmHeader::GetTransferSyntaxName(void) { + std::string TransfertSyntax = GetPubElValByNumber(0x0002,0x0010); + if (TransfertSyntax == GDCM_UNFOUND) { + dbg.Verbose(0, "gdcmHeader::GetTransferSyntaxName: unfound Transfert Syntax (0002,0010)"); + return "Uncompressed ACR-NEMA"; + } + // we do it only when we need it + gdcmTS * ts = gdcmGlobal::GetTS(); + std::string tsName=ts->GetValue(TransfertSyntax); + //delete ts; // Seg Fault when deleted ?! + return tsName; +} + +// -------------------------------- Lookup Table related functions ------------ + +/** + * \ingroup gdcmHeader + * \brief tells us if LUT are used + * @return int acts as a Boolean + */ + +int gdcmHeader::HasLUT(void) { + + // Just hope checking the presence of the LUT Descriptors is enough + if (GetPubElValByNumber(0x0028,0x1101) == GDCM_UNFOUND) + return 0; + // LutDescriptorGreen + if (GetPubElValByNumber(0x0028,0x1102) == GDCM_UNFOUND) + return 0; + // LutDescriptorBlue + if (GetPubElValByNumber(0x0028,0x1103) == GDCM_UNFOUND) + return 0; + return 1; +} + +/** + * \ingroup gdcmHeader + * \brief gets the info from 0028,1101 : Lookup Table Desc-Red + * \ else 0 + * @return Lookup Table nBit + * \ when (0028,0004),Photometric Interpretation = [PALETTE COLOR ] + */ + +int gdcmHeader::GetLUTNbits(void) { + std::vector tokens; + //int LutLength; + //int LutDepth; + int LutNbits; + //Just hope Lookup Table Desc-Red = Lookup Table Desc-Red = Lookup Table Desc-Blue + // Consistency already checked in GetLUTLength + std::string LutDescription = GetPubElValByNumber(0x0028,0x1101); + if (LutDescription == GDCM_UNFOUND) + return 0; + tokens.erase(tokens.begin(),tokens.end()); // clean any previous value + Tokenize (LutDescription, tokens, "\\"); + //LutLength=atoi(tokens[0].c_str()); + //LutDepth=atoi(tokens[1].c_str()); + LutNbits=atoi(tokens[2].c_str()); + tokens.clear(); + return LutNbits; +} + +/** + * \ingroup gdcmHeader + * \brief builts Red/Green/Blue/Alpha LUT from Header + * \ when (0028,0004),Photometric Interpretation = [PALETTE COLOR ] + * \ and (0028,1101),(0028,1102),(0028,1102) + * \ - xxx Palette Color Lookup Table Descriptor - are found + * \ and (0028,1201),(0028,1202),(0028,1202) + * \ - xxx Palette Color Lookup Table Data - are found + * \warning does NOT deal with : + * \ 0028 1100 Gray Lookup Table Descriptor (Retired) + * \ 0028 1221 Segmented Red Palette Color Lookup Table Data + * \ 0028 1222 Segmented Green Palette Color Lookup Table Data + * \ 0028 1223 Segmented Blue Palette Color Lookup Table Data + * \ no known Dicom reader deails with them :-( + * @return Lookup Table RGBA + */ + +void * gdcmHeader::GetLUTRGBA(void) { +// Not so easy : see +// http://www.barre.nom.fr/medical/dicom2/limitations.html#Color%20Lookup%20Tables +// and OT-PAL-8-face.dcm + +// if Photometric Interpretation # PALETTE COLOR, no LUT to be done + + if (gdcmHeader::GetPubElValByNumber(0x0028,0x0004) != "PALETTE COLOR ") { + return NULL; + } + + void * LutR,*LutG,*LutB; + int l; + int lengthR, debR, nbitsR; + int lengthG, debG, nbitsG; + int lengthB, debB, nbitsB; + +// Get info from Lut Descriptors +// (the 3 LUT descriptors may be different) + + std::string LutDescriptionR = GetPubElValByNumber(0x0028,0x1101); + if (LutDescriptionR == GDCM_UNFOUND) + return NULL; + std::string LutDescriptionG = GetPubElValByNumber(0x0028,0x1102); + if (LutDescriptionG == GDCM_UNFOUND) + return NULL; + std::string LutDescriptionB = GetPubElValByNumber(0x0028,0x1103); + if (LutDescriptionB == GDCM_UNFOUND) + return NULL; + + std::vector tokens; + + tokens.erase(tokens.begin(),tokens.end()); // clean any previous value + Tokenize (LutDescriptionR, tokens, "\\"); + lengthR=atoi(tokens[0].c_str()); // Red LUT length in Bytes + debR =atoi(tokens[1].c_str()); // subscript of the first Lut Value + nbitsR =atoi(tokens[2].c_str()); // Lut item size (in Bits) + tokens.clear(); + + tokens.erase(tokens.begin(),tokens.end()); // clean any previous value + Tokenize (LutDescriptionG, tokens, "\\"); + lengthG=atoi(tokens[0].c_str()); // Green LUT length in Bytes + debG =atoi(tokens[1].c_str()); + nbitsG =atoi(tokens[2].c_str()); + tokens.clear(); + + tokens.erase(tokens.begin(),tokens.end()); // clean any previous value + Tokenize (LutDescriptionB, tokens, "\\"); + lengthB=atoi(tokens[0].c_str()); // Blue LUT length in Bytes + debB =atoi(tokens[1].c_str()); + nbitsB =atoi(tokens[2].c_str()); + tokens.clear(); + +// Load LUTs into memory, (as they were stored on disk) + + unsigned char *lutR =(unsigned char *) + GetPubElValVoidAreaByNumber(0x0028,0x1201); + unsigned char *lutG =(unsigned char *) + GetPubElValVoidAreaByNumber(0x0028,0x1202); + unsigned char *lutB =(unsigned char *) + GetPubElValVoidAreaByNumber(0x0028,0x1203); + + if (!lutR || !lutG || !lutB ) { + return NULL; + } + // forge the 4 * 8 Bits Red/Green/Blue/Alpha LUT + + char *LUTRGBA = (char *)calloc(1024,1); // 256 * 4 (R, G, B, Alpha) + if (!LUTRGBA) { + return NULL; + } + // Bits Allocated + int nb; + std::string str_nb = GetPubElValByNumber(0x0028,0x0100); + if (str_nb == GDCM_UNFOUND ) { + nb = 16; + } else { + nb = atoi(str_nb.c_str() ); + } + int mult; + + if (nbitsR==16 && nb==8) // when LUT item size is different than pixel size + mult=2; // high byte must be = low byte + else // See PS 3.3-2003 C.11.1.1.2 p 619 + mult=1; + + + // if we get a black image, let's just remove the '+1' + // from 'i*mult+1' and check again + // if it works, we shall have to check the 3 Palettes + // to see which byte is ==0 (first one, or second one) + // and fix the code + // We give up the checking to avoid some overhead + char *a; + a= LUTRGBA+debR; + for(int i=0;i