VTK  9.6.20260204
vtkNIFTIImageReader.h
Go to the documentation of this file.
1// SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2// SPDX-License-Identifier: BSD-3-Clause
26
27#ifndef vtkNIFTIImageReader_h
28#define vtkNIFTIImageReader_h
29
30#include "vtkIOImageModule.h" // For export macro
31#include "vtkImageReader2.h"
32
33VTK_ABI_NAMESPACE_BEGIN
35class vtkMatrix4x4;
36VTK_ABI_NAMESPACE_END
37
38struct nifti_1_header;
39
40VTK_ABI_NAMESPACE_BEGIN
41
42//----------------------------------------------------------------------------
43class VTKIOIMAGE_EXPORT vtkNIFTIImageReader : public vtkImageReader2
44{
45public:
47
53
57 void PrintSelf(ostream& os, vtkIndent indent) override;
58
62 const char* GetFileExtensions() override { return ".nii .nii.gz .img .img.gz .hdr .hdr.gz"; }
63
67 const char* GetDescriptiveName() override { return "NIfTI"; }
68
69 using Superclass::CanReadFile;
73 int CanReadFile(VTK_FILEPATH const char* filename) override;
74
76
83 vtkGetMacro(TimeAsVector, bool);
84 vtkSetMacro(TimeAsVector, bool);
85 vtkBooleanMacro(TimeAsVector, bool);
87
91 int GetTimeDimension() { return this->Dim[4]; }
92 double GetTimeSpacing() { return this->PixDim[4]; }
93
101 double GetRescaleSlope() { return this->RescaleSlope; }
102 double GetRescaleIntercept() { return this->RescaleIntercept; }
103
105
112 vtkGetMacro(PlanarRGB, bool);
113 vtkSetMacro(PlanarRGB, bool);
114 vtkBooleanMacro(PlanarRGB, bool);
116
127 double GetQFac() { return this->QFac; }
128
142
158
163
164protected:
167
172 vtkInformationVector* outputVector) override;
173
178 vtkInformationVector* outputVector) override;
179
185 static bool CheckExtension(const char* filename, const char* ext);
186
195 static char* ReplaceExtension(const char* filename, const char* ext1, const char* ext2);
196
200 static int CheckNIFTIVersion(const nifti_1_header* hdr);
201
205 static bool CheckAnalyzeHeader(const nifti_1_header* hdr);
206
211
213
219
223 double QFac;
224
226
232
236 int Dim[8];
237
241 double PixDim[8];
242
247
252
253private:
255 void operator=(const vtkNIFTIImageReader&) = delete;
256};
257
258VTK_ABI_NAMESPACE_END
259#endif // vtkNIFTIImageReader_h
vtkImageReader2()
Return a descriptive name for the file format that might be useful in a GUI.
a simple class to control print indentation
Definition vtkIndent.h:108
Store zero or more vtkInformation instances.
Store vtkAlgorithm input/output information.
represent and manipulate 4x4 transformation matrices
Store NIfTI header information.
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).
int CanReadFile(const char *filename) override
Return true if this reader can read the given file.
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.
double PixDim[8]
The spacings in the NIFTI file.
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.
int Dim[8]
The dimensions of the NIFTI file.
vtkNIFTIImageHeader * GetNIFTIHeader()
Get the raw header information from the NIfTI 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