-// gdcmFile.h
+/*=========================================================================
+
+ Program: gdcm
+ Module: $RCSfile: gdcmFile.h,v $
+ Language: C++
+ Date: $Date: 2004/06/20 18:08:47 $
+ Version: $Revision: 1.30 $
+
+ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
+ l'Image). All rights reserved. See Doc/License.txt or
+ http://www.creatis.insa-lyon.fr/Public/Gdcm/License.htm for details.
+
+ This software is distributed WITHOUT ANY WARRANTY; without even
+ the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ PURPOSE. See the above copyright notices for more information.
+
+=========================================================================*/
#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 lgrTotaleRaw; // Area length to receive the pixels
- size_t lgrTotale; // Area length to receive the RGB pixels
- // from Grey Plane + Palette Color
-
- int Parsed; // weather already parsed
- std::string OrigFileName; // To avoid file overwrite
- void SwapZone(void* im, int swap, int lgr, int nb);
-
- bool ReadPixelData(void * destination);
-
- int gdcm_read_JPEG_file (void * image_buffer); // For JPEG 8 Bits
- int gdcm_read_JPEG_file12 (void * image_buffer); // For JPEG 12 Bits
- int gdcm_read_JPEG2000_file (void * image_buffer); // For JPEG 2000 (TODO)
-
-// For Run Length Encoding (TOCHECK)
- int gdcm_read_RLE_file (void * image_buffer);
-
-
-protected:
- int WriteBase(std::string FileName, FileType type);
public:
- gdcmFile(std::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();
void SetPixelDataSizeFromHeader(void);
size_t GetImageDataSize();
size_t GetImageDataSizeRaw();
+
void * GetImageData();
size_t GetImageDataIntoVector(void* destination, size_t MaxSize);
void * GetImageDataRaw();
// 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);
+
+ // 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);
- void SetImageDataSize (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 ?
// 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 (std::string fileName);
- int WriteDcmImplVR(std::string fileName);
- int WriteDcmImplVR(const char * fileName);
- int WriteDcmExplVR(std::string fileName);
- int WriteAcr (std::string fileName);
-
+ // 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);
+
+ inline virtual bool SetEntryByNumber(std::string content,
+ guint16 group, guint16 element)
+ { GetHeader()->SetEntryByNumber(content,group,element); }
+
+
+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
+
+ /// \brief Header to use to load the file
+ gdcmHeader *Header;
+
+ /// \brief Whether the underlying \ref gdcmHeader was loaded by
+ /// the constructor or passed to the constructor. When false
+ /// the destructor is in charge of deletion.
+ bool SelfHeader;
+
+ /// \brief to hold the Pixels (when read)
+ void* PixelData;
+
+ /// \brief Area length to receive the pixels
+ size_t lgrTotaleRaw;
+
+ /// \brief Area length to receive the RGB pixels
+ /// from Grey Plane + Palette Color
+ size_t lgrTotale;
+
+ /// \brief ==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