src/gdcmPixelReadConvert.cxx

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmPixelReadConvert.cxx,v $
   5   Language:  C++
   6   Date:      $Date: 2005/10/21 17:11:33 $
   7   Version:   $Revision: 1.84 $
   8
   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.
  12
  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.
  16
  17 =========================================================================*/
  18
  19 #include "gdcmPixelReadConvert.h"
  20 #include "gdcmDebug.h"
  21 #include "gdcmFile.h"
  22 #include "gdcmGlobal.h"
  23 #include "gdcmTS.h"
  24 #include "gdcmDocEntry.h"
  25 #include "gdcmRLEFramesInfo.h"
  26 #include "gdcmJPEGFragmentsInfo.h"
  27
  28 #include <fstream>
  29 #include <stdio.h> //for sscanf
  30
  31 namespace gdcm
  32 {
  33
  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))
  39
  40 //-----------------------------------------------------------------------------
  41 // Constructor / Destructor
  42 /// Constructor
  43 PixelReadConvert::PixelReadConvert()
  44 {
  45    RGB          = 0;
  46    RGBSize      = 0;
  47    Raw          = 0;
  48    RawSize      = 0;
  49    LutRGBA      = 0;
  50    LutRedData   = 0;
  51    LutGreenData = 0;
  52    LutBlueData  = 0;
  53    RLEInfo      = 0;
  54    JPEGInfo     = 0;
  55    UserFunction = 0;
  56    FileInternal = 0;
  57 }
  58
  59 /// Canonical Destructor
  60 PixelReadConvert::~PixelReadConvert()
  61 {
  62    Squeeze();
  63 }
  64
  65 //-----------------------------------------------------------------------------
  66 // Public
  67 /**
  68  * \brief Predicate to know whether the image[s] (once Raw) is RGB.
  69  * \note See comments of \ref ConvertHandleColor
  70  */
  71 bool PixelReadConvert::IsRawRGB()
  72 {
  73    if (   IsMonochrome
  74        || PlanarConfiguration == 2
  75        || IsPaletteColor )
  76    {
  77       return false;
  78    }
  79    return true;
  80 }
  81 /**
  82  * \brief Gets various usefull informations from the file header
  83  * @param file gdcm::File pointer
  84  */
  85 void PixelReadConvert::GrabInformationsFromFile( File *file )
  86 {
  87    // Number of Bits Allocated for storing a Pixel is defaulted to 16
  88    // when absent from the file.
  89    BitsAllocated = file->GetBitsAllocated();
  90    if ( BitsAllocated == 0 )
  91    {
  92       BitsAllocated = 16;
  93    }
  94
  95    // Number of "Bits Stored", defaulted to number of "Bits Allocated"
  96    // when absent from the file.
  97    BitsStored = file->GetBitsStored();
  98    if ( BitsStored == 0 )
  99    {
 100       BitsStored = BitsAllocated;
 101    }
 102
 103    // High Bit Position, defaulted to "Bits Allocated" - 1
 104    HighBitPosition = file->GetHighBitPosition();
 105    if ( HighBitPosition == 0 )
 106    {
 107       HighBitPosition = BitsAllocated - 1;
 108    }
 109
 110    XSize           = file->GetXSize();
 111    YSize           = file->GetYSize();
 112    ZSize           = file->GetZSize();
 113    SamplesPerPixel = file->GetSamplesPerPixel();
 114    //PixelSize       = file->GetPixelSize();  Useless
 115    PixelSign       = file->IsSignedPixelData();
 116    SwapCode        = file->GetSwapCode();
 117    std::string ts  = file->GetTransferSyntax();
 118    IsRaw =
 119         ( ! file->IsDicomV3() )
 120      || Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ImplicitVRLittleEndian
 121      || Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ImplicitVRBigEndianPrivateGE
 122      || Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ExplicitVRLittleEndian
 123      || Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ExplicitVRBigEndian
 124      || Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::DeflatedExplicitVRLittleEndian;
 125
 126    IsPrivateGETransferSyntax =
 127                 ( Global::GetTS()->GetSpecialTransferSyntax(ts) == TS::ImplicitVRBigEndianPrivateGE );
 128
 129    IsMPEG          = Global::GetTS()->IsMPEG(ts);
 130    IsJPEG2000      = Global::GetTS()->IsJPEG2000(ts);
 131    IsJPEGLS        = Global::GetTS()->IsJPEGLS(ts);
 132    IsJPEGLossy     = Global::GetTS()->IsJPEGLossy(ts);
 133    IsJPEGLossless  = Global::GetTS()->IsJPEGLossless(ts);
 134    IsRLELossless   = Global::GetTS()->IsRLELossless(ts);
 135
 136    PixelOffset     = file->GetPixelOffset();
 137    PixelDataLength = file->GetPixelAreaLength();
 138    RLEInfo         = file->GetRLEInfo();
 139    JPEGInfo        = file->GetJPEGInfo();
 140
 141    IsMonochrome    = file->IsMonochrome();
 142    IsMonochrome1   = file->IsMonochrome1();
 143    IsPaletteColor  = file->IsPaletteColor();
 144    IsYBRFull       = file->IsYBRFull();
 145
 146    PlanarConfiguration = file->GetPlanarConfiguration();
 147
 148    /////////////////////////////////////////////////////////////////
 149    // LUT section:
 150    HasLUT = file->HasLUT();
 151    if ( HasLUT )
 152    {
 153       // Just in case some access to a File element requires disk access.
 154       LutRedDescriptor   = file->GetEntryString( 0x0028, 0x1101 );
 155       LutGreenDescriptor = file->GetEntryString( 0x0028, 0x1102 );
 156       LutBlueDescriptor  = file->GetEntryString( 0x0028, 0x1103 );
 157
 158       // The following comment is probabely meaningless, since LUT are *always*
 159       // loaded at parsing time, whatever their length is.
 160
 161       // Depending on the value of Document::MAX_SIZE_LOAD_ELEMENT_VALUE
 162       // [ refer to invocation of Document::SetMaxSizeLoadEntry() in
 163       // Document::Document() ], the loading of the value (content) of a
 164       // [Bin|Val]Entry occurence migth have been hindered (read simply NOT
 165       // loaded). Hence, we first try to obtain the LUTs data from the file
 166       // and when this fails we read the LUTs data directly from disk.
 167       // \TODO Reading a [Bin|Val]Entry directly from disk is a kludge.
 168       //       We should NOT bypass the [Bin|Val]Entry class. Instead
 169       //       an access to an UNLOADED content of a [Bin|Val]Entry occurence
 170       //       (e.g. DataEntry::GetBinArea()) should force disk access from
 171       //       within the [Bin|Val]Entry class itself. The only problem
 172       //       is that the [Bin|Val]Entry is unaware of the FILE* is was
 173       //       parsed from. Fix that. FIXME.
 174
 175       // //// Red round
 176       file->LoadEntryBinArea(0x0028, 0x1201);
 177       LutRedData = (uint8_t*)file->GetEntryBinArea( 0x0028, 0x1201 );
 178       if ( ! LutRedData )
 179       {
 180          gdcmWarningMacro("Unable to read Red Palette Color Lookup Table data");
 181       }
 182
 183       // //// Green round:
 184       file->LoadEntryBinArea(0x0028, 0x1202);
 185       LutGreenData = (uint8_t*)file->GetEntryBinArea(0x0028, 0x1202 );
 186       if ( ! LutGreenData)
 187       {
 188          gdcmWarningMacro("Unable to read Green Palette Color Lookup Table data");
 189       }
 190
 191       // //// Blue round:
 192       file->LoadEntryBinArea(0x0028, 0x1203);
 193       LutBlueData = (uint8_t*)file->GetEntryBinArea( 0x0028, 0x1203 );
 194       if ( ! LutBlueData )
 195       {
 196          gdcmWarningMacro("Unable to read Blue Palette Color Lookup Table data");
 197       }
 198    }
 199    FileInternal = file;
 200
 201    ComputeRawAndRGBSizes();
 202 }
 203
 204 /// \brief Reads from disk and decompresses Pixels
 205 bool PixelReadConvert::ReadAndDecompressPixelData( std::ifstream *fp )
 206 {
 207    // ComputeRawAndRGBSizes is already made by
 208    // ::GrabInformationsFromfile. So, the structure sizes are
 209    // correct
 210    Squeeze();
 211
 212    //////////////////////////////////////////////////
 213    //// First stage: get our hands on the Pixel Data.
 214    if ( !fp )
 215    {
 216       gdcmWarningMacro( "Unavailable file pointer." );
 217       return false;
 218    }
 219
 220    fp->seekg( PixelOffset, std::ios::beg );
 221    if ( fp->fail() || fp->eof() )
 222    {
 223       gdcmWarningMacro( "Unable to find PixelOffset in file." );
 224       return false;
 225    }
 226
 227    AllocateRaw();
 228
 229    //////////////////////////////////////////////////
 230    //// Second stage: read from disk and decompress.
 231    if ( BitsAllocated == 12 )
 232    {
 233       ReadAndDecompress12BitsTo16Bits( fp);
 234    }
 235    else if ( IsRaw )
 236    {
 237       // This problem can be found when some obvious informations are found
 238       // after the field containing the image data. In this case, these
 239       // bad data are added to the size of the image (in the PixelDataLength
 240       // variable). But RawSize is the right size of the image !
 241       if ( PixelDataLength != RawSize )
 242       {
 243          gdcmWarningMacro( "Mismatch between PixelReadConvert : "
 244                           << PixelDataLength << " and RawSize : " << RawSize );
 245       }
 246       if ( PixelDataLength > RawSize )
 247       {
 248          fp->read( (char*)Raw, RawSize);
 249       }
 250       else
 251       {
 252          fp->read( (char*)Raw, PixelDataLength);
 253       }
 254
 255       if ( fp->fail() || fp->eof())
 256       {
 257          gdcmWarningMacro( "Reading of Raw pixel data failed." );
 258          return false;
 259       }
 260    }
 261    else if ( IsRLELossless )
 262    {
 263       if ( ! RLEInfo->DecompressRLEFile
 264                                ( fp, Raw, XSize, YSize, ZSize, BitsAllocated ) )
 265       {
 266          gdcmWarningMacro( "RLE decompressor failed." );
 267          return false;
 268       }
 269    }
 270    else if ( IsMPEG )
 271    {
 272       //gdcmWarningMacro( "Sorry, MPEG not yet taken into account" );
 273       //return false;
 274       // fp has already been seek to start of mpeg
 275       //ReadMPEGFile(fp, Raw, PixelDataLength);
 276       return true;
 277    }
 278    else
 279    {
 280       // Default case concerns JPEG family
 281       if ( ! ReadAndDecompressJPEGFile( fp ) )
 282       {
 283          gdcmWarningMacro( "JPEG decompressor failed." );
 284          return false;
 285       }
 286    }
 287
 288    ////////////////////////////////////////////
 289    //// Third stage: twigle the bytes and bits.
 290    ConvertReorderEndianity();
 291    ConvertReArrangeBits();
 292    ConvertFixGreyLevels();
 293    if (UserFunction) // user is allowed to Mirror, TopDown, Rotate,...the image
 294       UserFunction( Raw, FileInternal);
 295    ConvertHandleColor();
 296
 297    return true;
 298 }
 299
 300 /// Deletes Pixels Area
 301 void PixelReadConvert::Squeeze()
 302 {
 303    if ( RGB )
 304       delete [] RGB;
 305    RGB = 0;
 306
 307    if ( Raw )
 308       delete [] Raw;
 309    Raw = 0;
 310
 311    if ( LutRGBA )
 312       delete [] LutRGBA;
 313    LutRGBA = 0;
 314 }
 315
 316 /**
 317  * \brief Build the RGB image from the Raw image and the LUTs.
 318  */
 319 bool PixelReadConvert::BuildRGBImage()
 320 {
 321    if ( RGB )
 322    {
 323       // The job is already done.
 324       return true;
 325    }
 326
 327    if ( ! Raw )
 328    {
 329       // The job can't be done
 330       return false;
 331    }
 332
 333    BuildLUTRGBA();
 334    if ( ! LutRGBA )
 335    {
 336       // The job can't be done
 337       return false;
 338    }
 339
 340    gdcmWarningMacro( "--> BuildRGBImage" );
 341
 342    // Build RGB Pixels
 343    AllocateRGB();
 344
 345    int j;
 346    if ( BitsAllocated <= 8 )
 347    {
 348       uint8_t *localRGB = RGB;
 349       for (size_t i = 0; i < RawSize; ++i )
 350       {
 351          j  = Raw[i] * 4;
 352          *localRGB++ = LutRGBA[j];
 353          *localRGB++ = LutRGBA[j+1];
 354          *localRGB++ = LutRGBA[j+2];
 355       }
 356     }
 357
 358     else  // deal with 16 bits pixels and 16 bits Palette color
 359     {
 360       uint16_t *localRGB = (uint16_t *)RGB;
 361       for (size_t i = 0; i < RawSize/2; ++i )
 362       {
 363          j  = ((uint16_t *)Raw)[i] * 4;
 364          *localRGB++ = ((uint16_t *)LutRGBA)[j];
 365          *localRGB++ = ((uint16_t *)LutRGBA)[j+1];
 366          *localRGB++ = ((uint16_t *)LutRGBA)[j+2];
 367       }
 368     }
 369
 370    return true;
 371 }
 372
 373 //-----------------------------------------------------------------------------
 374 // Protected
 375
 376 //-----------------------------------------------------------------------------
 377 // Private
 378 /**
 379  * \brief Read from file a 12 bits per pixel image and decompress it
 380  *        into a 16 bits per pixel image.
 381  */
 382 void PixelReadConvert::ReadAndDecompress12BitsTo16Bits( std::ifstream *fp )
 383                throw ( FormatError )
 384 {
 385    int nbPixels = XSize * YSize;
 386    uint16_t *localDecompres = (uint16_t*)Raw;
 387
 388    for( int p = 0; p < nbPixels; p += 2 )
 389    {
 390       uint8_t b0, b1, b2;
 391
 392       fp->read( (char*)&b0, 1);
 393       if ( fp->fail() || fp->eof() )
 394       {
 395          throw FormatError( "PixelReadConvert::ReadAndDecompress12BitsTo16Bits()",
 396                                 "Unfound first block" );
 397       }
 398
 399       fp->read( (char*)&b1, 1 );
 400       if ( fp->fail() || fp->eof())
 401       {
 402          throw FormatError( "PixelReadConvert::ReadAndDecompress12BitsTo16Bits()",
 403                                 "Unfound second block" );
 404       }
 405
 406       fp->read( (char*)&b2, 1 );
 407       if ( fp->fail() || fp->eof())
 408       {
 409          throw FormatError( "PixelReadConvert::ReadAndDecompress12BitsTo16Bits()",
 410                                 "Unfound second block" );
 411       }
 412
 413       // Two steps are necessary to please VC++
 414       //
 415       // 2 pixels 12bit =     [0xABCDEF]
 416       // 2 pixels 16bit = [0x0ABD] + [0x0FCE]
 417       //                        A                     B                 D
 418       *localDecompres++ =  ((b0 >> 4) << 8) + ((b0 & 0x0f) << 4) + (b1 & 0x0f);
 419       //                        F                     C                 E
 420       *localDecompres++ =  ((b2 & 0x0f) << 8) + ((b1 >> 4) << 4) + (b2 >> 4);
 421
 422       /// \todo JPR Troubles expected on Big-Endian processors ?
 423    }
 424 }
 425
 426 /**
 427  * \brief     Reads from disk the Pixel Data of JPEG Dicom encapsulated
 428  *            file and decompress it.
 429  * @param     fp File Pointer
 430  * @return    Boolean
 431  */
 432 bool PixelReadConvert::ReadAndDecompressJPEGFile( std::ifstream *fp )
 433 {
 434    if ( IsJPEG2000 )
 435    {
 436      // make sure this is the right JPEG compression
 437      assert( !IsJPEGLossless || !IsJPEGLossy || !IsJPEGLS );
 438      // FIXME this is really ugly but it seems I have to load the complete
 439      // jpeg2000 stream to use jasper:
 440      // I don't think we'll ever be able to deal with multiple fragments properly
 441
 442       unsigned long inputlength = 0;
 443       JPEGFragment *jpegfrag = JPEGInfo->GetFirstFragment();
 444       while( jpegfrag )
 445       {
 446          inputlength += jpegfrag->GetLength();
 447          jpegfrag = JPEGInfo->GetNextFragment();
 448       }
 449       gdcmAssertMacro( inputlength != 0);
 450       uint8_t *inputdata = new uint8_t[inputlength];
 451       char *pinputdata = (char*)inputdata;
 452       jpegfrag = JPEGInfo->GetFirstFragment();
 453       while( jpegfrag )
 454       {
 455          fp->seekg( jpegfrag->GetOffset(), std::ios::beg);
 456          fp->read(pinputdata, jpegfrag->GetLength());
 457          pinputdata += jpegfrag->GetLength();
 458          jpegfrag = JPEGInfo->GetNextFragment();
 459       }
 460       // Warning the inputdata buffer is delete in the function
 461       if ( ! gdcm_read_JPEG2000_file( Raw,
 462           (char*)inputdata, inputlength ) )
 463       {
 464          return true;
 465       }
 466       // wow what happen, must be an error
 467       return false;
 468    }
 469    else if ( IsJPEGLS )
 470    {
 471      // make sure this is the right JPEG compression
 472      assert( !IsJPEGLossless || !IsJPEGLossy || !IsJPEG2000 );
 473    // WARNING : JPEG-LS is NOT the 'classical' Jpeg Lossless :
 474    // [JPEG-LS is the basis for new lossless/near-lossless compression
 475    // standard for continuous-tone images intended for JPEG2000. The standard
 476    // is based on the LOCO-I algorithm (LOw COmplexity LOssless COmpression
 477    // for Images) developed at Hewlett-Packard Laboratories]
 478    //
 479    // see http://datacompression.info/JPEGLS.shtml
 480    //
 481 #if 0
 482    std::cerr << "count:" << JPEGInfo->GetFragmentCount() << std::endl;
 483       unsigned long inputlength = 0;
 484       JPEGFragment *jpegfrag = JPEGInfo->GetFirstFragment();
 485       while( jpegfrag )
 486       {
 487          inputlength += jpegfrag->GetLength();
 488          jpegfrag = JPEGInfo->GetNextFragment();
 489       }
 490       gdcmAssertMacro( inputlength != 0);
 491       uint8_t *inputdata = new uint8_t[inputlength];
 492       char *pinputdata = (char*)inputdata;
 493       jpegfrag = JPEGInfo->GetFirstFragment();
 494       while( jpegfrag )
 495       {
 496          fp->seekg( jpegfrag->GetOffset(), std::ios::beg);
 497          fp->read(pinputdata, jpegfrag->GetLength());
 498          pinputdata += jpegfrag->GetLength();
 499          jpegfrag = JPEGInfo->GetNextFragment();
 500       }
 501
 502   //fp->read((char*)Raw, PixelDataLength);
 503
 504   std::ofstream out("/tmp/jpegls.jpg");
 505   out.write((char*)inputdata, inputlength);
 506   out.close();
 507   delete[] inputdata;
 508 #endif
 509
 510       gdcmWarningMacro( "Sorry, JPEG-LS not yet taken into account" );
 511       fp->seekg( JPEGInfo->GetFirstFragment()->GetOffset(), std::ios::beg);
 512 //    if ( ! gdcm_read_JPEGLS_file( fp,Raw ) )
 513          return false;
 514    }
 515    else
 516    {
 517      // make sure this is the right JPEG compression
 518      assert( !IsJPEGLS || !IsJPEG2000 );
 519      // Precompute the offset localRaw will be shifted with
 520      int length = XSize * YSize * SamplesPerPixel;
 521      int numberBytes = BitsAllocated / 8;
 522
 523      JPEGInfo->DecompressFromFile(fp, Raw, BitsStored, numberBytes, length );
 524      return true;
 525    }
 526 }
 527
 528 /**
 529  * \brief Build Red/Green/Blue/Alpha LUT from File
 530  *         when (0028,0004),Photometric Interpretation = [PALETTE COLOR ]
 531  *          and (0028,1101),(0028,1102),(0028,1102)
 532  *            - xxx Palette Color Lookup Table Descriptor - are found
 533  *          and (0028,1201),(0028,1202),(0028,1202)
 534  *            - xxx Palette Color Lookup Table Data - are found
 535  * \warning does NOT deal with :
 536  *   0028 1100 Gray Lookup Table Descriptor (Retired)
 537  *   0028 1221 Segmented Red Palette Color Lookup Table Data
 538  *   0028 1222 Segmented Green Palette Color Lookup Table Data
 539  *   0028 1223 Segmented Blue Palette Color Lookup Table Data
 540  *   no known Dicom reader deals with them :-(
 541  * @return a RGBA Lookup Table
 542  */
 543 void PixelReadConvert::BuildLUTRGBA()
 544 {
 545
 546    // Note to code reviewers :
 547    // The problem is *much more* complicated, since a lot of manufacturers
 548    // Don't follow the norm :
 549    // have a look at David Clunie's remark at the end of this .cxx file.
 550    if ( LutRGBA )
 551
 552    {
 553       return;
 554    }
 555    // Not so easy : see
 556    // http://www.barre.nom.fr/medical/dicom2/limitations.html#Color%20Lookup%20Tables
 557
 558    if ( ! IsPaletteColor )
 559    {
 560       return;
 561    }
 562
 563    if (   LutRedDescriptor   == GDCM_UNFOUND
 564        || LutGreenDescriptor == GDCM_UNFOUND
 565        || LutBlueDescriptor  == GDCM_UNFOUND )
 566    {
 567       gdcmWarningMacro( "(At least) a LUT Descriptor is missing" );
 568       return;
 569    }
 570
 571    ////////////////////////////////////////////
 572    // Extract the info from the LUT descriptors
 573    int lengthR;   // Red LUT length in Bytes
 574    int debR;      // Subscript of the first Lut Value
 575    int nbitsR;    // Lut item size (in Bits)
 576    int nbRead;    // nb of items in LUT descriptor (must be = 3)
 577
 578    nbRead = sscanf( LutRedDescriptor.c_str(),
 579                         "%d\\%d\\%d",
 580                         &lengthR, &debR, &nbitsR );
 581    if ( nbRead != 3 )
 582    {
 583       gdcmWarningMacro( "Wrong Red LUT descriptor" );
 584    }
 585    int lengthG;  // Green LUT length in Bytes
 586    int debG;     // Subscript of the first Lut Value
 587    int nbitsG;   // Lut item size (in Bits)
 588
 589    nbRead = sscanf( LutGreenDescriptor.c_str(),
 590                     "%d\\%d\\%d",
 591                     &lengthG, &debG, &nbitsG );
 592    if ( nbRead != 3 )
 593    {
 594       gdcmWarningMacro( "Wrong Green LUT descriptor" );
 595    }
 596
 597    int lengthB;  // Blue LUT length in Bytes
 598    int debB;     // Subscript of the first Lut Value
 599    int nbitsB;   // Lut item size (in Bits)
 600    nbRead = sscanf( LutRedDescriptor.c_str(),
 601                     "%d\\%d\\%d",
 602                     &lengthB, &debB, &nbitsB );
 603    if ( nbRead != 3 )
 604    {
 605       gdcmWarningMacro( "Wrong Blue LUT descriptor" );
 606    }
 607
 608    gdcmWarningMacro(" lengthR " << lengthR << " debR "
 609                  << debR << " nbitsR " << nbitsR);
 610    gdcmWarningMacro(" lengthG " << lengthG << " debG "
 611                  << debG << " nbitsG " << nbitsG);
 612    gdcmWarningMacro(" lengthB " << lengthB << " debB "
 613                  << debB << " nbitsB " << nbitsB);
 614
 615    if ( !lengthR ) // if = 2^16, this shall be 0 see : CP-143
 616       lengthR=65536;
 617    if ( !lengthG ) // if = 2^16, this shall be 0
 618       lengthG=65536;
 619    if ( !lengthB ) // if = 2^16, this shall be 0
 620       lengthB=65536;
 621
 622    ////////////////////////////////////////////////////////
 623
 624    if ( ( ! LutRedData ) || ( ! LutGreenData ) || ( ! LutBlueData ) )
 625    {
 626       gdcmWarningMacro( "(At least) a LUT is missing" );
 627       return;
 628    }
 629
 630    // -------------------------------------------------------------
 631
 632    if ( BitsAllocated <= 8 )
 633    {
 634       // forge the 4 * 8 Bits Red/Green/Blue/Alpha LUT
 635       LutRGBA = new uint8_t[ 1024 ]; // 256 * 4 (R, G, B, Alpha)
 636       if ( !LutRGBA )
 637          return;
 638       LutItemNumber = 256;
 639       LutItemSize   = 8;
 640       memset( LutRGBA, 0, 1024 );
 641
 642       int mult;
 643       if ( ( nbitsR == 16 ) && ( BitsAllocated == 8 ) )
 644       {
 645          // when LUT item size is different than pixel size
 646          mult = 2; // high byte must be = low byte
 647       }
 648       else
 649       {
 650          // See PS 3.3-2003 C.11.1.1.2 p 619
 651          mult = 1;
 652       }
 653
 654       // if we get a black image, let's just remove the '+1'
 655       // from 'i*mult+1' and check again
 656       // if it works, we shall have to check the 3 Palettes
 657       // to see which byte is ==0 (first one, or second one)
 658       // and fix the code
 659       // We give up the checking to avoid some (useless ?) overhead
 660       // (optimistic asumption)
 661       int i;
 662       uint8_t *a;
 663
 664       //take "Subscript of the first Lut Value" (debR,debG,debB) into account!
 665
 666       //FIXME :  +1 : to get 'low value' byte
 667       //         Trouble expected on Big Endian Processors ?
 668       //         16 BIts Per Pixel Palette Color to be swapped?
 669
 670       a = LutRGBA + 0 + debR;
 671       for( i=0; i < lengthR; ++i )
 672       {
 673          *a = LutRedData[i*mult+1];
 674          a += 4;
 675       }
 676
 677       a = LutRGBA + 1 + debG;
 678       for( i=0; i < lengthG; ++i)
 679       {
 680          *a = LutGreenData[i*mult+1];
 681          a += 4;
 682       }
 683
 684       a = LutRGBA + 2 + debB;
 685       for(i=0; i < lengthB; ++i)
 686       {
 687          *a = LutBlueData[i*mult+1];
 688          a += 4;
 689       }
 690
 691       a = LutRGBA + 3 ;
 692       for(i=0; i < 256; ++i)
 693       {
 694          *a = 1; // Alpha component
 695          a += 4;
 696       }
 697    }
 698    else
 699    {
 700       // Probabely the same stuff is to be done for 16 Bits Pixels
 701       // with 65536 entries LUT ?!?
 702       // Still looking for accurate info on the web :-(
 703
 704       gdcmWarningMacro( "Sorry Palette Color Lookup Tables not yet dealt with"
 705                          << " for 16 Bits Per Pixel images" );
 706
 707       // forge the 4 * 16 Bits Red/Green/Blue/Alpha LUT
 708
 709       LutRGBA = (uint8_t *)new uint16_t[ 65536*4 ]; // 2^16 * 4 (R, G, B, Alpha)
 710       if ( !LutRGBA )
 711          return;
 712       memset( LutRGBA, 0, 65536*4*2 );  // 16 bits = 2 bytes ;-)
 713
 714       LutItemNumber = 65536;
 715       LutItemSize   = 16;
 716
 717       int i;
 718       uint16_t *a16;
 719
 720       //take "Subscript of the first Lut Value" (debR,debG,debB) into account!
 721
 722       a16 = (uint16_t*)LutRGBA + 0 + debR;
 723       for( i=0; i < lengthR; ++i )
 724       {
 725          *a16 = ((uint16_t*)LutRedData)[i];
 726          a16 += 4;
 727       }
 728
 729       a16 = (uint16_t*)LutRGBA + 1 + debG;
 730       for( i=0; i < lengthG; ++i)
 731       {
 732          *a16 = ((uint16_t*)LutGreenData)[i];
 733          a16 += 4;
 734       }
 735
 736       a16 = (uint16_t*)LutRGBA + 2 + debB;
 737       for(i=0; i < lengthB; ++i)
 738       {
 739          *a16 = ((uint16_t*)LutBlueData)[i];
 740          a16 += 4;
 741       }
 742
 743       a16 = (uint16_t*)LutRGBA + 3 ;
 744       for(i=0; i < 65536; ++i)
 745       {
 746          *a16 = 1; // Alpha component
 747          a16 += 4;
 748       }
 749 /* Just to 'see' the LUT, at debug time
 750 // Don't remove this commented out code.
 751
 752       a16=(uint16_t*)LutRGBA;
 753       for (int j=0;j<65536;j++)
 754       {
 755          std::cout << *a16     << " " << *(a16+1) << " "
 756                    << *(a16+2) << " " << *(a16+3) << std::endl;
 757          a16+=4;
 758       }
 759 */
 760    }
 761 }
 762
 763 /**
 764  * \brief Swap the bytes, according to \ref SwapCode.
 765  */
 766 void PixelReadConvert::ConvertSwapZone()
 767 {
 768    unsigned int i;
 769    uint16_t localSwapCode = SwapCode;
 770
 771    // If this file is 'ImplicitVR BigEndian PrivateGE Transfer Syntax',
 772    // then the header is in little endian format and the pixel data is in
 773    // big endian format.  When reading the header, GDCM has already established
 774    // a byte swapping code suitable for this machine to read the
 775    // header. In TS::ImplicitVRBigEndianPrivateGE, this code will need
 776    // to be switched in order to read the pixel data.  This must be
 777    // done REGARDLESS of the processor endianess!
 778    //
 779    // Example:  Assume we are on a little endian machine.  When
 780    // GDCM reads the header, the header will match the machine
 781    // endianess and the swap code will be established as a no-op.
 782    // When GDCM reaches the pixel data, it will need to switch the
 783    // swap code to do big endian to little endian conversion.
 784    //
 785    // Now, assume we are on a big endian machine.  When GDCM reads the
 786    // header, the header will be recognized as a different endianess
 787    // than the machine endianess, and a swap code will be established
 788    // to convert from little endian to big endian.  When GDCM readers
 789    // the pixel data, the pixel data endianess will now match the
 790    // machine endianess.  But we currently have a swap code that
 791    // converts from little endian to big endian.  In this case, we
 792    // need to switch the swap code to a no-op.
 793    //
 794    // Therefore, in either case, if the file is in
 795    // 'ImplicitVR BigEndian PrivateGE Transfer Syntax', then GDCM needs to switch
 796    // the byte swapping code when entering the pixel data.
 797
 798    if ( IsPrivateGETransferSyntax )
 799    {
 800       // PrivateGETransferSyntax only exists for 'true' Dicom images
 801       // we assume there is no 'exotic' 32 bits endianess!
 802       switch (localSwapCode)
 803       {
 804          case 1234:
 805             localSwapCode = 4321;
 806             break;
 807          case 4321:
 808             localSwapCode = 1234;
 809             break;
 810       }
 811    }
 812
 813    if ( BitsAllocated == 16 )
 814    {
 815       uint16_t *im16 = (uint16_t*)Raw;
 816       switch( localSwapCode )
 817       {
 818          case 1234:
 819             break;
 820          case 3412:
 821          case 2143:
 822          case 4321:
 823             for( i = 0; i < RawSize / 2; i++ )
 824             {
 825                im16[i]= (im16[i] >> 8) | (im16[i] << 8 );
 826             }
 827             break;
 828          default:
 829             gdcmWarningMacro("SwapCode value (16 bits) not allowed.");
 830       }
 831    }
 832    else if ( BitsAllocated == 32 )
 833    {
 834       uint32_t s32;
 835       uint16_t high;
 836       uint16_t low;
 837       uint32_t *im32 = (uint32_t*)Raw;
 838       switch ( localSwapCode )
 839       {
 840          case 1234:
 841             break;
 842          case 4321:
 843             for( i = 0; i < RawSize / 4; i++ )
 844             {
 845                low     = im32[i] & 0x0000ffff;  // 4321
 846                high    = im32[i] >> 16;
 847                high    = ( high >> 8 ) | ( high << 8 );
 848                low     = ( low  >> 8 ) | ( low  << 8 );
 849                s32     = low;
 850                im32[i] = ( s32 << 16 ) | high;
 851             }
 852             break;
 853          case 2143:
 854             for( i = 0; i < RawSize / 4; i++ )
 855             {
 856                low     = im32[i] & 0x0000ffff;   // 2143
 857                high    = im32[i] >> 16;
 858                high    = ( high >> 8 ) | ( high << 8 );
 859                low     = ( low  >> 8 ) | ( low  << 8 );
 860                s32     = high;
 861                im32[i] = ( s32 << 16 ) | low;
 862             }
 863             break;
 864          case 3412:
 865             for( i = 0; i < RawSize / 4; i++ )
 866             {
 867                low     = im32[i] & 0x0000ffff; // 3412
 868                high    = im32[i] >> 16;
 869                s32     = low;
 870                im32[i] = ( s32 << 16 ) | high;
 871             }
 872             break;
 873          default:
 874             gdcmWarningMacro("SwapCode value (32 bits) not allowed." );
 875       }
 876    }
 877 }
 878
 879 /**
 880  * \brief Deal with endianness i.e. re-arange bytes inside the integer
 881  */
 882 void PixelReadConvert::ConvertReorderEndianity()
 883 {
 884    if ( BitsAllocated != 8 )
 885    {
 886       ConvertSwapZone();
 887    }
 888
 889    // Special kludge in order to deal with xmedcon broken images:
 890    if ( BitsAllocated == 16
 891      && BitsStored < BitsAllocated
 892      && !PixelSign )
 893    {
 894       int l = (int)( RawSize / ( BitsAllocated / 8 ) );
 895       uint16_t *deb = (uint16_t *)Raw;
 896       for(int i = 0; i<l; i++)
 897       {
 898          if ( *deb == 0xffff )
 899          {
 900            *deb = 0;
 901          }
 902          deb++;
 903       }
 904    }
 905 }
 906
 907 /**
 908  * \brief Deal with Grey levels i.e. re-arange them
 909  *        to have low values = dark, high values = bright
 910  */
 911 void PixelReadConvert::ConvertFixGreyLevels()
 912 {
 913    if (!IsMonochrome1)
 914       return;
 915
 916    uint32_t i; // to please M$VC6
 917    int16_t j;
 918
 919    if (!PixelSign)
 920    {
 921       if ( BitsAllocated == 8 )
 922       {
 923          uint8_t *deb = (uint8_t *)Raw;
 924          for (i=0; i<RawSize; i++)
 925          {
 926             *deb = 255 - *deb;
 927             deb++;
 928          }
 929          return;
 930       }
 931
 932       if ( BitsAllocated == 16 )
 933       {
 934          uint16_t mask =1;
 935          for (j=0; j<BitsStored-1; j++)
 936          {
 937             mask = (mask << 1) +1; // will be fff when BitsStored=12
 938          }
 939
 940          uint16_t *deb = (uint16_t *)Raw;
 941          for (i=0; i<RawSize/2; i++)
 942          {
 943             *deb = mask - *deb;
 944             deb++;
 945          }
 946          return;
 947        }
 948    }
 949    else
 950    {
 951       if ( BitsAllocated == 8 )
 952       {
 953          uint8_t smask8 = 255;
 954          uint8_t *deb = (uint8_t *)Raw;
 955          for (i=0; i<RawSize; i++)
 956          {
 957             *deb = smask8 - *deb;
 958             deb++;
 959          }
 960          return;
 961       }
 962       if ( BitsAllocated == 16 )
 963       {
 964          uint16_t smask16 = 65535;
 965          uint16_t *deb = (uint16_t *)Raw;
 966          for (i=0; i<RawSize/2; i++)
 967          {
 968             *deb = smask16 - *deb;
 969             deb++;
 970          }
 971          return;
 972       }
 973    }
 974 }
 975
 976 /**
 977  * \brief  Re-arrange the bits within the bytes.
 978  * @return Boolean always true
 979  */
 980 bool PixelReadConvert::ConvertReArrangeBits() throw ( FormatError )
 981 {
 982
 983    if ( BitsStored != BitsAllocated )
 984    {
 985       int l = (int)( RawSize / ( BitsAllocated / 8 ) );
 986       if ( BitsAllocated == 16 )
 987       {
 988          // pmask : to mask the 'unused bits' (may contain overlays)
 989          uint16_t pmask = 0xffff;
 990          pmask = pmask >> ( BitsAllocated - BitsStored );
 991
 992          uint16_t *deb = (uint16_t*)Raw;
 993
 994          if ( !PixelSign )  // Pixels are unsigned
 995          {
 996             for(int i = 0; i<l; i++)
 997             {
 998                *deb = (*deb >> (BitsStored - HighBitPosition - 1)) & pmask;
 999                deb++;
1000             }
1001          }
1002          else // Pixels are signed
1003          {
1004             // smask : to check the 'sign' when BitsStored != BitsAllocated
1005             uint16_t smask = 0x0001;
1006             smask = smask << ( 16 - (BitsAllocated - BitsStored + 1) );
1007             // nmask : to propagate sign bit on negative values
1008             int16_t nmask = (int16_t)0x8000;
1009             nmask = nmask >> ( BitsAllocated - BitsStored - 1 );
1010
1011             for(int i = 0; i<l; i++)
1012             {
1013                *deb = *deb >> (BitsStored - HighBitPosition - 1);
1014                if ( *deb & smask )
1015                {
1016                   *deb = *deb | nmask;
1017                }
1018                else
1019                {
1020                   *deb = *deb & pmask;
1021                }
1022                deb++;
1023             }
1024          }
1025       }
1026       else if ( BitsAllocated == 32 )
1027       {
1028          // pmask : to mask the 'unused bits' (may contain overlays)
1029          uint32_t pmask = 0xffffffff;
1030          pmask = pmask >> ( BitsAllocated - BitsStored );
1031
1032          uint32_t *deb = (uint32_t*)Raw;
1033
1034          if ( !PixelSign )
1035          {
1036             for(int i = 0; i<l; i++)
1037             {
1038                *deb = (*deb >> (BitsStored - HighBitPosition - 1)) & pmask;
1039                deb++;
1040             }
1041          }
1042          else
1043          {
1044             // smask : to check the 'sign' when BitsStored != BitsAllocated
1045             uint32_t smask = 0x00000001;
1046             smask = smask >> ( 32 - (BitsAllocated - BitsStored +1 ));
1047             // nmask : to propagate sign bit on negative values
1048             int32_t nmask = 0x80000000;
1049             nmask = nmask >> ( BitsAllocated - BitsStored -1 );
1050
1051             for(int i = 0; i<l; i++)
1052             {
1053                *deb = *deb >> (BitsStored - HighBitPosition - 1);
1054                if ( *deb & smask )
1055                   *deb = *deb | nmask;
1056                else
1057                   *deb = *deb & pmask;
1058                deb++;
1059             }
1060          }
1061       }
1062       else
1063       {
1064          gdcmWarningMacro("Weird image (BitsAllocated !=8, 12, 16, 32)");
1065          throw FormatError( "Weird image !?" );
1066       }
1067    }
1068    return true;
1069 }
1070
1071 /**
1072  * \brief   Convert (Red plane, Green plane, Blue plane) to RGB pixels
1073  * \warning Works on all the frames at a time
1074  */
1075 void PixelReadConvert::ConvertRGBPlanesToRGBPixels()
1076 {
1077    gdcmWarningMacro("--> ConvertRGBPlanesToRGBPixels");
1078
1079    uint8_t *localRaw = Raw;
1080    uint8_t *copyRaw = new uint8_t[ RawSize ];
1081    memmove( copyRaw, localRaw, RawSize );
1082
1083    int l = XSize * YSize * ZSize;
1084
1085    uint8_t *a = copyRaw;
1086    uint8_t *b = copyRaw + l;
1087    uint8_t *c = copyRaw + l + l;
1088
1089    for (int j = 0; j < l; j++)
1090    {
1091       *(localRaw++) = *(a++);
1092       *(localRaw++) = *(b++);
1093       *(localRaw++) = *(c++);
1094    }
1095    delete[] copyRaw;
1096 }
1097
1098 /**
1099  * \brief   Convert (cY plane, cB plane, cR plane) to RGB pixels
1100  * \warning Works on all the frames at a time
1101  */
1102 void PixelReadConvert::ConvertYcBcRPlanesToRGBPixels()
1103 {
1104   // Remarks for YBR newbees :
1105   // YBR_FULL works very much like RGB, i.e. three samples per pixel,
1106   // just the color space is YCbCr instead of RGB. This is particularly useful
1107   // for doppler ultrasound where most of the image is grayscale
1108   // (i.e. only populates the Y components) and Cb and Cr are mostly zero,
1109   // except for the few patches of color on the image.
1110   // On such images, RLE achieves a compression ratio that is much better
1111   // than the compression ratio on an equivalent RGB image.
1112
1113    gdcmWarningMacro("--> ConvertYcBcRPlanesToRGBPixels");
1114
1115    uint8_t *localRaw = Raw;
1116    uint8_t *copyRaw = new uint8_t[ RawSize ];
1117    memmove( copyRaw, localRaw, RawSize );
1118
1119    // to see the tricks about YBR_FULL, YBR_FULL_422,
1120    // YBR_PARTIAL_422, YBR_ICT, YBR_RCT have a look at :
1121    // ftp://medical.nema.org/medical/dicom/final/sup61_ft.pdf
1122    // and be *very* affraid
1123    //
1124    int l        = XSize * YSize;
1125    int nbFrames = ZSize;
1126
1127    uint8_t *a = copyRaw + 0;
1128    uint8_t *b = copyRaw + l;
1129    uint8_t *c = copyRaw + l+ l;
1130    int32_t R, G, B;
1131
1132    ///  We replaced easy to understand but time consuming floating point
1133    ///  computations by the 'well known' integer computation counterpart
1134    ///  Refer to :
1135    ///            http://lestourtereaux.free.fr/papers/data/yuvrgb.pdf
1136    ///  for code optimisation.
1137
1138    for ( int i = 0; i < nbFrames; i++ )
1139    {
1140       for ( int j = 0; j < l; j++ )
1141       {
1142          R = 38142 *(*a-16) + 52298 *(*c -128);
1143          G = 38142 *(*a-16) - 26640 *(*c -128) - 12845 *(*b -128);
1144          B = 38142 *(*a-16) + 66093 *(*b -128);
1145
1146          R = (R+16384)>>15;
1147          G = (G+16384)>>15;
1148          B = (B+16384)>>15;
1149
1150          if (R < 0)   R = 0;
1151          if (G < 0)   G = 0;
1152          if (B < 0)   B = 0;
1153          if (R > 255) R = 255;
1154          if (G > 255) G = 255;
1155          if (B > 255) B = 255;
1156
1157          *(localRaw++) = (uint8_t)R;
1158          *(localRaw++) = (uint8_t)G;
1159          *(localRaw++) = (uint8_t)B;
1160          a++;
1161          b++;
1162          c++;
1163       }
1164    }
1165    delete[] copyRaw;
1166 }
1167
1168 /// \brief Deals with the color decoding i.e. handle:
1169 ///   - R, G, B planes (as opposed to RGB pixels)
1170 ///   - YBR (various) encodings.
1171 ///   - LUT[s] (or "PALETTE COLOR").
1172
1173 void PixelReadConvert::ConvertHandleColor()
1174 {
1175    //////////////////////////////////
1176    // Deal with the color decoding i.e. handle:
1177    //   - R, G, B planes (as opposed to RGB pixels)
1178    //   - YBR (various) encodings.
1179    //   - LUT[s] (or "PALETTE COLOR").
1180    //
1181    // The classification in the color decoding schema is based on the blending
1182    // of two Dicom tags values:
1183    // * "Photometric Interpretation" for which we have the cases:
1184    //  - [Photo A] MONOCHROME[1|2] pictures,
1185    //  - [Photo B] RGB or YBR_FULL_422 (which acts as RGB),
1186    //  - [Photo C] YBR_* (with the above exception of YBR_FULL_422)
1187    //  - [Photo D] "PALETTE COLOR" which indicates the presence of LUT[s].
1188    // * "Planar Configuration" for which we have the cases:
1189    //  - [Planar 0] 0 then Pixels are already RGB
1190    //  - [Planar 1] 1 then we have 3 planes : R, G, B,
1191    //  - [Planar 2] 2 then we have 1 gray Plane and 3 LUTs
1192    //
1193    // Now in theory, one could expect some coherence when blending the above
1194    // cases. For example we should not encounter files belonging at the
1195    // time to case [Planar 0] and case [Photo D].
1196    // Alas, this was only theory ! Because in practice some odd (read ill
1197    // formated Dicom) files (e.g. gdcmData/US-PAL-8-10x-echo.dcm) we encounter:
1198    //     - "Planar Configuration" = 0,
1199    //     - "Photometric Interpretation" = "PALETTE COLOR".
1200    // Hence gdcm will use the folowing "heuristic" in order to be tolerant
1201    // towards Dicom-non-conformant files:
1202    //   << whatever the "Planar Configuration" value might be, a
1203    //      "Photometric Interpretation" set to "PALETTE COLOR" forces
1204    //      a LUT intervention >>
1205    //
1206    // Now we are left with the following handling of the cases:
1207    // - [Planar 0] OR  [Photo A] no color decoding (since respectively
1208    //       Pixels are already RGB and monochrome pictures have no color :),
1209    // - [Planar 1] AND [Photo B] handled with ConvertRGBPlanesToRGBPixels()
1210    // - [Planar 1] AND [Photo C] handled with ConvertYcBcRPlanesToRGBPixels()
1211    // - [Planar 2] OR  [Photo D] requires LUT intervention.
1212
1213    gdcmWarningMacro("--> ConvertHandleColor"
1214                     << "Planar Configuration " << PlanarConfiguration );
1215
1216    if ( ! IsRawRGB() )
1217    {
1218       // [Planar 2] OR  [Photo D]: LUT intervention done outside
1219       gdcmWarningMacro("--> RawRGB : LUT intervention done outside");
1220       return;
1221    }
1222
1223    if ( PlanarConfiguration == 1 )
1224    {
1225       if ( IsYBRFull )
1226       {
1227          // [Planar 1] AND [Photo C] (remember YBR_FULL_422 acts as RGB)
1228          gdcmWarningMacro("--> YBRFull");
1229          ConvertYcBcRPlanesToRGBPixels();
1230       }
1231       else
1232       {
1233          // [Planar 1] AND [Photo C]
1234          gdcmWarningMacro("--> YBRFull");
1235          ConvertRGBPlanesToRGBPixels();
1236       }
1237       return;
1238    }
1239
1240    // When planarConf is 0, and RLELossless (forbidden by Dicom norm)
1241    // pixels need to be RGB-fyied anyway
1242
1243    if (IsRLELossless)
1244    {
1245      gdcmWarningMacro("--> RLE Lossless");
1246      ConvertRGBPlanesToRGBPixels();
1247    }
1248
1249    // In *normal *case, when planarConf is 0, pixels are already in RGB
1250 }
1251
1252 /// Computes the Pixels Size
1253 void PixelReadConvert::ComputeRawAndRGBSizes()
1254 {
1255    int bitsAllocated = BitsAllocated;
1256    // Number of "Bits Allocated" is fixed to 16 when it's 12, since
1257    // in this case we will expand the image to 16 bits (see
1258    //    \ref ReadAndDecompress12BitsTo16Bits() )
1259    if (  BitsAllocated == 12 )
1260    {
1261       bitsAllocated = 16;
1262    }
1263
1264    RawSize =  XSize * YSize * ZSize
1265                      * ( bitsAllocated / 8 )
1266                      * SamplesPerPixel;
1267    if ( HasLUT )
1268    {
1269       RGBSize = 3 * RawSize; // works for 8 and 16 bits per Pixel
1270    }
1271    else
1272    {
1273       RGBSize = RawSize;
1274    }
1275 }
1276
1277 /// Allocates room for RGB Pixels
1278 void PixelReadConvert::AllocateRGB()
1279 {
1280   if ( RGB )
1281      delete [] RGB;
1282   RGB = new uint8_t[RGBSize];
1283 }
1284
1285 /// Allocates room for RAW Pixels
1286 void PixelReadConvert::AllocateRaw()
1287 {
1288   if ( Raw )
1289      delete [] Raw;
1290   Raw = new uint8_t[RawSize];
1291 }
1292
1293 //-----------------------------------------------------------------------------
1294 // Print
1295 /**
1296  * \brief        Print self.
1297  * @param indent Indentation string to be prepended during printing.
1298  * @param os     Stream to print to.
1299  */
1300 void PixelReadConvert::Print( std::ostream &os, std::string const &indent )
1301 {
1302    os << indent
1303       << "--- Pixel information -------------------------"
1304       << std::endl;
1305    os << indent
1306       << "Pixel Data: offset " << PixelOffset
1307       << " x(" << std::hex << PixelOffset << std::dec
1308       << ")   length " << PixelDataLength
1309       << " x(" << std::hex << PixelDataLength << std::dec
1310       << ")" << std::endl;
1311
1312    if ( IsRLELossless )
1313    {
1314       if ( RLEInfo )
1315       {
1316          RLEInfo->Print( os, indent );
1317       }
1318       else
1319       {
1320          gdcmWarningMacro("Set as RLE file but NO RLEinfo present.");
1321       }
1322    }
1323
1324    if ( IsJPEG2000 || IsJPEGLossless || IsJPEGLossy || IsJPEGLS )
1325    {
1326       if ( JPEGInfo )
1327       {
1328          JPEGInfo->Print( os, indent );
1329       }
1330       else
1331       {
1332          gdcmWarningMacro("Set as JPEG file but NO JPEGinfo present.");
1333       }
1334    }
1335 }
1336
1337 //-----------------------------------------------------------------------------
1338 } // end namespace gdcm
1339
1340 // Note to developpers :
1341 // Here is a very detailled post from David Clunie, on the troubles caused
1342 // 'non standard' LUT and LUT description
1343 // We shall have to take it into accound in our code.
1344 // Some day ...
1345
1346
1347 /*
1348 Subject: Problem with VOI LUTs in Agfa and Fuji CR and GE DX images, was Re: VOI LUT issues
1349 Date: Sun, 06 Feb 2005 17:13:40 GMT
1350 From: David Clunie <dclunie@dclunie.com>
1351 Reply-To: dclunie@dclunie.com
1352 Newsgroups: comp.protocols.dicom
1353 References: <1107553502.040221.189550@o13g2000cwo.googlegroups.com>
1354
1355 > THE LUT that comes with [my] image claims to be 16-bit, but none of the
1356 > values goes higher than 4095.  That being said, though, none of my
1357 > original pixel values goes higher than that, either.  I have read
1358 > elsewhere on this group that when that happens you are supposed to
1359 > adjust the LUT.  Can someone be more specific?  There was a thread from
1360 > 2002 where Marco and David were mentioning doing precisely that.
1361 >
1362 > Thanks
1363 >
1364 > -carlos rodriguez
1365
1366
1367 You have encountered the well known "we know what the standard says but
1368 we are going to ignore it and do what we have been doing for almost
1369 a decade regardless" CR vendor bug. Agfa started this, but they are not
1370 the only vendor doing this now; GE and Fuji may have joined the club.
1371
1372 Sadly, one needs to look at the LUT Data, figure out what the maximum
1373 value actually encoded is, and find the next highest power of 2 (e.g.
1374 212 in this case), to figure out what the range of the data is
1375 supposed to be. I have assumed that if the maximum value in the LUT
1376 data is less than a power of 2 minus 1 (e.g. 0xebc) then the intent
1377 of the vendor was not to use the maximum available grayscale range
1378 of the display (e.g. the maximum is 0xfff in this case). An alternative
1379 would be to scale to the actual maximum rather than a power of two.
1380
1381 Very irritating, and in theory not totally reliable if one really
1382 intended the full 16 bits and only used, say 15, but that is extremely
1383 unlikely since everything would be too dark, and this heuristic
1384 seems to work OK.
1385
1386 There has never been anything in the standard that describes having
1387 to go through these convolutions. Since the only value in the
1388 standard that describes the bit depth of the LUT values is LUT
1389 Descriptor value 3 and that is (usually) always required to be
1390 either 8 or 16, it mystifies me how the creators' of these images
1391 imagine that the receiver is going to divine the range that is intended. Further, the standard is quite explicit that this 3rd
1392 value defines the range of LUT values, but as far as I am aware, all
1393 the vendors are ignoring the standard and indeed sending a third value
1394 of 16 in all cases.
1395
1396 This problem is not confined to CR, and is also seen with DX products.
1397
1398 Typically I have seen:
1399
1400 - Agfa CR, which usually (always ?) sends LUTs, values up to 0x0fff
1401 - Fuji CR, which occasionally send LUTs, values up to 0x03ff
1402 - GE DX, for presentation, which always have LUTs, up to 0x3fff
1403
1404 Swissray, Siemens, Philips, Canon and Kodak never seem to send VOI LUTs
1405 at this point (which is a whole other problem). Note that the presence
1406 or absence of a VOI LUT as opposed to window values may be configurable
1407 on the modality in some cases, and I have just looked at what I happen
1408 to have received from a myriad of sites over whose configuration I have
1409 no control. This may be why the majority of Fuji images have no VOI LUTs,
1410 but a few do (or it may be the Siemens system that these Fuji images went
1411 through that perhaps added it). I do have some test Hologic DX images that
1412 are not from a clinical site that do actually get this right (a value
1413 of 12 for the third value and a max of 0xfff).
1414
1415 Since almost every vendor that I have encountered that encodes LUTs
1416 makes this mistake, perhaps it is time to amend the standard to warn
1417 implementor's of receivers and/or sanction this bad behavior. We have
1418 talked about this in the past in WG 6 but so far everyone has been
1419 reluctant to write into the standard such a comment. Maybe it is time
1420 to try again, since if one is not aware of this problem, one cannot
1421 effectively implement display using VOI LUTs, and there is a vast
1422 installed base to contend with.
1423
1424 I did not check presentation states, in which VOI LUTs could also be
1425 encountered, for the prevalence of this mistake, nor did I look at the
1426 encoding of Modality LUT's, which are unusual. Nor did I check digital
1427 mammography images. I would be interested to hear from anyone who has.
1428
1429 David
1430
1431 PS. The following older thread in this newsgroup discusses this:
1432
1433 "http://groups-beta.google.com/group/comp.protocols.dicom/browse_frm/t hread/6a033444802a35fc/0f0a9a1e35c1468e?q=voi+lut&_done=%2Fgroup%2Fcom p.protocols.dicom%2Fsearch%3Fgroup%3Dcomp.protocols.dicom%26q%3Dvoi+lu t%26qt_g%3D1%26searchnow%3DSearch+this+group%26&_doneTitle=Back+to+Sea rch&&d#0f0a9a1e35c1468e"
1434
1435 PPS. From a historical perspective, the following may be of interest.
1436
1437 In the original standard in 1993, all that was said about this was a
1438 reference to the corresponding such where Modality LUTs are described
1439 that said:
1440
1441 "The third value specifies the number of bits for each entry in the
1442 LUT Data. It shall take the value 8 or 16. The LUT Data shall be stored
1443 in a format equivalent to 8 or 16 bits allocated and high bit equal
1444 1-bits allocated."
1445
1446 Since the high bit hint was not apparently explicit enough, a very
1447 early CP, CP 15 (submitted by Agfa as it happens), replaced this with:
1448
1449 "The third value conveys the range of LUT entry values. It shall take
1450 the value 8 or 16, corresponding with the LUT entry value range of
1451 256 or 65536.
1452
1453 Note:    The third value is not required for describing the
1454     LUT data and is only included for informational usage
1455     and for maintaining compatibility with ACRNEMA 2.0.
1456
1457 The LUT Data contains the LUT entry values."
1458
1459 That is how it read in the 1996, 1998 and 1999 editions.
1460
1461 By the 2000 edition, Supplement 33 that introduced presentation states
1462 extensively reworked this entire section and tried to explain this in
1463 different words:
1464
1465 "The output range is from 0 to 2^n-1 where n is the third value of LUT
1466 Descriptor. This range is always unsigned."
1467
1468 and also added a note to spell out what the output range meant in the
1469 VOI LUT section:
1470
1471 "9. The output of the Window Center/Width or VOI LUT transformation
1472 is either implicitly scaled to the full range of the display device
1473 if there is no succeeding transformation defined, or implicitly scaled
1474 to the full input range of the succeeding transformation step (such as
1475 the Presentation LUT), if present. See C.11.6.1."
1476
1477 It still reads this way in the 2004 edition.
1478
1479 Note that LUTs in other applications than the general VOI LUT allow for
1480 values other than 8 or 16 in the third value of LUT descriptor to permit
1481 ranges other than 0 to 255 or 65535.
1482
1483 In addition, the DX Image Module specializes the VOI LUT
1484 attributes as follows, in PS 3.3 section C.8.11.3.1.5 (added in Sup 32):
1485
1486 "The third value specifies the number of bits for each entry in the LUT
1487 Data (analogous to ìbits storedî). It shall be between 10-16. The LUT
1488 Data shall be stored in a format equivalent to 16 ìbits allocatedî and
1489 ìhigh bitî equal to ìbits storedî - 1. The third value conveys the range
1490 of LUT entry values. These unsigned LUT entry values shall range between
1491 0 and 2^n-1, where n is the third value of the LUT Descriptor."
1492
1493 So in the case of the GE DX for presentation images, the third value of
1494 LUT descriptor is allowed to be and probably should be 14 rather than 16.
1495
1496 */