1 /*=========================================================================
4 Module: $RCSfile: gdcmFileHelper.cxx,v $
7 Date: $Date: 2005/03/04 11:15:56 $
8 Version: $Revision: 1.26 $
10 Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
11 l'Image). All rights reserved. See Doc/License.txt or
12 http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
14 This software is distributed WITHOUT ANY WARRANTY; without even
15 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
16 PURPOSE. See the above copyright notices for more information.
18 =========================================================================*/
20 #include "gdcmFileHelper.h"
21 #include "gdcmGlobal.h"
23 #include "gdcmDocument.h"
24 #include "gdcmDebug.h"
26 #include "gdcmBinEntry.h"
27 #include "gdcmValEntry.h"
28 #include "gdcmSeqEntry.h"
29 #include "gdcmSQItem.h"
30 #include "gdcmContentEntry.h"
32 #include "gdcmPixelReadConvert.h"
33 #include "gdcmPixelWriteConvert.h"
34 #include "gdcmDocEntryArchive.h"
35 #include "gdcmDictSet.h"
40 // ----------------------------- WARNING -------------------------
42 These lines will be moved to the document-to-be 'User's Guide'
44 // To read an image, user needs a gdcm::File
45 gdcm::File *f1 = new gdcm::File(fileName);
46 // user can now check some values
47 std::string v = f1->GetEntryValue(groupNb,ElementNb);
48 // to get the pixels, user needs a gdcm::FileHelper
49 gdcm::FileHelper *fh1 = new gdcm::FileHelper(f1);
50 // user may ask not to convert Palette to RGB
51 uint8_t *pixels = fh1->GetImageDataRaw();
52 int imageLength = fh1->GetImageDataRawSize();
53 // He can now use the pixels, create a new image, ...
54 uint8_t *userPixels = ...
56 To re-write the image, user re-uses the gdcm::FileHelper
58 fh1->SetImageData( userPixels, userPixelsLength);
59 fh1->SetTypeToRaw(); // Even if it was possible to convert Palette to RGB
62 fh1->SetWriteTypeToDcmExpl(); // he wants Explicit Value Representation
63 // Little Endian is the default
64 // no other value is allowed
65 (-->SetWriteType(ExplicitVR);)
66 -->WriteType = ExplicitVR;
67 fh1->Write(newFileName); // overwrites the file, if any
70 fh1->WriteDcmExplVR(newFileName);
73 // ----------------------------- WARNING -------------------------
75 These lines will be moved to the document-to-be 'Developer's Guide'
77 WriteMode : WMODE_RAW / WMODE_RGB
78 WriteType : ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO
80 fh1->Write(newFileName);
81 SetWriteFileTypeToImplicitVR() / SetWriteFileTypeToExplicitVR();
82 (modifies TransferSyntax)
83 SetWriteToRaw(); / SetWriteToRGB();
84 (modifies, when necessary : photochromatic interpretation,
85 samples per pixel, Planar configuration,
86 bits allocated, bits stored, high bit -ACR 24 bits-
87 Pixels element VR, pushes out the LUT )
88 CheckWriteIntegrity();
89 (checks user given pixels length)
90 FileInternal->Write(fileName,WriteType)
91 fp = opens file(fileName);
92 ComputeGroup0002Length(writetype);
94 RemoveEntryNoDestroy(palettes, etc)
95 Document::WriteContent(fp, writetype);
97 (moves back to the File all the archived elements)
98 RestoreWriteFileType();
99 (pushes back group 0002, with TransferSyntax)
107 //-------------------------------------------------------------------------
108 // Constructor / Destructor
110 * \brief Constructor dedicated to deal with the *pixels* area of a ACR/DICOMV3
111 * file (gdcm::File only deals with the ... header)
112 * Opens (in read only and when possible) an existing file and checks
113 * for DICOM compliance. Returns NULL on failure.
114 * It will be up to the user to load the pixels into memory
115 * \note the in-memory representation of all available tags found in
116 * the DICOM header is post-poned to first header information access.
117 * This avoid a double parsing of public part of the header when
118 * one sets an a posteriori shadow dictionary (efficiency can be
119 * seen as a side effect).
121 FileHelper::FileHelper( )
123 FileInternal = new File( );
129 * \brief Constructor dedicated to deal with the *pixels* area of a ACR/DICOMV3
130 * file (File only deals with the ... header)
131 * Opens (in read only and when possible) an existing file and checks
132 * for DICOM compliance. Returns NULL on failure.
133 * It will be up to the user to load the pixels into memory
134 * \note the in-memory representation of all available tags found in
135 * the DICOM header is post-poned to first header information access.
136 * This avoid a double parsing of public part of the header when
137 * user sets an a posteriori shadow dictionary (efficiency can be
138 * seen as a side effect).
139 * @param header already built Header
141 FileHelper::FileHelper(File *header)
143 FileInternal = header;
149 * \brief Constructor dedicated to deal with the *pixels* area of a ACR/DICOMV3
150 * file (gdcm::File only deals with the ... header)
151 * Opens (in read only and when possible) an existing file and checks
152 * for DICOM compliance. Returns NULL on failure.
153 * It will be up to the user to load the pixels into memory
154 * \note the in-memory representation of all available tags found in
155 * the DICOM header is post-poned to first header information access.
156 * This avoid a double parsing of public part of the header when
157 * one sets an a posteriori shadow dictionary (efficiency can be
158 * seen as a side effect).
159 * @param filename file to be opened for parsing
161 FileHelper::FileHelper(std::string const &filename )
163 FileInternal = new File( filename );
169 * \brief canonical destructor
170 * \note If the header (gdcm::File) was created by the FileHelper constructor,
171 * it is destroyed by the FileHelper
173 FileHelper::~FileHelper()
175 if( PixelReadConverter )
177 delete PixelReadConverter;
179 if( PixelWriteConverter )
181 delete PixelWriteConverter;
195 //-----------------------------------------------------------------------------
198 * \brief Accesses an existing DocEntry (i.e. a Dicom Element)
199 * through it's (group, element) and modifies it's content with
201 * @param content new value (string) to substitute with
202 * @param group group number of the Dicom Element to modify
203 * @param elem element number of the Dicom Element to modify
204 * \return false if DocEntry not found
206 bool FileHelper::SetValEntry(std::string const &content,
207 uint16_t group, uint16_t elem)
209 return FileInternal->SetValEntry(content, group, elem);
214 * \brief Accesses an existing DocEntry (i.e. a Dicom Element)
215 * through it's (group, element) and modifies it's content with
217 * @param content new value (void* -> uint8_t*) to substitute with
218 * @param lgth new value length
219 * @param group group number of the Dicom Element to modify
220 * @param elem element number of the Dicom Element to modify
221 * \return false if DocEntry not found
223 bool FileHelper::SetBinEntry(uint8_t *content, int lgth,
224 uint16_t group, uint16_t elem)
226 return FileInternal->SetBinEntry(content, lgth, group, elem);
230 * \brief Modifies the value of a given DocEntry (Dicom entry)
231 * when it exists. Creates it with the given value when unexistant.
232 * @param content (string)value to be set
233 * @param group Group number of the Entry
234 * @param elem Element number of the Entry
235 * \return pointer to the modified/created Dicom entry (NULL when creation
238 ValEntry *FileHelper::InsertValEntry(std::string const &content,
239 uint16_t group, uint16_t elem)
241 return FileInternal->InsertValEntry(content,group,elem);
245 * \brief Modifies the value of a given DocEntry (Dicom entry)
246 * when it exists. Creates it with the given value when unexistant.
247 * A copy of the binArea is made to be kept in the Document.
248 * @param binArea (binary)value to be set
249 * @param lgth new value length
250 * @param group Group number of the Entry
251 * @param elem Element number of the Entry
252 * \return pointer to the modified/created Dicom entry (NULL when creation
255 BinEntry *FileHelper::InsertBinEntry(uint8_t *binArea, int lgth,
256 uint16_t group, uint16_t elem)
258 return FileInternal->InsertBinEntry(binArea, lgth, group, elem);
262 * \brief Modifies the value of a given DocEntry (Dicom entry)
263 * when it exists. Creates it, empty (?!) when unexistant.
264 * @param group Group number of the Entry
265 * @param elem Element number of the Entry
266 * \return pointer to the modified/created Dicom entry (NULL when creation
269 SeqEntry *FileHelper::InsertSeqEntry(uint16_t group, uint16_t elem)
271 return FileInternal->InsertSeqEntry(group, elem);
275 * \brief Get the size of the image data
276 * If the image can be RGB (with a lut or by default), the size
277 * corresponds to the RGB image
278 * (use GetImageDataRawSize if you want to be sure to get *only*
279 * the size of the pixels)
280 * @return The image size
282 size_t FileHelper::GetImageDataSize()
284 if ( PixelWriteConverter->GetUserData() )
286 return PixelWriteConverter->GetUserDataSize();
289 return PixelReadConverter->GetRGBSize();
293 * \brief Get the size of the image data
294 * If the image could be converted to RGB using a LUT,
295 * this transformation is not taken into account by GetImageDataRawSize
296 * (use GetImageDataSize if you wish)
297 * @return The raw image size
299 size_t FileHelper::GetImageDataRawSize()
301 if ( PixelWriteConverter->GetUserData() )
303 return PixelWriteConverter->GetUserDataSize();
306 return PixelReadConverter->GetRawSize();
310 * \brief - Allocates necessary memory,
311 * - Reads the pixels from disk (uncompress if necessary),
312 * - Transforms YBR pixels, if any, into RGB pixels,
313 * - Transforms 3 planes R, G, B, if any, into a single RGB Plane
314 * - Transforms single Grey plane + 3 Palettes into a RGB Plane
315 * - Copies the pixel data (image[s]/volume[s]) to newly allocated zone.
316 * @return Pointer to newly allocated pixel data.
317 * NULL if alloc fails
319 uint8_t *FileHelper::GetImageData()
321 if ( PixelWriteConverter->GetUserData() )
323 return PixelWriteConverter->GetUserData();
328 // If the decompression failed nothing can be done.
332 if ( FileInternal->HasLUT() && PixelReadConverter->BuildRGBImage() )
334 return PixelReadConverter->GetRGB();
338 // When no LUT or LUT conversion fails, return the Raw
339 return PixelReadConverter->GetRaw();
344 * \brief Allocates necessary memory,
345 * Transforms YBR pixels (if any) into RGB pixels
346 * Transforms 3 planes R, G, B (if any) into a single RGB Plane
347 * Copies the pixel data (image[s]/volume[s]) to newly allocated zone.
348 * DOES NOT transform Grey plane + 3 Palettes into a RGB Plane
349 * @return Pointer to newly allocated pixel data.
350 * NULL if alloc fails
352 uint8_t *FileHelper::GetImageDataRaw ()
359 * Read the pixels from disk (uncompress if necessary),
360 * Transforms YBR pixels, if any, into RGB pixels
361 * Transforms 3 planes R, G, B, if any, into a single RGB Plane
362 * Transforms single Grey plane + 3 Palettes into a RGB Plane
363 * Copies at most MaxSize bytes of pixel data to caller allocated
365 * \warning This function allows people that want to build a volume
366 * from an image stack *not to* have, first to get the image pixels,
367 * and then move them to the volume area.
368 * It's absolutely useless for any VTK user since vtk chooses
369 * to invert the lines of an image, that is the last line comes first
370 * (for some axis related reasons?). Hence he will have
371 * to load the image line by line, starting from the end.
372 * VTK users have to call GetImageData
374 * @param destination Address (in caller's memory space) at which the
375 * pixel data should be copied
376 * @param maxSize Maximum number of bytes to be copied. When MaxSize
377 * is not sufficient to hold the pixel data the copy is not
378 * executed (i.e. no partial copy).
379 * @return On success, the number of bytes actually copied. Zero on
380 * failure e.g. MaxSize is lower than necessary.
382 size_t FileHelper::GetImageDataIntoVector (void *destination, size_t maxSize)
386 // If the decompression failed nothing can be done.
390 if ( FileInternal->HasLUT() && PixelReadConverter->BuildRGBImage() )
392 if ( PixelReadConverter->GetRGBSize() > maxSize )
394 gdcmWarningMacro( "Pixel data bigger than caller's expected MaxSize");
398 (void*)PixelReadConverter->GetRGB(),
399 PixelReadConverter->GetRGBSize() );
400 return PixelReadConverter->GetRGBSize();
403 // Either no LUT conversion necessary or LUT conversion failed
404 if ( PixelReadConverter->GetRawSize() > maxSize )
406 gdcmWarningMacro( "Pixel data bigger than caller's expected MaxSize");
410 (void*)PixelReadConverter->GetRaw(),
411 PixelReadConverter->GetRawSize() );
412 return PixelReadConverter->GetRawSize();
416 * \brief Points the internal pointer to the callers inData
417 * image representation, BUT WITHOUT COPYING THE DATA.
418 * 'image' Pixels are presented as C-like 2D arrays : line per line.
419 * 'volume'Pixels are presented as C-like 3D arrays : plane per plane
420 * \warning Since the pixels are not copied, it is the caller's responsability
421 * not to deallocate its data before gdcm uses them (e.g. with
422 * the Write() method )
423 * @param inData user supplied pixel area (uint8_t* is just for the compiler.
424 * user is allowed to pass any kind of pixelsn since the size is
426 * @param expectedSize total image size, *in Bytes*
428 void FileHelper::SetImageData(uint8_t *inData, size_t expectedSize)
430 SetUserData(inData, expectedSize);
434 * \brief Set the image data defined by the user
435 * \warning When writting the file, this data are get as default data to write
436 * @param inData user supplied pixel area (uint8_t* is just for the compiler.
437 * user is allowed to pass any kind of pixels since the size is
439 * @param expectedSize total image size, *in Bytes*
441 void FileHelper::SetUserData(uint8_t *inData, size_t expectedSize)
443 PixelWriteConverter->SetUserData(inData, expectedSize);
447 * \brief Get the image data defined by the user
448 * \warning When writting the file, this data are get as default data to write
450 uint8_t *FileHelper::GetUserData()
452 return PixelWriteConverter->GetUserData();
456 * \brief Get the image data size defined by the user
457 * \warning When writting the file, this data are get as default data to write
459 size_t FileHelper::GetUserDataSize()
461 return PixelWriteConverter->GetUserDataSize();
465 * \brief Get the image data from the file.
466 * If a LUT is found, the data are expanded to be RGB
468 uint8_t *FileHelper::GetRGBData()
470 return PixelReadConverter->GetRGB();
474 * \brief Get the image data size from the file.
475 * If a LUT is found, the data are expanded to be RGB
477 size_t FileHelper::GetRGBDataSize()
479 return PixelReadConverter->GetRGBSize();
483 * \brief Get the image data from the file.
484 * Even when a LUT is found, the data are not expanded to RGB!
486 uint8_t *FileHelper::GetRawData()
488 return PixelReadConverter->GetRaw();
492 * \brief Get the image data size from the file.
493 * Even when a LUT is found, the data are not expanded to RGB!
495 size_t FileHelper::GetRawDataSize()
497 return PixelReadConverter->GetRawSize();
501 * \brief Access to the underlying \ref PixelReadConverter RGBA LUT
503 uint8_t* FileHelper::GetLutRGBA()
505 return PixelReadConverter->GetLutRGBA();
509 * \brief Writes on disk A SINGLE Dicom file
510 * NO test is performed on processor "Endiannity".
511 * It's up to the user to call his Reader properly
512 * @param fileName name of the file to be created
513 * (any already existing file is over written)
514 * @return false if write fails
516 bool FileHelper::WriteRawData(std::string const &fileName)
518 std::ofstream fp1(fileName.c_str(), std::ios::out | std::ios::binary );
521 gdcmWarningMacro( "Fail to open (write) file:" << fileName.c_str());
525 if( PixelWriteConverter->GetUserData() )
527 fp1.write( (char*)PixelWriteConverter->GetUserData(),
528 PixelWriteConverter->GetUserDataSize() );
530 else if ( PixelReadConverter->GetRGB() )
532 fp1.write( (char*)PixelReadConverter->GetRGB(),
533 PixelReadConverter->GetRGBSize());
535 else if ( PixelReadConverter->GetRaw() )
537 fp1.write( (char*)PixelReadConverter->GetRaw(),
538 PixelReadConverter->GetRawSize());
542 gdcmErrorMacro( "Nothing written." );
551 * \brief Writes on disk A SINGLE Dicom file,
552 * using the Implicit Value Representation convention
553 * NO test is performed on processor "Endiannity".
554 * @param fileName name of the file to be created
555 * (any already existing file is overwritten)
556 * @return false if write fails
559 bool FileHelper::WriteDcmImplVR (std::string const &fileName)
561 SetWriteTypeToDcmImplVR();
562 return Write(fileName);
566 * \brief Writes on disk A SINGLE Dicom file,
567 * using the Explicit Value Representation convention
568 * NO test is performed on processor "Endiannity".
569 * @param fileName name of the file to be created
570 * (any already existing file is overwritten)
571 * @return false if write fails
574 bool FileHelper::WriteDcmExplVR (std::string const &fileName)
576 SetWriteTypeToDcmExplVR();
577 return Write(fileName);
581 * \brief Writes on disk A SINGLE Dicom file,
582 * using the ACR-NEMA convention
583 * NO test is performed on processor "Endiannity".
584 * (a l'attention des logiciels cliniques
585 * qui ne prennent en entrée QUE des images ACR ...
586 * \warning if a DICOM_V3 header is supplied,
587 * groups < 0x0008 and shadow groups are ignored
588 * \warning NO TEST is performed on processor "Endiannity".
589 * @param fileName name of the file to be created
590 * (any already existing file is overwritten)
591 * @return false if write fails
594 bool FileHelper::WriteAcr (std::string const &fileName)
597 return Write(fileName);
601 * \brief Writes on disk A SINGLE Dicom file,
602 * @param fileName name of the file to be created
603 * (any already existing file is overwritten)
604 * @return false if write fails
606 bool FileHelper::Write(std::string const &fileName)
611 SetWriteFileTypeToImplicitVR();
612 CheckMandatoryElements();
615 SetWriteFileTypeToExplicitVR();
616 CheckMandatoryElements();
620 SetWriteFileTypeToACR();
623 SetWriteFileTypeToExplicitVR();
624 CheckMandatoryElements();
627 // --------------------------------------------------------------
628 // Special Patch to allow gdcm to re-write ACR-LibIDO formated images
630 // if recognition code tells us we dealt with a LibIDO image
631 // we reproduce on disk the switch between lineNumber and columnNumber
632 // just before writting ...
633 /// \todo the best trick would be *change* the recognition code
634 /// but pb expected if user deals with, e.g. COMPLEX images
635 if( WriteType == ACR_LIBIDO )
641 SetWriteToNoLibido();
643 // ----------------- End of Special Patch ----------------
648 SetWriteToRaw(); // modifies and pushes to the archive, when necessary
651 SetWriteToRGB(); // modifies and pushes to the archive, when necessary
655 bool check = CheckWriteIntegrity(); // verifies length
658 check = FileInternal->Write(fileName,WriteType);
662 RestoreWriteFileType();
664 // --------------------------------------------------------------
665 // Special Patch to allow gdcm to re-write ACR-LibIDO formated images
667 // ...and we restore the header to be Dicom Compliant again
668 // just after writting
669 RestoreWriteOfLibido();
670 // ----------------- End of Special Patch ----------------
675 //-----------------------------------------------------------------------------
678 * \brief Checks the write integrity
680 * The tests made are :
681 * - verify the size of the image to write with the possible write
682 * when the user set an image data
683 * @return true if check is successfull
685 bool FileHelper::CheckWriteIntegrity()
687 if(PixelWriteConverter->GetUserData())
689 int numberBitsAllocated = FileInternal->GetBitsAllocated();
690 if ( numberBitsAllocated == 0 || numberBitsAllocated == 12 )
692 numberBitsAllocated = 16;
695 size_t decSize = FileInternal->GetXSize()
696 * FileInternal->GetYSize()
697 * FileInternal->GetZSize()
698 * ( numberBitsAllocated / 8 )
699 * FileInternal->GetSamplesPerPixel();
700 size_t rgbSize = decSize;
701 if( FileInternal->HasLUT() )
702 rgbSize = decSize * 3;
707 if( decSize!=PixelWriteConverter->GetUserDataSize() )
709 gdcmWarningMacro( "Data size (Raw) is incorrect. Should be "
710 << decSize << " / Found :"
711 << PixelWriteConverter->GetUserDataSize() );
716 if( rgbSize!=PixelWriteConverter->GetUserDataSize() )
718 gdcmWarningMacro( "Data size (RGB) is incorrect. Should be "
719 << decSize << " / Found "
720 << PixelWriteConverter->GetUserDataSize() );
731 * \brief Updates the File to write RAW data (as opposed to RGB data)
732 * (modifies, when necessary, photochromatic interpretation,
733 * bits allocated, Pixels element VR)
735 void FileHelper::SetWriteToRaw()
737 if( FileInternal->GetNumberOfScalarComponents() == 3
738 && !FileInternal->HasLUT())
744 ValEntry *photInt = CopyValEntry(0x0028,0x0004);
745 if(FileInternal->HasLUT())
747 photInt->SetValue("PALETTE COLOR ");
751 photInt->SetValue("MONOCHROME2 ");
754 PixelWriteConverter->SetReadData(PixelReadConverter->GetRaw(),
755 PixelReadConverter->GetRawSize());
757 std::string vr = "OB";
758 if( FileInternal->GetBitsAllocated()>8 )
760 if( FileInternal->GetBitsAllocated()==24 ) // For RGB ACR files
763 CopyBinEntry(GetFile()->GetGrPixel(),GetFile()->GetNumPixel(),vr);
764 pixel->SetValue(GDCM_BINLOADED);
765 pixel->SetBinArea(PixelWriteConverter->GetData(),false);
766 pixel->SetLength(PixelWriteConverter->GetDataSize());
768 Archive->Push(photInt);
769 Archive->Push(pixel);
774 * \brief Updates the File to write RGB data (as opposed to RAW data)
775 * (modifies, when necessary, photochromatic interpretation,
776 * samples per pixel, Planar configuration,
777 * bits allocated, bits stored, high bit -ACR 24 bits-
778 * Pixels element VR, pushes out the LUT, )
780 void FileHelper::SetWriteToRGB()
782 if(FileInternal->GetNumberOfScalarComponents()==3)
784 PixelReadConverter->BuildRGBImage();
786 ValEntry *spp = CopyValEntry(0x0028,0x0002);
789 ValEntry *planConfig = CopyValEntry(0x0028,0x0006);
790 planConfig->SetValue("0 ");
792 ValEntry *photInt = CopyValEntry(0x0028,0x0004);
793 photInt->SetValue("RGB ");
795 if(PixelReadConverter->GetRGB())
797 PixelWriteConverter->SetReadData(PixelReadConverter->GetRGB(),
798 PixelReadConverter->GetRGBSize());
802 PixelWriteConverter->SetReadData(PixelReadConverter->GetRaw(),
803 PixelReadConverter->GetRawSize());
806 std::string vr = "OB";
807 if( FileInternal->GetBitsAllocated()>8 )
809 if( FileInternal->GetBitsAllocated()==24 ) // For RGB ACR files
812 CopyBinEntry(GetFile()->GetGrPixel(),GetFile()->GetNumPixel(),vr);
813 pixel->SetValue(GDCM_BINLOADED);
814 pixel->SetBinArea(PixelWriteConverter->GetData(),false);
815 pixel->SetLength(PixelWriteConverter->GetDataSize());
818 Archive->Push(planConfig);
819 Archive->Push(photInt);
820 Archive->Push(pixel);
823 Archive->Push(0x0028,0x1101);
824 Archive->Push(0x0028,0x1102);
825 Archive->Push(0x0028,0x1103);
826 Archive->Push(0x0028,0x1201);
827 Archive->Push(0x0028,0x1202);
828 Archive->Push(0x0028,0x1203);
830 // For old '24 Bits' ACR-NEMA
831 // Thus, we have a RGB image and the bits allocated = 24 and
832 // samples per pixels = 1 (in the read file)
833 if(FileInternal->GetBitsAllocated()==24)
835 ValEntry *bitsAlloc = CopyValEntry(0x0028,0x0100);
836 bitsAlloc->SetValue("8 ");
838 ValEntry *bitsStored = CopyValEntry(0x0028,0x0101);
839 bitsStored->SetValue("8 ");
841 ValEntry *highBit = CopyValEntry(0x0028,0x0102);
842 highBit->SetValue("7 ");
844 Archive->Push(bitsAlloc);
845 Archive->Push(bitsStored);
846 Archive->Push(highBit);
856 * \brief Restore the File write mode
858 void FileHelper::RestoreWrite()
860 Archive->Restore(0x0028,0x0002);
861 Archive->Restore(0x0028,0x0004);
862 Archive->Restore(0x0028,0x0006);
863 Archive->Restore(GetFile()->GetGrPixel(),GetFile()->GetNumPixel());
865 // For old ACR-NEMA (24 bits problem)
866 Archive->Restore(0x0028,0x0100);
867 Archive->Restore(0x0028,0x0101);
868 Archive->Restore(0x0028,0x0102);
871 Archive->Restore(0x0028,0x1101);
872 Archive->Restore(0x0028,0x1102);
873 Archive->Restore(0x0028,0x1103);
874 Archive->Restore(0x0028,0x1201);
875 Archive->Restore(0x0028,0x1202);
876 Archive->Restore(0x0028,0x1203);
878 // group 0002 may be pushed out for ACR-NEMA writting purposes
879 Archive->Restore(0x0002,0x0000);
880 Archive->Restore(0x0002,0x0001);
881 Archive->Restore(0x0002,0x0002);
882 Archive->Restore(0x0002,0x0003);
883 Archive->Restore(0x0002,0x0010);
884 Archive->Restore(0x0002,0x0012);
885 Archive->Restore(0x0002,0x0013);
886 Archive->Restore(0x0002,0x0016);
887 Archive->Restore(0x0002,0x0100);
888 Archive->Restore(0x0002,0x0102);
892 * \brief Pushes out the whole group 0002
893 * FIXME : better, set a flag to tell the writer not to write it ...
894 * FIXME : method should probably have an other name !
895 * SetWriteFileTypeToACR is NOT opposed to
896 * SetWriteFileTypeToExplicitVR and SetWriteFileTypeToImplicitVR
898 void FileHelper::SetWriteFileTypeToACR()
900 Archive->Push(0x0002,0x0000);
901 Archive->Push(0x0002,0x0001);
902 Archive->Push(0x0002,0x0002);
903 Archive->Push(0x0002,0x0003);
904 Archive->Push(0x0002,0x0010);
905 Archive->Push(0x0002,0x0012);
906 Archive->Push(0x0002,0x0013);
907 Archive->Push(0x0002,0x0016);
908 Archive->Push(0x0002,0x0100);
909 Archive->Push(0x0002,0x0102);
913 * \brief Sets in the File the TransferSyntax to 'Explicit VR Little Endian"
915 void FileHelper::SetWriteFileTypeToExplicitVR()
917 std::string ts = Util::DicomString(
918 Global::GetTS()->GetSpecialTransferSyntax(TS::ExplicitVRLittleEndian) );
920 ValEntry *tss = CopyValEntry(0x0002,0x0010);
927 * \brief Sets in the File the TransferSyntax to 'Implicit VR Little Endian"
929 void FileHelper::SetWriteFileTypeToImplicitVR()
931 std::string ts = Util::DicomString(
932 Global::GetTS()->GetSpecialTransferSyntax(TS::ImplicitVRLittleEndian) );
934 ValEntry *tss = CopyValEntry(0x0002,0x0010);
942 * \brief Restore in the File the initial group 0002
944 void FileHelper::RestoreWriteFileType()
946 // group 0002 may be pushed out for ACR-NEMA writting purposes
947 Archive->Restore(0x0002,0x0000);
948 Archive->Restore(0x0002,0x0001);
949 Archive->Restore(0x0002,0x0002);
950 Archive->Restore(0x0002,0x0003);
951 Archive->Restore(0x0002,0x0010);
952 Archive->Restore(0x0002,0x0012);
953 Archive->Restore(0x0002,0x0013);
954 Archive->Restore(0x0002,0x0016);
955 Archive->Restore(0x0002,0x0100);
956 Archive->Restore(0x0002,0x0102);
960 * \brief Set the Write not to Libido format
962 void FileHelper::SetWriteToLibido()
964 ValEntry *oldRow = dynamic_cast<ValEntry *>
965 (FileInternal->GetDocEntry(0x0028, 0x0010));
966 ValEntry *oldCol = dynamic_cast<ValEntry *>
967 (FileInternal->GetDocEntry(0x0028, 0x0011));
969 if( oldRow && oldCol )
971 std::string rows, columns;
973 ValEntry *newRow=new ValEntry(oldRow->GetDictEntry());
974 ValEntry *newCol=new ValEntry(oldCol->GetDictEntry());
976 newRow->Copy(oldCol);
977 newCol->Copy(oldRow);
979 newRow->SetValue(oldCol->GetValue());
980 newCol->SetValue(oldRow->GetValue());
982 Archive->Push(newRow);
983 Archive->Push(newCol);
986 ValEntry *libidoCode = CopyValEntry(0x0008,0x0010);
987 libidoCode->SetValue("ACRNEMA_LIBIDO_1.1");
988 Archive->Push(libidoCode);
992 * \brief Set the Write not to No Libido format
994 void FileHelper::SetWriteToNoLibido()
996 ValEntry *recCode = dynamic_cast<ValEntry *>
997 (FileInternal->GetDocEntry(0x0008,0x0010));
1000 if( recCode->GetValue() == "ACRNEMA_LIBIDO_1.1" )
1002 ValEntry *libidoCode = CopyValEntry(0x0008,0x0010);
1003 libidoCode->SetValue("");
1004 Archive->Push(libidoCode);
1010 * \brief Restore the Write format
1012 void FileHelper::RestoreWriteOfLibido()
1014 Archive->Restore(0x0028,0x0010);
1015 Archive->Restore(0x0028,0x0011);
1016 Archive->Restore(0x0008,0x0010);
1020 * \brief Duplicates a ValEntry or creates it.
1021 * @param group Group number of the Entry
1022 * @param elem Element number of the Entry
1023 * \return pointer to the new Val Entry (NULL when creation failed).
1025 ValEntry *FileHelper::CopyValEntry(uint16_t group, uint16_t elem)
1027 DocEntry *oldE = FileInternal->GetDocEntry(group, elem);
1032 newE = new ValEntry(oldE->GetDictEntry());
1037 newE = GetFile()->NewValEntry(group, elem);
1044 * \brief Duplicates a BinEntry or creates it.
1045 * @param group Group number of the Entry
1046 * @param elem Element number of the Entry
1047 * @param vr Value Representation of the Entry
1048 * FIXME : what is it used for?
1049 * \return pointer to the new Bin Entry (NULL when creation failed).
1051 BinEntry *FileHelper::CopyBinEntry(uint16_t group, uint16_t elem,
1052 const std::string &vr)
1054 DocEntry *oldE = FileInternal->GetDocEntry(group, elem);
1058 if( oldE ) // Is this really usefull?
1059 if( oldE->GetVR()!=vr )
1062 gdcmWarningMacro( " Unconsistent VR for Bin Entry : [" << oldE->GetVR()
1063 << "] vs [" << vr << "] for " <<
1064 std::hex << group << "|" << elem);
1069 newE = new BinEntry(oldE->GetDictEntry());
1074 newE = GetFile()->NewBinEntry(group, elem, vr);
1081 * \brief This method is called automatically, just before writting
1082 * in order to produce a 'True Dicom V3' image
1083 * We cannot know *how* the user made the File (reading an old ACR-NEMA
1084 * file or a not very clean DICOM file ...)
1086 * Just before writting :
1087 * - we check the Entries
1088 * - we create the mandatory entries if they are missing
1089 * - we modify the values if necessary
1090 * - we push the sensitive entries to the Archive
1091 * The writing process will restore the entries as they where before
1092 * entering FileHelper::CheckMandatoryElements, so the user will always
1093 * see the entries just as he left them.
1095 * \todo : - warn the user if we had to add some entries :
1096 * even if a mandatory entry is missing, we add it, with a default value
1097 * (we don't want to give up the writting process if user forgot to
1098 * specify Lena's Patient ID, for instance ...)
1099 * - read the whole PS 3.3 Part of DICOM (890 pages)
1100 * and write a *full* checker (probably one method per Modality ...)
1101 * Any contribution is welcome.
1102 * - write a user callable full checker, to allow post reading
1103 * and/or pre writting image consistency check.
1106 void FileHelper::CheckMandatoryElements()
1108 // just to remember : 'official' 0002 group
1110 //0002 0000 UL 1 Meta Group Length
1111 //0002 0001 OB 1 File Meta Information Version
1112 //0002 0002 UI 1 Media Stored SOP Class UID
1113 //0002 0003 UI 1 Media Stored SOP Instance UID
1114 //0002 0010 UI 1 Transfer Syntax UID
1115 //0002 0012 UI 1 Implementation Class UID
1116 //0002 0013 SH 1 Implementation Version Name
1117 //0002 0016 AE 1 Source Application Entity Title
1118 //0002 0100 UI 1 Private Information Creator
1119 //0002 0102 OB 1 Private Information
1121 // Create them if not found
1122 // Always modify the value
1123 // Push the entries to the archive.
1125 ValEntry *e_0002_0000 = CopyValEntry(0x0002,0x0000);
1126 e_0002_0000->SetValue("0"); // for the moment
1127 Archive->Push(e_0002_0000);
1129 BinEntry *e_0002_0001 = CopyBinEntry(0x0002,0x0001, "OB");
1130 e_0002_0001->SetBinArea((uint8_t*)Util::GetFileMetaInformationVersion(),
1132 e_0002_0001->SetLength(2);
1134 ValEntry *e_0002_0002 = CopyValEntry(0x0002,0x0002);
1135 // [Secondary Capture Image Storage]
1136 e_0002_0002->SetValue("1.2.840.10008.5.1.4.1.1.7");
1137 Archive->Push(e_0002_0002);
1139 // 'Media Stored SOP Instance UID'
1140 ValEntry *e_0002_0003 = CopyValEntry(0x0002,0x0003);
1141 e_0002_0003->SetValue(Util::CreateUniqueUID());
1142 Archive->Push(e_0002_0003);
1144 ValEntry *e_0002_0010 = CopyValEntry(0x0002,0x0010);
1145 //[Explicit VR - Little Endian]
1146 e_0002_0010->SetValue("1.2.840.10008.1.2.1");
1147 Archive->Push(e_0002_0010);
1149 // 'Implementation Class UID'
1150 ValEntry *e_0002_0012 = CopyValEntry(0x0002,0x0012);
1151 e_0002_0012->SetValue(Util::CreateUniqueUID());
1152 Archive->Push(e_0002_0012);
1154 // 'Implementation Version Name'
1155 ValEntry *e_0002_0013 = CopyValEntry(0x0002,0x0013);
1156 e_0002_0013->SetValue("GDCM 1.0");
1157 Archive->Push(e_0002_0013);
1159 //'Source Application Entity Title' Not Mandatory
1160 //ValEntry *e_0002_0016 = CopyValEntry(0x0002,0x0016);
1161 // e_0002_0016->SetValue("1.2.840.10008.5.1.4.1.1.7");
1162 // Archive->Push(e_0002_0016);
1164 // Push out 'LibIDO-special' entries, if any
1165 Archive->Push(0x0028,0x0015);
1166 Archive->Push(0x0028,0x0016);
1167 Archive->Push(0x0028,0x0017);
1168 Archive->Push(0x0028,0x00199);
1170 // --- Check UID-related Entries ---
1172 // If 'SOP Class UID' exists ('true DICOM' image)
1173 // we create the 'Source Image Sequence' SeqEntry
1174 // to hold informations about the Source Image
1176 ValEntry *e_0008_0016 = FileInternal->GetValEntry(0x0008, 0x0016);
1177 if ( e_0008_0016 != 0 )
1179 // Create 'Source Image Sequence' SeqEntry
1180 SeqEntry *s = new SeqEntry (
1181 Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0008, 0x2112) );
1182 SQItem *sqi = new SQItem(1);
1183 // (we assume 'SOP Instance UID' exists too)
1184 // create 'Referenced SOP Class UID'
1185 ValEntry *e_0008_1150 = new ValEntry(
1186 Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0008, 0x1150) );
1187 e_0008_1150->SetValue( e_0008_0016->GetValue());
1188 sqi->AddEntry(e_0008_1150);
1190 // create 'Referenced SOP Instance UID'
1191 ValEntry *e_0008_0018 = FileInternal->GetValEntry(0x0008, 0x0018);
1192 ValEntry *e_0008_1155 = new ValEntry(
1193 Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0008, 0x1155) );
1194 e_0008_1155->SetValue( e_0008_0018->GetValue());
1195 sqi->AddEntry(e_0008_1155);
1197 s->AddSQItem(sqi,1);
1198 // temporarily replaces any previous 'Source Image Sequence'
1201 // 'Image Type' (The written image is no longer an 'ORIGINAL' one)
1202 ValEntry *e_0008_0008 = CopyValEntry(0x0008,0x0008);
1203 e_0008_0008->SetValue("DERIVED\\PRIMARY");
1204 Archive->Push(e_0008_0008);
1208 // There was no 'SOP Class UID'.
1209 // the source image was NOT a true Dicom one.
1210 // We consider the image is a 'Secondary Capture' one
1212 e_0008_0016 = new ValEntry(
1213 Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0008, 0x0016) );
1214 // [Secondary Capture Image Storage]
1215 e_0008_0016 ->SetValue("1.2.840.10008.5.1.4.1.1.7");
1216 Archive->Push(e_0008_0016);
1219 // ---- The user will never have to take any action on the following ----.
1221 // new value for 'SOP Instance UID'
1222 ValEntry *e_0008_0018 = new ValEntry(
1223 Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0008, 0x0018) );
1224 e_0008_0018->SetValue( Util::CreateUniqueUID() );
1225 Archive->Push(e_0008_0018);
1227 // Instance Creation Date
1228 ValEntry *e_0008_0012 = CopyValEntry(0x0008,0x0012);
1229 std::string date = Util::GetCurrentDate();
1230 e_0008_0012->SetValue(date.c_str());
1231 Archive->Push(e_0008_0012);
1233 // Instance Creation Time
1234 ValEntry *e_0008_0013 = CopyValEntry(0x0008,0x0013);
1235 std::string time = Util::GetCurrentTime();
1236 e_0008_0013->SetValue(time.c_str());
1237 Archive->Push(e_0008_0013);
1239 // ----- Add Mandatory Entries if missing ---
1241 // Entries whose type is 1 are mandatory, with a mandatory value
1242 // Entries whose type is 1c are mandatory-inside-a-Sequence
1243 // Entries whose type is 2 are mandatory, with a optional value
1244 // Entries whose type is 2c are mandatory-inside-a-Sequence
1245 // Entries whose type is 3 are optional
1247 // 'Serie Instance UID'
1248 // Keep the value if exists
1249 // The user is allowed to create his own Series,
1250 // keeping the same 'Serie Instance UID' for various images
1251 // The user shouldn't add any image to a 'Manufacturer Serie'
1252 // but there is no way no to allowed him to do that
1253 ValEntry *e_0020_000e = FileInternal->GetValEntry(0x0020, 0x000e);
1256 e_0020_000e = new ValEntry(
1257 Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0020, 0x000e) );
1258 e_0020_000e->SetValue(Util::CreateUniqueUID() );
1259 Archive->Push(e_0020_000e);
1262 // 'Study Instance UID'
1263 // Keep the value if exists
1264 // The user is allowed to create his own Study,
1265 // keeping the same 'Study Instance UID' for various images
1266 // The user may add images to a 'Manufacturer Study',
1267 // adding new series to an already existing Study
1268 ValEntry *e_0020_000d = FileInternal->GetValEntry(0x0020, 0x000d);
1271 e_0020_000d = new ValEntry(
1272 Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0020, 0x000d) );
1273 e_0020_000d->SetValue(Util::CreateUniqueUID() );
1274 Archive->Push(e_0020_000d);
1277 // Modality : if missing we set it to 'OTher'
1278 ValEntry *e_0008_0060 = FileInternal->GetValEntry(0x0008, 0x0060);
1281 e_0008_0060 = new ValEntry(
1282 Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0008, 0x0060) );
1283 e_0008_0060->SetValue("OT");
1284 Archive->Push(e_0008_0060);
1287 // Manufacturer : if missing we set it to 'GDCM Factory'
1288 ValEntry *e_0008_0070 = FileInternal->GetValEntry(0x0008, 0x0070);
1291 e_0008_0070 = new ValEntry(
1292 Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0008, 0x0070) );
1293 e_0008_0070->SetValue("GDCM Factory");
1294 Archive->Push(e_0008_0070);
1297 // Institution Name : if missing we set it to 'GDCM Hospital'
1298 ValEntry *e_0008_0080 = FileInternal->GetValEntry(0x0008, 0x0080);
1301 e_0008_0080 = new ValEntry(
1302 Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0008, 0x0080) );
1303 e_0008_0080->SetValue("GDCM Hospital");
1304 Archive->Push(e_0008_0080);
1307 // Patient's Name : if missing, we set it to 'GDCM^Patient'
1308 ValEntry *e_0010_0010 = FileInternal->GetValEntry(0x0010, 0x0010);
1311 e_0010_0010 = new ValEntry(
1312 Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0010, 0x0010) );
1313 e_0010_0010->SetValue("GDCM^Patient");
1314 Archive->Push(e_0010_0010);
1317 // Patient's ID : if missing, we set it to 'GDCM_Patient_ID'
1318 ValEntry *e_0010_0020 = FileInternal->GetValEntry(0x0010, 0x0020);
1321 e_0010_0020 = new ValEntry(
1322 Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0010, 0x0020) );
1323 e_0010_0020->SetValue("GDCM_Patient_ID");
1324 Archive->Push(e_0010_0020);
1327 // Patient's Birth Date :'type 2' entry -> must exist, value not mandatory
1328 ValEntry *e_0010_0030 = FileInternal->GetValEntry(0x0010, 0x0030);
1331 e_0010_0030 = new ValEntry(
1332 Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0010, 0x0030) );
1333 e_0010_0030->SetValue("");
1334 Archive->Push(e_0010_0030);
1337 // Patient's Sex :'type 2' entry -> must exist, value not mandatory
1338 ValEntry *e_0010_0040 = FileInternal->GetValEntry(0x0010, 0x0040);
1341 e_0010_0040 = new ValEntry(
1342 Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0010, 0x0040) );
1343 e_0010_0040->SetValue("");
1344 Archive->Push(e_0010_0040);
1347 // Referring Physician's Name :'type 2' entry -> must exist, value not mandatory
1348 ValEntry *e_0008_0090 = FileInternal->GetValEntry(0x0008, 0x0090);
1351 e_0008_0090 = new ValEntry(
1352 Global::GetDicts()->GetDefaultPubDict()->GetEntry(0x0008, 0x0090) );
1353 e_0008_0090->SetValue("");
1354 Archive->Push(e_0008_0090);
1357 // Remove some inconstencies (probably some more will be added)
1359 // if (0028 0008)Number of Frames exists
1360 // Push out (0020 0052),Frame of Reference UID
1361 // (only meaningfull within a Serie)
1362 ValEntry *e_0028_0008 = FileInternal->GetValEntry(0x0028, 0x0008);
1365 Archive->Push(0x0020, 0X0052);
1369 //-----------------------------------------------------------------------------
1372 * \brief Factorization for various forms of constructors.
1374 void FileHelper::Initialize()
1376 WriteMode = WMODE_RAW;
1377 WriteType = ExplicitVR;
1379 PixelReadConverter = new PixelReadConvert;
1380 PixelWriteConverter = new PixelWriteConvert;
1381 Archive = new DocEntryArchive( FileInternal );
1383 if ( FileInternal->IsReadable() )
1385 PixelReadConverter->GrabInformationsFromFile( FileInternal );
1392 uint8_t *FileHelper::GetRaw()
1394 uint8_t *raw = PixelReadConverter->GetRaw();
1397 // The Raw image migth not be loaded yet:
1398 std::ifstream *fp = FileInternal->OpenFile();
1399 PixelReadConverter->ReadAndDecompressPixelData( fp );
1401 FileInternal->CloseFile();
1403 raw = PixelReadConverter->GetRaw();
1406 gdcmWarningMacro( "Read/decompress of pixel data apparently went wrong.");
1414 //-----------------------------------------------------------------------------
1416 void FileHelper::Print(std::ostream &os, std::string const &)
1418 FileInternal->SetPrintLevel(PrintLevel);
1419 FileInternal->Print(os);
1421 PixelReadConverter->SetPrintLevel(PrintLevel);
1422 PixelReadConverter->Print(os);
1425 //-----------------------------------------------------------------------------
1426 } // end namespace gdcm