src/gdcmFileHelper.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmFileHelper.h,v $
   5   Language:  C++
   6   Date:      $Date: 2006/04/11 16:03:26 $
   7   Version:   $Revision: 1.42 $
   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 #include "gdcmVRKey.h"
  25 #include "gdcmFile.h"
  26
  27 namespace gdcm
  28 {
  29 //class File;
  30 class DataEntry;
  31 class SeqEntry;
  32 class PixelReadConvert;
  33 class PixelWriteConvert;
  34 class DocEntryArchive;
  35
  36 typedef void (*VOID_FUNCTION_PUINT8_PFILE_POINTER)(uint8_t *, File *);
  37
  38 //-----------------------------------------------------------------------------
  39 /**
  40  * \brief In addition to Dicom header exploration, this class is designed
  41  * for accessing the image/volume content. One can also use it to
  42  * write Dicom/ACR-NEMA/RAW files.
  43  */
  44 class GDCM_EXPORT FileHelper : public RefCounter
  45 {
  46    gdcmTypeMacro(FileHelper);
  47
  48 public:
  49    enum FileMode
  50    {
  51       WMODE_RAW,
  52       WMODE_RGB
  53    };
  54
  55 /// \brief Constructs a FileHelper with a RefCounter
  56    static FileHelper *New() {return new FileHelper();}
  57 /// \brief Constructs a FileHelper with a RefCounter from a fileHelper
  58    static FileHelper *New(File *header) {return new FileHelper(header);}
  59
  60    void Print(std::ostream &os = std::cout, std::string const &indent = "");
  61
  62    /// Accessor to \ref File
  63    File *GetFile() { return FileInternal; }
  64
  65
  66    void SetLoadMode(int loadMode);
  67    void SetFileName(std::string const &fileName);
  68    bool Load();
  69    /// to allow user to modify pixel order (e.g. Mirror, UpsideDown,...)
  70    void SetUserFunction( VOID_FUNCTION_PUINT8_PFILE_POINTER userFunc )
  71                         { UserFunction = userFunc; }
  72    // File methods
  73    bool SetEntryString(std::string const &content,
  74                            uint16_t group, uint16_t elem);
  75    bool SetEntryBinArea(uint8_t *content, int lgth,
  76                             uint16_t group, uint16_t elem);
  77
  78    DataEntry *InsertEntryString(std::string const &content,
  79                                        uint16_t group, uint16_t elem);
  80    DataEntry *InsertEntryBinArea(uint8_t *binArea, int lgth,
  81                                         uint16_t group, uint16_t elem);
  82    SeqEntry *InsertSeqEntry(uint16_t group, uint16_t elem);
  83
  84    // File helpers
  85    size_t GetImageDataSize();
  86    size_t GetImageDataRawSize();
  87
  88    uint8_t *GetImageData();
  89    uint8_t *GetImageDataRaw();
  90
  91    GDCM_LEGACY(size_t GetImageDataIntoVector(void *destination,size_t maxSize));
  92
  93    void SetImageData(uint8_t *data, size_t expectedSize);
  94
  95    // User data
  96    void SetUserData(uint8_t *data, size_t expectedSize);
  97    uint8_t *GetUserData();
  98    size_t GetUserDataSize();
  99    // RBG data (from file)
 100    uint8_t *GetRGBData();
 101    size_t GetRGBDataSize();
 102    // RAW data (from file)
 103    uint8_t *GetRawData();
 104    size_t GetRawDataSize();
 105
 106    // LUT
 107    uint8_t* GetLutRGBA();
 108    int GetLutItemNumber();
 109    int GetLutItemSize();
 110
 111    // Write mode
 112
 113    /// \brief Tells the writer we want to keep 'Grey pixels + Palettes color'
 114    ///        when possible (as opposed to convert 'Palettes color' to RGB)
 115    void SetWriteModeToRaw()           { SetWriteMode(WMODE_RAW);  }
 116    /// \brief Tells the writer we want to write RGB image when possible
 117    ///        (as opposed to 'Grey pixels + Palettes color')
 118    void SetWriteModeToRGB()           { SetWriteMode(WMODE_RGB);  }
 119    /// \brief Sets the Write Mode ( )
 120    void SetWriteMode(FileMode mode)   {
 121       WriteMode = mode;
 122       // Deal with Samples per Pixel
 123       //if (mode == WMODE_RGB) FileInternal->InsertEntryString("3",0x0028,0x0002);
 124    }
 125    /// \brief Gets the Write Mode ( )
 126    FileMode GetWriteMode()            { return WriteMode;         }
 127
 128    // Write format
 129
 130    /// \brief Tells the writer we want to write as Implicit VR
 131    void SetWriteTypeToDcmImplVR()     { SetWriteType(ImplicitVR); }
 132    /// \brief Tells the writer we want to write as Explicit VR
 133    void SetWriteTypeToDcmExplVR()     { SetWriteType(ExplicitVR); }
 134    /// \brief Tells the writer we want to write as ACR-NEMA
 135    void SetWriteTypeToAcr()           { SetWriteType(ACR);        }
 136    /// \brief Tells the writer we want to write as LibIDO
 137    void SetWriteTypeToAcrLibido()     { SetWriteType(ACR_LIBIDO); }
 138    /// \brief Tells the writer we want to write as JPEG
 139    void SetWriteTypeToJPEG()          { SetWriteType(JPEG);       }
 140    /// \brief Tells the writer which format we want to write
 141    /// (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
 142    void SetWriteType(FileType format) { WriteType = format;       }
 143    /// \brief Gets the format we talled the write we wanted to write
 144    /// (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
 145    FileType GetWriteType()            { return WriteType;         }
 146
 147    // Write pixels of ONE image on hard drive
 148    // No test is made on processor "endianness"
 149    // The user must call his reader correctly
 150    bool WriteRawData  (std::string const &fileName);
 151    bool WriteDcmImplVR(std::string const &fileName);
 152    bool WriteDcmExplVR(std::string const &fileName);
 153    bool WriteAcr      (std::string const &fileName);
 154    bool Write         (std::string const &fileName);
 155
 156 /// \brief We have to deal with 4 *very* different cases :
 157 /// -1) user created ex nihilo his own image and wants to write it as a Dicom image.
 158 ///    USER_OWN_IMAGE
 159 /// -2) user modified the pixels of an existing image.
 160 ///    FILTERED_IMAGE
 161 /// -3) user created a new image, using existing images (eg MIP, MPR, cartography image)
 162 ///   CREATED_IMAGE
 163 /// -4) user modified/added some tags *without processing* the pixels (anonymization...
 164 ///   UNMODIFIED_PIXELS_IMAGE
 165
 166    void SetContentType (ImageContentType c) { ContentType = c; }
 167    // no GetContentType() method, on purpose!
 168
 169    void CallStartMethod();
 170    void CallProgressMethod();
 171    void CallEndMethod();
 172
 173 protected:
 174    FileHelper( );
 175    FileHelper( File *header );
 176    ~FileHelper();
 177
 178    bool CheckWriteIntegrity();
 179
 180    void SetWriteToRaw();
 181    void SetWriteToRGB();
 182    void RestoreWrite();
 183
 184    void SetWriteFileTypeToACR();
 185    void SetWriteFileTypeToJPEG();
 186    void SetWriteFileTypeToExplicitVR();
 187    void SetWriteFileTypeToImplicitVR();
 188    void RestoreWriteFileType();
 189
 190    void SetWriteToLibido();
 191    void SetWriteToNoLibido();
 192    void RestoreWriteOfLibido();
 193
 194    DataEntry *CopyDataEntry(uint16_t group, uint16_t elem,
 195                                const VRKey &vr = GDCM_VRUNKNOWN);
 196    void CheckMandatoryElements();
 197    void CheckMandatoryEntry(uint16_t group, uint16_t elem, std::string value,
 198                                const VRKey &vr = GDCM_VRUNKNOWN);
 199    void SetMandatoryEntry(uint16_t group, uint16_t elem, std::string value,
 200                                const VRKey &vr = GDCM_VRUNKNOWN);
 201    void CopyMandatoryEntry(uint16_t group, uint16_t elem, std::string value,
 202                                const VRKey &vr = GDCM_VRUNKNOWN);
 203    void RestoreWriteMandatory();
 204
 205 private:
 206    void Initialize();
 207
 208    uint8_t *GetRaw();
 209
 210 // members variables:
 211 protected:
 212    /// value of the ??? for any progress bar
 213    float Progress;
 214    mutable bool Abort;
 215
 216 private:
 217
 218    /// gdcm::File to use to load the file
 219    File *FileInternal;
 220
 221    /// Whether already parsed or not
 222    bool Parsed;
 223
 224    // Utility pixel converter
 225    /// \brief Pointer to the PixelReadConverter
 226    PixelReadConvert *PixelReadConverter;
 227    /// \brief Pointer to the PixelWriteConverter
 228    PixelWriteConvert *PixelWriteConverter;
 229
 230    // Utility header archive
 231    /// \brief Pointer to the DocEntryArchive (used while writting process)
 232    DocEntryArchive *Archive;
 233
 234    // Write variables
 235    /// \brief (WMODE_RAW, WMODE_RGB)
 236    FileMode WriteMode;
 237
 238    /// \brief (ImplicitVR, ExplicitVR, ACR, ACR_LIBIDO)
 239    FileType WriteType;
 240
 241    /// \brief Pointer to a user supplied function to allow modification
 242    /// of pixel order (e.g. : Mirror, UpsideDown, 90°Rotation, ...)
 243    /// use as : void userSuppliedFunction(uint8_t *im, gdcm::File *f)
 244    /// NB : the "uint8_t *" type of first param is just for prototyping.
 245    /// User will Cast it according what he founds with f->GetPixelType()
 246    /// See vtkgdcmSerieViewer for an example
 247    VOID_FUNCTION_PUINT8_PFILE_POINTER UserFunction;
 248
 249    /// \brief only user knows what he did before asking the image to be written
 250    /// - he created ex nihilo his own image
 251    /// - he just applied a mathematical process on the pixels
 252    /// - he created a new image, using existing images (eg MIP, MPR,cartography)
 253    /// - he anonymized and image (*no* modif on the pixels)
 254    ImageContentType ContentType;
 255
 256 };
 257 } // end namespace gdcm
 258
 259 //-----------------------------------------------------------------------------
 260 #endif