src/gdcmCommon.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmCommon.h,v $
   5   Language:  C++
   6   Date:      $Date: 2006/01/24 19:58:13 $
   7   Version:   $Revision: 1.104 $
   8
   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.
  12
  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.
  16
  17 =========================================================================*/
  18
  19 #ifndef GDCMCOMMON_H
  20 #define GDCMCOMMON_H
  21
  22 #include "gdcmConfigure.h"
  23 #include "gdcmSystem.h"
  24 #include "gdcmMacro.h"
  25
  26 #include <string>
  27
  28 //-----------------------------------------------------------------------------
  29 #if defined(_WIN32) && defined(BUILD_SHARED_LIBS)
  30   #ifdef gdcm_EXPORTS
  31     #define GDCM_EXPORT __declspec( dllexport )
  32   #else
  33     #define GDCM_EXPORT __declspec( dllimport )
  34   #endif
  35 #else
  36   #define GDCM_EXPORT
  37 #endif
  38
  39 //-----------------------------------------------------------------------------
  40 /// \brief namespace for Grass root DiCoM
  41 namespace gdcm
  42 {
  43
  44 // Centralize information about the gdcm dictionary in only one file:
  45 #ifndef PUB_DICT_PATH
  46 #  define PUB_DICT_PATH   "../Dicts/"
  47 #endif
  48 #define PUB_DICT_NAME     "DicomV3Dict"
  49 #define PUB_DICT_FILENAME "gdcm.dic"
  50 #define DICT_ELEM         "DicomDir.dic"
  51 #define DICT_TS           "dicomTS.dic"
  52 #define DICT_VR           "dicomVR.dic"
  53 #define DICT_GROUP_NAME   "DictGroupName.dic"
  54
  55 GDCM_EXPORT extern const std::string GDCM_UNKNOWN;
  56 GDCM_EXPORT extern const std::string GDCM_UNFOUND;
  57 GDCM_EXPORT extern const std::string GDCM_BINLOADED;
  58 GDCM_EXPORT extern const std::string GDCM_NOTLOADED;
  59 GDCM_EXPORT extern const std::string GDCM_UNREAD;
  60 GDCM_EXPORT extern const std::string GDCM_NOTASCII;
  61 GDCM_EXPORT extern const std::string GDCM_PIXELDATA;
  62
  63 GDCM_EXPORT extern const std::string GDCM_VRUNKNOWN;
  64
  65 GDCM_EXPORT extern const char GDCM_FILESEPARATOR;
  66
  67 /// \brief TagKey is made to hold the standard Dicom Tag
  68 ///               (Group number, Element number)
  69 /// Instead of using the two '16 bits integers' as the Hask Table key, we
  70 /// converted into a string (e.g. 0x0018,0x0050 converted into "0018|0050")
  71 /// It appears to be a huge waste of time.
  72 /// We'll fix the mess up -without any change in the API- as soon as the bench
  73 /// marks are fully performed.
  74
  75 #if defined(_MSC_VER) && (_MSC_VER == 1200)
  76 // Doing everything within gdcm namespace to avoid polluting 3d party software
  77 inline std::ostream& operator<<(std::ostream& _O, std::string _val)
  78 {
  79   return _O << _val.c_str();
  80 }
  81 #endif
  82
  83 /// \brief TagName is made to hold the 'non hexa" fields (VR, VM, Name)
  84 ///        of Dicom Entries
  85 typedef std::string TagName;
  86
  87 /// \brief various types of a DICOM file (for internal use only)
  88 enum FileType {
  89    Unknown = 0,
  90    ExplicitVR, // DicomDir is in this case. Except when it's ImplicitVR !...
  91    ImplicitVR,
  92    ACR,
  93    ACR_LIBIDO,
  94    JPEG
  95 };
  96
  97 /// \brief type of the elements composing a DICOMDIR (for internal use only)
  98 enum DicomDirType {
  99    DD_UNKNOWN = 0,
 100    DD_META,
 101    DD_PATIENT,
 102    DD_STUDY,
 103    DD_SERIE,
 104    DD_IMAGE,
 105    DD_VISIT
 106 };
 107
 108 /// \brief comparison operators (as used in SerieHelper::AddRestriction() )
 109 enum CompOperators {
 110    GDCM_EQUAL = 0,
 111    GDCM_DIFFERENT,
 112    GDCM_GREATER,
 113    GDCM_GREATEROREQUAL,
 114    GDCM_LESS,
 115    GDCM_LESSOREQUAL
 116 };
 117
 118 /// \brief Loading mode
 119 enum LodModeType
 120 {
 121    LD_ALL         = 0x00000000, // Load all
 122    LD_NOSEQ       = 0x00000001, // Don't load Sequences
 123    LD_NOSHADOW    = 0x00000002, // Don't load odd groups
 124    LD_NOSHADOWSEQ = 0x00000004  // Don't load Sequences if they belong
 125                                 //            to an odd group
 126                                 // (*exclusive* from LD_NOSEQ and LD_NOSHADOW)
 127 };
 128
 129 /**
 130  * \brief structure, for internal use only
 131  */
 132 struct DicomElement
 133 {
 134    /// Dicom Group number
 135    unsigned short int Group;
 136    /// Dicom Element number
 137    unsigned short int Elem;
 138    /// value (coded as a std::string) of the Element
 139    std::string Value;
 140 };
 141
 142 } //namespace gdcm
 143 //-----------------------------------------------------------------------------
 144 #endif