X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmCommon.h;h=98ff3901ec7b0c9181118d82356890b51d64c485;hb=bd7bec4c367d671a9da358584e98a8ec29bb641e;hp=2313fe016ed0723e98e6bf3108bbdb1c9d3e8ddb;hpb=eebf2c84ee4b7d361c81ab463d546cb5e843f09e;p=gdcm.git diff --git a/src/gdcmCommon.h b/src/gdcmCommon.h index 2313fe01..98ff3901 100644 --- a/src/gdcmCommon.h +++ b/src/gdcmCommon.h @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmCommon.h,v $ Language: C++ - Date: $Date: 2005/01/22 22:21:19 $ - Version: $Revision: 1.56 $ + Date: $Date: 2007/08/22 16:14:03 $ + Version: $Revision: 1.116 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -16,57 +16,16 @@ =========================================================================*/ -#ifndef GDCMCOMMON_H -#define GDCMCOMMON_H +#ifndef _GDCMCOMMON_H_ +#define _GDCMCOMMON_H_ #include "gdcmConfigure.h" +#include "gdcmSystem.h" +#include "gdcmMacro.h" +#include "gdcmVRKey.h" +#include //----------------------------------------------------------------------------- -//This is needed when compiling in debug mode -#ifdef _MSC_VER -// 'identifier' : class 'type' needs to have dll-interface to be used by -// clients of class 'type2' -#pragma warning ( disable : 4251 ) -// 'identifier' : identifier was truncated to 'number' characters in the -// debug information -#pragma warning ( disable : 4786 ) -//'identifier' : decorated name length exceeded, name was truncated -#pragma warning ( disable : 4503 ) -// C++ exception specification ignored except to indicate a -// function is not __declspec(nothrow) -#pragma warning ( disable : 4290 ) -// signed/unsigned mismatch -#pragma warning ( disable : 4018 ) -// return type for 'identifier' is '' (ie; not a UDT or reference to UDT. Will -// produce errors if applied using infix notation -#pragma warning ( disable : 4284 ) -// 'type' : forcing value to bool 'true' or 'false' (performance warning) -// //#pragma warning ( disable : 4800 ) -#endif //_MSC_VER - -//----------------------------------------------------------------------------- -#ifdef CMAKE_HAVE_STDINT_H - #include -#else -#ifdef CMAKE_HAVE_INTTYPES_H - // Old system only have this - #include // For uint8_t uint16_t and uint32_t -#endif -#endif - -// Broken plateform do not respect C99 and do not provide those typedef -#if defined(_MSC_VER) || defined(__BORLANDC__) -typedef signed __int8 int8_t; -typedef signed __int16 int16_t; -typedef signed __int32 int32_t; -typedef signed __int64 int64_t; -typedef unsigned __int8 uint8_t; -typedef unsigned __int16 uint16_t; -typedef unsigned __int32 uint32_t; -typedef unsigned __int64 uint64_t; -#define UINT32_MAX (4294967295U) -#endif - #if defined(_WIN32) && defined(BUILD_SHARED_LIBS) #ifdef gdcm_EXPORTS #define GDCM_EXPORT __declspec( dllexport ) @@ -77,73 +36,148 @@ typedef unsigned __int64 uint64_t; #define GDCM_EXPORT #endif -#include +#ifdef __BORLANDC__ +#include +#endif -namespace gdcm +//----------------------------------------------------------------------------- +/// \brief namespace for Grass root DiCoM +namespace GDCM_NAME_SPACE { // Centralize information about the gdcm dictionary in only one file: +// +// ==> +// ==> Don't forget gdcm/gdcmPython/gdcm.i +// ==> +// + #ifndef PUB_DICT_PATH # define PUB_DICT_PATH "../Dicts/" #endif -#define PUB_DICT_NAME "DicomV3Dict" -#define PUB_DICT_FILENAME "dicomV3.dic" +#define PUB_DICT_NAME "dicomV3Dict" + +// dicomV3.dic replaced by the generated gdcm.dic/ +// if gdcm.dic not found, method FillDefaultDataDict() is invoked +//#define PUB_DICT_FILENAME "dicomV3.dic" +#define PUB_DICT_FILENAME "gdcm.dic" #define DICT_ELEM "DicomDir.dic" #define DICT_TS "dicomTS.dic" #define DICT_VR "dicomVR.dic" +#define DICT_GROUP_NAME "DictGroupName.dic" GDCM_EXPORT extern const std::string GDCM_UNKNOWN; GDCM_EXPORT extern const std::string GDCM_UNFOUND; GDCM_EXPORT extern const std::string GDCM_BINLOADED; GDCM_EXPORT extern const std::string GDCM_NOTLOADED; GDCM_EXPORT extern const std::string GDCM_UNREAD; +GDCM_EXPORT extern const std::string GDCM_NOTASCII; +GDCM_EXPORT extern const std::string GDCM_PIXELDATA; + +GDCM_EXPORT extern const char GDCM_VRUNKNOWN[2]; -/// \brief TagKey is made to hold an "universal" (as in URL, Universal -/// Ressource Locator) key to a DocEntry i.e. a dicom tag. -/// A dicom tag always has a group and an elem, but a set of tags -/// embeded in various (optionally nested) sequences and sharing -/// the same group and elem all share the same (group, elem) -/// "identifier". Hence the (group, elem) cannot be used as an -/// identifier (in gdcm we shall refer to a "TagKey") of a tag. -/// In order to construct a proper tag identifier (i.e. a key) we -/// consider the following definition of a TagKey: -/// - let Group, Element be the string representation of the -/// group and elem dicom tag members, -/// - let ItemNumber be the string representation of the integer -/// index of the considered item number of a sequence, -/// Let the key of a tag embeded in a sequence, noted SeqTag, be -/// the form: -/// /ItemNumber#Group|Element -/// where "/", "#" and "|" are characters acting as separators. -/// Then the general form of a TagKey is given by: -/// Group|Element[SeqTag] -/// where [SeqTag] means NO or many instances of SeqTag. -/// Hence the TagKey of a tag not "leaving" in a sequence is the -/// string e.g. -/// 0028|1201 -/// but the TagKey of a tag "embeded" is the first item of -/// a sequence, itself nested in the third item of a sequence is the -/// string e.g. -/// 0004|1220/2#0008|0082/0#0008|0090 -typedef std::string TagKey; +GDCM_EXPORT extern const char GDCM_FILESEPARATOR; + +/// \brief TagKey is made to hold the standard Dicom Tag +/// (Group number, Element number) +/// Instead of using the two '16 bits integers' as the Hask Table key, we +/// converted into a string (e.g. 0x0018,0x0050 converted into "0018|0050") +/// It appears to be a huge waste of time. +/// We'll fix the mess up -without any change in the API- as soon as the bench +/// marks are fully performed. + +#if defined(_MSC_VER) && (_MSC_VER == 1200) +// Doing everything within gdcm namespace to avoid polluting 3d party software +inline std::ostream& operator<<(std::ostream& _O, std::string _val) +{ + return _O << _val.c_str(); +} +#endif + +/// \brief TagName is made to hold the 'non hexa" fields (VR, VM, Name) +/// of Dicom Entries typedef std::string TagName; +/// \brief various types of a DICOM file (for internal use only) enum FileType { +// note to developer : don't forget to add as well in vtkGdcmWriter.h ! Unknown = 0, - ExplicitVR, // DicomDir is in this case + ExplicitVR, // DicomDir is in this case. Except when it's ImplicitVR !... ImplicitVR, ACR, - ACR_LIBIDO + ACR_LIBIDO, + /// \todo FIXME : an encapsulated JPEG file may be + /// either ExplicitVR or ImplicitVR, right? + JPEG, + JPEG2000 }; +/// \brief type of the elements composing a DICOMDIR (for internal use only) enum DicomDirType { DD_UNKNOWN = 0, DD_META, DD_PATIENT, DD_STUDY, DD_SERIE, - DD_IMAGE + DD_IMAGE, + DD_VISIT +}; + +/// \brief comparison operators (as used in SerieHelper::AddRestriction() ) +enum CompOperators { + GDCM_EQUAL = 0, + GDCM_DIFFERENT, + GDCM_GREATER, + GDCM_GREATEROREQUAL, + GDCM_LESS, + GDCM_LESSOREQUAL }; + +/// \brief Loading mode +enum LodModeType +{ + LD_ALL = 0x00000000, // Load all + LD_NOSEQ = 0x00000001, // Don't load Sequences + LD_NOSHADOW = 0x00000002, // Don't load odd groups + LD_NOSHADOWSEQ = 0x00000004 // Don't load Sequences if they belong + // to an odd group + // (*exclusive* from LD_NOSEQ and LD_NOSHADOW) +}; + +/// \brief Only user knows what kind of image he is going to write ! +/// +/// -1) user created ex nihilo his own image and wants to write it as a Dicom image. +/// USER_OWN_IMAGE +/// -2) user modified the pixels of an existing image. +/// FILTERED_IMAGE +/// -3) user created a new image, using existing images (eg MIP, MPR, cartography image) +/// CREATED_IMAGE +/// -4) user modified/added some tags *without processing* the pixels (anonymization... +/// UNMODIFIED_PIXELS_IMAGE +enum ImageContentType +{ +// note to developer : don't forget to add as well in vtkGdcmWriter.h ! + USER_OWN_IMAGE = 1, + FILTERED_IMAGE, + CREATED_IMAGE, + UNMODIFIED_PIXELS_IMAGE +}; + +/** + * \brief structure, for internal use only + */ +struct DicomElement +{ + /// Dicom Group number + unsigned short int Group; + /// Dicom Element number + unsigned short int Elem; + /// Value Representation + VRKey VR; + /// value (coded as a std::string) of the Element + std::string Value; +}; + } //namespace gdcm //----------------------------------------------------------------------------- #endif