-// gdcmFile.h
+/*=========================================================================
+
+ Program: gdcm
+ Module: $RCSfile: gdcmFile.h,v $
+ Language: C++
+ Date: $Date: 2004/08/02 16:42:14 $
+ Version: $Revision: 1.42 $
+
+ 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.
-
+//-----------------------------------------------------------------------------
+/*
+ * 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:
- gdcmHeader *Header; // Header to use to load the file
- bool SelfHeader;
+public:
+ gdcmFile( gdcmHeader *header );
+ gdcmFile( std::string const & filename );
+
+ virtual ~gdcmFile();
- 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
+ /// Accessor to \ref Header
+ gdcmHeader* GetHeader() { return Header; }
+
+ void SetPixelDataSizeFromHeader();
+ 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
+
+ // see also gdcmHeader::SetImageDataSize ?!?
+ bool SetImageData (void * data, size_t expectedSize);
+
+ /// \todo When the caller is aware we simply point to the data:
+ /// int SetImageDataNoCopy (void * Data, size_t ExpectedSize);
+
+ // 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 const & fileName);
+ bool WriteDcmImplVR(std::string const & fileName);
+ bool WriteDcmExplVR(std::string const & fileName);
+ bool WriteAcr (std::string const & fileName);
+
+ // Don't look any longer for the code :
+ // It's in file gdcmParsePixels.cxx
+ bool ParsePixelData();
+
+ virtual bool SetEntryByNumber(std::string const & content,
+ uint16_t group, uint16_t element)
+ {
+ Header->SetEntryByNumber(content,group,element);
+ return true;
+ }
+
+protected:
+ bool WriteBase(std::string const & fileName, FileType type);
- int Parsed; // weather already parsed
- std::string OrigFileName; // To avoid file overwrite
+private:
void SwapZone(void* im, int swap, int lgr, int nb);
bool ReadPixelData(void * destination);
- bool gdcm_read_JPEG_file (FILE *fp,void * image_buffer); // For JPEG 8 Bits
- bool gdcm_read_JPEG_file12 (FILE *fp,void * image_buffer); // For JPEG 12 Bits
- bool gdcm_read_JPEG2000_file (FILE *fp,void * image_buffer); // For JPEG 2000 (TODO)
+ // 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 Run Length Encoding (TOCHECK)
- bool gdcm_read_RLE_file (FILE *fp,void * image_buffer);
+ // For JPEG 12 Bits, body in file gdcmJpeg12.cxx
+ bool gdcm_read_JPEG_file12 (FILE *fp, void* image_buffer);
-
-protected:
- int WriteBase(std::string FileName, FileType type);
+ // For JPEG 2000, body in file gdcmJpeg2000.cxx
+ bool gdcm_read_JPEG2000_file (FILE *fp, void* image_buffer);
-public:
- 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(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);
- 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);
-
- // 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);
+ // For Run Length Encoding (TOCHECK)
+ bool gdcm_read_RLE_file (FILE *fp, void* image_buffer);
+
+// members 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;
- bool ParsePixelData(void);
+ /// \brief Area length to receive the pixels
+ size_t ImageDataSizeRaw;
+
+ /// \brief Area length to receive the RGB pixels
+ /// from Grey Plane + Palette Color
+ size_t ImageDataSize;
+
+ /// \brief ==1 if GetImageDataRaw was used
+ /// ==0 if GetImageData was used
+ /// ==-1 if ImageData never read
+ int PixelRead;
+
+ /// wether already parsed
+ int Parsed;
};
+//-----------------------------------------------------------------------------
#endif
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff