1 /*=========================================================================
4 Module: $RCSfile: gdcmFile.h,v $
6 Date: $Date: 2004/10/18 12:49:22 $
7 Version: $Revision: 1.63 $
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"
24 #include "gdcmPixelConvert.h"
29 //-----------------------------------------------------------------------------
31 * In addition to Dicom header exploration, this class is designed
32 * for accessing the image/volume content. One can also use it to
33 * write Dicom/ACR-NEMA/RAW files.
35 class GDCM_EXPORT File
38 File( Header* header );
39 File( std::string const& filename );
43 /// Accessor to \ref Header
44 Header* GetHeader() { return HeaderInternal; }
46 int ComputeDecompressedPixelDataSizeFromHeader();
48 /// Accessor to \ref ImageDataSize
49 size_t GetImageDataSize(){ return ImageDataSize; };
51 /// Accessor to \ref ImageDataSizeRaw
52 size_t GetImageDataSizeRaw(){ return ImageDataSizeRaw; };
54 uint8_t* GetImageData();
55 size_t GetImageDataIntoVector(void* destination, size_t maxSize);
56 uint8_t* GetImageDataRaw();
57 void GetImageDataIntoVectorRaw(void* destination, size_t maxSize);
59 // see also Header::SetImageDataSize ?!?
60 bool SetImageData (uint8_t* data, size_t expectedSize);
62 /// \todo When the caller is aware we simply point to the data:
63 /// int SetImageDataNoCopy (void* Data, size_t ExpectedSize);
65 // Write pixels of ONE image on hard drive
66 // No test is made on processor "endianity"
67 // The user must call his reader correctly
68 bool WriteRawData (std::string const& fileName);
69 bool WriteDcmImplVR(std::string const& fileName);
70 bool WriteDcmExplVR(std::string const& fileName);
71 bool WriteAcr (std::string const& fileName);
73 // Don't look any longer for the code :
74 // It's in file gdcmParsePixels.cxx
75 bool ParsePixelData();
77 virtual bool SetEntryByNumber(std::string const& content,
78 uint16_t group, uint16_t element)
80 HeaderInternal->SetEntryByNumber(content,group,element);
83 uint8_t* GetLutRGBA();
86 bool WriteBase(std::string const& fileName, FileType type);
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 PixelData class
102 void RestoreInitialValues(); // will belong to the future PixelData class
103 void DeleteInitialValues(); // will belong to the future PixelData class
106 // members variables:
108 /// Header to use to load the file
109 Header *HeaderInternal;
111 /// \brief Whether the underlying \ref Header was loaded by
112 /// the constructor or passed to the constructor. When false
113 /// the destructor is in charge of deletion.
116 /// wether already parsed
120 PixelConvert PixelConverter;
122 // --------------- Will be moved to a PixelData class
125 /// \brief to hold the Pixels (when read)
126 uint8_t* Pixel_Data; // (was PixelData)
128 /// \brief Size (in bytes) of required memory to hold the Gray Level pixels
129 /// represented in this file. This is used when the user DOESN'T want
130 /// the RGB pixels image when it's stored as a PALETTE COLOR image
131 size_t ImageDataSizeRaw;
133 /// \brief Size (in bytes) of requited memory to hold the the pixels
134 /// of this image in it's RGB convertion either from:
135 /// - Plane R, Plane G, Plane B
136 /// - Grey Plane + Palette Color
137 /// - YBR Pixels (or from RGB Pixels, as well)
138 size_t ImageDataSize;
140 /// \brief ==1 if GetImageDataRaw was used
141 /// ==0 if GetImageData was used
142 /// ==-1 if ImageData never read
145 /// \brief length of the last allocated area devoided to receive Pixels
146 /// ( to allow us not to (free + new) if un necessary )
147 size_t LastAllocatedPixelDataLength;
149 // Initial values of some fields that can be modified during reading process
150 // if user asked to transform gray level + LUT image into RGB image
152 /// \brief Samples Per Pixel (0x0028,0x0002), as found on disk
153 std::string InitialSpp;
154 /// \brief Photometric Interpretation (0x0028,0x0004), as found on disk
155 std::string InitialPhotInt;
156 /// \brief Planar Configuration (0x0028,0x0006), as found on disk
157 std::string InitialPlanConfig;
159 // Initial values of some fields that can be modified during reading process
160 // if the image was a 'strange' ACR-NEMA
161 // (Bits Allocated=12, High Bit not equal to Bits stored +1)
162 /// \brief Bits Allocated (0x0028,0x0100), as found on disk
163 std::string InitialBitsAllocated;
164 /// \brief High Bit (0x0028,0x0102), as found on disk
165 std::string InitialHighBit;
167 // some DocEntry that can be moved out of the H table during reading process
168 // if user asked to transform gray level + LUT image into RGB image
169 // We keep a pointer on them for a future use.
171 /// \brief Red Palette Color Lookup Table Descriptor 0028 1101 as read
172 DocEntry* InitialRedLUTDescr;
173 /// \brief Green Palette Color Lookup Table Descriptor 0028 1102 as read
174 DocEntry* InitialGreenLUTDescr;
175 /// \brief Blue Palette Color Lookup Table Descriptor 0028 1103 as read
176 DocEntry* InitialBlueLUTDescr;
178 /// \brief Red Palette Color Lookup Table Data 0028 1201 as read
179 DocEntry* InitialRedLUTData;
180 /// \brief Green Palette Color Lookup Table Data 0028 1202 as read
181 DocEntry* InitialGreenLUTData;
182 /// \brief Blue Palette Color Lookup Table Data 0028 1203 as read
183 DocEntry* InitialBlueLUTData;
186 // --------------- end of future PixelData class
190 } // end namespace gdcm
192 //-----------------------------------------------------------------------------