src/gdcmFile.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmFile.h,v $
   5   Language:  C++
   6   Date:      $Date: 2004/10/08 08:56:48 $
   7   Version:   $Revision: 1.56 $
   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 #ifndef GDCMFILE_H
  20 #define GDCMFILE_H
  21
  22 #include "gdcmCommon.h"
  23 #include "gdcmHeader.h"
  24
  25 //-----------------------------------------------------------------------------
  26 /*
  27  * In addition to Dicom header exploration, this class is designed
  28  * for accessing the image/volume content. One can also use it to
  29  * write Dicom/ACR-NEMA/RAW files.
  30  */
  31 class GDCM_EXPORT gdcmFile
  32 {
  33 public:
  34    gdcmFile( gdcmHeader *header );
  35    gdcmFile( std::string const& filename );
  36
  37    virtual ~gdcmFile();
  38
  39    /// Accessor to \ref Header
  40    gdcmHeader* GetHeader() { return Header; }
  41
  42    int ComputeDecompressedPixelDataSizeFromHeader();
  43
  44    void ConvertRGBPlanesToRGBPixels( uint8_t* source, uint8_t* destination );
  45    void ConvertYcBcRPlanesToRGBPixels( uint8_t* source, uint8_t* destination );
  46    void ConvertReArrangeBits(
  47            uint8_t* pixelZone,
  48            size_t imageDataSize,
  49            int numberBitsStored,
  50            int numberBitsAllocated,
  51            int highBitPosition ) throw ( gdcmFormatError );
  52    void ConvertReorderEndianity(
  53            uint8_t* pixelZone,
  54            size_t imageDataSize,
  55            int numberBitsStored,
  56            int numberBitsAllocated,
  57            bool signedPixel );
  58    void ConvertDecompress12BitsTo16Bits(
  59            uint8_t* pixelZone,
  60            int sizeX,
  61            int sizeY,
  62            FILE* filePtr) throw ( gdcmFormatError);
  63
  64    /// Accessor to \ref ImageDataSize
  65    size_t GetImageDataSize(){ return ImageDataSize; };
  66
  67    /// Accessor to \ref ImageDataSizeRaw
  68    size_t GetImageDataSizeRaw(){ return ImageDataSizeRaw; };
  69
  70    uint8_t* GetImageData();
  71    size_t GetImageDataIntoVector(void* destination, size_t maxSize);
  72    uint8_t* GetImageDataRaw();
  73    size_t GetImageDataIntoVectorRaw(void* destination, size_t maxSize);
  74
  75    // see also gdcmHeader::SetImageDataSize ?!?
  76    bool SetImageData (uint8_t* data, size_t expectedSize);
  77
  78    /// \todo When the caller is aware we simply point to the data:
  79    /// int SetImageDataNoCopy (void* Data, size_t ExpectedSize);
  80
  81    // Write pixels of ONE image on hard drive
  82    // No test is made on processor "endianity"
  83    // The user must call his reader correctly
  84    bool WriteRawData  (std::string const& fileName);
  85    bool WriteDcmImplVR(std::string const& fileName);
  86    bool WriteDcmExplVR(std::string const& fileName);
  87    bool WriteAcr      (std::string const& fileName);
  88
  89    // Don't look any longer for the code :
  90    // It's in file gdcmParsePixels.cxx
  91    bool ParsePixelData();
  92
  93    virtual bool SetEntryByNumber(std::string const& content,
  94                                  uint16_t group, uint16_t element)
  95    {
  96       Header->SetEntryByNumber(content,group,element);
  97       return true;
  98    }
  99
 100 protected:
 101    bool WriteBase(std::string const& fileName, FileType type);
 102
 103 private:
 104    void Initialise();
 105    void SwapZone(void* im, int swap, int lgr, int nb);
 106
 107    bool ReadPixelData(void* destination);
 108
 109    // For JPEG 8 Bits, body in file gdcmJpeg.cxx
 110    bool gdcm_read_JPEG_file     (FILE* fp, void* image_buffer);
 111    bool gdcm_write_JPEG_file    (FILE* fp, void* image_buffer,
 112                                  int image_width, int image_heigh,
 113                                  int quality);
 114
 115    // For JPEG 12 Bits, body in file gdcmJpeg12.cxx
 116    bool gdcm_read_JPEG_file12   (FILE* fp, void* image_buffer);
 117    bool gdcm_write_JPEG_file12  (FILE* fp, void* image_buffer,
 118                                  int image_width, int image_height,
 119                                  int quality);
 120
 121    // For JPEG 2000, body in file gdcmJpeg2000.cxx
 122    bool gdcm_read_JPEG2000_file (FILE* fp, void* image_buffer);
 123
 124    // For Run Length Encoding
 125    bool gdcm_read_RLE_file      (FILE* fp, void* image_buffer);
 126 // FIXME : *sure* it's NOT static (C++)
 127 // (would be static in C, or embedded in ADA)
 128 // It's NOT a method, but a not user intended fonction.
 129 // How do we write that in C++ ?)
 130    static bool gdcm_read_RLE_fragment( uint8_t** decodedZone,
 131                                        long fragmentSize,
 132                                        long uncompressedSegmentSize, FILE* fp);
 133
 134    void SaveInitialValues();    // will belong to the future gdcmPixelData class
 135    void RestoreInitialValues(); // will belong to the future gdcmPixelData class
 136    void DeleteInitialValues();  // will belong to the future gdcmPixelData class
 137
 138 // members variables:
 139
 140    /// \brief Header to use to load the file
 141    gdcmHeader *Header;
 142
 143    /// \brief Whether the underlying \ref gdcmHeader was loaded by
 144    ///  the constructor or passed to the constructor. When false
 145    ///  the destructor is in charge of deletion.
 146    bool SelfHeader;
 147
 148    /// wether already parsed
 149    bool Parsed;
 150
 151 //
 152 // --------------- Will be moved to a gdcmPixelData class
 153 //
 154
 155    /// \brief to hold the Pixels (when read)
 156    uint8_t* Pixel_Data;  // (was PixelData)
 157
 158    /// \brief Size (in bytes) of required memory to hold the Gray Level pixels
 159    ///        represented in this file. This is used when the user DOESN'T want
 160    ///        the RGB pixels image when it's stored as a PALETTE COLOR image
 161    size_t ImageDataSizeRaw;
 162
 163    /// \brief Size (in bytes) of requited memory to hold the the pixels
 164    ///        of this image in it's RGB convertion either from:
 165    ///        - Plane R, Plane G, Plane B
 166    ///        - Grey Plane + Palette Color
 167    ///        - YBR Pixels (or from RGB Pixels, as well)
 168    size_t ImageDataSize;
 169
 170   /// \brief ==1  if GetImageDataRaw was used
 171   ///        ==0  if GetImageData    was used
 172   ///        ==-1 if ImageData never read
 173    int PixelRead;
 174
 175   /// \brief length of the last allocated area devoided to receive Pixels
 176   ///        ( to allow us not to (free + new) if un necessary )
 177    size_t LastAllocatedPixelDataLength;
 178
 179   // Initial values of some fields that can be modified during reading process
 180   // if user asked to transform gray level + LUT image into RGB image
 181
 182   /// \brief Samples Per Pixel           (0x0028,0x0002), as found on disk
 183    std::string InitialSpp;
 184   /// \brief Photometric Interpretation  (0x0028,0x0004), as found on disk
 185    std::string InitialPhotInt;
 186   /// \brief Planar Configuration        (0x0028,0x0006), as found on disk
 187    std::string InitialPlanConfig;
 188
 189   // Initial values of some fields that can be modified during reading process
 190   // if the image was a 'strange' ACR-NEMA
 191   // (Bits Allocated=12, High Bit not equal to Bits stored +1)
 192   /// \brief Bits Allocated              (0x0028,0x0100), as found on disk
 193    std::string InitialBitsAllocated;
 194   /// \brief High Bit                    (0x0028,0x0102), as found on disk
 195    std::string InitialHighBit;
 196
 197   // some DocEntry that can be moved out of the H table during reading process
 198   // if user asked to transform gray level + LUT image into RGB image
 199   // We keep a pointer on them for a future use.
 200
 201   /// \brief Red Palette Color Lookup Table Descriptor   0028 1101 as read
 202   gdcmDocEntry* InitialRedLUTDescr;
 203   /// \brief Green Palette Color Lookup Table Descriptor 0028 1102 as read
 204   gdcmDocEntry* InitialGreenLUTDescr;
 205   /// \brief Blue Palette Color Lookup Table Descriptor  0028 1103 as read
 206   gdcmDocEntry* InitialBlueLUTDescr;
 207
 208   /// \brief Red Palette Color Lookup Table Data         0028 1201 as read
 209   gdcmDocEntry* InitialRedLUTData;
 210   /// \brief Green Palette Color Lookup Table Data       0028 1202 as read
 211   gdcmDocEntry* InitialGreenLUTData;
 212   /// \brief Blue Palette Color Lookup Table Data        0028 1203 as read
 213   gdcmDocEntry* InitialBlueLUTData;
 214
 215 //
 216 // --------------- end of future gdcmPixelData class
 217 //
 218
 219 };
 220
 221 //-----------------------------------------------------------------------------
 222 #endif