1 /*=========================================================================
4 Module: $RCSfile: gdcmFile.h,v $
6 Date: $Date: 2004/09/13 07:49:36 $
7 Version: $Revision: 1.47 $
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.htm 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 void SetPixelDataSizeFromHeader();
45 /// \brief Returns the size (in bytes) of required memory to hold
46 /// the pixel data represented in this file.
47 size_t GetImageDataSize(){ return ImageDataSize; };
50 /// \brief Returns the size (in bytes) of required memory to hold
51 /// the pixel data represented in this file, if user DOESN'T want
52 /// to get RGB pixels image when it's stored as a PALETTE COLOR image
53 /// -the (vtk) user is supposed to know how to deal with LUTs-
54 size_t GetImageDataSizeRaw(){ return ImageDataSizeRaw; };
56 void * GetImageData();
57 size_t GetImageDataIntoVector(void* destination, size_t maxSize);
58 void * GetImageDataRaw();
59 size_t GetImageDataIntoVectorRaw(void* destination, size_t maxSize);
61 // Allocates ExpectedSize bytes of memory at this->Data and copies the
62 // pointed data to it. Copying the image might look useless but
63 // the caller might destroy it's image (without knowing it: think
64 // of a complicated interface where display is done with a library
65 // e.g. VTK) before calling the Write
67 // see also gdcmHeader::SetImageDataSize ?!?
68 bool SetImageData (void * data, size_t expectedSize);
70 /// \todo When the caller is aware we simply point to the data:
71 /// int SetImageDataNoCopy (void * Data, size_t ExpectedSize);
73 // Write pixels of ONE image on hard drive
74 // No test is made on processor "endianity"
75 // The user must call his reader correctly
76 bool WriteRawData (std::string const & fileName);
77 bool WriteDcmImplVR(std::string const & fileName);
78 bool WriteDcmExplVR(std::string const & fileName);
79 bool WriteAcr (std::string const & fileName);
81 // Don't look any longer for the code :
82 // It's in file gdcmParsePixels.cxx
83 bool ParsePixelData();
85 virtual bool SetEntryByNumber(std::string const & content,
86 uint16_t group, uint16_t element)
88 Header->SetEntryByNumber(content,group,element);
93 bool WriteBase(std::string const & fileName, FileType type);
96 void SwapZone(void* im, int swap, int lgr, int nb);
97 void SetInitialValues();
98 bool ReadPixelData(void * destination);
100 // For JPEG 8 Bits, body in file gdcmJpeg.cxx
101 bool gdcm_read_JPEG_file (FILE *fp, void * image_buffer);
102 static int gdcm_read_RLE_fragment(char **areaToRead, long lengthToDecode,
103 long uncompressedSegmentSize, FILE *fp);
105 // For JPEG 12 Bits, body in file gdcmJpeg12.cxx
106 bool gdcm_read_JPEG_file12 (FILE *fp, void* image_buffer);
108 // For JPEG 2000, body in file gdcmJpeg2000.cxx
109 bool gdcm_read_JPEG2000_file (FILE *fp, void* image_buffer);
111 // For Run Length Encoding
112 bool gdcm_read_RLE_file (FILE *fp, void* image_buffer);
114 // members variables:
116 /// \brief Header to use to load the file
119 /// \brief Whether the underlying \ref gdcmHeader was loaded by
120 /// the constructor or passed to the constructor. When false
121 /// the destructor is in charge of deletion.
124 /// \brief to hold the Pixels (when read)
125 void* Pixel_Data; // (was PixelData; should be removed)
127 /// \brief Area length to receive the pixels
128 size_t ImageDataSizeRaw;
130 /// \brief Area length to receive the RGB pixels
131 /// from Grey Plane + Palette Color
132 size_t ImageDataSize;
134 /// \brief ==1 if GetImageDataRaw was used
135 /// ==0 if GetImageData was used
136 /// ==-1 if ImageData never read
139 /// wether already parsed
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;
155 /// \brief Bits Allocated (0x0028,0x0100), as found on disk
156 std::string InitialBitsAllocated;
158 // some DocEntry that can be moved out of the H table during reading process
159 // if user asked to transform gray level + LUT image into RGB image
160 // We keep a pointer on them for a future use.
162 /// \brief Red Palette Color Lookup Table Descriptor 0028 1101 as read
163 gdcmDocEntry* InitialRedLUTDescr;
164 /// \brief Green Palette Color Lookup Table Descriptor 0028 1102 as read
165 gdcmDocEntry* InitialGreenLUTDescr;
166 /// \brief Blue Palette Color Lookup Table Descriptor 0028 1103 as read
167 gdcmDocEntry* InitialBlueLUTDescr;
169 /// \brief Red Palette Color Lookup Table Data 0028 1201 as read
170 gdcmDocEntry* InitialRedLUTData;
171 /// \brief Green Palette Color Lookup Table Data 0028 1202 as read
172 gdcmDocEntry* InitialGreenLUTData;
173 /// \brief Blue Palette Color Lookup Table Data 0028 1203 as read
174 gdcmDocEntry* InitialBlueLUTData;
178 //-----------------------------------------------------------------------------