// 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.
-
-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:
- 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:
- gdcmFile(string & filename);
- gdcmFile(const char * filename);
+ gdcmFile(gdcmHeader *header);
+ gdcmFile(std::string & filename,
+ bool exception_on_error = false,
+ bool enable_sequences = false,
+ bool skip_shadow = false);
+
+ gdcmFile(const char * filename,
+ bool exception_on_error = false,
+ bool enable_sequences = false,
+ bool skip_shadow = false);
+
+ 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);
- 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)
- size_t GetImageDataIntoVector(void* destination, size_t MaxSize );
+ 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);
- // 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
- 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);
+ // 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 WriteDcmImplVR(string nomFichier);
- int WriteDcmImplVR(const char * nomFichier);
- int WriteDcmExplVR(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
+ /// Header to use to load the file
+ gdcmHeader *Header;
+ bool SelfHeader;
+
+ void* PixelData;
+
+ /// Area length to receive the pixels
+ size_t lgrTotaleRaw;
+
+ /// Area length to receive the RGB pixels
+ /// from Grey Plane + Palette Color
+ size_t lgrTotale;
+
+ /// ==1 if GetImageDataRaw was used
+ /// ==0 if GetImageData was used
+ /// ==-1 if ImageData never read
+ int PixelRead;
+
+ /// weather already parsed
+ int Parsed;
+
+ /// To avoid file overwrite
+ std::string OrigFileName;
};
+//-----------------------------------------------------------------------------
#endif
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff