X-Git-Url: https://git.creatis.insa-lyon.fr/pubgit/?a=blobdiff_plain;f=src%2FgdcmFileHelper.h;h=d761add27ba31d6323ed31abceb773991c26cb0f;hb=f2dd0107ba49eda3386b34715cdc0c046d12397f;hp=1c1d0d8d07b4e60aa5b83d840e1668163ee77a2b;hpb=bc69950a406d06c50f0fb75a96572784965cb534;p=gdcm.git diff --git a/src/gdcmFileHelper.h b/src/gdcmFileHelper.h index 1c1d0d8d..d761add2 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/10/18 08:35:50 $ - Version: $Revision: 1.23 $ + Date: $Date: 2007/09/17 12:16:01 $ + Version: $Revision: 1.55 $ Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de l'Image). All rights reserved. See Doc/License.txt or @@ -16,18 +16,17 @@ =========================================================================*/ -#ifndef GDCMFILEHELPER_H -#define GDCMFILEHELPER_H +#ifndef _GDCMFILEHELPER_H_ +#define _GDCMFILEHELPER_H_ #include "gdcmDebug.h" -#include "gdcmBase.h" -//#include +#include "gdcmRefCounter.h" +#include "gdcmVRKey.h" +#include "gdcmFile.h" - - -namespace gdcm +namespace GDCM_NAME_SPACE { -class File; +//class File; class DataEntry; class SeqEntry; class PixelReadConvert; @@ -42,32 +41,35 @@ typedef void (*VOID_FUNCTION_PUINT8_PFILE_POINTER)(uint8_t *, File *); * 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 ); - GDCM_LEGACY(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 + /// Accessor to File File *GetFile() { return FileInternal; } - + /// \brief Tells gdcm wether we want to keep ACR-NEMA-like overlays or not. + void SetKeepOverlays(bool k) { KeepOverlays =k; } + bool GetKeepOverlays( ) { return KeepOverlays; } + void SetLoadMode(int loadMode); void SetFileName(std::string const &fileName); bool Load(); - /// to allow user to modify pixel order (e.g. Mirror, TopDown,...) + /// to allow user to modify pixel order (e.g. Mirror, UpsideDown,...) void SetUserFunction( VOID_FUNCTION_PUINT8_PFILE_POINTER userFunc ) { UserFunction = userFunc; } // File methods @@ -77,9 +79,9 @@ public: uint16_t group, uint16_t elem); DataEntry *InsertEntryString(std::string const &content, - uint16_t group, uint16_t elem); + uint16_t group, uint16_t elem, const VRKey &vr); DataEntry *InsertEntryBinArea(uint8_t *binArea, int lgth, - uint16_t group, uint16_t elem); + uint16_t group, uint16_t elem, const VRKey &vr); SeqEntry *InsertSeqEntry(uint16_t group, uint16_t elem); // File helpers @@ -89,7 +91,7 @@ public: uint8_t *GetImageData(); uint8_t *GetImageDataRaw(); - GDCM_LEGACY(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); @@ -104,6 +106,8 @@ public: uint8_t *GetRawData(); size_t GetRawDataSize(); + void ConvertFixGreyLevels(uint8_t *data, size_t size); + // LUT uint8_t* GetLutRGBA(); int GetLutItemNumber(); @@ -132,12 +136,25 @@ public: 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 we want to write as JPEG2000 + void SetWriteTypeToJPEG2000() { SetWriteType(JPEG2000); } /// \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) + /// (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO) FileType GetWriteType() { return WriteType; } + /// \brief 1 : white=0, black=high value + void SetPhotometricInterpretationToMonochrome1() { + PhotometricInterpretation = 1;} + /// \brief 2 : black=0, white=high value (default) + void SetPhotometricInterpretationToMonochrome2() { + PhotometricInterpretation = 2;} + /// \brief 1 : white=0, black=high value + int GetPhotometricInterpretation() { + return PhotometricInterpretation; } // Write pixels of ONE image on hard drive // No test is made on processor "endianness" @@ -147,8 +164,31 @@ 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(); + + /// \todo move all those 'protected' methods to 'private' + /// since FileHelper is not derived in anything! bool CheckWriteIntegrity(); void SetWriteToRaw(); @@ -156,6 +196,8 @@ protected: void RestoreWrite(); void SetWriteFileTypeToACR(); + void SetWriteFileTypeToJPEG(); + void SetWriteFileTypeToJPEG2000(); void SetWriteFileTypeToExplicitVR(); void SetWriteFileTypeToImplicitVR(); void RestoreWriteFileType(); @@ -165,11 +207,14 @@ protected: void RestoreWriteOfLibido(); DataEntry *CopyDataEntry(uint16_t group, uint16_t elem, - const TagName &vr = GDCM_UNKNOWN); + const VRKey &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 CheckMandatoryEntry(uint16_t group, uint16_t elem, std::string value, + const VRKey &vr = GDCM_VRUNKNOWN); + void SetMandatoryEntry(uint16_t group, uint16_t elem, std::string value, + const VRKey &vr = GDCM_VRUNKNOWN); + void CopyMandatoryEntry(uint16_t group, uint16_t elem, std::string value, + const VRKey &vr = GDCM_VRUNKNOWN); void RestoreWriteMandatory(); private: @@ -178,20 +223,24 @@ 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; - /// Whether already parsed or not bool Parsed; // Utility pixel converter + /// \brief Pointer to the PixelReadConverter PixelReadConvert *PixelReadConverter; + /// \brief Pointer to the PixelWriteConverter PixelWriteConvert *PixelWriteConverter; @@ -202,15 +251,32 @@ private: // Write variables /// \brief (WMODE_RAW, WMODE_RGB) FileMode WriteMode; + /// \brief (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO) FileType WriteType; - /// Pointer to a user supplied function to allow modification of pixel order - /// (i.e. : Mirror, TopDown, 90°Rotation, ...) + + /// \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; + + /// \brief 1 : white=0, black=high value + /// 2 : black=0, white=high value (default) + int PhotometricInterpretation; + + /// \brief wether we want to keep ACR-NEMA-like overlays or not. + bool KeepOverlays; + }; } // end namespace gdcm