X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDictEntry.h;h=ab4b95f4827b8d96ea011eedc97e245e3e3d84e0;hb=327dfe7647e3720b0f3125f9b19397cb9afc0ed3;hp=cd329bd1d969134b2b829e7eda7891c50c309dda;hpb=55d77e0913ff360d639af1841c70d14dc8687584;p=gdcm.git diff --git a/src/gdcmDictEntry.h b/src/gdcmDictEntry.h index cd329bd1..ab4b95f4 100644 --- a/src/gdcmDictEntry.h +++ b/src/gdcmDictEntry.h @@ -1,138 +1,174 @@ -// gdcmDictEntry.h -//----------------------------------------------------------------------------- +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDictEntry.h,v $ + Language: C++ + Date: $Date: 2005/01/06 20:03:27 $ + Version: $Revision: 1.24 $ + + 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. + +=========================================================================*/ + #ifndef GDCMDICTENTRY_H #define GDCMDICTENTRY_H -#include "gdcmCommon.h" +#include "gdcmBase.h" + +namespace gdcm +{ //----------------------------------------------------------------------------- /* - * \defgroup gdcmDictEntry + * \defgroup DictEntry * \brief - * the gdcmDictEntry in an element contained by the gdcmDict. + * the DictEntry in an element contained by the Dict. * It contains : * - the key referenced by the DICOM norm or the constructor (for private keys) * - the corresponding name in english (it's equivalent to a label) * - the owner group * - etc. */ -class GDCM_EXPORT gdcmDictEntry +class GDCM_EXPORT DictEntry : public Base { public: - gdcmDictEntry(guint16 group, - guint16 element, - std::string vr = "Unknown", - std::string fourth = "Unknown", - std::string name = "Unknown"); - - static TagKey TranslateToKey(guint16 group, guint16 element); + DictEntry(uint16_t group, + uint16_t element, + TagName const &vr = GDCM_UNKNOWN, + TagName const &fourth = GDCM_UNKNOWN, + TagName const &name = GDCM_UNKNOWN); - void SetVR(std::string); + static TagKey TranslateToKey(uint16_t group, uint16_t element); - /** - * \ingroup gdcmDictEntry - * \brief tells if the V(alue) R(epresentation) is known (?!) - * - * @return - */ - inline bool IsVRUnknown() {return vr == "??"; } + void SetVR(TagName const &vr); - /** - * \ingroup gdcmDictEntry - * \brief returns the Dicom Group Number of the current gdcmDictEntry - * return the Dicom Group Number - */ - inline guint16 GetGroup(void) { return group; } + /// \brief tells if the V(alue) R(epresentation) is known (?!) + /// @return + bool IsVRUnknown() { return VR == GDCM_UNKNOWN; } + + /// \brief Returns the Dicom Group Number of the current DictEntry + /// @return the Dicom Group Number + uint16_t GetGroup() { return Group; } - /** - * \ingroup gdcmDictEntry - * \brief returns the Dicom Element Number of the current gdcmDictEntry - * return the Dicom Element Number - */ - inline guint16 GetElement(void) { return element; } + /// \brief Returns the Dicom Element Number of the current DictEntry + /// @return the Dicom Element Number + uint16_t GetElement() { return Element; } - /** - * \ingroup gdcmDictEntry - * \brief returns the Dicom Value Representation of the current gdcmDictEntry - * return the Dicom Value Representation - */ - inline std::string GetVR(void) { return vr; } + /// \brief Returns the Dicom Value Representation of the current + /// DictEntry + /// @return the Dicom Value Representation + const TagName &GetVR() const { return VR; } - /** - * \ingroup gdcmDictEntry - * \brief sets the key of the current gdcmDictEntry - * @param k New key to be set. - */ - inline void SetKey(std::string k) { key = k; } + /// \brief sets the key of the current DictEntry + /// @param k New key to be set. + void SetKey(TagName const &k) { Key = k; } - /** - * \ingroup gdcmDictEntry - * \brief returns the Fourth field of the current gdcmDictEntry - * \warning NOT part of the Dicom Standard - * \ May be REMOVED an any time - * \ NEVER use it - * return the Fourth field - */ - inline std::string GetFourth(void) { return fourth; } + /// \brief returns the Fourth field of the current DictEntry + /// \warning NOT part of the Dicom Standard. + /// May be REMOVED an any time. NEVER use it. + /// @return The Fourth field + const TagName &GetFourth() const { return Fourth; } - /** - * \ingroup gdcmDictEntry - * \brief returns the Dicom Name of the current gdcmDictEntry - * \ e.g. "Patient Name" for Dicom Tag (0x0010, 0x0010) - * return the Dicom Name - */ - inline std::string GetName(void) { return name; } + /// \brief Returns the Dicom Name of the current DictEntry + /// e.g. "Patient Name" for Dicom Tag (0x0010, 0x0010) + /// @return the Dicom Name + const TagName &GetName() const { return Name; } - /** - * \ingroup gdcmDictEntry - * \brief Gets the key of the current gdcmDictEntry - * @return the key . - */ - inline std::string GetKey(void) { return key; } + /// \brief Gets the key of the current DictEntry + /// @return the key. + const TagName &GetKey() const { return Key; } private: - // 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. - // - // --> EVERYWHERE ! The alternate question would be : - // What's TagKey used for ? + /// \todo 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. + /// + /// --> EVERYWHERE ! The alternate question would be : + /// What's TagKey used for ? /// DicomGroup number - guint16 group; // e.g. 0x0010 + uint16_t Group; // e.g. 0x0010 + /// DicomElement number - guint16 element; // e.g. 0x0103 - /// Value Representation i.e. some clue about the nature - /// of the data represented e.g. "FD" short for - /// "Floating Point Double" - std::string vr; - - // CLEANME: find the official dicom name for this field ! - - ///Fourth field containing some semantics. - ///(Group Name abbr.) - /// DON'T USER ANY LONGER ! - std::string fourth; - /// e.g. "Patient_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 { - // Uint16 upperGroup; - // Uint16 upperElement; - // DcmEVR evr; - // const char* tagName; - // int vmMin; - // int vmMax; - // const char* standardVersion; - // DcmDictRangeRestriction groupRestriction; - // DcmDictRangeRestriction elementRestriction; - // }; -}; + uint16_t Element; // e.g. 0x0103 + + /// \brief Value Representation i.e. some clue about the nature + /// of the data represented e.g. "FD" short for + /// "Floating Point Double" (see \ref VR) + TagName VR; + /** + * \brief AVOID using the following fourth field at all costs. + * + * They are at least 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 + * . + */ + TagName Fourth; + + /// e.g. "Patient's Name" + TagName Name; + + /// Redundant with (group, element) but we add it for efficiency purpose. + TagKey Key; +}; +} // end namespace gdcm //----------------------------------------------------------------------------- #endif