X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDictEntry.h;h=fda8b998202a0acba57912461d2ff866362022ba;hb=45a9005ae5c1975bbe932e43c8080a83c9daf29e;hp=5c6abff303eae3c407bc89e06264bc78c845e9aa;hpb=06c1c583239fdf5196260e6ef83a78669c1bd17f;p=gdcm.git diff --git a/src/gdcmDictEntry.h b/src/gdcmDictEntry.h index 5c6abff3..fda8b998 100644 --- a/src/gdcmDictEntry.h +++ b/src/gdcmDictEntry.h @@ -1,5 +1,21 @@ -// gdcmDictEntry.h -//----------------------------------------------------------------------------- +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDictEntry.h,v $ + Language: C++ + Date: $Date: 2004/06/20 18:08:47 $ + Version: $Revision: 1.14 $ + + Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de + l'Image). All rights reserved. See Doc/License.txt or + http://www.creatis.insa-lyon.fr/Public/Gdcm/License.htm for details. + + 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. + +=========================================================================*/ + #ifndef GDCMDICTENTRY_H #define GDCMDICTENTRY_H @@ -7,6 +23,8 @@ //----------------------------------------------------------------------------- /* + * \defgroup gdcmDictEntry + * \brief * the gdcmDictEntry in an element contained by the gdcmDict. * It contains : * - the key referenced by the DICOM norm or the constructor (for private keys) @@ -14,7 +32,8 @@ * - the owner group * - etc. */ -class GDCM_EXPORT gdcmDictEntry { +class GDCM_EXPORT gdcmDictEntry +{ public: gdcmDictEntry(guint16 group, guint16 element, @@ -23,6 +42,7 @@ public: std::string name = "Unknown"); static TagKey TranslateToKey(guint16 group, guint16 element); + void SetVR(std::string); /** @@ -31,47 +51,35 @@ public: * * @return */ - inline bool gdcmDictEntry::IsVRUnknown() { - if ( vr == "Unknown" ) - return true; - return false; - } + inline bool IsVRUnknown() {return vr == "??"; } /** * \ingroup gdcmDictEntry * \brief returns the Dicom Group Number of the current gdcmDictEntry * return the Dicom Group Number */ - inline guint16 gdcmDictEntry::GetGroup(void) { - return group; - } + inline guint16 GetGroup(void) { return group; } /** * \ingroup gdcmDictEntry * \brief returns the Dicom Element Number of the current gdcmDictEntry * return the Dicom Element Number */ - inline guint16 gdcmDictEntry::GetElement(void) { - return element; - } + inline guint16 GetElement(void) { return element; } /** * \ingroup gdcmDictEntry * \brief returns the Dicom Value Representation of the current gdcmDictEntry * return the Dicom Value Representation */ - inline std::string gdcmDictEntry::GetVR(void) { - return vr; - } + inline std::string GetVR(void) { return vr; } /** * \ingroup gdcmDictEntry * \brief sets the key of the current gdcmDictEntry * @param k New key to be set. */ - inline void gdcmDictEntry::SetKey(std::string k) { - key = k; - } + inline void SetKey(std::string k) { key = k; } /** * \ingroup gdcmDictEntry @@ -81,9 +89,7 @@ public: * \ NEVER use it * return the Fourth field */ - inline std::string gdcmDictEntry::GetFourth(void) { - return fourth; - } + inline std::string GetFourth(void) { return fourth; } /** * \ingroup gdcmDictEntry @@ -91,35 +97,100 @@ public: * \ e.g. "Patient Name" for Dicom Tag (0x0010, 0x0010) * return the Dicom Name */ - inline std::string gdcmDictEntry::GetName(void) { - return name; - } + inline std::string GetName(void) { return name; } /** * \ingroup gdcmDictEntry * \brief Gets the key of the current gdcmDictEntry * @return the key . */ - inline std::string gdcmDictEntry::GetKey(void) { - return key; - } + inline std::string GetKey(void) { return key; } private: - // FIXME : were are the group and element used except from building up + // FIXME : where are the group and element used except from building up // a TagKey. If the answer is nowhere then there is no need // to store the group and element independently. - guint16 group; // e.g. 0x0010 - guint16 element; // e.g. 0x0103 - std::string vr; // Value Representation i.e. some clue about the nature - // of the data represented e.g. "FD" short for - // "Floating Point Double" - // CLEANME: find the official dicom name for this field ! - std::string fourth; // Fourth field containing some semantics. - //(Group Name abbr.) - std::string name; // e.g. "Patient_Name" - TagKey key; // Redundant with (group, element) but we add it - // on efficiency purposes. + // + // --> EVERYWHERE ! The alternate question would be : + // What's TagKey used for ? + + /// DicomGroup number + guint16 group; // e.g. 0x0010 + /// DicomElement number + guint16 element; // e.g. 0x0103 + /** + * \ingroup gdcmDictEntry + * \brief Value Representation i.e. some clue about the nature + * of the data represented + * e.g. "FD" short for "Floating Point Double" + */ + std::string vr; + + /** + * \brief AVOID using the following fourth field at all costs. + * + * They are at leat two good reasons for NOT using fourth: + * - the main reason is that it is NOT part of the 'official' + * Dicom Dictionnary. + * - a second reason is that it is not defined for all the groups. + * . + * Still it provides some semantics as group name abbreviation that + * can prove of some help when organizing things in an interface. + * For the time being we keep it in gdcm but it migth be removed in + * future releases it proves to be source of confusion. + * Here is a small dictionary we encountered in "nature": + * - 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 + * . + * + * Other usefull abreviations used for Radiographic view associated with + * Patient Position (0018,5100): + * - AP = Anterior/Posterior + * - PA = Posterior/Anterior + * - LL = Left Lateral + * - RL = Right Lateral + * - RLD = Right Lateral Decubitus + * - LLD = Left Lateral Decubitus + * - RLO = Right Lateral Oblique + * - LLO = Left Lateral Oblique + * . + */ + std::string fourth; + + /// e.g. "Patient's Name" + std::string name; + /// Redundant with (group, element) but we add it on efficiency purposes. + TagKey key; + // DCMTK has many fields for handling a DictEntry (see below). What are the // relevant ones for gdcmlib ? // struct DBI_SimpleEntry {