VTK  9.2.5
vtkNIFTIImageReader.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkNIFTIImageReader.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=========================================================================*/
38#ifndef vtkNIFTIImageReader_h
39#define vtkNIFTIImageReader_h
40
41#include "vtkIOImageModule.h" // For export macro
42#include "vtkImageReader2.h"
43
45class vtkMatrix4x4;
46
47struct nifti_1_header;
48
49//----------------------------------------------------------------------------
50class VTKIOIMAGE_EXPORT vtkNIFTIImageReader : public vtkImageReader2
51{
52public:
54
60
64 void PrintSelf(ostream& os, vtkIndent indent) override;
65
69 const char* GetFileExtensions() override { return ".nii .nii.gz .img .img.gz .hdr .hdr.gz"; }
70
74 const char* GetDescriptiveName() override { return "NIfTI"; }
75
79 int CanReadFile(VTK_FILEPATH const char* filename) override;
80
82
89 vtkGetMacro(TimeAsVector, bool);
90 vtkSetMacro(TimeAsVector, bool);
91 vtkBooleanMacro(TimeAsVector, bool);
93
97 int GetTimeDimension() { return this->Dim[4]; }
98 double GetTimeSpacing() { return this->PixDim[4]; }
99
107 double GetRescaleSlope() { return this->RescaleSlope; }
108 double GetRescaleIntercept() { return this->RescaleIntercept; }
109
111
118 vtkGetMacro(PlanarRGB, bool);
119 vtkSetMacro(PlanarRGB, bool);
120 vtkBooleanMacro(PlanarRGB, bool);
122
133 double GetQFac() { return this->QFac; }
134
147 vtkMatrix4x4* GetQFormMatrix() { return this->QFormMatrix; }
148
163 vtkMatrix4x4* GetSFormMatrix() { return this->SFormMatrix; }
164
169
170protected:
173
178 vtkInformationVector* outputVector) override;
179
184 vtkInformationVector* outputVector) override;
185
191 static bool CheckExtension(const char* filename, const char* ext);
192
201 static char* ReplaceExtension(const char* filename, const char* ext1, const char* ext2);
202
206 static int CheckNIFTIVersion(const nifti_1_header* hdr);
207
211 static bool CheckAnalyzeHeader(const nifti_1_header* hdr);
212
217
219
225
229 double QFac;
230
232
238
242 int Dim[8];
243
247 double PixDim[8];
248
253
258
259private:
261 void operator=(const vtkNIFTIImageReader&) = delete;
262};
263
264#endif // vtkNIFTIImageReader_h
Superclass of binary file readers.
a simple class to control print indentation
Definition: vtkIndent.h:40
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
represent and manipulate 4x4 transformation matrices
Definition: vtkMatrix4x4.h:42
Store NIfTI header information.
Read NIfTI-1 and NIfTI-2 medical image files.
vtkMatrix4x4 * GetSFormMatrix()
Get a matrix that gives the "sform" orientation and offset for the data.
const char * GetDescriptiveName() override
Return a descriptive name that might be useful in a GUI.
double GetQFac()
QFac gives the slice order in the NIFTI file versus the VTK image.
vtkMatrix4x4 * GetQFormMatrix()
Get a matrix that gives the "qform" orientation and offset for the data.
static int CheckNIFTIVersion(const nifti_1_header *hdr)
Check the version of the header.
double QFac
Is -1 if VTK slice order is opposite to NIFTI slice order, +1 otherwise.
static vtkNIFTIImageReader * New()
Static method for construction.
double GetRescaleSlope()
Get the slope and intercept for rescaling the scalar values.
void PrintSelf(ostream &os, vtkIndent indent) override
Print information about this object.
int RequestData(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
Read the voxel data.
bool PlanarRGB
Use planar RGB instead of the default (packed).
static char * ReplaceExtension(const char *filename, const char *ext1, const char *ext2)
Make a new filename by replacing extension "ext1" with "ext2".
static bool CheckExtension(const char *filename, const char *ext)
Do a case-insensitive check for the given extension.
int RequestInformation(vtkInformation *request, vtkInformationVector **inputVector, vtkInformationVector *outputVector) override
Read the header information.
double RescaleIntercept
Information for rescaling data to quantitative units.
vtkMatrix4x4 * QFormMatrix
The orientation matrices for the NIFTI file.
static bool CheckAnalyzeHeader(const nifti_1_header *hdr)
Return true if an Analyze 7.5 header was found.
vtkNIFTIImageHeader * GetNIFTIHeader()
Get the raw header information from the NIfTI file.
int CanReadFile(VTK_FILEPATH const char *filename) override
Return true if this reader can read the given file.
~vtkNIFTIImageReader() override
vtkMatrix4x4 * SFormMatrix
The orientation matrices for the NIFTI file.
double RescaleSlope
Information for rescaling data to quantitative units.
bool TimeAsVector
Read the time dimension as if it was a vector dimension.
int GetTimeDimension()
Get the time dimension that was stored in the NIFTI header.
const char * GetFileExtensions() override
Valid extensions for this file type.
vtkNIFTIImageHeader * NIFTIHeader
A copy of the header from the file that was most recently read.
Data structure defining the fields in the nifti1 header. This binary header should be found at the be...
#define VTK_FILEPATH