X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmFileHelper.h;h=de75a809a0de89e285a799ec2ae4120154f70743;hb=725267b12a1928251820ad7a3fc363de5fcdf8dc;hp=7c55cb41c7c036c69f6d5c9f2c8ce29173c78a80;hpb=96cc99e8e141ceaf026104699c3273ad5fc88a1f;p=gdcm.git diff --git a/src/gdcmFileHelper.h b/src/gdcmFileHelper.h index 7c55cb41..de75a809 100644 --- a/src/gdcmFileHelper.h +++ b/src/gdcmFileHelper.h @@ -3,8 +3,8 @@ Program: gdcm Module: $RCSfile: gdcmFileHelper.h,v $ Language: C++ - Date: $Date: 2005/02/03 10:03:07 $ - Version: $Revision: 1.9 $ + Date: $Date: 2006/03/01 15:32:52 $ + Version: $Revision: 1.40 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -19,55 +19,65 @@ #ifndef GDCMFILEHELPER_H #define GDCMFILEHELPER_H -#include -#include "gdcmBase.h" +#include "gdcmDebug.h" +#include "gdcmRefCounter.h" + namespace gdcm { class File; -class ValEntry; -class BinEntry; +class DataEntry; class SeqEntry; class PixelReadConvert; class PixelWriteConvert; class DocEntryArchive; + +typedef void (*VOID_FUNCTION_PUINT8_PFILE_POINTER)(uint8_t *, File *); + //----------------------------------------------------------------------------- /** * \brief 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 FileHelper : public Base +class GDCM_EXPORT FileHelper : public RefCounter { + gdcmTypeMacro(FileHelper); + public: enum FileMode { WMODE_RAW, WMODE_RGB }; - -public: - FileHelper( ); - FileHelper( File *header ); - FileHelper( std::string const &filename ); - - virtual ~FileHelper(); +/// \brief Constructs a FileHelper with a RefCounter + static FileHelper *New() {return new FileHelper();} +/// \brief Constructs a FileHelper with a RefCounter from a fileHelper + static FileHelper *New(File *header) {return new FileHelper(header);} + void Print(std::ostream &os = std::cout, std::string const &indent = ""); /// Accessor to \ref File File *GetFile() { return FileInternal; } + + void SetLoadMode(int loadMode); + void SetFileName(std::string const &fileName); + bool Load(); + /// to allow user to modify pixel order (e.g. Mirror, UpsideDown,...) + void SetUserFunction( VOID_FUNCTION_PUINT8_PFILE_POINTER userFunc ) + { UserFunction = userFunc; } // File methods - bool SetValEntry(std::string const &content, - uint16_t group, uint16_t elem); - bool SetBinEntry(uint8_t *content, int lgth, - uint16_t group, uint16_t elem); - - ValEntry *InsertValEntry(std::string const &content, - uint16_t group, uint16_t elem); - BinEntry *InsertBinEntry(uint8_t *binArea, int lgth, + bool SetEntryString(std::string const &content, + uint16_t group, uint16_t elem); + bool SetEntryBinArea(uint8_t *content, int lgth, uint16_t group, uint16_t elem); + + DataEntry *InsertEntryString(std::string const &content, + uint16_t group, uint16_t elem); + DataEntry *InsertEntryBinArea(uint8_t *binArea, int lgth, + uint16_t group, uint16_t elem); SeqEntry *InsertSeqEntry(uint16_t group, uint16_t elem); // File helpers @@ -76,37 +86,58 @@ public: uint8_t *GetImageData(); uint8_t *GetImageDataRaw(); - size_t GetImageDataIntoVector(void *destination, size_t maxSize); + + GDCM_LEGACY(size_t GetImageDataIntoVector(void *destination,size_t maxSize)); void SetImageData(uint8_t *data, size_t expectedSize); // User data void SetUserData(uint8_t *data, size_t expectedSize); - uint8_t* GetUserData(); + uint8_t *GetUserData(); size_t GetUserDataSize(); // RBG data (from file) - uint8_t* GetRGBData(); + uint8_t *GetRGBData(); size_t GetRGBDataSize(); // RAW data (from file) - uint8_t* GetRawData(); + uint8_t *GetRawData(); size_t GetRawDataSize(); // LUT uint8_t* GetLutRGBA(); + int GetLutItemNumber(); + int GetLutItemSize(); // Write mode - void SetWriteModeToRaw() { SetWriteMode(WMODE_RAW); }; - void SetWriteModeToRGB() { SetWriteMode(WMODE_RGB); }; - void SetWriteMode(FileMode mode) { WriteMode = mode; }; - FileMode GetWriteMode() { return WriteMode; }; + + /// \brief Tells the writer we want to keep 'Grey pixels + Palettes color' + /// when possible (as opposed to convert 'Palettes color' to RGB) + void SetWriteModeToRaw() { SetWriteMode(WMODE_RAW); } + /// \brief Tells the writer we want to write RGB image when possible + /// (as opposed to 'Grey pixels + Palettes color') + void SetWriteModeToRGB() { SetWriteMode(WMODE_RGB); } + /// \brief Sets the Write Mode ( ) + void SetWriteMode(FileMode mode) { WriteMode = mode; } + /// \brief Gets the Write Mode ( ) + FileMode GetWriteMode() { return WriteMode; } // Write format - 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; }; + + /// \brief Tells the writer we want to write as Implicit VR + void SetWriteTypeToDcmImplVR() { SetWriteType(ImplicitVR); } + /// \brief Tells the writer we want to write as Explicit VR + void SetWriteTypeToDcmExplVR() { SetWriteType(ExplicitVR); } + /// \brief Tells the writer we want to write as ACR-NEMA + void SetWriteTypeToAcr() { SetWriteType(ACR); } + /// \brief Tells the writer we want to write as LibIDO + void SetWriteTypeToAcrLibido() { SetWriteType(ACR_LIBIDO); } + /// \brief Tells the writer we want to write as JPEG + void SetWriteTypeToJPEG() { SetWriteType(JPEG); } + /// \brief Tells the writer which format we want to write + /// (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO) + void SetWriteType(FileType format) { WriteType = format; } + /// \brief Gets the format we talled the write we wanted to write + /// (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO) + FileType GetWriteType() { return WriteType; } // Write pixels of ONE image on hard drive // No test is made on processor "endianness" @@ -116,8 +147,29 @@ public: bool WriteDcmExplVR(std::string const &fileName); bool WriteAcr (std::string const &fileName); bool Write (std::string const &fileName); - + +/// \brief We have to deal with 4 *very* different cases : +/// -1) user created ex nihilo his own image and wants to write it as a Dicom image. +/// USER_OWN_IMAGE +/// -2) user modified the pixels of an existing image. +/// FILTERED_IMAGE +/// -3) user created a new image, using existing images (eg MIP, MPR, cartography image) +/// CREATED_IMAGE +/// -4) user modified/added some tags *without processing* the pixels (anonymization... +/// UNMODIFIED_PIXELS_IMAGE + + void SetContentType (ImageContentType c) { ContentType = c; } + // no GetContentType() method, on purpose! + + void CallStartMethod(); + void CallProgressMethod(); + void CallEndMethod(); + protected: + FileHelper( ); + FileHelper( File *header ); + ~FileHelper(); + bool CheckWriteIntegrity(); void SetWriteToRaw(); @@ -125,6 +177,7 @@ protected: void RestoreWrite(); void SetWriteFileTypeToACR(); + void SetWriteFileTypeToJPEG(); void SetWriteFileTypeToExplicitVR(); void SetWriteFileTypeToImplicitVR(); void RestoreWriteFileType(); @@ -133,8 +186,13 @@ protected: void SetWriteToNoLibido(); void RestoreWriteOfLibido(); - ValEntry *CopyValEntry(uint16_t group, uint16_t elem); - BinEntry *CopyBinEntry(uint16_t group, uint16_t elem); + DataEntry *CopyDataEntry(uint16_t group, uint16_t elem, + const TagName &vr = GDCM_VRUNKNOWN); + void CheckMandatoryElements(); + void CheckMandatoryEntry(uint16_t group, uint16_t elem, std::string value); + void SetMandatoryEntry(uint16_t group, uint16_t elem, std::string value); + void CopyMandatoryEntry(uint16_t group, uint16_t elem, std::string value); + void RestoreWriteMandatory(); private: void Initialize(); @@ -142,27 +200,51 @@ private: uint8_t *GetRaw(); // members variables: +protected: + /// value of the ??? for any progress bar + float Progress; + mutable bool Abort; + +private: + /// gdcm::File to use to load the file File *FileInternal; - /// \brief Whether the underlying \ref gdcm::File 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 + /// Whether already parsed or not bool Parsed; - /// Utility pixel converter + // Utility pixel converter + /// \brief Pointer to the PixelReadConverter PixelReadConvert *PixelReadConverter; + /// \brief Pointer to the PixelWriteConverter PixelWriteConvert *PixelWriteConverter; // Utility header archive + /// \brief Pointer to the DocEntryArchive (used while writting process) DocEntryArchive *Archive; // Write variables + /// \brief (WMODE_RAW, WMODE_RGB) FileMode WriteMode; + + /// \brief (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO) FileType WriteType; + + /// \brief Pointer to a user supplied function to allow modification + /// of pixel order (e.g. : Mirror, UpsideDown, 90°Rotation, ...) + /// use as : void userSuppliedFunction(uint8_t *im, gdcm::File *f) + /// NB : the "uint8_t *" type of first param is just for prototyping. + /// User will Cast it according what he founds with f->GetPixelType() + /// See vtkgdcmSerieViewer for an example + VOID_FUNCTION_PUINT8_PFILE_POINTER UserFunction; + + /// \brief only user knows what he did before asking the image to be written + /// - he created ex nihilo his own image + /// - he just applied a mathematical process on the pixels + /// - he created a new image, using existing images (eg MIP, MPR,cartography) + /// - he anonymized and image (*no* modif on the pixels) + ImageContentType ContentType; + }; } // end namespace gdcm