VTK
vtkDICOMImageReader.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkDICOMImageReader.h
5 
6  Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7  All rights reserved.
8  See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9 
10  This software is distributed WITHOUT ANY WARRANTY; without even
11  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12  PURPOSE. See the above copyright notice for more information.
13 
14 =========================================================================*/
43 #ifndef vtkDICOMImageReader_h
44 #define vtkDICOMImageReader_h
45 
46 #include "vtkIOImageModule.h" // For export macro
47 #include "vtkImageReader2.h"
48 
49 class vtkDICOMImageReaderVector;
50 class DICOMParser;
51 class DICOMAppHelper;
52 
53 class VTKIOIMAGE_EXPORT vtkDICOMImageReader : public vtkImageReader2
54 {
55  public:
57 
60  static vtkDICOMImageReader *New();
63 
67  void PrintSelf(ostream& os, vtkIndent indent) override;
68 
70 
74  void SetFileName(const char* fn) override
75  {
76  delete [] this->DirectoryName;
77  delete [] this->FileName;
78  this->DirectoryName = nullptr;
79  this->FileName = nullptr;
81  }
83 
93  void SetDirectoryName(const char* dn);
94 
96 
99  vtkGetStringMacro(DirectoryName);
101 
108  double* GetPixelSpacing() VTK_SIZEHINT(3);
109 
113  int GetWidth();
114 
118  int GetHeight();
119 
125  float* GetImagePositionPatient() VTK_SIZEHINT(3);
126 
132  float* GetImageOrientationPatient() VTK_SIZEHINT(6);
133 
137  int GetBitsAllocated();
138 
144  int GetPixelRepresentation();
145 
150  int GetNumberOfComponents();
151 
155  const char* GetTransferSyntaxUID();
156 
160  float GetRescaleSlope();
161 
165  float GetRescaleOffset();
166 
170  const char* GetPatientName();
171 
175  const char* GetStudyUID();
176 
180  const char* GetStudyID();
181 
185  float GetGantryAngle();
186 
187  //
188  // Can I read the file?
189  //
190  int CanReadFile(const char* fname) override;
191 
192  //
193  // What file extensions are supported?
194  //
195  const char* GetFileExtensions() override
196  {
197  return ".dcm";
198  }
199 
203  const char* GetDescriptiveName() override
204  {
205  return "DICOM";
206  }
207 
208 protected:
209  //
210  // Setup the volume size
211  //
212  void SetupOutputInformation(int num_slices);
213 
214  void ExecuteInformation() override;
215  void ExecuteDataWithInformation(vtkDataObject *out, vtkInformation *outInfo) override;
216 
217  //
218  // Constructor
219  //
221 
222  //
223  // Destructor
224  //
225  ~vtkDICOMImageReader() override;
226 
227  //
228  // Instance of the parser used to parse the file.
229  //
230  DICOMParser* Parser;
231 
232  //
233  // Instance of the callbacks that get the data from the file.
234  //
235  DICOMAppHelper* AppHelper;
236 
237  //
238  // vtkDICOMImageReaderVector wants to be a PIMPL and it will be, but not quite yet.
239  //
240  vtkDICOMImageReaderVector* DICOMFileNames;
242 
243  char* PatientName;
244  char* StudyUID;
245  char* StudyID;
247 
248  // DICOMFileNames accessor methods for subclasses:
249  int GetNumberOfDICOMFileNames();
250  const char* GetDICOMFileName(int index);
251 private:
252  vtkDICOMImageReader(const vtkDICOMImageReader&) = delete;
253  void operator=(const vtkDICOMImageReader&) = delete;
254 
255 };
256 
257 #endif
vtkImageReader2::FileName
char * FileName
Definition: vtkImageReader2.h:316
vtkImageReader2::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkImageReader2::ExecuteDataWithInformation
void ExecuteDataWithInformation(vtkDataObject *data, vtkInformation *outInfo) override
This is a convenience method that is implemented in many subclasses instead of RequestData.
vtkDICOMImageReader::PatientName
char * PatientName
Definition: vtkDICOMImageReader.h:243
vtkDICOMImageReader
Reads some DICOM images.
Definition: vtkDICOMImageReader.h:53
vtkDICOMImageReader::DirectoryName
char * DirectoryName
Definition: vtkDICOMImageReader.h:241
vtkDICOMImageReader::GetDescriptiveName
const char * GetDescriptiveName() override
Return a descriptive name for the file format that might be useful in a GUI.
Definition: vtkDICOMImageReader.h:203
vtkImageReader2::New
static vtkImageReader2 * New()
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition: vtkWrappingHints.h:42
vtkDICOMImageReader::Parser
DICOMParser * Parser
Definition: vtkDICOMImageReader.h:230
vtkDICOMImageReader::SetFileName
void SetFileName(const char *fn) override
Set the filename for the file to read.
Definition: vtkDICOMImageReader.h:74
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkImageReader2
Superclass of binary file readers.
Definition: vtkImageReader2.h:58
vtkDICOMImageReader::DICOMFileNames
vtkDICOMImageReaderVector * DICOMFileNames
Definition: vtkDICOMImageReader.h:240
vtkImageReader2::SetFileName
virtual void SetFileName(const char *)
Specify file name for the image file.
vtkInformation
Store vtkAlgorithm input/output information.
Definition: vtkInformation.h:86
vtkDICOMImageReader::TransferSyntaxUID
char * TransferSyntaxUID
Definition: vtkDICOMImageReader.h:246
vtkDICOMImageReader::AppHelper
DICOMAppHelper * AppHelper
Definition: vtkDICOMImageReader.h:235
vtkImageReader2::ExecuteInformation
virtual void ExecuteInformation()
vtkDICOMImageReader::StudyID
char * StudyID
Definition: vtkDICOMImageReader.h:245
vtkDataObject
general representation of visualization data
Definition: vtkDataObject.h:64
vtkX3D::index
Definition: vtkX3D.h:246
vtkDICOMImageReader::StudyUID
char * StudyUID
Definition: vtkDICOMImageReader.h:244
vtkImageReader2.h