X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocEntrySet.cxx;h=5f31e20205cf00f95bce10d6e11d52bda420bb17;hb=82afaad85d04083d5d7945e2a70a79a720a9ba3a;hp=c2d28100c29a6782af0472464bead2a45536e211;hpb=00be59e3db4bb1efcb3ac7980822863d1f7b92e5;p=gdcm.git diff --git a/src/gdcmDocEntrySet.cxx b/src/gdcmDocEntrySet.cxx index c2d28100..5f31e202 100644 --- a/src/gdcmDocEntrySet.cxx +++ b/src/gdcmDocEntrySet.cxx @@ -1,222 +1,541 @@ -// gdcmDocEntrySet.cxx -//----------------------------------------------------------------------------- -// +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDocEntrySet.cxx,v $ + Language: C++ + Date: $Date: 2005/11/21 09:41:46 $ + Version: $Revision: 1.68 $ + + 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.html for details. + + This software is distributed WITHOUT ANY WARRANTY; without even + the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR + PURPOSE. See the above copyright notices for more information. + +=========================================================================*/ #include "gdcmDocEntrySet.h" -#include // for std::ios::left, ... - +#include "gdcmDebug.h" +#include "gdcmCommon.h" +#include "gdcmDictSet.h" +#include "gdcmGlobal.h" +#include "gdcmDocEntry.h" +#include "gdcmSeqEntry.h" +#include "gdcmUtil.h" +#include "gdcmDataEntry.h" +#include "gdcmVR.h" +namespace gdcm +{ //----------------------------------------------------------------------------- // Constructor / Destructor +DocEntrySet::DocEntrySet() +{ + PreviousDocEntry = 0; +} +//----------------------------------------------------------------------------- +// Public /** - * \ingroup gdcmDocEntrySEt - * \brief Constructor from a given gdcmDocEntrySet + * \brief Get the "std::string representable" value of the Dicom entry + * @param group Group number of the searched tag. + * @param elem Element number of the searched tag. + * @return Corresponding element value when it exists, + * and the string GDCM_UNFOUND otherwise. */ -gdcmDocEntrySet::gdcmDocEntrySet() { - +std::string DocEntrySet::GetEntryString(uint16_t group, uint16_t elem) +{ + DataEntry *entry = dynamic_cast(GetDocEntry(group,elem)); + if ( entry ) + { + if( entry->IsNotLoaded() ) + return GDCM_NOTLOADED; + if( entry->IsUnfound() ) + return GDCM_UNFOUND; + if( entry->IsUnread() ) + return GDCM_UNREAD; + return entry->GetString(); + } + return GDCM_UNFOUND; } -//----------------------------------------------------------------------------- -// Print -/* - * \ingroup gdcmDocEntrySet - * \brief canonical Printer +/** + * \brief Gets (from Header) a 'non string' element value + * @param group group number of the Entry + * @param elem element number of the Entry + * @return Pointer to the 'non string' area */ +void *DocEntrySet::GetEntryBinArea(uint16_t group, uint16_t elem) +{ + DataEntry *entry = GetDataEntry(group, elem); + if ( entry ) + return entry->GetBinArea(); + return 0; +} +/** + * \brief Searches within the DocEntrySet + * for the value length of a given tag.. + * @param group Group number of the searched tag. + * @param elem Element number of the searched tag. + * @return Corresponding element length; -1 if not found + */ +int DocEntrySet::GetEntryLength(uint16_t group, uint16_t elem) +{ + DocEntry *entry = GetDocEntry(group, elem); + if ( entry ) + return entry->GetLength(); + return -1; +} -//----------------------------------------------------------------------------- -// Public +/** + * \brief Same as \ref Document::GetDocEntry except it returns a result + * only when the corresponding entry is of type DataEntry. + * @param group Group number of the searched Dicom Element + * @param elem Element number of the searched Dicom Element + * @return When present, the corresponding DataEntry. + */ +DataEntry *DocEntrySet::GetDataEntry(uint16_t group, uint16_t elem) +{ + DocEntry *currentEntry = GetDocEntry(group, elem); + if ( !currentEntry ) + return NULL; + return dynamic_cast(currentEntry); +} -//----------------------------------------------------------------------------- -// Protected +/** + * \brief Same as \ref Document::GetDocEntry except it returns a result + * only when the corresponding entry is of type SeqEntry. + * @param group Group number of the searched Dicom Element + * @param elem Element number of the searched Dicom Element + * @return When present, the corresponding SeqEntry. + */ +SeqEntry *DocEntrySet::GetSeqEntry(uint16_t group, uint16_t elem) +{ + DocEntry *currentEntry = GetDocEntry(group, elem); + if ( !currentEntry ) + return NULL; + + return dynamic_cast(currentEntry); +} -//----------------------------------------------------------------------------- -// Private +/** + * \brief Accesses an existing DocEntry (i.e. a Dicom Element) + * through it's (group, element) and modifies it's content with + * the given value. + * @param content new value (string) to substitute with + * @param group group number of the Dicom Element to modify + * @param elem element number of the Dicom Element to modify + */ +bool DocEntrySet::SetEntryString(std::string const &content, + uint16_t group, uint16_t elem) +{ + DataEntry *entry = GetDataEntry(group, elem); + if (!entry ) + { + gdcmWarningMacro( "No corresponding DataEntry " << std::hex << group << + "," << elem << " element (try promotion first)."); + return false; + } + return SetEntryString(content,entry); +} /** - * \brief Parses an EntrySet (Document header or SQ Item ) - * \ and load element values (a voir !) - * @return false if file is not ACR-NEMA / PAPYRUS / DICOM + * \brief Accesses an existing DocEntry (i.e. a Dicom Element) + * through it's (group, element) and modifies it's content with + * the given value. + * @param content new value (void* -> uint8_t*) to substitute with + * @param lgth new value length + * @param group group number of the Dicom Element to modify + * @param elem element number of the Dicom Element to modify */ -bool gdcmDocument::LoadDocEntrySet(bool exception_on_error) throw(gdcmFormatError) { - (void)exception_on_error; - rewind(fp); - if (!CheckSwap()) +bool DocEntrySet::SetEntryBinArea(uint8_t *content, int lgth, + uint16_t group, uint16_t elem) +{ + DataEntry *entry = GetDataEntry(group, elem); + if (!entry ) + { + gdcmWarningMacro( "No corresponding DataEntry " << std::hex << group << + "," << elem << " element (try promotion first)."); return false; + } - gdcmDocEntry *newDocEntry = (gdcmDocEntry *)0; - gdcmValEntry *newValEntry = (gdcmValEntry *)0; - gdcmBinEntry *newBinEntry = (gdcmBinEntry *)0; - gdcmSeqEntry *newSeqEntry = (gdcmSeqEntry *)0; - //gdcmDictEntry *NewTag = (gdcmDictEntry *)0; - - while (newDocEntry = ReadNextDocEntry())) { - // TODO (?) : liberation du DocEntry ainsi cree, - // apres copie dans un ValEntry, SeqEntry, BinEntry - vr = newDocEntry->getVR(); - - if (vr == "SQ" ) { - // --- SeqEntry - - newSeqEntry = (gdcmSeqEntry *)0; - if (!NewSeqEntry) { - dbg.Verbose(1, "gdcmDocEntrySet::LoadDocEntrySet", - "failed to allocate gdcmSeqEntry"); - return false; - } - newSeqEntry->Copy(newDocEntry); - // TODO - // SEQUENCE; appel 'récursif' de ??? pour charger la 'valeur' - // (ensemble d' ITEMs, en fait, - // chaque ITEM etant chargé avec LoadDocEntrySet) - - SkipDocEntry(newSeqEntry); // voir ce qu'on fait pour une SeQuence - AddDocEntry(newSeqEntry); - - } else if (vr == "AE" || vr == "AS" || vr == "DA" || vr == "PN" || - vr == "UI" || vr == "TM" ) { - // --- ValEntry - - newValEntry = (gdcmValEntry *)0; - if (!NewValEntry) { - dbg.Verbose(1, "gdcmDocEntrySet::LoadDocEntrySet", - "failed to allocate gdcmValEntry"); - return false; - } - newValEntry->Copy(newDocEntry); - SkipDocEntry(newValEntry); - AddDocEntry(newValEntry); - - } else { - // --- BinEntry - - NewBinEntry = new gdcmBinEntry(DictEntry); - if (!NewValEntry) { - dbg.Verbose(1, "gdcmDocEntrySet::LoadDocEntrySet", - "failed to allocate gdcmBinEntry"); - return false; - } - newBinEntry->Copy(newDocEntry); - SkipDocEntry(newBinEntry); - AddDocEntry(newBinEntry); - } - } - rewind(fp); - - - // TODO : il n'y a plus de Chained List qui contient toutes les Entries - // Le chargement des valeurs devra se faire à la volée - // Be carefull : merging this two loops may cause troubles ... - for (ListTag::iterator i = GetListEntry().begin(); - i != GetListEntry().end(); - ++i) - { - LoadDocEntry(*i); - } - rewind(fp); - - // -------------------------------------------------------------- - // 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 = GetEntryByNumber(0x0008, 0x0010); // recognition code - if (RecCode == "ACRNEMA_LIBIDO_1.1" || - RecCode == "CANRME_AILIBOD1_1." ) // for brain-damaged softwares - // with "little-endian strings" - { - filetype = ACR_LIBIDO; - std::string rows = GetEntryByNumber(0x0028, 0x0010); - std::string columns = GetEntryByNumber(0x0028, 0x0011); - SetEntryByNumber(columns, 0x0028, 0x0010); - SetEntryByNumber(rows , 0x0028, 0x0011); - } - // ----------------- End of Special Patch ---------------- - return true; -} + return SetEntryBinArea(content,lgth,entry); +} +/** + * \brief Accesses an existing DocEntry (i.e. a Dicom Element) + * and modifies it's content with the given value. + * @param content new value (string) to substitute with + * @param entry Entry to be modified + */ +bool DocEntrySet::SetEntryString(std::string const &content, DataEntry *entry) +{ + if (entry) + { + entry->SetString(content); + return true; + } + return false; +} +/** + * \brief Accesses an existing DataEntry (i.e. a Dicom Element) + * and modifies it's content with the given value. + * @param content new value (void* -> uint8_t*) to substitute with + * @param entry Entry to be modified + * @param lgth new value length + */ +bool DocEntrySet::SetEntryBinArea(uint8_t *content, int lgth, DataEntry *entry) +{ + if (entry) + { + entry->SetLength(lgth); + entry->SetBinArea(content); + return true; + } + return false; +} /** - * \brief Check the correspondance between the VR of the header entry - * and the taken VR. If they are different, the header entry is - * updated with the new VR. - * @param Entry Header Entry to check - * @param vr Dicom Value Representation - * @return false if the VR is incorrect of if the VR isn't referenced - * otherwise, it returns true -*/ + * \brief Modifies the value of a given Doc Entry (Dicom Element) + * when it exists. Create it with the given value when unexistant. + * @param value (string) Value to be set + * @param group Group number of the Entry + * @param elem Element number of the Entry + * @param vr V(alue) R(epresentation) of the Entry -if private Entry- + * \return pointer to the modified/created Header Entry (NULL when creation + * failed). + */ +DataEntry *DocEntrySet::InsertEntryString(std::string const &value, + uint16_t group, uint16_t elem, + VRKey const &vr ) +{ + DataEntry *dataEntry = 0; + DocEntry *currentEntry = GetDocEntry( group, elem ); + + if (currentEntry) + { + dataEntry = dynamic_cast(currentEntry); + + // Verify the VR + if ( dataEntry ) + if ( dataEntry->GetVR()!=vr ) + dataEntry = NULL; + + // if currentEntry doesn't correspond to the requested dataEntry + if ( !dataEntry) + { + if ( !RemoveEntry(currentEntry) ) + { + gdcmWarningMacro( "Removal of previous DocEntry failed."); + return NULL; + } + } + } -// NE MARCHE PAS EN L'ETAT : -// On a besoin de VR pour 'fabriquer', au choix ValEntry, BinEntry, ou SeqEntry. -// + // Create a new dataEntry if necessary + if ( !dataEntry ) + { + dataEntry = NewDataEntry( group, elem, vr ); -bool gdcmDocEntrySet::CheckEntryVR(gdcmHeaderEntry *Entry, VRKey vr) + if ( !AddEntry(dataEntry) ) + { + gdcmWarningMacro("AddEntry failed although this is a creation."); + dataEntry->Delete(); + return NULL; + } + dataEntry->Delete(); + } + + // Set the dataEntry value + SetEntryString(value, dataEntry); // The std::string value + return dataEntry; +} + +/** + * \brief Modifies the value of a given Header Entry (Dicom Element) + * when it exists. Create it with the given value when unexistant. + * A copy of the binArea is made to be kept in the Document. + * @param binArea (binary) value to be set + * @param lgth length of the Bin Area we want to set + * @param group Group number of the Entry + * @param elem Element number of the Entry + * @param vr V(alue) R(epresentation) of the Entry -if private Entry- + * \return pointer to the modified/created Header Entry (NULL when creation + * failed). + */ +DataEntry *DocEntrySet::InsertEntryBinArea(uint8_t *binArea, int lgth, + uint16_t group, uint16_t elem, + VRKey const &vr ) { - char msg[100]; // for sprintf - bool RealExplicit = true; + DataEntry *dataEntry = 0; + DocEntry *currentEntry = GetDocEntry( group, elem ); + + // Verify the currentEntry + if (currentEntry) + { + dataEntry = dynamic_cast(currentEntry); - // 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 - // first to bytes of the length. Then we will interogate (through find) - // the dicom_vr dictionary with oddities like "\004\0" which crashes - // both GCC and VC++ implementations of the STL map. Hence when the - // expected VR read happens to be non-ascii characters we consider - // we hit falsely explicit VR tag. + // Verify the VR + if ( dataEntry ) + if ( dataEntry->GetVR()!=vr ) + dataEntry = NULL; - if ( (!isalpha(vr[0])) && (!isalpha(vr[1])) ) - RealExplicit = false; + // if currentEntry doesn't correspond to the requested dataEntry + if ( !dataEntry) + { + if ( !RemoveEntry(currentEntry) ) + { + gdcmWarningMacro( "Removal of previous DocEntry failed."); + return NULL; + } + } + } - // 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 && !gdcmGlobal::GetVR()->Count(vr) ) - RealExplicit= false; + // Create a new dataEntry if necessary + if ( !dataEntry) + { + dataEntry = NewDataEntry(group, elem, vr); + + if ( !AddEntry(dataEntry) ) + { + gdcmWarningMacro( "AddEntry failed although this is a creation."); + dataEntry->Delete(); + return NULL; + } + dataEntry->Delete(); + } - if ( !RealExplicit ) + // Set the dataEntry value + uint8_t *tmpArea; + if ( lgth>0 && binArea ) { - // We thought this was explicit VR, but we end up with an - // implicit VR tag. Let's backtrack. - sprintf(msg,"Falsely explicit vr file (%04x,%04x)\n", - Entry->GetGroup(),Entry->GetElement()); - dbg.Verbose(1, "gdcmParser::FindVR: ",msg); - if (Entry->GetGroup()%2 && Entry->GetElement() == 0x0000) { // Group length is UL ! - gdcmDictEntry* NewEntry = NewVirtualDictEntry( - Entry->GetGroup(),Entry->GetElement(), - "UL","FIXME","Group Length"); - Entry->SetDictEntry(NewEntry); + tmpArea = new uint8_t[lgth]; + memcpy(tmpArea,binArea,lgth); + } + else + { + tmpArea = 0; + } + if ( !SetEntryBinArea(tmpArea,lgth,dataEntry) ) + { + if ( tmpArea ) + { + delete[] tmpArea; } - return(false); } + return dataEntry; +} + +/** + * \brief Creates a new gdcm::SeqEntry and adds it to the current DocEntrySet. + * (remove any existing entry with same group,elem) + * @param group Group number of the Entry + * @param elem Element number of the Entry + * \return pointer to the created SeqEntry (NULL when creation + * failed). + */ +SeqEntry *DocEntrySet::InsertSeqEntry(uint16_t group, uint16_t elem) +{ + SeqEntry *seqEntry = 0; + DocEntry *currentEntry = GetDocEntry( group, elem ); + + // Verify the currentEntry + if ( currentEntry ) + { + seqEntry = dynamic_cast(currentEntry); + + // Verify the VR + if ( seqEntry ) + seqEntry = NULL; - if ( Entry->IsVRUnknown() ) + // if currentEntry doesn't correspond to the requested seqEntry + if ( !seqEntry ) + { + if (!RemoveEntry(currentEntry)) + { + gdcmWarningMacro( "Removal of previous DocEntry failed for (" + <GetElement() == 0x0000) { // Group length is UL ! - Entry->SetVR("UL"); - } else { - Entry->SetVR(vr); + seqEntry = NewSeqEntry(group, elem); + + if ( !AddEntry(seqEntry) ) + { + gdcmWarningMacro( "AddEntry failed although this is a creation for (" + <Delete(); + return NULL; } + seqEntry->Delete(); + } + // Remark : + // SequenceDelimitationItem will be added at the end of the SeqEntry, + // at write time + return seqEntry; +} + +/** + * \brief Checks if a given Dicom Element exists within the DocEntrySet + * @param group Group number of the searched Dicom Element + * @param elem Element number of the searched Dicom Element + * @return true is found + */ +bool DocEntrySet::CheckIfEntryExist(uint16_t group, uint16_t elem ) +{ + return GetDocEntry(group,elem)!=NULL; +} + +/** + * \brief Build a new DataEntry from all the low level arguments. + * Check for existence of dictionary entry, and build + * a default one when absent. + * @param group Group number of the new Entry + * @param elem Element number of the new Entry + * @param vr V(alue) R(epresentation) of the new Entry + * \remarks The user of this method must destroy the DataEntry when unused + */ +DataEntry *DocEntrySet::NewDataEntry(uint16_t group,uint16_t elem, + VRKey const &vr) +{ + DictEntry *dictEntry = GetDictEntry(group, elem, vr); + + DataEntry *newEntry = DataEntry::New(dictEntry); + dictEntry->Unregister(); // GetDictEntry register it + if (!newEntry) + { + gdcmWarningMacro( "Failed to allocate DataEntry for (" + <Unregister(); // GetDictEntry register it + if (!newEntry) + { + gdcmWarningMacro( "Failed to allocate SeqEntry for (" + <GetDefaultPubDict(); + if (!pubDict) + { + gdcmWarningMacro( "We SHOULD have a default dictionary"); } - else if ( Entry->GetVR() != vr ) + else { - // The VR present in the file and the dictionary disagree. We assume - // the file writer knew best and use the VR of the file. Since it would - // be unwise to overwrite the VR of a dictionary (since it would - // compromise it's next user), we need to clone the actual DictEntry - // and change the VR for the read one. - gdcmDictEntry* NewEntry = NewVirtualDictEntry( - Entry->GetGroup(),Entry->GetElement(), - vr,"FIXME",Entry->GetName()); - Entry->SetDictEntry(NewEntry); + found = pubDict->GetEntry(group, elem); + if( found ) + found->Register(); } - return(true); + return found; } +/** + * \brief Searches [both] the public [and the shadow dictionary (when they + * exist)] for the presence of the DictEntry with given + * group and element, and create a new virtual DictEntry if necessary + * @param group group number of the searched DictEntry + * @param elem element number of the searched DictEntry + * @param vr V(alue) R(epresentation) to use, if necessary + * @return Corresponding DictEntry when it exists, NULL otherwise. + * \remarks The returned DictEntry is registered + */ +DictEntry *DocEntrySet::GetDictEntry(uint16_t group, uint16_t elem, + VRKey const &vr) +{ + DictEntry *dictEntry = GetDictEntry(group,elem); + DictEntry *goodEntry = dictEntry; + VRKey goodVR = vr; + TagName vm; + if (elem == 0x0000) + goodVR="UL"; + + if ( goodEntry ) + { + if ( goodVR != goodEntry->GetVR() + && goodVR != GDCM_VRUNKNOWN ) + { + gdcmWarningMacro("For (" << std::hex << group << "|" + << elem << "), found VR : [" << vr << "]" + << " expected: [" << goodEntry->GetVR() << "]" ) ; + // avoid confusing further validator with "FIXME" VM + // when possible + vm = dictEntry->GetVM(); + goodEntry = NULL; + } + dictEntry->Unregister(); + } + else + { + vm = "FIXME"; + } + // Create a new virtual DictEntry if necessary + if (!goodEntry) + { + if (dictEntry) + { + + goodEntry = DictEntry::New(group, elem, goodVR, vm,//"FIXME", + dictEntry->GetName() ); + } + else + { + goodEntry = DictEntry::New(group, elem, goodVR); + } + } + else + { + goodEntry->Register(); + } + return goodEntry; +} +//----------------------------------------------------------------------------- +// Private +//----------------------------------------------------------------------------- +// Print //----------------------------------------------------------------------------- +} // end namespace gdcm