Program: gdcm
Module: $RCSfile: gdcmFile.h,v $
Language: C++
- Date: $Date: 2004/11/23 09:13:26 $
- Version: $Revision: 1.72 $
+ Date: $Date: 2005/01/06 20:03:27 $
+ Version: $Revision: 1.91 $
Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
l'Image). All rights reserved. See Doc/License.txt or
#ifndef GDCMFILE_H
#define GDCMFILE_H
-#include "gdcmCommon.h"
-#include "gdcmHeader.h"
-#include "gdcmPixelConvert.h"
-#include "gdcmDocEntryArchive.h"
+#include <iostream>
+#include "gdcmBase.h"
namespace gdcm
{
+class Header;
+class ValEntry;
+class BinEntry;
+class PixelReadConvert;
+class PixelWriteConvert;
+class DocEntryArchive;
//-----------------------------------------------------------------------------
/*
* 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
+class GDCM_EXPORT File : public Base
{
public:
- enum TWriteMode
+ enum FileMode
{
- WMODE_NATIVE,
- WMODE_DECOMPRESSED,
+ WMODE_RAW,
WMODE_RGB
};
- enum TWriteType
- {
- WTYPE_IMPL_VR,
- WTYPE_EXPL_VR,
- WTYPE_ACR
- };
-
public:
- File( Header* header );
- File( std::string const& filename );
+ File( );
+ File( Header *header );
+ File( std::string const &filename );
virtual ~File();
- /// Accessor to \ref Header
- Header* GetHeader() { return HeaderInternal; }
+ void Print(std::ostream &os = std::cout);
- /// Accessor to \ref ImageDataSize
- size_t GetImageDataSize() { return ImageDataSize; };
+ /// Accessor to \ref Header
+ Header *GetHeader() { return HeaderInternal; }
- /// Accessor to \ref ImageDataSizeRaw
- size_t GetImageDataSizeRaw() { return ImageDataSizeRaw; };
+ 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);
- uint8_t* GetImageData();
- size_t GetImageDataIntoVector(void* destination, size_t maxSize);
- uint8_t* GetImageDataRaw();
+ void SetImageData(uint8_t *data, size_t expectedSize);
- // see also Header::SetImageDataSize ?!?
- bool SetImageData (uint8_t* data, size_t expectedSize);
+ // User datas
+ void SetUserData(uint8_t *data, size_t expectedSize);
+ uint8_t* GetUserData();
+ size_t GetUserDataSize();
+ // RBG datas (from file
+ uint8_t* GetRGBData();
+ size_t GetRGBDataSize();
+ // RAW datas (from file
+ uint8_t* GetRawData();
+ size_t GetRawDataSize();
// 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;
- }
+ 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);
+
+ bool SetEntryByNumber(std::string const &content,
+ uint16_t group, uint16_t element);
+ bool SetEntryByNumber(uint8_t *content, int lgth,
+ uint16_t group, uint16_t element);
+ bool ReplaceOrCreateByNumber(std::string const &content,
+ uint16_t group, uint16_t element);
+ bool ReplaceOrCreateByNumber(uint8_t *binArea, int lgth,
+ uint16_t group, uint16_t element);
+
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; };
+ void SetWriteModeToRaw() { SetWriteMode(WMODE_RAW); };
+ void SetWriteModeToRGB() { SetWriteMode(WMODE_RGB); };
+ void SetWriteMode(FileMode mode) { WriteMode = mode; };
+ FileMode 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; };
+ void SetWriteTypeToDcmImplVR() { SetWriteType(ImplicitVR); };
+ void SetWriteTypeToDcmExplVR() { SetWriteType(ExplicitVR); };
+ void SetWriteTypeToAcr() { SetWriteType(ACR); };
+ void SetWriteTypeToAcrLibido() { SetWriteType(ACR_LIBIDO); };
+ void SetWriteType(FileType format) { WriteType = format; };
+ FileType GetWriteType() { return WriteType; };
protected:
- bool WriteBase(std::string const& fileName, FileType type);
+ bool CheckWriteIntegrity();
- void SetToRAW();
- void SetToRGB();
- void Restore();
+ void SetWriteToRaw();
+ void SetWriteToRGB();
+ void RestoreWrite();
- void SetToLibido();
- void RestoreFromLibido();
+ void SetWriteFileTypeToACR();
+ void SetWriteFileTypeToExplicitVR();
+ void SetWriteFileTypeToImplicitVR();
+ void RestoreWriteFileType();
-private:
- void Initialise();
+ void SetWriteToLibido();
+ void SetWriteToNoLibido();
+ void RestoreWriteOfLibido();
- 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
- uint8_t* GetDecompressed();
- int ComputeDecompressedPixelDataSizeFromHeader();
+ ValEntry *CopyValEntry(uint16_t group,uint16_t element);
+ BinEntry *CopyBinEntry(uint16_t group,uint16_t element);
private:
- void SetPixelData(uint8_t* data);
+ void Initialise();
-// members variables:
+ uint8_t *GetRaw();
+// members variables:
/// Header to use to load the file
Header *HeaderInternal;
/// Wether already parsed or not
bool Parsed;
-
+
/// Utility pixel converter
- PixelConvert* PixelConverter;
+ PixelReadConvert *PixelReadConverter;
+ PixelWriteConvert *PixelWriteConverter;
// 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 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 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;
-
- /// \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
-//
-
+ FileMode WriteMode;
+ FileType WriteType;
};
} // end namespace gdcm