Remove useless accesses to the Dicom Dictionnary std::map

[gdcm.git] / src / gdcmFileHelper.h

diff --git a/src/gdcmFileHelper.h b/src/gdcmFileHelper.h
index 899cb436b75980429536b6d2f5e0a7d7334ad677..fe5f725fd54a0a89b49379dd31fc3dda81472ccb 100644 (file)
--- 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/25 14:52:34 $
-  Version:   $Revision: 1.29 $
+  Date:      $Date: 2006/04/11 16:03:26 $
+  Version:   $Revision: 1.42 $
                                                                                 
   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
   l'Image). All rights reserved. See Doc/License.txt or
@@ -21,11 +21,12 @@
 
 #include "gdcmDebug.h"
 #include "gdcmRefCounter.h"
-
+#include "gdcmVRKey.h"
+#include "gdcmFile.h"
 
 namespace gdcm 
 {
-class File;
+//class File;
 class DataEntry;
 class SeqEntry;
 class PixelReadConvert;
@@ -50,13 +51,12 @@ 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);}
    
-   virtual ~FileHelper();
-
    void Print(std::ostream &os = std::cout, std::string const &indent = ""); 
 
    /// Accessor to \ref File
@@ -66,7 +66,7 @@ public:
    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
@@ -117,7 +117,11 @@ public:
    ///        (as opposed to 'Grey pixels + Palettes color')
    void SetWriteModeToRGB()           { SetWriteMode(WMODE_RGB);  }
    /// \brief Sets the Write Mode ( )
-   void SetWriteMode(FileMode mode)   { WriteMode = mode;         }
+   void SetWriteMode(FileMode mode)   { 
+      WriteMode = mode;
+      // Deal with Samples per Pixel    
+      //if (mode == WMODE_RGB) FileInternal->InsertEntryString("3",0x0028,0x0002);
+   }
    /// \brief Gets the Write Mode ( )
    FileMode GetWriteMode()            { return WriteMode;         }
 
@@ -148,10 +152,28 @@ 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();
 
@@ -170,11 +192,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:
@@ -183,6 +208,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;
 
@@ -202,7 +234,7 @@ private:
    // Write variables
    /// \brief (WMODE_RAW, WMODE_RGB)
    FileMode WriteMode;
-   
+
    /// \brief (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
    FileType WriteType;
    
@@ -213,6 +245,14 @@ private:
    /// 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