X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDictEntry.h;h=2b651f2b6dfc41a781c9caaa97e16e8f2777b56c;hb=536e773e8f72c8e949831abf6496c348d5badf2d;hp=5c6abff303eae3c407bc89e06264bc78c845e9aa;hpb=06c1c583239fdf5196260e6ef83a78669c1bd17f;p=gdcm.git diff --git a/src/gdcmDictEntry.h b/src/gdcmDictEntry.h index 5c6abff3..2b651f2b 100644 --- a/src/gdcmDictEntry.h +++ b/src/gdcmDictEntry.h @@ -1,139 +1,176 @@ -// gdcmDictEntry.h -//----------------------------------------------------------------------------- +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDictEntry.h,v $ + Language: C++ + Date: $Date: 2005/10/18 12:58:27 $ + Version: $Revision: 1.37 $ + + 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" +#include "gdcmVRKey.h" +namespace gdcm +{ //----------------------------------------------------------------------------- -/* - * the gdcmDictEntry in an element contained by the gdcmDict. +/** + * \brief + * 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. + * i.e. the Group number + * the Element number + * - the VR (Value Representation) + * - the VM (Value Multplicity) + * - the corresponding name in english */ -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); - void SetVR(std::string); - - /** - * \ingroup gdcmDictEntry - * \brief tells if the V(alue) R(epresentation) is known (?!) - * - * @return - */ - inline bool gdcmDictEntry::IsVRUnknown() { - if ( vr == "Unknown" ) - return true; - return false; - } - - /** - * \ingroup gdcmDictEntry - * \brief returns the Dicom Group Number of the current gdcmDictEntry - * return the Dicom Group Number - */ - inline guint16 gdcmDictEntry::GetGroup(void) { - return group; - } + DictEntry(uint16_t group, + uint16_t elem, + VRKey const &vr = GDCM_VRUNKNOWN, + TagName const &vm = GDCM_UNKNOWN, + TagName const &name = GDCM_UNKNOWN); + +// Print + void Print(std::ostream &os = std::cout, std::string const &indent = ""); + +// Content of DictEntry + void SetVR(VRKey const &vr); + void SetVM(TagName const &vm); + + /// \brief tells if the V(alue) R(epresentation) is known (?!) + /// @return + bool IsVRUnknown() const { return VR == GDCM_VRUNKNOWN; } + + /// \brief tells if the V(alue) M(ultiplicity) is known (?!) + /// @return + bool IsVMUnknown() const { return VM == GDCM_UNKNOWN; } + + /// \brief Returns the Dicom Group Number of the current DictEntry + /// @return the Dicom Group Number + const uint16_t &GetGroup() const { 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; - } + /// \brief Returns the Dicom Element Number of the current DictEntry + /// @return the Dicom Element Number + const uint16_t &GetElement() const { 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; - } + /// \brief Returns the Dicom Value Representation of the current + /// DictEntry + /// @return the Dicom Value Representation + const VRKey &GetVR() const { 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; - } + /// \brief sets the key of the current DictEntry + /// @param k New key to be set. + void SetKey(TagKey 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 gdcmDictEntry::GetFourth(void) { - 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 gdcmDictEntry::GetName(void) { - return name; - } + /// \brief returns the VM field of the current DictEntry + /// @return The 'Value Multiplicity' field + const TagName &GetVM() const { return VM; } + + /// \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 gdcmDictEntry::GetKey(void) { - return key; - } + /// \brief Gets the key of the current DictEntry + /// @return the key. + const TagKey &GetKey() const { return Key; } + +// Key creation + static TagKey TranslateToKey(uint16_t group, uint16_t elem); private: - // FIXME : were 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. - - // 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; - // }; -}; + /// \todo FIXME + /// where are the group and elem used except from building up + /// a TagKey. If the answer is nowhere then there is no need + /// to store the group and elem independently. + /// + /// --> EVERYWHERE ! The alternate question would be : + /// What's TagKey used for ? + + /// DicomGroup number + uint16_t Group; // e.g. 0x0010 + /// DicomElement number + 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) + /// "PN" short for "Person Name" + VRKey VR; + + /* + * . + * Formerly 'Group name abbreviations' + * 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 + * . + */ + /// \brief Value Multiplicity (e.g. "1", "1-n", "6") + TagName VM; + + /// e.g. "Patient's Name" + TagName Name; + + /// Redundant with (group, elem) but we add it for efficiency purpose. + TagKey Key; +}; +} // end namespace gdcm //----------------------------------------------------------------------------- #endif