1 /*=========================================================================
4 Module: $RCSfile: gdcmFile.h,v $
6 Date: $Date: 2004/10/10 16:44:00 $
7 Version: $Revision: 1.59 $
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 void ConvertRGBPlanesToRGBPixels( uint8_t* source, uint8_t* destination );
45 void ConvertYcBcRPlanesToRGBPixels( uint8_t* source, uint8_t* destination );
47 /// Accessor to \ref ImageDataSize
48 size_t GetImageDataSize(){ return ImageDataSize; };
50 /// Accessor to \ref ImageDataSizeRaw
51 size_t GetImageDataSizeRaw(){ return ImageDataSizeRaw; };
53 uint8_t* GetImageData();
54 size_t GetImageDataIntoVector(void* destination, size_t maxSize);
55 uint8_t* GetImageDataRaw();
56 size_t GetImageDataIntoVectorRaw(void* destination, size_t maxSize);
58 // see also gdcmHeader::SetImageDataSize ?!?
59 bool SetImageData (uint8_t* data, size_t expectedSize);
61 /// \todo When the caller is aware we simply point to the data:
62 /// int SetImageDataNoCopy (void* Data, size_t ExpectedSize);
64 // Write pixels of ONE image on hard drive
65 // No test is made on processor "endianity"
66 // The user must call his reader correctly
67 bool WriteRawData (std::string const& fileName);
68 bool WriteDcmImplVR(std::string const& fileName);
69 bool WriteDcmExplVR(std::string const& fileName);
70 bool WriteAcr (std::string const& fileName);
72 // Don't look any longer for the code :
73 // It's in file gdcmParsePixels.cxx
74 bool ParsePixelData();
76 virtual bool SetEntryByNumber(std::string const& content,
77 uint16_t group, uint16_t element)
79 Header->SetEntryByNumber(content,group,element);
84 bool WriteBase(std::string const& fileName, FileType type);
89 bool ReadPixelData(void* destination);
91 // For JPEG 8 Bits, body in file gdcmJpeg.cxx
92 bool gdcm_write_JPEG_file (FILE* fp, void* image_buffer,
93 int image_width, int image_heigh,
96 // For JPEG 12 Bits, body in file gdcmJpeg12.cxx
97 bool gdcm_write_JPEG_file12 (FILE* fp, void* image_buffer,
98 int image_width, int image_height,
101 void SaveInitialValues(); // will belong to the future gdcmPixelData class
102 void RestoreInitialValues(); // will belong to the future gdcmPixelData class
103 void DeleteInitialValues(); // will belong to the future gdcmPixelData class
105 // members variables:
107 /// \brief Header to use to load the file
110 /// \brief Whether the underlying \ref gdcmHeader was loaded by
111 /// the constructor or passed to the constructor. When false
112 /// the destructor is in charge of deletion.
115 /// wether already parsed
119 // --------------- Will be moved to a gdcmPixelData class
122 /// \brief to hold the Pixels (when read)
123 uint8_t* Pixel_Data; // (was PixelData)
125 /// \brief Size (in bytes) of required memory to hold the Gray Level pixels
126 /// represented in this file. This is used when the user DOESN'T want
127 /// the RGB pixels image when it's stored as a PALETTE COLOR image
128 size_t ImageDataSizeRaw;
130 /// \brief Size (in bytes) of requited memory to hold the the pixels
131 /// of this image in it's RGB convertion either from:
132 /// - Plane R, Plane G, Plane B
133 /// - Grey Plane + Palette Color
134 /// - YBR Pixels (or from RGB Pixels, as well)
135 size_t ImageDataSize;
137 /// \brief ==1 if GetImageDataRaw was used
138 /// ==0 if GetImageData was used
139 /// ==-1 if ImageData never read
142 /// \brief length of the last allocated area devoided to receive Pixels
143 /// ( to allow us not to (free + new) if un necessary )
144 size_t LastAllocatedPixelDataLength;
146 // Initial values of some fields that can be modified during reading process
147 // if user asked to transform gray level + LUT image into RGB image
149 /// \brief Samples Per Pixel (0x0028,0x0002), as found on disk
150 std::string InitialSpp;
151 /// \brief Photometric Interpretation (0x0028,0x0004), as found on disk
152 std::string InitialPhotInt;
153 /// \brief Planar Configuration (0x0028,0x0006), as found on disk
154 std::string InitialPlanConfig;
156 // Initial values of some fields that can be modified during reading process
157 // if the image was a 'strange' ACR-NEMA
158 // (Bits Allocated=12, High Bit not equal to Bits stored +1)
159 /// \brief Bits Allocated (0x0028,0x0100), as found on disk
160 std::string InitialBitsAllocated;
161 /// \brief High Bit (0x0028,0x0102), as found on disk
162 std::string InitialHighBit;
164 // some DocEntry that can be moved out of the H table during reading process
165 // if user asked to transform gray level + LUT image into RGB image
166 // We keep a pointer on them for a future use.
168 /// \brief Red Palette Color Lookup Table Descriptor 0028 1101 as read
169 gdcmDocEntry* InitialRedLUTDescr;
170 /// \brief Green Palette Color Lookup Table Descriptor 0028 1102 as read
171 gdcmDocEntry* InitialGreenLUTDescr;
172 /// \brief Blue Palette Color Lookup Table Descriptor 0028 1103 as read
173 gdcmDocEntry* InitialBlueLUTDescr;
175 /// \brief Red Palette Color Lookup Table Data 0028 1201 as read
176 gdcmDocEntry* InitialRedLUTData;
177 /// \brief Green Palette Color Lookup Table Data 0028 1202 as read
178 gdcmDocEntry* InitialGreenLUTData;
179 /// \brief Blue Palette Color Lookup Table Data 0028 1203 as read
180 gdcmDocEntry* InitialBlueLUTData;
183 // --------------- end of future gdcmPixelData class
188 //-----------------------------------------------------------------------------