1 /*=========================================================================
4 Module: $RCSfile: gdcmFileHelper.h,v $
6 Date: $Date: 2005/02/04 14:49:01 $
7 Version: $Revision: 1.10 $
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
31 class PixelReadConvert;
32 class PixelWriteConvert;
33 class DocEntryArchive;
34 //-----------------------------------------------------------------------------
36 * \brief In addition to Dicom header exploration, this class is designed
37 * for accessing the image/volume content. One can also use it to
38 * write Dicom/ACR-NEMA/RAW files.
40 class GDCM_EXPORT FileHelper : public Base
51 FileHelper( File *header );
52 FileHelper( std::string const &filename );
54 virtual ~FileHelper();
56 void Print(std::ostream &os = std::cout, std::string const &indent = "");
58 /// Accessor to \ref File
59 File *GetFile() { return FileInternal; }
62 bool SetValEntry(std::string const &content,
63 uint16_t group, uint16_t elem);
64 bool SetBinEntry(uint8_t *content, int lgth,
65 uint16_t group, uint16_t elem);
67 ValEntry *InsertValEntry(std::string const &content,
68 uint16_t group, uint16_t elem);
69 BinEntry *InsertBinEntry(uint8_t *binArea, int lgth,
70 uint16_t group, uint16_t elem);
71 SeqEntry *InsertSeqEntry(uint16_t group, uint16_t elem);
74 size_t GetImageDataSize();
75 size_t GetImageDataRawSize();
77 uint8_t *GetImageData();
78 uint8_t *GetImageDataRaw();
79 size_t GetImageDataIntoVector(void *destination, size_t maxSize);
81 void SetImageData(uint8_t *data, size_t expectedSize);
84 void SetUserData(uint8_t *data, size_t expectedSize);
85 uint8_t* GetUserData();
86 size_t GetUserDataSize();
87 // RBG data (from file)
88 uint8_t* GetRGBData();
89 size_t GetRGBDataSize();
90 // RAW data (from file)
91 uint8_t* GetRawData();
92 size_t GetRawDataSize();
95 uint8_t* GetLutRGBA();
99 /// \brief Tells the writer we want to write a Raw File (no header)
100 void SetWriteModeToRaw() { SetWriteMode(WMODE_RAW); };
101 /// \brief Tells the writer we want to write RGB image when possible
102 /// (as opposite to 'Grey pixels + Palettes color')
103 void SetWriteModeToRGB() { SetWriteMode(WMODE_RGB); };
104 /// \brief Sets the Write Mode ( )
105 void SetWriteMode(FileMode mode) { WriteMode = mode; };
106 /// \brief Gets the Write Mode ( )
107 FileMode GetWriteMode() { return WriteMode; };
111 /// \brief Tells the writer we want to write as Implicit VR
112 void SetWriteTypeToDcmImplVR() { SetWriteType(ImplicitVR); };
113 /// \brief Tells the writer we want to write as Explicit VR
114 void SetWriteTypeToDcmExplVR() { SetWriteType(ExplicitVR); };
115 /// \brief Tells the writer we want to write as ACR-NEMA
116 void SetWriteTypeToAcr() { SetWriteType(ACR); };
117 /// \brief Tells the writer we want to write as LibIDO
118 void SetWriteTypeToAcrLibido() { SetWriteType(ACR_LIBIDO); };
119 /// \brief Tells the writer which format want to write
120 /// (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
121 void SetWriteType(FileType format) { WriteType = format; };
122 /// \brief Gets the format we want to write
123 /// (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
124 FileType GetWriteType() { return WriteType; };
126 // Write pixels of ONE image on hard drive
127 // No test is made on processor "endianness"
128 // The user must call his reader correctly
129 bool WriteRawData (std::string const &fileName);
130 bool WriteDcmImplVR(std::string const &fileName);
131 bool WriteDcmExplVR(std::string const &fileName);
132 bool WriteAcr (std::string const &fileName);
133 bool Write (std::string const &fileName);
136 bool CheckWriteIntegrity();
138 void SetWriteToRaw();
139 void SetWriteToRGB();
142 void SetWriteFileTypeToACR();
143 void SetWriteFileTypeToExplicitVR();
144 void SetWriteFileTypeToImplicitVR();
145 void RestoreWriteFileType();
147 void SetWriteToLibido();
148 void SetWriteToNoLibido();
149 void RestoreWriteOfLibido();
151 ValEntry *CopyValEntry(uint16_t group, uint16_t elem);
152 BinEntry *CopyBinEntry(uint16_t group, uint16_t elem);
159 // members variables:
160 /// gdcm::File to use to load the file
163 /// \brief Whether the underlying \ref gdcm::File was loaded by
164 /// the constructor or passed to the constructor. When false
165 /// the destructor is in charge of deletion.
168 /// Wether already parsed or not
171 // Utility pixel converter
172 /// \brief Pointer to the PixelReadConverter
173 PixelReadConvert *PixelReadConverter;
174 /// \brief Pointer to the PixelWriteConverter
175 PixelWriteConvert *PixelWriteConverter;
177 // Utility header archive
178 /// \brief Pointer to the DocEntryArchive (used while writting process)
179 DocEntryArchive *Archive;
182 /// \brief (WMODE_RAW, WMODE_RGB)
184 /// \brief (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
187 } // end namespace gdcm
189 //-----------------------------------------------------------------------------