-// gdcmFile.h
+/*=========================================================================
+
+ Program: gdcm
+ Module: $RCSfile: gdcmFile.h,v $
+ Language: C++
+ Date: $Date: 2005/01/20 16:17:00 $
+ Version: $Revision: 1.96 $
+
+ 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.html 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"
+#include <iostream>
+#include "gdcmBase.h"
-/*
- * In addition to Dicom header exploration, this class is designed
+namespace gdcm
+{
+class Header;
+class ValEntry;
+class BinEntry;
+class PixelReadConvert;
+class PixelWriteConvert;
+class DocEntryArchive;
+//-----------------------------------------------------------------------------
+/**
+ * \brief 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.
+ * write Dicom/ACR-NEMA/RAW files.
*/
-class GDCM_EXPORT gdcmFile
+class GDCM_EXPORT FileHelper : public Base
{
-private:
- gdcmHeader *Header; // Header to use to load the file
- bool SelfHeader;
+public:
+ enum FileMode
+ {
+ WMODE_RAW,
+ WMODE_RGB
+ };
+
+public:
+ FileHelper( );
+ FileHelper( Header *header );
+ FileHelper( std::string const &filename );
+
+ virtual ~FileHelper();
- 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
+ void Print(std::ostream &os = std::cout, std::string const & indent = "");
- 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);
-
- 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)
+ /// Accessor to \ref Header
+ Header *GetHeader() { return HeaderInternal; }
+
+ size_t GetImageDataSize();
+ size_t GetImageDataRawSize();
+
+ uint8_t *GetImageData();
+ uint8_t *GetImageDataRaw();
+ size_t GetImageDataIntoVector(void *destination, size_t maxSize);
+
+ void SetImageData(uint8_t *data, size_t expectedSize);
+
+ // User datas
+ void SetUserData(uint8_t *data, size_t expectedSize);
+ uint8_t* GetUserData();
+ size_t GetUserDataSize();
+ // RBG datas (from file
+ uint8_t* GetRGBData();
+ size_t GetRGBDataSize();
+ // RAW datas (from file
+ uint8_t* GetRawData();
+ size_t GetRawDataSize();
+
+ // 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);
+ bool Write (std::string const &fileName);
+
+ bool SetEntry(std::string const &content,
+ uint16_t group, uint16_t elem);
+ bool SetEntry(uint8_t *content, int lgth,
+ uint16_t group, uint16_t elem);
+ bool ReplaceOrCreate(std::string const &content,
+ uint16_t group, uint16_t elem);
+ bool ReplaceOrCreate(uint8_t *binArea, int lgth,
+ uint16_t group, uint16_t elem);
+
+ uint8_t* GetLutRGBA();
-// For Run Length Encoding (TOCHECK)
- bool gdcm_read_RLE_file (FILE *fp,void * image_buffer);
+ // Write mode
+ void SetWriteModeToRaw() { SetWriteMode(WMODE_RAW); };
+ void SetWriteModeToRGB() { SetWriteMode(WMODE_RGB); };
+ void SetWriteMode(FileMode mode) { WriteMode = mode; };
+ FileMode GetWriteMode() { return WriteMode; };
+
+ // Write format
+ void SetWriteTypeToDcmImplVR() { SetWriteType(ImplicitVR); };
+ void SetWriteTypeToDcmExplVR() { SetWriteType(ExplicitVR); };
+ void SetWriteTypeToAcr() { SetWriteType(ACR); };
+ void SetWriteTypeToAcrLibido() { SetWriteType(ACR_LIBIDO); };
+ void SetWriteType(FileType format) { WriteType = format; };
+ FileType GetWriteType() { return WriteType; };
protected:
- bool WriteBase(std::string FileName, FileType type);
+ bool CheckWriteIntegrity();
-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
-
- // 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 ?
- // 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
-
- 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);
+ void SetWriteToRaw();
+ void SetWriteToRGB();
+ void RestoreWrite();
+
+ void SetWriteFileTypeToACR();
+ void SetWriteFileTypeToExplicitVR();
+ void SetWriteFileTypeToImplicitVR();
+ void RestoreWriteFileType();
+
+ void SetWriteToLibido();
+ void SetWriteToNoLibido();
+ void RestoreWriteOfLibido();
+
+ ValEntry *CopyValEntry(uint16_t group,uint16_t elem);
+ BinEntry *CopyBinEntry(uint16_t group,uint16_t elem);
+
+private:
+ void Initialise();
+
+ uint8_t *GetRaw();
+
+// members variables:
+ /// Header to use to load the file
+ Header *HeaderInternal;
+
+ /// \brief Whether the underlying \ref Header was loaded by
+ /// the constructor or passed to the constructor. When false
+ /// the destructor is in charge of deletion.
+ bool SelfHeader;
- bool ParsePixelData(void);
+ /// Wether already parsed or not
+ bool Parsed;
+
+ /// Utility pixel converter
+ PixelReadConvert *PixelReadConverter;
+ PixelWriteConvert *PixelWriteConverter;
+
+ // Utility header archive
+ DocEntryArchive *Archive;
+
+ // Write variables
+ FileMode WriteMode;
+ FileType WriteType;
};
+} // end namespace gdcm
+//-----------------------------------------------------------------------------
#endif