src/gdcmFile.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: gdcmFile.h,v $
   5   Language:  C++
   6   Date:      $Date: 2006/05/12 19:09:55 $
   7   Version:   $Revision: 1.127 $
   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 GDCMFILE_H
  20 #define GDCMFILE_H
  21
  22 #include "gdcmDebug.h"
  23 #include "gdcmDocument.h"
  24 #include "gdcmTagKey.h"
  25
  26
  27 namespace gdcm
  28 {
  29
  30 class RLEFramesInfo;
  31 class JPEGFragmentsInfo;
  32
  33 //-----------------------------------------------------------------------------
  34 // Dicom Part 3.3 Compliant
  35 enum ModalityType {
  36    Unknow,
  37    AU,       // Voice Audio
  38    AS,       // Angioscopy
  39    BI,       // Biomagnetic Imaging
  40    CF,       // Cinefluorography
  41    CP,       // Culposcopy
  42    CR,       // Computed Radiography
  43    CS,       // Cystoscopy
  44    CT,       // Computed Tomography
  45    DD,       // Duplex Dopler
  46    DF,       // Digital Fluoroscopy
  47    DG,       // Diaphanography
  48    DM,       // Digital Microscopy
  49    DS,       // Digital Substraction Angiography
  50    DX,       // Digital Radiography
  51    ECG,      // Echocardiography
  52    EPS,      // Basic Cardiac EP
  53    ES,       // Endoscopy
  54    FA,       // Fluorescein Angiography
  55    FS,       // Fundoscopy
  56    HC,       // Hard Copy
  57    HD,       // Hemodynamic
  58    LP,       // Laparoscopy
  59    LS,       // Laser Surface Scan
  60    MA,       // Magnetic Resonance Angiography
  61    MR,       // Magnetic Resonance
  62    NM,       // Nuclear Medicine
  63    OT,       // Other
  64    PT,       // Positron Emission Tomography
  65    RF,       // Radio Fluoroscopy
  66    RG,       // Radiographic Imaging
  67    RTDOSE,   // Radiotherapy Dose
  68    RTIMAGE,  // Radiotherapy Image
  69    RTPLAN,   // Radiotherapy Plan
  70    RTSTRUCT, // Radiotherapy Structure Set
  71    SM,       // Microscopic Imaging
  72    ST,       // Single-photon Emission Computed Tomography
  73    TG,       // Thermography
  74    US,       // Ultrasound
  75    VF,       // Videofluorography
  76    XA,       // X-Ray Angiography
  77    XC        // Photographic Imaging
  78 };
  79
  80 //-----------------------------------------------------------------------------
  81
  82 /**
  83  * \brief DICOM elements and their corresponding values (and
  84  * additionaly the corresponding DICOM dictionary entry) of the header
  85  * of a DICOM file.
  86  *
  87  * The typical usage of instances of class File is to classify a set of
  88  * dicom files according to header information e.g. to create a file hierarchy
  89  * reflecting the Patient/Study/Serie informations, or extracting a given
  90  * SerieId. Accessing the content (image[s] or volume[s]) is beyond the
  91  * functionality of this class and belongs to gdcm::FileHelper.
  92  * \note  The various entries of the explicit value representation (VR) shall
  93  *        be managed within a dictionary which is shared by all File
  94  *        instances.
  95  * \note  The File::Set*Tag* family members cannot be defined as
  96  *        protected due to Swig limitations for as Has_a dependency between
  97  *        File and FileHelper.
  98  */
  99 class GDCM_EXPORT File : public Document
 100 {
 101    gdcmTypeMacro(File);
 102
 103 public:
 104    static File *New() {return new File();}
 105
 106    // Loading
 107    GDCM_LEGACY(bool Load( std::string const &filename ))
 108    bool Load();
 109    // Standard values and informations contained in the header
 110    bool IsReadable();
 111
 112    void SetFourthDimensionLocation(uint16_t group, uint16_t elem) {
 113                    FourthDimensionLocation = TagKey(group, elem); }
 114
 115    // Some heuristic based accessors, end user intended
 116    int GetImageNumber();
 117    ModalityType GetModality();
 118
 119    int GetXSize();
 120    int GetYSize();
 121    int GetZSize();
 122    int GetTSize(); // unnormalized in DICOM V3
 123
 124    float GetXSpacing();
 125    float GetYSpacing();
 126    float GetZSpacing();
 127
 128    float GetXOrigin();
 129    float GetYOrigin();
 130    float GetZOrigin();
 131
 132    bool GetImageOrientationPatient( float iop[6] );
 133
 134    int GetBitsStored();
 135    int GetBitsAllocated();
 136    int GetHighBitPosition();
 137    int GetSamplesPerPixel();
 138    int GetPlanarConfiguration();
 139    int GetPixelSize();
 140    std::string GetPixelType();
 141    bool IsSignedPixelData();
 142    bool IsMonochrome();
 143    bool IsMonochrome1();
 144    bool IsPaletteColor();
 145    bool IsYBRFull();
 146
 147    bool HasLUT();
 148    int GetLUTNbits();
 149
 150    // For rescaling graylevel:
 151    float GetRescaleIntercept();
 152    float GetRescaleSlope();
 153
 154    int GetNumberOfScalarComponents();
 155    int GetNumberOfScalarComponentsRaw();
 156
 157    /// Accessor to \ref File::GrPixel
 158    uint16_t GetGrPixel()  { return GrPixel; }
 159    /// Accessor to \ref File::NumPixel
 160    uint16_t GetNumPixel() { return NumPixel; }
 161
 162    size_t GetPixelOffset();
 163    size_t GetPixelAreaLength();
 164
 165    /// returns the RLE info
 166    RLEFramesInfo *GetRLEInfo() { return RLEInfo; }
 167    /// Returns the JPEG Fragments info
 168    JPEGFragmentsInfo *GetJPEGInfo() { return JPEGInfo; }
 169
 170 // Anonymization process
 171    void AddAnonymizeElement (uint16_t group, uint16_t elem,
 172                              std::string const &value);
 173    /// Clears the list of elements to be anonymized
 174    void ClearAnonymizeList() { UserAnonymizeList.clear(); }
 175    void AnonymizeNoLoad();
 176    /// Replace patient's own information by info from the Anonymization list
 177    bool AnonymizeFile();
 178
 179    bool Write(std::string fileName, FileType filetype);
 180
 181 protected:
 182    File();
 183    virtual ~File();
 184    /// \brief Protect the Writer from writing illegal groups
 185    bool MayIWrite(uint16_t group)
 186      { if (group < 8 &&  group !=2 ) return false; else return true; }
 187
 188    /// Store the RLE frames info obtained during parsing of pixels.
 189    RLEFramesInfo *RLEInfo;
 190    /// Store the JPEG fragments info obtained during parsing of pixels.
 191    JPEGFragmentsInfo *JPEGInfo;
 192
 193    /// \brief In some cases (e.g. for some ACR-NEMA images) the Entry Element
 194    /// Number of the 'Pixel Element' is *not* found at 0x0010. In order to
 195    /// make things easier the parser shall store the proper value in
 196    /// NumPixel to provide a unique access facility.
 197    uint16_t NumPixel;
 198    /// \brief In some cases (e.g. for some ACR-NEMA images) the header entry for
 199    /// the group of pixels is *not* found at 0x7fe0.
 200    /// In order to make things easier the parser shall store the proper value
 201    /// in GrPixel to provide a unique access facility.
 202    uint16_t GrPixel;
 203    /// \brief allows user to tell gdcm in which DataElement is stored
 204    ///the -unnormalized- 4th Dimension
 205    TagKey FourthDimensionLocation;
 206
 207 private:
 208    bool DoTheLoadingJob();
 209    void ComputeRLEInfo();
 210    void ComputeJPEGFragmentInfo();
 211    bool     ReadTag(uint16_t, uint16_t);
 212    uint32_t ReadTagLength(uint16_t, uint16_t);
 213    void ReadEncapsulatedBasicOffsetTable();
 214    uint32_t *BasicOffsetTableItemValue;
 215
 216 };
 217 } // end namespace gdcm
 218
 219 //-----------------------------------------------------------------------------
 220 #endif