1 /*=========================================================================
4 Module: $RCSfile: gdcmFile.cxx,v $
6 Date: $Date: 2005/02/05 01:37:08 $
7 Version: $Revision: 1.212 $
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 =========================================================================*/
20 // -------------- Remember ! ----------------------------------
22 // Image Position Patient (0020,0032):
23 // If not found (ACR_NEMA) we try Image Position (0020,0030)
24 // If not found (ACR-NEMA), we consider Slice Location (0020,1041)
25 // or Location (0020,0050)
26 // as the Z coordinate,
27 // 0. for all the coordinates if nothing is found
29 // ---------------------------------------------------------------
32 #include "gdcmGlobal.h"
34 #include "gdcmDebug.h"
36 #include "gdcmValEntry.h"
37 #include "gdcmBinEntry.h"
38 #include "gdcmRLEFramesInfo.h"
39 #include "gdcmJPEGFragmentsInfo.h"
41 #include <stdio.h> //sscanf
46 //-----------------------------------------------------------------------------
47 // Constructor / Destructor
50 * @param filename name of the file whose header we want to analyze
52 File::File( std::string const &filename )
55 RLEInfo = new RLEFramesInfo;
56 JPEGInfo = new JPEGFragmentsInfo;
58 // for some ACR-NEMA images GrPixel, NumPixel is *not* 7fe0,0010
59 // We may encounter the 'RETired' (0x0028, 0x0200) tag
60 // (Image Location") . This entry contains the number of
61 // the group that contains the pixel data (hence the "Pixel Data"
62 // is found by indirection through the "Image Location").
63 // Inside the group pointed by "Image Location" the searched element
64 // is conventionally the element 0x0010 (when the norm is respected).
65 // When the "Image Location" is missing we default to group 0x7fe0.
66 // Note: this IS the right place for the code
69 const std::string &imgLocation = GetEntryValue(0x0028, 0x0200);
70 if ( imgLocation == GDCM_UNFOUND )
77 GrPixel = (uint16_t) atoi( imgLocation.c_str() );
80 // sometimes Image Location value doesn't follow
81 // the supposed processor endianness.
82 // see gdcmData/cr172241.dcm
83 if ( GrPixel == 0xe07f )
88 if ( GrPixel != 0x7fe0 )
90 // This is a kludge for old dirty Philips imager.
98 // Now, we know GrPixel and NumPixel.
99 // Let's create a VirtualDictEntry to allow a further VR modification
100 // and force VR to match with BitsAllocated.
101 DocEntry *entry = GetDocEntry(GrPixel, NumPixel);
104 // Compute the RLE or JPEG info
106 std::string ts = GetTransferSyntax();
107 Fp->seekg( entry->GetOffset(), std::ios::beg );
108 if ( Global::GetTS()->IsRLELossless(ts) )
110 else if ( Global::GetTS()->IsJPEG(ts) )
111 ComputeJPEGFragmentInfo();
114 // Create a new BinEntry to change the the DictEntry
115 // The changed DictEntry will have
116 // - a correct PixelVR OB or OW)
118 // - the name to "Pixel Data"
119 BinEntry *oldEntry = dynamic_cast<BinEntry *>(entry);
123 // 8 bits allocated is a 'O Bytes' , as well as 24 (old ACR-NEMA RGB)
124 // more than 8 (i.e 12, 16) is a 'O Words'
125 if ( GetBitsAllocated() == 8 || GetBitsAllocated() == 24 )
130 // Change only made if usefull
131 if( PixelVR != oldEntry->GetVR() )
133 DictEntry* newDict = NewVirtualDictEntry(GrPixel,NumPixel,
134 PixelVR,"1","Pixel Data");
136 BinEntry *newEntry = new BinEntry(newDict);
137 newEntry->Copy(entry);
138 newEntry->SetBinArea(oldEntry->GetBinArea(),oldEntry->IsSelfArea());
139 oldEntry->SetSelfArea(false);
141 RemoveEntry(oldEntry);
149 * \brief Constructor used when we want to generate dicom files from scratch
154 RLEInfo = new RLEFramesInfo;
155 JPEGInfo = new JPEGFragmentsInfo;
156 InitializeDefaultFile();
160 * \brief Canonical destructor.
170 //-----------------------------------------------------------------------------
173 * \brief This predicate, based on hopefully reasonable heuristics,
174 * decides whether or not the current File was properly parsed
175 * and contains the mandatory information for being considered as
176 * a well formed and usable Dicom/Acr File.
177 * @return true when File is the one of a reasonable Dicom/Acr file,
180 bool File::IsReadable()
182 if( !Document::IsReadable() )
187 const std::string &res = GetEntryValue(0x0028, 0x0005);
188 if ( res != GDCM_UNFOUND && atoi(res.c_str()) > 4 )
190 return false; // Image Dimensions
192 if ( !GetDocEntry(0x0028, 0x0100) )
194 return false; // "Bits Allocated"
196 if ( !GetDocEntry(0x0028, 0x0101) )
198 return false; // "Bits Stored"
200 if ( !GetDocEntry(0x0028, 0x0102) )
202 return false; // "High Bit"
204 if ( !GetDocEntry(0x0028, 0x0103) )
206 return false; // "Pixel Representation" i.e. 'Sign'
213 * \brief gets the info from 0020,0013 : Image Number else 0.
214 * @return image number
216 int File::GetImageNumber()
218 // The function i atoi() takes the address of an area of memory as
219 // parameter and converts the string stored at that location to an integer
220 // using the external decimal to internal binary conversion rules. This may
221 // be preferable to sscanf() since atoi() is a much smaller, simpler and
222 // faster function. sscanf() can do all possible conversions whereas
223 // atoi() can only do single decimal integer conversions.
224 //0020 0013 IS REL Image Number
225 std::string strImNumber = GetEntryValue(0x0020,0x0013);
226 if ( strImNumber != GDCM_UNFOUND )
228 return atoi( strImNumber.c_str() );
234 * \brief gets the info from 0008,0060 : Modality
235 * @return Modality Type
237 ModalityType File::GetModality()
239 // 0008 0060 CS ID Modality
240 std::string strModality = GetEntryValue(0x0008,0x0060);
241 if ( strModality != GDCM_UNFOUND )
243 if ( strModality.find("AU") < strModality.length()) return AU;
244 else if ( strModality.find("AS") < strModality.length()) return AS;
245 else if ( strModality.find("BI") < strModality.length()) return BI;
246 else if ( strModality.find("CF") < strModality.length()) return CF;
247 else if ( strModality.find("CP") < strModality.length()) return CP;
248 else if ( strModality.find("CR") < strModality.length()) return CR;
249 else if ( strModality.find("CT") < strModality.length()) return CT;
250 else if ( strModality.find("CS") < strModality.length()) return CS;
251 else if ( strModality.find("DD") < strModality.length()) return DD;
252 else if ( strModality.find("DF") < strModality.length()) return DF;
253 else if ( strModality.find("DG") < strModality.length()) return DG;
254 else if ( strModality.find("DM") < strModality.length()) return DM;
255 else if ( strModality.find("DS") < strModality.length()) return DS;
256 else if ( strModality.find("DX") < strModality.length()) return DX;
257 else if ( strModality.find("ECG") < strModality.length()) return ECG;
258 else if ( strModality.find("EPS") < strModality.length()) return EPS;
259 else if ( strModality.find("FA") < strModality.length()) return FA;
260 else if ( strModality.find("FS") < strModality.length()) return FS;
261 else if ( strModality.find("HC") < strModality.length()) return HC;
262 else if ( strModality.find("HD") < strModality.length()) return HD;
263 else if ( strModality.find("LP") < strModality.length()) return LP;
264 else if ( strModality.find("LS") < strModality.length()) return LS;
265 else if ( strModality.find("MA") < strModality.length()) return MA;
266 else if ( strModality.find("MR") < strModality.length()) return MR;
267 else if ( strModality.find("NM") < strModality.length()) return NM;
268 else if ( strModality.find("OT") < strModality.length()) return OT;
269 else if ( strModality.find("PT") < strModality.length()) return PT;
270 else if ( strModality.find("RF") < strModality.length()) return RF;
271 else if ( strModality.find("RG") < strModality.length()) return RG;
272 else if ( strModality.find("RTDOSE") < strModality.length()) return RTDOSE;
273 else if ( strModality.find("RTIMAGE") < strModality.length()) return RTIMAGE;
274 else if ( strModality.find("RTPLAN") < strModality.length()) return RTPLAN;
275 else if ( strModality.find("RTSTRUCT") < strModality.length()) return RTSTRUCT;
276 else if ( strModality.find("SM") < strModality.length()) return SM;
277 else if ( strModality.find("ST") < strModality.length()) return ST;
278 else if ( strModality.find("TG") < strModality.length()) return TG;
279 else if ( strModality.find("US") < strModality.length()) return US;
280 else if ( strModality.find("VF") < strModality.length()) return VF;
281 else if ( strModality.find("XA") < strModality.length()) return XA;
282 else if ( strModality.find("XC") < strModality.length()) return XC;
286 /// \todo throw error return value ???
287 /// specified <> unknown in our database
296 * \brief Retrieve the number of columns of image.
297 * @return The encountered size when found, 0 by default.
298 * 0 means the file is NOT USABLE. The caller will have to check
302 const std::string &strSize = GetEntryValue(0x0028,0x0011);
303 if ( strSize == GDCM_UNFOUND )
308 return atoi( strSize.c_str() );
312 * \brief Retrieve the number of lines of image.
313 * \warning The defaulted value is 1 as opposed to File::GetXSize()
314 * @return The encountered size when found, 1 by default
315 * (The ACR-NEMA file contains a Signal, not an Image).
319 const std::string &strSize = GetEntryValue(0x0028,0x0010);
320 if ( strSize != GDCM_UNFOUND )
322 return atoi( strSize.c_str() );
329 // The Rows (0028,0010) entry was optional for ACR/NEMA. It might
330 // hence be a signal (1D image). So we default to 1:
335 * \brief Retrieve the number of planes of volume or the number
336 * of frames of a multiframe.
337 * \warning When present we consider the "Number of Frames" as the third
338 * dimension. When Missing we consider the third dimension as
339 * being the ACR-NEMA "Planes" tag content.
340 * @return The encountered size when found, 1 by default (single image).
344 // Both DicomV3 and ACR/Nema consider the "Number of Frames"
345 // as the third dimension.
346 const std::string &strSize = GetEntryValue(0x0028,0x0008);
347 if ( strSize != GDCM_UNFOUND )
349 return atoi( strSize.c_str() );
352 // We then consider the "Planes" entry as the third dimension
353 const std::string &strSize2 = GetEntryValue(0x0028,0x0012);
354 if ( strSize2 != GDCM_UNFOUND )
356 return atoi( strSize2.c_str() );
363 * \brief gets the info from 0028,0030 : Pixel Spacing
365 * @return X dimension of a pixel
367 float File::GetXSpacing()
369 float xspacing, yspacing;
370 const std::string &strSpacing = GetEntryValue(0x0028,0x0030);
372 if ( strSpacing == GDCM_UNFOUND )
374 gdcmWarningMacro( "Unfound Pixel Spacing (0028,0030)" );
379 if( ( nbValues = sscanf( strSpacing.c_str(),
380 "%f\\%f", &yspacing, &xspacing)) != 2 )
382 // if single value is found, xspacing is defaulted to yspacing
388 if ( xspacing == 0.0 )
395 // to avoid troubles with David Clunie's-like images
396 if ( xspacing == 0. && yspacing == 0.)
401 gdcmWarningMacro("gdcmData/CT-MONO2-8-abdo.dcm problem");
402 // seems to be a bug in the header ...
403 nbValues = sscanf( strSpacing.c_str(), "%f\\0\\%f", &yspacing, &xspacing);
404 gdcmAssertMacro( nbValues == 2 );
411 * \brief gets the info from 0028,0030 : Pixel Spacing
413 * @return Y dimension of a pixel
415 float File::GetYSpacing()
418 std::string strSpacing = GetEntryValue(0x0028,0x0030);
420 if ( strSpacing == GDCM_UNFOUND )
422 gdcmWarningMacro("Unfound Pixel Spacing (0028,0030)");
426 // if sscanf cannot read any float value, it won't affect yspacing
427 sscanf( strSpacing.c_str(), "%f", &yspacing);
429 if ( yspacing == 0.0 )
436 * \brief gets the info from 0018,0088 : Space Between Slices
437 * else from 0018,0050 : Slice Thickness
439 * @return Z dimension of a voxel-to be
441 float File::GetZSpacing()
443 // Spacing Between Slices : distance entre le milieu de chaque coupe
444 // Les coupes peuvent etre :
445 // jointives (Spacing between Slices = Slice Thickness)
446 // chevauchantes (Spacing between Slices < Slice Thickness)
447 // disjointes (Spacing between Slices > Slice Thickness)
448 // Slice Thickness : epaisseur de tissus sur laquelle est acquis le signal
449 // ca interesse le physicien de l'IRM, pas le visualisateur de volumes ...
450 // Si le Spacing Between Slices est Missing,
451 // on suppose que les coupes sont jointives
453 const std::string &strSpacingBSlices = GetEntryValue(0x0018,0x0088);
455 if ( strSpacingBSlices == GDCM_UNFOUND )
457 gdcmWarningMacro("Unfound Spacing Between Slices (0018,0088)");
458 const std::string &strSliceThickness = GetEntryValue(0x0018,0x0050);
459 if ( strSliceThickness == GDCM_UNFOUND )
461 gdcmWarningMacro("Unfound Slice Thickness (0018,0050)");
466 // if no 'Spacing Between Slices' is found,
467 // we assume slices join together
468 // (no overlapping, no interslice gap)
469 // if they don't, we're fucked up
470 return (float)atof( strSliceThickness.c_str() );
474 return (float)atof( strSpacingBSlices.c_str() );
478 * \brief gets the info from 0020,0032 : Image Position Patient
479 * else from 0020,0030 : Image Position (RET)
481 * @return up-left image corner X position
483 float File::GetXOrigin()
485 float xImPos, yImPos, zImPos;
486 std::string strImPos = GetEntryValue(0x0020,0x0032);
488 if ( strImPos == GDCM_UNFOUND )
490 gdcmWarningMacro( "Unfound Image Position Patient (0020,0032)");
491 strImPos = GetEntryValue(0x0020,0x0030); // For ACR-NEMA images
492 if ( strImPos == GDCM_UNFOUND )
494 gdcmWarningMacro( "Unfound Image Position (RET) (0020,0030)");
499 if( sscanf( strImPos.c_str(), "%f\\%f\\%f", &xImPos, &yImPos, &zImPos) != 3 )
508 * \brief gets the info from 0020,0032 : Image Position Patient
509 * else from 0020,0030 : Image Position (RET)
511 * @return up-left image corner Y position
513 float File::GetYOrigin()
515 float xImPos, yImPos, zImPos;
516 std::string strImPos = GetEntryValue(0x0020,0x0032);
518 if ( strImPos == GDCM_UNFOUND)
520 gdcmWarningMacro( "Unfound Image Position Patient (0020,0032)");
521 strImPos = GetEntryValue(0x0020,0x0030); // For ACR-NEMA images
522 if ( strImPos == GDCM_UNFOUND )
524 gdcmWarningMacro( "Unfound Image Position (RET) (0020,0030)");
529 if( sscanf( strImPos.c_str(), "%f\\%f\\%f", &xImPos, &yImPos, &zImPos) != 3 )
538 * \brief gets the info from 0020,0032 : Image Position Patient
539 * else from 0020,0030 : Image Position (RET)
540 * else from 0020,1041 : Slice Location
541 * else from 0020,0050 : Location
543 * @return up-left image corner Z position
545 float File::GetZOrigin()
547 float xImPos, yImPos, zImPos;
548 std::string strImPos = GetEntryValue(0x0020,0x0032);
550 if ( strImPos != GDCM_UNFOUND )
552 if( sscanf( strImPos.c_str(), "%f\\%f\\%f", &xImPos, &yImPos, &zImPos) != 3)
554 gdcmWarningMacro( "Wrong Image Position Patient (0020,0032)");
555 return 0.; // bug in the element 0x0020,0x0032
563 strImPos = GetEntryValue(0x0020,0x0030); // For ACR-NEMA images
564 if ( strImPos != GDCM_UNFOUND )
566 if( sscanf( strImPos.c_str(),
567 "%f\\%f\\%f", &xImPos, &yImPos, &zImPos ) != 3 )
569 gdcmWarningMacro( "Wrong Image Position (RET) (0020,0030)");
570 return 0.; // bug in the element 0x0020,0x0032
578 std::string strSliceLocation = GetEntryValue(0x0020,0x1041); // for *very* old ACR-NEMA images
579 if ( strSliceLocation != GDCM_UNFOUND )
581 if( sscanf( strSliceLocation.c_str(), "%f", &zImPos) != 1)
583 gdcmWarningMacro( "Wrong Slice Location (0020,1041)");
584 return 0.; // bug in the element 0x0020,0x1041
591 gdcmWarningMacro( "Unfound Slice Location (0020,1041)");
593 std::string strLocation = GetEntryValue(0x0020,0x0050);
594 if ( strLocation != GDCM_UNFOUND )
596 if( sscanf( strLocation.c_str(), "%f", &zImPos) != 1)
598 gdcmWarningMacro( "Wrong Location (0020,0050)");
599 return 0.; // bug in the element 0x0020,0x0050
606 gdcmWarningMacro( "Unfound Location (0020,0050)");
608 return 0.; // Hopeless
612 * \brief gets the info from 0020,0037 : Image Orientation Patient
613 * (needed to organize DICOM files based on their x,y,z position)
614 * @param iop adress of the (6)float aray to receive values
615 * @return cosines of image orientation patient
617 void File::GetImageOrientationPatient( float iop[6] )
619 std::string strImOriPat;
620 //iop is supposed to be float[6]
621 iop[0] = iop[1] = iop[2] = iop[3] = iop[4] = iop[5] = 0.;
623 // 0020 0037 DS REL Image Orientation (Patient)
624 if ( (strImOriPat = GetEntryValue(0x0020,0x0037)) != GDCM_UNFOUND )
626 if( sscanf( strImOriPat.c_str(), "%f\\%f\\%f\\%f\\%f\\%f",
627 &iop[0], &iop[1], &iop[2], &iop[3], &iop[4], &iop[5]) != 6 )
629 gdcmWarningMacro( "Wrong Image Orientation Patient (0020,0037). Less than 6 values were found." );
633 // 0020 0035 DS REL Image Orientation (RET)
634 else if ( (strImOriPat = GetEntryValue(0x0020,0x0035)) != GDCM_UNFOUND )
636 if( sscanf( strImOriPat.c_str(), "%f\\%f\\%f\\%f\\%f\\%f",
637 &iop[0], &iop[1], &iop[2], &iop[3], &iop[4], &iop[5]) != 6 )
639 gdcmWarningMacro( "wrong Image Orientation Patient (0020,0035). Less than 6 values were found." );
645 * \brief Retrieve the number of Bits Stored (actually used)
646 * (as opposite to number of Bits Allocated)
647 * @return The encountered number of Bits Stored, 0 by default.
648 * 0 means the file is NOT USABLE. The caller has to check it !
650 int File::GetBitsStored()
652 std::string strSize = GetEntryValue( 0x0028, 0x0101 );
653 if ( strSize == GDCM_UNFOUND )
655 gdcmWarningMacro("(0028,0101) is supposed to be mandatory");
656 return 0; // It's supposed to be mandatory
657 // the caller will have to check
659 return atoi( strSize.c_str() );
663 * \brief Retrieve the number of Bits Allocated
664 * (8, 12 -compacted ACR-NEMA files, 16, ...)
665 * @return The encountered number of Bits Allocated, 0 by default.
666 * 0 means the file is NOT USABLE. The caller has to check it !
668 int File::GetBitsAllocated()
670 std::string strSize = GetEntryValue(0x0028,0x0100);
671 if ( strSize == GDCM_UNFOUND )
673 gdcmWarningMacro( "(0028,0100) is supposed to be mandatory");
674 return 0; // It's supposed to be mandatory
675 // the caller will have to check
677 return atoi( strSize.c_str() );
681 * \brief Retrieve the high bit position.
682 * \warning The method defaults to 0 when information is Missing.
683 * The responsability of checking this value is left to the caller.
684 * @return The high bit positin when present. 0 when Missing.
686 int File::GetHighBitPosition()
688 std::string strSize = GetEntryValue( 0x0028, 0x0102 );
689 if ( strSize == GDCM_UNFOUND )
691 gdcmWarningMacro( "(0028,0102) is supposed to be mandatory");
694 return atoi( strSize.c_str() );
698 * \brief Retrieve the number of Samples Per Pixel
699 * (1 : gray level, 3 : RGB -1 or 3 Planes-)
700 * @return The encountered number of Samples Per Pixel, 1 by default.
701 * (Gray level Pixels)
703 int File::GetSamplesPerPixel()
705 const std::string &strSize = GetEntryValue(0x0028,0x0002);
706 if ( strSize == GDCM_UNFOUND )
708 gdcmWarningMacro( "(0028,0002) is supposed to be mandatory");
709 return 1; // Well, it's supposed to be mandatory ...
710 // but sometimes it's missing : *we* assume Gray pixels
712 return atoi( strSize.c_str() );
716 * \brief Retrieve the Planar Configuration for RGB images
717 * (0 : RGB Pixels , 1 : R Plane + G Plane + B Plane)
718 * @return The encountered Planar Configuration, 0 by default.
720 int File::GetPlanarConfiguration()
722 std::string strSize = GetEntryValue(0x0028,0x0006);
723 if ( strSize == GDCM_UNFOUND )
725 gdcmWarningMacro( "Not found : Planar Configuration (0028,0006)");
728 return atoi( strSize.c_str() );
732 * \brief Return the size (in bytes) of a single pixel of data.
733 * @return The size in bytes of a single pixel of data; 0 by default
734 * 0 means the file is NOT USABLE; the caller will have to check
736 int File::GetPixelSize()
738 // 0028 0100 US IMG Bits Allocated
739 // (in order no to be messed up by old RGB images)
740 // if (File::GetEntryValue(0x0028,0x0100) == "24")
743 std::string pixelType = GetPixelType();
744 if ( pixelType == "8U" || pixelType == "8S" )
748 if ( pixelType == "16U" || pixelType == "16S")
752 if ( pixelType == "32U" || pixelType == "32S")
756 if ( pixelType == "FD" )
760 gdcmWarningMacro( "Unknown pixel type");
765 * \brief Build the Pixel Type of the image.
766 * Possible values are:
767 * - 8U unsigned 8 bit,
769 * - 16U unsigned 16 bit,
770 * - 16S signed 16 bit,
771 * - 32U unsigned 32 bit,
772 * - 32S signed 32 bit,
773 * - FD floating double 64 bits (Not kosher DICOM, but so usefull!)
774 * \warning 12 bit images appear as 16 bit.
775 * 24 bit images appear as 8 bit
776 * @return 0S if nothing found. NOT USABLE file. The caller has to check
778 std::string File::GetPixelType()
780 std::string bitsAlloc = GetEntryValue(0x0028, 0x0100); // Bits Allocated
781 if ( bitsAlloc == GDCM_UNFOUND )
783 gdcmWarningMacro( "Missing Bits Allocated (0028,0100)");
784 bitsAlloc = "16"; // default and arbitrary value, not to polute the output
787 if ( bitsAlloc == "64" )
791 else if ( bitsAlloc == "12" )
793 // It will be unpacked
796 else if ( bitsAlloc == "24" )
798 // (in order no to be messed up
799 bitsAlloc = "8"; // by old RGB images)
802 std::string sign = GetEntryValue(0x0028, 0x0103);//"Pixel Representation"
804 if (sign == GDCM_UNFOUND )
806 gdcmWarningMacro( "Missing Pixel Representation (0028,0103)");
807 sign = "U"; // default and arbitrary value, not to polute the output
809 else if ( sign == "0" )
817 return bitsAlloc + sign;
821 * \brief Check whether the pixels are signed or UNsigned data.
822 * \warning The method defaults to false (UNsigned) when information is Missing.
823 * The responsability of checking this value is left to the caller.
824 * @return True when signed, false when UNsigned
826 bool File::IsSignedPixelData()
828 std::string strSize = GetEntryValue( 0x0028, 0x0103 );
829 if ( strSize == GDCM_UNFOUND )
831 gdcmWarningMacro( "(0028,0103) is supposed to be mandatory");
834 int sign = atoi( strSize.c_str() );
843 * \brief Check whether this a monochrome picture or not by accessing
844 * the "Photometric Interpretation" tag ( 0x0028, 0x0004 ).
845 * @return true when "MONOCHROME1" or "MONOCHROME2". False otherwise.
847 bool File::IsMonochrome()
849 const std::string &PhotometricInterp = GetEntryValue( 0x0028, 0x0004 );
850 if ( Util::DicomStringEqual(PhotometricInterp, "MONOCHROME1")
851 || Util::DicomStringEqual(PhotometricInterp, "MONOCHROME2") )
855 if ( PhotometricInterp == GDCM_UNFOUND )
857 gdcmWarningMacro( "Not found : Photometric Interpretation (0028,0004)");
863 * \brief Check whether this a "PALETTE COLOR" picture or not by accessing
864 * the "Photometric Interpretation" tag ( 0x0028, 0x0004 ).
865 * @return true when "PALETTE COLOR". False otherwise.
867 bool File::IsPaletteColor()
869 std::string PhotometricInterp = GetEntryValue( 0x0028, 0x0004 );
870 if ( PhotometricInterp == "PALETTE COLOR " )
874 if ( PhotometricInterp == GDCM_UNFOUND )
876 gdcmWarningMacro( "Not found : Palette color (0028,0004)");
882 * \brief Check whether this a "YBR_FULL" color picture or not by accessing
883 * the "Photometric Interpretation" tag ( 0x0028, 0x0004 ).
884 * @return true when "YBR_FULL". False otherwise.
886 bool File::IsYBRFull()
888 std::string PhotometricInterp = GetEntryValue( 0x0028, 0x0004 );
889 if ( PhotometricInterp == "YBR_FULL" )
893 if ( PhotometricInterp == GDCM_UNFOUND )
895 gdcmWarningMacro( "Not found : YBR Full (0028,0004)");
901 * \brief tells us if LUT are used
902 * \warning Right now, 'Segmented xxx Palette Color Lookup Table Data'
903 * are NOT considered as LUT, since nobody knows
904 * how to deal with them
905 * Please warn me if you know sbdy that *does* know ... jprx
906 * @return true if LUT Descriptors and LUT Tables were found
910 // Check the presence of the LUT Descriptors, and LUT Tables
912 if ( !GetDocEntry(0x0028,0x1101) )
916 // LutDescriptorGreen
917 if ( !GetDocEntry(0x0028,0x1102) )
922 if ( !GetDocEntry(0x0028,0x1103) )
926 // Red Palette Color Lookup Table Data
927 if ( !GetDocEntry(0x0028,0x1201) )
931 // Green Palette Color Lookup Table Data
932 if ( !GetDocEntry(0x0028,0x1202) )
936 // Blue Palette Color Lookup Table Data
937 if ( !GetDocEntry(0x0028,0x1203) )
942 // FIXME : (0x0028,0x3006) : LUT Data (CTX dependent)
943 // NOT taken into account, but we don't know how to use it ...
948 * \brief gets the info from 0028,1101 : Lookup Table Desc-Red
950 * @return Lookup Table number of Bits , 0 by default
951 * when (0028,0004),Photometric Interpretation = [PALETTE COLOR ]
952 * @ return bit number of each LUT item
954 int File::GetLUTNbits()
956 std::vector<std::string> tokens;
959 //Just hope Lookup Table Desc-Red = Lookup Table Desc-Red
960 // = Lookup Table Desc-Blue
961 // Consistency already checked in GetLUTLength
962 std::string lutDescription = GetEntryValue(0x0028,0x1101);
963 if ( lutDescription == GDCM_UNFOUND )
968 tokens.clear(); // clean any previous value
969 Util::Tokenize ( lutDescription, tokens, "\\" );
970 //LutLength=atoi(tokens[0].c_str());
971 //LutDepth=atoi(tokens[1].c_str());
973 lutNbits = atoi( tokens[2].c_str() );
980 *\brief gets the info from 0028,1052 : Rescale Intercept
981 * @return Rescale Intercept
983 float File::GetRescaleIntercept()
986 /// 0028 1052 DS IMG Rescale Intercept
987 const std::string &strRescInter = GetEntryValue(0x0028,0x1052);
988 if ( strRescInter != GDCM_UNFOUND )
990 if( sscanf( strRescInter.c_str(), "%f", &resInter) != 1 )
992 // bug in the element 0x0028,0x1052
993 gdcmWarningMacro( "Rescale Intercept (0028,1052) is empty." );
1001 *\brief gets the info from 0028,1053 : Rescale Slope
1002 * @return Rescale Slope
1004 float File::GetRescaleSlope()
1006 float resSlope = 1.;
1007 //0028 1053 DS IMG Rescale Slope
1008 std::string strRescSlope = GetEntryValue(0x0028,0x1053);
1009 if ( strRescSlope != GDCM_UNFOUND )
1011 if( sscanf( strRescSlope.c_str(), "%f", &resSlope) != 1)
1013 // bug in the element 0x0028,0x1053
1014 gdcmWarningMacro( "Rescale Slope (0028,1053) is empty.");
1022 * \brief This function is intended to user who doesn't want
1023 * to have to manage a LUT and expects to get an RBG Pixel image
1024 * (or a monochrome one ...)
1025 * \warning to be used with GetImagePixels()
1026 * @return 1 if Gray level, 3 if Color (RGB, YBR or PALETTE COLOR)
1028 int File::GetNumberOfScalarComponents()
1030 if ( GetSamplesPerPixel() == 3 )
1035 // 0028 0100 US IMG Bits Allocated
1036 // (in order no to be messed up by old RGB images)
1037 if ( GetEntryValue(0x0028,0x0100) == "24" )
1042 std::string strPhotometricInterpretation = GetEntryValue(0x0028,0x0004);
1044 if ( ( strPhotometricInterpretation == "PALETTE COLOR ") )
1046 if ( HasLUT() )// PALETTE COLOR is NOT enough
1056 // beware of trailing space at end of string
1057 // DICOM tags are never of odd length
1058 if ( strPhotometricInterpretation == GDCM_UNFOUND ||
1059 Util::DicomStringEqual(strPhotometricInterpretation, "MONOCHROME1") ||
1060 Util::DicomStringEqual(strPhotometricInterpretation, "MONOCHROME2") )
1066 // we assume that *all* kinds of YBR are dealt with
1072 * \brief This function is intended to user that DOESN'T want
1073 * to get RGB pixels image when it's stored as a PALETTE COLOR image
1074 * - the (vtk) user is supposed to know how deal with LUTs -
1075 * \warning to be used with GetImagePixelsRaw()
1076 * @return 1 if Gray level, 3 if Color (RGB or YBR - NOT 'PALETTE COLOR' -)
1078 int File::GetNumberOfScalarComponentsRaw()
1080 // 0028 0100 US IMG Bits Allocated
1081 // (in order no to be messed up by old RGB images)
1082 if ( File::GetEntryValue(0x0028,0x0100) == "24" )
1087 // we assume that *all* kinds of YBR are dealt with
1088 return GetSamplesPerPixel();
1092 * \brief Recover the offset (from the beginning of the file)
1093 * of *image* pixels (not *icone image* pixels, if any !)
1094 * @return Pixel Offset
1096 size_t File::GetPixelOffset()
1098 DocEntry* pxlElement = GetDocEntry(GrPixel,NumPixel);
1101 return pxlElement->GetOffset();
1105 gdcmDebugMacro( "Big trouble : Pixel Element ("
1106 << std::hex << GrPixel<<","<< NumPixel<< ") NOT found" );
1112 * \brief Recover the pixel area length (in Bytes)
1113 * @return Pixel Element Length, as stored in the header
1114 * (NOT the memory space necessary to hold the Pixels
1115 * -in case of embeded compressed image-)
1116 * 0 : NOT USABLE file. The caller has to check.
1118 size_t File::GetPixelAreaLength()
1120 DocEntry* pxlElement = GetDocEntry(GrPixel,NumPixel);
1123 return pxlElement->GetLength();
1127 gdcmDebugMacro( "Big trouble : Pixel Element ("
1128 << std::hex << GrPixel<<","<< NumPixel<< ") NOT found" );
1134 * \brief anonymize a File (removes Patient's personal info)
1135 * (read the code to see which ones ...)
1137 bool File::AnonymizeFile()
1139 // If exist, replace by spaces
1140 SetValEntry (" ",0x0010, 0x2154); // Telephone
1141 SetValEntry (" ",0x0010, 0x1040); // Adress
1142 SetValEntry (" ",0x0010, 0x0020); // Patient ID
1144 DocEntry* patientNameHE = GetDocEntry (0x0010, 0x0010);
1146 if ( patientNameHE ) // we replace it by Study Instance UID (why not)
1148 std::string studyInstanceUID = GetEntryValue (0x0020, 0x000d);
1149 if ( studyInstanceUID != GDCM_UNFOUND )
1151 InsertValEntry(studyInstanceUID, 0x0010, 0x0010);
1155 InsertValEntry("anonymised", 0x0010, 0x0010);
1160 // (if any) remove or replace all the stuff that contains a Date
1162 //0008 0012 DA ID Instance Creation Date
1163 //0008 0020 DA ID Study Date
1164 //0008 0021 DA ID Series Date
1165 //0008 0022 DA ID Acquisition Date
1166 //0008 0023 DA ID Content Date
1167 //0008 0024 DA ID Overlay Date
1168 //0008 0025 DA ID Curve Date
1169 //0008 002a DT ID Acquisition Datetime
1170 //0018 9074 DT ACQ Frame Acquisition Datetime
1171 //0018 9151 DT ACQ Frame Reference Datetime
1172 //0018 a002 DT ACQ Contribution Date Time
1173 //0020 3403 SH REL Modified Image Date (RET)
1174 //0032 0032 DA SDY Study Verified Date
1175 //0032 0034 DA SDY Study Read Date
1176 //0032 1000 DA SDY Scheduled Study Start Date
1177 //0032 1010 DA SDY Scheduled Study Stop Date
1178 //0032 1040 DA SDY Study Arrival Date
1179 //0032 1050 DA SDY Study Completion Date
1180 //0038 001a DA VIS Scheduled Admission Date
1181 //0038 001c DA VIS Scheduled Discharge Date
1182 //0038 0020 DA VIS Admitting Date
1183 //0038 0030 DA VIS Discharge Date
1184 //0040 0002 DA PRC Scheduled Procedure Step Start Date
1185 //0040 0004 DA PRC Scheduled Procedure Step End Date
1186 //0040 0244 DA PRC Performed Procedure Step Start Date
1187 //0040 0250 DA PRC Performed Procedure Step End Date
1188 //0040 2004 DA PRC Issue Date of Imaging Service Request
1189 //0040 4005 DT PRC Scheduled Procedure Step Start Date and Time
1190 //0040 4011 DT PRC Expected Completion Date and Time
1191 //0040 a030 DT PRC Verification Date Time
1192 //0040 a032 DT PRC Observation Date Time
1193 //0040 a120 DT PRC DateTime
1194 //0040 a121 DA PRC Date
1195 //0040 a13a DT PRC Referenced Datetime
1196 //0070 0082 DA ??? Presentation Creation Date
1197 //0100 0420 DT ??? SOP Autorization Date and Time
1198 //0400 0105 DT ??? Digital Signature DateTime
1199 //2100 0040 DA PJ Creation Date
1200 //3006 0008 DA SSET Structure Set Date
1201 //3008 0024 DA ??? Treatment Control Point Date
1202 //3008 0054 DA ??? First Treatment Date
1203 //3008 0056 DA ??? Most Recent Treatment Date
1204 //3008 0162 DA ??? Safe Position Exit Date
1205 //3008 0166 DA ??? Safe Position Return Date
1206 //3008 0250 DA ??? Treatment Date
1207 //300a 0006 DA RT RT Plan Date
1208 //300a 022c DA RT Air Kerma Rate Reference Date
1209 //300e 0004 DA RT Review Date
1215 * \brief Performs some consistency checking on various 'File related'
1216 * (as opposed to 'DicomDir related') entries
1217 * then writes in a file all the (Dicom Elements) included the Pixels
1218 * @param fileName file name to write to
1219 * @param filetype Type of the File to be written
1220 * (ACR, ExplicitVR, ImplicitVR)
1222 bool File::Write(std::string fileName, FileType filetype)
1224 std::ofstream *fp = new std::ofstream(fileName.c_str(),
1225 std::ios::out | std::ios::binary);
1228 gdcmWarningMacro("Failed to open (write) File: " << fileName.c_str());
1232 // Entry : 0002|0000 = group length -> recalculated
1233 ValEntry *e0002 = GetValEntry(0x0002,0x0000);
1236 std::ostringstream sLen;
1237 sLen << ComputeGroup0002Length(filetype);
1238 e0002->SetValue(sLen.str());
1242 if ( GetEntryValue(0x0028,0x0100) == "12")
1244 SetValEntry("16", 0x0028,0x0100);
1247 int i_lgPix = GetEntryLength(GrPixel, NumPixel);
1250 // no (GrPixel, NumPixel) element
1251 std::string s_lgPix = Util::Format("%d", i_lgPix+12);
1252 s_lgPix = Util::DicomString( s_lgPix.c_str() );
1253 InsertValEntry(s_lgPix,GrPixel, 0x0000);
1256 // FIXME : should be nice if we could move it to File
1257 // (or in future gdcmPixelData class)
1259 // Drop Palette Color, if necessary
1260 if ( GetEntryValue(0x0028,0x0002).c_str()[0] == '3' )
1262 // if SamplesPerPixel = 3, sure we don't need any LUT !
1263 // Drop 0028|1101, 0028|1102, 0028|1103
1264 // Drop 0028|1201, 0028|1202, 0028|1203
1266 DocEntry *e = GetDocEntry(0x0028,0x01101);
1269 RemoveEntryNoDestroy(e);
1271 e = GetDocEntry(0x0028,0x1102);
1274 RemoveEntryNoDestroy(e);
1276 e = GetDocEntry(0x0028,0x1103);
1279 RemoveEntryNoDestroy(e);
1281 e = GetDocEntry(0x0028,0x01201);
1284 RemoveEntryNoDestroy(e);
1286 e = GetDocEntry(0x0028,0x1202);
1289 RemoveEntryNoDestroy(e);
1291 e = GetDocEntry(0x0028,0x1203);
1294 RemoveEntryNoDestroy(e);
1299 #ifdef GDCM_WORDS_BIGENDIAN
1300 // Super Super hack that will make gdcm a BOMB ! but should
1301 // Fix temporarily the dashboard
1302 BinEntry *b = GetBinEntry(GrPixel,NumPixel);
1303 if ( GetPixelSize() == 16 )
1305 uint16_t *im16 = (uint16_t *)b->GetBinArea();
1306 int lgr = b->GetLength();
1307 for( int i = 0; i < lgr / 2; i++ )
1309 im16[i]= (im16[i] >> 8) | (im16[i] << 8 );
1312 #endif //GDCM_WORDS_BIGENDIAN
1315 Document::WriteContent(fp, filetype);
1318 #ifdef GDCM_WORDS_BIGENDIAN
1319 // Flip back the pixel ... I told you this is a hack
1320 if ( GetPixelSize() == 16 )
1322 uint16_t *im16 = (uint16_t*)b->GetBinArea();
1323 int lgr = b->GetLength();
1324 for( int i = 0; i < lgr / 2; i++ )
1326 im16[i]= (im16[i] >> 8) | (im16[i] << 8 );
1329 #endif //GDCM_WORDS_BIGENDIAN
1338 //-----------------------------------------------------------------------------
1341 * \brief Initialize a default DICOM File that should contain all the
1342 * field require by other reader. DICOM standard does not
1343 * explicitely defines those fields, heuristic has been choosen.
1344 * This is not perfect as we are writting a CT image...
1346 void File::InitializeDefaultFile()
1348 std::string date = Util::GetCurrentDate();
1349 std::string time = Util::GetCurrentTime();
1350 std::string uid = Util::CreateUniqueUID();
1351 std::string uidMedia = uid;
1352 std::string uidInst = uid;
1353 std::string uidClass = Util::CreateUniqueUID();
1354 std::string uidStudy = Util::CreateUniqueUID();
1355 std::string uidSerie = Util::CreateUniqueUID();
1357 // Meta Element Group Length
1358 InsertValEntry("146 ", 0x0002, 0x0000);
1359 // Media Storage SOP Class UID (CT Image Storage)
1360 InsertValEntry("1.2.840.10008.5.1.4.1.1.2", 0x0002, 0x0002);
1361 // Media Storage SOP Instance UID
1362 InsertValEntry(uidClass.c_str(), 0x0002, 0x0003);
1363 // Transfer Syntax UID (Explicit VR Little Endian)
1364 InsertValEntry("1.2.840.10008.1.2.1 ", 0x0002, 0x0010);
1365 // META Implementation Class UID
1366 InsertValEntry(uidClass.c_str(), 0x0002, 0x0012);
1367 // Source Application Entity Title
1368 InsertValEntry("GDCM", 0x0002, 0x0016);
1370 // Instance Creation Date
1371 InsertValEntry(date.c_str(), 0x0008, 0x0012);
1372 // Instance Creation Time
1373 InsertValEntry(time.c_str(), 0x0008, 0x0013);
1375 InsertValEntry("1.2.840.10008.5.1.4.1.1.2", 0x0008, 0x0016);
1377 InsertValEntry(uidInst.c_str(), 0x0008, 0x0018);
1379 InsertValEntry("CT", 0x0008, 0x0060);
1381 InsertValEntry("GDCM", 0x0008, 0x0070);
1383 InsertValEntry("GDCM", 0x0008, 0x0080);
1384 // Institution Address
1385 InsertValEntry("http://www-creatis.insa-lyon.fr/Public/Gdcm", 0x0008, 0x0081);
1388 InsertValEntry("GDCM", 0x0010, 0x0010);
1390 InsertValEntry("GDCMID", 0x0010, 0x0020);
1392 // Study Instance UID
1393 InsertValEntry(uidStudy.c_str(), 0x0020, 0x000d);
1394 // Series Instance UID
1395 InsertValEntry(uidSerie.c_str(), 0x0020, 0x000e);
1397 InsertValEntry("1", 0x0020, 0x0010);
1399 InsertValEntry("1", 0x0020, 0x0011);
1401 // Samples per pixel 1 or 3
1402 InsertValEntry("1", 0x0028, 0x0002);
1403 // photochromatic interpretation
1404 InsertValEntry("MONOCHROME1", 0x0028, 0x0004);
1406 InsertValEntry("0", 0x0028, 0x0010);
1408 InsertValEntry("0", 0x0028, 0x0011);
1409 // BitsAllocated 8 or 12 or 16
1410 InsertValEntry("8", 0x0028, 0x0100);
1411 // BitsStored <= BitsAllocated
1412 InsertValEntry("8", 0x0028, 0x0101);
1413 // HighBit <= BitsAllocated - 1
1414 InsertValEntry("7", 0x0028, 0x0102);
1415 // Pixel Representation 0(unsigned) or 1(signed)
1416 InsertValEntry("0", 0x0028, 0x0103);
1419 // Special case this is the image (not a string)
1422 InsertBinEntry(0, 0, GrPixel, NumPixel);
1425 //-----------------------------------------------------------------------------
1428 * \brief Parse pixel data from disk of [multi-]fragment RLE encoding.
1429 * Compute the RLE extra information and store it in \ref RLEInfo
1430 * for later pixel retrieval usage.
1432 void File::ComputeRLEInfo()
1434 std::string ts = GetTransferSyntax();
1435 if ( !Global::GetTS()->IsRLELossless(ts) )
1440 // Encoded pixel data: for the time being we are only concerned with
1441 // Jpeg or RLE Pixel data encodings.
1442 // As stated in PS 3.5-2003, section 8.2 p44:
1443 // "If sent in Encapsulated Format (i.e. other than the Native Format) the
1444 // value representation OB is used".
1445 // Hence we expect an OB value representation. Concerning OB VR,
1446 // the section PS 3.5-2003, section A.4.c p 58-59, states:
1447 // "For the Value Representations OB and OW, the encoding shall meet the
1448 // following specifications depending on the Data element tag:"
1450 // - the first item in the sequence of items before the encoded pixel
1451 // data stream shall be basic offset table item. The basic offset table
1452 // item value, however, is not required to be present"
1453 ReadAndSkipEncapsulatedBasicOffsetTable();
1455 // Encapsulated RLE Compressed Images (see PS 3.5-2003, Annex G)
1456 // Loop on the individual frame[s] and store the information
1457 // on the RLE fragments in a RLEFramesInfo.
1458 // Note: - when only a single frame is present, this is a
1460 // - when more than one frame are present, then we are in
1461 // the case of a multi-frame image.
1463 while ( (frameLength = ReadTagLength(0xfffe, 0xe000)) )
1465 // Parse the RLE Header and store the corresponding RLE Segment
1466 // Offset Table information on fragments of this current Frame.
1467 // Note that the fragment pixels themselves are not loaded
1468 // (but just skipped).
1469 long frameOffset = Fp->tellg();
1471 uint32_t nbRleSegments = ReadInt32();
1472 if ( nbRleSegments > 16 )
1474 // There should be at most 15 segments (refer to RLEFrame class)
1475 gdcmWarningMacro( "Too many segments.");
1478 uint32_t rleSegmentOffsetTable[16];
1479 for( int k = 1; k <= 15; k++ )
1481 rleSegmentOffsetTable[k] = ReadInt32();
1484 // Deduce from both the RLE Header and the frameLength the
1485 // fragment length, and again store this info in a
1487 long rleSegmentLength[15];
1488 // skipping (not reading) RLE Segments
1489 if ( nbRleSegments > 1)
1491 for(unsigned int k = 1; k <= nbRleSegments-1; k++)
1493 rleSegmentLength[k] = rleSegmentOffsetTable[k+1]
1494 - rleSegmentOffsetTable[k];
1495 SkipBytes(rleSegmentLength[k]);
1499 rleSegmentLength[nbRleSegments] = frameLength
1500 - rleSegmentOffsetTable[nbRleSegments];
1501 SkipBytes(rleSegmentLength[nbRleSegments]);
1503 // Store the collected info
1504 RLEFrame *newFrame = new RLEFrame;
1505 newFrame->SetNumberOfFragments(nbRleSegments);
1506 for( unsigned int uk = 1; uk <= nbRleSegments; uk++ )
1508 newFrame->SetOffset(uk,frameOffset + rleSegmentOffsetTable[uk]);
1509 newFrame->SetLength(uk,rleSegmentLength[uk]);
1511 RLEInfo->AddFrame(newFrame);
1514 // Make sure that at the end of the item we encounter a 'Sequence
1516 if ( !ReadTag(0xfffe, 0xe0dd) )
1518 gdcmWarningMacro( "No sequence delimiter item at end of RLE item sequence");
1523 * \brief Parse pixel data from disk of [multi-]fragment Jpeg encoding.
1524 * Compute the jpeg extra information (fragment[s] offset[s] and
1525 * length) and store it[them] in \ref JPEGInfo for later pixel
1528 void File::ComputeJPEGFragmentInfo()
1530 // If you need to, look for comments of ComputeRLEInfo().
1531 std::string ts = GetTransferSyntax();
1532 if ( ! Global::GetTS()->IsJPEG(ts) )
1537 ReadAndSkipEncapsulatedBasicOffsetTable();
1539 // Loop on the fragments[s] and store the parsed information in a
1541 long fragmentLength;
1542 while ( (fragmentLength = ReadTagLength(0xfffe, 0xe000)) )
1544 long fragmentOffset = Fp->tellg();
1546 // Store the collected info
1547 JPEGFragment *newFragment = new JPEGFragment;
1548 newFragment->SetOffset(fragmentOffset);
1549 newFragment->SetLength(fragmentLength);
1550 JPEGInfo->AddFragment(newFragment);
1552 SkipBytes(fragmentLength);
1555 // Make sure that at the end of the item we encounter a 'Sequence
1557 if ( !ReadTag(0xfffe, 0xe0dd) )
1559 gdcmWarningMacro( "No sequence delimiter item at end of JPEG item sequence");
1564 * \brief Assuming the internal file pointer \ref Document::Fp
1565 * is placed at the beginning of a tag check whether this
1566 * tag is (TestGroup, TestElement).
1567 * \warning On success the internal file pointer \ref Document::Fp
1568 * is modified to point after the tag.
1569 * On failure (i.e. when the tag wasn't the expected tag
1570 * (TestGroup, TestElement) the internal file pointer
1571 * \ref Document::Fp is restored to it's original position.
1572 * @param testGroup The expected group of the tag.
1573 * @param testElement The expected Element of the tag.
1574 * @return True on success, false otherwise.
1576 bool File::ReadTag(uint16_t testGroup, uint16_t testElement)
1578 long positionOnEntry = Fp->tellg();
1579 long currentPosition = Fp->tellg(); // On debugging purposes
1581 //// Read the Item Tag group and element, and make
1582 // sure they are what we expected:
1583 uint16_t itemTagGroup;
1584 uint16_t itemTagElement;
1587 itemTagGroup = ReadInt16();
1588 itemTagElement = ReadInt16();
1590 catch ( FormatError e )
1592 //std::cerr << e << std::endl;
1595 if ( itemTagGroup != testGroup || itemTagElement != testElement )
1597 gdcmWarningMacro( "Wrong Item Tag found:"
1598 << " We should have found tag ("
1599 << std::hex << testGroup << "," << testElement << ")" << std::endl
1600 << " but instead we encountered tag ("
1601 << std::hex << itemTagGroup << "," << itemTagElement << ")"
1602 << " at address: " << " 0x(" << (unsigned int)currentPosition << ")"
1604 Fp->seekg(positionOnEntry, std::ios::beg);
1612 * \brief Assuming the internal file pointer \ref Document::Fp
1613 * is placed at the beginning of a tag (TestGroup, TestElement),
1614 * read the length associated to the Tag.
1615 * \warning On success the internal file pointer \ref Document::Fp
1616 * is modified to point after the tag and it's length.
1617 * On failure (i.e. when the tag wasn't the expected tag
1618 * (TestGroup, TestElement) the internal file pointer
1619 * \ref Document::Fp is restored to it's original position.
1620 * @param testGroup The expected group of the tag.
1621 * @param testElement The expected Element of the tag.
1622 * @return On success returns the length associated to the tag. On failure
1625 uint32_t File::ReadTagLength(uint16_t testGroup, uint16_t testElement)
1628 if ( !ReadTag(testGroup, testElement) )
1633 //// Then read the associated Item Length
1634 long currentPosition = Fp->tellg();
1635 uint32_t itemLength = ReadInt32();
1637 gdcmWarningMacro( "Basic Item Length is: "
1638 << itemLength << std::endl
1639 << " at address: " << std::hex << (unsigned int)currentPosition);
1645 * \brief When parsing the Pixel Data of an encapsulated file, read
1646 * the basic offset table (when present, and BTW dump it).
1648 void File::ReadAndSkipEncapsulatedBasicOffsetTable()
1650 //// Read the Basic Offset Table Item Tag length...
1651 uint32_t itemLength = ReadTagLength(0xfffe, 0xe000);
1653 // When present, read the basic offset table itself.
1654 // Notes: - since the presence of this basic offset table is optional
1655 // we can't rely on it for the implementation, and we will simply
1656 // trash it's content (when present).
1657 // - still, when present, we could add some further checks on the
1658 // lengths, but we won't bother with such fuses for the time being.
1659 if ( itemLength != 0 )
1661 char *basicOffsetTableItemValue = new char[itemLength + 1];
1662 Fp->read(basicOffsetTableItemValue, itemLength);
1665 for (unsigned int i=0; i < itemLength; i += 4 )
1667 uint32_t individualLength = str2num( &basicOffsetTableItemValue[i],
1669 gdcmWarningMacro( "Read one length: " <<
1670 std::hex << individualLength );
1674 delete[] basicOffsetTableItemValue;
1678 //-----------------------------------------------------------------------------
1681 //-----------------------------------------------------------------------------
1682 } // end namespace gdcm