]> Creatis software - gdcm.git/blob - src/gdcmFile.h
* ENH : Add the functions gdcmFile::GetImageDataRaw
[gdcm.git] / src / gdcmFile.h
1 // gdcmFile.h
2
3 #ifndef GDCMFILE_H
4 #define GDCMFILE_H
5
6 #include "gdcmCommon.h"
7 #include "gdcmHeader.h"
8
9 ////////////////////////////////////////////////////////////////////////////
10 // In addition to Dicom header exploration, this class is designed
11 // for accessing the image/volume content. One can also use it to
12 // write Dicom files.
13
14 class GDCM_EXPORT gdcmFile: public gdcmHeader
15 {
16 private:
17    void* PixelData;
18    size_t lgrTotaleRaw;  // Area length to receive the pixels
19    size_t lgrTotale;     // Area length to receive the RGB pixels
20                          // from Grey Plane + Palette Color
21
22    int Parsed;               // weather already parsed
23    std::string OrigFileName; // To avoid file overwrite
24    void SwapZone(void* im, int swap, int lgr, int nb);
25    
26    bool ReadPixelData(void * destination);
27    
28    int gdcm_read_JPEG_file     (void * image_buffer); // For JPEG 8 Bits
29    int gdcm_read_JPEG_file12   (void * image_buffer); // For JPEG 12 Bits
30    int gdcm_read_JPEG2000_file (void * image_buffer); // For JPEG 2000 (TODO)
31
32 // For Run Length Encoding (TOCHECK)
33    int gdcm_read_RLE_file      (void * image_buffer); 
34
35      
36 protected:
37    int WriteBase(std::string FileName, FileType type);
38 public:
39    gdcmFile(std::string & filename);
40    gdcmFile(const char * filename);
41         
42         // For promotion (performs a deepcopy of pointed header object)
43         // TODO Swig gdcmFile(gdcmHeader* header);
44         // TODO Swig ~gdcmFile();
45
46         // On writing purposes. When instance was created through
47         // gdcmFile(std::string filename) then the filename argument MUST be
48         // different from the constructor's one (no overwriting allowed).
49         // TODO Swig int SetFileName(std::string filename);
50
51    void   SetPixelDataSizeFromHeader(void);
52    size_t GetImageDataSize();
53    void * GetImageData();
54    size_t GetImageDataIntoVector(void* destination, size_t MaxSize);
55    void * GetImageDataRaw();
56    size_t GetImageDataIntoVectorRaw(void* destination, size_t MaxSize);
57         
58       // Allocates ExpectedSize bytes of memory at this->Data and copies the
59       // pointed data to it. Copying the image might look useless but
60       // the caller might destroy it's image (without knowing it: think
61       // of a complicated interface where display is done with a library
62       // e.g. VTK) before calling the Write
63    int SetImageData     (void * Data, size_t ExpectedSize);
64       // When the caller is aware we simply point to the data:
65       // TODO int SetImageDataNoCopy (void * Data, size_t ExpectedSize);
66    void SetImageDataSize (size_t ExpectedSize);
67         
68         // Push to disk.
69         // A NE PAS OUBLIER : que fait-on en cas de Transfert Syntax (dans l'entete)
70         // incohérente avec l'ordre des octets en mémoire ? 
71         // TODO Swig int Write();
72         
73         // Ecrit sur disque les pixels d'UNE image
74         // Aucun test n'est fait sur l'"Endiannerie" du processeur.
75         // Ca sera à l'utilisateur d'appeler son Reader correctement
76                 
77    int WriteRawData  (std::string fileName);
78    int WriteDcmImplVR(std::string fileName);
79    int WriteDcmImplVR(const char * fileName);
80    int WriteDcmExplVR(std::string fileName);
81    int WriteAcr      (std::string fileName);
82    
83    bool ParsePixelData(void);
84 };
85
86 #endif