1 /*=========================================================================
4 Module: $RCSfile: gdcmFile.h,v $
6 Date: $Date: 2004/09/29 17:33:17 $
7 Version: $Revision: 1.53 $
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 "gdcmCommon.h"
23 #include "gdcmHeader.h"
25 //-----------------------------------------------------------------------------
27 * In addition to Dicom header exploration, this class is designed
28 * for accessing the image/volume content. One can also use it to
29 * write Dicom/ACR-NEMA/RAW files.
31 class GDCM_EXPORT gdcmFile
34 gdcmFile( gdcmHeader *header );
35 gdcmFile( std::string const& filename );
39 /// Accessor to \ref Header
40 gdcmHeader* GetHeader() { return Header; }
42 int ComputeDecompressedPixelDataSizeFromHeader();
44 /// Accessor to \ref ImageDataSize
45 size_t GetImageDataSize(){ return ImageDataSize; };
47 /// Accessor to \ref ImageDataSizeRaw
48 size_t GetImageDataSizeRaw(){ return ImageDataSizeRaw; };
50 uint8_t* GetImageData();
51 size_t GetImageDataIntoVector(void* destination, size_t maxSize);
52 uint8_t* GetImageDataRaw();
53 size_t GetImageDataIntoVectorRaw(void* destination, size_t maxSize);
55 // see also gdcmHeader::SetImageDataSize ?!?
56 bool SetImageData (uint8_t* data, size_t expectedSize);
58 /// \todo When the caller is aware we simply point to the data:
59 /// int SetImageDataNoCopy (void* Data, size_t ExpectedSize);
61 // Write pixels of ONE image on hard drive
62 // No test is made on processor "endianity"
63 // The user must call his reader correctly
64 bool WriteRawData (std::string const& fileName);
65 bool WriteDcmImplVR(std::string const& fileName);
66 bool WriteDcmExplVR(std::string const& fileName);
67 bool WriteAcr (std::string const& fileName);
69 // Don't look any longer for the code :
70 // It's in file gdcmParsePixels.cxx
71 bool ParsePixelData();
73 virtual bool SetEntryByNumber(std::string const& content,
74 uint16_t group, uint16_t element)
76 Header->SetEntryByNumber(content,group,element);
81 bool WriteBase(std::string const& fileName, FileType type);
85 void SwapZone(void* im, int swap, int lgr, int nb);
87 bool ReadPixelData(void* destination);
89 // For JPEG 8 Bits, body in file gdcmJpeg.cxx
90 bool gdcm_read_JPEG_file (FILE* fp, void* image_buffer);
91 bool gdcm_write_JPEG_file (FILE* fp, void* image_buffer,
92 int image_width, int image_heigh,
95 // For JPEG 12 Bits, body in file gdcmJpeg12.cxx
96 bool gdcm_read_JPEG_file12 (FILE* fp, void* image_buffer);
97 bool gdcm_write_JPEG_file12 (FILE* fp, void* image_buffer,
98 int image_width, int image_height,
101 // For JPEG 2000, body in file gdcmJpeg2000.cxx
102 bool gdcm_read_JPEG2000_file (FILE* fp, void* image_buffer);
104 // For Run Length Encoding
105 bool gdcm_read_RLE_file (FILE* fp, void* image_buffer);
106 // FIXME : *sure* it's NOT static (C++)
107 // (would be static in C, or embedded in ADA)
108 // It's NOT a method, but a not user intended fonction.
109 // How do we write that in C++ ?)
110 static int gdcm_read_RLE_fragment(char **areaToRead, long lengthToDecode,
111 long uncompressedSegmentSize, FILE* fp);
113 void SaveInitialValues(); // will belong to the future gdcmPixelData class
114 void RestoreInitialValues(); // will belong to the future gdcmPixelData class
115 void DeleteInitialValues(); // will belong to the future gdcmPixelData class
117 // members variables:
119 /// \brief Header to use to load the file
122 /// \brief Whether the underlying \ref gdcmHeader was loaded by
123 /// the constructor or passed to the constructor. When false
124 /// the destructor is in charge of deletion.
127 /// wether already parsed
131 // --------------- Will be moved to a gdcmPixelData class
134 /// \brief to hold the Pixels (when read)
135 uint8_t* Pixel_Data; // (was PixelData)
137 /// \brief Size (in bytes) of required memory to hold the Gray Level pixels
138 /// represented in this file. This is used when the user DOESN'T want
139 /// the RGB pixels image when it's stored as a PALETTE COLOR image
140 size_t ImageDataSizeRaw;
142 /// \brief Size (in bytes) of requited memory to hold the the pixels
143 /// of this image in it's RGB convertion either from:
144 /// - Plane R, Plane G, Plane B
145 /// - Grey Plane + Palette Color
146 /// - YBR Pixels (or from RGB Pixels, as well)
147 size_t ImageDataSize;
149 /// \brief ==1 if GetImageDataRaw was used
150 /// ==0 if GetImageData was used
151 /// ==-1 if ImageData never read
154 /// \brief length of the last allocated area devoided to receive Pixels
155 /// ( to allow us not to (free + new) if un necessary )
156 size_t LastAllocatedPixelDataLength;
158 // Initial values of some fields that can be modified during reading process
159 // if user asked to transform gray level + LUT image into RGB image
161 /// \brief Samples Per Pixel (0x0028,0x0002), as found on disk
162 std::string InitialSpp;
163 /// \brief Photometric Interpretation (0x0028,0x0004), as found on disk
164 std::string InitialPhotInt;
165 /// \brief Planar Configuration (0x0028,0x0006), as found on disk
166 std::string InitialPlanConfig;
168 // Initial values of some fields that can be modified during reading process
169 // if the image was a 'strange' ACR-NEMA
170 // (Bits Allocated=12, High Bit not equal to Bits stored +1)
171 /// \brief Bits Allocated (0x0028,0x0100), as found on disk
172 std::string InitialBitsAllocated;
173 /// \brief High Bit (0x0028,0x0102), as found on disk
174 std::string InitialHighBit;
176 // some DocEntry that can be moved out of the H table during reading process
177 // if user asked to transform gray level + LUT image into RGB image
178 // We keep a pointer on them for a future use.
180 /// \brief Red Palette Color Lookup Table Descriptor 0028 1101 as read
181 gdcmDocEntry* InitialRedLUTDescr;
182 /// \brief Green Palette Color Lookup Table Descriptor 0028 1102 as read
183 gdcmDocEntry* InitialGreenLUTDescr;
184 /// \brief Blue Palette Color Lookup Table Descriptor 0028 1103 as read
185 gdcmDocEntry* InitialBlueLUTDescr;
187 /// \brief Red Palette Color Lookup Table Data 0028 1201 as read
188 gdcmDocEntry* InitialRedLUTData;
189 /// \brief Green Palette Color Lookup Table Data 0028 1202 as read
190 gdcmDocEntry* InitialGreenLUTData;
191 /// \brief Blue Palette Color Lookup Table Data 0028 1203 as read
192 gdcmDocEntry* InitialBlueLUTData;
195 // --------------- end of future gdcmPixelData class
200 //-----------------------------------------------------------------------------