src/gdcmFileHelper.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmFileHelper.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/02/02 16:18:48 $
   7   Version:   $Revision: 1.8 $
   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 <iostream>
  23 #include "gdcmBase.h"
  24
  25 namespace gdcm
  26 {
  27 class File;
  28 class ValEntry;
  29 class BinEntry;
  30 class SeqEntry;
  31 class PixelReadConvert;
  32 class PixelWriteConvert;
  33 class DocEntryArchive;
  34 //-----------------------------------------------------------------------------
  35 /**
  36  * \brief In addition to Dicom header exploration, this class is designed
  37  * for accessing the image/volume content. One can also use it to
  38  * write Dicom/ACR-NEMA/RAW files.
  39  */
  40 class GDCM_EXPORT FileHelper : public Base
  41 {
  42 public:
  43    enum FileMode
  44    {
  45       WMODE_RAW,
  46       WMODE_RGB
  47    };
  48
  49 public:
  50    FileHelper( );
  51    FileHelper( File *header );
  52    FileHelper( std::string const &filename );
  53
  54    virtual ~FileHelper();
  55
  56    void Print(std::ostream &os = std::cout, std::string const & indent = "");
  57
  58    /// Accessor to \ref File
  59    File *GetFile() { return FileInternal; }
  60
  61    // File methods
  62    bool SetValEntry(std::string const &content,
  63                     uint16_t group, uint16_t elem);
  64    bool SetBinEntry(uint8_t *content, int lgth,
  65                     uint16_t group, uint16_t elem);
  66
  67    ValEntry *InsertValEntry(std::string const &content,
  68                             uint16_t group, uint16_t elem);
  69    BinEntry *InsertBinEntry(uint8_t *binArea, int lgth,
  70                             uint16_t group, uint16_t elem);
  71    SeqEntry *InsertSeqEntry(uint16_t group, uint16_t elem);
  72
  73    // File helpers
  74    size_t GetImageDataSize();
  75    size_t GetImageDataRawSize();
  76
  77    uint8_t *GetImageData();
  78    uint8_t *GetImageDataRaw();
  79    size_t GetImageDataIntoVector(void *destination, size_t maxSize);
  80
  81    void SetImageData(uint8_t *data, size_t expectedSize);
  82
  83    // User data
  84    void SetUserData(uint8_t *data, size_t expectedSize);
  85    uint8_t* GetUserData();
  86    size_t GetUserDataSize();
  87    // RBG data (from file
  88    uint8_t* GetRGBData();
  89    size_t GetRGBDataSize();
  90    // RAW data (from file
  91    uint8_t* GetRawData();
  92    size_t GetRawDataSize();
  93
  94    // LUT
  95    uint8_t* GetLutRGBA();
  96
  97    // Write mode
  98    void SetWriteModeToRaw()          { SetWriteMode(WMODE_RAW); };
  99    void SetWriteModeToRGB()          { SetWriteMode(WMODE_RGB); };
 100    void SetWriteMode(FileMode mode)  { WriteMode = mode; };
 101    FileMode GetWriteMode()           { return WriteMode; };
 102
 103    // Write format
 104    void SetWriteTypeToDcmImplVR()     { SetWriteType(ImplicitVR); };
 105    void SetWriteTypeToDcmExplVR()     { SetWriteType(ExplicitVR); };
 106    void SetWriteTypeToAcr()           { SetWriteType(ACR); };
 107    void SetWriteTypeToAcrLibido()     { SetWriteType(ACR_LIBIDO); };
 108    void SetWriteType(FileType format) { WriteType = format; };
 109    FileType GetWriteType()            { return WriteType; };
 110
 111    // Write pixels of ONE image on hard drive
 112    // No test is made on processor "endianity"
 113    // The user must call his reader correctly
 114    bool WriteRawData  (std::string const &fileName);
 115    bool WriteDcmImplVR(std::string const &fileName);
 116    bool WriteDcmExplVR(std::string const &fileName);
 117    bool WriteAcr      (std::string const &fileName);
 118    bool Write         (std::string const &fileName);
 119
 120 protected:
 121    bool CheckWriteIntegrity();
 122
 123    void SetWriteToRaw();
 124    void SetWriteToRGB();
 125    void RestoreWrite();
 126
 127    void SetWriteFileTypeToACR();
 128    void SetWriteFileTypeToExplicitVR();
 129    void SetWriteFileTypeToImplicitVR();
 130    void RestoreWriteFileType();
 131
 132    void SetWriteToLibido();
 133    void SetWriteToNoLibido();
 134    void RestoreWriteOfLibido();
 135
 136    ValEntry *CopyValEntry(uint16_t group,uint16_t elem);
 137    BinEntry *CopyBinEntry(uint16_t group,uint16_t elem);
 138
 139 private:
 140    void Initialize();
 141
 142    uint8_t *GetRaw();
 143
 144 // members variables:
 145    /// gdcm::File to use to load the file
 146    File *FileInternal;
 147
 148    /// \brief Whether the underlying \ref gdcm::File was loaded by
 149    ///  the constructor or passed to the constructor. When false
 150    ///  the destructor is in charge of deletion.
 151    bool SelfHeader;
 152
 153    /// Wether already parsed or not
 154    bool Parsed;
 155
 156    /// Utility pixel converter
 157    PixelReadConvert *PixelReadConverter;
 158    PixelWriteConvert *PixelWriteConverter;
 159
 160    // Utility header archive
 161    DocEntryArchive *Archive;
 162
 163    // Write variables
 164    FileMode WriteMode;
 165    FileType WriteType;
 166 };
 167 } // end namespace gdcm
 168
 169 //-----------------------------------------------------------------------------
 170 #endif