]> Creatis software - gdcm.git/blobdiff - src/gdcmFile.h
* gdcmPython/testSuite.py checks on CR-MONO1-10-chest.dcm moved to
[gdcm.git] / src / gdcmFile.h
index 5d042c8e39299494e338ea9d8c9b173fa1ebfd77..a229157f442de84769f8eb1387effe7e590aa53a 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmFile.h,v $
   Language:  C++
-  Date:      $Date: 2004/06/23 03:36:24 $
-  Version:   $Revision: 1.34 $
+  Date:      $Date: 2004/08/02 16:42:14 $
+  Version:   $Revision: 1.42 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
 class GDCM_EXPORT gdcmFile
 {
 public:
-   gdcmFile(gdcmHeader *header);
-   gdcmFile(std::string const & filename, 
-            bool  exception_on_error = false, 
-            bool  enable_sequences   = false,
-            bool  skip_shadow        = false);
+   gdcmFile( gdcmHeader *header );
+   gdcmFile( std::string const & filename );
  
    virtual ~gdcmFile();
-       
- /// \brief returns the gdcmHeader *Header
-   inline gdcmHeader *GetHeader() { return Header;};
 
-   // For promotion (performs a deepcopy of pointed header object)
-   // TODO Swig gdcmFile(gdcmHeader* header);
-   // TODO Swig ~gdcmFile();
-
-   // On writing purposes. When instance was created through
-   // gdcmFile(std::string filename) then the filename argument MUST be
-        // different from the constructor's one (no overwriting allowed).
-   // TODO Swig int SetFileName(std::string filename);
+   /// Accessor to \ref Header
+   gdcmHeader* GetHeader() { return Header; }
 
    void   SetPixelDataSizeFromHeader();
    size_t GetImageDataSize();
    size_t GetImageDataSizeRaw();
 
    void * GetImageData();
-   size_t GetImageDataIntoVector(void* destination, size_t MaxSize);
+   size_t GetImageDataIntoVector(void* destination, size_t maxSize);
    void * GetImageDataRaw();
-   size_t GetImageDataIntoVectorRaw(void* destination, size_t MaxSize);
+   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 ?!?         
-   bool SetImageData     (void * Data, size_t ExpectedSize);
-      // When the caller is aware we simply point to the data:
-      // TODO int SetImageDataNoCopy (void * Data, size_t ExpectedSize);
+   // see also gdcmHeader::SetImageDataSize ?!?         
+   bool SetImageData (void * data, size_t expectedSize);
 
-  // Push to disk.
-  // TODO Swig int Write();
+   /// \todo When the caller is aware we simply point to the data:
+   /// int SetImageDataNoCopy (void * Data, size_t ExpectedSize);
 
    // Write pixels of ONE image on hard drive
    // No test is made on processor "endianity"
@@ -82,18 +68,19 @@ public:
    bool WriteDcmExplVR(std::string const & fileName);
    bool WriteAcr      (std::string const & fileName);
 
-   // Body in file gdcmParse.cxx
+   // Don't look any longer for the code : 
+   // It's in file gdcmParsePixels.cxx
    bool ParsePixelData();
 
-   inline virtual bool SetEntryByNumber(std::string const & content,
-                                        guint16 group, guint16 element)
-      { GetHeader()->SetEntryByNumber(content,group,element); 
-        return true;  //default behavior ?
-      }
-
+   virtual bool SetEntryByNumber(std::string const & content,
+                                 uint16_t group, uint16_t element)
+   { 
+      Header->SetEntryByNumber(content,group,element);
+      return true;
+   }
      
 protected:
-   bool WriteBase(std::string const & FileName, FileType type);
+   bool WriteBase(std::string const & fileName, FileType type);
 
 private:
    void SwapZone(void* im, int swap, int lgr, int nb);
@@ -101,18 +88,20 @@ private:
    bool ReadPixelData(void * destination);
    
    // For JPEG 8 Bits, body in file gdcmJpeg.cxx
-   bool gdcm_read_JPEG_file     (FILE *fp,void * image_buffer); 
+   bool gdcm_read_JPEG_file     (FILE *fp, void * image_buffer); 
    static int gdcm_read_RLE_fragment(char **areaToRead, long lengthToDecode, 
-                                     long uncompressedSegmentSize,FILE *fp);
+                                     long uncompressedSegmentSize, FILE *fp);
+
    // For JPEG 12 Bits, body in file gdcmJpeg12.cxx
-   bool gdcm_read_JPEG_file12   (FILE *fp,void * image_buffer);
+   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);
+   bool gdcm_read_JPEG2000_file (FILE *fp, void* image_buffer);
 
    // For Run Length Encoding (TOCHECK)
-   bool gdcm_read_RLE_file      (FILE *fp,void * image_buffer); 
+   bool gdcm_read_RLE_file      (FILE *fp, void* image_buffer); 
 
-// Variables
+// members variables:
 
    /// \brief Header to use to load the file
    gdcmHeader *Header;
@@ -126,11 +115,11 @@ private:
    void* PixelData;
    
    /// \brief Area length to receive the pixels
-   size_t lgrTotaleRaw;
+   size_t ImageDataSizeRaw;
    
    /// \brief Area length to receive the RGB pixels
    /// from Grey Plane + Palette Color  
-   size_t lgrTotale; 
+   size_t ImageDataSize;
        
   /// \brief ==1  if GetImageDataRaw was used
   ///        ==0  if GetImageData    was used
@@ -139,9 +128,6 @@ private:
 
    /// wether already parsed 
    int Parsed;
-   
-   /// To avoid file overwrite              
-   std::string OrigFileName;    
 };
 
 //-----------------------------------------------------------------------------