1 /*=========================================================================
4 Module: $RCSfile: gdcmFile.h,v $
6 Date: $Date: 2005/01/28 17:01:30 $
7 Version: $Revision: 1.101 $
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.
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.
17 =========================================================================*/
22 #include "gdcmDocument.h"
27 class JPEGFragmentsInfo;
29 //-----------------------------------------------------------------------------
30 // Dicom Part 3.3 Compliant
35 BI, // Biomagnetic Imaging
36 CF, // Cinefluorography
38 CR, // Computed Radiography
40 CT, // Computed Tomography
42 DF, // Digital Fluoroscopy
44 DM, // Digital Microscopy
45 DS, // Digital Substraction Angiography
46 DX, // Digital Radiography
47 ECG, // Echocardiography
48 EPS, // Basic Cardiac EP
50 FA, // Fluorescein Angiography
55 LS, // Laser Surface Scan
56 MA, // Magnetic Resonance Angiography
57 MR, // Magnetic Resonance
58 NM, // Nuclear Medicine
60 PT, // Positron Emission Tomography
61 RF, // Radio Fluoroscopy
62 RG, // Radiographic Imaging
63 RTDOSE, // Radiotherapy Dose
64 RTIMAGE, // Radiotherapy Image
65 RTPLAN, // Radiotherapy Plan
66 RTSTRUCT, // Radiotherapy Structure Set
67 SM, // Microscopic Imaging
68 ST, // Single-photon Emission Computed Tomography
71 VF, // Videofluorography
72 XA, // X-Ray Angiography
73 XC // Photographic Imaging
76 //-----------------------------------------------------------------------------
78 * \brief DICOM elements and their corresponding values (and
79 * additionaly the corresponding DICOM dictionary entry) of the header
82 * The typical usage of instances of class File is to classify a set of
83 * dicom files according to header information e.g. to create a file hierarchy
84 * reflecting the Patient/Study/Serie informations, or extracting a given
85 * SerieId. Accessing the content (image[s] or volume[s]) is beyond the
86 * functionality of this class and belongs to gdmcFile.
87 * \note The various entries of the explicit value representation (VR) shall
88 * be managed within a dictionary which is shared by all File
90 * \note The File::Set*Tag* family members cannot be defined as
91 * protected due to Swig limitations for as Has_a dependency between
92 * File and FileHelper.
95 //-----------------------------------------------------------------------------
96 class GDCM_EXPORT File : public Document
99 /// \brief In some cases (e.g. for some ACR-NEMA images) the Entry Element
100 /// Number of the 'Pixel Element' is *not* found at 0x0010. In order to
101 /// make things easier the parser shall store the proper value in
102 /// NumPixel to provide a unique access facility.
104 /// \brief In some cases (e.g. for some ACR-NEMA images) the header entry for
105 /// the group of pixels is *not* found at 0x7fe0. In order to
106 /// make things easier the parser shall store the proper value in
107 /// GrPixel to provide a unique access facility.
112 File( std::string const &filename );
116 // Standard values and informations contained in the header
119 // Some heuristic based accessors, end user intended
121 int GetBitsAllocated();
122 int GetSamplesPerPixel();
123 int GetPlanarConfiguration();
125 int GetHighBitPosition();
126 bool IsSignedPixelData();
128 bool IsPaletteColor();
131 std::string GetPixelType();
132 size_t GetPixelOffset();
133 size_t GetPixelAreaLength();
135 //Some image informations needed for third package imaging library
144 // For rescaling graylevel:
145 float GetRescaleIntercept();
146 float GetRescaleSlope();
148 int GetNumberOfScalarComponents();
149 int GetNumberOfScalarComponentsRaw();
151 // To organize DICOM files based on their x,y,z position
152 void GetImageOrientationPatient( float iop[6] );
154 int GetImageNumber();
155 ModalityType GetModality();
164 /// Accessor to \ref File::GrPixel
165 uint16_t GetGrPixel() { return GrPixel; }
167 /// Accessor to \ref File::NumPixel
168 uint16_t GetNumPixel() { return NumPixel; }
170 /// Replace patient's specific information by 'anonymous'
171 bool AnonymizeFile();
173 bool Write(std::string fileName, FileType filetype);
175 /// returns the RLE info
176 RLEFramesInfo *GetRLEInfo() { return RLEInfo; }
177 /// Returns the JPEG Fragments info
178 JPEGFragmentsInfo *GetJPEGInfo() { return JPEGInfo; }
181 /// Initialize DICOM File when none
182 void InitializeDefaultFile();
184 /// Store the RLE frames info obtained during parsing of pixels.
185 RLEFramesInfo *RLEInfo;
186 /// Store the JPEG fragments info obtained during parsing of pixels.
187 JPEGFragmentsInfo *JPEGInfo;
190 void ComputeRLEInfo();
191 void ComputeJPEGFragmentInfo();
192 void ReadAndSkipEncapsulatedBasicOffsetTable();
193 bool ReadTag(uint16_t, uint16_t);
194 uint32_t ReadTagLength(uint16_t, uint16_t);
196 } // end namespace gdcm
198 //-----------------------------------------------------------------------------