X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmDictEntry.h;h=240c106665a0ce2b8a6ce1fa71f0ccb54fd57990;hb=7815fe9dc3532b716dc478ca0f255263f99d296f;hp=6b21209977ce20947e7df07075831bae83969d9f;hpb=5a6910a313a526514242a21b868c7186fca14168;p=gdcm.git diff --git a/src/gdcmDictEntry.h b/src/gdcmDictEntry.h index 6b212099..240c1066 100644 --- a/src/gdcmDictEntry.h +++ b/src/gdcmDictEntry.h @@ -1,11 +1,30 @@ -// gdcmDictEntry.h +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmDictEntry.h,v $ + Language: C++ + Date: $Date: 2004/07/02 13:55:27 $ + Version: $Revision: 1.15 $ + + 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 #include "gdcmCommon.h" +//----------------------------------------------------------------------------- /* + * \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) @@ -13,139 +32,140 @@ * - the owner group * - etc. */ -class GDCM_EXPORT gdcmDictEntry { -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; - // }; +class GDCM_EXPORT gdcmDictEntry +{ public: - gdcmDictEntry(guint16 group, - guint16 element, + gdcmDictEntry(uint16_t group, + uint16_t element, std::string vr = "Unknown", std::string fourth = "Unknown", std::string name = "Unknown"); - - static TagKey TranslateToKey(guint16 group, guint16 element); - -// bool IsVrUnknown(void); - -// inline guint16 GetGroup(void); -// inline guint16 GetElement(void); -// inline std::string GetVR(void); - void SetVR(std::string); -// inline void SetKey(std::string k); -// inline std::string GetFourth(void); -// inline std::string GetName(void); -// inline std::string GetKey(void); + static gdcmTagKey TranslateToKey(uint16_t group, uint16_t 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; -} - + /// \brief tells if the V(alue) R(epresentation) is known (?!) + /// @return + 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; - } + /// \brief Returns the Dicom Group Number of the current gdcmDictEntry + /// @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 gdcmDictEntry::GetElement(void) { - return element; - } + /// \brief Returns the Dicom Element Number of the current gdcmDictEntry + /// @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 gdcmDictEntry::GetVR(void) { - return vr; - } + /// \brief Returns the Dicom Value Representation of the current + /// gdcmDictEntry + /// @return the Dicom Value Representation + std::string GetVR() { 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 gdcmDictEntry + /// @param k New key to be set. + void SetKey(std::string 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; - } + /// \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 + std::string 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 Dicom Name of the current gdcmDictEntry + /// e.g. "Patient Name" for Dicom Tag (0x0010, 0x0010) + /// @return the Dicom Name + 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; - } + /// \brief Gets the key of the current gdcmDictEntry + /// @return the key. + std::string GetKey(void) { return key; } + +private: + /// \todo FIXME + /// where are the group and element used except from building up + /// a gdcmTagKey. 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 gdcmTagKey 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 gdcmVR) + 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. + gdcmTagKey key; }; +//----------------------------------------------------------------------------- #endif