src/gdcmCommon.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmCommon.h,v $
   5   Language:  C++
   6   Date:      $Date: 2006/03/13 14:44:07 $
   7   Version:   $Revision: 1.107 $
   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    /// \todo FIXME : an encapsulated JPEG file may be
  95    ///              either ExplicitVR or ImplicitVR, right?
  96    JPEG
  97 };
  98
  99 /// \brief type of the elements composing a DICOMDIR (for internal use only)
 100 enum DicomDirType {
 101    DD_UNKNOWN = 0,
 102    DD_META,
 103    DD_PATIENT,
 104    DD_STUDY,
 105    DD_SERIE,
 106    DD_IMAGE,
 107    DD_VISIT
 108 };
 109
 110 /// \brief comparison operators (as used in SerieHelper::AddRestriction() )
 111 enum CompOperators {
 112    GDCM_EQUAL = 0,
 113    GDCM_DIFFERENT,
 114    GDCM_GREATER,
 115    GDCM_GREATEROREQUAL,
 116    GDCM_LESS,
 117    GDCM_LESSOREQUAL
 118 };
 119
 120 /// \brief Loading mode
 121 enum LodModeType
 122 {
 123    LD_ALL         = 0x00000000, // Load all
 124    LD_NOSEQ       = 0x00000001, // Don't load Sequences
 125    LD_NOSHADOW    = 0x00000002, // Don't load odd groups
 126    LD_NOSHADOWSEQ = 0x00000004  // Don't load Sequences if they belong
 127                                 //            to an odd group
 128                                 // (*exclusive* from LD_NOSEQ and LD_NOSHADOW)
 129 };
 130
 131 /// \brief Only user knows what kind of image he is going to write  !
 132 ///
 133 /// -1) user created ex nihilo his own image and wants to write it as a Dicom image.
 134 ///    USER_OWN_IMAGE
 135 /// -2) user modified the pixels of an existing image.
 136 ///    FILTERED_IMAGE
 137 /// -3) user created a new image, using existing images (eg MIP, MPR, cartography image)
 138 ///   CREATED_IMAGE
 139 /// -4) user modified/added some tags *without processing* the pixels (anonymization...
 140 ///   UNMODIFIED_PIXELS_IMAGE
 141 enum ImageContentType
 142 {
 143       USER_OWN_IMAGE,
 144       FILTERED_IMAGE,
 145       CREATED_IMAGE,
 146       UNMODIFIED_PIXELS_IMAGE
 147 };
 148
 149 /**
 150  * \brief structure, for internal use only
 151  */
 152 struct DicomElement
 153 {
 154    /// Dicom Group number
 155    unsigned short int Group;
 156    /// Dicom Element number
 157    unsigned short int Elem;
 158    /// value (coded as a std::string) of the Element
 159    std::string Value;
 160 };
 161
 162 } //namespace gdcm
 163 //-----------------------------------------------------------------------------
 164 #endif