1 /*=========================================================================
4 Module: $RCSfile: gdcmFileHelper.h,v $
6 Date: $Date: 2005/01/25 15:44:24 $
7 Version: $Revision: 1.7 $
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 = "");
59 bool SetValEntry(std::string const &content,
60 uint16_t group, uint16_t elem);
61 bool SetBinEntry(uint8_t *content, int lgth,
62 uint16_t group, uint16_t elem);
64 ValEntry *InsertValEntry(std::string const &content,
65 uint16_t group, uint16_t elem);
66 BinEntry *InsertBinEntry(uint8_t *binArea, int lgth,
67 uint16_t group, uint16_t elem);
68 SeqEntry *InsertSeqEntry(uint16_t group, uint16_t elem);
70 /// Accessor to \ref File
71 File *GetFile() { return FileInternal; }
73 size_t GetImageDataSize();
74 size_t GetImageDataRawSize();
76 uint8_t *GetImageData();
77 uint8_t *GetImageDataRaw();
78 size_t GetImageDataIntoVector(void *destination, size_t maxSize);
80 void SetImageData(uint8_t *data, size_t expectedSize);
83 void SetUserData(uint8_t *data, size_t expectedSize);
84 uint8_t* GetUserData();
85 size_t GetUserDataSize();
86 // RBG data (from file
87 uint8_t* GetRGBData();
88 size_t GetRGBDataSize();
89 // RAW data (from file
90 uint8_t* GetRawData();
91 size_t GetRawDataSize();
93 // Write pixels of ONE image on hard drive
94 // No test is made on processor "endianity"
95 // The user must call his reader correctly
96 bool WriteRawData (std::string const &fileName);
97 bool WriteDcmImplVR(std::string const &fileName);
98 bool WriteDcmExplVR(std::string const &fileName);
99 bool WriteAcr (std::string const &fileName);
100 bool Write (std::string const &fileName);
102 uint8_t* GetLutRGBA();
105 void SetWriteModeToRaw() { SetWriteMode(WMODE_RAW); };
106 void SetWriteModeToRGB() { SetWriteMode(WMODE_RGB); };
107 void SetWriteMode(FileMode mode) { WriteMode = mode; };
108 FileMode GetWriteMode() { return WriteMode; };
111 void SetWriteTypeToDcmImplVR() { SetWriteType(ImplicitVR); };
112 void SetWriteTypeToDcmExplVR() { SetWriteType(ExplicitVR); };
113 void SetWriteTypeToAcr() { SetWriteType(ACR); };
114 void SetWriteTypeToAcrLibido() { SetWriteType(ACR_LIBIDO); };
115 void SetWriteType(FileType format) { WriteType = format; };
116 FileType GetWriteType() { return WriteType; };
119 bool CheckWriteIntegrity();
121 void SetWriteToRaw();
122 void SetWriteToRGB();
125 void SetWriteFileTypeToACR();
126 void SetWriteFileTypeToExplicitVR();
127 void SetWriteFileTypeToImplicitVR();
128 void RestoreWriteFileType();
130 void SetWriteToLibido();
131 void SetWriteToNoLibido();
132 void RestoreWriteOfLibido();
134 ValEntry *CopyValEntry(uint16_t group,uint16_t elem);
135 BinEntry *CopyBinEntry(uint16_t group,uint16_t elem);
142 // members variables:
143 /// gdcm::File to use to load the file
146 /// \brief Whether the underlying \ref gdcm::File was loaded by
147 /// the constructor or passed to the constructor. When false
148 /// the destructor is in charge of deletion.
151 /// Wether already parsed or not
154 /// Utility pixel converter
155 PixelReadConvert *PixelReadConverter;
156 PixelWriteConvert *PixelWriteConverter;
158 // Utility header archive
159 DocEntryArchive *Archive;
165 } // end namespace gdcm
167 //-----------------------------------------------------------------------------