]> Creatis software - gdcm.git/blobdiff - src/gdcmFile.h
* gdcmDocEntrySet::SQDepthLevel and gdcmDocEntrySet::BaseTagKey attributes
[gdcm.git] / src / gdcmFile.h
index b7a395827c8a4488c26e522afad87fc4de0f6118..90ea66afd248678bfd8c2d678af2cbe0bdb38765 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmFile.h,v $
   Language:  C++
-  Date:      $Date: 2004/07/30 16:09:27 $
-  Version:   $Revision: 1.40 $
+  Date:      $Date: 2004/09/13 07:49:36 $
+  Version:   $Revision: 1.47 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -31,9 +31,8 @@
 class GDCM_EXPORT gdcmFile
 {
 public:
-   gdcmFile(gdcmHeader *header);
-   gdcmFile(std::string const & filename, 
-            bool  exception_on_error = false);
+   gdcmFile( gdcmHeader *header );
+   gdcmFile( std::string const & filename );
  
    virtual ~gdcmFile();
 
@@ -41,21 +40,31 @@ public:
    gdcmHeader* GetHeader() { return Header; }
 
    void   SetPixelDataSizeFromHeader();
-   size_t GetImageDataSize();
-   size_t GetImageDataSizeRaw();
+   
+
+/// \brief     Returns the size (in bytes) of required memory to hold
+///            the pixel data represented in this file.
+   size_t GetImageDataSize(){ return ImageDataSize; };
+
+   
+/// \brief     Returns the size (in bytes) of required memory to hold
+///            the pixel data represented in this file, if user DOESN'T want 
+///            to get RGB pixels image when it's stored as a PALETTE COLOR image
+///            -the (vtk) user is supposed to know how to deal with LUTs-     
+   size_t GetImageDataSizeRaw(){ return ImageDataSizeRaw; };
 
    void * GetImageData();
    size_t GetImageDataIntoVector(void* destination, size_t maxSize);
    void * GetImageDataRaw();
    size_t GetImageDataIntoVectorRaw(void* destination, size_t maxSize);
 
-      // Allocates ExpectedSize bytes of memory at this->Data and copies the
-      // pointed data to it. Copying the image might look useless but
-      // the caller might destroy it's image (without knowing it: think
-      // of a complicated interface where display is done with a library
-      // e.g. VTK) before calling the Write
+   // Allocates ExpectedSize bytes of memory at this->Data and copies the
+   // pointed data to it. Copying the image might look useless but
+   // the caller might destroy it's image (without knowing it: think
+   // of a complicated interface where display is done with a library
+   // e.g. VTK) before calling the Write
       
-   // voir gdcmHeader::SetImageDataSize ?!?         
+   // see also gdcmHeader::SetImageDataSize ?!?         
    bool SetImageData (void * data, size_t expectedSize);
 
    /// \todo When the caller is aware we simply point to the data:
@@ -85,22 +94,24 @@ protected:
 
 private:
    void SwapZone(void* im, int swap, int lgr, int nb);
-   
+   void SetInitialValues();  
    bool ReadPixelData(void * destination);
    
    // For JPEG 8 Bits, body in file gdcmJpeg.cxx
    bool gdcm_read_JPEG_file     (FILE *fp, void * image_buffer); 
    static int gdcm_read_RLE_fragment(char **areaToRead, long lengthToDecode, 
                                      long uncompressedSegmentSize, FILE *fp);
+
    // For JPEG 12 Bits, body in file gdcmJpeg12.cxx
    bool gdcm_read_JPEG_file12   (FILE *fp, void* image_buffer);
+
    // For JPEG 2000, body in file gdcmJpeg2000.cxx
    bool gdcm_read_JPEG2000_file (FILE *fp, void* image_buffer);
 
-   // For Run Length Encoding (TOCHECK)
+   // For Run Length Encoding
    bool gdcm_read_RLE_file      (FILE *fp, void* image_buffer); 
 
-// Variables
+// members variables:
 
    /// \brief Header to use to load the file
    gdcmHeader *Header;
@@ -111,7 +122,7 @@ private:
    bool SelfHeader;
 
    /// \brief to hold the Pixels (when read)
-   void* PixelData;
+   void* Pixel_Data;  // (was PixelData; should be removed)
    
    /// \brief Area length to receive the pixels
    size_t ImageDataSizeRaw;
@@ -123,10 +134,45 @@ private:
   /// \brief ==1  if GetImageDataRaw was used
   ///        ==0  if GetImageData    was used
   ///        ==-1 if ImageData never read                       
-   int PixelRead;     
+   int PixelRead;
+   
+  /// wether already parsed 
+   bool Parsed;
+      
+  /// \brief length of the last allocated area devoided to receive Pixels
+  ///        ( to allow us not to (free + new) if un necessary )     
+   size_t LastAllocatedPixelDataLength; 
+
+  // Initial values of some fields that can be modified during reading process
+  // if user asked to transform gray level + LUT image into RGB image
+     
+  /// \brief Samples Per Pixel           (0x0028,0x0002), as found on disk
+   std::string InitialSpp;
+  /// \brief Photometric Interpretation  (0x0028,0x0004), as found on disk
+   std::string InitialPhotInt;
+  /// \brief Planar Configuration        (0x0028,0x0006), as found on disk   
+   std::string InitialPlanConfig;    
+  /// \brief Bits Allocated              (0x0028,0x0100), as found on disk
+   std::string InitialBitsAllocated;
+   
+  // some DocEntry that can be moved out of the H table during reading process
+  // if user asked to transform gray level + LUT image into RGB image
+  // We keep a pointer on them for a future use.
+     
+  /// \brief Red Palette Color Lookup Table Descriptor   0028 1101 as read
+  gdcmDocEntry* InitialRedLUTDescr;  
+  /// \brief Green Palette Color Lookup Table Descriptor 0028 1102 as read
+  gdcmDocEntry* InitialGreenLUTDescr;
+  /// \brief Blue Palette Color Lookup Table Descriptor  0028 1103 as read
+  gdcmDocEntry* InitialBlueLUTDescr;
+  
+  /// \brief Red Palette Color Lookup Table Data         0028 1201 as read
+  gdcmDocEntry* InitialRedLUTData;  
+  /// \brief Green Palette Color Lookup Table Data       0028 1202 as read
+  gdcmDocEntry* InitialGreenLUTData;
+  /// \brief Blue Palette Color Lookup Table Data        0028 1203 as read
+  gdcmDocEntry* InitialBlueLUTData;
 
-   /// wether already parsed 
-   int Parsed;
 };
 
 //-----------------------------------------------------------------------------