X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDocEntrySet.cxx;h=5835a8f34ae7c03c29ff9372237e426980cc7d61;hb=8d10ccb6794a0f22234983990e2181a24625fbd8;hp=d60f1dbef0bd11bf39ea43d0728c6b58cd570bfd;hpb=e49dda75179644e228e33af72931535878799dff;p=gdcm.git diff --git a/src/gdcmDocEntrySet.cxx b/src/gdcmDocEntrySet.cxx index d60f1dbe..5835a8f3 100644 --- a/src/gdcmDocEntrySet.cxx +++ b/src/gdcmDocEntrySet.cxx @@ -1,221 +1,309 @@ -// gdcmDocEntrySet.cxx -//----------------------------------------------------------------------------- -// +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDocEntrySet.cxx,v $ + Language: C++ + Date: $Date: 2004/12/03 20:16:58 $ + Version: $Revision: 1.27 $ + + 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 "gdcmDebug.h" +#include "gdcmCommon.h" +#include "gdcmDictSet.h" +#include "gdcmGlobal.h" #include "gdcmException.h" +#include "gdcmDocEntry.h" +#include "gdcmSeqEntry.h" +#include "gdcmValEntry.h" +#include "gdcmBinEntry.h" + +namespace gdcm +{ //----------------------------------------------------------------------------- -// Constructor / Destructor +// Public + /** - * \ingroup gdcmDocEntrySEt - * \brief Constructor from a given gdcmDocEntrySet + * \brief Build a new Val Entry 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 underlying DictEntry + * @param elem element number of the underlying DictEntry */ -gdcmDocEntrySet::gdcmDocEntrySet() { +ValEntry *DocEntrySet::NewValEntryByNumber(uint16_t group, + uint16_t elem) +{ + // Find out if the tag we encountered is in the dictionaries: + DictEntry *dictEntry = GetDictEntryByNumber(group, elem); + if (!dictEntry) + { + dictEntry = NewVirtualDictEntry(group, elem); + } + + ValEntry *newEntry = new ValEntry(dictEntry); + if (!newEntry) + { + dbg.Verbose(1, "Document::NewValEntryByNumber", + "failed to allocate ValEntry"); + return 0; + } + return newEntry; } + + /** - * \brief Canonical destructor. + * \brief Build a new Bin Entry 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 underlying DictEntry + * @param elem element number of the underlying DictEntry */ -gdcmDocEntrySet::~gdcmDocEntrySet(){ +BinEntry *DocEntrySet::NewBinEntryByNumber(uint16_t group, + uint16_t elem) +{ + // Find out if the tag we encountered is in the dictionaries: + DictEntry *dictEntry = GetDictEntryByNumber(group, elem); + if (!dictEntry) + { + dictEntry = NewVirtualDictEntry(group, elem); + } + + BinEntry *newEntry = new BinEntry(dictEntry); + if (!newEntry) + { + dbg.Verbose(1, "Document::NewBinEntryByNumber", + "failed to allocate BinEntry"); + return 0; + } + return newEntry; } -//----------------------------------------------------------------------------- -// Print -/* - * \ingroup gdcmDocEntrySet - * \brief canonical Printer + +/** + * \brief Build a new Seq Entry 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 underlying DictEntry + * @param Elem element number of the underlying DictEntry */ +SeqEntry* DocEntrySet::NewSeqEntryByNumber(uint16_t Group, + uint16_t Elem) +{ + // Find out if the tag we encountered is in the dictionaries: + DictEntry* DictEntry = GetDictEntryByNumber( Group, Elem ); + if ( ! DictEntry ) + { + DictEntry = NewVirtualDictEntry(Group, Elem); + } + SeqEntry *NewEntry = new SeqEntry( DictEntry ); + if ( !NewEntry ) + { + dbg.Verbose(1, "Document::NewSeqEntryByNumber", + "failed to allocate SeqEntry"); + return 0; + } + return NewEntry; +} //----------------------------------------------------------------------------- -// Public +// Protected +/** + * \brief Gets a Dicom Element inside a SQ Item Entry, by name + * @param name of the element to be found. + * @return + */ +DocEntry* DocEntrySet::GetDocEntryByName( TagName const & name ) +{ + Dict *pubDict = Global::GetDicts()->GetDefaultPubDict(); + DictEntry *dictEntry = pubDict->GetDictEntryByName(name); + if( !dictEntry ) + { + return 0; + } -//----------------------------------------------------------------------------- -// Protected + return GetDocEntryByNumber(dictEntry->GetGroup(),dictEntry->GetElement()); +} -//----------------------------------------------------------------------------- -// Private /** - * \brief Parses an EntrySet (Document header or SQ Item ) - * \ and load element values (a voir !) - * @return false anything wrong happens + * \brief Get the value of a Dicom Element inside a SQ Item Entry, by name + * @param name : name of the searched element. + * @return + */ + +std::string DocEntrySet::GetEntryByName(TagName const & name) +{ + Dict *pubDict = Global::GetDicts()->GetDefaultPubDict(); + DictEntry *dictEntry = pubDict->GetDictEntryByName(name); + + if( !dictEntry ) + { + return GDCM_UNFOUND; + } + + return GetEntryByNumber(dictEntry->GetGroup(), dictEntry->GetElement()); +} + + +/** + * \brief Request a new virtual dict entry to the dict set + * @param group group number of the underlying DictEntry + * @param element element number of the underlying DictEntry + * @param vr VR of the underlying DictEntry + * @param fourth owner group + * @param name english name + */ +DictEntry* DocEntrySet::NewVirtualDictEntry( uint16_t group, + uint16_t element, + TagName const & vr, + TagName const & fourth, + TagName const & name ) +{ + return Global::GetDicts()->NewVirtualDictEntry(group,element,vr,fourth,name); +} + +/** \brief + * Creates a new DocEntry (without any 'value' ...) + * @param group group number of the underlying DictEntry + * @param elem elem number of the underlying DictEntry */ -bool gdcmDocEntrySet::LoadDocEntrySet(bool exception_on_error) - throw(gdcmFormatError) { - (void)exception_on_error; - - 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; +DocEntry* DocEntrySet::NewDocEntryByNumber(uint16_t group, + uint16_t elem) +{ + // Find out if the tag we encountered is in the dictionaries: + Dict *pubDict = Global::GetDicts()->GetDefaultPubDict(); + DictEntry *dictEntry = pubDict->GetDictEntryByNumber(group, elem); + if (!dictEntry) + { + dictEntry = NewVirtualDictEntry(group, elem); + } + + DocEntry *newEntry = new DocEntry(dictEntry); + if (!newEntry) + { + dbg.Verbose(1, "SQItem::NewDocEntryByNumber", + "failed to allocate DocEntry"); + return 0; + } + return newEntry; } +/** \brief + * Creates a new DocEntry (without any 'value' ...) + * @param group group number of the underlying DictEntry + * @param elem elem number of the underlying DictEntry + * @param vr V(alue) R(epresentation) of the Entry -if private Entry- + */ +DocEntry* DocEntrySet::NewDocEntryByNumber(uint16_t group, uint16_t elem, + TagName const & vr) +{ + // Find out if the tag we encountered is in the dictionaries: + Dict *pubDict = Global::GetDicts()->GetDefaultPubDict(); + DictEntry *dictEntry = pubDict->GetDictEntryByNumber(group, elem); + if (!dictEntry) + { + dictEntry = NewVirtualDictEntry(group, elem, vr); + } + + DocEntry *newEntry = new DocEntry(dictEntry); + if (!newEntry) + { + dbg.Verbose(1, "SQItem::NewDocEntryByNumber", + "failed to allocate DocEntry"); + return 0; + } + return newEntry; +} +/* \brief + * Probabely move, as is, to DocEntrySet, as a non virtual method + * and remove Document::NewDocEntryByName + */ +DocEntry *DocEntrySet::NewDocEntryByName(TagName const & name) +{ + Dict *pubDict = Global::GetDicts()->GetDefaultPubDict(); + DictEntry *newTag = pubDict->GetDictEntryByName(name); + if (!newTag) + { + newTag = NewVirtualDictEntry(0xffff, 0xffff, "LO", "unkn", name); + } + + DocEntry* newEntry = new DocEntry(newTag); + if (!newEntry) + { + dbg.Verbose(1, "SQItem::ObtainDocEntryByName", + "failed to allocate DocEntry"); + return 0; + } + + return newEntry; +} + /** - * \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 -*/ - -// NE MARCHE PAS EN L'ETAT : -// On a besoin de VR pour 'fabriquer', au choix ValEntry, BinEntry, ou SeqEntry. -// - -bool gdcmDocEntrySet::CheckEntryVR(gdcmHeaderEntry *Entry, VRKey vr) + * \brief Searches both the public and the shadow dictionary (when they + * exist) for the presence of the DictEntry with given name. + * The public dictionary has precedence on the shadow one. + * @param name Name of the searched DictEntry + * @return Corresponding DictEntry when it exists, NULL otherwise. + */ +DictEntry *DocEntrySet::GetDictEntryByName(TagName const & name) { - char msg[100]; // for sprintf - bool RealExplicit = true; - - // 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. - - if ( (!isalpha(vr[0])) && (!isalpha(vr[1])) ) - RealExplicit = false; - - // 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; - - if ( !RealExplicit ) - { - // 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); - } - return(false); - } - - if ( Entry->IsVRUnknown() ) - { - // When not a dictionary entry, we can safely overwrite the VR. - if (Entry->GetElement() == 0x0000) { // Group length is UL ! - Entry->SetVR("UL"); - } else { - Entry->SetVR(vr); - } - } - else if ( Entry->GetVR() != vr ) - { - // 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); - } - return(true); + DictEntry *found = 0; + Dict *pubDict = Global::GetDicts()->GetDefaultPubDict(); + if (!pubDict) + { + dbg.Verbose(0, "Document::GetDictEntry", + "we SHOULD have a default dictionary"); + } + else + { + found = pubDict->GetDictEntryByName(name); + } + 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. The public dictionary has precedence on the + * shadow one. + * @param group group number of the searched DictEntry + * @param element element number of the searched DictEntry + * @return Corresponding DictEntry when it exists, NULL otherwise. + */ +DictEntry *DocEntrySet::GetDictEntryByNumber(uint16_t group, + uint16_t element) +{ + DictEntry *found = 0; + Dict *pubDict = Global::GetDicts()->GetDefaultPubDict(); + if (!pubDict) + { + dbg.Verbose(0, "Document::GetDictEntry", + "we SHOULD have a default dictionary"); + } + else + { + found = pubDict->GetDictEntryByNumber(group, element); + } + return found; } +//----------------------------------------------------------------------------- +// Private +} // end namespace gdcm //-----------------------------------------------------------------------------