Program: gdcm
Module: $RCSfile: gdcmFile.h,v $
Language: C++
- Date: $Date: 2004/06/23 02:13:14 $
- Version: $Revision: 1.33 $
+ 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.htm for details.
+ 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
#include "gdcmCommon.h"
#include "gdcmHeader.h"
+#include "gdcmPixelConvert.h"
+
+namespace gdcm
+{
//-----------------------------------------------------------------------------
/*
* for accessing the image/volume content. One can also use it to
* write Dicom/ACR-NEMA/RAW files.
*/
-class GDCM_EXPORT gdcmFile
+class GDCM_EXPORT File
{
public:
- gdcmFile(gdcmHeader *header);
- gdcmFile(std::string const & filename,
- bool exception_on_error = false,
- bool enable_sequences = false,
- bool skip_shadow = false);
+ File( Header* header );
+ File( std::string const& filename );
- virtual ~gdcmFile(void);
-
- /// \brief returns the gdcmHeader *Header
- inline gdcmHeader *GetHeader(void) {return(Header);};
-
- // 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);
+ virtual ~File();
- // Push to disk.
- // TODO Swig int Write();
+ /// Accessor to \ref Header
+ Header* GetHeader() { return HeaderInternal; }
- // 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);
+ int ComputeDecompressedPixelDataSizeFromHeader();
+
+ /// Accessor to \ref ImageDataSize
+ size_t GetImageDataSize(){ return ImageDataSize; };
- // Body in file gdcmParse.cxx
- bool ParsePixelData(void);
+ /// Accessor to \ref ImageDataSizeRaw
+ size_t GetImageDataSizeRaw(){ return ImageDataSizeRaw; };
- inline virtual bool SetEntryByNumber(std::string content,
- guint16 group, guint16 element)
- { GetHeader()->SetEntryByNumber(content,group,element);
- return true; //default behavior ?
- }
+ /// 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 FileName, FileType type);
+ bool WriteBase(std::string const& fileName, FileType type);
private:
- void SwapZone(void* im, int swap, int lgr, int nb);
-
- bool ReadPixelData(void * destination);
-
+ void Initialise();
+
// For JPEG 8 Bits, body in file gdcmJpeg.cxx
- bool gdcm_read_JPEG_file (FILE *fp,void * image_buffer);
- static int gdcm_read_RLE_fragment(char **areaToRead, long lengthToDecode,
- long uncompressedSegmentSize,FILE *fp);
+ 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_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_write_JPEG_file12 (FILE* fp, void* image_buffer,
+ int image_width, int image_height,
+ int quality);
- // For Run Length Encoding (TOCHECK)
- bool gdcm_read_RLE_file (FILE *fp,void * image_buffer);
+ 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
-// Variables
+private:
+// members variables:
- /// \brief Header to use to load the file
- gdcmHeader *Header;
+ /// Header to use to load the file
+ Header *HeaderInternal;
- /// \brief Whether the underlying \ref gdcmHeader was loaded by
+ /// \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;
+
+/// FIXME
+// --------------- Will be moved to a PixelData class
+//
/// \brief to hold the Pixels (when read)
- void* PixelData;
+ uint8_t* Pixel_Data; // (was PixelData)
- /// \brief Area length to receive the pixels
- size_t lgrTotaleRaw;
+ /// \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;
- /// \brief Area length to receive the RGB pixels
- /// from Grey Plane + Palette Color
- size_t lgrTotale;
+ /// \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;
+ int PixelRead;
+
+ /// \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
+
+ /// \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
+//
- /// weather already parsed
- int Parsed;
-
- /// To avoid file overwrite
- std::string OrigFileName;
};
+} // end namespace gdcm
//-----------------------------------------------------------------------------
#endif
git://git.creatis.insa-lyon.fr / gdcm.git / blobdiff