1 /*=========================================================================
4 Module: $RCSfile: gdcmFileHelper.h,v $
6 Date: $Date: 2006/04/11 16:03:26 $
7 Version: $Revision: 1.42 $
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 =========================================================================*/
19 #ifndef GDCMFILEHELPER_H
20 #define GDCMFILEHELPER_H
22 #include "gdcmDebug.h"
23 #include "gdcmRefCounter.h"
24 #include "gdcmVRKey.h"
32 class PixelReadConvert;
33 class PixelWriteConvert;
34 class DocEntryArchive;
36 typedef void (*VOID_FUNCTION_PUINT8_PFILE_POINTER)(uint8_t *, File *);
38 //-----------------------------------------------------------------------------
40 * \brief In addition to Dicom header exploration, this class is designed
41 * for accessing the image/volume content. One can also use it to
42 * write Dicom/ACR-NEMA/RAW files.
44 class GDCM_EXPORT FileHelper : public RefCounter
46 gdcmTypeMacro(FileHelper);
55 /// \brief Constructs a FileHelper with a RefCounter
56 static FileHelper *New() {return new FileHelper();}
57 /// \brief Constructs a FileHelper with a RefCounter from a fileHelper
58 static FileHelper *New(File *header) {return new FileHelper(header);}
60 void Print(std::ostream &os = std::cout, std::string const &indent = "");
62 /// Accessor to \ref File
63 File *GetFile() { return FileInternal; }
66 void SetLoadMode(int loadMode);
67 void SetFileName(std::string const &fileName);
69 /// to allow user to modify pixel order (e.g. Mirror, UpsideDown,...)
70 void SetUserFunction( VOID_FUNCTION_PUINT8_PFILE_POINTER userFunc )
71 { UserFunction = userFunc; }
73 bool SetEntryString(std::string const &content,
74 uint16_t group, uint16_t elem);
75 bool SetEntryBinArea(uint8_t *content, int lgth,
76 uint16_t group, uint16_t elem);
78 DataEntry *InsertEntryString(std::string const &content,
79 uint16_t group, uint16_t elem);
80 DataEntry *InsertEntryBinArea(uint8_t *binArea, int lgth,
81 uint16_t group, uint16_t elem);
82 SeqEntry *InsertSeqEntry(uint16_t group, uint16_t elem);
85 size_t GetImageDataSize();
86 size_t GetImageDataRawSize();
88 uint8_t *GetImageData();
89 uint8_t *GetImageDataRaw();
91 GDCM_LEGACY(size_t GetImageDataIntoVector(void *destination,size_t maxSize));
93 void SetImageData(uint8_t *data, size_t expectedSize);
96 void SetUserData(uint8_t *data, size_t expectedSize);
97 uint8_t *GetUserData();
98 size_t GetUserDataSize();
99 // RBG data (from file)
100 uint8_t *GetRGBData();
101 size_t GetRGBDataSize();
102 // RAW data (from file)
103 uint8_t *GetRawData();
104 size_t GetRawDataSize();
107 uint8_t* GetLutRGBA();
108 int GetLutItemNumber();
109 int GetLutItemSize();
113 /// \brief Tells the writer we want to keep 'Grey pixels + Palettes color'
114 /// when possible (as opposed to convert 'Palettes color' to RGB)
115 void SetWriteModeToRaw() { SetWriteMode(WMODE_RAW); }
116 /// \brief Tells the writer we want to write RGB image when possible
117 /// (as opposed to 'Grey pixels + Palettes color')
118 void SetWriteModeToRGB() { SetWriteMode(WMODE_RGB); }
119 /// \brief Sets the Write Mode ( )
120 void SetWriteMode(FileMode mode) {
122 // Deal with Samples per Pixel
123 //if (mode == WMODE_RGB) FileInternal->InsertEntryString("3",0x0028,0x0002);
125 /// \brief Gets the Write Mode ( )
126 FileMode GetWriteMode() { return WriteMode; }
130 /// \brief Tells the writer we want to write as Implicit VR
131 void SetWriteTypeToDcmImplVR() { SetWriteType(ImplicitVR); }
132 /// \brief Tells the writer we want to write as Explicit VR
133 void SetWriteTypeToDcmExplVR() { SetWriteType(ExplicitVR); }
134 /// \brief Tells the writer we want to write as ACR-NEMA
135 void SetWriteTypeToAcr() { SetWriteType(ACR); }
136 /// \brief Tells the writer we want to write as LibIDO
137 void SetWriteTypeToAcrLibido() { SetWriteType(ACR_LIBIDO); }
138 /// \brief Tells the writer we want to write as JPEG
139 void SetWriteTypeToJPEG() { SetWriteType(JPEG); }
140 /// \brief Tells the writer which format we want to write
141 /// (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
142 void SetWriteType(FileType format) { WriteType = format; }
143 /// \brief Gets the format we talled the write we wanted to write
144 /// (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
145 FileType GetWriteType() { return WriteType; }
147 // Write pixels of ONE image on hard drive
148 // No test is made on processor "endianness"
149 // The user must call his reader correctly
150 bool WriteRawData (std::string const &fileName);
151 bool WriteDcmImplVR(std::string const &fileName);
152 bool WriteDcmExplVR(std::string const &fileName);
153 bool WriteAcr (std::string const &fileName);
154 bool Write (std::string const &fileName);
156 /// \brief We have to deal with 4 *very* different cases :
157 /// -1) user created ex nihilo his own image and wants to write it as a Dicom image.
159 /// -2) user modified the pixels of an existing image.
161 /// -3) user created a new image, using existing images (eg MIP, MPR, cartography image)
163 /// -4) user modified/added some tags *without processing* the pixels (anonymization...
164 /// UNMODIFIED_PIXELS_IMAGE
166 void SetContentType (ImageContentType c) { ContentType = c; }
167 // no GetContentType() method, on purpose!
169 void CallStartMethod();
170 void CallProgressMethod();
171 void CallEndMethod();
175 FileHelper( File *header );
178 bool CheckWriteIntegrity();
180 void SetWriteToRaw();
181 void SetWriteToRGB();
184 void SetWriteFileTypeToACR();
185 void SetWriteFileTypeToJPEG();
186 void SetWriteFileTypeToExplicitVR();
187 void SetWriteFileTypeToImplicitVR();
188 void RestoreWriteFileType();
190 void SetWriteToLibido();
191 void SetWriteToNoLibido();
192 void RestoreWriteOfLibido();
194 DataEntry *CopyDataEntry(uint16_t group, uint16_t elem,
195 const VRKey &vr = GDCM_VRUNKNOWN);
196 void CheckMandatoryElements();
197 void CheckMandatoryEntry(uint16_t group, uint16_t elem, std::string value,
198 const VRKey &vr = GDCM_VRUNKNOWN);
199 void SetMandatoryEntry(uint16_t group, uint16_t elem, std::string value,
200 const VRKey &vr = GDCM_VRUNKNOWN);
201 void CopyMandatoryEntry(uint16_t group, uint16_t elem, std::string value,
202 const VRKey &vr = GDCM_VRUNKNOWN);
203 void RestoreWriteMandatory();
210 // members variables:
212 /// value of the ??? for any progress bar
218 /// gdcm::File to use to load the file
221 /// Whether already parsed or not
224 // Utility pixel converter
225 /// \brief Pointer to the PixelReadConverter
226 PixelReadConvert *PixelReadConverter;
227 /// \brief Pointer to the PixelWriteConverter
228 PixelWriteConvert *PixelWriteConverter;
230 // Utility header archive
231 /// \brief Pointer to the DocEntryArchive (used while writting process)
232 DocEntryArchive *Archive;
235 /// \brief (WMODE_RAW, WMODE_RGB)
238 /// \brief (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
241 /// \brief Pointer to a user supplied function to allow modification
242 /// of pixel order (e.g. : Mirror, UpsideDown, 90°Rotation, ...)
243 /// use as : void userSuppliedFunction(uint8_t *im, gdcm::File *f)
244 /// NB : the "uint8_t *" type of first param is just for prototyping.
245 /// User will Cast it according what he founds with f->GetPixelType()
246 /// See vtkgdcmSerieViewer for an example
247 VOID_FUNCTION_PUINT8_PFILE_POINTER UserFunction;
249 /// \brief only user knows what he did before asking the image to be written
250 /// - he created ex nihilo his own image
251 /// - he just applied a mathematical process on the pixels
252 /// - he created a new image, using existing images (eg MIP, MPR,cartography)
253 /// - he anonymized and image (*no* modif on the pixels)
254 ImageContentType ContentType;
257 } // end namespace gdcm
259 //-----------------------------------------------------------------------------