src/gdcmFileHelper.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmFileHelper.h,v $
   5   Language:  C++
   6   Date:      $Date: 2005/02/09 16:28:41 $
   7   Version:   $Revision: 1.12 $
   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
  99    /// \brief Tells the writer we want to write a Raw File (no header)
 100   void SetWriteModeToRaw()           { SetWriteMode(WMODE_RAW);  };
 101    /// \brief Tells the writer we want to write RGB image when possible
 102    ///        (as opposite to 'Grey pixels + Palettes color')
 103    void SetWriteModeToRGB()           { SetWriteMode(WMODE_RGB);  };
 104    /// \brief Sets the Write Mode ( )
 105    void SetWriteMode(FileMode mode)   { WriteMode = mode;         };
 106    /// \brief Gets the Write Mode ( )
 107    FileMode GetWriteMode()            { return WriteMode;         };
 108
 109    // Write format
 110
 111    /// \brief Tells the writer we want to write as Implicit VR
 112    void SetWriteTypeToDcmImplVR()     { SetWriteType(ImplicitVR); };
 113    /// \brief Tells the writer we want to write as Explicit VR
 114    void SetWriteTypeToDcmExplVR()     { SetWriteType(ExplicitVR); };
 115    /// \brief Tells the writer we want to write as ACR-NEMA
 116    void SetWriteTypeToAcr()           { SetWriteType(ACR);        };
 117    /// \brief Tells the writer we want to write as LibIDO
 118    void SetWriteTypeToAcrLibido()     { SetWriteType(ACR_LIBIDO); };
 119    /// \brief Tells the writer which format want to write
 120    /// (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
 121    void SetWriteType(FileType format) { WriteType = format;       };
 122    /// \brief Gets the format we want to write
 123    ///   (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
 124    FileType GetWriteType()            { return WriteType;         };
 125
 126    // Write pixels of ONE image on hard drive
 127    // No test is made on processor "endianness"
 128    // The user must call his reader correctly
 129    bool WriteRawData  (std::string const &fileName);
 130    bool WriteDcmImplVR(std::string const &fileName);
 131    bool WriteDcmExplVR(std::string const &fileName);
 132    bool WriteAcr      (std::string const &fileName);
 133    bool Write         (std::string const &fileName);
 134
 135 protected:
 136    bool CheckWriteIntegrity();
 137
 138    void SetWriteToRaw();
 139    void SetWriteToRGB();
 140    void RestoreWrite();
 141
 142    void SetWriteFileTypeToACR();
 143    void SetWriteFileTypeToExplicitVR();
 144    void SetWriteFileTypeToImplicitVR();
 145    void RestoreWriteFileType();
 146
 147    void SetWriteToLibido();
 148    void SetWriteToNoLibido();
 149    void RestoreWriteOfLibido();
 150
 151    ValEntry *CopyValEntry(uint16_t group, uint16_t elem);
 152    BinEntry *CopyBinEntry(uint16_t group, uint16_t elem,
 153                           const std::string &vr);
 154
 155 private:
 156    void Initialize();
 157
 158    uint8_t *GetRaw();
 159
 160 // members variables:
 161    /// gdcm::File to use to load the file
 162    File *FileInternal;
 163
 164    /// \brief Whether the underlying \ref gdcm::File was loaded by
 165    ///  the constructor or passed to the constructor. When false
 166    ///  the destructor is in charge of deletion.
 167    bool SelfHeader;
 168
 169    /// Wether already parsed or not
 170    bool Parsed;
 171
 172    // Utility pixel converter
 173    /// \brief Pointer to the PixelReadConverter
 174    PixelReadConvert *PixelReadConverter;
 175    /// \brief Pointer to the PixelWriteConverter
 176    PixelWriteConvert *PixelWriteConverter;
 177
 178    // Utility header archive
 179    /// \brief Pointer to the DocEntryArchive (used while writting process)
 180    DocEntryArchive *Archive;
 181
 182    // Write variables
 183    /// \brief (WMODE_RAW, WMODE_RGB)
 184    FileMode WriteMode;
 185    /// \brief (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
 186    FileType WriteType;
 187 };
 188 } // end namespace gdcm
 189
 190 //-----------------------------------------------------------------------------
 191 #endif