X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmFile.h;h=a229157f442de84769f8eb1387effe7e590aa53a;hb=7815fe9dc3532b716dc478ca0f255263f99d296f;hp=da6ce949ba08d3ac1973821a9b5eb5e500f296d5;hpb=c11dce1faf0053eb984aed57f01e6b7d29cbd1ab;p=gdcm.git diff --git a/src/gdcmFile.h b/src/gdcmFile.h index da6ce949..a229157f 100644 --- a/src/gdcmFile.h +++ b/src/gdcmFile.h @@ -1,5 +1,21 @@ -// 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 @@ -15,69 +31,56 @@ class GDCM_EXPORT gdcmFile { public: - gdcmFile(gdcmHeader *header); - gdcmFile(std::string & filename, - bool exception_on_error = false, - bool enable_sequences = false, - bool skip_shadow = false); + gdcmFile( gdcmHeader *header ); + gdcmFile( std::string const & filename ); - gdcmFile(const char * filename, - bool exception_on_error = false, - bool enable_sequences = false, - bool skip_shadow = false); - - virtual ~gdcmFile(void); - - gdcmHeader *GetHeader(void); - - // For promotion (performs a deepcopy of pointed header object) - // TODO Swig gdcmFile(gdcmHeader* header); - // TODO Swig ~gdcmFile(); + virtual ~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); + /// Accessor to \ref Header + gdcmHeader* GetHeader() { return Header; } - void SetPixelDataSizeFromHeader(void); + void SetPixelDataSizeFromHeader(); size_t GetImageDataSize(); size_t GetImageDataSizeRaw(); void * GetImageData(); - size_t GetImageDataIntoVector(void* destination, size_t MaxSize); + 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 + 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(); - + // 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 fileName); - bool WriteDcmImplVR(std::string fileName); - bool WriteDcmImplVR(const char * fileName); - bool WriteDcmExplVR(std::string fileName); - bool WriteAcr (std::string fileName); - - // Body in file gdcmParse.cxx - bool ParsePixelData(void); + 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 FileName, FileType type); + bool WriteBase(std::string const & fileName, FileType type); private: void SwapZone(void* im, int swap, int lgr, int nb); @@ -85,41 +88,46 @@ private: bool ReadPixelData(void * destination); // For JPEG 8 Bits, body in file gdcmJpeg.cxx - bool gdcm_read_JPEG_file (FILE *fp,void * image_buffer); + bool gdcm_read_JPEG_file (FILE *fp, void * image_buffer); static int gdcm_read_RLE_fragment(char **areaToRead, long lengthToDecode, - long uncompressedSegmentSize,FILE *fp); + long uncompressedSegmentSize, FILE *fp); + // For JPEG 12 Bits, body in file gdcmJpeg12.cxx - bool gdcm_read_JPEG_file12 (FILE *fp,void * image_buffer); + bool gdcm_read_JPEG_file12 (FILE *fp, void* image_buffer); + // For JPEG 2000, body in file gdcmJpeg2000.cxx - bool gdcm_read_JPEG2000_file (FILE *fp,void * image_buffer); + bool gdcm_read_JPEG2000_file (FILE *fp, void* image_buffer); // For Run Length Encoding (TOCHECK) - bool gdcm_read_RLE_file (FILE *fp,void * image_buffer); + bool gdcm_read_RLE_file (FILE *fp, void* image_buffer); -// Variables - /// Header to use to load the file - gdcmHeader *Header; +// 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; - /// Area length to receive the pixels - size_t lgrTotaleRaw; + /// \brief Area length to receive the pixels + size_t ImageDataSizeRaw; - /// Area length to receive the RGB pixels + /// \brief Area length to receive the RGB pixels /// from Grey Plane + Palette Color - size_t lgrTotale; + size_t ImageDataSize; - /// ==1 if GetImageDataRaw was used - /// ==0 if GetImageData was used - /// ==-1 if ImageData never read + /// \brief ==1 if GetImageDataRaw was used + /// ==0 if GetImageData was used + /// ==-1 if ImageData never read int PixelRead; - /// weather already parsed + /// wether already parsed int Parsed; - - /// To avoid file overwrite - std::string OrigFileName; }; //-----------------------------------------------------------------------------