1 /*=========================================================================
4 Module: $RCSfile: vtkGdcmReader.h,v $
6 Date: $Date: 2005/08/22 12:43:11 $
7 Version: $Revision: 1.27 $
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.
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.
17 =========================================================================*/
19 #ifndef __vtkGdcmReader_h
20 #define __vtkGdcmReader_h
22 #include "gdcmCommon.h" // To avoid warnings concerning the std
25 #include <vtkImageReader.h>
30 typedef void (*VOID_FUNCTION_PUINT8_PFILE_POINTER)(uint8_t *, gdcm::File *);
32 //-----------------------------------------------------------------------------
35 //-----------------------------------------------------------------------------
36 class VTK_EXPORT vtkGdcmReader : public vtkImageReader
39 static vtkGdcmReader *New();
40 vtkTypeRevisionMacro(vtkGdcmReader, vtkImageReader);
41 void PrintSelf(ostream& os, vtkIndent indent);
43 virtual void RemoveAllFileName(void);
44 virtual void AddFileName(const char *name);
45 virtual void SetFileName(const char *name);
48 void SetCoherentFileList( std::vector<gdcm::File* > *cfl) {
49 CoherentFileList = cfl; }
52 vtkSetMacro(AllowLightChecking, int);
53 vtkGetMacro(AllowLightChecking, int);
54 vtkBooleanMacro(AllowLightChecking, int);
57 void SetUserFunction (VOID_FUNCTION_PUINT8_PFILE_POINTER userFunc )
58 { UserFunction = userFunc; }
62 // If this flag is set and the DICOM reader encounters a dicom file with
63 // lookup table the data will be kept as unsigned chars and a lookuptable
64 // will be exported and accessible through GetLookupTable()
65 vtkSetMacro(AllowLookupTable, int);
66 vtkGetMacro(AllowLookupTable, int);
67 vtkBooleanMacro(AllowLookupTable, int);
69 vtkGetObjectMacro(LookupTable, vtkLookupTable);
72 * \brief Sets the LoadMode as a boolean string.
73 * NO_SEQ, NO_SHADOW, NO_SHADOWSEQ... (nothing more, right now)
74 * WARNING : before using NO_SHADOW, be sure *all* your files
75 * contain accurate values in the 0x0000 element (if any)
76 * of *each* Shadow Group. The parser will fail if the size is wrong !
77 * @param mode Load mode to be used
79 vtkSetMacro(LoadMode, int);
80 vtkGetMacro(LoadMode, int);
81 vtkBooleanMacro(LoadMode, int);
87 virtual void ExecuteInformation();
88 virtual void ExecuteData(vtkDataObject *output);
89 virtual void BuildFileListFromPattern();
90 virtual int CheckFileCoherence();
91 virtual int CheckFileCoherenceLight();
92 virtual int CheckFileCoherenceAlreadyDone();
94 void RemoveAllInternalFileName(void);
95 void AddInternalFileName(const char* name);
98 size_t LoadImageInMemory(std::string fileName, unsigned char *dest,
99 const unsigned long updateProgressTarget,
100 unsigned long &updateProgressCount);
102 size_t LoadImageInMemory(gdcm::File *f, unsigned char *dest,
103 const unsigned long updateProgressTarget,
104 unsigned long &updateProgressCount);
106 size_t DoTheLoadingJob (gdcm::File *f,
108 const unsigned long updateProgressTarget,
109 unsigned long &updateProgressCount);
113 vtkLookupTable *LookupTable;
114 vtkTimeStamp fileTime;
115 int AllowLookupTable;
117 int AllowLightChecking;
120 // Number of columns of the image/volume to be loaded
122 // Number of lines of the image/volume to be loaded
124 // Total number of planes (or images) of the stack to be build.
125 int TotalNumberOfPlanes;
126 // Number of scalar components of the image to be loaded (1=monochrome 3=rgb)
128 // Type of the image[s]: 8/16/32 bits, signed/unsigned:
129 std::string ImageType;
130 // Pixel size (in number of bytes):
132 // List of filenames to be read in order to build a stack of images
133 // or volume. The order in the list shall be the order of the images.
134 std::list<std::string> FileNameList;
136 // List of filenames created in ExecuteInformation and used in
138 // If FileNameList isn't empty, InternalFileNameList is a copy of
140 // Otherwise, InternalFileNameList correspond to the list of
142 std::list<std::string> InternalFileNameList;
143 std::vector<gdcm::File* > *CoherentFileList;
147 /// \brief Bit string integer (each one considered as a boolean)
148 /// Bit 0 : Skip Sequences, if possible
149 /// Bit 1 : Skip Shadow Groups if possible
150 /// Bit 2 : Skip Sequences inside a Shadow Group, if possible
151 /// Probabely (?), some more to add
154 /// Pointer to a user suplied function to allow modification of pixel order
155 VOID_FUNCTION_PUINT8_PFILE_POINTER UserFunction;
159 //-----------------------------------------------------------------------------