src/gdcmFileHelper.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmFileHelper.h,v $
   5   Language:  C++
   6   Date:      $Date: 2006/03/01 15:32:52 $
   7   Version:   $Revision: 1.40 $
   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 "gdcmRefCounter.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 RefCounter
  44 {
  45    gdcmTypeMacro(FileHelper);
  46
  47 public:
  48    enum FileMode
  49    {
  50       WMODE_RAW,
  51       WMODE_RGB
  52    };
  53
  54 /// \brief Constructs a FileHelper with a RefCounter
  55    static FileHelper *New() {return new FileHelper();}
  56 /// \brief Constructs a FileHelper with a RefCounter from a fileHelper
  57    static FileHelper *New(File *header) {return new FileHelper(header);}
  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, UpsideDown,...)
  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 /// \brief We have to deal with 4 *very* different cases :
 152 /// -1) user created ex nihilo his own image and wants to write it as a Dicom image.
 153 ///    USER_OWN_IMAGE
 154 /// -2) user modified the pixels of an existing image.
 155 ///    FILTERED_IMAGE
 156 /// -3) user created a new image, using existing images (eg MIP, MPR, cartography image)
 157 ///   CREATED_IMAGE
 158 /// -4) user modified/added some tags *without processing* the pixels (anonymization...
 159 ///   UNMODIFIED_PIXELS_IMAGE
 160
 161    void SetContentType (ImageContentType c) { ContentType = c; }
 162    // no GetContentType() method, on purpose!
 163
 164    void CallStartMethod();
 165    void CallProgressMethod();
 166    void CallEndMethod();
 167
 168 protected:
 169    FileHelper( );
 170    FileHelper( File *header );
 171    ~FileHelper();
 172
 173    bool CheckWriteIntegrity();
 174
 175    void SetWriteToRaw();
 176    void SetWriteToRGB();
 177    void RestoreWrite();
 178
 179    void SetWriteFileTypeToACR();
 180    void SetWriteFileTypeToJPEG();
 181    void SetWriteFileTypeToExplicitVR();
 182    void SetWriteFileTypeToImplicitVR();
 183    void RestoreWriteFileType();
 184
 185    void SetWriteToLibido();
 186    void SetWriteToNoLibido();
 187    void RestoreWriteOfLibido();
 188
 189    DataEntry *CopyDataEntry(uint16_t group, uint16_t elem,
 190                                const TagName &vr = GDCM_VRUNKNOWN);
 191    void CheckMandatoryElements();
 192    void CheckMandatoryEntry(uint16_t group, uint16_t elem, std::string value);
 193    void SetMandatoryEntry(uint16_t group, uint16_t elem, std::string value);
 194    void CopyMandatoryEntry(uint16_t group, uint16_t elem, std::string value);
 195    void RestoreWriteMandatory();
 196
 197 private:
 198    void Initialize();
 199
 200    uint8_t *GetRaw();
 201
 202 // members variables:
 203 protected:
 204    /// value of the ??? for any progress bar
 205    float Progress;
 206    mutable bool Abort;
 207
 208 private:
 209
 210    /// gdcm::File to use to load the file
 211    File *FileInternal;
 212
 213    /// Whether already parsed or not
 214    bool Parsed;
 215
 216    // Utility pixel converter
 217    /// \brief Pointer to the PixelReadConverter
 218    PixelReadConvert *PixelReadConverter;
 219    /// \brief Pointer to the PixelWriteConverter
 220    PixelWriteConvert *PixelWriteConverter;
 221
 222    // Utility header archive
 223    /// \brief Pointer to the DocEntryArchive (used while writting process)
 224    DocEntryArchive *Archive;
 225
 226    // Write variables
 227    /// \brief (WMODE_RAW, WMODE_RGB)
 228    FileMode WriteMode;
 229
 230    /// \brief (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
 231    FileType WriteType;
 232
 233    /// \brief Pointer to a user supplied function to allow modification
 234    /// of pixel order (e.g. : Mirror, UpsideDown, 90°Rotation, ...)
 235    /// use as : void userSuppliedFunction(uint8_t *im, gdcm::File *f)
 236    /// NB : the "uint8_t *" type of first param is just for prototyping.
 237    /// User will Cast it according what he founds with f->GetPixelType()
 238    /// See vtkgdcmSerieViewer for an example
 239    VOID_FUNCTION_PUINT8_PFILE_POINTER UserFunction;
 240
 241    /// \brief only user knows what he did before asking the image to be written
 242    /// - he created ex nihilo his own image
 243    /// - he just applied a mathematical process on the pixels
 244    /// - he created a new image, using existing images (eg MIP, MPR,cartography)
 245    /// - he anonymized and image (*no* modif on the pixels)
 246    ImageContentType ContentType;
 247
 248 };
 249 } // end namespace gdcm
 250
 251 //-----------------------------------------------------------------------------
 252 #endif