update

[gdcm.git] / src / gdcmDictEntry.h

diff --git a/src/gdcmDictEntry.h b/src/gdcmDictEntry.h
index cd329bd1d969134b2b829e7eda7891c50c309dda..affbd53d4438c8561fce349b41f67c282bd70f78 100644 (file)
--- a/src/gdcmDictEntry.h
+++ b/src/gdcmDictEntry.h
@@ -102,21 +102,77 @@ private:
    guint16 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"
+   /**
+    * \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;
                                                
-       // CLEANME: find the official dicom name for this field !
-       
-   ///Fourth field containing some semantics.
-   ///(Group Name abbr.)
-   /// DON'T USER ANY LONGER ! 
+   /**
+    * \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_Name"                    
+
+   /// e.g. "Patient's Name"                    
    std::string name;      
-   /// Redundant with (group, element) but we add it
-   /// on efficiency purposes.
+
+   /// 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