]> Creatis software - gdcm.git/blobdiff - src/gdcmFileHelper.h
* Remove useless constructor of gdcm::Document
[gdcm.git] / src / gdcmFileHelper.h
index 18ab4bb9adc04d0c031ed024111de704f822783f..1c1d0d8d07b4e60aa5b83d840e1668163ee77a2b 100644 (file)
@@ -3,8 +3,8 @@
   Program:   gdcm
   Module:    $RCSfile: gdcmFileHelper.h,v $
   Language:  C++
-  Date:      $Date: 2005/02/04 14:49:01 $
-  Version:   $Revision: 1.10 $
+  Date:      $Date: 2005/10/18 08:35:50 $
+  Version:   $Revision: 1.23 $
                                                                                 
   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
 
-#include <iostream>
+#include "gdcmDebug.h"
 #include "gdcmBase.h"
+//#include <iostream>
+
+
 
 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
@@ -49,25 +54,32 @@ public:
 public:
    FileHelper( );
    FileHelper( File *header );
-   FileHelper( std::string const &filename );
+   GDCM_LEGACY(FileHelper( std::string const &filename ));
+   
    virtual ~FileHelper();
 
    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, TopDown,...)
+   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,52 +88,56 @@ 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_tGetUserData();
+   uint8_t *GetUserData();
    size_t GetUserDataSize();
    // RBG data (from file)
-   uint8_tGetRGBData();
+   uint8_t *GetRGBData();
    size_t GetRGBDataSize();
    // RAW data (from file)
-   uint8_tGetRawData();
+   uint8_t *GetRawData();
    size_t GetRawDataSize();
 
    // LUT
    uint8_t* GetLutRGBA();
+   int GetLutItemNumber();
+   int GetLutItemSize();
 
    // Write mode
 
-   /// \brief Tells the writer we want to write a Raw File (no header)
-  void SetWriteModeToRaw()           { SetWriteMode(WMODE_RAW);  };
+   /// \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 opposite to 'Grey pixels + Palettes color')
-   void SetWriteModeToRGB()           { SetWriteMode(WMODE_RGB);  };
+   ///        (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;         }
    /// \brief Gets the Write Mode ( )
-   FileMode GetWriteMode()            { return WriteMode;         };
+   FileMode GetWriteMode()            { return WriteMode;         }
 
    // Write format
 
    /// \brief Tells the writer we want to write as Implicit VR
-   void SetWriteTypeToDcmImplVR()     { SetWriteType(ImplicitVR); };
+   void SetWriteTypeToDcmImplVR()     { SetWriteType(ImplicitVR); }
    /// \brief Tells the writer we want to write as Explicit VR
-   void SetWriteTypeToDcmExplVR()     { SetWriteType(ExplicitVR); };
+   void SetWriteTypeToDcmExplVR()     { SetWriteType(ExplicitVR); }
    /// \brief Tells the writer we want to write as ACR-NEMA
-   void SetWriteTypeToAcr()           { SetWriteType(ACR);        };
+   void SetWriteTypeToAcr()           { SetWriteType(ACR);        }
    /// \brief Tells the writer we want to write as LibIDO
-   void SetWriteTypeToAcrLibido()     { SetWriteType(ACR_LIBIDO); };
-   /// \brief Tells the writer which format want to write
+   void SetWriteTypeToAcrLibido()     { SetWriteType(ACR_LIBIDO); }
+   /// \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 want to write
+   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;         };
+   FileType GetWriteType()            { return WriteType;         }
 
    // Write pixels of ONE image on hard drive
    // No test is made on processor "endianness"
@@ -148,8 +164,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_UNKNOWN);
+   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();
@@ -161,11 +182,11 @@ private:
    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.
+   ///  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
@@ -183,6 +204,13 @@ private:
    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, ...)
+   /// 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;
 };
 } // end namespace gdcm