src/gdcmFileHelper.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmFileHelper.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/10/23 15:24:47 $
   7   Version:   $Revision: 1.27 $
   8
   9   Copyright (c) CREATIS (Centre de Recherche et d'Applications en Traitement de
  10   l'Image). All rights reserved. See Doc/License.txt or
  11   http://www.creatis.insa-lyon.fr/Public/Gdcm/License.html for details.
  12
  13      This software is distributed WITHOUT ANY WARRANTY; without even
  14      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15      PURPOSE.  See the above copyright notices for more information.
  16
  17 =========================================================================*/
  18
  19 #ifndef GDCMFILEHELPER_H
  20 #define GDCMFILEHELPER_H
  21
  22 #include "gdcmDebug.h"
  23 #include "gdcmBase.h"
  24
  25
  26 namespace gdcm
  27 {
  28 class File;
  29 class DataEntry;
  30 class SeqEntry;
  31 class PixelReadConvert;
  32 class PixelWriteConvert;
  33 class DocEntryArchive;
  34
  35 typedef void (*VOID_FUNCTION_PUINT8_PFILE_POINTER)(uint8_t *, File *);
  36
  37 //-----------------------------------------------------------------------------
  38 /**
  39  * \brief In addition to Dicom header exploration, this class is designed
  40  * for accessing the image/volume content. One can also use it to
  41  * write Dicom/ACR-NEMA/RAW files.
  42  */
  43 class GDCM_EXPORT FileHelper : public Base
  44 {
  45 public:
  46    enum FileMode
  47    {
  48       WMODE_RAW,
  49       WMODE_RGB
  50    };
  51
  52 public:
  53    FileHelper( );
  54    FileHelper( File *header );
  55    GDCM_LEGACY(FileHelper( std::string const &filename ));
  56
  57    virtual ~FileHelper();
  58
  59    void Print(std::ostream &os = std::cout, std::string const &indent = "");
  60
  61    /// Accessor to \ref File
  62    File *GetFile() { return FileInternal; }
  63
  64
  65    void SetLoadMode(int loadMode);
  66    void SetFileName(std::string const &fileName);
  67    bool Load();
  68    /// to allow user to modify pixel order (e.g. Mirror, TopDown,...)
  69    void SetUserFunction( VOID_FUNCTION_PUINT8_PFILE_POINTER userFunc )
  70                         { UserFunction = userFunc; }
  71    // File methods
  72    bool SetEntryString(std::string const &content,
  73                            uint16_t group, uint16_t elem);
  74    bool SetEntryBinArea(uint8_t *content, int lgth,
  75                             uint16_t group, uint16_t elem);
  76
  77    DataEntry *InsertEntryString(std::string const &content,
  78                                        uint16_t group, uint16_t elem);
  79    DataEntry *InsertEntryBinArea(uint8_t *binArea, int lgth,
  80                                         uint16_t group, uint16_t elem);
  81    SeqEntry *InsertSeqEntry(uint16_t group, uint16_t elem);
  82
  83    // File helpers
  84    size_t GetImageDataSize();
  85    size_t GetImageDataRawSize();
  86
  87    uint8_t *GetImageData();
  88    uint8_t *GetImageDataRaw();
  89
  90    GDCM_LEGACY(size_t GetImageDataIntoVector(void *destination,size_t maxSize));
  91
  92    void SetImageData(uint8_t *data, size_t expectedSize);
  93
  94    // User data
  95    void SetUserData(uint8_t *data, size_t expectedSize);
  96    uint8_t *GetUserData();
  97    size_t GetUserDataSize();
  98    // RBG data (from file)
  99    uint8_t *GetRGBData();
 100    size_t GetRGBDataSize();
 101    // RAW data (from file)
 102    uint8_t *GetRawData();
 103    size_t GetRawDataSize();
 104
 105    // LUT
 106    uint8_t* GetLutRGBA();
 107    int GetLutItemNumber();
 108    int GetLutItemSize();
 109
 110    // Write mode
 111
 112    /// \brief Tells the writer we want to keep 'Grey pixels + Palettes color'
 113    ///        when possible (as opposed to convert 'Palettes color' to RGB)
 114    void SetWriteModeToRaw()           { SetWriteMode(WMODE_RAW);  }
 115    /// \brief Tells the writer we want to write RGB image when possible
 116    ///        (as opposed to 'Grey pixels + Palettes color')
 117    void SetWriteModeToRGB()           { SetWriteMode(WMODE_RGB);  }
 118    /// \brief Sets the Write Mode ( )
 119    void SetWriteMode(FileMode mode)   { WriteMode = mode;         }
 120    /// \brief Gets the Write Mode ( )
 121    FileMode GetWriteMode()            { return WriteMode;         }
 122
 123    // Write format
 124
 125    /// \brief Tells the writer we want to write as Implicit VR
 126    void SetWriteTypeToDcmImplVR()     { SetWriteType(ImplicitVR); }
 127    /// \brief Tells the writer we want to write as Explicit VR
 128    void SetWriteTypeToDcmExplVR()     { SetWriteType(ExplicitVR); }
 129    /// \brief Tells the writer we want to write as ACR-NEMA
 130    void SetWriteTypeToAcr()           { SetWriteType(ACR);        }
 131    /// \brief Tells the writer we want to write as LibIDO
 132    void SetWriteTypeToAcrLibido()     { SetWriteType(ACR_LIBIDO); }
 133    /// \brief Tells the writer we want to write as JPEG
 134    void SetWriteTypeToJPEG()          { SetWriteType(JPEG);       }
 135    /// \brief Tells the writer which format we want to write
 136    /// (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
 137    void SetWriteType(FileType format) { WriteType = format;       }
 138    /// \brief Gets the format we talled the write we wanted to write
 139    /// (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
 140    FileType GetWriteType()            { return WriteType;         }
 141
 142    // Write pixels of ONE image on hard drive
 143    // No test is made on processor "endianness"
 144    // The user must call his reader correctly
 145    bool WriteRawData  (std::string const &fileName);
 146    bool WriteDcmImplVR(std::string const &fileName);
 147    bool WriteDcmExplVR(std::string const &fileName);
 148    bool WriteAcr      (std::string const &fileName);
 149    bool Write         (std::string const &fileName);
 150
 151 protected:
 152    bool CheckWriteIntegrity();
 153
 154    void SetWriteToRaw();
 155    void SetWriteToRGB();
 156    void RestoreWrite();
 157
 158    void SetWriteFileTypeToACR();
 159    void SetWriteFileTypeToJPEG();
 160    void SetWriteFileTypeToExplicitVR();
 161    void SetWriteFileTypeToImplicitVR();
 162    void RestoreWriteFileType();
 163
 164    void SetWriteToLibido();
 165    void SetWriteToNoLibido();
 166    void RestoreWriteOfLibido();
 167
 168    DataEntry *CopyDataEntry(uint16_t group, uint16_t elem,
 169                                const TagName &vr = GDCM_VRUNKNOWN);
 170    void CheckMandatoryElements();
 171    void CheckMandatoryEntry(uint16_t group, uint16_t elem, std::string value);
 172    void SetMandatoryEntry(uint16_t group, uint16_t elem, std::string value);
 173    void CopyMandatoryEntry(uint16_t group, uint16_t elem, std::string value);
 174    void RestoreWriteMandatory();
 175
 176 private:
 177    void Initialize();
 178
 179    uint8_t *GetRaw();
 180
 181 // members variables:
 182    /// gdcm::File to use to load the file
 183    File *FileInternal;
 184
 185    /// \brief Whether the underlying \ref gdcm::File was loaded by
 186    ///  the constructor or passed to the constructor.
 187    ///  When false the destructor is in charge of deletion.
 188    bool SelfHeader;
 189
 190    /// Whether already parsed or not
 191    bool Parsed;
 192
 193    // Utility pixel converter
 194    /// \brief Pointer to the PixelReadConverter
 195    PixelReadConvert *PixelReadConverter;
 196    /// \brief Pointer to the PixelWriteConverter
 197    PixelWriteConvert *PixelWriteConverter;
 198
 199    // Utility header archive
 200    /// \brief Pointer to the DocEntryArchive (used while writting process)
 201    DocEntryArchive *Archive;
 202
 203    // Write variables
 204    /// \brief (WMODE_RAW, WMODE_RGB)
 205    FileMode WriteMode;
 206    /// \brief (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
 207    FileType WriteType;
 208    /// Pointer to a user supplied function to allow modification of pixel order
 209    /// (i.e. : Mirror, TopDown, 90°Rotation, ...)
 210    /// use as : void userSuppliedFunction(uint8_t *im, gdcm::File *f)
 211    /// NB : the "uint8_t *" type of first param is just for prototyping.
 212    /// User will Cast it according what he founds with f->GetPixelType()
 213    /// See vtkgdcmSerieViewer for an example
 214    VOID_FUNCTION_PUINT8_PFILE_POINTER UserFunction;
 215 };
 216 } // end namespace gdcm
 217
 218 //-----------------------------------------------------------------------------
 219 #endif