X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmFile.h;h=11c046db913f98dea214b0a1ec3b95e9b9cf790f;hb=27c61aa23c3f02def28d44dca855e54d9adb25a1;hp=90ec3b85c97507edd3ba31af38363b1737baa6d2;hpb=25efc388a88895fc1ba2b961d5f27488ab3c073c;p=gdcm.git diff --git a/src/gdcmFile.h b/src/gdcmFile.h index 90ec3b85..11c046db 100644 --- a/src/gdcmFile.h +++ b/src/gdcmFile.h @@ -1,101 +1,108 @@ // gdcmFile.h - +//----------------------------------------------------------------------------- #ifndef GDCMFILE_H #define GDCMFILE_H #include "gdcmCommon.h" #include "gdcmHeader.h" -//////////////////////////////////////////////////////////////////////////// -// 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 +//----------------------------------------------------------------------------- +/* + * 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 { -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; - int Parsed; // weather allready parsed - string OrigFileName; // To avoid file overwrite 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(gdcmHeader *header); + gdcmFile(std::string & filename); + gdcmFile(const char * filename); + virtual ~gdcmFile(void); + gdcmHeader *GetHeader(void); + // 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(string filename) then the filename argument MUST be different - // from the constructor's one (no overwriting allowed). - // TODO Swig int SetFileName(string filename); + // 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); - // Allocates necessary memory, copies the data (image[s]/volume[s]) to - // newly allocated zone and return a pointer to it: - - void * GetImageData(); - - // Returns size (in bytes) of required memory to contain data - // represented in this file. - - size_t GetImageDataSize(); - - // 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 ); - - // Question : - // - // GetImageData et GetImageDataIntoVector - // Get et Put pour 2 fonctions qui font presque la meme chose :-( - // - - // 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 ? + void SetPixelDataSizeFromHeader(void); + size_t GetImageDataSize(); + size_t GetImageDataSizeRaw(); + + void * GetImageData(); + size_t GetImageDataIntoVector(void* destination, size_t MaxSize); + void * GetImageDataRaw(); + size_t GetImageDataIntoVectorRaw(void* destination, size_t MaxSize); - // TODO Swig int SetImageData(void * Data, size_t ExpectedSize); + // 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); // Push to disk. // A NE PAS OUBLIER : que fait-on en cas de Transfert Syntax (dans l'entete) - // incohérente avec l'ordre des octets en mémoire + // incohérente avec l'ordre des octets en mémoire ? // TODO Swig int Write(); - // Ecrit sur disque les pixels d'UNE image - // Aucun test n'est fait sur l'"Endiannerie" du processeur. - // Ca sera à l'utilisateur d'appeler son Reader correctement - - int WriteRawData (string nomFichier); - int WriteDcm (string nomFichier); - int WriteAcr (string nomFichier); + // 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 fileName); + bool WriteDcmImplVR(std::string fileName); + bool WriteDcmImplVR(const char * fileName); + bool WriteDcmExplVR(std::string fileName); + bool WriteAcr (std::string fileName); + + // Body in file gdcmParse.cxx + bool ParsePixelData(void); + +protected: + bool WriteBase(std::string FileName, FileType type); + +private: + void SwapZone(void* im, int swap, int lgr, int nb); + + 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) + bool gdcm_read_RLE_file (FILE *fp,void * image_buffer); + +// Variables + gdcmHeader *Header; // Header to use to load the file + bool SelfHeader; + + void* PixelData; + size_t lgrTotaleRaw; // Area length to receive the pixels + size_t lgrTotale; // Area length to receive the RGB pixels + // from Grey Plane + Palette Color + int PixelRead; // ==1 if GetImageDataRaw was used + // ==0 if GetImageData was used + // ==-1 if ImageData never read. + + int Parsed; // weather already parsed + std::string OrigFileName; // To avoid file overwrite }; +//----------------------------------------------------------------------------- #endif