1 /*=========================================================================
4 Module: $RCSfile: gdcmDictEntry.h,v $
6 Date: $Date: 2004/10/18 02:35:35 $
7 Version: $Revision: 1.20 $
9 Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
10 l'Image). All rights reserved. See Doc/License.txt or
11 http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
13 This software is distributed WITHOUT ANY WARRANTY; without even
14 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 PURPOSE. See the above copyright notices for more information.
17 =========================================================================*/
19 #ifndef GDCMDICTENTRY_H
20 #define GDCMDICTENTRY_H
22 #include "gdcmCommon.h"
27 //-----------------------------------------------------------------------------
31 * the DictEntry in an element contained by the Dict.
33 * - the key referenced by the DICOM norm or the constructor (for private keys)
34 * - the corresponding name in english (it's equivalent to a label)
38 class GDCM_EXPORT DictEntry
41 DictEntry(uint16_t group,
43 TagName const & vr = "Unknown",
44 TagName const & fourth = "Unknown",
45 TagName const & name = "Unknown");
47 static TagKey TranslateToKey(uint16_t group, uint16_t element);
49 void SetVR(TagName const & vr);
51 /// \brief tells if the V(alue) R(epresentation) is known (?!)
53 bool IsVRUnknown() { return VR == "??"; }
55 /// \brief Returns the Dicom Group Number of the current DictEntry
56 /// @return the Dicom Group Number
57 uint16_t GetGroup() { return Group; }
59 /// \brief Returns the Dicom Element Number of the current DictEntry
60 /// @return the Dicom Element Number
61 uint16_t GetElement() { return Element; }
63 /// \brief Returns the Dicom Value Representation of the current
65 /// @return the Dicom Value Representation
66 const TagName & GetVR() const { return VR; }
68 /// \brief sets the key of the current DictEntry
69 /// @param k New key to be set.
70 void SetKey(TagName const & k) { Key = k; }
72 /// \brief returns the Fourth field of the current DictEntry
73 /// \warning NOT part of the Dicom Standard.
74 /// May be REMOVED an any time. NEVER use it.
75 /// @return The Fourth field
76 const TagName & GetFourth() const { return Fourth; }
78 /// \brief Returns the Dicom Name of the current DictEntry
79 /// e.g. "Patient Name" for Dicom Tag (0x0010, 0x0010)
80 /// @return the Dicom Name
81 const TagName & GetName() const { return Name; }
83 /// \brief Gets the key of the current DictEntry
85 const TagName & GetKey() const { return Key; }
89 /// where are the group and element used except from building up
90 /// a TagKey. If the answer is nowhere then there is no need
91 /// to store the group and element independently.
93 /// --> EVERYWHERE ! The alternate question would be :
94 /// What's TagKey used for ?
97 uint16_t Group; // e.g. 0x0010
99 /// DicomElement number
100 uint16_t Element; // e.g. 0x0103
102 /// \brief Value Representation i.e. some clue about the nature
103 /// of the data represented e.g. "FD" short for
104 /// "Floating Point Double" (see \ref VR)
108 * \brief AVOID using the following fourth field at all costs.
110 * They are at least two good reasons for NOT using fourth:
111 * - the main reason is that it is NOT part of the 'official'
113 * - a second reason is that it is not defined for all the groups.
115 * Still it provides some semantics as group name abbreviation that
116 * can prove of some help when organizing things in an interface.
117 * For the time being we keep it in gdcm but it migth be removed in
118 * future releases it proves to be source of confusion.
119 * Here is a small dictionary we encountered in "nature":
121 * - META Meta Information
133 * - NMI Nuclear Medicine
135 * - BFS Basic Film Session
136 * - BFB Basic Film Box
137 * - BIB Basic Image Box
152 * Other usefull abreviations used for Radiographic view associated with
153 * Patient Position (0018,5100):
154 * - AP = Anterior/Posterior
155 * - PA = Posterior/Anterior
156 * - LL = Left Lateral
157 * - RL = Right Lateral
158 * - RLD = Right Lateral Decubitus
159 * - LLD = Left Lateral Decubitus
160 * - RLO = Right Lateral Oblique
161 * - LLO = Left Lateral Oblique
166 /// e.g. "Patient's Name"
169 /// Redundant with (group, element) but we add it for efficiency purpose.
172 } // end namespace gdcm
173 //-----------------------------------------------------------------------------