1 /*=========================================================================
4 Module: $RCSfile: gdcmPixelReadConvert.cxx,v $
6 Date: $Date: 2005/06/13 15:43:48 $
7 Version: $Revision: 1.64 $
9 Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
10 l'Image). All rights reserved. See Doc/License.txt or
11 http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
13 This software is distributed WITHOUT ANY WARRANTY; without even
14 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15 PURPOSE. See the above copyright notices for more information.
17 =========================================================================*/
19 #include "gdcmPixelReadConvert.h"
20 #include "gdcmDebug.h"
22 #include "gdcmGlobal.h"
24 #include "gdcmDocEntry.h"
25 #include "gdcmRLEFramesInfo.h"
26 #include "gdcmJPEGFragmentsInfo.h"
29 #include <stdio.h> //for sscanf
34 //bool ReadMPEGFile (std::ifstream *fp, void *image_buffer, size_t lenght);
35 bool gdcm_read_JPEG2000_file (void* raw,
36 char *inputdata, size_t inputlength);
37 //-----------------------------------------------------------------------------
38 #define str2num(str, typeNum) *((typeNum *)(str))
40 //-----------------------------------------------------------------------------
41 // Constructor / Destructor
43 PixelReadConvert::PixelReadConvert()
55 /// Canonical Destructor
56 PixelReadConvert::~PixelReadConvert()
61 //-----------------------------------------------------------------------------
64 * \brief Predicate to know whether the image[s] (once Raw) is RGB.
65 * \note See comments of \ref ConvertHandleColor
67 bool PixelReadConvert::IsRawRGB()
70 || PlanarConfiguration == 2
78 * \brief Gets various usefull informations from the file header
79 * @param file gdcm::File pointer
81 void PixelReadConvert::GrabInformationsFromFile( File *file )
83 // Number of Bits Allocated for storing a Pixel is defaulted to 16
84 // when absent from the file.
85 BitsAllocated = file->GetBitsAllocated();
86 if ( BitsAllocated == 0 )
91 // Number of "Bits Stored", defaulted to number of "Bits Allocated"
92 // when absent from the file.
93 BitsStored = file->GetBitsStored();
94 if ( BitsStored == 0 )
96 BitsStored = BitsAllocated;
99 // High Bit Position, defaulted to "Bits Allocated" - 1
100 HighBitPosition = file->GetHighBitPosition();
101 if ( HighBitPosition == 0 )
103 HighBitPosition = BitsAllocated - 1;
106 XSize = file->GetXSize();
107 YSize = file->GetYSize();
108 ZSize = file->GetZSize();
109 SamplesPerPixel = file->GetSamplesPerPixel();
110 PixelSize = file->GetPixelSize();
111 PixelSign = file->IsSignedPixelData();
112 SwapCode = file->GetSwapCode();
113 std::string ts = file->GetTransferSyntax();
115 ( ! file->IsDicomV3() )
116 || Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ImplicitVRLittleEndian
117 || Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ImplicitVRLittleEndianDLXGE
118 || Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ExplicitVRLittleEndian
119 || Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ExplicitVRBigEndian
120 || Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::DeflatedExplicitVRLittleEndian;
122 IsMPEG = Global::GetTS()->IsMPEG(ts);
123 IsJPEG2000 = Global::GetTS()->IsJPEG2000(ts);
124 IsJPEGLS = Global::GetTS()->IsJPEGLS(ts);
125 IsJPEGLossy = Global::GetTS()->IsJPEGLossy(ts);
126 IsJPEGLossless = Global::GetTS()->IsJPEGLossless(ts);
127 IsRLELossless = Global::GetTS()->IsRLELossless(ts);
129 PixelOffset = file->GetPixelOffset();
130 PixelDataLength = file->GetPixelAreaLength();
131 RLEInfo = file->GetRLEInfo();
132 JPEGInfo = file->GetJPEGInfo();
134 IsMonochrome = file->IsMonochrome();
135 IsMonochrome1 = file->IsMonochrome1();
136 IsPaletteColor = file->IsPaletteColor();
137 IsYBRFull = file->IsYBRFull();
139 PlanarConfiguration = file->GetPlanarConfiguration();
141 /////////////////////////////////////////////////////////////////
143 HasLUT = file->HasLUT();
146 // Just in case some access to a File element requires disk access.
147 LutRedDescriptor = file->GetEntryValue( 0x0028, 0x1101 );
148 LutGreenDescriptor = file->GetEntryValue( 0x0028, 0x1102 );
149 LutBlueDescriptor = file->GetEntryValue( 0x0028, 0x1103 );
151 // Depending on the value of Document::MAX_SIZE_LOAD_ELEMENT_VALUE
152 // [ refer to invocation of Document::SetMaxSizeLoadEntry() in
153 // Document::Document() ], the loading of the value (content) of a
154 // [Bin|Val]Entry occurence migth have been hindered (read simply NOT
155 // loaded). Hence, we first try to obtain the LUTs data from the file
156 // and when this fails we read the LUTs data directly from disk.
157 // \TODO Reading a [Bin|Val]Entry directly from disk is a kludge.
158 // We should NOT bypass the [Bin|Val]Entry class. Instead
159 // an access to an UNLOADED content of a [Bin|Val]Entry occurence
160 // (e.g. BinEntry::GetBinArea()) should force disk access from
161 // within the [Bin|Val]Entry class itself. The only problem
162 // is that the [Bin|Val]Entry is unaware of the FILE* is was
163 // parsed from. Fix that. FIXME.
166 file->LoadEntryBinArea(0x0028, 0x1201);
167 LutRedData = (uint8_t*)file->GetEntryBinArea( 0x0028, 0x1201 );
170 gdcmWarningMacro( "Unable to read Red LUT data" );
174 file->LoadEntryBinArea(0x0028, 0x1202);
175 LutGreenData = (uint8_t*)file->GetEntryBinArea(0x0028, 0x1202 );
178 gdcmWarningMacro( "Unable to read Green LUT data" );
182 file->LoadEntryBinArea(0x0028, 0x1203);
183 LutBlueData = (uint8_t*)file->GetEntryBinArea( 0x0028, 0x1203 );
186 gdcmWarningMacro( "Unable to read Blue LUT data" );
190 ComputeRawAndRGBSizes();
193 /// \brief Reads from disk and decompresses Pixels
194 bool PixelReadConvert::ReadAndDecompressPixelData( std::ifstream *fp )
196 // ComputeRawAndRGBSizes is already made by
197 // ::GrabInformationsFromfile. So, the structure sizes are
201 //////////////////////////////////////////////////
202 //// First stage: get our hands on the Pixel Data.
205 gdcmWarningMacro( "Unavailable file pointer." );
209 fp->seekg( PixelOffset, std::ios::beg );
210 if( fp->fail() || fp->eof())
212 gdcmWarningMacro( "Unable to find PixelOffset in file." );
218 //////////////////////////////////////////////////
219 //// Second stage: read from disk dans decompress.
220 if ( BitsAllocated == 12 )
222 ReadAndDecompress12BitsTo16Bits( fp);
226 // This problem can be found when some obvious informations are found
227 // after the field containing the image data. In this case, these
228 // bad data are added to the size of the image (in the PixelDataLength
229 // variable). But RawSize is the right size of the image !
230 if( PixelDataLength != RawSize)
232 gdcmWarningMacro( "Mismatch between PixelReadConvert : "
233 << PixelDataLength << " and RawSize : " << RawSize );
235 if( PixelDataLength > RawSize)
237 fp->read( (char*)Raw, RawSize);
241 fp->read( (char*)Raw, PixelDataLength);
244 if ( fp->fail() || fp->eof())
246 gdcmWarningMacro( "Reading of Raw pixel data failed." );
250 else if ( IsRLELossless )
252 if ( ! RLEInfo->DecompressRLEFile( fp, Raw, XSize, YSize, ZSize, BitsAllocated ) )
254 gdcmWarningMacro( "RLE decompressor failed." );
260 //gdcmWarningMacro( "Sorry, MPEG not yet taken into account" );
262 // ReadMPEGFile(fp, Raw, PixelDataLength); // fp has already been seek to start of mpeg
267 // Default case concerns JPEG family
268 if ( ! ReadAndDecompressJPEGFile( fp ) )
270 gdcmWarningMacro( "JPEG decompressor failed." );
275 ////////////////////////////////////////////
276 //// Third stage: twigle the bytes and bits.
277 ConvertReorderEndianity();
278 ConvertReArrangeBits();
279 ConvertFixGreyLevels();
280 ConvertHandleColor();
285 /// Deletes Pixels Area
286 void PixelReadConvert::Squeeze()
302 * \brief Build the RGB image from the Raw imagage and the LUTs.
304 bool PixelReadConvert::BuildRGBImage()
308 // The job is already done.
314 // The job can't be done
321 // The job can't be done
327 uint8_t *localRGB = RGB;
328 for (size_t i = 0; i < RawSize; ++i )
331 *localRGB++ = LutRGBA[j];
332 *localRGB++ = LutRGBA[j+1];
333 *localRGB++ = LutRGBA[j+2];
338 //-----------------------------------------------------------------------------
341 //-----------------------------------------------------------------------------
344 * \brief Read from file a 12 bits per pixel image and decompress it
345 * into a 16 bits per pixel image.
347 void PixelReadConvert::ReadAndDecompress12BitsTo16Bits( std::ifstream *fp )
348 throw ( FormatError )
350 int nbPixels = XSize * YSize;
351 uint16_t *localDecompres = (uint16_t*)Raw;
353 for( int p = 0; p < nbPixels; p += 2 )
357 fp->read( (char*)&b0, 1);
358 if ( fp->fail() || fp->eof() )
360 throw FormatError( "PixelReadConvert::ReadAndDecompress12BitsTo16Bits()",
361 "Unfound first block" );
364 fp->read( (char*)&b1, 1 );
365 if ( fp->fail() || fp->eof())
367 throw FormatError( "PixelReadConvert::ReadAndDecompress12BitsTo16Bits()",
368 "Unfound second block" );
371 fp->read( (char*)&b2, 1 );
372 if ( fp->fail() || fp->eof())
374 throw FormatError( "PixelReadConvert::ReadAndDecompress12BitsTo16Bits()",
375 "Unfound second block" );
378 // Two steps are necessary to please VC++
380 // 2 pixels 12bit = [0xABCDEF]
381 // 2 pixels 16bit = [0x0ABD] + [0x0FCE]
383 *localDecompres++ = ((b0 >> 4) << 8) + ((b0 & 0x0f) << 4) + (b1 & 0x0f);
385 *localDecompres++ = ((b2 & 0x0f) << 8) + ((b1 >> 4) << 4) + (b2 >> 4);
387 /// \todo JPR Troubles expected on Big-Endian processors ?
392 * \brief Reads from disk the Pixel Data of JPEG Dicom encapsulated
393 * file and decompress it.
394 * @param fp File Pointer
397 bool PixelReadConvert::ReadAndDecompressJPEGFile( std::ifstream *fp )
401 // FIXME this is really ugly but it seems I have to load the complete
402 // jpeg2000 stream to use jasper:
403 // I don't think we'll ever be able to deal with multiple fragments properly
405 unsigned long inputlength = 0;
406 JPEGFragment *jpegfrag = JPEGInfo->GetFirstFragment();
409 inputlength += jpegfrag->GetLength();
410 jpegfrag = JPEGInfo->GetNextFragment();
412 gdcmAssertMacro( inputlength != 0);
413 uint8_t *inputdata = new uint8_t[inputlength];
414 char *pinputdata = (char*)inputdata;
415 jpegfrag = JPEGInfo->GetFirstFragment();
418 fp->seekg( jpegfrag->GetOffset(), std::ios::beg);
419 fp->read(pinputdata, jpegfrag->GetLength());
420 pinputdata += jpegfrag->GetLength();
421 jpegfrag = JPEGInfo->GetNextFragment();
423 // Warning the inputdata buffer is delete in the function
424 if ( ! gdcm_read_JPEG2000_file( Raw,
425 (char*)inputdata, inputlength ) )
433 // WARNING : JPEG-LS is NOT the 'classical' Jpeg Lossless :
434 // [JPEG-LS is the basis for new lossless/near-lossless compression
435 // standard for continuous-tone images intended for JPEG2000. The standard
436 // is based on the LOCO-I algorithm (LOw COmplexity LOssless COmpression
437 // for Images) developed at Hewlett-Packard Laboratories]
439 // see http://datacompression.info/JPEGLS.shtml
442 gdcmWarningMacro( "Sorry, JPEG-LS not yet taken into account" );
443 fp->seekg( JPEGInfo->GetFirstFragment()->GetOffset(), std::ios::beg);
444 // if ( ! gdcm_read_JPEGLS_file( fp,Raw ) )
449 // Precompute the offset localRaw will be shifted with
450 int length = XSize * YSize * SamplesPerPixel;
451 int numberBytes = BitsAllocated / 8;
453 JPEGInfo->DecompressFromFile(fp, Raw, BitsStored, numberBytes, length );
459 * \brief Build Red/Green/Blue/Alpha LUT from File
460 * when (0028,0004),Photometric Interpretation = [PALETTE COLOR ]
461 * and (0028,1101),(0028,1102),(0028,1102)
462 * - xxx Palette Color Lookup Table Descriptor - are found
463 * and (0028,1201),(0028,1202),(0028,1202)
464 * - xxx Palette Color Lookup Table Data - are found
465 * \warning does NOT deal with :
466 * 0028 1100 Gray Lookup Table Descriptor (Retired)
467 * 0028 1221 Segmented Red Palette Color Lookup Table Data
468 * 0028 1222 Segmented Green Palette Color Lookup Table Data
469 * 0028 1223 Segmented Blue Palette Color Lookup Table Data
470 * no known Dicom reader deals with them :-(
471 * @return a RGBA Lookup Table
473 void PixelReadConvert::BuildLUTRGBA()
480 // http://www.barre.nom.fr/medical/dicom2/limitations.html#Color%20Lookup%20Tables
482 if ( ! IsPaletteColor )
487 if ( LutRedDescriptor == GDCM_UNFOUND
488 || LutGreenDescriptor == GDCM_UNFOUND
489 || LutBlueDescriptor == GDCM_UNFOUND )
491 gdcmWarningMacro( "(At least) a LUT Descriptor is missing" );
495 ////////////////////////////////////////////
496 // Extract the info from the LUT descriptors
497 int lengthR; // Red LUT length in Bytes
498 int debR; // Subscript of the first Lut Value
499 int nbitsR; // Lut item size (in Bits)
500 int nbRead = sscanf( LutRedDescriptor.c_str(),
502 &lengthR, &debR, &nbitsR );
505 gdcmWarningMacro( "Wrong Red LUT descriptor" );
508 int lengthG; // Green LUT length in Bytes
509 int debG; // Subscript of the first Lut Value
510 int nbitsG; // Lut item size (in Bits)
511 nbRead = sscanf( LutGreenDescriptor.c_str(),
513 &lengthG, &debG, &nbitsG );
517 gdcmWarningMacro( "Wrong Green LUT descriptor" );
520 int lengthB; // Blue LUT length in Bytes
521 int debB; // Subscript of the first Lut Value
522 int nbitsB; // Lut item size (in Bits)
523 nbRead = sscanf( LutRedDescriptor.c_str(),
525 &lengthB, &debB, &nbitsB );
526 gdcmWarningMacro(" lengthR " << lengthR << " debR "
527 << debR << " nbitsR " << nbitsR);
528 gdcmWarningMacro(" lengthG " << lengthG << " debG "
529 << debG << " nbitsG " << nbitsG);
530 gdcmWarningMacro(" lengthB " << lengthB << " debB "
531 << debB << " nbitsB " << nbitsB);
534 gdcmWarningMacro( "Wrong Blue LUT descriptor" );
537 if ( !lengthR ) // if = 2^16, this shall be 0 see : CP-143
539 if( !lengthG ) // if = 2^16, this shall be 0
541 if ( !lengthB ) // if = 2^16, this shall be 0
544 ////////////////////////////////////////////////////////
546 if ( ( ! LutRedData ) || ( ! LutGreenData ) || ( ! LutBlueData ) )
548 gdcmWarningMacro( "(At least) a LUT is missing" );
552 // -------------------------------------------------------------
554 if ( BitsAllocated <= 8)
557 // forge the 4 * 8 Bits Red/Green/Blue/Alpha LUT
558 LutRGBA = new uint8_t[ 1024 ]; // 256 * 4 (R, G, B, Alpha)
562 memset( LutRGBA, 0, 1024 );
565 if ( ( nbitsR == 16 ) && ( BitsAllocated == 8 ) )
567 // when LUT item size is different than pixel size
568 mult = 2; // high byte must be = low byte
572 // See PS 3.3-2003 C.11.1.1.2 p 619
576 // if we get a black image, let's just remove the '+1'
577 // from 'i*mult+1' and check again
578 // if it works, we shall have to check the 3 Palettes
579 // to see which byte is ==0 (first one, or second one)
581 // We give up the checking to avoid some (useless ?) overhead
582 // (optimistic asumption)
586 //take "Subscript of the first Lut Value" (debR,debG,debB) into account!
588 a = LutRGBA + 0 + debR;
589 for( i=0; i < lengthR; ++i )
591 *a = LutRedData[i*mult+1];
595 a = LutRGBA + 1 + debG;
596 for( i=0; i < lengthG; ++i)
598 *a = LutGreenData[i*mult+1];
602 a = LutRGBA + 2 + debB;
603 for(i=0; i < lengthB; ++i)
605 *a = LutBlueData[i*mult+1];
610 for(i=0; i < 256; ++i)
612 *a = 1; // Alpha component
618 gdcmWarningMacro( "Sorry Palette Color Lookup Tables not yet dealt with"
619 << "for 16 Bits Per Pixel images" );
624 * \brief Swap the bytes, according to \ref SwapCode.
626 void PixelReadConvert::ConvertSwapZone()
630 if( BitsAllocated == 16 )
632 uint16_t *im16 = (uint16_t*)Raw;
640 for( i = 0; i < RawSize / 2; i++ )
642 im16[i]= (im16[i] >> 8) | (im16[i] << 8 );
646 gdcmWarningMacro("SwapCode value (16 bits) not allowed.");
649 else if( BitsAllocated == 32 )
654 uint32_t *im32 = (uint32_t*)Raw;
660 for( i = 0; i < RawSize / 4; i++ )
662 low = im32[i] & 0x0000ffff; // 4321
663 high = im32[i] >> 16;
664 high = ( high >> 8 ) | ( high << 8 );
665 low = ( low >> 8 ) | ( low << 8 );
667 im32[i] = ( s32 << 16 ) | high;
671 for( i = 0; i < RawSize / 4; i++ )
673 low = im32[i] & 0x0000ffff; // 2143
674 high = im32[i] >> 16;
675 high = ( high >> 8 ) | ( high << 8 );
676 low = ( low >> 8 ) | ( low << 8 );
678 im32[i] = ( s32 << 16 ) | low;
682 for( i = 0; i < RawSize / 4; i++ )
684 low = im32[i] & 0x0000ffff; // 3412
685 high = im32[i] >> 16;
687 im32[i] = ( s32 << 16 ) | high;
691 gdcmWarningMacro("SwapCode value (32 bits) not allowed." );
697 * \brief Deal with endianness i.e. re-arange bytes inside the integer
699 void PixelReadConvert::ConvertReorderEndianity()
701 if ( BitsAllocated != 8 )
706 // Special kludge in order to deal with xmedcon broken images:
707 if ( BitsAllocated == 16
708 && BitsStored < BitsAllocated
711 int l = (int)( RawSize / ( BitsAllocated / 8 ) );
712 uint16_t *deb = (uint16_t *)Raw;
713 for(int i = 0; i<l; i++)
725 * \brief Deal with Grey levels i.e. re-arange them
726 * to have low values = dark, high values = bright
728 void PixelReadConvert::ConvertFixGreyLevels()
733 uint32_t i; // to please M$VC6
738 if ( BitsAllocated == 8 )
740 uint8_t *deb = (uint8_t *)Raw;
741 for (i=0; i<RawSize; i++)
749 if ( BitsAllocated == 16 )
752 for (j=0; j<BitsStored-1; j++)
754 mask = (mask << 1) +1; // will be fff when BitsStored=12
757 uint16_t *deb = (uint16_t *)Raw;
758 for (i=0; i<RawSize/2; i++)
768 if ( BitsAllocated == 8 )
770 uint8_t smask8 = 255;
771 uint8_t *deb = (uint8_t *)Raw;
772 for (i=0; i<RawSize; i++)
774 *deb = smask8 - *deb;
779 if ( BitsAllocated == 16 )
781 uint16_t smask16 = 65535;
782 uint16_t *deb = (uint16_t *)Raw;
783 for (i=0; i<RawSize/2; i++)
785 *deb = smask16 - *deb;
794 * \brief Re-arrange the bits within the bytes.
795 * @return Boolean always true
797 bool PixelReadConvert::ConvertReArrangeBits() throw ( FormatError )
799 if ( BitsStored != BitsAllocated )
801 int l = (int)( RawSize / ( BitsAllocated / 8 ) );
802 if ( BitsAllocated == 16 )
804 uint16_t mask = 0xffff;
805 mask = mask >> ( BitsAllocated - BitsStored );
806 uint16_t *deb = (uint16_t*)Raw;
807 for(int i = 0; i<l; i++)
809 *deb = (*deb >> (BitsStored - HighBitPosition - 1)) & mask;
813 else if ( BitsAllocated == 32 )
815 uint32_t mask = 0xffffffff;
816 mask = mask >> ( BitsAllocated - BitsStored );
817 uint32_t *deb = (uint32_t*)Raw;
818 for(int i = 0; i<l; i++)
820 *deb = (*deb >> (BitsStored - HighBitPosition - 1)) & mask;
826 gdcmWarningMacro("Weird image");
827 throw FormatError( "Weird image !?" );
834 * \brief Convert (Red plane, Green plane, Blue plane) to RGB pixels
835 * \warning Works on all the frames at a time
837 void PixelReadConvert::ConvertRGBPlanesToRGBPixels()
839 uint8_t *localRaw = Raw;
840 uint8_t *copyRaw = new uint8_t[ RawSize ];
841 memmove( copyRaw, localRaw, RawSize );
843 int l = XSize * YSize * ZSize;
845 uint8_t *a = copyRaw;
846 uint8_t *b = copyRaw + l;
847 uint8_t *c = copyRaw + l + l;
849 for (int j = 0; j < l; j++)
851 *(localRaw++) = *(a++);
852 *(localRaw++) = *(b++);
853 *(localRaw++) = *(c++);
859 * \brief Convert (cY plane, cB plane, cR plane) to RGB pixels
860 * \warning Works on all the frames at a time
862 void PixelReadConvert::ConvertYcBcRPlanesToRGBPixels()
864 uint8_t *localRaw = Raw;
865 uint8_t *copyRaw = new uint8_t[ RawSize ];
866 memmove( copyRaw, localRaw, RawSize );
868 // to see the tricks about YBR_FULL, YBR_FULL_422,
869 // YBR_PARTIAL_422, YBR_ICT, YBR_RCT have a look at :
870 // ftp://medical.nema.org/medical/dicom/final/sup61_ft.pdf
871 // and be *very* affraid
873 int l = XSize * YSize;
874 int nbFrames = ZSize;
876 uint8_t *a = copyRaw + 0;
877 uint8_t *b = copyRaw + l;
878 uint8_t *c = copyRaw + l+ l;
881 /// \todo : Replace by the 'well known' integer computation
882 /// counterpart. Refer to
883 /// http://lestourtereaux.free.fr/papers/data/yuvrgb.pdf
884 /// for code optimisation.
886 for ( int i = 0; i < nbFrames; i++ )
888 for ( int j = 0; j < l; j++ )
890 R = 38142 *(*a-16) + 52298 *(*c -128);
891 G = 38142 *(*a-16) - 26640 *(*c -128) - 12845 *(*b -128);
892 B = 38142 *(*a-16) + 66093 *(*b -128);
901 if (R > 255) R = 255;
902 if (G > 255) G = 255;
903 if (B > 255) B = 255;
905 *(localRaw++) = (uint8_t)R;
906 *(localRaw++) = (uint8_t)G;
907 *(localRaw++) = (uint8_t)B;
916 /// \brief Deals with the color decoding i.e. handle:
917 /// - R, G, B planes (as opposed to RGB pixels)
918 /// - YBR (various) encodings.
919 /// - LUT[s] (or "PALETTE COLOR").
921 void PixelReadConvert::ConvertHandleColor()
923 //////////////////////////////////
924 // Deal with the color decoding i.e. handle:
925 // - R, G, B planes (as opposed to RGB pixels)
926 // - YBR (various) encodings.
927 // - LUT[s] (or "PALETTE COLOR").
929 // The classification in the color decoding schema is based on the blending
930 // of two Dicom tags values:
931 // * "Photometric Interpretation" for which we have the cases:
932 // - [Photo A] MONOCHROME[1|2] pictures,
933 // - [Photo B] RGB or YBR_FULL_422 (which acts as RGB),
934 // - [Photo C] YBR_* (with the above exception of YBR_FULL_422)
935 // - [Photo D] "PALETTE COLOR" which indicates the presence of LUT[s].
936 // * "Planar Configuration" for which we have the cases:
937 // - [Planar 0] 0 then Pixels are already RGB
938 // - [Planar 1] 1 then we have 3 planes : R, G, B,
939 // - [Planar 2] 2 then we have 1 gray Plane and 3 LUTs
941 // Now in theory, one could expect some coherence when blending the above
942 // cases. For example we should not encounter files belonging at the
943 // time to case [Planar 0] and case [Photo D].
944 // Alas, this was only theory ! Because in practice some odd (read ill
945 // formated Dicom) files (e.g. gdcmData/US-PAL-8-10x-echo.dcm) we encounter:
946 // - "Planar Configuration" = 0,
947 // - "Photometric Interpretation" = "PALETTE COLOR".
948 // Hence gdcm will use the folowing "heuristic" in order to be tolerant
949 // towards Dicom-non-conformance files:
950 // << whatever the "Planar Configuration" value might be, a
951 // "Photometric Interpretation" set to "PALETTE COLOR" forces
952 // a LUT intervention >>
954 // Now we are left with the following handling of the cases:
955 // - [Planar 0] OR [Photo A] no color decoding (since respectively
956 // Pixels are already RGB and monochrome pictures have no color :),
957 // - [Planar 1] AND [Photo B] handled with ConvertRGBPlanesToRGBPixels()
958 // - [Planar 1] AND [Photo C] handled with ConvertYcBcRPlanesToRGBPixels()
959 // - [Planar 2] OR [Photo D] requires LUT intervention.
963 // [Planar 2] OR [Photo D]: LUT intervention done outside
967 if ( PlanarConfiguration == 1 )
971 // [Planar 1] AND [Photo C] (remember YBR_FULL_422 acts as RGB)
972 ConvertYcBcRPlanesToRGBPixels();
976 // [Planar 1] AND [Photo C]
977 ConvertRGBPlanesToRGBPixels();
982 // When planarConf is 0, and RLELossless (forbidden by Dicom norm)
983 // pixels need to be RGB-fied anyway
986 ConvertRGBPlanesToRGBPixels();
988 // In *normal *case, when planarConf is 0, pixels are already in RGB
991 /// Computes the Pixels Size
992 void PixelReadConvert::ComputeRawAndRGBSizes()
994 int bitsAllocated = BitsAllocated;
995 // Number of "Bits Allocated" is fixed to 16 when it's 12, since
996 // in this case we will expand the image to 16 bits (see
997 // \ref ReadAndDecompress12BitsTo16Bits() )
998 if ( BitsAllocated == 12 )
1003 RawSize = XSize * YSize * ZSize
1004 * ( bitsAllocated / 8 )
1008 RGBSize = 3 * RawSize;
1016 /// Allocates room for RGB Pixels
1017 void PixelReadConvert::AllocateRGB()
1021 RGB = new uint8_t[RGBSize];
1024 /// Allocates room for RAW Pixels
1025 void PixelReadConvert::AllocateRaw()
1029 Raw = new uint8_t[RawSize];
1032 //-----------------------------------------------------------------------------
1035 * \brief Print self.
1036 * @param indent Indentation string to be prepended during printing.
1037 * @param os Stream to print to.
1039 void PixelReadConvert::Print( std::ostream &os, std::string const &indent )
1042 << "--- Pixel information -------------------------"
1045 << "Pixel Data: offset " << PixelOffset
1046 << " x(" << std::hex << PixelOffset << std::dec
1047 << ") length " << PixelDataLength
1048 << " x(" << std::hex << PixelDataLength << std::dec
1049 << ")" << std::endl;
1051 if ( IsRLELossless )
1055 RLEInfo->Print( os, indent );
1059 gdcmWarningMacro("Set as RLE file but NO RLEinfo present.");
1063 if ( IsJPEG2000 || IsJPEGLossless || IsJPEGLossy || IsJPEGLS )
1067 JPEGInfo->Print( os, indent );
1071 gdcmWarningMacro("Set as JPEG file but NO JPEGinfo present.");
1076 //-----------------------------------------------------------------------------
1077 } // end namespace gdcm
1079 // NOTES on File internal calls
1081 // ---> GetImageData
1082 // ---> GetImageDataIntoVector
1083 // |---> GetImageDataIntoVectorRaw
1084 // | lut intervention
1086 // ---> GetImageDataRaw
1087 // ---> GetImageDataIntoVectorRaw