]> Creatis software - gdcm.git/blobdiff - src/gdcmFileHelper.h
Fix mistypings
[gdcm.git] / src / gdcmFileHelper.h
index b5f50adc5c939dc8434aa0b92c4f85087b0d2fab..d761add27ba31d6323ed31abceb773991c26cb0f 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmFileHelper.h,v $
   Language:  C++
-  Date:      $Date: 2005/11/28 16:31:23 $
-  Version:   $Revision: 1.35 $
+  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
                                                                                 
 =========================================================================*/
 
-#ifndef GDCMFILEHELPER_H
-#define GDCMFILEHELPER_H
+#ifndef _GDCMFILEHELPER_H_
+#define _GDCMFILEHELPER_H_
 
 #include "gdcmDebug.h"
 #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;
@@ -50,19 +51,21 @@ public:
       WMODE_RAW,
       WMODE_RGB
    };
-     
-public:
+
 /// \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();
@@ -76,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
@@ -88,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);
 
@@ -103,6 +106,8 @@ public:
    uint8_t *GetRawData();
    size_t GetRawDataSize();
 
+   void ConvertFixGreyLevels(uint8_t *data, size_t size);
+
    // LUT
    uint8_t* GetLutRGBA();
    int GetLutItemNumber();
@@ -131,14 +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   
+   /// \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)
    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"
@@ -148,18 +164,31 @@ public:
    bool WriteDcmExplVR(std::string const &fileName);
    bool WriteAcr      (std::string const &fileName);
    bool Write         (std::string const &fileName);
-   /// \brief if user knows he didn't modify the pixels (e.g. he just anonymized 
-   ///        the file), he is allowed to ask to keep the original
-   ///        'Media Storage SOP Class UID' and 'Image Type'   
-   void SetKeepMediaStorageSOPClassUID (bool v) 
-                              { KeepMediaStorageSOPClassUID = v; }
-   // no GetKeepMediaStorageSOPClassUID() method, on purpose!
+   
+/// \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();
@@ -168,6 +197,7 @@ protected:
 
    void SetWriteFileTypeToACR();
    void SetWriteFileTypeToJPEG();
+   void SetWriteFileTypeToJPEG2000();
    void SetWriteFileTypeToExplicitVR();
    void SetWriteFileTypeToImplicitVR();
    void RestoreWriteFileType();
@@ -177,11 +207,14 @@ protected:
    void RestoreWriteOfLibido();
 
    DataEntry *CopyDataEntry(uint16_t group, uint16_t elem, 
-                               const TagName &vr = GDCM_VRUNKNOWN);
+                            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:
@@ -190,6 +223,13 @@ 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;
 
@@ -197,8 +237,10 @@ private:
    bool Parsed;
 
    // Utility pixel converter
+   
    /// \brief Pointer to the PixelReadConverter
    PixelReadConvert *PixelReadConverter;
+   
    /// \brief Pointer to the PixelWriteConverter
    PixelWriteConvert *PixelWriteConverter;
 
@@ -209,10 +251,10 @@ private:
    // 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)
@@ -221,10 +263,20 @@ private:
    /// See vtkgdcmSerieViewer for an example
    VOID_FUNCTION_PUINT8_PFILE_POINTER UserFunction;
    
-   /// \brief if user knows he didn't modify the pixels (e.g. he just 
-   /// anonymized the file), he is allowed to ask to keep the original
-   /// 'Media Storage SOP Class UID' and 'Image Type'  
-   bool KeepMediaStorageSOPClassUID;
+   /// \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