Clean up with JPR. Frog

[gdcm.git] / src / gdcmFile.h

diff --git a/src/gdcmFile.h b/src/gdcmFile.h
index d9a5f3d1ef30f0ee21613fe4f8f21d11045ace32..b81587600ed500b90f84b91217bed357c4ca7bc8 100644 (file)
--- a/src/gdcmFile.h
+++ b/src/gdcmFile.h
@@ -10,41 +10,19 @@
 // In addition to Dicom header exploration, this class is designed
 // for accessing the image/volume content. One can also use it to
 // write Dicom files.
-////// QUESTION: this looks still like an open question whether the
-//////           relationship between a gdcmFile and gdcmHeader is of
-//////           type IS_A or HAS_A !
 
 class GDCM_EXPORT gdcmFile: public gdcmHeader
 {
 private:
-       // QUESTION :
-       // Data pointe sur quoi?
-       // sur les Pixels lus?
-       // --> j'ajoute un champ public : Pixels
-       // (il faudra que l'utilisateur puisse modifier les pixels ?)
-       
-       void* Data;
+       void* PixelData;
+       size_t lgrTotale;
        int Parsed;          // weather allready parsed
        string OrigFileName; // To avoid file overwrite
+   void SwapZone(void* im, int swap, int lgr, int nb);
+   bool ReadPixelData(void * destination);
 protected:
    int WriteBase(string FileName, FileType type);
 public:
-       // je ne suis pas sur d'avoir compris *où* il serait légitime de ranger ca.
-       // on pourra tjs le deplacer, et mettre des accesseurs
-       void * Pixels;
-       size_t lgrTotale;
-       
-       // Constructor dedicated to writing a new DICOMV3 part10 compliant
-       // file (see SetFileName, SetDcmTag and Write)
-       // TODO Swig gdcmFile();
-       // Opens (in read only and when possible) an existing file and checks
-       // for DICOM compliance. Returns NULL on failure.
-       // Note: the in-memory representation of all available tags found in
-       //    the DICOM header is post-poned to first header information access.
-       //    This avoid a double parsing of public part of the header when
-       //    one sets an a posteriori shadow dictionary (efficiency can be
-       //    seen as a side effect).
-       
        gdcmFile(string & filename);
        gdcmFile(const char * filename);
        
@@ -57,29 +35,27 @@ public:
        // from the constructor's one (no overwriting allowed).
        // TODO Swig int SetFileName(string filename);
 
-       // Allocates necessary memory, copies the data (image[s]/volume[s]) to
-       // newly allocated zone and return a pointer to it:
-       
-        void * GetImageData();
-       
+   void SetPixelDataSizeFromHeader(void);
        // Returns size (in bytes) of required memory to contain data
        // represented in this file.
-       
        size_t GetImageDataSize();
        
+       // Allocates necessary memory, copies the data (image[s]/volume[s]) to
+       // newly allocated zone and return a pointer to it:
+        void * GetImageData();
+       
        // Copies (at most MaxSize bytes) of data to caller's memory space.
        // Returns an error code on failure (if MaxSize is not big enough)
-       
-       int GetImageDataIntoVector(void* destination, size_t MaxSize );
+       size_t GetImageDataIntoVector(void* destination, size_t MaxSize );
        
        // Allocates ExpectedSize bytes of memory at this->Data and copies the
-       // pointed data to it.
-       
-       // Question :
-       // Pourquoi dupliquer les pixels, alors qu'on les a deja en mémoire,
-       // et que Data (dans le gdcmHeader) est un pointeur ?
-       
+       // 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
        int 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);
        void SetImageDataSize (size_t ExpectedSize);
        
        // Push to disk.