X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;ds=sidebyside;f=src%2FgdcmFile.h;h=02eaae758134333b59e2504e727b01e36c82647f;hb=8da9df62c47908e7b9a67238a6c12b92ba6cae7a;hp=9d2f21855b024c4c1bc6bb7cb2a0cc696bf2174c;hpb=0add622a61a208e9ed5f55b1b48e373b6bf38f39;p=gdcm.git diff --git a/src/gdcmFile.h b/src/gdcmFile.h index 9d2f2185..02eaae75 100644 --- a/src/gdcmFile.h +++ b/src/gdcmFile.h @@ -1,86 +1,180 @@ -// gdcmFile.h +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmFile.h,v $ + Language: C++ + Date: $Date: 2004/11/25 13:12:02 $ + Version: $Revision: 1.77 $ + + 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 "gdcmPixelConvert.h" +#include "gdcmDocEntryArchive.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 +namespace gdcm +{ +//----------------------------------------------------------------------------- +/* + * 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 File { +public: + enum TWriteMode + { + WMODE_NATIVE, + WMODE_DECOMPRESSED, + WMODE_RGB + }; + + enum TWriteType + { + WTYPE_IMPL_VR, + WTYPE_EXPL_VR, + WTYPE_ACR + }; + +public: + File( Header* header ); + File( std::string const& filename ); + + virtual ~File(); + + /// Accessor to \ref Header + Header* GetHeader() { return HeaderInternal; } + + size_t GetImageDataSize(); + size_t GetImageDataRawSize(); + + /// Accessor to \ref PixelConverter + PixelConvert* GetPixelConverter() { return PixelConverter; }; + + uint8_t* GetImageData(); + uint8_t* GetImageDataRaw(); + size_t GetImageDataIntoVector(void* destination, size_t maxSize); + + // see also Header::SetImageDataSize ?!? + bool SetImageData (uint8_t* 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); + bool Write(std::string const& fileName); + + virtual bool SetEntryByNumber(std::string const& content, + uint16_t group, uint16_t element) + { + HeaderInternal->SetEntryByNumber(content,group,element); + return true; + } + uint8_t* GetLutRGBA(); + + // Write mode + void SetWriteModeToNative() { SetWriteMode(WMODE_NATIVE); }; + void SetWriteModeToDecompressed() { SetWriteMode(WMODE_DECOMPRESSED); }; + void SetWriteModeToRGB() { SetWriteMode(WMODE_RGB); }; + void SetWriteMode(unsigned int mode) { WriteMode = mode; }; + unsigned int GetWriteMode() { return WriteMode; }; + + // Write format + void SetWriteTypeToDcmImplVR() { SetWriteType(WTYPE_EXPL_VR); }; + void SetWriteTypeToDcmExplVR() { SetWriteType(WTYPE_EXPL_VR); }; + void SetWriteTypeToAcr() { SetWriteType(WTYPE_ACR); }; + void SetWriteType(unsigned int format) { WriteType = format; }; + unsigned int GetWriteType() { return WriteType; }; + +protected: + bool WriteBase(std::string const& fileName, FileType type); + bool CheckWriteIntegrity(); + + void SetWriteToNative(); + void SetWriteToDecompressed(); + void SetWriteToRGB(); + void RestoreWrite(); + + void SetWriteFileTypeToACR(); + void SetWriteFileTypeToACRLibido(); + void SetWriteFileTypeToExplicitVR(); + void SetWriteFileTypeToImplicitVR(); + void RestoreWriteFileType(); + + void SetWriteToLibido(); + void RestoreWriteFromLibido(); + + ValEntry* CopyValEntry(uint16_t group,uint16_t element); + BinEntry* CopyBinEntry(uint16_t group,uint16_t element); + 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); + void Initialise(); + + uint8_t* GetDecompressed(); + int ComputeDecompressedPixelDataSizeFromHeader(); + + void SetPixelData(uint8_t* data); + +private: +// 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; - 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) + /// Wether already parsed or not + bool Parsed; -// For Run Length Encoding (TOCHECK) - int gdcm_read_RLE_file (void * image_buffer); + /// Utility pixel converter + PixelConvert* PixelConverter; - -protected: - int WriteBase(std::string FileName, FileType type); -public: - gdcmFile(std::string & filename); - gdcmFile(const char * filename); - - // 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(); - 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); - - // 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); + // Utility header archive + DocEntryArchive *Archive; + + // Write variables + unsigned int WriteMode; + unsigned int WriteType; + +/// FIXME +// --------------- Will be moved to a PixelData class +// + + /// \brief to hold the Pixels (when read) + uint8_t* Pixel_Data; // (was PixelData) - bool ParsePixelData(void); + /// \brief Size (in bytes) of requited memory to hold the the pixels + /// of this image in it's RGB convertion either from: + /// - Plane R, Plane G, Plane B + /// - Grey Plane + Palette Color + /// - YBR Pixels (or from RGB Pixels, as well) + size_t ImageDataSize; + +// +// --------------- end of future PixelData class +// + }; +} // end namespace gdcm +//----------------------------------------------------------------------------- #endif