vtk/vtkGdcmReader.h

   1 /*=========================================================================
   2
   3   Program:   gdcm
   4   Module:    $RCSfile: vtkGdcmReader.h,v $
   5   Language:  C++
   6   Date:      $Date: 2007/09/04 16:21:50 $
   7   Version:   $Revision: 1.35 $
   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 __vtkGdcmReader_h
  20 #define __vtkGdcmReader_h
  21
  22 #include "gdcmCommon.h" // To avoid warnings concerning the std
  23 #include "gdcmFile.h"
  24
  25 #include <vtkImageReader.h>
  26 #include <list>
  27 #include <string>
  28 #include <vector>
  29
  30 typedef void (*VOID_FUNCTION_PUINT8_PFILE_POINTER)(uint8_t *, GDCM_NAME_SPACE::File *);
  31
  32 //-----------------------------------------------------------------------------
  33 class vtkLookupTable;
  34
  35 //-----------------------------------------------------------------------------
  36 class VTK_EXPORT vtkGdcmReader : public vtkImageReader
  37 {
  38 public:
  39    static vtkGdcmReader *New();
  40    vtkTypeRevisionMacro(vtkGdcmReader, vtkImageReader);
  41    void PrintSelf(ostream& os, vtkIndent indent);
  42
  43    virtual void RemoveAllFileName(void);
  44    virtual void AddFileName(const char *name);
  45    virtual void SetFileName(const char *name);
  46
  47    //BTX
  48    void SetCoherentFileList( std::vector<GDCM_NAME_SPACE::File* > *cfl) {
  49                                                       CoherentFileList = cfl; }
  50    //ETX
  51
  52    //vtkSetMacro(AllowLightChecking, bool);
  53    //vtkGetMacro(AllowLightChecking, bool);
  54    //vtkBooleanMacro(AllowLightChecking, bool);
  55
  56    //BTX
  57
  58    /// \todo fix possible problems around VTK pipelining
  59
  60    void SetUserFunction (VOID_FUNCTION_PUINT8_PFILE_POINTER userFunc )
  61                         { UserFunction = userFunc; }
  62    //ETX
  63
  64    // Description:
  65    // If this flag is set and the DICOM reader encounters a dicom file with
  66    // lookup table the data will be kept as unsigned chars and a lookuptable
  67    // will be exported and accessible through GetLookupTable()
  68    vtkSetMacro(AllowLookupTable, bool);
  69    vtkGetMacro(AllowLookupTable, bool);
  70    vtkBooleanMacro(AllowLookupTable, bool);
  71
  72
  73    vtkSetMacro(KeepOverlays, bool);
  74    vtkGetMacro(KeepOverlays, bool);
  75    vtkBooleanMacro(KeepOverlays, bool);
  76
  77    vtkGetObjectMacro(LookupTable, vtkLookupTable);
  78
  79 // FIXME : HOW to doxygen a VTK macro?
  80 /*
  81  * \ brief Sets the LoadMode as a boolean string.
  82  *        gdcm.LD_NOSEQ, gdcm.LD_NOSHADOW, gdcm.LD_NOSHADOWSEQ...
  83  *        (nothing more, right now)
  84  *        WARNING : before using NO_SHADOW, be sure *all* your files
  85  *        contain accurate values in the 0x0000 element (if any)
  86  *        of *each* Shadow Group. The parser will fail if the size is wrong !
  87  * @param   mode Load mode to be used
  88  */
  89    vtkSetMacro(LoadMode, int);
  90    vtkGetMacro(LoadMode, int);
  91    vtkBooleanMacro(LoadMode, int);
  92
  93 /*
  94  * \ brief drop images with duplicate position
  95  *         and therefore calculate ZSpacing for the whole file set
  96  * @param   mode user wants to drop images with duplicate position
  97  */
  98    vtkSetMacro(DropDuplicatePositions, bool);
  99    vtkGetMacro(DropDuplicatePositions, bool);
 100    vtkBooleanMacro(DropDuplicatePositions, bool);
 101
 102 protected:
 103    vtkGdcmReader();
 104    ~vtkGdcmReader();
 105
 106    virtual void ExecuteInformation();
 107    virtual void ExecuteData(vtkDataObject *output);
 108
 109    //virtual void BuildData(vtkDataObject *output); // for VTK5.0
 110    virtual void BuildFileListFromPattern();
 111    virtual void LoadFileInformation();
 112    virtual void UpdateFileInformation();
 113    //BTX
 114    virtual void GetFileInformation(GDCM_NAME_SPACE::File *file);
 115    virtual bool TestFileInformation(GDCM_NAME_SPACE::File *file);
 116    //ETX
 117
 118 private:
 119    void RemoveAllInternalFileName(void);
 120    void AddInternalFileName(const char *name);
 121    void RemoveAllInternalFile(void);
 122
 123    //BTX
 124    void IncrementProgress(const unsigned long updateProgressTarget,
 125                           unsigned long &updateProgressCount);
 126    /*void LoadImageInMemory(std::string fileName, unsigned char *dest,
 127                           const unsigned long updateProgressTarget,
 128                           unsigned long &updateProgressCount);*/
 129
 130    void LoadImageInMemory(GDCM_NAME_SPACE::File *f, unsigned char *dest,
 131                           const unsigned long updateProgressTarget,
 132                           unsigned long &updateProgressCount);
 133    //ETX
 134
 135 // Variables
 136    //BTX
 137    typedef std::vector<GDCM_NAME_SPACE::File *> gdcmFileList;
 138    //ETX
 139
 140    vtkLookupTable *LookupTable;
 141    vtkTimeStamp fileTime;
 142
 143    bool AllowLookupTable;
 144    bool AllowLightChecking;
 145
 146    //BTX
 147    // Number of columns of the image/volume to be loaded
 148    int NumColumns;
 149    // Number of lines of the image/volume to be loaded
 150    int NumLines;
 151    // Number of lines of the image/volume to be loaded
 152    int NumPlanes;
 153    // Total number of planes (or images) of the stack to be build.
 154    int TotalNumberOfPlanes;
 155    // Number of scalar components of the image to be loaded (1=monochrome 3=rgb)
 156    int NumComponents;
 157    // Type of the image[s]: 8/16/32 bits, signed/unsigned:
 158    std::string ImageType;
 159    // Pixel size (in number of bytes):
 160    size_t PixelSize;
 161    // List of filenames to be read in order to build a stack of images
 162    // or volume. The order in the list shall be the order of the images.
 163    std::list<std::string> FileNameList;
 164    gdcmFileList *CoherentFileList;
 165    bool OwnFile;
 166
 167    // List of filenames created in ExecuteInformation and used in
 168    // ExecuteData.
 169    // If FileNameList isn't empty, InternalFileNameList is a copy of
 170    //    FileNameList
 171    // Otherwise, InternalFileNameList correspond to the list of
 172    //    files patterned
 173    std::list<std::string> InternalFileNameList;
 174    gdcmFileList InternalFileList;
 175    //bool Execution;  // For VTK5.0
 176
 177    //ETX
 178
 179    /// \brief Bit string integer (each one considered as a boolean)
 180    ///        Bit 0 : Skip Sequences,    if possible
 181    ///        Bit 1 : Skip Shadow Groups if possible
 182    ///        Bit 2 : Skip Sequences inside a Shadow Group, if possible
 183    ///        Probabely (?), some more to add
 184    int LoadMode;
 185
 186    bool DropDuplicatePositions;
 187
 188    bool KeepOverlays;
 189
 190    /// Pointer to a user suplied function to allow modification of pixel order
 191    VOID_FUNCTION_PUINT8_PFILE_POINTER UserFunction;
 192
 193 };
 194
 195 //-----------------------------------------------------------------------------
 196 #endif
 197