src/gdcmFile.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmFile.h,v $
   5   Language:  C++
   6   Date:      $Date: 2004/08/02 16:42:14 $
   7   Version:   $Revision: 1.42 $
   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.htm 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    void   SetPixelDataSizeFromHeader();
  43    size_t GetImageDataSize();
  44    size_t GetImageDataSizeRaw();
  45
  46    void * GetImageData();
  47    size_t GetImageDataIntoVector(void* destination, size_t maxSize);
  48    void * GetImageDataRaw();
  49    size_t GetImageDataIntoVectorRaw(void* destination, size_t maxSize);
  50
  51    // Allocates ExpectedSize bytes of memory at this->Data and copies the
  52    // pointed data to it. Copying the image might look useless but
  53    // the caller might destroy it's image (without knowing it: think
  54    // of a complicated interface where display is done with a library
  55    // e.g. VTK) before calling the Write
  56
  57    // see also gdcmHeader::SetImageDataSize ?!?
  58    bool SetImageData (void * data, size_t expectedSize);
  59
  60    /// \todo When the caller is aware we simply point to the data:
  61    /// int SetImageDataNoCopy (void * Data, size_t ExpectedSize);
  62
  63    // Write pixels of ONE image on hard drive
  64    // No test is made on processor "endianity"
  65    // The user must call his reader correctly
  66    bool WriteRawData  (std::string const & fileName);
  67    bool WriteDcmImplVR(std::string const & fileName);
  68    bool WriteDcmExplVR(std::string const & fileName);
  69    bool WriteAcr      (std::string const & fileName);
  70
  71    // Don't look any longer for the code :
  72    // It's in file gdcmParsePixels.cxx
  73    bool ParsePixelData();
  74
  75    virtual bool SetEntryByNumber(std::string const & content,
  76                                  uint16_t group, uint16_t element)
  77    {
  78       Header->SetEntryByNumber(content,group,element);
  79       return true;
  80    }
  81
  82 protected:
  83    bool WriteBase(std::string const & fileName, FileType type);
  84
  85 private:
  86    void SwapZone(void* im, int swap, int lgr, int nb);
  87
  88    bool ReadPixelData(void * destination);
  89
  90    // For JPEG 8 Bits, body in file gdcmJpeg.cxx
  91    bool gdcm_read_JPEG_file     (FILE *fp, void * image_buffer);
  92    static int gdcm_read_RLE_fragment(char **areaToRead, long lengthToDecode,
  93                                      long uncompressedSegmentSize, FILE *fp);
  94
  95    // For JPEG 12 Bits, body in file gdcmJpeg12.cxx
  96    bool gdcm_read_JPEG_file12   (FILE *fp, void* image_buffer);
  97
  98    // For JPEG 2000, body in file gdcmJpeg2000.cxx
  99    bool gdcm_read_JPEG2000_file (FILE *fp, void* image_buffer);
 100
 101    // For Run Length Encoding (TOCHECK)
 102    bool gdcm_read_RLE_file      (FILE *fp, void* image_buffer);
 103
 104 // members variables:
 105
 106    /// \brief Header to use to load the file
 107    gdcmHeader *Header;
 108
 109    /// \brief Whether the underlying \ref gdcmHeader was loaded by
 110    ///  the constructor or passed to the constructor. When false
 111    ///  the destructor is in charge of deletion.
 112    bool SelfHeader;
 113
 114    /// \brief to hold the Pixels (when read)
 115    void* PixelData;
 116
 117    /// \brief Area length to receive the pixels
 118    size_t ImageDataSizeRaw;
 119
 120    /// \brief Area length to receive the RGB pixels
 121    /// from Grey Plane + Palette Color
 122    size_t ImageDataSize;
 123
 124   /// \brief ==1  if GetImageDataRaw was used
 125   ///        ==0  if GetImageData    was used
 126   ///        ==-1 if ImageData never read
 127    int PixelRead;
 128
 129    /// wether already parsed
 130    int Parsed;
 131 };
 132
 133 //-----------------------------------------------------------------------------
 134 #endif