]> Creatis software - gdcm.git/blobdiff - src/gdcmFile.h
* src/gdcmFile.h : bug fix. Variable type and variable name had same name
[gdcm.git] / src / gdcmFile.h
index a78434c2e76be7ddf56f3155ba4ff01e14ebe90d..f72484188d77d0a8363eaa7d4f457398996aed20 100644 (file)
@@ -3,12 +3,12 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmFile.h,v $
   Language:  C++
-  Date:      $Date: 2004/09/10 18:54:39 $
-  Version:   $Revision: 1.45 $
+  Date:      $Date: 2004/12/04 09:41:02 $
+  Version:   $Revision: 1.84 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
-  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.htm for details.
+  http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
                                                                                 
      This software is distributed WITHOUT ANY WARRANTY; without even
      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
 #define GDCMFILE_H
 
 #include "gdcmCommon.h"
-#include "gdcmHeader.h"
 
+namespace gdcm 
+{
+class Header;
+class ValEntry;
+class BinEntry;
+class PixelReadConvert;
+class PixelWriteConvert;
+class DocEntryArchive;
 //-----------------------------------------------------------------------------
 /*
  * In addition to Dicom header exploration, this class is designed
  * for accessing the image/volume content. One can also use it to
  * write Dicom/ACR-NEMA/RAW files.
  */
-class GDCM_EXPORT gdcmFile
+class GDCM_EXPORT File
 {
 public:
-   gdcmFile( gdcmHeader *header );
-   gdcmFile( std::string const & filename );
+   enum FileMode
+   {
+      WMODE_DECOMPRESSED,
+      WMODE_RGB
+   };
+     
+public:
+   File( Header* header );
+   File( std::string const& filename );
  
-   virtual ~gdcmFile();
+   virtual ~File();
 
    /// Accessor to \ref Header
-   gdcmHeader* GetHeader() { return Header; }
-
-   void   SetPixelDataSizeFromHeader();
-   
-
-/// \brief     Returns the size (in bytes) of required memory to hold
-///            the pixel data represented in this file.
-   size_t GetImageDataSize(){ return ImageDataSize; };
+   Header* GetHeader() { return HeaderInternal; }
 
-   
-/// \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; };
+   size_t GetImageDataSize();
+   size_t GetImageDataRawSize();
 
-   void * GetImageData();
+   uint8_t* GetImageData();
+   uint8_t* GetImageDataRaw();
    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
-      
-   // see also gdcmHeader::SetImageDataSize ?!?         
-   bool SetImageData (void * data, size_t expectedSize);
 
-   /// \todo When the caller is aware we simply point to the data:
-   /// int SetImageDataNoCopy (void * Data, size_t ExpectedSize);
+   bool SetImageData (uint8_t* data, size_t expectedSize);
 
    // Write pixels of ONE image on hard drive
    // No test is made on processor "endianity"
    // The user must call his reader correctly
-   bool WriteRawData  (std::string const & fileName);
-   bool WriteDcmImplVR(std::string const & fileName);
-   bool WriteDcmExplVR(std::string const & fileName);
-   bool WriteAcr      (std::string const & fileName);
-
-   // Don't look any longer for the code : 
-   // It's in file gdcmParsePixels.cxx
-   bool ParsePixelData();
-
-   virtual bool SetEntryByNumber(std::string const & content,
-                                 uint16_t group, uint16_t element)
-   { 
-      Header->SetEntryByNumber(content,group,element);
-      return true;
-   }
-     
+   bool WriteRawData  (std::string const& fileName);
+   bool WriteDcmImplVR(std::string const& fileName);
+   bool WriteDcmExplVR(std::string const& fileName);
+   bool WriteAcr      (std::string const& fileName);
+   bool Write(std::string const& fileName);
+
+   bool SetEntryByNumber(std::string const& content,
+                                uint16_t group, uint16_t element);
+   uint8_t* GetLutRGBA();
+
+   // Write mode
+   void SetWriteModeToDecompressed() { SetWriteMode(WMODE_DECOMPRESSED); };
+   void SetWriteModeToRGB()          { SetWriteMode(WMODE_RGB); };
+   void SetWriteMode(FileMode mode)  { WriteMode = mode; };
+   FileMode GetWriteMode()           { return WriteMode; };
+
+   // Write format
+   void SetWriteTypeToDcmImplVR()     { SetWriteType(ImplicitVR); };
+   void SetWriteTypeToDcmExplVR()     { SetWriteType(ExplicitVR); };
+   void SetWriteTypeToAcr()           { SetWriteType(ACR); };
+   void SetWriteTypeToAcrLibido()     { SetWriteType(ACR_LIBIDO); };
+   void SetWriteType(FileType format) { WriteType = format; };
+   FileType GetWriteType()            { return WriteType; };
+
 protected:
-   bool WriteBase(std::string const & fileName, FileType type);
+   bool WriteBase(std::string const& fileName);
+   bool CheckWriteIntegrity();
 
-private:
-   void SwapZone(void* im, int swap, int lgr, int nb);
-   void gdcmFile::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);
+   void SetWriteToDecompressed();
+   void SetWriteToRGB();
+   void RestoreWrite();
 
-   // For JPEG 12 Bits, body in file gdcmJpeg12.cxx
-   bool gdcm_read_JPEG_file12   (FILE *fp, void* image_buffer);
+   void SetWriteFileTypeToACR();
+   void SetWriteFileTypeToExplicitVR();
+   void SetWriteFileTypeToImplicitVR();
+   void RestoreWriteFileType();
 
-   // For JPEG 2000, body in file gdcmJpeg2000.cxx
-   bool gdcm_read_JPEG2000_file (FILE *fp, void* image_buffer);
+   void SetWriteToLibido();
+   void SetWriteToNoLibido();
+   void RestoreWriteOfLibido();
 
-   // For Run Length Encoding
-   bool gdcm_read_RLE_file      (FILE *fp, void* image_buffer); 
+   ValEntry* CopyValEntry(uint16_t group,uint16_t element);
+   BinEntry* CopyBinEntry(uint16_t group,uint16_t element);
 
+private:
+   void Initialise();
+
+   uint8_t* GetDecompressed();
+   int ComputeDecompressedPixelDataSizeFromHeader();
+
+private:
 // members variables:
 
-   /// \brief Header to use to load the file
-   gdcmHeader *Header;
+   /// Header to use to load the file
+   Header *HeaderInternal;
 
-   /// \brief Whether the underlying \ref gdcmHeader was loaded by
+   /// \brief Whether the underlying \ref Header was loaded by
    ///  the constructor or passed to the constructor. When false
    ///  the destructor is in charge of deletion.
    bool SelfHeader;
-
-   /// \brief to hold the Pixels (when read)
-   void* Pixel_Data;  // (was PixelData; should be removed)
-   
-   /// \brief Area length to receive the pixels
-   size_t ImageDataSizeRaw;
    
-   /// \brief Area length to receive the RGB pixels
-   /// from Grey Plane + Palette Color  
-   size_t ImageDataSize;
-       
-  /// \brief ==1  if GetImageDataRaw was used
-  ///        ==0  if GetImageData    was used
-  ///        ==-1 if ImageData never read                       
-   int PixelRead;
-   
-  /// wether already parsed 
+   /// Wether already parsed or not
    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 ou of the H table during reading process
-  // if user asked to transform gray level + LUT image into RGB image
-   
-  /// \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;
+   /// Utility pixel converter
+   PixelReadConvert* PixelReadConverter;
+   PixelWriteConvert* PixelWriteConverter;
+
+   // Utility header archive
+   DocEntryArchive *Archive;
 
+   // Write variables
+   FileMode WriteMode;
+   FileType WriteType;
 };
+} // end namespace gdcm
 
 //-----------------------------------------------------------------------------
 #endif