]> Creatis software - gdcm.git/blob - gdcmFile.h
57ef7d107c03f6aa31af9b2ce5abe36e54d5dfc6
[gdcm.git] / gdcmFile.h
1 /*=========================================================================
2                                                                                 
3   Program:   gdcm
4   Module:    $RCSfile: gdcmFile.h,v $
5   Language:  C++
6   Date:      $Date: 2005/08/29 13:05:02 $
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 GDCMFILE_H
20 #define GDCMFILE_H
21
22 #include "gdcmDebug.h"
23 #include "gdcmDocument.h"
24
25
26
27 namespace gdcm 
28 {
29
30 class RLEFramesInfo;
31 class JPEGFragmentsInfo;
32
33 //-----------------------------------------------------------------------------
34 // Dicom Part 3.3 Compliant
35 enum ModalityType {
36    Unknow,
37    AU,       // Voice Audio
38    AS,       // Angioscopy
39    BI,       // Biomagnetic Imaging
40    CF,       // Cinefluorography
41    CP,       // Culposcopy
42    CR,       // Computed Radiography
43    CS,       // Cystoscopy
44    CT,       // Computed Tomography
45    DD,       // Duplex Dopler
46    DF,       // Digital Fluoroscopy
47    DG,       // Diaphanography
48    DM,       // Digital Microscopy
49    DS,       // Digital Substraction Angiography
50    DX,       // Digital Radiography
51    ECG,      // Echocardiography
52    EPS,      // Basic Cardiac EP
53    ES,       // Endoscopy
54    FA,       // Fluorescein Angiography
55    FS,       // Fundoscopy
56    HC,       // Hard Copy
57    HD,       // Hemodynamic
58    LP,       // Laparoscopy
59    LS,       // Laser Surface Scan
60    MA,       // Magnetic Resonance Angiography
61    MR,       // Magnetic Resonance
62    NM,       // Nuclear Medicine
63    OT,       // Other
64    PT,       // Positron Emission Tomography
65    RF,       // Radio Fluoroscopy
66    RG,       // Radiographic Imaging
67    RTDOSE,   // Radiotherapy Dose
68    RTIMAGE,  // Radiotherapy Image
69    RTPLAN,   // Radiotherapy Plan
70    RTSTRUCT, // Radiotherapy Structure Set
71    SM,       // Microscopic Imaging
72    ST,       // Single-photon Emission Computed Tomography
73    TG,       // Thermography
74    US,       // Ultrasound
75    VF,       // Videofluorography
76    XA,       // X-Ray Angiography
77    XC        // Photographic Imaging
78 };
79
80 //-----------------------------------------------------------------------------
81
82 /**
83  * \brief DICOM elements and their corresponding values (and
84  * additionaly the corresponding DICOM dictionary entry) of the header
85  * of a DICOM file.
86  *
87  * The typical usage of instances of class File is to classify a set of
88  * dicom files according to header information e.g. to create a file hierarchy
89  * reflecting the Patient/Study/Serie informations, or extracting a given
90  * SerieId. Accessing the content (image[s] or volume[s]) is beyond the
91  * functionality of this class and belongs to gdcm::FileHelper.
92  * \note  The various entries of the explicit value representation (VR) shall
93  *        be managed within a dictionary which is shared by all File
94  *        instances.
95  * \note  The File::Set*Tag* family members cannot be defined as
96  *        protected due to Swig limitations for as Has_a dependency between
97  *        File and FileHelper.
98  */
99 class GDCM_EXPORT File : public Document
100 {
101 public:
102    File();
103    GDCM_LEGACY(File( std::string const &filename ));
104    ~File();
105
106    // Loading
107    GDCM_LEGACY(bool Load( std::string const &filename ));
108    bool Load(); 
109    // Standard values and informations contained in the header
110    bool IsReadable();
111
112    // Some heuristic based accessors, end user intended 
113    int GetImageNumber();
114    ModalityType GetModality();
115
116    int GetXSize();
117    int GetYSize();
118    int GetZSize();
119
120    float GetXSpacing();
121    float GetYSpacing();
122    float GetZSpacing();
123
124    float GetXOrigin();
125    float GetYOrigin();
126    float GetZOrigin();
127
128    bool GetImageOrientationPatient( float iop[6] );
129
130    int GetBitsStored();
131    int GetBitsAllocated();
132    int GetHighBitPosition();
133    int GetSamplesPerPixel();
134    int GetPlanarConfiguration();
135    int GetPixelSize();
136    std::string GetPixelType();
137    bool IsSignedPixelData();
138    bool IsMonochrome();
139    bool IsMonochrome1();
140    bool IsPaletteColor();
141    bool IsYBRFull();
142
143    bool HasLUT();
144    int GetLUTNbits();
145
146    // For rescaling graylevel:
147    float GetRescaleIntercept();
148    float GetRescaleSlope();
149
150    int GetNumberOfScalarComponents();
151    int GetNumberOfScalarComponentsRaw();
152
153    /// Accessor to \ref File::GrPixel
154    uint16_t GetGrPixel()  { return GrPixel; }
155    /// Accessor to \ref File::NumPixel
156    uint16_t GetNumPixel() { return NumPixel; }
157
158    size_t GetPixelOffset();
159    size_t GetPixelAreaLength();
160
161    /// returns the RLE info
162    RLEFramesInfo *GetRLEInfo() { return RLEInfo; }
163    /// Returns the JPEG Fragments info
164    JPEGFragmentsInfo *GetJPEGInfo() { return JPEGInfo; }
165
166 // Anonymization process
167    void AddAnonymizeElement (uint16_t group, uint16_t elem, 
168                              std::string const &value);
169    /// Clears the list of elements to be anonymized
170    void ClearAnonymizeList() { UserAnonymizeList.clear(); }      
171    void AnonymizeNoLoad();
172    /// Replace patient's own information by info from the Anonymization list
173    bool AnonymizeFile();
174
175    bool Write(std::string fileName, FileType filetype);
176
177 protected:
178  
179    /// Store the RLE frames info obtained during parsing of pixels.
180    RLEFramesInfo *RLEInfo;
181    /// Store the JPEG fragments info obtained during parsing of pixels.
182    JPEGFragmentsInfo *JPEGInfo;
183
184    /// \brief In some cases (e.g. for some ACR-NEMA images) the Entry Element
185    /// Number of the 'Pixel Element' is *not* found at 0x0010. In order to
186    /// make things easier the parser shall store the proper value in
187    /// NumPixel to provide a unique access facility. 
188    uint16_t NumPixel;
189    /// \brief In some cases (e.g. for some ACR-NEMA images) the header entry for
190    /// the group of pixels is *not* found at 0x7fe0. 
191    /// In order to make things easier the parser shall store the proper value
192    /// in GrPixel to provide a unique access facility.
193    uint16_t GrPixel;
194
195 private:
196    bool DoTheLoadingJob();
197    void ComputeRLEInfo();
198    void ComputeJPEGFragmentInfo();
199    bool     ReadTag(uint16_t, uint16_t);
200    uint32_t ReadTagLength(uint16_t, uint16_t);
201    void ReadAndSkipEncapsulatedBasicOffsetTable();
202
203 };
204 } // end namespace gdcm
205
206 //-----------------------------------------------------------------------------
207 #endif