X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmFile.h;h=cf48b6d1294a20c89fc8c648336247b5ab210e95;hb=e5e7b1bd7ee84e8f9dc7da5d1d42b598fac68399;hp=fa41817c8be4bbbd7d9d9ef315f40da266c0e109;hpb=45c3270f0afbdb22a10da1fa2c993125ca960304;p=gdcm.git diff --git a/src/gdcmFile.h b/src/gdcmFile.h index fa41817c..cf48b6d1 100644 --- a/src/gdcmFile.h +++ b/src/gdcmFile.h @@ -1,97 +1,175 @@ -// gdcmFile.h +/*========================================================================= + + Program: gdcm + Module: $RCSfile: gdcmFile.h,v $ + Language: C++ + Date: $Date: 2004/11/25 10:24:34 $ + Version: $Revision: 1.76 $ + + 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. -////// QUESTION: this looks still like an open question whether the -////// relationship between a gdcmFile and gdcmHeader is of -////// type IS_A or HAS_A ! - -class GDCM_EXPORT gdcmFile: public gdcmHeader +namespace gdcm { -private: - // QUESTION : - // Data pointe sur quoi? - // sur les Pixels lus? - // --> j'ajoute un champ public : Pixels - // (il faudra que l'utilisateur puisse modifier les pixels ?) - - void* Data; - int Parsed; // weather allready parsed - string OrigFileName; // To avoid file overwrite +//----------------------------------------------------------------------------- +/* + * 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: - // je ne suis pas sur d'avoir compris *où* il serait légitime de ranger ca. - // on pourra tjs le deplacer, et mettre des accesseurs - void * Pixels; - size_t lgrTotale; - - // Constructor dedicated to writing a new DICOMV3 part10 compliant - // file (see SetFileName, SetDcmTag and Write) - // TODO Swig gdcmFile(); - // Opens (in read only and when possible) an existing file and checks - // for DICOM compliance. Returns NULL on failure. - // Note: the in-memory representation of all available tags found in - // the DICOM header is post-poned to first header information access. - // This avoid a double parsing of public part of the header when - // one sets an a posteriori shadow dictionary (efficiency can be - // seen as a side effect). - - gdcmFile(string & 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(string filename) then the filename argument MUST be different - // from the constructor's one (no overwriting allowed). - // TODO Swig int SetFileName(string filename); - - // Allocates necessary memory, copies the data (image[s]/volume[s]) to - // newly allocated zone and return a pointer to it: - - void * GetImageData(); - - // Returns size (in bytes) of required memory to contain data - // represented in this file. - - size_t GetImageDataSize(); - - // Copies (at most MaxSize bytes) of data to caller's memory space. - // Returns an error code on failure (if MaxSize is not big enough) - - int GetImageDataIntoVector(void* destination, size_t MaxSize ); - - // Allocates ExpectedSize bytes of memory at this->Data and copies the - // pointed data to it. - - // Question : - // Pourquoi dupliquer les pixels, alors qu'on les a deja en mémoire, - // et que Data (dans le gdcmHeader) est un pointeur ? - - int SetImageData (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 (string nomFichier); - int WriteDcm (string nomFichier); - int WriteDcmExplVR (string nomFichier); - int WriteAcr (string nomFichier); + 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 SetWriteToLibido(); + void RestoreWriteFromLibido(); + + ValEntry* CopyValEntry(uint16_t group,uint16_t element); + BinEntry* CopyBinEntry(uint16_t group,uint16_t element); + +private: + 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; + + /// Wether already parsed or not + bool Parsed; + + /// Utility pixel converter + PixelConvert* PixelConverter; + + // 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) + + /// \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