]> Creatis software - gdcm.git/blob - vtk/vtkGdcmReader.h
Fix bug in windows part
[gdcm.git] / vtk / vtkGdcmReader.h
1 /*=========================================================================
2                                                                                 
3   Program:   gdcm
4   Module:    $RCSfile: vtkGdcmReader.h,v $
5   Language:  C++
6   Date:      $Date: 2009/04/18 14:42:51 $
7   Version:   $Revision: 1.36 $
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    
69    vtkSetMacro(AllowLookupTable, bool);
70    vtkGetMacro(AllowLookupTable, bool);
71    vtkBooleanMacro(AllowLookupTable, bool);
72
73    vtkSetMacro(KeepOverlays, bool);
74    vtkGetMacro(KeepOverlays, bool);
75    vtkBooleanMacro(KeepOverlays, bool);
76    
77    vtkSetMacro(FlipY, bool);
78    vtkGetMacro(FlipY, bool);
79    vtkBooleanMacro(FlipY, bool);   
80
81    vtkGetObjectMacro(LookupTable, vtkLookupTable);
82
83 // FIXME : HOW to doxygen a VTK macro?
84 /*
85  * \ brief Sets the LoadMode as a boolean string. 
86  *        gdcm.LD_NOSEQ, gdcm.LD_NOSHADOW, gdcm.LD_NOSHADOWSEQ... 
87  *        (nothing more, right now)
88  *        WARNING : before using NO_SHADOW, be sure *all* your files
89  *        contain accurate values in the 0x0000 element (if any) 
90  *        of *each* Shadow Group. The parser will fail if the size is wrong !
91  * @param   mode Load mode to be used    
92  */
93    vtkSetMacro(LoadMode, int);
94    vtkGetMacro(LoadMode, int);
95    vtkBooleanMacro(LoadMode, int);
96  
97 /*
98  * \ brief drop images with duplicate position  
99  *         and therefore calculate ZSpacing for the whole file set
100  * @param   mode user wants to drop images with duplicate position    
101  */   
102    vtkSetMacro(DropDuplicatePositions, bool);
103    vtkGetMacro(DropDuplicatePositions, bool);
104    vtkBooleanMacro(DropDuplicatePositions, bool);      
105
106 protected:
107    vtkGdcmReader();
108    ~vtkGdcmReader();
109
110    virtual void ExecuteInformation();
111    virtual void ExecuteData(vtkDataObject *output);
112
113    //virtual void BuildData(vtkDataObject *output); // for VTK5.0
114    virtual void BuildFileListFromPattern();
115    virtual void LoadFileInformation();
116    virtual void UpdateFileInformation();
117    //BTX
118    virtual void GetFileInformation(GDCM_NAME_SPACE::File *file);
119    virtual bool TestFileInformation(GDCM_NAME_SPACE::File *file);
120    //ETX
121
122 private:
123    void RemoveAllInternalFileName(void);
124    void AddInternalFileName(const char *name);
125    void RemoveAllInternalFile(void);
126
127    //BTX
128    void IncrementProgress(const unsigned long updateProgressTarget,
129                           unsigned long &updateProgressCount);
130    /*void LoadImageInMemory(std::string fileName, unsigned char *dest,
131                           const unsigned long updateProgressTarget,
132                           unsigned long &updateProgressCount);*/
133
134    void LoadImageInMemory(GDCM_NAME_SPACE::File *f, unsigned char *dest,
135                           const unsigned long updateProgressTarget,
136                           unsigned long &updateProgressCount);
137    //ETX
138
139 // Variables
140    //BTX
141    typedef std::vector<GDCM_NAME_SPACE::File *> gdcmFileList;
142    //ETX
143
144    vtkLookupTable *LookupTable;
145    vtkTimeStamp fileTime;
146
147    bool AllowLookupTable;
148    bool AllowLightChecking;
149
150    //BTX
151    // Number of columns of the image/volume to be loaded
152    int NumColumns;
153    // Number of lines of the image/volume to be loaded
154    int NumLines;
155    // Number of lines of the image/volume to be loaded
156    int NumPlanes;
157    // Total number of planes (or images) of the stack to be build.
158    int TotalNumberOfPlanes;
159    // Number of scalar components of the image to be loaded (1=monochrome 3=rgb)
160    int NumComponents;
161    // Type of the image[s]: 8/16/32 bits, signed/unsigned:
162    std::string ImageType;
163    // Pixel size (in number of bytes):
164    size_t PixelSize;
165    // List of filenames to be read in order to build a stack of images
166    // or volume. The order in the list shall be the order of the images.
167    std::list<std::string> FileNameList;
168    gdcmFileList *CoherentFileList;
169    bool OwnFile;
170
171    // List of filenames created in ExecuteInformation and used in
172    // ExecuteData.
173    // If FileNameList isn't empty, InternalFileNameList is a copy of
174    //    FileNameList
175    // Otherwise, InternalFileNameList correspond to the list of 
176    //    files patterned
177    std::list<std::string> InternalFileNameList;
178    gdcmFileList InternalFileList;
179    //bool Execution;  // For VTK5.0
180   
181    //ETX
182
183    /// \brief Bit string integer (each one considered as a boolean)
184    ///        Bit 0 : Skip Sequences,    if possible
185    ///        Bit 1 : Skip Shadow Groups if possible
186    ///        Bit 2 : Skip Sequences inside a Shadow Group, if possible
187    ///        Probabely (?), some more to add
188    int LoadMode;
189     
190    bool DropDuplicatePositions;
191    
192    bool KeepOverlays;
193    
194    bool FlipY;
195    
196    /// Pointer to a user suplied function to allow modification of pixel order
197    VOID_FUNCTION_PUINT8_PFILE_POINTER UserFunction;
198
199 };
200
201 //-----------------------------------------------------------------------------
202 #endif
203