X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmFile.h;h=7fd947fb16ea947a2aecfd31b778f4a25d43e91a;hb=5bf7c51796867388334836847a6874640bc83f89;hp=9fc32baed090dbfc5dfb690aa5d77036b44a932f;hpb=2fde1103e77a2448cce41d061781d0ec89ef239b;p=gdcm.git diff --git a/src/gdcmFile.h b/src/gdcmFile.h index 9fc32bae..7fd947fb 100644 --- a/src/gdcmFile.h +++ b/src/gdcmFile.h @@ -1,94 +1,193 @@ -// gdcmFile.h +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmFile.h,v $ + Language: C++ + Date: $Date: 2004/10/20 14:30:40 $ + Version: $Revision: 1.64 $ + + 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" -//////////////////////////////////////////////////////////////////////////// -// 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. +namespace gdcm +{ -class GDCM_EXPORT gdcmFile +//----------------------------------------------------------------------------- +/* + * 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: + File( Header* header ); + File( std::string const& filename ); + + virtual ~File(); + + /// Accessor to \ref Header + Header* GetHeader() { return HeaderInternal; } + + int ComputeDecompressedPixelDataSizeFromHeader(); + + /// Accessor to \ref ImageDataSize + size_t GetImageDataSize(){ return ImageDataSize; }; + + /// Accessor to \ref ImageDataSizeRaw + size_t GetImageDataSizeRaw(){ return ImageDataSizeRaw; }; + + /// Accessor to \ref PixelConverter + PixelConvert* GetPixelConverter(){ return PixelConverter; }; + + uint8_t* GetImageData(); + size_t GetImageDataIntoVector(void* destination, size_t maxSize); + uint8_t* GetImageDataRaw(); + void GetImageDataIntoVectorRaw(void* destination, size_t maxSize); + + // see also Header::SetImageDataSize ?!? + bool SetImageData (uint8_t* 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); + + virtual bool SetEntryByNumber(std::string const& content, + uint16_t group, uint16_t element) + { + HeaderInternal->SetEntryByNumber(content,group,element); + return true; + } + uint8_t* GetLutRGBA(); + +protected: + bool WriteBase(std::string const& fileName, FileType type); + private: - gdcmHeader *Header; // Header to use to load the file + void Initialise(); + + // For JPEG 8 Bits, body in file gdcmJpeg.cxx + bool gdcm_write_JPEG_file (FILE* fp, void* image_buffer, + int image_width, int image_heigh, + int quality); + + // For JPEG 12 Bits, body in file gdcmJpeg12.cxx + bool gdcm_write_JPEG_file12 (FILE* fp, void* image_buffer, + int image_width, int image_height, + int quality); + + void SaveInitialValues(); // will belong to the future PixelData class + void RestoreInitialValues(); // will belong to the future PixelData class + void DeleteInitialValues(); // will belong to the future PixelData class + +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; + + /// Wether already parsed or not + bool Parsed; + + /// Utility pixel converter + PixelConvert* PixelConverter; - 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 +/// FIXME +// --------------- Will be moved to a PixelData class +// - int Parsed; // weather already parsed - std::string OrigFileName; // To avoid file overwrite - void SwapZone(void* im, int swap, int lgr, int nb); + /// \brief to hold the Pixels (when read) + uint8_t* Pixel_Data; // (was PixelData) - bool ReadPixelData(void * destination); + /// \brief Size (in bytes) of required memory to hold the Gray Level pixels + /// represented in this file. This is used when the user DOESN'T want + /// the RGB pixels image when it's stored as a PALETTE COLOR image + size_t ImageDataSizeRaw; - 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) + /// \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; + + /// \brief ==1 if GetImageDataRaw was used + /// ==0 if GetImageData was used + /// ==-1 if ImageData never read + int PixelRead; -// For Run Length Encoding (TOCHECK) - bool gdcm_read_RLE_file (FILE *fp,void * image_buffer); + /// \brief length of the last allocated area devoided to receive Pixels + /// ( to allow us not to (free + new) if un necessary ) + size_t LastAllocatedPixelDataLength; + // Initial values of some fields that can be modified during reading process + // if user asked to transform gray level + LUT image into RGB image -protected: - int WriteBase(std::string FileName, FileType type); + /// \brief Samples Per Pixel (0x0028,0x0002), as found on disk + std::string InitialSpp; + /// \brief Photometric Interpretation (0x0028,0x0004), as found on disk + std::string InitialPhotInt; + /// \brief Planar Configuration (0x0028,0x0006), as found on disk + std::string InitialPlanConfig; + + // Initial values of some fields that can be modified during reading process + // if the image was a 'strange' ACR-NEMA + // (Bits Allocated=12, High Bit not equal to Bits stored +1) + /// \brief Bits Allocated (0x0028,0x0100), as found on disk + std::string InitialBitsAllocated; + /// \brief High Bit (0x0028,0x0102), as found on disk + std::string InitialHighBit; + + // some DocEntry that can be moved out of the H table during reading process + // if user asked to transform gray level + LUT image into RGB image + // We keep a pointer on them for a future use. + + /// \brief Red Palette Color Lookup Table Descriptor 0028 1101 as read + DocEntry* InitialRedLUTDescr; + /// \brief Green Palette Color Lookup Table Descriptor 0028 1102 as read + DocEntry* InitialGreenLUTDescr; + /// \brief Blue Palette Color Lookup Table Descriptor 0028 1103 as read + DocEntry* InitialBlueLUTDescr; + + /// \brief Red Palette Color Lookup Table Data 0028 1201 as read + DocEntry* InitialRedLUTData; + /// \brief Green Palette Color Lookup Table Data 0028 1202 as read + DocEntry* InitialGreenLUTData; + /// \brief Blue Palette Color Lookup Table Data 0028 1203 as read + DocEntry* InitialBlueLUTData; + +// +// --------------- end of future PixelData class +// -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); - - bool ParsePixelData(void); }; +} // end namespace gdcm +//----------------------------------------------------------------------------- #endif