]> Creatis software - gdcm.git/blob - src/gdcmDocument.h
CheckEntryIfExistByNumber returns a bool (no longer an int, because we use now a...
[gdcm.git] / src / gdcmDocument.h
1 /*=========================================================================
2  
3   Program:   gdcm
4   Module:    $RCSfile: gdcmDocument.h,v $
5   Language:  C++
6   Date:      $Date: 2004/09/03 15:11:35 $
7   Version:   $Revision: 1.35 $
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.htm 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 GDCMDOCUMENT_H
20 #define GDCMDOCUMENT_H
21
22 #include "gdcmCommon.h"
23 #include "gdcmVR.h"
24 #include "gdcmTS.h"
25 #include "gdcmException.h"
26 #include "gdcmDictSet.h"
27 #include "gdcmDocEntry.h"
28
29 class gdcmValEntry;
30 class gdcmBinEntry;
31 class gdcmSeqEntry;
32
33 #include "gdcmDocEntrySet.h"
34 #include "gdcmElementSet.h"
35
36 #include <map>
37 #include <list>
38
39 //-----------------------------------------------------------------------------
40 /**
41  * \brief Derived by both gdcmHeader and gdcmDicomDir
42  */
43 class GDCM_EXPORT gdcmDocument : public gdcmElementSet
44 {
45 friend class gdcmFile;
46 private:
47    /// Public dictionary used to parse this header
48    gdcmDict *RefPubDict;
49    
50    /// \brief Optional "shadow dictionary" (private elements) used to parse
51    /// this header
52    gdcmDict *RefShaDict;
53
54    /// \brief Size threshold above which an element value will NOT be loaded
55    /// in memory (to avoid loading the image/volume itself). By default,
56    /// this upper bound is fixed to 1024 bytes (which might look reasonable
57    /// when one considers the definition of the various VR contents).
58    uint32_t MaxSizeLoadEntry;
59    
60    /// \brief Size threshold above which an element value will NOT be *printed*
61    /// in order no to polute the screen output. By default, this upper bound
62    /// is fixed to 64 bytes.
63    uint32_t MaxSizePrintEntry;   
64
65 protected:
66    /// Refering underlying filename.
67    std::string Filename;
68
69    /// \brief SWap code (e.g. Big Endian, Little Endian, Bad Big Endian,
70    /// Bad Little Endian) according to the processor Endianity and
71    /// what is written on disc.
72    int SwapCode;
73
74    /// File Pointer, opened during Header parsing.
75    FILE *Fp;
76
77    /// ACR, ACR_LIBIDO, ExplicitVR, ImplicitVR, Unknown
78    FileType Filetype;  
79
80    /// After opening the file, we read HEADER_LENGTH_TO_READ bytes.
81    static const unsigned int HEADER_LENGTH_TO_READ; 
82
83    /// \brief Elements whose value is longer than MAX_SIZE_LOAD_ELEMENT_VALUE
84    /// are NOT loaded.
85    static const unsigned int MAX_SIZE_LOAD_ELEMENT_VALUE;
86
87    /// \brief Elements whose value is longer than  MAX_SIZE_PRINT_ELEMENT_VALUE
88    /// are NOT printed.
89    /// \todo Currently not used since collides with #define in
90    ///       \ref gdcmDocEntry.cxx. See also
91    ///       \ref gdcmDocument::SetMaxSizePrintEntry()
92    static const unsigned int MAX_SIZE_PRINT_ELEMENT_VALUE;
93
94    /// Will be set 1 if user asks to 'go inside' the 'sequences' (VR = "SQ")
95    int EnableSequences;
96
97    /// \brief Amount of printed details for each Header Entry (Dicom Element):
98    /// 0 : stands for the least detail level.
99    int PrintLevel;
100    
101 public:
102 // the 2 following will be merged
103    virtual void PrintPubDict (std::ostream &os = std::cout);
104    virtual void PrintShaDict (std::ostream &os = std::cout);
105
106 // Dictionnaries
107    gdcmDict *GetPubDict();
108    gdcmDict *GetShaDict();
109    bool SetShaDict(gdcmDict *dict);
110    bool SetShaDict(DictKey const & dictName);
111
112 // Informations contained in the parser
113    virtual bool IsReadable();
114    bool IsGivenTransferSyntax(std::string const & syntaxToCheck);
115    bool IsImplicitVRLittleEndianTransferSyntax();
116    bool IsExplicitVRLittleEndianTransferSyntax();
117    bool IsDeflatedExplicitVRLittleEndianTransferSyntax();
118    bool IsExplicitVRBigEndianTransferSyntax();
119    bool IsJPEGBaseLineProcess1TransferSyntax();
120    bool IsJPEGExtendedProcess2_4TransferSyntax();
121    bool IsJPEGExtendedProcess3_5TransferSyntax();
122    bool IsJPEGSpectralSelectionProcess6_8TransferSyntax();
123    bool IsRLELossLessTransferSyntax();
124    bool IsJPEGLossless();
125    bool IsJPEG2000();
126    bool IsDicomV3();
127
128    FileType GetFileType();
129
130    FILE* OpenFile();
131    bool CloseFile();
132
133    void Write(FILE* fp, FileType type);
134
135    gdcmValEntry* ReplaceOrCreateByNumber(std::string const & value,
136                                          uint16_t group, uint16_t elem);
137
138    gdcmBinEntry* ReplaceOrCreateByNumber(void *voidArea, int lgth,
139                                          uint16_t group, uint16_t elem);
140    gdcmSeqEntry* ReplaceOrCreateByNumber(uint16_t group, uint16_t elem);
141    bool ReplaceIfExistByNumber ( std::string const & value,
142                                  uint16_t group,
143                                  uint16_t elem );
144    
145    virtual void* LoadEntryVoidArea(uint16_t group, uint16_t elem);
146    virtual void* LoadEntryVoidArea(gdcmBinEntry* entry);
147       
148    // System access (meaning endian related !?)
149    uint16_t SwapShort(uint16_t);   // needed by gdcmFile
150    uint32_t SwapLong(uint32_t);    // needed by gdcmFile
151    uint16_t UnswapShort(uint16_t); // needed by gdcmFile
152    uint32_t UnswapLong(uint32_t);  // needed by gdcmFile
153
154 protected:
155    // Constructor and destructor are protected to forbid end user 
156    // to instanciate from this class gdcmDocument (only gdcmHeader and
157    // gdcmDicomDir are meaningfull).
158    gdcmDocument();
159    gdcmDocument( std::string const & filename );
160    virtual ~gdcmDocument();
161    
162    void Parse7FE0 ();   
163    // Entry
164    bool CheckIfEntryExistByNumber(uint16_t group, uint16_t elem );
165 public:
166    virtual std::string GetEntryByName    (TagName const & tagName);
167    virtual std::string GetEntryVRByName  (TagName const & tagName);
168    virtual std::string GetEntryByNumber  (uint16_t group, uint16_t elem);
169    virtual std::string GetEntryVRByNumber(uint16_t group, uint16_t elem);
170    virtual int     GetEntryLengthByNumber(uint16_t group, uint16_t elem);
171 //protected:
172    virtual bool SetEntryByName  (std::string const & content, 
173                                  std::string const & tagName);
174    virtual bool SetEntryByNumber(std::string const & content,
175                                  uint16_t group, uint16_t element);
176    virtual bool SetEntryByNumber(void *content, int lgth,
177                                  uint16_t group, uint16_t element);
178    virtual bool SetEntryLengthByNumber(uint32_t length,
179                                        uint16_t group, uint16_t element);
180
181    virtual size_t GetEntryOffsetByNumber(uint16_t group, uint16_t elem);
182    virtual void* GetEntryVoidAreaByNumber(uint16_t group, uint16_t elem);   
183    virtual bool  SetEntryVoidAreaByNumber(void* a, uint16_t group,
184                                                    uint16_t elem);
185
186    virtual void UpdateShaEntries();
187
188    // Header entry
189    gdcmDocEntry* GetDocEntryByNumber(uint16_t group, uint16_t element); 
190    gdcmDocEntry* GetDocEntryByName  (std::string const & tagName);
191
192    gdcmValEntry* GetValEntryByNumber(uint16_t group, uint16_t element); 
193    gdcmBinEntry* GetBinEntryByNumber(uint16_t group, uint16_t element); 
194
195    void LoadDocEntrySafe(gdcmDocEntry* entry);
196
197 private:
198    // Read
199    long ParseDES(gdcmDocEntrySet *set,long offset, long l_max, bool delim_mode);
200    long ParseSQ (gdcmSeqEntry *seq,   long offset, long l_max, bool delim_mode); 
201    
202    void LoadDocEntry      (gdcmDocEntry *);
203    void FindDocEntryLength(gdcmDocEntry *) throw ( gdcmFormatError );
204    void FindDocEntryVR    (gdcmDocEntry *);
205    bool CheckDocEntryVR   (gdcmDocEntry *, gdcmVRKey);
206
207    std::string GetDocEntryValue  (gdcmDocEntry *);
208    std::string GetDocEntryUnvalue(gdcmDocEntry *);
209
210    void SkipDocEntry          (gdcmDocEntry *);
211    void SkipToNextDocEntry    (gdcmDocEntry *);
212
213    void FixDocEntryFoundLength(gdcmDocEntry *, uint32_t);
214    bool IsDocEntryAnInteger   (gdcmDocEntry *);
215
216    uint32_t FindDocEntryLengthOB() throw( gdcmFormatUnexpected );
217
218    uint16_t ReadInt16() throw ( gdcmFormatError );
219    uint32_t ReadInt32() throw ( gdcmFormatError );
220    void     SkipBytes(uint32_t);
221    bool     ReadTag(uint16_t, uint16_t);
222    uint32_t ReadTagLength(uint16_t, uint16_t);
223
224    void Initialise();
225    bool CheckSwap();
226    void SwitchSwapToBigEndian();
227    void SetMaxSizeLoadEntry(long);
228    void SetMaxSizePrintEntry(long);
229
230    // DocEntry related utilities
231    gdcmDocEntry* ReadNextDocEntry();
232
233    uint32_t GenerateFreeTagKeyInGroup(uint16_t group);
234
235 public:
236 // Accessors:
237    /// Accessor to \ref PrintLevel
238    void SetPrintLevel(int level) { PrintLevel = level; }
239
240    /// Accessor to \ref Filename
241    const std::string &GetFileName() { return Filename; }
242
243    /// Accessor to \ref Filename
244    void SetFileName(std::string const & fileName) { Filename = fileName; }
245
246    /// 'Swap code' accessor (see \ref SwapCode )
247    int GetSwapCode() { return SwapCode; }
248    
249    /// File pointer
250    FILE * GetFP() { return Fp; }
251
252    bool operator<(gdcmDocument &document);
253
254 };
255
256 //-----------------------------------------------------------------------------
257 #endif