1 /*=========================================================================
4 Module: $RCSfile: gdcmFile.cxx,v $
6 Date: $Date: 2005/02/10 10:12:16 $
7 Version: $Revision: 1.220 $
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 "gdcmSeqEntry.h"
39 #include "gdcmRLEFramesInfo.h"
40 #include "gdcmJPEGFragmentsInfo.h"
42 #include <stdio.h> //sscanf
47 //-----------------------------------------------------------------------------
48 // Constructor / Destructor
51 * @param filename name of the file whose header we want to analyze
53 File::File( std::string const &filename )
56 RLEInfo = new RLEFramesInfo;
57 JPEGInfo = new JPEGFragmentsInfo;
59 // for some ACR-NEMA images GrPixel, NumPixel is *not* 7fe0,0010
60 // We may encounter the 'RETired' (0x0028, 0x0200) tag
61 // (Image Location") . This entry contains the number of
62 // the group that contains the pixel data (hence the "Pixel Data"
63 // is found by indirection through the "Image Location").
64 // Inside the group pointed by "Image Location" the searched element
65 // is conventionally the element 0x0010 (when the norm is respected).
66 // When the "Image Location" is missing we default to group 0x7fe0.
67 // Note: this IS the right place for the code
70 const std::string &imgLocation = GetEntryValue(0x0028, 0x0200);
71 if ( imgLocation == GDCM_UNFOUND )
78 GrPixel = (uint16_t) atoi( imgLocation.c_str() );
81 // sometimes Image Location value doesn't follow
82 // the supposed processor endianness.
83 // see gdcmData/cr172241.dcm
84 if ( GrPixel == 0xe07f )
89 if ( GrPixel != 0x7fe0 )
91 // This is a kludge for old dirty Philips imager.
99 // Now, we know GrPixel and NumPixel.
100 // Let's create a VirtualDictEntry to allow a further VR modification
101 // and force VR to match with BitsAllocated.
102 DocEntry *entry = GetDocEntry(GrPixel, NumPixel);
105 // Compute the RLE or JPEG info
107 std::string ts = GetTransferSyntax();
108 Fp->seekg( entry->GetOffset(), std::ios::beg );
109 if ( Global::GetTS()->IsRLELossless(ts) )
111 else if ( Global::GetTS()->IsJPEG(ts) )
112 ComputeJPEGFragmentInfo();
115 // Create a new BinEntry to change the the DictEntry
116 // The changed DictEntry will have
117 // - a correct PixelVR OB or OW)
119 // - the name to "Pixel Data"
120 BinEntry *oldEntry = dynamic_cast<BinEntry *>(entry);
124 // 8 bits allocated is a 'O Bytes' , as well as 24 (old ACR-NEMA RGB)
125 // more than 8 (i.e 12, 16) is a 'O Words'
126 if ( GetBitsAllocated() == 8 || GetBitsAllocated() == 24 )
131 // Change only made if usefull
132 if( PixelVR != oldEntry->GetVR() )
134 DictEntry* newDict = NewVirtualDictEntry(GrPixel,NumPixel,
135 PixelVR,"1","Pixel Data");
137 BinEntry *newEntry = new BinEntry(newDict);
138 newEntry->Copy(entry);
139 newEntry->SetBinArea(oldEntry->GetBinArea(),oldEntry->IsSelfArea());
140 oldEntry->SetSelfArea(false);
142 RemoveEntry(oldEntry);
150 * \brief Constructor used when we want to generate dicom files from scratch
155 RLEInfo = new RLEFramesInfo;
156 JPEGInfo = new JPEGFragmentsInfo;
157 InitializeDefaultFile();
161 * \brief Canonical destructor.
171 //-----------------------------------------------------------------------------
174 * \brief This predicate, based on hopefully reasonable heuristics,
175 * decides whether or not the current File was properly parsed
176 * and contains the mandatory information for being considered as
177 * a well formed and usable Dicom/Acr File.
178 * @return true when File is the one of a reasonable Dicom/Acr file,
181 bool File::IsReadable()
183 if( !Document::IsReadable() )
188 const std::string &res = GetEntryValue(0x0028, 0x0005);
189 if ( res != GDCM_UNFOUND && atoi(res.c_str()) > 4 )
191 return false; // Image Dimensions
193 if ( !GetDocEntry(0x0028, 0x0100) )
195 return false; // "Bits Allocated"
197 if ( !GetDocEntry(0x0028, 0x0101) )
199 return false; // "Bits Stored"
201 if ( !GetDocEntry(0x0028, 0x0102) )
203 return false; // "High Bit"
205 if ( !GetDocEntry(0x0028, 0x0103) )
207 return false; // "Pixel Representation" i.e. 'Sign'
214 * \brief gets the info from 0020,0013 : Image Number else 0.
215 * @return image number
217 int File::GetImageNumber()
219 // The function i atoi() takes the address of an area of memory as
220 // parameter and converts the string stored at that location to an integer
221 // using the external decimal to internal binary conversion rules. This may
222 // be preferable to sscanf() since atoi() is a much smaller, simpler and
223 // faster function. sscanf() can do all possible conversions whereas
224 // atoi() can only do single decimal integer conversions.
225 //0020 0013 IS REL Image Number
226 std::string strImNumber = GetEntryValue(0x0020,0x0013);
227 if ( strImNumber != GDCM_UNFOUND )
229 return atoi( strImNumber.c_str() );
235 * \brief gets the info from 0008,0060 : Modality
236 * @return Modality Type
238 ModalityType File::GetModality()
240 // 0008 0060 CS ID Modality
241 std::string strModality = GetEntryValue(0x0008,0x0060);
242 if ( strModality != GDCM_UNFOUND )
244 if ( strModality.find("AU") < strModality.length()) return AU;
245 else if ( strModality.find("AS") < strModality.length()) return AS;
246 else if ( strModality.find("BI") < strModality.length()) return BI;
247 else if ( strModality.find("CF") < strModality.length()) return CF;
248 else if ( strModality.find("CP") < strModality.length()) return CP;
249 else if ( strModality.find("CR") < strModality.length()) return CR;
250 else if ( strModality.find("CT") < strModality.length()) return CT;
251 else if ( strModality.find("CS") < strModality.length()) return CS;
252 else if ( strModality.find("DD") < strModality.length()) return DD;
253 else if ( strModality.find("DF") < strModality.length()) return DF;
254 else if ( strModality.find("DG") < strModality.length()) return DG;
255 else if ( strModality.find("DM") < strModality.length()) return DM;
256 else if ( strModality.find("DS") < strModality.length()) return DS;
257 else if ( strModality.find("DX") < strModality.length()) return DX;
258 else if ( strModality.find("ECG") < strModality.length()) return ECG;
259 else if ( strModality.find("EPS") < strModality.length()) return EPS;
260 else if ( strModality.find("FA") < strModality.length()) return FA;
261 else if ( strModality.find("FS") < strModality.length()) return FS;
262 else if ( strModality.find("HC") < strModality.length()) return HC;
263 else if ( strModality.find("HD") < strModality.length()) return HD;
264 else if ( strModality.find("LP") < strModality.length()) return LP;
265 else if ( strModality.find("LS") < strModality.length()) return LS;
266 else if ( strModality.find("MA") < strModality.length()) return MA;
267 else if ( strModality.find("MR") < strModality.length()) return MR;
268 else if ( strModality.find("NM") < strModality.length()) return NM;
269 else if ( strModality.find("OT") < strModality.length()) return OT;
270 else if ( strModality.find("PT") < strModality.length()) return PT;
271 else if ( strModality.find("RF") < strModality.length()) return RF;
272 else if ( strModality.find("RG") < strModality.length()) return RG;
273 else if ( strModality.find("RTDOSE") < strModality.length()) return RTDOSE;
274 else if ( strModality.find("RTIMAGE") < strModality.length()) return RTIMAGE;
275 else if ( strModality.find("RTPLAN") < strModality.length()) return RTPLAN;
276 else if ( strModality.find("RTSTRUCT") < strModality.length()) return RTSTRUCT;
277 else if ( strModality.find("SM") < strModality.length()) return SM;
278 else if ( strModality.find("ST") < strModality.length()) return ST;
279 else if ( strModality.find("TG") < strModality.length()) return TG;
280 else if ( strModality.find("US") < strModality.length()) return US;
281 else if ( strModality.find("VF") < strModality.length()) return VF;
282 else if ( strModality.find("XA") < strModality.length()) return XA;
283 else if ( strModality.find("XC") < strModality.length()) return XC;
287 /// \todo throw error return value ???
288 /// specified <> unknown in our database
297 * \brief Retrieve the number of columns of image.
298 * @return The encountered size when found, 0 by default.
299 * 0 means the file is NOT USABLE. The caller will have to check
303 const std::string &strSize = GetEntryValue(0x0028,0x0011);
304 if ( strSize == GDCM_UNFOUND )
309 return atoi( strSize.c_str() );
313 * \brief Retrieve the number of lines of image.
314 * \warning The defaulted value is 1 as opposed to File::GetXSize()
315 * @return The encountered size when found, 1 by default
316 * (The ACR-NEMA file contains a Signal, not an Image).
320 const std::string &strSize = GetEntryValue(0x0028,0x0010);
321 if ( strSize != GDCM_UNFOUND )
323 return atoi( strSize.c_str() );
330 // The Rows (0028,0010) entry was optional for ACR/NEMA. It might
331 // hence be a signal (1D image). So we default to 1:
336 * \brief Retrieve the number of planes of volume or the number
337 * of frames of a multiframe.
338 * \warning When present we consider the "Number of Frames" as the third
339 * dimension. When Missing we consider the third dimension as
340 * being the ACR-NEMA "Planes" tag content.
341 * @return The encountered size when found, 1 by default (single image).
345 // Both DicomV3 and ACR/Nema consider the "Number of Frames"
346 // as the third dimension.
347 const std::string &strSize = GetEntryValue(0x0028,0x0008);
348 if ( strSize != GDCM_UNFOUND )
350 return atoi( strSize.c_str() );
353 // We then consider the "Planes" entry as the third dimension
354 const std::string &strSize2 = GetEntryValue(0x0028,0x0012);
355 if ( strSize2 != GDCM_UNFOUND )
357 return atoi( strSize2.c_str() );
364 * \brief gets the info from 0028,0030 : Pixel Spacing
366 * @return X dimension of a pixel
368 float File::GetXSpacing()
370 float xspacing, yspacing;
371 const std::string &strSpacing = GetEntryValue(0x0028,0x0030);
373 if( strSpacing == GDCM_UNFOUND )
375 gdcmWarningMacro( "Unfound Pixel Spacing (0028,0030)" );
380 if( ( nbValues = sscanf( strSpacing.c_str(),
381 "%f\\%f", &yspacing, &xspacing)) != 2 )
383 // if no values, xspacing is set to 1.0
386 // if single value is found, xspacing is defaulted to yspacing
390 if ( xspacing == 0.0 )
397 // to avoid troubles with David Clunie's-like images
398 if ( xspacing == 0. && yspacing == 0.)
403 gdcmWarningMacro("gdcmData/CT-MONO2-8-abdo.dcm problem");
404 // seems to be a bug in the header ...
405 nbValues = sscanf( strSpacing.c_str(), "%f\\0\\%f", &yspacing, &xspacing);
406 gdcmAssertMacro( nbValues == 2 );
413 * \brief gets the info from 0028,0030 : Pixel Spacing
415 * @return Y dimension of a pixel
417 float File::GetYSpacing()
420 std::string strSpacing = GetEntryValue(0x0028,0x0030);
422 if ( strSpacing == GDCM_UNFOUND )
424 gdcmWarningMacro("Unfound Pixel Spacing (0028,0030)");
428 // if sscanf cannot read any float value, it won't affect yspacing
429 int nbValues = sscanf( strSpacing.c_str(), "%f", &yspacing);
431 // if no values, xspacing is set to 1.0
435 if ( yspacing == 0.0 )
442 * \brief gets the info from 0018,0088 : Space Between Slices
443 * else from 0018,0050 : Slice Thickness
445 * @return Z dimension of a voxel-to be
447 float File::GetZSpacing()
449 // Spacing Between Slices : distance entre le milieu de chaque coupe
450 // Les coupes peuvent etre :
451 // jointives (Spacing between Slices = Slice Thickness)
452 // chevauchantes (Spacing between Slices < Slice Thickness)
453 // disjointes (Spacing between Slices > Slice Thickness)
454 // Slice Thickness : epaisseur de tissus sur laquelle est acquis le signal
455 // ca interesse le physicien de l'IRM, pas le visualisateur de volumes ...
456 // Si le Spacing Between Slices est Missing,
457 // on suppose que les coupes sont jointives
459 const std::string &strSpacingBSlices = GetEntryValue(0x0018,0x0088);
461 if ( strSpacingBSlices == GDCM_UNFOUND )
463 gdcmWarningMacro("Unfound Spacing Between Slices (0018,0088)");
464 const std::string &strSliceThickness = GetEntryValue(0x0018,0x0050);
465 if ( strSliceThickness == GDCM_UNFOUND )
467 gdcmWarningMacro("Unfound Slice Thickness (0018,0050)");
472 // if no 'Spacing Between Slices' is found,
473 // we assume slices join together
474 // (no overlapping, no interslice gap)
475 // if they don't, we're fucked up
476 return (float)atof( strSliceThickness.c_str() );
480 return (float)atof( strSpacingBSlices.c_str() );
484 * \brief gets the info from 0020,0032 : Image Position Patient
485 * else from 0020,0030 : Image Position (RET)
487 * @return up-left image corner X position
489 float File::GetXOrigin()
491 float xImPos, yImPos, zImPos;
492 std::string strImPos = GetEntryValue(0x0020,0x0032);
494 if ( strImPos == GDCM_UNFOUND )
496 gdcmWarningMacro( "Unfound Image Position Patient (0020,0032)");
497 strImPos = GetEntryValue(0x0020,0x0030); // For ACR-NEMA images
498 if ( strImPos == GDCM_UNFOUND )
500 gdcmWarningMacro( "Unfound Image Position (RET) (0020,0030)");
505 if( sscanf( strImPos.c_str(), "%f\\%f\\%f", &xImPos, &yImPos, &zImPos) != 3 )
514 * \brief gets the info from 0020,0032 : Image Position Patient
515 * else from 0020,0030 : Image Position (RET)
517 * @return up-left image corner Y position
519 float File::GetYOrigin()
521 float xImPos, yImPos, zImPos;
522 std::string strImPos = GetEntryValue(0x0020,0x0032);
524 if ( strImPos == GDCM_UNFOUND)
526 gdcmWarningMacro( "Unfound Image Position Patient (0020,0032)");
527 strImPos = GetEntryValue(0x0020,0x0030); // For ACR-NEMA images
528 if ( strImPos == GDCM_UNFOUND )
530 gdcmWarningMacro( "Unfound Image Position (RET) (0020,0030)");
535 if( sscanf( strImPos.c_str(), "%f\\%f\\%f", &xImPos, &yImPos, &zImPos) != 3 )
544 * \brief gets the info from 0020,0032 : Image Position Patient
545 * else from 0020,0030 : Image Position (RET)
546 * else from 0020,1041 : Slice Location
547 * else from 0020,0050 : Location
549 * @return up-left image corner Z position
551 float File::GetZOrigin()
553 float xImPos, yImPos, zImPos;
554 std::string strImPos = GetEntryValue(0x0020,0x0032);
556 if ( strImPos != GDCM_UNFOUND )
558 if( sscanf( strImPos.c_str(), "%f\\%f\\%f", &xImPos, &yImPos, &zImPos) != 3)
560 gdcmWarningMacro( "Wrong Image Position Patient (0020,0032)");
561 return 0.; // bug in the element 0x0020,0x0032
569 strImPos = GetEntryValue(0x0020,0x0030); // For ACR-NEMA images
570 if ( strImPos != GDCM_UNFOUND )
572 if( sscanf( strImPos.c_str(),
573 "%f\\%f\\%f", &xImPos, &yImPos, &zImPos ) != 3 )
575 gdcmWarningMacro( "Wrong Image Position (RET) (0020,0030)");
576 return 0.; // bug in the element 0x0020,0x0032
584 std::string strSliceLocation = GetEntryValue(0x0020,0x1041); // for *very* old ACR-NEMA images
585 if ( strSliceLocation != GDCM_UNFOUND )
587 if( sscanf( strSliceLocation.c_str(), "%f", &zImPos) != 1)
589 gdcmWarningMacro( "Wrong Slice Location (0020,1041)");
590 return 0.; // bug in the element 0x0020,0x1041
597 gdcmWarningMacro( "Unfound Slice Location (0020,1041)");
599 std::string strLocation = GetEntryValue(0x0020,0x0050);
600 if ( strLocation != GDCM_UNFOUND )
602 if( sscanf( strLocation.c_str(), "%f", &zImPos) != 1)
604 gdcmWarningMacro( "Wrong Location (0020,0050)");
605 return 0.; // bug in the element 0x0020,0x0050
612 gdcmWarningMacro( "Unfound Location (0020,0050)");
614 return 0.; // Hopeless
618 * \brief gets the info from 0020,0037 : Image Orientation Patient
619 * (needed to organize DICOM files based on their x,y,z position)
620 * @param iop adress of the (6)float aray to receive values
621 * @return cosines of image orientation patient
623 void File::GetImageOrientationPatient( float iop[6] )
625 std::string strImOriPat;
626 //iop is supposed to be float[6]
627 iop[0] = iop[1] = iop[2] = iop[3] = iop[4] = iop[5] = 0.;
629 // 0020 0037 DS REL Image Orientation (Patient)
630 if ( (strImOriPat = GetEntryValue(0x0020,0x0037)) != GDCM_UNFOUND )
632 if( sscanf( strImOriPat.c_str(), "%f\\%f\\%f\\%f\\%f\\%f",
633 &iop[0], &iop[1], &iop[2], &iop[3], &iop[4], &iop[5]) != 6 )
635 gdcmWarningMacro( "Wrong Image Orientation Patient (0020,0037). Less than 6 values were found." );
639 // 0020 0035 DS REL Image Orientation (RET)
640 else if ( (strImOriPat = GetEntryValue(0x0020,0x0035)) != GDCM_UNFOUND )
642 if( sscanf( strImOriPat.c_str(), "%f\\%f\\%f\\%f\\%f\\%f",
643 &iop[0], &iop[1], &iop[2], &iop[3], &iop[4], &iop[5]) != 6 )
645 gdcmWarningMacro( "wrong Image Orientation Patient (0020,0035). Less than 6 values were found." );
651 * \brief Retrieve the number of Bits Stored (actually used)
652 * (as opposed to number of Bits Allocated)
653 * @return The encountered number of Bits Stored, 0 by default.
654 * 0 means the file is NOT USABLE. The caller has to check it !
656 int File::GetBitsStored()
658 std::string strSize = GetEntryValue( 0x0028, 0x0101 );
659 if ( strSize == GDCM_UNFOUND )
661 gdcmWarningMacro("(0028,0101) is supposed to be mandatory");
662 return 0; // It's supposed to be mandatory
663 // the caller will have to check
665 return atoi( strSize.c_str() );
669 * \brief Retrieve the number of Bits Allocated
670 * (8, 12 -compacted ACR-NEMA files, 16, ...)
671 * @return The encountered number of Bits Allocated, 0 by default.
672 * 0 means the file is NOT USABLE. The caller has to check it !
674 int File::GetBitsAllocated()
676 std::string strSize = GetEntryValue(0x0028,0x0100);
677 if ( strSize == GDCM_UNFOUND )
679 gdcmWarningMacro( "(0028,0100) is supposed to be mandatory");
680 return 0; // It's supposed to be mandatory
681 // the caller will have to check
683 return atoi( strSize.c_str() );
687 * \brief Retrieve the high bit position.
688 * \warning The method defaults to 0 when information is Missing.
689 * The responsability of checking this value is left to the caller.
690 * @return The high bit positin when present. 0 when Missing.
692 int File::GetHighBitPosition()
694 std::string strSize = GetEntryValue( 0x0028, 0x0102 );
695 if ( strSize == GDCM_UNFOUND )
697 gdcmWarningMacro( "(0028,0102) is supposed to be mandatory");
700 return atoi( strSize.c_str() );
704 * \brief Retrieve the number of Samples Per Pixel
705 * (1 : gray level, 3 : RGB -1 or 3 Planes-)
706 * @return The encountered number of Samples Per Pixel, 1 by default.
707 * (Gray level Pixels)
709 int File::GetSamplesPerPixel()
711 const std::string &strSize = GetEntryValue(0x0028,0x0002);
712 if ( strSize == GDCM_UNFOUND )
714 gdcmWarningMacro( "(0028,0002) is supposed to be mandatory");
715 return 1; // Well, it's supposed to be mandatory ...
716 // but sometimes it's missing : *we* assume Gray pixels
718 return atoi( strSize.c_str() );
722 * \brief Retrieve the Planar Configuration for RGB images
723 * (0 : RGB Pixels , 1 : R Plane + G Plane + B Plane)
724 * @return The encountered Planar Configuration, 0 by default.
726 int File::GetPlanarConfiguration()
728 std::string strSize = GetEntryValue(0x0028,0x0006);
729 if ( strSize == GDCM_UNFOUND )
731 gdcmWarningMacro( "Not found : Planar Configuration (0028,0006)");
734 return atoi( strSize.c_str() );
738 * \brief Return the size (in bytes) of a single pixel of data.
739 * @return The size in bytes of a single pixel of data; 0 by default
740 * 0 means the file is NOT USABLE; the caller will have to check
742 int File::GetPixelSize()
744 // 0028 0100 US IMG Bits Allocated
745 // (in order no to be messed up by old RGB images)
746 // if (File::GetEntryValue(0x0028,0x0100) == "24")
749 std::string pixelType = GetPixelType();
750 if ( pixelType == "8U" || pixelType == "8S" )
754 if ( pixelType == "16U" || pixelType == "16S")
758 if ( pixelType == "32U" || pixelType == "32S")
762 if ( pixelType == "FD" )
766 gdcmWarningMacro( "Unknown pixel type");
771 * \brief Build the Pixel Type of the image.
772 * Possible values are:
773 * - 8U unsigned 8 bit,
775 * - 16U unsigned 16 bit,
776 * - 16S signed 16 bit,
777 * - 32U unsigned 32 bit,
778 * - 32S signed 32 bit,
779 * - FD floating double 64 bits (Not kosher DICOM, but so usefull!)
780 * \warning 12 bit images appear as 16 bit.
781 * 24 bit images appear as 8 bit
782 * @return 0S if nothing found. NOT USABLE file. The caller has to check
784 std::string File::GetPixelType()
786 std::string bitsAlloc = GetEntryValue(0x0028, 0x0100); // Bits Allocated
787 if ( bitsAlloc == GDCM_UNFOUND )
789 gdcmWarningMacro( "Missing Bits Allocated (0028,0100)");
790 bitsAlloc = "16"; // default and arbitrary value, not to polute the output
793 if ( bitsAlloc == "64" )
797 else if ( bitsAlloc == "12" )
799 // It will be unpacked
802 else if ( bitsAlloc == "24" )
804 // (in order no to be messed up
805 bitsAlloc = "8"; // by old RGB images)
808 std::string sign = GetEntryValue(0x0028, 0x0103);//"Pixel Representation"
810 if (sign == GDCM_UNFOUND )
812 gdcmWarningMacro( "Missing Pixel Representation (0028,0103)");
813 sign = "U"; // default and arbitrary value, not to polute the output
815 else if ( sign == "0" )
823 return bitsAlloc + sign;
827 * \brief Check whether the pixels are signed or UNsigned data.
828 * \warning The method defaults to false (UNsigned) when information is Missing.
829 * The responsability of checking this value is left to the caller.
830 * @return True when signed, false when UNsigned
832 bool File::IsSignedPixelData()
834 std::string strSize = GetEntryValue( 0x0028, 0x0103 );
835 if ( strSize == GDCM_UNFOUND )
837 gdcmWarningMacro( "(0028,0103) is supposed to be mandatory");
840 int sign = atoi( strSize.c_str() );
849 * \brief Check whether this a monochrome picture or not by accessing
850 * the "Photometric Interpretation" tag ( 0x0028, 0x0004 ).
851 * @return true when "MONOCHROME1" or "MONOCHROME2". False otherwise.
853 bool File::IsMonochrome()
855 const std::string &PhotometricInterp = GetEntryValue( 0x0028, 0x0004 );
856 if ( Util::DicomStringEqual(PhotometricInterp, "MONOCHROME1")
857 || Util::DicomStringEqual(PhotometricInterp, "MONOCHROME2") )
861 if ( PhotometricInterp == GDCM_UNFOUND )
863 gdcmWarningMacro( "Not found : Photometric Interpretation (0028,0004)");
869 * \brief Check whether this a "PALETTE COLOR" picture or not by accessing
870 * the "Photometric Interpretation" tag ( 0x0028, 0x0004 ).
871 * @return true when "PALETTE COLOR". False otherwise.
873 bool File::IsPaletteColor()
875 std::string PhotometricInterp = GetEntryValue( 0x0028, 0x0004 );
876 if ( PhotometricInterp == "PALETTE COLOR " )
880 if ( PhotometricInterp == GDCM_UNFOUND )
882 gdcmWarningMacro( "Not found : Palette color (0028,0004)");
888 * \brief Check whether this a "YBR_FULL" color picture or not by accessing
889 * the "Photometric Interpretation" tag ( 0x0028, 0x0004 ).
890 * @return true when "YBR_FULL". False otherwise.
892 bool File::IsYBRFull()
894 std::string PhotometricInterp = GetEntryValue( 0x0028, 0x0004 );
895 if ( PhotometricInterp == "YBR_FULL" )
899 if ( PhotometricInterp == GDCM_UNFOUND )
901 gdcmWarningMacro( "Not found : YBR Full (0028,0004)");
907 * \brief tells us if LUT are used
908 * \warning Right now, 'Segmented xxx Palette Color Lookup Table Data'
909 * are NOT considered as LUT, since nobody knows
910 * how to deal with them
911 * Please warn me if you know sbdy that *does* know ... jprx
912 * @return true if LUT Descriptors and LUT Tables were found
916 // Check the presence of the LUT Descriptors, and LUT Tables
918 if ( !GetDocEntry(0x0028,0x1101) )
922 // LutDescriptorGreen
923 if ( !GetDocEntry(0x0028,0x1102) )
928 if ( !GetDocEntry(0x0028,0x1103) )
932 // Red Palette Color Lookup Table Data
933 if ( !GetDocEntry(0x0028,0x1201) )
937 // Green Palette Color Lookup Table Data
938 if ( !GetDocEntry(0x0028,0x1202) )
942 // Blue Palette Color Lookup Table Data
943 if ( !GetDocEntry(0x0028,0x1203) )
948 // FIXME : (0x0028,0x3006) : LUT Data (CTX dependent)
949 // NOT taken into account, but we don't know how to use it ...
954 * \brief gets the info from 0028,1101 : Lookup Table Desc-Red
956 * @return Lookup Table number of Bits , 0 by default
957 * when (0028,0004),Photometric Interpretation = [PALETTE COLOR ]
958 * @ return bit number of each LUT item
960 int File::GetLUTNbits()
962 std::vector<std::string> tokens;
965 //Just hope Lookup Table Desc-Red = Lookup Table Desc-Red
966 // = Lookup Table Desc-Blue
967 // Consistency already checked in GetLUTLength
968 std::string lutDescription = GetEntryValue(0x0028,0x1101);
969 if ( lutDescription == GDCM_UNFOUND )
974 tokens.clear(); // clean any previous value
975 Util::Tokenize ( lutDescription, tokens, "\\" );
976 //LutLength=atoi(tokens[0].c_str());
977 //LutDepth=atoi(tokens[1].c_str());
979 lutNbits = atoi( tokens[2].c_str() );
986 *\brief gets the info from 0028,1052 : Rescale Intercept
987 * @return Rescale Intercept
989 float File::GetRescaleIntercept()
992 /// 0028 1052 DS IMG Rescale Intercept
993 const std::string &strRescInter = GetEntryValue(0x0028,0x1052);
994 if ( strRescInter != GDCM_UNFOUND )
996 if( sscanf( strRescInter.c_str(), "%f", &resInter) != 1 )
998 // bug in the element 0x0028,0x1052
999 gdcmWarningMacro( "Rescale Intercept (0028,1052) is empty." );
1007 *\brief gets the info from 0028,1053 : Rescale Slope
1008 * @return Rescale Slope
1010 float File::GetRescaleSlope()
1012 float resSlope = 1.;
1013 //0028 1053 DS IMG Rescale Slope
1014 std::string strRescSlope = GetEntryValue(0x0028,0x1053);
1015 if ( strRescSlope != GDCM_UNFOUND )
1017 if( sscanf( strRescSlope.c_str(), "%f", &resSlope) != 1)
1019 // bug in the element 0x0028,0x1053
1020 gdcmWarningMacro( "Rescale Slope (0028,1053) is empty.");
1028 * \brief This function is intended to user who doesn't want
1029 * to have to manage a LUT and expects to get an RBG Pixel image
1030 * (or a monochrome one ...)
1031 * \warning to be used with GetImagePixels()
1032 * @return 1 if Gray level, 3 if Color (RGB, YBR or PALETTE COLOR)
1034 int File::GetNumberOfScalarComponents()
1036 if ( GetSamplesPerPixel() == 3 )
1041 // 0028 0100 US IMG Bits Allocated
1042 // (in order no to be messed up by old RGB images)
1043 if ( GetEntryValue(0x0028,0x0100) == "24" )
1048 std::string strPhotometricInterpretation = GetEntryValue(0x0028,0x0004);
1050 if ( ( strPhotometricInterpretation == "PALETTE COLOR ") )
1052 if ( HasLUT() )// PALETTE COLOR is NOT enough
1062 // beware of trailing space at end of string
1063 // DICOM tags are never of odd length
1064 if ( strPhotometricInterpretation == GDCM_UNFOUND ||
1065 Util::DicomStringEqual(strPhotometricInterpretation, "MONOCHROME1") ||
1066 Util::DicomStringEqual(strPhotometricInterpretation, "MONOCHROME2") )
1072 // we assume that *all* kinds of YBR are dealt with
1078 * \brief This function is intended to user that DOESN'T want
1079 * to get RGB pixels image when it's stored as a PALETTE COLOR image
1080 * - the (vtk) user is supposed to know how deal with LUTs -
1081 * \warning to be used with GetImagePixelsRaw()
1082 * @return 1 if Gray level, 3 if Color (RGB or YBR - NOT 'PALETTE COLOR' -)
1084 int File::GetNumberOfScalarComponentsRaw()
1086 // 0028 0100 US IMG Bits Allocated
1087 // (in order no to be messed up by old RGB images)
1088 if ( File::GetEntryValue(0x0028,0x0100) == "24" )
1093 // we assume that *all* kinds of YBR are dealt with
1094 return GetSamplesPerPixel();
1098 * \brief Recover the offset (from the beginning of the file)
1099 * of *image* pixels (not *icone image* pixels, if any !)
1100 * @return Pixel Offset
1102 size_t File::GetPixelOffset()
1104 DocEntry *pxlElement = GetDocEntry(GrPixel, NumPixel);
1107 return pxlElement->GetOffset();
1111 gdcmDebugMacro( "Big trouble : Pixel Element ("
1112 << std::hex << GrPixel<<","<< NumPixel<< ") NOT found" );
1118 * \brief Recover the pixel area length (in Bytes)
1119 * @return Pixel Element Length, as stored in the header
1120 * (NOT the memory space necessary to hold the Pixels
1121 * -in case of embeded compressed image-)
1122 * 0 : NOT USABLE file. The caller has to check.
1124 size_t File::GetPixelAreaLength()
1126 DocEntry *pxlElement = GetDocEntry(GrPixel, NumPixel);
1129 return pxlElement->GetLength();
1133 gdcmDebugMacro( "Big trouble : Pixel Element ("
1134 << std::hex << GrPixel<<","<< NumPixel<< ") NOT found" );
1140 * \brief Adds the characteristics of a new element we want to anonymize
1143 void File::AddAnonymizeElement (uint16_t group, uint16_t elem,
1144 std::string const &value)
1151 AnonymizeList.push_back(el);
1155 * \brief Overwrites in the file the values of the DicomElements
1158 void File::AnonymizeNoLoad()
1160 std::fstream *fp = new std::fstream(Filename.c_str(),
1161 std::ios::in | std::ios::out | std::ios::binary);
1164 // how to white out disk space if longer than 50 ?
1165 char spaces[50] = " ";
1170 uint32_t lgtToWrite;
1171 for (ListElements::iterator it = AnonymizeList.begin();
1172 it != AnonymizeList.end();
1175 d = GetDocEntry( (*it).Group, (*it).Elem);
1180 if ( dynamic_cast<BinEntry *>(d)
1181 || dynamic_cast<SeqEntry *>(d) )
1184 offset = d->GetOffset();
1185 lgth = d->GetLength();
1186 fp->seekp( offset, std::ios::beg );
1188 if ( (*it).Value == "" )
1190 lgtToWrite = lgth > 50 ? 50 : lgth;
1191 fp->write( spaces, lgtToWrite );
1196 // how to white out disk space if longer than 50 ?
1197 (*it).Value = (*it).Value + spaces;
1198 lgtToWrite = lgth > (*it).Value.length() ? (*it).Value.length() : lgth;
1199 fp->write( (char *)(*it).Value.c_str(), lgtToWrite );
1208 * \brief anonymize a File (removes Patient's personal info passed with
1209 * AddAnonymizeElement()
1211 bool File::AnonymizeFile()
1213 // If Anonymisation list is empty, let's perform some basic anonymisation
1214 if ( AnonymizeList.begin() == AnonymizeList.end() )
1216 // If exist, replace by spaces
1217 SetValEntry (" ",0x0010, 0x2154); // Telephone
1218 SetValEntry (" ",0x0010, 0x1040); // Adress
1219 SetValEntry (" ",0x0010, 0x0020); // Patient ID
1221 DocEntry* patientNameHE = GetDocEntry (0x0010, 0x0010);
1223 if ( patientNameHE ) // we replace it by Study Instance UID (why not ?)
1225 std::string studyInstanceUID = GetEntryValue (0x0020, 0x000d);
1226 if ( studyInstanceUID != GDCM_UNFOUND )
1228 SetValEntry(studyInstanceUID, 0x0010, 0x0010);
1232 SetValEntry("anonymised", 0x0010, 0x0010);
1239 for (ListElements::iterator it = AnonymizeList.begin();
1240 it != AnonymizeList.end();
1243 d = GetDocEntry( (*it).Group, (*it).Elem);
1248 if ( dynamic_cast<BinEntry *>(d)
1249 || dynamic_cast<SeqEntry *>(d) )
1252 SetValEntry ((*it).Value, (*it).Group, (*it).Elem);
1256 // In order to make definitively impossible any further identification
1257 // remove or replace all the stuff that contains a Date
1259 //0008 0012 DA ID Instance Creation Date
1260 //0008 0020 DA ID Study Date
1261 //0008 0021 DA ID Series Date
1262 //0008 0022 DA ID Acquisition Date
1263 //0008 0023 DA ID Content Date
1264 //0008 0024 DA ID Overlay Date
1265 //0008 0025 DA ID Curve Date
1266 //0008 002a DT ID Acquisition Datetime
1267 //0018 9074 DT ACQ Frame Acquisition Datetime
1268 //0018 9151 DT ACQ Frame Reference Datetime
1269 //0018 a002 DT ACQ Contribution Date Time
1270 //0020 3403 SH REL Modified Image Date (RET)
1271 //0032 0032 DA SDY Study Verified Date
1272 //0032 0034 DA SDY Study Read Date
1273 //0032 1000 DA SDY Scheduled Study Start Date
1274 //0032 1010 DA SDY Scheduled Study Stop Date
1275 //0032 1040 DA SDY Study Arrival Date
1276 //0032 1050 DA SDY Study Completion Date
1277 //0038 001a DA VIS Scheduled Admission Date
1278 //0038 001c DA VIS Scheduled Discharge Date
1279 //0038 0020 DA VIS Admitting Date
1280 //0038 0030 DA VIS Discharge Date
1281 //0040 0002 DA PRC Scheduled Procedure Step Start Date
1282 //0040 0004 DA PRC Scheduled Procedure Step End Date
1283 //0040 0244 DA PRC Performed Procedure Step Start Date
1284 //0040 0250 DA PRC Performed Procedure Step End Date
1285 //0040 2004 DA PRC Issue Date of Imaging Service Request
1286 //0040 4005 DT PRC Scheduled Procedure Step Start Date and Time
1287 //0040 4011 DT PRC Expected Completion Date and Time
1288 //0040 a030 DT PRC Verification Date Time
1289 //0040 a032 DT PRC Observation Date Time
1290 //0040 a120 DT PRC DateTime
1291 //0040 a121 DA PRC Date
1292 //0040 a13a DT PRC Referenced Datetime
1293 //0070 0082 DA ??? Presentation Creation Date
1294 //0100 0420 DT ??? SOP Autorization Date and Time
1295 //0400 0105 DT ??? Digital Signature DateTime
1296 //2100 0040 DA PJ Creation Date
1297 //3006 0008 DA SSET Structure Set Date
1298 //3008 0024 DA ??? Treatment Control Point Date
1299 //3008 0054 DA ??? First Treatment Date
1300 //3008 0056 DA ??? Most Recent Treatment Date
1301 //3008 0162 DA ??? Safe Position Exit Date
1302 //3008 0166 DA ??? Safe Position Return Date
1303 //3008 0250 DA ??? Treatment Date
1304 //300a 0006 DA RT RT Plan Date
1305 //300a 022c DA RT Air Kerma Rate Reference Date
1306 //300e 0004 DA RT Review Date
1312 * \brief Performs some consistency checking on various 'File related'
1313 * (as opposed to 'DicomDir related') entries
1314 * then writes in a file all the (Dicom Elements) included the Pixels
1315 * @param fileName file name to write to
1316 * @param filetype Type of the File to be written
1317 * (ACR, ExplicitVR, ImplicitVR)
1319 bool File::Write(std::string fileName, FileType filetype)
1321 std::ofstream *fp = new std::ofstream(fileName.c_str(),
1322 std::ios::out | std::ios::binary);
1325 gdcmWarningMacro("Failed to open (write) File: " << fileName.c_str());
1329 // Entry : 0002|0000 = group length -> recalculated
1330 ValEntry *e0002 = GetValEntry(0x0002,0x0000);
1333 std::ostringstream sLen;
1334 sLen << ComputeGroup0002Length(filetype);
1335 e0002->SetValue(sLen.str());
1339 if ( GetEntryValue(0x0028,0x0100) == "12")
1341 SetValEntry("16", 0x0028,0x0100);
1344 int i_lgPix = GetEntryLength(GrPixel, NumPixel);
1347 // no (GrPixel, NumPixel) element
1348 std::string s_lgPix = Util::Format("%d", i_lgPix+12);
1349 s_lgPix = Util::DicomString( s_lgPix.c_str() );
1350 InsertValEntry(s_lgPix,GrPixel, 0x0000);
1353 // FIXME : should be nice if we could move it to File
1354 // (or in future gdcmPixelData class)
1356 // Drop Palette Color, if necessary
1357 if ( GetEntryValue(0x0028,0x0002).c_str()[0] == '3' )
1359 // if SamplesPerPixel = 3, sure we don't need any LUT !
1360 // Drop 0028|1101, 0028|1102, 0028|1103
1361 // Drop 0028|1201, 0028|1202, 0028|1203
1363 DocEntry *e = GetDocEntry(0x0028,0x01101);
1366 RemoveEntryNoDestroy(e);
1368 e = GetDocEntry(0x0028,0x1102);
1371 RemoveEntryNoDestroy(e);
1373 e = GetDocEntry(0x0028,0x1103);
1376 RemoveEntryNoDestroy(e);
1378 e = GetDocEntry(0x0028,0x01201);
1381 RemoveEntryNoDestroy(e);
1383 e = GetDocEntry(0x0028,0x1202);
1386 RemoveEntryNoDestroy(e);
1388 e = GetDocEntry(0x0028,0x1203);
1391 RemoveEntryNoDestroy(e);
1395 Document::WriteContent(fp, filetype);
1403 //-----------------------------------------------------------------------------
1406 * \brief Initialize a default DICOM File that should contain all the
1407 * field require by other reader. DICOM standard does not
1408 * explicitely defines those fields, heuristic has been choosen.
1409 * This is not perfect as we are writting a CT image...
1411 void File::InitializeDefaultFile()
1413 std::string date = Util::GetCurrentDate();
1414 std::string time = Util::GetCurrentTime();
1415 std::string uid = Util::CreateUniqueUID();
1416 std::string uidMedia = uid;
1417 std::string uidInst = uid;
1418 std::string uidClass = Util::CreateUniqueUID();
1419 std::string uidStudy = Util::CreateUniqueUID();
1420 std::string uidSerie = Util::CreateUniqueUID();
1422 // Meta Element Group Length
1423 InsertValEntry("146 ", 0x0002, 0x0000);
1424 // Media Storage SOP Class UID (CT Image Storage)
1425 InsertValEntry("1.2.840.10008.5.1.4.1.1.2", 0x0002, 0x0002);
1426 // Media Storage SOP Instance UID
1427 InsertValEntry(uidMedia.c_str(), 0x0002, 0x0003);
1428 // Transfer Syntax UID (Explicit VR Little Endian)
1429 InsertValEntry("1.2.840.10008.1.2.1 ", 0x0002, 0x0010);
1430 // META Implementation Class UID
1431 InsertValEntry(uidClass.c_str(), 0x0002, 0x0012);
1432 // Source Application Entity Title
1433 InsertValEntry("GDCM", 0x0002, 0x0016);
1435 // Instance Creation Date
1436 InsertValEntry(date.c_str(), 0x0008, 0x0012);
1437 // Instance Creation Time
1438 InsertValEntry(time.c_str(), 0x0008, 0x0013);
1440 InsertValEntry("1.2.840.10008.5.1.4.1.1.2", 0x0008, 0x0016);
1442 InsertValEntry(uidInst.c_str(), 0x0008, 0x0018);
1444 InsertValEntry("CT", 0x0008, 0x0060);
1446 InsertValEntry("GDCM", 0x0008, 0x0070);
1448 InsertValEntry("GDCM", 0x0008, 0x0080);
1449 // Institution Address
1450 InsertValEntry("http://www-creatis.insa-lyon.fr/Public/Gdcm", 0x0008, 0x0081);
1453 InsertValEntry("GDCM", 0x0010, 0x0010);
1455 InsertValEntry("GDCMID", 0x0010, 0x0020);
1457 // Study Instance UID
1458 InsertValEntry(uidStudy.c_str(), 0x0020, 0x000d);
1459 // Series Instance UID
1460 InsertValEntry(uidSerie.c_str(), 0x0020, 0x000e);
1462 InsertValEntry("1", 0x0020, 0x0010);
1464 InsertValEntry("1", 0x0020, 0x0011);
1466 // Samples per pixel 1 or 3
1467 InsertValEntry("1", 0x0028, 0x0002);
1468 // photochromatic interpretation
1469 InsertValEntry("MONOCHROME1", 0x0028, 0x0004);
1471 InsertValEntry("0", 0x0028, 0x0010);
1473 InsertValEntry("0", 0x0028, 0x0011);
1474 // BitsAllocated 8 or 12 or 16
1475 InsertValEntry("8", 0x0028, 0x0100);
1476 // BitsStored <= BitsAllocated
1477 InsertValEntry("8", 0x0028, 0x0101);
1478 // HighBit <= BitsAllocated - 1
1479 InsertValEntry("7", 0x0028, 0x0102);
1480 // Pixel Representation 0(unsigned) or 1(signed)
1481 InsertValEntry("0", 0x0028, 0x0103);
1484 // Special case this is the image (not a string)
1487 InsertBinEntry(0, 0, GrPixel, NumPixel);
1490 //-----------------------------------------------------------------------------
1493 * \brief Parse pixel data from disk of [multi-]fragment RLE encoding.
1494 * Compute the RLE extra information and store it in \ref RLEInfo
1495 * for later pixel retrieval usage.
1497 void File::ComputeRLEInfo()
1499 std::string ts = GetTransferSyntax();
1500 if ( !Global::GetTS()->IsRLELossless(ts) )
1505 // Encoded pixel data: for the time being we are only concerned with
1506 // Jpeg or RLE Pixel data encodings.
1507 // As stated in PS 3.5-2003, section 8.2 p44:
1508 // "If sent in Encapsulated Format (i.e. other than the Native Format) the
1509 // value representation OB is used".
1510 // Hence we expect an OB value representation. Concerning OB VR,
1511 // the section PS 3.5-2003, section A.4.c p 58-59, states:
1512 // "For the Value Representations OB and OW, the encoding shall meet the
1513 // following specifications depending on the Data element tag:"
1515 // - the first item in the sequence of items before the encoded pixel
1516 // data stream shall be basic offset table item. The basic offset table
1517 // item value, however, is not required to be present"
1518 ReadAndSkipEncapsulatedBasicOffsetTable();
1520 // Encapsulated RLE Compressed Images (see PS 3.5-2003, Annex G)
1521 // Loop on the individual frame[s] and store the information
1522 // on the RLE fragments in a RLEFramesInfo.
1523 // Note: - when only a single frame is present, this is a
1525 // - when more than one frame are present, then we are in
1526 // the case of a multi-frame image.
1528 while ( (frameLength = ReadTagLength(0xfffe, 0xe000)) )
1530 // Parse the RLE Header and store the corresponding RLE Segment
1531 // Offset Table information on fragments of this current Frame.
1532 // Note that the fragment pixels themselves are not loaded
1533 // (but just skipped).
1534 long frameOffset = Fp->tellg();
1536 uint32_t nbRleSegments = ReadInt32();
1537 if ( nbRleSegments > 16 )
1539 // There should be at most 15 segments (refer to RLEFrame class)
1540 gdcmWarningMacro( "Too many segments.");
1543 uint32_t rleSegmentOffsetTable[16];
1544 for( int k = 1; k <= 15; k++ )
1546 rleSegmentOffsetTable[k] = ReadInt32();
1549 // Deduce from both the RLE Header and the frameLength the
1550 // fragment length, and again store this info in a
1552 long rleSegmentLength[15];
1553 // skipping (not reading) RLE Segments
1554 if ( nbRleSegments > 1)
1556 for(unsigned int k = 1; k <= nbRleSegments-1; k++)
1558 rleSegmentLength[k] = rleSegmentOffsetTable[k+1]
1559 - rleSegmentOffsetTable[k];
1560 SkipBytes(rleSegmentLength[k]);
1564 rleSegmentLength[nbRleSegments] = frameLength
1565 - rleSegmentOffsetTable[nbRleSegments];
1566 SkipBytes(rleSegmentLength[nbRleSegments]);
1568 // Store the collected info
1569 RLEFrame *newFrame = new RLEFrame;
1570 newFrame->SetNumberOfFragments(nbRleSegments);
1571 for( unsigned int uk = 1; uk <= nbRleSegments; uk++ )
1573 newFrame->SetOffset(uk,frameOffset + rleSegmentOffsetTable[uk]);
1574 newFrame->SetLength(uk,rleSegmentLength[uk]);
1576 RLEInfo->AddFrame(newFrame);
1579 // Make sure that at the end of the item we encounter a 'Sequence
1581 if ( !ReadTag(0xfffe, 0xe0dd) )
1583 gdcmWarningMacro( "No sequence delimiter item at end of RLE item sequence");
1588 * \brief Parse pixel data from disk of [multi-]fragment Jpeg encoding.
1589 * Compute the jpeg extra information (fragment[s] offset[s] and
1590 * length) and store it[them] in \ref JPEGInfo for later pixel
1593 void File::ComputeJPEGFragmentInfo()
1595 // If you need to, look for comments of ComputeRLEInfo().
1596 std::string ts = GetTransferSyntax();
1597 if ( ! Global::GetTS()->IsJPEG(ts) )
1602 ReadAndSkipEncapsulatedBasicOffsetTable();
1604 // Loop on the fragments[s] and store the parsed information in a
1606 long fragmentLength;
1607 while ( (fragmentLength = ReadTagLength(0xfffe, 0xe000)) )
1609 long fragmentOffset = Fp->tellg();
1611 // Store the collected info
1612 JPEGFragment *newFragment = new JPEGFragment;
1613 newFragment->SetOffset(fragmentOffset);
1614 newFragment->SetLength(fragmentLength);
1615 JPEGInfo->AddFragment(newFragment);
1617 SkipBytes(fragmentLength);
1620 // Make sure that at the end of the item we encounter a 'Sequence
1622 if ( !ReadTag(0xfffe, 0xe0dd) )
1624 gdcmWarningMacro( "No sequence delimiter item at end of JPEG item sequence");
1629 * \brief Assuming the internal file pointer \ref Document::Fp
1630 * is placed at the beginning of a tag check whether this
1631 * tag is (TestGroup, TestElement).
1632 * \warning On success the internal file pointer \ref Document::Fp
1633 * is modified to point after the tag.
1634 * On failure (i.e. when the tag wasn't the expected tag
1635 * (TestGroup, TestElement) the internal file pointer
1636 * \ref Document::Fp is restored to it's original position.
1637 * @param testGroup The expected group of the tag.
1638 * @param testElement The expected Element of the tag.
1639 * @return True on success, false otherwise.
1641 bool File::ReadTag(uint16_t testGroup, uint16_t testElement)
1643 long positionOnEntry = Fp->tellg();
1644 long currentPosition = Fp->tellg(); // On debugging purposes
1646 // Read the Item Tag group and element, and make
1647 // sure they are what we expected:
1648 uint16_t itemTagGroup;
1649 uint16_t itemTagElement;
1652 itemTagGroup = ReadInt16();
1653 itemTagElement = ReadInt16();
1655 catch ( FormatError e )
1657 //std::cerr << e << std::endl;
1660 if ( itemTagGroup != testGroup || itemTagElement != testElement )
1662 gdcmWarningMacro( "Wrong Item Tag found:"
1663 << " We should have found tag ("
1664 << std::hex << testGroup << "," << testElement << ")" << std::endl
1665 << " but instead we encountered tag ("
1666 << std::hex << itemTagGroup << "," << itemTagElement << ")"
1667 << " at address: " << " 0x(" << (unsigned int)currentPosition << ")"
1669 Fp->seekg(positionOnEntry, std::ios::beg);
1677 * \brief Assuming the internal file pointer \ref Document::Fp
1678 * is placed at the beginning of a tag (TestGroup, TestElement),
1679 * read the length associated to the Tag.
1680 * \warning On success the internal file pointer \ref Document::Fp
1681 * is modified to point after the tag and it's length.
1682 * On failure (i.e. when the tag wasn't the expected tag
1683 * (TestGroup, TestElement) the internal file pointer
1684 * \ref Document::Fp is restored to it's original position.
1685 * @param testGroup The expected group of the tag.
1686 * @param testElement The expected Element of the tag.
1687 * @return On success returns the length associated to the tag. On failure
1690 uint32_t File::ReadTagLength(uint16_t testGroup, uint16_t testElement)
1693 if ( !ReadTag(testGroup, testElement) )
1698 //// Then read the associated Item Length
1699 long currentPosition = Fp->tellg();
1700 uint32_t itemLength = ReadInt32();
1702 gdcmWarningMacro( "Basic Item Length is: "
1703 << itemLength << std::endl
1704 << " at address: " << std::hex << (unsigned int)currentPosition);
1710 * \brief When parsing the Pixel Data of an encapsulated file, read
1711 * the basic offset table (when present, and BTW dump it).
1713 void File::ReadAndSkipEncapsulatedBasicOffsetTable()
1715 //// Read the Basic Offset Table Item Tag length...
1716 uint32_t itemLength = ReadTagLength(0xfffe, 0xe000);
1718 // When present, read the basic offset table itself.
1719 // Notes: - since the presence of this basic offset table is optional
1720 // we can't rely on it for the implementation, and we will simply
1721 // trash it's content (when present).
1722 // - still, when present, we could add some further checks on the
1723 // lengths, but we won't bother with such fuses for the time being.
1724 if ( itemLength != 0 )
1726 char *basicOffsetTableItemValue = new char[itemLength + 1];
1727 Fp->read(basicOffsetTableItemValue, itemLength);
1730 for (unsigned int i=0; i < itemLength; i += 4 )
1732 uint32_t individualLength = str2num( &basicOffsetTableItemValue[i],
1734 gdcmWarningMacro( "Read one length: " <<
1735 std::hex << individualLength );
1739 delete[] basicOffsetTableItemValue;
1743 //-----------------------------------------------------------------------------
1746 //-----------------------------------------------------------------------------
1747 } // end namespace gdcm