]> Creatis software - gdcm.git/blob - src/gdcmCommon.h
add SetFlipY()
[gdcm.git] / src / gdcmCommon.h
1 /*=========================================================================
2                                                                                 
3   Program:   gdcm
4   Module:    $RCSfile: gdcmCommon.h,v $
5   Language:  C++
6   Date:      $Date: 2007/08/22 16:14:03 $
7   Version:   $Revision: 1.116 $
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 #include "gdcmVRKey.h"
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 #ifdef __BORLANDC__
40 #include <mem.h>
41 #endif
42
43 //-----------------------------------------------------------------------------
44 /// \brief namespace for Grass root DiCoM
45 namespace GDCM_NAME_SPACE
46 {
47
48 // Centralize information about the gdcm dictionary in only one file:
49 //
50 // ==>
51 // ==> Don't forget gdcm/gdcmPython/gdcm.i
52 // ==>
53 //
54
55 #ifndef PUB_DICT_PATH
56 #  define PUB_DICT_PATH   "../Dicts/"
57 #endif
58 #define PUB_DICT_NAME     "dicomV3Dict"
59
60 // dicomV3.dic replaced by the generated gdcm.dic/
61 // if gdcm.dic not found, method FillDefaultDataDict() is invoked
62 //#define PUB_DICT_FILENAME "dicomV3.dic"
63 #define PUB_DICT_FILENAME "gdcm.dic"
64 #define DICT_ELEM         "DicomDir.dic"
65 #define DICT_TS           "dicomTS.dic"
66 #define DICT_VR           "dicomVR.dic"
67 #define DICT_GROUP_NAME   "DictGroupName.dic"
68
69 GDCM_EXPORT extern const std::string GDCM_UNKNOWN;
70 GDCM_EXPORT extern const std::string GDCM_UNFOUND;
71 GDCM_EXPORT extern const std::string GDCM_BINLOADED;
72 GDCM_EXPORT extern const std::string GDCM_NOTLOADED;
73 GDCM_EXPORT extern const std::string GDCM_UNREAD;
74 GDCM_EXPORT extern const std::string GDCM_NOTASCII;
75 GDCM_EXPORT extern const std::string GDCM_PIXELDATA;
76
77 GDCM_EXPORT extern const char GDCM_VRUNKNOWN[2];
78
79 GDCM_EXPORT extern const char GDCM_FILESEPARATOR;
80
81 /// \brief TagKey is made to hold the standard Dicom Tag 
82 ///               (Group number, Element number)
83 /// Instead of using the two '16 bits integers' as the Hask Table key, we
84 /// converted into a string (e.g. 0x0018,0x0050 converted into "0018|0050")
85 /// It appears to be a huge waste of time.
86 /// We'll fix the mess up -without any change in the API- as soon as the bench
87 /// marks are fully performed.
88
89 #if defined(_MSC_VER) && (_MSC_VER == 1200)
90 // Doing everything within gdcm namespace to avoid polluting 3d party software
91 inline std::ostream& operator<<(std::ostream& _O, std::string _val)
92 {
93   return _O << _val.c_str();
94 }
95 #endif
96
97 /// \brief TagName is made to hold the 'non hexa" fields (VR, VM, Name) 
98 ///        of Dicom Entries
99 typedef std::string TagName;
100
101 /// \brief various types of a DICOM file (for internal use only)
102 enum FileType {
103 // note to developer : don't forget to add as well in vtkGdcmWriter.h !
104    Unknown = 0,
105    ExplicitVR, // DicomDir is in this case. Except when it's ImplicitVR !...
106    ImplicitVR,
107    ACR,
108    ACR_LIBIDO,
109    /// \todo FIXME : an encapsulated JPEG file may be 
110    ///              either ExplicitVR or ImplicitVR, right?
111    JPEG,
112    JPEG2000
113 };
114
115 /// \brief type of the elements composing a DICOMDIR (for internal use only)
116 enum DicomDirType {
117    DD_UNKNOWN = 0,
118    DD_META,
119    DD_PATIENT,
120    DD_STUDY,
121    DD_SERIE,
122    DD_IMAGE,
123    DD_VISIT
124 };
125
126 /// \brief comparison operators (as used in SerieHelper::AddRestriction() )
127 enum CompOperators {
128    GDCM_EQUAL = 0,
129    GDCM_DIFFERENT,
130    GDCM_GREATER,
131    GDCM_GREATEROREQUAL,
132    GDCM_LESS,
133    GDCM_LESSOREQUAL
134 };
135
136 /// \brief Loading mode
137 enum LodModeType
138 {
139    LD_ALL         = 0x00000000, // Load all
140    LD_NOSEQ       = 0x00000001, // Don't load Sequences
141    LD_NOSHADOW    = 0x00000002, // Don't load odd groups
142    LD_NOSHADOWSEQ = 0x00000004  // Don't load Sequences if they belong 
143                                 //            to an odd group
144                                 // (*exclusive* from LD_NOSEQ and LD_NOSHADOW)
145 };
146
147 /// \brief Only user knows what kind of image he is going to write  !
148 ///
149 /// -1) user created ex nihilo his own image and wants to write it as a Dicom image.
150 ///    USER_OWN_IMAGE
151 /// -2) user modified the pixels of an existing image.
152 ///    FILTERED_IMAGE
153 /// -3) user created a new image, using existing images (eg MIP, MPR, cartography image)
154 ///   CREATED_IMAGE
155 /// -4) user modified/added some tags *without processing* the pixels (anonymization...
156 ///   UNMODIFIED_PIXELS_IMAGE
157 enum ImageContentType
158 {
159 // note to developer : don't forget to add as well in vtkGdcmWriter.h !
160       USER_OWN_IMAGE = 1,
161       FILTERED_IMAGE,
162       CREATED_IMAGE,      
163       UNMODIFIED_PIXELS_IMAGE            
164 }; 
165   
166 /**
167  * \brief structure, for internal use only
168  */  
169 struct DicomElement
170 {
171    /// Dicom Group number
172    unsigned short int Group;
173    /// Dicom Element number
174    unsigned short int Elem;
175    /// Value Representation
176    VRKey VR;
177    /// value (coded as a std::string) of the Element
178    std::string Value;
179 };
180
181 } //namespace gdcm
182 //-----------------------------------------------------------------------------
183 #endif